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