blob: 2233b911a1d7d7c5992db5681dcc1907d9719769 [file] [log] [blame]
Ivo van Doorn181d6902008-02-05 16:42:23 -05001/*
Ivo van Doorn7e613e12010-08-06 20:45:38 +02002 Copyright (C) 2004 - 2010 Ivo van Doorn <IvDoorn@gmail.com>
Ivo van Doorn181d6902008-02-05 16:42:23 -05003 <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
Jeff Kirshera05b8c52013-12-06 03:32:11 -080016 along with this program; if not, see <http://www.gnu.org/licenses/>.
Ivo van Doorn181d6902008-02-05 16:42:23 -050017 */
18
19/*
20 Module: rt2x00
21 Abstract: rt2x00 queue datastructures and routines
22 */
23
24#ifndef RT2X00QUEUE_H
25#define RT2X00QUEUE_H
26
27#include <linux/prefetch.h>
28
29/**
Luis Correia49513482009-07-17 21:39:19 +020030 * DOC: Entry frame size
Ivo van Doorn181d6902008-02-05 16:42:23 -050031 *
32 * Ralink PCI devices demand the Frame size to be a multiple of 128 bytes,
33 * for USB devices this restriction does not apply, but the value of
34 * 2432 makes sense since it is big enough to contain the maximum fragment
35 * size according to the ieee802.11 specs.
Ivo van Doorn35f00cf2009-04-26 16:09:32 +020036 * The aggregation size depends on support from the driver, but should
37 * be something around 3840 bytes.
Ivo van Doorn181d6902008-02-05 16:42:23 -050038 */
Ivo van Doorn35f00cf2009-04-26 16:09:32 +020039#define DATA_FRAME_SIZE 2432
40#define MGMT_FRAME_SIZE 256
41#define AGGREGATION_SIZE 3840
Ivo van Doorn181d6902008-02-05 16:42:23 -050042
43/**
Ivo van Doorn181d6902008-02-05 16:42:23 -050044 * enum data_queue_qid: Queue identification
Ivo van Doorne58c6ac2008-04-21 19:00:47 +020045 *
Ivo van Doornf615e9a2010-12-13 12:36:38 +010046 * @QID_AC_VO: AC VO queue
47 * @QID_AC_VI: AC VI queue
Ivo van Doorne58c6ac2008-04-21 19:00:47 +020048 * @QID_AC_BE: AC BE queue
49 * @QID_AC_BK: AC BK queue
Ivo van Doorne58c6ac2008-04-21 19:00:47 +020050 * @QID_HCCA: HCCA queue
51 * @QID_MGMT: MGMT queue (prio queue)
52 * @QID_RX: RX queue
53 * @QID_OTHER: None of the above (don't use, only present for completeness)
54 * @QID_BEACON: Beacon queue (value unspecified, don't send it to device)
Joe Perches1d616b12011-06-23 15:35:18 -070055 * @QID_ATIM: Atim queue (value unspecified, don't send it to device)
Ivo van Doorn181d6902008-02-05 16:42:23 -050056 */
57enum data_queue_qid {
Ivo van Doornf615e9a2010-12-13 12:36:38 +010058 QID_AC_VO = 0,
59 QID_AC_VI = 1,
60 QID_AC_BE = 2,
61 QID_AC_BK = 3,
Ivo van Doorn181d6902008-02-05 16:42:23 -050062 QID_HCCA = 4,
63 QID_MGMT = 13,
64 QID_RX = 14,
65 QID_OTHER = 15,
Ivo van Doorne58c6ac2008-04-21 19:00:47 +020066 QID_BEACON,
67 QID_ATIM,
Ivo van Doorn181d6902008-02-05 16:42:23 -050068};
69
70/**
Ivo van Doornbaf26a72008-02-17 17:32:08 +010071 * enum skb_frame_desc_flags: Flags for &struct skb_frame_desc
72 *
Ivo van Doornd74f5ba2008-06-16 19:56:54 +020073 * @SKBDESC_DMA_MAPPED_RX: &skb_dma field has been mapped for RX
74 * @SKBDESC_DMA_MAPPED_TX: &skb_dma field has been mapped for TX
Ivo van Doorn9f166172009-04-26 16:08:50 +020075 * @SKBDESC_IV_STRIPPED: Frame contained a IV/EIV provided by
Ivo van Doorn2bb057d2008-08-04 16:37:44 +020076 * mac80211 but was stripped for processing by the driver.
Johannes Berg7351c6b2009-11-19 01:08:30 +010077 * @SKBDESC_NOT_MAC80211: Frame didn't originate from mac80211,
78 * don't try to pass it back.
Gertjan van Wingerdefd76f142010-05-11 23:51:43 +020079 * @SKBDESC_DESC_IN_SKB: The descriptor is at the start of the
80 * skb, instead of in the desc field.
Ivo van Doornbaf26a72008-02-17 17:32:08 +010081 */
Gertjan van Wingerdec4da0042008-06-16 19:56:31 +020082enum skb_frame_desc_flags {
Ivo van Doorn2bb057d2008-08-04 16:37:44 +020083 SKBDESC_DMA_MAPPED_RX = 1 << 0,
84 SKBDESC_DMA_MAPPED_TX = 1 << 1,
Ivo van Doorn9f166172009-04-26 16:08:50 +020085 SKBDESC_IV_STRIPPED = 1 << 2,
Gertjan van Wingerde354e39d2009-12-04 23:47:02 +010086 SKBDESC_NOT_MAC80211 = 1 << 3,
Gertjan van Wingerdefd76f142010-05-11 23:51:43 +020087 SKBDESC_DESC_IN_SKB = 1 << 4,
Gertjan van Wingerdec4da0042008-06-16 19:56:31 +020088};
Ivo van Doornbaf26a72008-02-17 17:32:08 +010089
90/**
Ivo van Doorn181d6902008-02-05 16:42:23 -050091 * struct skb_frame_desc: Descriptor information for the skb buffer
92 *
Johannes Berge039fa42008-05-15 12:55:29 +020093 * This structure is placed over the driver_data array, this means that
94 * this structure should not exceed the size of that array (40 bytes).
Ivo van Doorn181d6902008-02-05 16:42:23 -050095 *
Ivo van Doornbaf26a72008-02-17 17:32:08 +010096 * @flags: Frame flags, see &enum skb_frame_desc_flags.
Gertjan van Wingerdec4da0042008-06-16 19:56:31 +020097 * @desc_len: Length of the frame descriptor.
Johannes Berge6a98542008-10-21 12:40:02 +020098 * @tx_rate_idx: the index of the TX rate, used for TX status reporting
99 * @tx_rate_flags: the TX rate flags, used for TX status reporting
Ivo van Doorn181d6902008-02-05 16:42:23 -0500100 * @desc: Pointer to descriptor part of the frame.
101 * Note that this pointer could point to something outside
102 * of the scope of the skb->data pointer.
Ivo van Doorn1ce9cda2008-12-02 18:19:48 +0100103 * @iv: IV/EIV data used during encryption/decryption.
Gertjan van Wingerdec4da0042008-06-16 19:56:31 +0200104 * @skb_dma: (PCI-only) the DMA address associated with the sk buffer.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500105 * @entry: The entry to which this sk buffer belongs.
106 */
107struct skb_frame_desc {
Johannes Berge6a98542008-10-21 12:40:02 +0200108 u8 flags;
Ivo van Doorn181d6902008-02-05 16:42:23 -0500109
Johannes Berge6a98542008-10-21 12:40:02 +0200110 u8 desc_len;
111 u8 tx_rate_idx;
112 u8 tx_rate_flags;
113
Gertjan van Wingerdec4da0042008-06-16 19:56:31 +0200114 void *desc;
115
Ivo van Doorn1ce9cda2008-12-02 18:19:48 +0100116 __le32 iv[2];
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200117
Gertjan van Wingerdec4da0042008-06-16 19:56:31 +0200118 dma_addr_t skb_dma;
Ivo van Doorn181d6902008-02-05 16:42:23 -0500119
Ivo van Doorn181d6902008-02-05 16:42:23 -0500120 struct queue_entry *entry;
121};
122
Johannes Berge039fa42008-05-15 12:55:29 +0200123/**
124 * get_skb_frame_desc - Obtain the rt2x00 frame descriptor from a sk_buff.
125 * @skb: &struct sk_buff from where we obtain the &struct skb_frame_desc
126 */
Ivo van Doorn181d6902008-02-05 16:42:23 -0500127static inline struct skb_frame_desc* get_skb_frame_desc(struct sk_buff *skb)
128{
Johannes Berge039fa42008-05-15 12:55:29 +0200129 BUILD_BUG_ON(sizeof(struct skb_frame_desc) >
130 IEEE80211_TX_INFO_DRIVER_DATA_SIZE);
131 return (struct skb_frame_desc *)&IEEE80211_SKB_CB(skb)->driver_data;
Ivo van Doorn181d6902008-02-05 16:42:23 -0500132}
133
134/**
Ivo van Doorn19d30e02008-03-15 21:38:07 +0100135 * enum rxdone_entry_desc_flags: Flags for &struct rxdone_entry_desc
136 *
Ivo van Doorn6c6aa3c2008-08-29 21:07:16 +0200137 * @RXDONE_SIGNAL_PLCP: Signal field contains the plcp value.
138 * @RXDONE_SIGNAL_BITRATE: Signal field contains the bitrate value.
Ivo van Doorn35f00cf2009-04-26 16:09:32 +0200139 * @RXDONE_SIGNAL_MCS: Signal field contains the mcs value.
Ivo van Doorn19d30e02008-03-15 21:38:07 +0100140 * @RXDONE_MY_BSS: Does this frame originate from device's BSS.
Ivo van Doorn74415ed2008-12-02 22:50:33 +0100141 * @RXDONE_CRYPTO_IV: Driver provided IV/EIV data.
142 * @RXDONE_CRYPTO_ICV: Driver provided ICV data.
Ivo van Doorn9f166172009-04-26 16:08:50 +0200143 * @RXDONE_L2PAD: 802.11 payload has been padded to 4-byte boundary.
Ivo van Doorn19d30e02008-03-15 21:38:07 +0100144 */
145enum rxdone_entry_desc_flags {
Ivo van Doorn35f00cf2009-04-26 16:09:32 +0200146 RXDONE_SIGNAL_PLCP = BIT(0),
147 RXDONE_SIGNAL_BITRATE = BIT(1),
148 RXDONE_SIGNAL_MCS = BIT(2),
149 RXDONE_MY_BSS = BIT(3),
150 RXDONE_CRYPTO_IV = BIT(4),
151 RXDONE_CRYPTO_ICV = BIT(5),
152 RXDONE_L2PAD = BIT(6),
Ivo van Doorn19d30e02008-03-15 21:38:07 +0100153};
154
155/**
Ivo van Doornb30dd5c02008-12-20 10:59:55 +0100156 * RXDONE_SIGNAL_MASK - Define to mask off all &rxdone_entry_desc_flags flags
157 * except for the RXDONE_SIGNAL_* flags. This is useful to convert the dev_flags
158 * from &rxdone_entry_desc to a signal value type.
159 */
160#define RXDONE_SIGNAL_MASK \
Ivo van Doorn35f00cf2009-04-26 16:09:32 +0200161 ( RXDONE_SIGNAL_PLCP | RXDONE_SIGNAL_BITRATE | RXDONE_SIGNAL_MCS )
Ivo van Doornb30dd5c02008-12-20 10:59:55 +0100162
163/**
Ivo van Doorn181d6902008-02-05 16:42:23 -0500164 * struct rxdone_entry_desc: RX Entry descriptor
165 *
166 * Summary of information that has been read from the RX frame descriptor.
167 *
Ivo van Doornae73e582008-07-04 16:14:59 +0200168 * @timestamp: RX Timestamp
Ivo van Doorn181d6902008-02-05 16:42:23 -0500169 * @signal: Signal of the received frame.
170 * @rssi: RSSI of the received frame.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500171 * @size: Data size of the received frame.
172 * @flags: MAC80211 receive flags (See &enum mac80211_rx_flags).
Ivo van Doorn19d30e02008-03-15 21:38:07 +0100173 * @dev_flags: Ralink receive flags (See &enum rxdone_entry_desc_flags).
Ivo van Doorn35f00cf2009-04-26 16:09:32 +0200174 * @rate_mode: Rate mode (See @enum rate_modulation).
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200175 * @cipher: Cipher type used during decryption.
176 * @cipher_status: Decryption status.
Ivo van Doorn1ce9cda2008-12-02 18:19:48 +0100177 * @iv: IV/EIV data used during decryption.
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200178 * @icv: ICV data used during decryption.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500179 */
180struct rxdone_entry_desc {
Ivo van Doornae73e582008-07-04 16:14:59 +0200181 u64 timestamp;
Ivo van Doorn181d6902008-02-05 16:42:23 -0500182 int signal;
Ivo van Doorn181d6902008-02-05 16:42:23 -0500183 int rssi;
Ivo van Doorn181d6902008-02-05 16:42:23 -0500184 int size;
185 int flags;
Ivo van Doorn19d30e02008-03-15 21:38:07 +0100186 int dev_flags;
Ivo van Doorn35f00cf2009-04-26 16:09:32 +0200187 u16 rate_mode;
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200188 u8 cipher;
189 u8 cipher_status;
190
Ivo van Doorn1ce9cda2008-12-02 18:19:48 +0100191 __le32 iv[2];
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200192 __le32 icv;
Ivo van Doorn181d6902008-02-05 16:42:23 -0500193};
194
195/**
Ivo van Doornfb55f4d12008-05-10 13:42:06 +0200196 * enum txdone_entry_desc_flags: Flags for &struct txdone_entry_desc
197 *
Helmut Schaa46678b12010-06-14 22:08:30 +0200198 * Every txdone report has to contain the basic result of the
199 * transmission, either &TXDONE_UNKNOWN, &TXDONE_SUCCESS or
200 * &TXDONE_FAILURE. The flag &TXDONE_FALLBACK can be used in
201 * conjunction with all of these flags but should only be set
202 * if retires > 0. The flag &TXDONE_EXCESSIVE_RETRY can only be used
203 * in conjunction with &TXDONE_FAILURE.
204 *
Ivo van Doornfb55f4d12008-05-10 13:42:06 +0200205 * @TXDONE_UNKNOWN: Hardware could not determine success of transmission.
206 * @TXDONE_SUCCESS: Frame was successfully send
Helmut Schaa46678b12010-06-14 22:08:30 +0200207 * @TXDONE_FALLBACK: Hardware used fallback rates for retries
Ivo van Doornfb55f4d12008-05-10 13:42:06 +0200208 * @TXDONE_FAILURE: Frame was not successfully send
209 * @TXDONE_EXCESSIVE_RETRY: In addition to &TXDONE_FAILURE, the
210 * frame transmission failed due to excessive retries.
211 */
212enum txdone_entry_desc_flags {
Jochen Friedrichf126cba2008-08-15 14:47:46 +0200213 TXDONE_UNKNOWN,
214 TXDONE_SUCCESS,
Benoit PAPILLAULT92ed48e2009-08-17 18:56:10 +0200215 TXDONE_FALLBACK,
Jochen Friedrichf126cba2008-08-15 14:47:46 +0200216 TXDONE_FAILURE,
217 TXDONE_EXCESSIVE_RETRY,
Helmut Schaaf16d2db2011-03-28 13:35:21 +0200218 TXDONE_AMPDU,
Ivo van Doornfb55f4d12008-05-10 13:42:06 +0200219};
220
221/**
Ivo van Doorn181d6902008-02-05 16:42:23 -0500222 * struct txdone_entry_desc: TX done entry descriptor
223 *
224 * Summary of information that has been read from the TX frame descriptor
225 * after the device is done with transmission.
226 *
Ivo van Doornfb55f4d12008-05-10 13:42:06 +0200227 * @flags: TX done flags (See &enum txdone_entry_desc_flags).
Ivo van Doorn181d6902008-02-05 16:42:23 -0500228 * @retry: Retry count.
229 */
230struct txdone_entry_desc {
Ivo van Doornfb55f4d12008-05-10 13:42:06 +0200231 unsigned long flags;
Ivo van Doorn181d6902008-02-05 16:42:23 -0500232 int retry;
233};
234
235/**
236 * enum txentry_desc_flags: Status flags for TX entry descriptor
237 *
238 * @ENTRY_TXD_RTS_FRAME: This frame is a RTS frame.
Ivo van Doorn7050ec82008-05-10 13:46:13 +0200239 * @ENTRY_TXD_CTS_FRAME: This frame is a CTS-to-self frame.
Ivo van Doorn5adf6d62008-07-20 18:03:38 +0200240 * @ENTRY_TXD_GENERATE_SEQ: This frame requires sequence counter.
Ivo van Doorn61486e02008-05-10 13:42:31 +0200241 * @ENTRY_TXD_FIRST_FRAGMENT: This is the first frame.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500242 * @ENTRY_TXD_MORE_FRAG: This frame is followed by another fragment.
243 * @ENTRY_TXD_REQ_TIMESTAMP: Require timestamp to be inserted.
244 * @ENTRY_TXD_BURST: This frame belongs to the same burst event.
245 * @ENTRY_TXD_ACK: An ACK is required for this frame.
Ivo van Doorn61486e02008-05-10 13:42:31 +0200246 * @ENTRY_TXD_RETRY_MODE: When set, the long retry count is used.
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200247 * @ENTRY_TXD_ENCRYPT: This frame should be encrypted.
248 * @ENTRY_TXD_ENCRYPT_PAIRWISE: Use pairwise key table (instead of shared).
249 * @ENTRY_TXD_ENCRYPT_IV: Generate IV/EIV in hardware.
250 * @ENTRY_TXD_ENCRYPT_MMIC: Generate MIC in hardware.
Ivo van Doorn35f00cf2009-04-26 16:09:32 +0200251 * @ENTRY_TXD_HT_AMPDU: This frame is part of an AMPDU.
252 * @ENTRY_TXD_HT_BW_40: Use 40MHz Bandwidth.
253 * @ENTRY_TXD_HT_SHORT_GI: Use short GI.
Ivo van Doorn84804cd2010-08-06 20:46:19 +0200254 * @ENTRY_TXD_HT_MIMO_PS: The receiving STA is in dynamic SM PS mode.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500255 */
256enum txentry_desc_flags {
257 ENTRY_TXD_RTS_FRAME,
Ivo van Doorn7050ec82008-05-10 13:46:13 +0200258 ENTRY_TXD_CTS_FRAME,
Ivo van Doorn5adf6d62008-07-20 18:03:38 +0200259 ENTRY_TXD_GENERATE_SEQ,
Ivo van Doorn61486e02008-05-10 13:42:31 +0200260 ENTRY_TXD_FIRST_FRAGMENT,
Ivo van Doorn181d6902008-02-05 16:42:23 -0500261 ENTRY_TXD_MORE_FRAG,
262 ENTRY_TXD_REQ_TIMESTAMP,
263 ENTRY_TXD_BURST,
264 ENTRY_TXD_ACK,
Ivo van Doorn61486e02008-05-10 13:42:31 +0200265 ENTRY_TXD_RETRY_MODE,
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200266 ENTRY_TXD_ENCRYPT,
267 ENTRY_TXD_ENCRYPT_PAIRWISE,
268 ENTRY_TXD_ENCRYPT_IV,
269 ENTRY_TXD_ENCRYPT_MMIC,
Ivo van Doorn35f00cf2009-04-26 16:09:32 +0200270 ENTRY_TXD_HT_AMPDU,
271 ENTRY_TXD_HT_BW_40,
272 ENTRY_TXD_HT_SHORT_GI,
Ivo van Doorn84804cd2010-08-06 20:46:19 +0200273 ENTRY_TXD_HT_MIMO_PS,
Ivo van Doorn181d6902008-02-05 16:42:23 -0500274};
275
276/**
277 * struct txentry_desc: TX Entry descriptor
278 *
279 * Summary of information for the frame descriptor before sending a TX frame.
280 *
281 * @flags: Descriptor flags (See &enum queue_entry_flags).
Gertjan van Wingerdedf624ca2010-05-03 22:43:05 +0200282 * @length: Length of the entire frame.
Ivo van Doorn9f166172009-04-26 16:08:50 +0200283 * @header_length: Length of 802.11 header.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500284 * @length_high: PLCP length high word.
285 * @length_low: PLCP length low word.
286 * @signal: PLCP signal.
287 * @service: PLCP service.
Ivo van Doorn35f00cf2009-04-26 16:09:32 +0200288 * @msc: MCS.
Helmut Schaa5dada062011-09-07 20:11:03 +0200289 * @stbc: Use Space Time Block Coding (only available for MCS rates < 8).
290 * @ba_size: Size of the recepients RX reorder buffer - 1.
Ivo van Doorn076f9582008-12-20 10:59:02 +0100291 * @rate_mode: Rate mode (See @enum rate_modulation).
Ivo van Doorn35f00cf2009-04-26 16:09:32 +0200292 * @mpdu_density: MDPU density.
Ivo van Doorn61486e02008-05-10 13:42:31 +0200293 * @retry_limit: Max number of retries.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500294 * @ifs: IFS value.
Helmut Schaa1affa092010-05-07 11:03:08 +0200295 * @txop: IFS value for 11n capable chips.
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200296 * @cipher: Cipher type used for encryption.
297 * @key_idx: Key index used for encryption.
298 * @iv_offset: Position where IV should be inserted by hardware.
Ivo van Doorn9eb4e212009-04-26 16:08:30 +0200299 * @iv_len: Length of IV data.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500300 */
301struct txentry_desc {
302 unsigned long flags;
303
Gertjan van Wingerdedf624ca2010-05-03 22:43:05 +0200304 u16 length;
Ivo van Doorn9f166172009-04-26 16:08:50 +0200305 u16 header_length;
Ivo van Doorn9f166172009-04-26 16:08:50 +0200306
Helmut Schaa26a1d072011-03-03 19:42:35 +0100307 union {
308 struct {
309 u16 length_high;
310 u16 length_low;
311 u16 signal;
312 u16 service;
Helmut Schaa25177942011-03-03 19:43:25 +0100313 enum ifs ifs;
Helmut Schaa26a1d072011-03-03 19:42:35 +0100314 } plcp;
Ivo van Doorn181d6902008-02-05 16:42:23 -0500315
Helmut Schaa26a1d072011-03-03 19:42:35 +0100316 struct {
317 u16 mcs;
Ivo van Doornfe107a52011-03-03 19:42:58 +0100318 u8 stbc;
319 u8 ba_size;
320 u8 mpdu_density;
321 enum txop txop;
Helmut Schaaead2bb62011-09-08 14:37:19 +0200322 int wcid;
Helmut Schaa26a1d072011-03-03 19:42:35 +0100323 } ht;
324 } u;
325
Helmut Schaa4df10c82011-03-03 19:44:10 +0100326 enum rate_modulation rate_mode;
Ivo van Doorn076f9582008-12-20 10:59:02 +0100327
Ivo van Doorn61486e02008-05-10 13:42:31 +0200328 short retry_limit;
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200329
330 enum cipher cipher;
331 u16 key_idx;
332 u16 iv_offset;
Ivo van Doorn9eb4e212009-04-26 16:08:30 +0200333 u16 iv_len;
Ivo van Doorn181d6902008-02-05 16:42:23 -0500334};
335
336/**
337 * enum queue_entry_flags: Status flags for queue entry
338 *
339 * @ENTRY_BCN_ASSIGNED: This entry has been assigned to an interface.
340 * As long as this bit is set, this entry may only be touched
341 * through the interface structure.
342 * @ENTRY_OWNER_DEVICE_DATA: This entry is owned by the device for data
343 * transfer (either TX or RX depending on the queue). The entry should
344 * only be touched after the device has signaled it is done with it.
Ivo van Doornf019d512008-06-06 22:47:39 +0200345 * @ENTRY_DATA_PENDING: This entry contains a valid frame and is waiting
346 * for the signal to start sending.
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300347 * @ENTRY_DATA_IO_FAILED: Hardware indicated that an IO error occurred
348 * while transferring the data to the hardware. No TX status report will
Ivo van Doorn7e613e12010-08-06 20:45:38 +0200349 * be expected from the hardware.
Ivo van Doorndba5dc12010-12-13 12:36:18 +0100350 * @ENTRY_DATA_STATUS_PENDING: The entry has been send to the device and
351 * returned. It is now waiting for the status reporting before the
352 * entry can be reused again.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500353 */
Ivo van Doorn181d6902008-02-05 16:42:23 -0500354enum queue_entry_flags {
355 ENTRY_BCN_ASSIGNED,
Stanislaw Gruszkaba089102014-06-05 13:52:24 +0200356 ENTRY_BCN_ENABLED,
Ivo van Doorn181d6902008-02-05 16:42:23 -0500357 ENTRY_OWNER_DEVICE_DATA,
Ivo van Doornf019d512008-06-06 22:47:39 +0200358 ENTRY_DATA_PENDING,
Ivo van Doorndba5dc12010-12-13 12:36:18 +0100359 ENTRY_DATA_IO_FAILED,
360 ENTRY_DATA_STATUS_PENDING,
Helmut Schaa8857d6d2013-03-15 09:57:57 +0100361 ENTRY_DATA_STATUS_SET,
Ivo van Doorn181d6902008-02-05 16:42:23 -0500362};
363
364/**
365 * struct queue_entry: Entry inside the &struct data_queue
366 *
367 * @flags: Entry flags, see &enum queue_entry_flags.
Johannes Stezenbach75256f02011-04-18 15:29:38 +0200368 * @last_action: Timestamp of last change.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500369 * @queue: The data queue (&struct data_queue) to which this entry belongs.
370 * @skb: The buffer which is currently being transmitted (for TX queue),
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300371 * or used to directly receive data in (for RX queue).
Ivo van Doorn181d6902008-02-05 16:42:23 -0500372 * @entry_idx: The entry index number.
373 * @priv_data: Private data belonging to this queue entry. The pointer
374 * points to data specific to a particular driver and queue type.
Helmut Schaa8857d6d2013-03-15 09:57:57 +0100375 * @status: Device specific status
Ivo van Doorn181d6902008-02-05 16:42:23 -0500376 */
377struct queue_entry {
378 unsigned long flags;
Johannes Stezenbach75256f02011-04-18 15:29:38 +0200379 unsigned long last_action;
Ivo van Doorn181d6902008-02-05 16:42:23 -0500380
381 struct data_queue *queue;
382
383 struct sk_buff *skb;
384
385 unsigned int entry_idx;
386
Helmut Schaa8857d6d2013-03-15 09:57:57 +0100387 u32 status;
388
Ivo van Doorn181d6902008-02-05 16:42:23 -0500389 void *priv_data;
390};
391
392/**
393 * enum queue_index: Queue index type
394 *
395 * @Q_INDEX: Index pointer to the current entry in the queue, if this entry is
396 * owned by the hardware then the queue is considered to be full.
Ivo van Doorn652a9dd2010-08-30 21:15:19 +0200397 * @Q_INDEX_DMA_DONE: Index pointer for the next entry which will have been
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300398 * transferred to the hardware.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500399 * @Q_INDEX_DONE: Index pointer to the next entry which will be completed by
400 * the hardware and for which we need to run the txdone handler. If this
401 * entry is not owned by the hardware the queue is considered to be empty.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500402 * @Q_INDEX_MAX: Keep last, used in &struct data_queue to determine the size
403 * of the index array.
404 */
405enum queue_index {
406 Q_INDEX,
Ivo van Doorn652a9dd2010-08-30 21:15:19 +0200407 Q_INDEX_DMA_DONE,
Ivo van Doorn181d6902008-02-05 16:42:23 -0500408 Q_INDEX_DONE,
Ivo van Doorn181d6902008-02-05 16:42:23 -0500409 Q_INDEX_MAX,
410};
411
412/**
Ivo van Doorn0b7fde52010-12-13 12:35:17 +0100413 * enum data_queue_flags: Status flags for data queues
414 *
415 * @QUEUE_STARTED: The queue has been started. Fox RX queues this means the
416 * device might be DMA'ing skbuffers. TX queues will accept skbuffers to
417 * be transmitted and beacon queues will start beaconing the configured
418 * beacons.
419 * @QUEUE_PAUSED: The queue has been started but is currently paused.
420 * When this bit is set, the queue has been stopped in mac80211,
421 * preventing new frames to be enqueued. However, a few frames
422 * might still appear shortly after the pausing...
423 */
424enum data_queue_flags {
425 QUEUE_STARTED,
426 QUEUE_PAUSED,
427};
428
429/**
Ivo van Doorn181d6902008-02-05 16:42:23 -0500430 * struct data_queue: Data queue
431 *
432 * @rt2x00dev: Pointer to main &struct rt2x00dev where this queue belongs to.
433 * @entries: Base address of the &struct queue_entry which are
434 * part of this queue.
435 * @qid: The queue identification, see &enum data_queue_qid.
Ivo van Doorn0b7fde52010-12-13 12:35:17 +0100436 * @flags: Entry flags, see &enum queue_entry_flags.
437 * @status_lock: The mutex for protecting the start/stop/flush
438 * handling on this queue.
Gertjan van Wingerde77a861c2011-07-06 22:56:24 +0200439 * @tx_lock: Spinlock to serialize tx operations on this queue.
Ivo van Doorn813f0332010-11-06 15:48:05 +0100440 * @index_lock: Spinlock to protect index handling. Whenever @index, @index_done or
Ivo van Doorn181d6902008-02-05 16:42:23 -0500441 * @index_crypt needs to be changed this lock should be grabbed to prevent
442 * index corruption due to concurrency.
443 * @count: Number of frames handled in the queue.
444 * @limit: Maximum number of entries in the queue.
Ivo van Doornb8697672008-06-06 22:53:14 +0200445 * @threshold: Minimum number of free entries before queue is kicked by force.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500446 * @length: Number of frames in queue.
447 * @index: Index pointers to entry positions in the queue,
448 * use &enum queue_index to get a specific index field.
Ivo van Doorn2af0a572008-08-29 21:05:45 +0200449 * @txop: maximum burst time.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500450 * @aifs: The aifs value for outgoing frames (field ignored in RX queue).
451 * @cw_min: The cw min value for outgoing frames (field ignored in RX queue).
452 * @cw_max: The cw max value for outgoing frames (field ignored in RX queue).
453 * @data_size: Maximum data size for the frames in this queue.
454 * @desc_size: Hardware descriptor size for the data in this queue.
Gabor Juhos568f7a42013-06-04 13:40:38 +0200455 * @priv_size: Size of per-queue_entry private data.
Ivo van Doornf1ca2162008-11-13 23:07:33 +0100456 * @usb_endpoint: Device endpoint used for communication (USB only)
457 * @usb_maxpacket: Max packet size for given endpoint (USB only)
Ivo van Doorn181d6902008-02-05 16:42:23 -0500458 */
459struct data_queue {
460 struct rt2x00_dev *rt2x00dev;
461 struct queue_entry *entries;
462
463 enum data_queue_qid qid;
Ivo van Doorn0b7fde52010-12-13 12:35:17 +0100464 unsigned long flags;
Ivo van Doorn181d6902008-02-05 16:42:23 -0500465
Ivo van Doorn0b7fde52010-12-13 12:35:17 +0100466 struct mutex status_lock;
Gertjan van Wingerde77a861c2011-07-06 22:56:24 +0200467 spinlock_t tx_lock;
Ivo van Doorn813f0332010-11-06 15:48:05 +0100468 spinlock_t index_lock;
Ivo van Doorn0b7fde52010-12-13 12:35:17 +0100469
Ivo van Doorn181d6902008-02-05 16:42:23 -0500470 unsigned int count;
471 unsigned short limit;
Ivo van Doornb8697672008-06-06 22:53:14 +0200472 unsigned short threshold;
Ivo van Doorn181d6902008-02-05 16:42:23 -0500473 unsigned short length;
474 unsigned short index[Q_INDEX_MAX];
475
Ivo van Doorn2af0a572008-08-29 21:05:45 +0200476 unsigned short txop;
Ivo van Doorn181d6902008-02-05 16:42:23 -0500477 unsigned short aifs;
478 unsigned short cw_min;
479 unsigned short cw_max;
480
481 unsigned short data_size;
Stanislaw Gruszkaf0bda572013-04-17 14:30:47 +0200482 unsigned char desc_size;
483 unsigned char winfo_size;
Gabor Juhos568f7a42013-06-04 13:40:38 +0200484 unsigned short priv_size;
Ivo van Doornf1ca2162008-11-13 23:07:33 +0100485
486 unsigned short usb_endpoint;
487 unsigned short usb_maxpacket;
Ivo van Doorn181d6902008-02-05 16:42:23 -0500488};
489
490/**
Ivo van Doorn181d6902008-02-05 16:42:23 -0500491 * queue_end - Return pointer to the last queue (HELPER MACRO).
492 * @__dev: Pointer to &struct rt2x00_dev
493 *
494 * Using the base rx pointer and the maximum number of available queues,
495 * this macro will return the address of 1 position beyond the end of the
496 * queues array.
497 */
498#define queue_end(__dev) \
499 &(__dev)->rx[(__dev)->data_queues]
500
501/**
502 * tx_queue_end - Return pointer to the last TX queue (HELPER MACRO).
503 * @__dev: Pointer to &struct rt2x00_dev
504 *
505 * Using the base tx pointer and the maximum number of available TX
506 * queues, this macro will return the address of 1 position beyond
507 * the end of the TX queue array.
508 */
509#define tx_queue_end(__dev) \
Gertjan van Wingerde61448f82008-05-10 13:43:33 +0200510 &(__dev)->tx[(__dev)->ops->tx_queues]
Ivo van Doorn181d6902008-02-05 16:42:23 -0500511
512/**
Ivo van Doornf1ca2162008-11-13 23:07:33 +0100513 * queue_next - Return pointer to next queue in list (HELPER MACRO).
514 * @__queue: Current queue for which we need the next queue
515 *
516 * Using the current queue address we take the address directly
517 * after the queue to take the next queue. Note that this macro
518 * should be used carefully since it does not protect against
519 * moving past the end of the list. (See macros &queue_end and
520 * &tx_queue_end for determining the end of the queue).
521 */
522#define queue_next(__queue) \
523 &(__queue)[1]
524
525/**
Ivo van Doorn181d6902008-02-05 16:42:23 -0500526 * queue_loop - Loop through the queues within a specific range (HELPER MACRO).
527 * @__entry: Pointer where the current queue entry will be stored in.
528 * @__start: Start queue pointer.
529 * @__end: End queue pointer.
530 *
531 * This macro will loop through all queues between &__start and &__end.
532 */
533#define queue_loop(__entry, __start, __end) \
534 for ((__entry) = (__start); \
Ivo van Doornf1ca2162008-11-13 23:07:33 +0100535 prefetch(queue_next(__entry)), (__entry) != (__end);\
536 (__entry) = queue_next(__entry))
Ivo van Doorn181d6902008-02-05 16:42:23 -0500537
538/**
539 * queue_for_each - Loop through all queues
540 * @__dev: Pointer to &struct rt2x00_dev
541 * @__entry: Pointer where the current queue entry will be stored in.
542 *
543 * This macro will loop through all available queues.
544 */
545#define queue_for_each(__dev, __entry) \
546 queue_loop(__entry, (__dev)->rx, queue_end(__dev))
547
548/**
549 * tx_queue_for_each - Loop through the TX queues
550 * @__dev: Pointer to &struct rt2x00_dev
551 * @__entry: Pointer where the current queue entry will be stored in.
552 *
553 * This macro will loop through all TX related queues excluding
554 * the Beacon and Atim queues.
555 */
556#define tx_queue_for_each(__dev, __entry) \
557 queue_loop(__entry, (__dev)->tx, tx_queue_end(__dev))
558
559/**
560 * txall_queue_for_each - Loop through all TX related queues
561 * @__dev: Pointer to &struct rt2x00_dev
562 * @__entry: Pointer where the current queue entry will be stored in.
563 *
564 * This macro will loop through all TX related queues including
565 * the Beacon and Atim queues.
566 */
567#define txall_queue_for_each(__dev, __entry) \
568 queue_loop(__entry, (__dev)->tx, queue_end(__dev))
569
570/**
Ivo van Doorn5eb7efe2010-08-23 19:54:21 +0200571 * rt2x00queue_for_each_entry - Loop through all entries in the queue
572 * @queue: Pointer to @data_queue
573 * @start: &enum queue_index Pointer to start index
574 * @end: &enum queue_index Pointer to end index
Helmut Schaa1dd0dbb2013-03-15 09:57:56 +0100575 * @data: Data to pass to the callback function
Ivo van Doorn5eb7efe2010-08-23 19:54:21 +0200576 * @fn: The function to call for each &struct queue_entry
577 *
578 * This will walk through all entries in the queue, in chronological
579 * order. This means it will start at the current @start pointer
580 * and will walk through the queue until it reaches the @end pointer.
Helmut Schaa10e11562011-04-18 15:27:43 +0200581 *
582 * If fn returns true for an entry rt2x00queue_for_each_entry will stop
583 * processing and return true as well.
Ivo van Doorn5eb7efe2010-08-23 19:54:21 +0200584 */
Helmut Schaa10e11562011-04-18 15:27:43 +0200585bool rt2x00queue_for_each_entry(struct data_queue *queue,
Ivo van Doorn5eb7efe2010-08-23 19:54:21 +0200586 enum queue_index start,
587 enum queue_index end,
Helmut Schaa1dd0dbb2013-03-15 09:57:56 +0100588 void *data,
589 bool (*fn)(struct queue_entry *entry,
590 void *data));
Ivo van Doorn5eb7efe2010-08-23 19:54:21 +0200591
592/**
Ivo van Doorn181d6902008-02-05 16:42:23 -0500593 * rt2x00queue_empty - Check if the queue is empty.
594 * @queue: Queue to check if empty.
595 */
596static inline int rt2x00queue_empty(struct data_queue *queue)
597{
598 return queue->length == 0;
599}
600
601/**
602 * rt2x00queue_full - Check if the queue is full.
603 * @queue: Queue to check if full.
604 */
605static inline int rt2x00queue_full(struct data_queue *queue)
606{
607 return queue->length == queue->limit;
608}
609
610/**
611 * rt2x00queue_free - Check the number of available entries in queue.
612 * @queue: Queue to check.
613 */
614static inline int rt2x00queue_available(struct data_queue *queue)
615{
616 return queue->limit - queue->length;
617}
618
619/**
Ivo van Doornb8697672008-06-06 22:53:14 +0200620 * rt2x00queue_threshold - Check if the queue is below threshold
621 * @queue: Queue to check.
622 */
623static inline int rt2x00queue_threshold(struct data_queue *queue)
624{
625 return rt2x00queue_available(queue) < queue->threshold;
626}
Ivo van Doorn652a9dd2010-08-30 21:15:19 +0200627/**
John W. Linvillecfef6042011-04-25 14:34:25 -0400628 * rt2x00queue_dma_timeout - Check if a timeout occurred for DMA transfers
Johannes Stezenbach75256f02011-04-18 15:29:38 +0200629 * @entry: Queue entry to check.
Ivo van Doorn652a9dd2010-08-30 21:15:19 +0200630 */
Johannes Stezenbach75256f02011-04-18 15:29:38 +0200631static inline int rt2x00queue_dma_timeout(struct queue_entry *entry)
Ivo van Doorn652a9dd2010-08-30 21:15:19 +0200632{
Johannes Stezenbach75256f02011-04-18 15:29:38 +0200633 if (!test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
634 return false;
635 return time_after(jiffies, entry->last_action + msecs_to_jiffies(100));
Ivo van Doornc965c742010-07-11 12:25:46 +0200636}
637
638/**
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200639 * _rt2x00_desc_read - Read a word from the hardware descriptor.
640 * @desc: Base descriptor address
641 * @word: Word index from where the descriptor should be read.
642 * @value: Address where the descriptor value should be written into.
643 */
644static inline void _rt2x00_desc_read(__le32 *desc, const u8 word, __le32 *value)
645{
646 *value = desc[word];
647}
648
649/**
650 * rt2x00_desc_read - Read a word from the hardware descriptor, this
651 * function will take care of the byte ordering.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500652 * @desc: Base descriptor address
653 * @word: Word index from where the descriptor should be read.
654 * @value: Address where the descriptor value should be written into.
655 */
656static inline void rt2x00_desc_read(__le32 *desc, const u8 word, u32 *value)
657{
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200658 __le32 tmp;
659 _rt2x00_desc_read(desc, word, &tmp);
660 *value = le32_to_cpu(tmp);
Ivo van Doorn181d6902008-02-05 16:42:23 -0500661}
662
663/**
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200664 * rt2x00_desc_write - write a word to the hardware descriptor, this
665 * function will take care of the byte ordering.
666 * @desc: Base descriptor address
667 * @word: Word index from where the descriptor should be written.
668 * @value: Value that should be written into the descriptor.
669 */
670static inline void _rt2x00_desc_write(__le32 *desc, const u8 word, __le32 value)
671{
672 desc[word] = value;
673}
674
675/**
676 * rt2x00_desc_write - write a word to the hardware descriptor.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500677 * @desc: Base descriptor address
678 * @word: Word index from where the descriptor should be written.
679 * @value: Value that should be written into the descriptor.
680 */
681static inline void rt2x00_desc_write(__le32 *desc, const u8 word, u32 value)
682{
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200683 _rt2x00_desc_write(desc, word, cpu_to_le32(value));
Ivo van Doorn181d6902008-02-05 16:42:23 -0500684}
685
686#endif /* RT2X00QUEUE_H */