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