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