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