drivers/net/wireless/rt2x00/rt2x00queue.h

   1 /*
   2         Copyright (C) 2004 - 2008 rt2x00 SourceForge Project
   3         <http://rt2x00.serialmonkey.com>
   4
   5         This program is free software; you can redistribute it and/or modify
   6         it under the terms of the GNU General Public License as published by
   7         the Free Software Foundation; either version 2 of the License, or
   8         (at your option) any later version.
   9
  10         This program is distributed in the hope that it will be useful,
  11         but WITHOUT ANY WARRANTY; without even the implied warranty of
  12         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13         GNU General Public License for more details.
  14
  15         You should have received a copy of the GNU General Public License
  16         along with this program; if not, write to the
  17         Free Software Foundation, Inc.,
  18         59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19  */
  20
  21 /*
  22         Module: rt2x00
  23         Abstract: rt2x00 queue datastructures and routines
  24  */
  25
  26 #ifndef RT2X00QUEUE_H
  27 #define RT2X00QUEUE_H
  28
  29 #include <linux/prefetch.h>
  30
  31 /**
  32  * DOC: Entrie frame size
  33  *
  34  * Ralink PCI devices demand the Frame size to be a multiple of 128 bytes,
  35  * for USB devices this restriction does not apply, but the value of
  36  * 2432 makes sense since it is big enough to contain the maximum fragment
  37  * size according to the ieee802.11 specs.
  38  */
  39 #define DATA_FRAME_SIZE 2432
  40 #define MGMT_FRAME_SIZE 256
  41
  42 /**
  43  * DOC: Number of entries per queue
  44  *
  45  * After research it was concluded that 12 entries in a RX and TX
  46  * queue would be sufficient. Although this is almost one third of
  47  * the amount the legacy driver allocated, the queues aren't getting
  48  * filled to the maximum even when working with the maximum rate.
  49  */
  50 #define RX_ENTRIES      12
  51 #define TX_ENTRIES      12
  52 #define BEACON_ENTRIES  1
  53 #define ATIM_ENTRIES    1
  54
  55 /**
  56  * enum data_queue_qid: Queue identification
  57  *
  58  * @QID_AC_BE: AC BE queue
  59  * @QID_AC_BK: AC BK queue
  60  * @QID_AC_VI: AC VI queue
  61  * @QID_AC_VO: AC VO queue
  62  * @QID_HCCA: HCCA queue
  63  * @QID_MGMT: MGMT queue (prio queue)
  64  * @QID_RX: RX queue
  65  * @QID_OTHER: None of the above (don't use, only present for completeness)
  66  * @QID_BEACON: Beacon queue (value unspecified, don't send it to device)
  67  * @QID_ATIM: Atim queue (value unspeficied, don't send it to device)
  68  */
  69 enum data_queue_qid {
  70         QID_AC_BE = 0,
  71         QID_AC_BK = 1,
  72         QID_AC_VI = 2,
  73         QID_AC_VO = 3,
  74         QID_HCCA = 4,
  75         QID_MGMT = 13,
  76         QID_RX = 14,
  77         QID_OTHER = 15,
  78         QID_BEACON,
  79         QID_ATIM,
  80 };
  81
  82 /**
  83  * enum skb_frame_desc_flags: Flags for &struct skb_frame_desc
  84  *
  85  */
  86 //enum skb_frame_desc_flags {
  87 //      TEMPORARILY EMPTY
  88 //};
  89
  90 /**
  91  * struct skb_frame_desc: Descriptor information for the skb buffer
  92  *
  93  * This structure is placed over the driver_data array, this means that
  94  * this structure should not exceed the size of that array (40 bytes).
  95  *
  96  * @flags: Frame flags, see &enum skb_frame_desc_flags.
  97  * @data: Pointer to data part of frame (Start of ieee80211 header).
  98  * @desc: Pointer to descriptor part of the frame.
  99  *      Note that this pointer could point to something outside
 100  *      of the scope of the skb->data pointer.
 101  * @data_len: Length of the frame data.
 102  * @desc_len: Length of the frame descriptor.
 103  * @entry: The entry to which this sk buffer belongs.
 104  */
 105 struct skb_frame_desc {
 106         unsigned int flags;
 107
 108         void *desc;
 109         unsigned int desc_len;
 110
 111         struct queue_entry *entry;
 112 };
 113
 114 /**
 115  * get_skb_frame_desc - Obtain the rt2x00 frame descriptor from a sk_buff.
 116  * @skb: &struct sk_buff from where we obtain the &struct skb_frame_desc
 117  */
 118 static inline struct skb_frame_desc* get_skb_frame_desc(struct sk_buff *skb)
 119 {
 120         BUILD_BUG_ON(sizeof(struct skb_frame_desc) >
 121                      IEEE80211_TX_INFO_DRIVER_DATA_SIZE);
 122         return (struct skb_frame_desc *)&IEEE80211_SKB_CB(skb)->driver_data;
 123 }
 124
 125 /**
 126  * enum rxdone_entry_desc_flags: Flags for &struct rxdone_entry_desc
 127  *
 128  * @RXDONE_SIGNAL_PLCP: Does the signal field contain the plcp value,
 129  *      or does it contain the bitrate itself.
 130  * @RXDONE_MY_BSS: Does this frame originate from device's BSS.
 131  */
 132 enum rxdone_entry_desc_flags {
 133         RXDONE_SIGNAL_PLCP = 1 << 0,
 134         RXDONE_MY_BSS = 1 << 1,
 135 };
 136
 137 /**
 138  * struct rxdone_entry_desc: RX Entry descriptor
 139  *
 140  * Summary of information that has been read from the RX frame descriptor.
 141  *
 142  * @signal: Signal of the received frame.
 143  * @rssi: RSSI of the received frame.
 144  * @size: Data size of the received frame.
 145  * @flags: MAC80211 receive flags (See &enum mac80211_rx_flags).
 146  * @dev_flags: Ralink receive flags (See &enum rxdone_entry_desc_flags).
 147
 148  */
 149 struct rxdone_entry_desc {
 150         int signal;
 151         int rssi;
 152         int size;
 153         int flags;
 154         int dev_flags;
 155 };
 156
 157 /**
 158  * enum txdone_entry_desc_flags: Flags for &struct txdone_entry_desc
 159  *
 160  * @TXDONE_UNKNOWN: Hardware could not determine success of transmission.
 161  * @TXDONE_SUCCESS: Frame was successfully send
 162  * @TXDONE_FAILURE: Frame was not successfully send
 163  * @TXDONE_EXCESSIVE_RETRY: In addition to &TXDONE_FAILURE, the
 164  *      frame transmission failed due to excessive retries.
 165  */
 166 enum txdone_entry_desc_flags {
 167         TXDONE_UNKNOWN = 1 << 0,
 168         TXDONE_SUCCESS = 1 << 1,
 169         TXDONE_FAILURE = 1 << 2,
 170         TXDONE_EXCESSIVE_RETRY = 1 << 3,
 171 };
 172
 173 /**
 174  * struct txdone_entry_desc: TX done entry descriptor
 175  *
 176  * Summary of information that has been read from the TX frame descriptor
 177  * after the device is done with transmission.
 178  *
 179  * @flags: TX done flags (See &enum txdone_entry_desc_flags).
 180  * @retry: Retry count.
 181  */
 182 struct txdone_entry_desc {
 183         unsigned long flags;
 184         int retry;
 185 };
 186
 187 /**
 188  * enum txentry_desc_flags: Status flags for TX entry descriptor
 189  *
 190  * @ENTRY_TXD_RTS_FRAME: This frame is a RTS frame.
 191  * @ENTRY_TXD_CTS_FRAME: This frame is a CTS-to-self frame.
 192  * @ENTRY_TXD_OFDM_RATE: This frame is send out with an OFDM rate.
 193  * @ENTRY_TXD_FIRST_FRAGMENT: This is the first frame.
 194  * @ENTRY_TXD_MORE_FRAG: This frame is followed by another fragment.
 195  * @ENTRY_TXD_REQ_TIMESTAMP: Require timestamp to be inserted.
 196  * @ENTRY_TXD_BURST: This frame belongs to the same burst event.
 197  * @ENTRY_TXD_ACK: An ACK is required for this frame.
 198  * @ENTRY_TXD_RETRY_MODE: When set, the long retry count is used.
 199  */
 200 enum txentry_desc_flags {
 201         ENTRY_TXD_RTS_FRAME,
 202         ENTRY_TXD_CTS_FRAME,
 203         ENTRY_TXD_OFDM_RATE,
 204         ENTRY_TXD_FIRST_FRAGMENT,
 205         ENTRY_TXD_MORE_FRAG,
 206         ENTRY_TXD_REQ_TIMESTAMP,
 207         ENTRY_TXD_BURST,
 208         ENTRY_TXD_ACK,
 209         ENTRY_TXD_RETRY_MODE,
 210 };
 211
 212 /**
 213  * struct txentry_desc: TX Entry descriptor
 214  *
 215  * Summary of information for the frame descriptor before sending a TX frame.
 216  *
 217  * @flags: Descriptor flags (See &enum queue_entry_flags).
 218  * @queue: Queue identification (See &enum data_queue_qid).
 219  * @length_high: PLCP length high word.
 220  * @length_low: PLCP length low word.
 221  * @signal: PLCP signal.
 222  * @service: PLCP service.
 223  * @retry_limit: Max number of retries.
 224  * @aifs: AIFS value.
 225  * @ifs: IFS value.
 226  * @cw_min: cwmin value.
 227  * @cw_max: cwmax value.
 228  */
 229 struct txentry_desc {
 230         unsigned long flags;
 231
 232         enum data_queue_qid queue;
 233
 234         u16 length_high;
 235         u16 length_low;
 236         u16 signal;
 237         u16 service;
 238
 239         short retry_limit;
 240         short aifs;
 241         short ifs;
 242         short cw_min;
 243         short cw_max;
 244 };
 245
 246 /**
 247  * enum queue_entry_flags: Status flags for queue entry
 248  *
 249  * @ENTRY_BCN_ASSIGNED: This entry has been assigned to an interface.
 250  *      As long as this bit is set, this entry may only be touched
 251  *      through the interface structure.
 252  * @ENTRY_OWNER_DEVICE_DATA: This entry is owned by the device for data
 253  *      transfer (either TX or RX depending on the queue). The entry should
 254  *      only be touched after the device has signaled it is done with it.
 255  * @ENTRY_OWNER_DEVICE_CRYPTO: This entry is owned by the device for data
 256  *      encryption or decryption. The entry should only be touched after
 257  *      the device has signaled it is done with it.
 258  * @ENTRY_DATA_PENDING: This entry contains a valid frame and is waiting
 259  *      for the signal to start sending.
 260  */
 261 enum queue_entry_flags {
 262         ENTRY_BCN_ASSIGNED,
 263         ENTRY_OWNER_DEVICE_DATA,
 264         ENTRY_OWNER_DEVICE_CRYPTO,
 265         ENTRY_DATA_PENDING,
 266 };
 267
 268 /**
 269  * struct queue_entry: Entry inside the &struct data_queue
 270  *
 271  * @flags: Entry flags, see &enum queue_entry_flags.
 272  * @queue: The data queue (&struct data_queue) to which this entry belongs.
 273  * @skb: The buffer which is currently being transmitted (for TX queue),
 274  *      or used to directly recieve data in (for RX queue).
 275  * @entry_idx: The entry index number.
 276  * @priv_data: Private data belonging to this queue entry. The pointer
 277  *      points to data specific to a particular driver and queue type.
 278  */
 279 struct queue_entry {
 280         unsigned long flags;
 281
 282         struct data_queue *queue;
 283
 284         struct sk_buff *skb;
 285
 286         unsigned int entry_idx;
 287
 288         void *priv_data;
 289 };
 290
 291 /**
 292  * enum queue_index: Queue index type
 293  *
 294  * @Q_INDEX: Index pointer to the current entry in the queue, if this entry is
 295  *      owned by the hardware then the queue is considered to be full.
 296  * @Q_INDEX_DONE: Index pointer to the next entry which will be completed by
 297  *      the hardware and for which we need to run the txdone handler. If this
 298  *      entry is not owned by the hardware the queue is considered to be empty.
 299  * @Q_INDEX_CRYPTO: Index pointer to the next entry which encryption/decription
 300  *      will be completed by the hardware next.
 301  * @Q_INDEX_MAX: Keep last, used in &struct data_queue to determine the size
 302  *      of the index array.
 303  */
 304 enum queue_index {
 305         Q_INDEX,
 306         Q_INDEX_DONE,
 307         Q_INDEX_CRYPTO,
 308         Q_INDEX_MAX,
 309 };
 310
 311 /**
 312  * struct data_queue: Data queue
 313  *
 314  * @rt2x00dev: Pointer to main &struct rt2x00dev where this queue belongs to.
 315  * @entries: Base address of the &struct queue_entry which are
 316  *      part of this queue.
 317  * @qid: The queue identification, see &enum data_queue_qid.
 318  * @lock: Spinlock to protect index handling. Whenever @index, @index_done or
 319  *      @index_crypt needs to be changed this lock should be grabbed to prevent
 320  *      index corruption due to concurrency.
 321  * @count: Number of frames handled in the queue.
 322  * @limit: Maximum number of entries in the queue.
 323  * @threshold: Minimum number of free entries before queue is kicked by force.
 324  * @length: Number of frames in queue.
 325  * @index: Index pointers to entry positions in the queue,
 326  *      use &enum queue_index to get a specific index field.
 327  * @aifs: The aifs value for outgoing frames (field ignored in RX queue).
 328  * @cw_min: The cw min value for outgoing frames (field ignored in RX queue).
 329  * @cw_max: The cw max value for outgoing frames (field ignored in RX queue).
 330  * @data_size: Maximum data size for the frames in this queue.
 331  * @desc_size: Hardware descriptor size for the data in this queue.
 332  */
 333 struct data_queue {
 334         struct rt2x00_dev *rt2x00dev;
 335         struct queue_entry *entries;
 336
 337         enum data_queue_qid qid;
 338
 339         spinlock_t lock;
 340         unsigned int count;
 341         unsigned short limit;
 342         unsigned short threshold;
 343         unsigned short length;
 344         unsigned short index[Q_INDEX_MAX];
 345
 346         unsigned short aifs;
 347         unsigned short cw_min;
 348         unsigned short cw_max;
 349
 350         unsigned short data_size;
 351         unsigned short desc_size;
 352 };
 353
 354 /**
 355  * struct data_queue_desc: Data queue description
 356  *
 357  * The information in this structure is used by drivers
 358  * to inform rt2x00lib about the creation of the data queue.
 359  *
 360  * @entry_num: Maximum number of entries for a queue.
 361  * @data_size: Maximum data size for the frames in this queue.
 362  * @desc_size: Hardware descriptor size for the data in this queue.
 363  * @priv_size: Size of per-queue_entry private data.
 364  */
 365 struct data_queue_desc {
 366         unsigned short entry_num;
 367         unsigned short data_size;
 368         unsigned short desc_size;
 369         unsigned short priv_size;
 370 };
 371
 372 /**
 373  * queue_end - Return pointer to the last queue (HELPER MACRO).
 374  * @__dev: Pointer to &struct rt2x00_dev
 375  *
 376  * Using the base rx pointer and the maximum number of available queues,
 377  * this macro will return the address of 1 position beyond  the end of the
 378  * queues array.
 379  */
 380 #define queue_end(__dev) \
 381         &(__dev)->rx[(__dev)->data_queues]
 382
 383 /**
 384  * tx_queue_end - Return pointer to the last TX queue (HELPER MACRO).
 385  * @__dev: Pointer to &struct rt2x00_dev
 386  *
 387  * Using the base tx pointer and the maximum number of available TX
 388  * queues, this macro will return the address of 1 position beyond
 389  * the end of the TX queue array.
 390  */
 391 #define tx_queue_end(__dev) \
 392         &(__dev)->tx[(__dev)->ops->tx_queues]
 393
 394 /**
 395  * queue_loop - Loop through the queues within a specific range (HELPER MACRO).
 396  * @__entry: Pointer where the current queue entry will be stored in.
 397  * @__start: Start queue pointer.
 398  * @__end: End queue pointer.
 399  *
 400  * This macro will loop through all queues between &__start and &__end.
 401  */
 402 #define queue_loop(__entry, __start, __end)                     \
 403         for ((__entry) = (__start);                             \
 404              prefetch(&(__entry)[1]), (__entry) != (__end);     \
 405              (__entry) = &(__entry)[1])
 406
 407 /**
 408  * queue_for_each - Loop through all queues
 409  * @__dev: Pointer to &struct rt2x00_dev
 410  * @__entry: Pointer where the current queue entry will be stored in.
 411  *
 412  * This macro will loop through all available queues.
 413  */
 414 #define queue_for_each(__dev, __entry) \
 415         queue_loop(__entry, (__dev)->rx, queue_end(__dev))
 416
 417 /**
 418  * tx_queue_for_each - Loop through the TX queues
 419  * @__dev: Pointer to &struct rt2x00_dev
 420  * @__entry: Pointer where the current queue entry will be stored in.
 421  *
 422  * This macro will loop through all TX related queues excluding
 423  * the Beacon and Atim queues.
 424  */
 425 #define tx_queue_for_each(__dev, __entry) \
 426         queue_loop(__entry, (__dev)->tx, tx_queue_end(__dev))
 427
 428 /**
 429  * txall_queue_for_each - Loop through all TX related queues
 430  * @__dev: Pointer to &struct rt2x00_dev
 431  * @__entry: Pointer where the current queue entry will be stored in.
 432  *
 433  * This macro will loop through all TX related queues including
 434  * the Beacon and Atim queues.
 435  */
 436 #define txall_queue_for_each(__dev, __entry) \
 437         queue_loop(__entry, (__dev)->tx, queue_end(__dev))
 438
 439 /**
 440  * rt2x00queue_empty - Check if the queue is empty.
 441  * @queue: Queue to check if empty.
 442  */
 443 static inline int rt2x00queue_empty(struct data_queue *queue)
 444 {
 445         return queue->length == 0;
 446 }
 447
 448 /**
 449  * rt2x00queue_full - Check if the queue is full.
 450  * @queue: Queue to check if full.
 451  */
 452 static inline int rt2x00queue_full(struct data_queue *queue)
 453 {
 454         return queue->length == queue->limit;
 455 }
 456
 457 /**
 458  * rt2x00queue_free - Check the number of available entries in queue.
 459  * @queue: Queue to check.
 460  */
 461 static inline int rt2x00queue_available(struct data_queue *queue)
 462 {
 463         return queue->limit - queue->length;
 464 }
 465
 466 /**
 467  * rt2x00queue_threshold - Check if the queue is below threshold
 468  * @queue: Queue to check.
 469  */
 470 static inline int rt2x00queue_threshold(struct data_queue *queue)
 471 {
 472         return rt2x00queue_available(queue) < queue->threshold;
 473 }
 474
 475 /**
 476  * rt2x00_desc_read - Read a word from the hardware descriptor.
 477  * @desc: Base descriptor address
 478  * @word: Word index from where the descriptor should be read.
 479  * @value: Address where the descriptor value should be written into.
 480  */
 481 static inline void rt2x00_desc_read(__le32 *desc, const u8 word, u32 *value)
 482 {
 483         *value = le32_to_cpu(desc[word]);
 484 }
 485
 486 /**
 487  * rt2x00_desc_write - wrote a word to the hardware descriptor.
 488  * @desc: Base descriptor address
 489  * @word: Word index from where the descriptor should be written.
 490  * @value: Value that should be written into the descriptor.
 491  */
 492 static inline void rt2x00_desc_write(__le32 *desc, const u8 word, u32 value)
 493 {
 494         desc[word] = cpu_to_le32(value);
 495 }
 496
 497 #endif /* RT2X00QUEUE_H */