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