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