Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[deliverable/linux.git] / drivers / net / wireless / rt2x00 / rt2x00queue.h
CommitLineData
181d6902 1/*
7e613e16 2 Copyright (C) 2004 - 2010 Ivo van Doorn <IvDoorn@gmail.com>
181d6902
ID
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/**
49513481 32 * DOC: Entry frame size
181d6902
ID
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.
35f00cfc
ID
38 * The aggregation size depends on support from the driver, but should
39 * be something around 3840 bytes.
181d6902 40 */
35f00cfc
ID
41#define DATA_FRAME_SIZE 2432
42#define MGMT_FRAME_SIZE 256
43#define AGGREGATION_SIZE 3840
181d6902 44
181d6902
ID
45/**
46 * enum data_queue_qid: Queue identification
e58c6aca 47 *
f615e9a3
ID
48 * @QID_AC_VO: AC VO queue
49 * @QID_AC_VI: AC VI queue
e58c6aca
ID
50 * @QID_AC_BE: AC BE queue
51 * @QID_AC_BK: AC BK queue
e58c6aca
ID
52 * @QID_HCCA: HCCA queue
53 * @QID_MGMT: MGMT queue (prio queue)
54 * @QID_RX: RX queue
55 * @QID_OTHER: None of the above (don't use, only present for completeness)
56 * @QID_BEACON: Beacon queue (value unspecified, don't send it to device)
1d616b14 57 * @QID_ATIM: Atim queue (value unspecified, don't send it to device)
181d6902
ID
58 */
59enum data_queue_qid {
f615e9a3
ID
60 QID_AC_VO = 0,
61 QID_AC_VI = 1,
62 QID_AC_BE = 2,
63 QID_AC_BK = 3,
181d6902
ID
64 QID_HCCA = 4,
65 QID_MGMT = 13,
66 QID_RX = 14,
67 QID_OTHER = 15,
e58c6aca
ID
68 QID_BEACON,
69 QID_ATIM,
181d6902
ID
70};
71
baf26a7e
ID
72/**
73 * enum skb_frame_desc_flags: Flags for &struct skb_frame_desc
74 *
d74f5ba4
ID
75 * @SKBDESC_DMA_MAPPED_RX: &skb_dma field has been mapped for RX
76 * @SKBDESC_DMA_MAPPED_TX: &skb_dma field has been mapped for TX
9f166171 77 * @SKBDESC_IV_STRIPPED: Frame contained a IV/EIV provided by
2bb057d0 78 * mac80211 but was stripped for processing by the driver.
7351c6bd
JB
79 * @SKBDESC_NOT_MAC80211: Frame didn't originate from mac80211,
80 * don't try to pass it back.
fd76f148
GW
81 * @SKBDESC_DESC_IN_SKB: The descriptor is at the start of the
82 * skb, instead of in the desc field.
baf26a7e 83 */
c4da0048 84enum skb_frame_desc_flags {
2bb057d0
ID
85 SKBDESC_DMA_MAPPED_RX = 1 << 0,
86 SKBDESC_DMA_MAPPED_TX = 1 << 1,
9f166171 87 SKBDESC_IV_STRIPPED = 1 << 2,
354e39db 88 SKBDESC_NOT_MAC80211 = 1 << 3,
fd76f148 89 SKBDESC_DESC_IN_SKB = 1 << 4,
c4da0048 90};
baf26a7e 91
181d6902
ID
92/**
93 * struct skb_frame_desc: Descriptor information for the skb buffer
94 *
e039fa4a
JB
95 * This structure is placed over the driver_data array, this means that
96 * this structure should not exceed the size of that array (40 bytes).
181d6902 97 *
baf26a7e 98 * @flags: Frame flags, see &enum skb_frame_desc_flags.
c4da0048 99 * @desc_len: Length of the frame descriptor.
e6a9854b
JB
100 * @tx_rate_idx: the index of the TX rate, used for TX status reporting
101 * @tx_rate_flags: the TX rate flags, used for TX status reporting
181d6902
ID
102 * @desc: Pointer to descriptor part of the frame.
103 * Note that this pointer could point to something outside
104 * of the scope of the skb->data pointer.
1ce9cdac 105 * @iv: IV/EIV data used during encryption/decryption.
c4da0048 106 * @skb_dma: (PCI-only) the DMA address associated with the sk buffer.
181d6902
ID
107 * @entry: The entry to which this sk buffer belongs.
108 */
109struct skb_frame_desc {
e6a9854b
JB
110 u8 flags;
111
112 u8 desc_len;
113 u8 tx_rate_idx;
114 u8 tx_rate_flags;
181d6902 115
c4da0048
GW
116 void *desc;
117
1ce9cdac 118 __le32 iv[2];
2bb057d0 119
c4da0048 120 dma_addr_t skb_dma;
181d6902 121
181d6902
ID
122 struct queue_entry *entry;
123};
124
e039fa4a
JB
125/**
126 * get_skb_frame_desc - Obtain the rt2x00 frame descriptor from a sk_buff.
127 * @skb: &struct sk_buff from where we obtain the &struct skb_frame_desc
128 */
181d6902
ID
129static inline struct skb_frame_desc* get_skb_frame_desc(struct sk_buff *skb)
130{
e039fa4a
JB
131 BUILD_BUG_ON(sizeof(struct skb_frame_desc) >
132 IEEE80211_TX_INFO_DRIVER_DATA_SIZE);
133 return (struct skb_frame_desc *)&IEEE80211_SKB_CB(skb)->driver_data;
181d6902
ID
134}
135
19d30e02
ID
136/**
137 * enum rxdone_entry_desc_flags: Flags for &struct rxdone_entry_desc
138 *
6c6aa3c0
ID
139 * @RXDONE_SIGNAL_PLCP: Signal field contains the plcp value.
140 * @RXDONE_SIGNAL_BITRATE: Signal field contains the bitrate value.
35f00cfc 141 * @RXDONE_SIGNAL_MCS: Signal field contains the mcs value.
19d30e02 142 * @RXDONE_MY_BSS: Does this frame originate from device's BSS.
74415edb
ID
143 * @RXDONE_CRYPTO_IV: Driver provided IV/EIV data.
144 * @RXDONE_CRYPTO_ICV: Driver provided ICV data.
9f166171 145 * @RXDONE_L2PAD: 802.11 payload has been padded to 4-byte boundary.
19d30e02
ID
146 */
147enum rxdone_entry_desc_flags {
35f00cfc
ID
148 RXDONE_SIGNAL_PLCP = BIT(0),
149 RXDONE_SIGNAL_BITRATE = BIT(1),
150 RXDONE_SIGNAL_MCS = BIT(2),
151 RXDONE_MY_BSS = BIT(3),
152 RXDONE_CRYPTO_IV = BIT(4),
153 RXDONE_CRYPTO_ICV = BIT(5),
154 RXDONE_L2PAD = BIT(6),
19d30e02
ID
155};
156
b30dd5c0
ID
157/**
158 * RXDONE_SIGNAL_MASK - Define to mask off all &rxdone_entry_desc_flags flags
159 * except for the RXDONE_SIGNAL_* flags. This is useful to convert the dev_flags
160 * from &rxdone_entry_desc to a signal value type.
161 */
162#define RXDONE_SIGNAL_MASK \
35f00cfc 163 ( RXDONE_SIGNAL_PLCP | RXDONE_SIGNAL_BITRATE | RXDONE_SIGNAL_MCS )
b30dd5c0 164
181d6902
ID
165/**
166 * struct rxdone_entry_desc: RX Entry descriptor
167 *
168 * Summary of information that has been read from the RX frame descriptor.
169 *
ae73e58e 170 * @timestamp: RX Timestamp
181d6902
ID
171 * @signal: Signal of the received frame.
172 * @rssi: RSSI of the received frame.
181d6902
ID
173 * @size: Data size of the received frame.
174 * @flags: MAC80211 receive flags (See &enum mac80211_rx_flags).
19d30e02 175 * @dev_flags: Ralink receive flags (See &enum rxdone_entry_desc_flags).
35f00cfc 176 * @rate_mode: Rate mode (See @enum rate_modulation).
2bb057d0
ID
177 * @cipher: Cipher type used during decryption.
178 * @cipher_status: Decryption status.
1ce9cdac 179 * @iv: IV/EIV data used during decryption.
2bb057d0 180 * @icv: ICV data used during decryption.
181d6902
ID
181 */
182struct rxdone_entry_desc {
ae73e58e 183 u64 timestamp;
181d6902
ID
184 int signal;
185 int rssi;
181d6902
ID
186 int size;
187 int flags;
19d30e02 188 int dev_flags;
35f00cfc 189 u16 rate_mode;
2bb057d0
ID
190 u8 cipher;
191 u8 cipher_status;
192
1ce9cdac 193 __le32 iv[2];
2bb057d0 194 __le32 icv;
181d6902
ID
195};
196
fb55f4d1
ID
197/**
198 * enum txdone_entry_desc_flags: Flags for &struct txdone_entry_desc
199 *
46678b19
HS
200 * Every txdone report has to contain the basic result of the
201 * transmission, either &TXDONE_UNKNOWN, &TXDONE_SUCCESS or
202 * &TXDONE_FAILURE. The flag &TXDONE_FALLBACK can be used in
203 * conjunction with all of these flags but should only be set
204 * if retires > 0. The flag &TXDONE_EXCESSIVE_RETRY can only be used
205 * in conjunction with &TXDONE_FAILURE.
206 *
fb55f4d1
ID
207 * @TXDONE_UNKNOWN: Hardware could not determine success of transmission.
208 * @TXDONE_SUCCESS: Frame was successfully send
46678b19 209 * @TXDONE_FALLBACK: Hardware used fallback rates for retries
fb55f4d1
ID
210 * @TXDONE_FAILURE: Frame was not successfully send
211 * @TXDONE_EXCESSIVE_RETRY: In addition to &TXDONE_FAILURE, the
212 * frame transmission failed due to excessive retries.
213 */
214enum txdone_entry_desc_flags {
f126cba4
JF
215 TXDONE_UNKNOWN,
216 TXDONE_SUCCESS,
92ed48e5 217 TXDONE_FALLBACK,
f126cba4
JF
218 TXDONE_FAILURE,
219 TXDONE_EXCESSIVE_RETRY,
f16d2db7 220 TXDONE_AMPDU,
fb55f4d1
ID
221};
222
181d6902
ID
223/**
224 * struct txdone_entry_desc: TX done entry descriptor
225 *
226 * Summary of information that has been read from the TX frame descriptor
227 * after the device is done with transmission.
228 *
fb55f4d1 229 * @flags: TX done flags (See &enum txdone_entry_desc_flags).
181d6902
ID
230 * @retry: Retry count.
231 */
232struct txdone_entry_desc {
fb55f4d1 233 unsigned long flags;
181d6902
ID
234 int retry;
235};
236
237/**
238 * enum txentry_desc_flags: Status flags for TX entry descriptor
239 *
240 * @ENTRY_TXD_RTS_FRAME: This frame is a RTS frame.
7050ec82 241 * @ENTRY_TXD_CTS_FRAME: This frame is a CTS-to-self frame.
5adf6d63 242 * @ENTRY_TXD_GENERATE_SEQ: This frame requires sequence counter.
61486e0f 243 * @ENTRY_TXD_FIRST_FRAGMENT: This is the first frame.
181d6902
ID
244 * @ENTRY_TXD_MORE_FRAG: This frame is followed by another fragment.
245 * @ENTRY_TXD_REQ_TIMESTAMP: Require timestamp to be inserted.
246 * @ENTRY_TXD_BURST: This frame belongs to the same burst event.
247 * @ENTRY_TXD_ACK: An ACK is required for this frame.
61486e0f 248 * @ENTRY_TXD_RETRY_MODE: When set, the long retry count is used.
2bb057d0
ID
249 * @ENTRY_TXD_ENCRYPT: This frame should be encrypted.
250 * @ENTRY_TXD_ENCRYPT_PAIRWISE: Use pairwise key table (instead of shared).
251 * @ENTRY_TXD_ENCRYPT_IV: Generate IV/EIV in hardware.
252 * @ENTRY_TXD_ENCRYPT_MMIC: Generate MIC in hardware.
35f00cfc
ID
253 * @ENTRY_TXD_HT_AMPDU: This frame is part of an AMPDU.
254 * @ENTRY_TXD_HT_BW_40: Use 40MHz Bandwidth.
255 * @ENTRY_TXD_HT_SHORT_GI: Use short GI.
84804cdc 256 * @ENTRY_TXD_HT_MIMO_PS: The receiving STA is in dynamic SM PS mode.
181d6902
ID
257 */
258enum txentry_desc_flags {
259 ENTRY_TXD_RTS_FRAME,
7050ec82 260 ENTRY_TXD_CTS_FRAME,
5adf6d63 261 ENTRY_TXD_GENERATE_SEQ,
61486e0f 262 ENTRY_TXD_FIRST_FRAGMENT,
181d6902
ID
263 ENTRY_TXD_MORE_FRAG,
264 ENTRY_TXD_REQ_TIMESTAMP,
265 ENTRY_TXD_BURST,
266 ENTRY_TXD_ACK,
61486e0f 267 ENTRY_TXD_RETRY_MODE,
2bb057d0
ID
268 ENTRY_TXD_ENCRYPT,
269 ENTRY_TXD_ENCRYPT_PAIRWISE,
270 ENTRY_TXD_ENCRYPT_IV,
271 ENTRY_TXD_ENCRYPT_MMIC,
35f00cfc
ID
272 ENTRY_TXD_HT_AMPDU,
273 ENTRY_TXD_HT_BW_40,
274 ENTRY_TXD_HT_SHORT_GI,
84804cdc 275 ENTRY_TXD_HT_MIMO_PS,
181d6902
ID
276};
277
278/**
279 * struct txentry_desc: TX Entry descriptor
280 *
281 * Summary of information for the frame descriptor before sending a TX frame.
282 *
283 * @flags: Descriptor flags (See &enum queue_entry_flags).
df624ca5 284 * @length: Length of the entire frame.
9f166171 285 * @header_length: Length of 802.11 header.
181d6902
ID
286 * @length_high: PLCP length high word.
287 * @length_low: PLCP length low word.
288 * @signal: PLCP signal.
289 * @service: PLCP service.
35f00cfc 290 * @msc: MCS.
5dada06c
HS
291 * @stbc: Use Space Time Block Coding (only available for MCS rates < 8).
292 * @ba_size: Size of the recepients RX reorder buffer - 1.
076f9582 293 * @rate_mode: Rate mode (See @enum rate_modulation).
35f00cfc 294 * @mpdu_density: MDPU density.
61486e0f 295 * @retry_limit: Max number of retries.
181d6902 296 * @ifs: IFS value.
1affa091 297 * @txop: IFS value for 11n capable chips.
2bb057d0
ID
298 * @cipher: Cipher type used for encryption.
299 * @key_idx: Key index used for encryption.
300 * @iv_offset: Position where IV should be inserted by hardware.
9eb4e21e 301 * @iv_len: Length of IV data.
181d6902
ID
302 */
303struct txentry_desc {
304 unsigned long flags;
305
df624ca5 306 u16 length;
9f166171 307 u16 header_length;
9f166171 308
26a1d07f
HS
309 union {
310 struct {
311 u16 length_high;
312 u16 length_low;
313 u16 signal;
314 u16 service;
2517794b 315 enum ifs ifs;
26a1d07f
HS
316 } plcp;
317
318 struct {
319 u16 mcs;
fe107a52
ID
320 u8 stbc;
321 u8 ba_size;
322 u8 mpdu_density;
323 enum txop txop;
ead2bb64 324 int wcid;
26a1d07f
HS
325 } ht;
326 } u;
181d6902 327
4df10c8c 328 enum rate_modulation rate_mode;
076f9582 329
61486e0f 330 short retry_limit;
2bb057d0
ID
331
332 enum cipher cipher;
333 u16 key_idx;
334 u16 iv_offset;
9eb4e21e 335 u16 iv_len;
181d6902
ID
336};
337
338/**
339 * enum queue_entry_flags: Status flags for queue entry
340 *
341 * @ENTRY_BCN_ASSIGNED: This entry has been assigned to an interface.
342 * As long as this bit is set, this entry may only be touched
343 * through the interface structure.
344 * @ENTRY_OWNER_DEVICE_DATA: This entry is owned by the device for data
345 * transfer (either TX or RX depending on the queue). The entry should
346 * only be touched after the device has signaled it is done with it.
f019d514
ID
347 * @ENTRY_DATA_PENDING: This entry contains a valid frame and is waiting
348 * for the signal to start sending.
25985edc
LDM
349 * @ENTRY_DATA_IO_FAILED: Hardware indicated that an IO error occurred
350 * while transferring the data to the hardware. No TX status report will
7e613e16 351 * be expected from the hardware.
dba5dc1a
ID
352 * @ENTRY_DATA_STATUS_PENDING: The entry has been send to the device and
353 * returned. It is now waiting for the status reporting before the
354 * entry can be reused again.
181d6902 355 */
181d6902
ID
356enum queue_entry_flags {
357 ENTRY_BCN_ASSIGNED,
358 ENTRY_OWNER_DEVICE_DATA,
f019d514 359 ENTRY_DATA_PENDING,
dba5dc1a
ID
360 ENTRY_DATA_IO_FAILED,
361 ENTRY_DATA_STATUS_PENDING,
8857d6dc 362 ENTRY_DATA_STATUS_SET,
181d6902
ID
363};
364
365/**
366 * struct queue_entry: Entry inside the &struct data_queue
367 *
368 * @flags: Entry flags, see &enum queue_entry_flags.
75256f03 369 * @last_action: Timestamp of last change.
181d6902
ID
370 * @queue: The data queue (&struct data_queue) to which this entry belongs.
371 * @skb: The buffer which is currently being transmitted (for TX queue),
25985edc 372 * or used to directly receive data in (for RX queue).
181d6902
ID
373 * @entry_idx: The entry index number.
374 * @priv_data: Private data belonging to this queue entry. The pointer
375 * points to data specific to a particular driver and queue type.
8857d6dc 376 * @status: Device specific status
181d6902
ID
377 */
378struct queue_entry {
379 unsigned long flags;
75256f03 380 unsigned long last_action;
181d6902
ID
381
382 struct data_queue *queue;
383
384 struct sk_buff *skb;
385
386 unsigned int entry_idx;
387
8857d6dc
HS
388 u32 status;
389
181d6902
ID
390 void *priv_data;
391};
392
393/**
394 * enum queue_index: Queue index type
395 *
396 * @Q_INDEX: Index pointer to the current entry in the queue, if this entry is
397 * owned by the hardware then the queue is considered to be full.
652a9dd2 398 * @Q_INDEX_DMA_DONE: Index pointer for the next entry which will have been
25985edc 399 * transferred to the hardware.
181d6902
ID
400 * @Q_INDEX_DONE: Index pointer to the next entry which will be completed by
401 * the hardware and for which we need to run the txdone handler. If this
402 * entry is not owned by the hardware the queue is considered to be empty.
181d6902
ID
403 * @Q_INDEX_MAX: Keep last, used in &struct data_queue to determine the size
404 * of the index array.
405 */
406enum queue_index {
407 Q_INDEX,
652a9dd2 408 Q_INDEX_DMA_DONE,
181d6902 409 Q_INDEX_DONE,
181d6902
ID
410 Q_INDEX_MAX,
411};
412
0b7fde54
ID
413/**
414 * enum data_queue_flags: Status flags for data queues
415 *
416 * @QUEUE_STARTED: The queue has been started. Fox RX queues this means the
417 * device might be DMA'ing skbuffers. TX queues will accept skbuffers to
418 * be transmitted and beacon queues will start beaconing the configured
419 * beacons.
420 * @QUEUE_PAUSED: The queue has been started but is currently paused.
421 * When this bit is set, the queue has been stopped in mac80211,
422 * preventing new frames to be enqueued. However, a few frames
423 * might still appear shortly after the pausing...
424 */
425enum data_queue_flags {
426 QUEUE_STARTED,
427 QUEUE_PAUSED,
428};
429
181d6902
ID
430/**
431 * struct data_queue: Data queue
432 *
433 * @rt2x00dev: Pointer to main &struct rt2x00dev where this queue belongs to.
434 * @entries: Base address of the &struct queue_entry which are
435 * part of this queue.
436 * @qid: The queue identification, see &enum data_queue_qid.
0b7fde54
ID
437 * @flags: Entry flags, see &enum queue_entry_flags.
438 * @status_lock: The mutex for protecting the start/stop/flush
439 * handling on this queue.
77a861c4 440 * @tx_lock: Spinlock to serialize tx operations on this queue.
813f0339 441 * @index_lock: Spinlock to protect index handling. Whenever @index, @index_done or
181d6902
ID
442 * @index_crypt needs to be changed this lock should be grabbed to prevent
443 * index corruption due to concurrency.
444 * @count: Number of frames handled in the queue.
445 * @limit: Maximum number of entries in the queue.
b869767b 446 * @threshold: Minimum number of free entries before queue is kicked by force.
181d6902
ID
447 * @length: Number of frames in queue.
448 * @index: Index pointers to entry positions in the queue,
449 * use &enum queue_index to get a specific index field.
2af0a570 450 * @txop: maximum burst time.
181d6902
ID
451 * @aifs: The aifs value for outgoing frames (field ignored in RX queue).
452 * @cw_min: The cw min value for outgoing frames (field ignored in RX queue).
453 * @cw_max: The cw max value for outgoing frames (field ignored in RX queue).
454 * @data_size: Maximum data size for the frames in this queue.
455 * @desc_size: Hardware descriptor size for the data in this queue.
568f7a43 456 * @priv_size: Size of per-queue_entry private data.
f1ca2167
ID
457 * @usb_endpoint: Device endpoint used for communication (USB only)
458 * @usb_maxpacket: Max packet size for given endpoint (USB only)
181d6902
ID
459 */
460struct data_queue {
461 struct rt2x00_dev *rt2x00dev;
462 struct queue_entry *entries;
463
464 enum data_queue_qid qid;
0b7fde54 465 unsigned long flags;
181d6902 466
0b7fde54 467 struct mutex status_lock;
77a861c4 468 spinlock_t tx_lock;
813f0339 469 spinlock_t index_lock;
0b7fde54 470
181d6902
ID
471 unsigned int count;
472 unsigned short limit;
b869767b 473 unsigned short threshold;
181d6902
ID
474 unsigned short length;
475 unsigned short index[Q_INDEX_MAX];
476
2af0a570 477 unsigned short txop;
181d6902
ID
478 unsigned short aifs;
479 unsigned short cw_min;
480 unsigned short cw_max;
481
482 unsigned short data_size;
f0bda571
SG
483 unsigned char desc_size;
484 unsigned char winfo_size;
568f7a43 485 unsigned short priv_size;
f1ca2167
ID
486
487 unsigned short usb_endpoint;
488 unsigned short usb_maxpacket;
181d6902
ID
489};
490
181d6902
ID
491/**
492 * queue_end - Return pointer to the last queue (HELPER MACRO).
493 * @__dev: Pointer to &struct rt2x00_dev
494 *
495 * Using the base rx pointer and the maximum number of available queues,
496 * this macro will return the address of 1 position beyond the end of the
497 * queues array.
498 */
499#define queue_end(__dev) \
500 &(__dev)->rx[(__dev)->data_queues]
501
502/**
503 * tx_queue_end - Return pointer to the last TX queue (HELPER MACRO).
504 * @__dev: Pointer to &struct rt2x00_dev
505 *
506 * Using the base tx pointer and the maximum number of available TX
507 * queues, this macro will return the address of 1 position beyond
508 * the end of the TX queue array.
509 */
510#define tx_queue_end(__dev) \
61448f88 511 &(__dev)->tx[(__dev)->ops->tx_queues]
181d6902 512
f1ca2167
ID
513/**
514 * queue_next - Return pointer to next queue in list (HELPER MACRO).
515 * @__queue: Current queue for which we need the next queue
516 *
517 * Using the current queue address we take the address directly
518 * after the queue to take the next queue. Note that this macro
519 * should be used carefully since it does not protect against
520 * moving past the end of the list. (See macros &queue_end and
521 * &tx_queue_end for determining the end of the queue).
522 */
523#define queue_next(__queue) \
524 &(__queue)[1]
525
181d6902
ID
526/**
527 * queue_loop - Loop through the queues within a specific range (HELPER MACRO).
528 * @__entry: Pointer where the current queue entry will be stored in.
529 * @__start: Start queue pointer.
530 * @__end: End queue pointer.
531 *
532 * This macro will loop through all queues between &__start and &__end.
533 */
534#define queue_loop(__entry, __start, __end) \
535 for ((__entry) = (__start); \
f1ca2167
ID
536 prefetch(queue_next(__entry)), (__entry) != (__end);\
537 (__entry) = queue_next(__entry))
181d6902
ID
538
539/**
540 * queue_for_each - Loop through all queues
541 * @__dev: Pointer to &struct rt2x00_dev
542 * @__entry: Pointer where the current queue entry will be stored in.
543 *
544 * This macro will loop through all available queues.
545 */
546#define queue_for_each(__dev, __entry) \
547 queue_loop(__entry, (__dev)->rx, queue_end(__dev))
548
549/**
550 * tx_queue_for_each - Loop through the TX queues
551 * @__dev: Pointer to &struct rt2x00_dev
552 * @__entry: Pointer where the current queue entry will be stored in.
553 *
554 * This macro will loop through all TX related queues excluding
555 * the Beacon and Atim queues.
556 */
557#define tx_queue_for_each(__dev, __entry) \
558 queue_loop(__entry, (__dev)->tx, tx_queue_end(__dev))
559
560/**
561 * txall_queue_for_each - Loop through all TX related queues
562 * @__dev: Pointer to &struct rt2x00_dev
563 * @__entry: Pointer where the current queue entry will be stored in.
564 *
565 * This macro will loop through all TX related queues including
566 * the Beacon and Atim queues.
567 */
568#define txall_queue_for_each(__dev, __entry) \
569 queue_loop(__entry, (__dev)->tx, queue_end(__dev))
570
5eb7efe8
ID
571/**
572 * rt2x00queue_for_each_entry - Loop through all entries in the queue
573 * @queue: Pointer to @data_queue
574 * @start: &enum queue_index Pointer to start index
575 * @end: &enum queue_index Pointer to end index
1dd0dbb3 576 * @data: Data to pass to the callback function
5eb7efe8
ID
577 * @fn: The function to call for each &struct queue_entry
578 *
579 * This will walk through all entries in the queue, in chronological
580 * order. This means it will start at the current @start pointer
581 * and will walk through the queue until it reaches the @end pointer.
10e11568
HS
582 *
583 * If fn returns true for an entry rt2x00queue_for_each_entry will stop
584 * processing and return true as well.
5eb7efe8 585 */
10e11568 586bool rt2x00queue_for_each_entry(struct data_queue *queue,
5eb7efe8
ID
587 enum queue_index start,
588 enum queue_index end,
1dd0dbb3
HS
589 void *data,
590 bool (*fn)(struct queue_entry *entry,
591 void *data));
5eb7efe8 592
181d6902
ID
593/**
594 * rt2x00queue_empty - Check if the queue is empty.
595 * @queue: Queue to check if empty.
596 */
597static inline int rt2x00queue_empty(struct data_queue *queue)
598{
599 return queue->length == 0;
600}
601
602/**
603 * rt2x00queue_full - Check if the queue is full.
604 * @queue: Queue to check if full.
605 */
606static inline int rt2x00queue_full(struct data_queue *queue)
607{
608 return queue->length == queue->limit;
609}
610
611/**
612 * rt2x00queue_free - Check the number of available entries in queue.
613 * @queue: Queue to check.
614 */
615static inline int rt2x00queue_available(struct data_queue *queue)
616{
617 return queue->limit - queue->length;
618}
619
b869767b
ID
620/**
621 * rt2x00queue_threshold - Check if the queue is below threshold
622 * @queue: Queue to check.
623 */
624static inline int rt2x00queue_threshold(struct data_queue *queue)
625{
626 return rt2x00queue_available(queue) < queue->threshold;
627}
652a9dd2 628/**
cfef6047 629 * rt2x00queue_dma_timeout - Check if a timeout occurred for DMA transfers
75256f03 630 * @entry: Queue entry to check.
652a9dd2 631 */
75256f03 632static inline int rt2x00queue_dma_timeout(struct queue_entry *entry)
652a9dd2 633{
75256f03
JS
634 if (!test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
635 return false;
636 return time_after(jiffies, entry->last_action + msecs_to_jiffies(100));
c965c74b
ID
637}
638
181d6902 639/**
2bb057d0
ID
640 * _rt2x00_desc_read - Read a word from the hardware descriptor.
641 * @desc: Base descriptor address
642 * @word: Word index from where the descriptor should be read.
643 * @value: Address where the descriptor value should be written into.
644 */
645static inline void _rt2x00_desc_read(__le32 *desc, const u8 word, __le32 *value)
646{
647 *value = desc[word];
648}
649
650/**
651 * rt2x00_desc_read - Read a word from the hardware descriptor, this
652 * function will take care of the byte ordering.
181d6902
ID
653 * @desc: Base descriptor address
654 * @word: Word index from where the descriptor should be read.
655 * @value: Address where the descriptor value should be written into.
656 */
657static inline void rt2x00_desc_read(__le32 *desc, const u8 word, u32 *value)
658{
2bb057d0
ID
659 __le32 tmp;
660 _rt2x00_desc_read(desc, word, &tmp);
661 *value = le32_to_cpu(tmp);
662}
663
664/**
665 * rt2x00_desc_write - write a word to the hardware descriptor, this
666 * function will take care of the byte ordering.
667 * @desc: Base descriptor address
668 * @word: Word index from where the descriptor should be written.
669 * @value: Value that should be written into the descriptor.
670 */
671static inline void _rt2x00_desc_write(__le32 *desc, const u8 word, __le32 value)
672{
673 desc[word] = value;
181d6902
ID
674}
675
676/**
2bb057d0 677 * rt2x00_desc_write - write a word to the hardware descriptor.
181d6902
ID
678 * @desc: Base descriptor address
679 * @word: Word index from where the descriptor should be written.
680 * @value: Value that should be written into the descriptor.
681 */
682static inline void rt2x00_desc_write(__le32 *desc, const u8 word, u32 value)
683{
2bb057d0 684 _rt2x00_desc_write(desc, word, cpu_to_le32(value));
181d6902
ID
685}
686
687#endif /* RT2X00QUEUE_H */
This page took 1.121571 seconds and 5 git commands to generate.