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