2 Copyright (C) 2004 - 2008 rt2x00 SourceForge Project
3 <http://rt2x00.serialmonkey.com>
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.
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.
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.
23 Abstract: rt2x00 queue datastructures and routines
29 #include <linux/prefetch.h>
32 * DOC: Entrie frame size
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.
39 #define DATA_FRAME_SIZE 2432
40 #define MGMT_FRAME_SIZE 256
43 * DOC: Number of entries per queue
45 * Under normal load without fragmentation 12 entries are sufficient
46 * without the queue being filled up to the maximum. When using fragmentation
47 * and the queue threshold code we need to add some additional margins to
48 * make sure the queue will never (or only under extreme load) fill up
50 * Since we don't use preallocated DMA having a large number of queue entries
51 * will have only minimal impact on the memory requirements for the queue.
55 #define BEACON_ENTRIES 1
56 #define ATIM_ENTRIES 8
59 * enum data_queue_qid: Queue identification
61 * @QID_AC_BE: AC BE queue
62 * @QID_AC_BK: AC BK queue
63 * @QID_AC_VI: AC VI queue
64 * @QID_AC_VO: AC VO queue
65 * @QID_HCCA: HCCA queue
66 * @QID_MGMT: MGMT queue (prio queue)
68 * @QID_OTHER: None of the above (don't use, only present for completeness)
69 * @QID_BEACON: Beacon queue (value unspecified, don't send it to device)
70 * @QID_ATIM: Atim queue (value unspeficied, don't send it to device)
86 * enum skb_frame_desc_flags: Flags for &struct skb_frame_desc
88 * @SKBDESC_DMA_MAPPED_RX: &skb_dma field has been mapped for RX
89 * @SKBDESC_DMA_MAPPED_TX: &skb_dma field has been mapped for TX
90 * @FRAME_DESC_IV_STRIPPED: Frame contained a IV/EIV provided by
91 * mac80211 but was stripped for processing by the driver.
93 enum skb_frame_desc_flags {
94 SKBDESC_DMA_MAPPED_RX = 1 << 0,
95 SKBDESC_DMA_MAPPED_TX = 1 << 1,
96 FRAME_DESC_IV_STRIPPED = 1 << 2,
100 * struct skb_frame_desc: Descriptor information for the skb buffer
102 * This structure is placed over the driver_data array, this means that
103 * this structure should not exceed the size of that array (40 bytes).
105 * @flags: Frame flags, see &enum skb_frame_desc_flags.
106 * @desc_len: Length of the frame descriptor.
107 * @desc: Pointer to descriptor part of the frame.
108 * Note that this pointer could point to something outside
109 * of the scope of the skb->data pointer.
110 * @iv: IV data used during encryption/decryption.
111 * @eiv: EIV data used during encryption/decryption.
112 * @skb_dma: (PCI-only) the DMA address associated with the sk buffer.
113 * @entry: The entry to which this sk buffer belongs.
115 struct skb_frame_desc {
118 unsigned int desc_len;
126 struct queue_entry *entry;
130 * get_skb_frame_desc - Obtain the rt2x00 frame descriptor from a sk_buff.
131 * @skb: &struct sk_buff from where we obtain the &struct skb_frame_desc
133 static inline struct skb_frame_desc* get_skb_frame_desc(struct sk_buff *skb)
135 BUILD_BUG_ON(sizeof(struct skb_frame_desc) >
136 IEEE80211_TX_INFO_DRIVER_DATA_SIZE);
137 return (struct skb_frame_desc *)&IEEE80211_SKB_CB(skb)->driver_data;
141 * enum rxdone_entry_desc_flags: Flags for &struct rxdone_entry_desc
143 * @RXDONE_SIGNAL_PLCP: Signal field contains the plcp value.
144 * @RXDONE_SIGNAL_BITRATE: Signal field contains the bitrate value.
145 * @RXDONE_MY_BSS: Does this frame originate from device's BSS.
147 enum rxdone_entry_desc_flags {
148 RXDONE_SIGNAL_PLCP = 1 << 0,
149 RXDONE_SIGNAL_BITRATE = 1 << 1,
150 RXDONE_MY_BSS = 1 << 2,
154 * struct rxdone_entry_desc: RX Entry descriptor
156 * Summary of information that has been read from the RX frame descriptor.
158 * @timestamp: RX Timestamp
159 * @signal: Signal of the received frame.
160 * @rssi: RSSI of the received frame.
161 * @size: Data size of the received frame.
162 * @flags: MAC80211 receive flags (See &enum mac80211_rx_flags).
163 * @dev_flags: Ralink receive flags (See &enum rxdone_entry_desc_flags).
164 * @cipher: Cipher type used during decryption.
165 * @cipher_status: Decryption status.
166 * @iv: IV data used during decryption.
167 * @eiv: EIV data used during decryption.
168 * @icv: ICV data used during decryption.
170 struct rxdone_entry_desc {
186 * enum txdone_entry_desc_flags: Flags for &struct txdone_entry_desc
188 * @TXDONE_UNKNOWN: Hardware could not determine success of transmission.
189 * @TXDONE_SUCCESS: Frame was successfully send
190 * @TXDONE_FAILURE: Frame was not successfully send
191 * @TXDONE_EXCESSIVE_RETRY: In addition to &TXDONE_FAILURE, the
192 * frame transmission failed due to excessive retries.
194 enum txdone_entry_desc_flags {
198 TXDONE_EXCESSIVE_RETRY,
202 * struct txdone_entry_desc: TX done entry descriptor
204 * Summary of information that has been read from the TX frame descriptor
205 * after the device is done with transmission.
207 * @flags: TX done flags (See &enum txdone_entry_desc_flags).
208 * @retry: Retry count.
210 struct txdone_entry_desc {
216 * enum txentry_desc_flags: Status flags for TX entry descriptor
218 * @ENTRY_TXD_RTS_FRAME: This frame is a RTS frame.
219 * @ENTRY_TXD_CTS_FRAME: This frame is a CTS-to-self frame.
220 * @ENTRY_TXD_OFDM_RATE: This frame is send out with an OFDM rate.
221 * @ENTRY_TXD_GENERATE_SEQ: This frame requires sequence counter.
222 * @ENTRY_TXD_FIRST_FRAGMENT: This is the first frame.
223 * @ENTRY_TXD_MORE_FRAG: This frame is followed by another fragment.
224 * @ENTRY_TXD_REQ_TIMESTAMP: Require timestamp to be inserted.
225 * @ENTRY_TXD_BURST: This frame belongs to the same burst event.
226 * @ENTRY_TXD_ACK: An ACK is required for this frame.
227 * @ENTRY_TXD_RETRY_MODE: When set, the long retry count is used.
228 * @ENTRY_TXD_ENCRYPT: This frame should be encrypted.
229 * @ENTRY_TXD_ENCRYPT_PAIRWISE: Use pairwise key table (instead of shared).
230 * @ENTRY_TXD_ENCRYPT_IV: Generate IV/EIV in hardware.
231 * @ENTRY_TXD_ENCRYPT_MMIC: Generate MIC in hardware.
233 enum txentry_desc_flags {
237 ENTRY_TXD_GENERATE_SEQ,
238 ENTRY_TXD_FIRST_FRAGMENT,
240 ENTRY_TXD_REQ_TIMESTAMP,
243 ENTRY_TXD_RETRY_MODE,
245 ENTRY_TXD_ENCRYPT_PAIRWISE,
246 ENTRY_TXD_ENCRYPT_IV,
247 ENTRY_TXD_ENCRYPT_MMIC,
251 * struct txentry_desc: TX Entry descriptor
253 * Summary of information for the frame descriptor before sending a TX frame.
255 * @flags: Descriptor flags (See &enum queue_entry_flags).
256 * @queue: Queue identification (See &enum data_queue_qid).
257 * @length_high: PLCP length high word.
258 * @length_low: PLCP length low word.
259 * @signal: PLCP signal.
260 * @service: PLCP service.
261 * @retry_limit: Max number of retries.
264 * @cw_min: cwmin value.
265 * @cw_max: cwmax value.
266 * @cipher: Cipher type used for encryption.
267 * @key_idx: Key index used for encryption.
268 * @iv_offset: Position where IV should be inserted by hardware.
270 struct txentry_desc {
273 enum data_queue_qid queue;
292 * enum queue_entry_flags: Status flags for queue entry
294 * @ENTRY_BCN_ASSIGNED: This entry has been assigned to an interface.
295 * As long as this bit is set, this entry may only be touched
296 * through the interface structure.
297 * @ENTRY_OWNER_DEVICE_DATA: This entry is owned by the device for data
298 * transfer (either TX or RX depending on the queue). The entry should
299 * only be touched after the device has signaled it is done with it.
300 * @ENTRY_OWNER_DEVICE_CRYPTO: This entry is owned by the device for data
301 * encryption or decryption. The entry should only be touched after
302 * the device has signaled it is done with it.
303 * @ENTRY_DATA_PENDING: This entry contains a valid frame and is waiting
304 * for the signal to start sending.
306 enum queue_entry_flags {
308 ENTRY_OWNER_DEVICE_DATA,
309 ENTRY_OWNER_DEVICE_CRYPTO,
314 * struct queue_entry: Entry inside the &struct data_queue
316 * @flags: Entry flags, see &enum queue_entry_flags.
317 * @queue: The data queue (&struct data_queue) to which this entry belongs.
318 * @skb: The buffer which is currently being transmitted (for TX queue),
319 * or used to directly recieve data in (for RX queue).
320 * @entry_idx: The entry index number.
321 * @priv_data: Private data belonging to this queue entry. The pointer
322 * points to data specific to a particular driver and queue type.
327 struct data_queue *queue;
331 unsigned int entry_idx;
337 * enum queue_index: Queue index type
339 * @Q_INDEX: Index pointer to the current entry in the queue, if this entry is
340 * owned by the hardware then the queue is considered to be full.
341 * @Q_INDEX_DONE: Index pointer to the next entry which will be completed by
342 * the hardware and for which we need to run the txdone handler. If this
343 * entry is not owned by the hardware the queue is considered to be empty.
344 * @Q_INDEX_CRYPTO: Index pointer to the next entry which encryption/decription
345 * will be completed by the hardware next.
346 * @Q_INDEX_MAX: Keep last, used in &struct data_queue to determine the size
347 * of the index array.
357 * struct data_queue: Data queue
359 * @rt2x00dev: Pointer to main &struct rt2x00dev where this queue belongs to.
360 * @entries: Base address of the &struct queue_entry which are
361 * part of this queue.
362 * @qid: The queue identification, see &enum data_queue_qid.
363 * @lock: Spinlock to protect index handling. Whenever @index, @index_done or
364 * @index_crypt needs to be changed this lock should be grabbed to prevent
365 * index corruption due to concurrency.
366 * @count: Number of frames handled in the queue.
367 * @limit: Maximum number of entries in the queue.
368 * @threshold: Minimum number of free entries before queue is kicked by force.
369 * @length: Number of frames in queue.
370 * @index: Index pointers to entry positions in the queue,
371 * use &enum queue_index to get a specific index field.
372 * @txop: maximum burst time.
373 * @aifs: The aifs value for outgoing frames (field ignored in RX queue).
374 * @cw_min: The cw min value for outgoing frames (field ignored in RX queue).
375 * @cw_max: The cw max value for outgoing frames (field ignored in RX queue).
376 * @data_size: Maximum data size for the frames in this queue.
377 * @desc_size: Hardware descriptor size for the data in this queue.
380 struct rt2x00_dev *rt2x00dev;
381 struct queue_entry *entries;
383 enum data_queue_qid qid;
387 unsigned short limit;
388 unsigned short threshold;
389 unsigned short length;
390 unsigned short index[Q_INDEX_MAX];
394 unsigned short cw_min;
395 unsigned short cw_max;
397 unsigned short data_size;
398 unsigned short desc_size;
402 * struct data_queue_desc: Data queue description
404 * The information in this structure is used by drivers
405 * to inform rt2x00lib about the creation of the data queue.
407 * @entry_num: Maximum number of entries for a queue.
408 * @data_size: Maximum data size for the frames in this queue.
409 * @desc_size: Hardware descriptor size for the data in this queue.
410 * @priv_size: Size of per-queue_entry private data.
412 struct data_queue_desc {
413 unsigned short entry_num;
414 unsigned short data_size;
415 unsigned short desc_size;
416 unsigned short priv_size;
420 * queue_end - Return pointer to the last queue (HELPER MACRO).
421 * @__dev: Pointer to &struct rt2x00_dev
423 * Using the base rx pointer and the maximum number of available queues,
424 * this macro will return the address of 1 position beyond the end of the
427 #define queue_end(__dev) \
428 &(__dev)->rx[(__dev)->data_queues]
431 * tx_queue_end - Return pointer to the last TX queue (HELPER MACRO).
432 * @__dev: Pointer to &struct rt2x00_dev
434 * Using the base tx pointer and the maximum number of available TX
435 * queues, this macro will return the address of 1 position beyond
436 * the end of the TX queue array.
438 #define tx_queue_end(__dev) \
439 &(__dev)->tx[(__dev)->ops->tx_queues]
442 * queue_loop - Loop through the queues within a specific range (HELPER MACRO).
443 * @__entry: Pointer where the current queue entry will be stored in.
444 * @__start: Start queue pointer.
445 * @__end: End queue pointer.
447 * This macro will loop through all queues between &__start and &__end.
449 #define queue_loop(__entry, __start, __end) \
450 for ((__entry) = (__start); \
451 prefetch(&(__entry)[1]), (__entry) != (__end); \
452 (__entry) = &(__entry)[1])
455 * queue_for_each - Loop through all queues
456 * @__dev: Pointer to &struct rt2x00_dev
457 * @__entry: Pointer where the current queue entry will be stored in.
459 * This macro will loop through all available queues.
461 #define queue_for_each(__dev, __entry) \
462 queue_loop(__entry, (__dev)->rx, queue_end(__dev))
465 * tx_queue_for_each - Loop through the TX queues
466 * @__dev: Pointer to &struct rt2x00_dev
467 * @__entry: Pointer where the current queue entry will be stored in.
469 * This macro will loop through all TX related queues excluding
470 * the Beacon and Atim queues.
472 #define tx_queue_for_each(__dev, __entry) \
473 queue_loop(__entry, (__dev)->tx, tx_queue_end(__dev))
476 * txall_queue_for_each - Loop through all TX related queues
477 * @__dev: Pointer to &struct rt2x00_dev
478 * @__entry: Pointer where the current queue entry will be stored in.
480 * This macro will loop through all TX related queues including
481 * the Beacon and Atim queues.
483 #define txall_queue_for_each(__dev, __entry) \
484 queue_loop(__entry, (__dev)->tx, queue_end(__dev))
487 * rt2x00queue_empty - Check if the queue is empty.
488 * @queue: Queue to check if empty.
490 static inline int rt2x00queue_empty(struct data_queue *queue)
492 return queue->length == 0;
496 * rt2x00queue_full - Check if the queue is full.
497 * @queue: Queue to check if full.
499 static inline int rt2x00queue_full(struct data_queue *queue)
501 return queue->length == queue->limit;
505 * rt2x00queue_free - Check the number of available entries in queue.
506 * @queue: Queue to check.
508 static inline int rt2x00queue_available(struct data_queue *queue)
510 return queue->limit - queue->length;
514 * rt2x00queue_threshold - Check if the queue is below threshold
515 * @queue: Queue to check.
517 static inline int rt2x00queue_threshold(struct data_queue *queue)
519 return rt2x00queue_available(queue) < queue->threshold;
523 * _rt2x00_desc_read - Read a word from the hardware descriptor.
524 * @desc: Base descriptor address
525 * @word: Word index from where the descriptor should be read.
526 * @value: Address where the descriptor value should be written into.
528 static inline void _rt2x00_desc_read(__le32 *desc, const u8 word, __le32 *value)
534 * rt2x00_desc_read - Read a word from the hardware descriptor, this
535 * function will take care of the byte ordering.
536 * @desc: Base descriptor address
537 * @word: Word index from where the descriptor should be read.
538 * @value: Address where the descriptor value should be written into.
540 static inline void rt2x00_desc_read(__le32 *desc, const u8 word, u32 *value)
543 _rt2x00_desc_read(desc, word, &tmp);
544 *value = le32_to_cpu(tmp);
548 * rt2x00_desc_write - write a word to the hardware descriptor, this
549 * function will take care of the byte ordering.
550 * @desc: Base descriptor address
551 * @word: Word index from where the descriptor should be written.
552 * @value: Value that should be written into the descriptor.
554 static inline void _rt2x00_desc_write(__le32 *desc, const u8 word, __le32 value)
560 * rt2x00_desc_write - write a word to the hardware descriptor.
561 * @desc: Base descriptor address
562 * @word: Word index from where the descriptor should be written.
563 * @value: Value that should be written into the descriptor.
565 static inline void rt2x00_desc_write(__le32 *desc, const u8 word, u32 value)
567 _rt2x00_desc_write(desc, word, cpu_to_le32(value));
570 #endif /* RT2X00QUEUE_H */