xref: /linux/drivers/net/wireless/ath/ath9k/mac.h (revision 60e13231561b3a4c5269bfa1ef6c0569ad6f28ec)
1 /*
2  * Copyright (c) 2008-2011 Atheros Communications Inc.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 #ifndef MAC_H
18 #define MAC_H
19 
20 #define RXSTATUS_RATE(ah, ads) (AR_SREV_5416_20_OR_LATER(ah) ?		\
21 				MS(ads->ds_rxstatus0, AR_RxRate) :	\
22 				(ads->ds_rxstatus3 >> 2) & 0xFF)
23 
24 #define set11nTries(_series, _index) \
25 	(SM((_series)[_index].Tries, AR_XmitDataTries##_index))
26 
27 #define set11nRate(_series, _index) \
28 	(SM((_series)[_index].Rate, AR_XmitRate##_index))
29 
30 #define set11nPktDurRTSCTS(_series, _index)				\
31 	(SM((_series)[_index].PktDuration, AR_PacketDur##_index) |	\
32 	 ((_series)[_index].RateFlags & ATH9K_RATESERIES_RTS_CTS   ?	\
33 	  AR_RTSCTSQual##_index : 0))
34 
35 #define set11nRateFlags(_series, _index)				\
36 	(((_series)[_index].RateFlags & ATH9K_RATESERIES_2040 ?		\
37 	  AR_2040_##_index : 0)						\
38 	 |((_series)[_index].RateFlags & ATH9K_RATESERIES_HALFGI ?	\
39 	   AR_GI##_index : 0)						\
40 	 |((_series)[_index].RateFlags & ATH9K_RATESERIES_STBC ?	\
41 	   AR_STBC##_index : 0)						\
42 	 |SM((_series)[_index].ChSel, AR_ChainSel##_index))
43 
44 #define CCK_SIFS_TIME        10
45 #define CCK_PREAMBLE_BITS   144
46 #define CCK_PLCP_BITS        48
47 
48 #define OFDM_SIFS_TIME        16
49 #define OFDM_PREAMBLE_TIME    20
50 #define OFDM_PLCP_BITS        22
51 #define OFDM_SYMBOL_TIME      4
52 
53 #define OFDM_SIFS_TIME_HALF     32
54 #define OFDM_PREAMBLE_TIME_HALF 40
55 #define OFDM_PLCP_BITS_HALF     22
56 #define OFDM_SYMBOL_TIME_HALF   8
57 
58 #define OFDM_SIFS_TIME_QUARTER      64
59 #define OFDM_PREAMBLE_TIME_QUARTER  80
60 #define OFDM_PLCP_BITS_QUARTER      22
61 #define OFDM_SYMBOL_TIME_QUARTER    16
62 
63 #define INIT_AIFS       2
64 #define INIT_CWMIN      15
65 #define INIT_CWMIN_11B  31
66 #define INIT_CWMAX      1023
67 #define INIT_SH_RETRY   10
68 #define INIT_LG_RETRY   10
69 #define INIT_SSH_RETRY  32
70 #define INIT_SLG_RETRY  32
71 
72 #define ATH9K_SLOT_TIME_6 6
73 #define ATH9K_SLOT_TIME_9 9
74 #define ATH9K_SLOT_TIME_20 20
75 
76 #define ATH9K_TXERR_XRETRY         0x01
77 #define ATH9K_TXERR_FILT           0x02
78 #define ATH9K_TXERR_FIFO           0x04
79 #define ATH9K_TXERR_XTXOP          0x08
80 #define ATH9K_TXERR_TIMER_EXPIRED  0x10
81 #define ATH9K_TX_ACKED		   0x20
82 #define ATH9K_TXERR_MASK						\
83 	(ATH9K_TXERR_XRETRY | ATH9K_TXERR_FILT | ATH9K_TXERR_FIFO |	\
84 	 ATH9K_TXERR_XTXOP | ATH9K_TXERR_TIMER_EXPIRED)
85 
86 #define ATH9K_TX_BA                0x01
87 #define ATH9K_TX_PWRMGMT           0x02
88 #define ATH9K_TX_DESC_CFG_ERR      0x04
89 #define ATH9K_TX_DATA_UNDERRUN     0x08
90 #define ATH9K_TX_DELIM_UNDERRUN    0x10
91 #define ATH9K_TX_SW_FILTERED       0x80
92 
93 /* 64 bytes */
94 #define MIN_TX_FIFO_THRESHOLD   0x1
95 
96 /*
97  * Single stream device AR9285 and AR9271 require 2 KB
98  * to work around a hardware issue, all other devices
99  * have can use the max 4 KB limit.
100  */
101 #define MAX_TX_FIFO_THRESHOLD   ((4096 / 64) - 1)
102 
103 struct ath_tx_status {
104 	u32 ts_tstamp;
105 	u16 ts_seqnum;
106 	u8 ts_status;
107 	u8 ts_rateindex;
108 	int8_t ts_rssi;
109 	u8 ts_shortretry;
110 	u8 ts_longretry;
111 	u8 ts_virtcol;
112 	u8 ts_flags;
113 	int8_t ts_rssi_ctl0;
114 	int8_t ts_rssi_ctl1;
115 	int8_t ts_rssi_ctl2;
116 	int8_t ts_rssi_ext0;
117 	int8_t ts_rssi_ext1;
118 	int8_t ts_rssi_ext2;
119 	u8 qid;
120 	u16 desc_id;
121 	u8 tid;
122 	u32 ba_low;
123 	u32 ba_high;
124 	u32 evm0;
125 	u32 evm1;
126 	u32 evm2;
127 };
128 
129 struct ath_rx_status {
130 	u32 rs_tstamp;
131 	u16 rs_datalen;
132 	u8 rs_status;
133 	u8 rs_phyerr;
134 	int8_t rs_rssi;
135 	u8 rs_keyix;
136 	u8 rs_rate;
137 	u8 rs_antenna;
138 	u8 rs_more;
139 	int8_t rs_rssi_ctl0;
140 	int8_t rs_rssi_ctl1;
141 	int8_t rs_rssi_ctl2;
142 	int8_t rs_rssi_ext0;
143 	int8_t rs_rssi_ext1;
144 	int8_t rs_rssi_ext2;
145 	u8 rs_isaggr;
146 	u8 rs_moreaggr;
147 	u8 rs_num_delims;
148 	u8 rs_flags;
149 	u32 evm0;
150 	u32 evm1;
151 	u32 evm2;
152 	u32 evm3;
153 	u32 evm4;
154 };
155 
156 struct ath_htc_rx_status {
157 	__be64 rs_tstamp;
158 	__be16 rs_datalen;
159 	u8 rs_status;
160 	u8 rs_phyerr;
161 	int8_t rs_rssi;
162 	int8_t rs_rssi_ctl0;
163 	int8_t rs_rssi_ctl1;
164 	int8_t rs_rssi_ctl2;
165 	int8_t rs_rssi_ext0;
166 	int8_t rs_rssi_ext1;
167 	int8_t rs_rssi_ext2;
168 	u8 rs_keyix;
169 	u8 rs_rate;
170 	u8 rs_antenna;
171 	u8 rs_more;
172 	u8 rs_isaggr;
173 	u8 rs_moreaggr;
174 	u8 rs_num_delims;
175 	u8 rs_flags;
176 	u8 rs_dummy;
177 	__be32 evm0;
178 	__be32 evm1;
179 	__be32 evm2;
180 };
181 
182 #define ATH9K_RXERR_CRC           0x01
183 #define ATH9K_RXERR_PHY           0x02
184 #define ATH9K_RXERR_FIFO          0x04
185 #define ATH9K_RXERR_DECRYPT       0x08
186 #define ATH9K_RXERR_MIC           0x10
187 
188 #define ATH9K_RX_MORE             0x01
189 #define ATH9K_RX_MORE_AGGR        0x02
190 #define ATH9K_RX_GI               0x04
191 #define ATH9K_RX_2040             0x08
192 #define ATH9K_RX_DELIM_CRC_PRE    0x10
193 #define ATH9K_RX_DELIM_CRC_POST   0x20
194 #define ATH9K_RX_DECRYPT_BUSY     0x40
195 
196 #define ATH9K_RXKEYIX_INVALID	((u8)-1)
197 #define ATH9K_TXKEYIX_INVALID	((u32)-1)
198 
199 enum ath9k_phyerr {
200 	ATH9K_PHYERR_UNDERRUN             = 0,  /* Transmit underrun */
201 	ATH9K_PHYERR_TIMING               = 1,  /* Timing error */
202 	ATH9K_PHYERR_PARITY               = 2,  /* Illegal parity */
203 	ATH9K_PHYERR_RATE                 = 3,  /* Illegal rate */
204 	ATH9K_PHYERR_LENGTH               = 4,  /* Illegal length */
205 	ATH9K_PHYERR_RADAR                = 5,  /* Radar detect */
206 	ATH9K_PHYERR_SERVICE              = 6,  /* Illegal service */
207 	ATH9K_PHYERR_TOR                  = 7,  /* Transmit override receive */
208 
209 	ATH9K_PHYERR_OFDM_TIMING          = 17,
210 	ATH9K_PHYERR_OFDM_SIGNAL_PARITY   = 18,
211 	ATH9K_PHYERR_OFDM_RATE_ILLEGAL    = 19,
212 	ATH9K_PHYERR_OFDM_LENGTH_ILLEGAL  = 20,
213 	ATH9K_PHYERR_OFDM_POWER_DROP      = 21,
214 	ATH9K_PHYERR_OFDM_SERVICE         = 22,
215 	ATH9K_PHYERR_OFDM_RESTART         = 23,
216 	ATH9K_PHYERR_FALSE_RADAR_EXT      = 24,
217 
218 	ATH9K_PHYERR_CCK_TIMING           = 25,
219 	ATH9K_PHYERR_CCK_HEADER_CRC       = 26,
220 	ATH9K_PHYERR_CCK_RATE_ILLEGAL     = 27,
221 	ATH9K_PHYERR_CCK_SERVICE          = 30,
222 	ATH9K_PHYERR_CCK_RESTART          = 31,
223 	ATH9K_PHYERR_CCK_LENGTH_ILLEGAL   = 32,
224 	ATH9K_PHYERR_CCK_POWER_DROP       = 33,
225 
226 	ATH9K_PHYERR_HT_CRC_ERROR         = 34,
227 	ATH9K_PHYERR_HT_LENGTH_ILLEGAL    = 35,
228 	ATH9K_PHYERR_HT_RATE_ILLEGAL      = 36,
229 
230 	ATH9K_PHYERR_MAX                  = 37,
231 };
232 
233 struct ath_desc {
234 	u32 ds_link;
235 	u32 ds_data;
236 	u32 ds_ctl0;
237 	u32 ds_ctl1;
238 	u32 ds_hw[20];
239 	void *ds_vdata;
240 } __packed __aligned(4);
241 
242 #define ATH9K_TXDESC_NOACK		0x0002
243 #define ATH9K_TXDESC_RTSENA		0x0004
244 #define ATH9K_TXDESC_CTSENA		0x0008
245 /* ATH9K_TXDESC_INTREQ forces a tx interrupt to be generated for
246  * the descriptor its marked on.  We take a tx interrupt to reap
247  * descriptors when the h/w hits an EOL condition or
248  * when the descriptor is specifically marked to generate
249  * an interrupt with this flag. Descriptors should be
250  * marked periodically to insure timely replenishing of the
251  * supply needed for sending frames. Defering interrupts
252  * reduces system load and potentially allows more concurrent
253  * work to be done but if done to aggressively can cause
254  * senders to backup. When the hardware queue is left too
255  * large rate control information may also be too out of
256  * date. An Alternative for this is TX interrupt mitigation
257  * but this needs more testing. */
258 #define ATH9K_TXDESC_INTREQ		0x0010
259 #define ATH9K_TXDESC_VEOL		0x0020
260 #define ATH9K_TXDESC_EXT_ONLY		0x0040
261 #define ATH9K_TXDESC_EXT_AND_CTL	0x0080
262 #define ATH9K_TXDESC_VMF		0x0100
263 #define ATH9K_TXDESC_FRAG_IS_ON 	0x0200
264 #define ATH9K_TXDESC_LOWRXCHAIN		0x0400
265 #define ATH9K_TXDESC_LDPC		0x00010000
266 
267 #define ATH9K_RXDESC_INTREQ		0x0020
268 
269 struct ar5416_desc {
270 	u32 ds_link;
271 	u32 ds_data;
272 	u32 ds_ctl0;
273 	u32 ds_ctl1;
274 	union {
275 		struct {
276 			u32 ctl2;
277 			u32 ctl3;
278 			u32 ctl4;
279 			u32 ctl5;
280 			u32 ctl6;
281 			u32 ctl7;
282 			u32 ctl8;
283 			u32 ctl9;
284 			u32 ctl10;
285 			u32 ctl11;
286 			u32 status0;
287 			u32 status1;
288 			u32 status2;
289 			u32 status3;
290 			u32 status4;
291 			u32 status5;
292 			u32 status6;
293 			u32 status7;
294 			u32 status8;
295 			u32 status9;
296 		} tx;
297 		struct {
298 			u32 status0;
299 			u32 status1;
300 			u32 status2;
301 			u32 status3;
302 			u32 status4;
303 			u32 status5;
304 			u32 status6;
305 			u32 status7;
306 			u32 status8;
307 		} rx;
308 	} u;
309 } __packed __aligned(4);
310 
311 #define AR5416DESC(_ds)         ((struct ar5416_desc *)(_ds))
312 #define AR5416DESC_CONST(_ds)   ((const struct ar5416_desc *)(_ds))
313 
314 #define ds_ctl2     u.tx.ctl2
315 #define ds_ctl3     u.tx.ctl3
316 #define ds_ctl4     u.tx.ctl4
317 #define ds_ctl5     u.tx.ctl5
318 #define ds_ctl6     u.tx.ctl6
319 #define ds_ctl7     u.tx.ctl7
320 #define ds_ctl8     u.tx.ctl8
321 #define ds_ctl9     u.tx.ctl9
322 #define ds_ctl10    u.tx.ctl10
323 #define ds_ctl11    u.tx.ctl11
324 
325 #define ds_txstatus0    u.tx.status0
326 #define ds_txstatus1    u.tx.status1
327 #define ds_txstatus2    u.tx.status2
328 #define ds_txstatus3    u.tx.status3
329 #define ds_txstatus4    u.tx.status4
330 #define ds_txstatus5    u.tx.status5
331 #define ds_txstatus6    u.tx.status6
332 #define ds_txstatus7    u.tx.status7
333 #define ds_txstatus8    u.tx.status8
334 #define ds_txstatus9    u.tx.status9
335 
336 #define ds_rxstatus0    u.rx.status0
337 #define ds_rxstatus1    u.rx.status1
338 #define ds_rxstatus2    u.rx.status2
339 #define ds_rxstatus3    u.rx.status3
340 #define ds_rxstatus4    u.rx.status4
341 #define ds_rxstatus5    u.rx.status5
342 #define ds_rxstatus6    u.rx.status6
343 #define ds_rxstatus7    u.rx.status7
344 #define ds_rxstatus8    u.rx.status8
345 
346 #define AR_FrameLen         0x00000fff
347 #define AR_VirtMoreFrag     0x00001000
348 #define AR_TxCtlRsvd00      0x0000e000
349 #define AR_XmitPower        0x003f0000
350 #define AR_XmitPower_S      16
351 #define AR_RTSEnable        0x00400000
352 #define AR_VEOL             0x00800000
353 #define AR_ClrDestMask      0x01000000
354 #define AR_TxCtlRsvd01      0x1e000000
355 #define AR_TxIntrReq        0x20000000
356 #define AR_DestIdxValid     0x40000000
357 #define AR_CTSEnable        0x80000000
358 
359 #define AR_TxMore           0x00001000
360 #define AR_DestIdx          0x000fe000
361 #define AR_DestIdx_S        13
362 #define AR_FrameType        0x00f00000
363 #define AR_FrameType_S      20
364 #define AR_NoAck            0x01000000
365 #define AR_InsertTS         0x02000000
366 #define AR_CorruptFCS       0x04000000
367 #define AR_ExtOnly          0x08000000
368 #define AR_ExtAndCtl        0x10000000
369 #define AR_MoreAggr         0x20000000
370 #define AR_IsAggr           0x40000000
371 
372 #define AR_BurstDur         0x00007fff
373 #define AR_BurstDur_S       0
374 #define AR_DurUpdateEna     0x00008000
375 #define AR_XmitDataTries0   0x000f0000
376 #define AR_XmitDataTries0_S 16
377 #define AR_XmitDataTries1   0x00f00000
378 #define AR_XmitDataTries1_S 20
379 #define AR_XmitDataTries2   0x0f000000
380 #define AR_XmitDataTries2_S 24
381 #define AR_XmitDataTries3   0xf0000000
382 #define AR_XmitDataTries3_S 28
383 
384 #define AR_XmitRate0        0x000000ff
385 #define AR_XmitRate0_S      0
386 #define AR_XmitRate1        0x0000ff00
387 #define AR_XmitRate1_S      8
388 #define AR_XmitRate2        0x00ff0000
389 #define AR_XmitRate2_S      16
390 #define AR_XmitRate3        0xff000000
391 #define AR_XmitRate3_S      24
392 
393 #define AR_PacketDur0       0x00007fff
394 #define AR_PacketDur0_S     0
395 #define AR_RTSCTSQual0      0x00008000
396 #define AR_PacketDur1       0x7fff0000
397 #define AR_PacketDur1_S     16
398 #define AR_RTSCTSQual1      0x80000000
399 
400 #define AR_PacketDur2       0x00007fff
401 #define AR_PacketDur2_S     0
402 #define AR_RTSCTSQual2      0x00008000
403 #define AR_PacketDur3       0x7fff0000
404 #define AR_PacketDur3_S     16
405 #define AR_RTSCTSQual3      0x80000000
406 
407 #define AR_AggrLen          0x0000ffff
408 #define AR_AggrLen_S        0
409 #define AR_TxCtlRsvd60      0x00030000
410 #define AR_PadDelim         0x03fc0000
411 #define AR_PadDelim_S       18
412 #define AR_EncrType         0x0c000000
413 #define AR_EncrType_S       26
414 #define AR_TxCtlRsvd61      0xf0000000
415 #define AR_LDPC             0x80000000
416 
417 #define AR_2040_0           0x00000001
418 #define AR_GI0              0x00000002
419 #define AR_ChainSel0        0x0000001c
420 #define AR_ChainSel0_S      2
421 #define AR_2040_1           0x00000020
422 #define AR_GI1              0x00000040
423 #define AR_ChainSel1        0x00000380
424 #define AR_ChainSel1_S      7
425 #define AR_2040_2           0x00000400
426 #define AR_GI2              0x00000800
427 #define AR_ChainSel2        0x00007000
428 #define AR_ChainSel2_S      12
429 #define AR_2040_3           0x00008000
430 #define AR_GI3              0x00010000
431 #define AR_ChainSel3        0x000e0000
432 #define AR_ChainSel3_S      17
433 #define AR_RTSCTSRate       0x0ff00000
434 #define AR_RTSCTSRate_S     20
435 #define AR_STBC0            0x10000000
436 #define AR_STBC1            0x20000000
437 #define AR_STBC2            0x40000000
438 #define AR_STBC3            0x80000000
439 
440 #define AR_TxRSSIAnt00      0x000000ff
441 #define AR_TxRSSIAnt00_S    0
442 #define AR_TxRSSIAnt01      0x0000ff00
443 #define AR_TxRSSIAnt01_S    8
444 #define AR_TxRSSIAnt02      0x00ff0000
445 #define AR_TxRSSIAnt02_S    16
446 #define AR_TxStatusRsvd00   0x3f000000
447 #define AR_TxBaStatus       0x40000000
448 #define AR_TxStatusRsvd01   0x80000000
449 
450 /*
451  * AR_FrmXmitOK - Frame transmission success flag. If set, the frame was
452  * transmitted successfully. If clear, no ACK or BA was received to indicate
453  * successful transmission when we were expecting an ACK or BA.
454  */
455 #define AR_FrmXmitOK            0x00000001
456 #define AR_ExcessiveRetries     0x00000002
457 #define AR_FIFOUnderrun         0x00000004
458 #define AR_Filtered             0x00000008
459 #define AR_RTSFailCnt           0x000000f0
460 #define AR_RTSFailCnt_S         4
461 #define AR_DataFailCnt          0x00000f00
462 #define AR_DataFailCnt_S        8
463 #define AR_VirtRetryCnt         0x0000f000
464 #define AR_VirtRetryCnt_S       12
465 #define AR_TxDelimUnderrun      0x00010000
466 #define AR_TxDataUnderrun       0x00020000
467 #define AR_DescCfgErr           0x00040000
468 #define AR_TxTimerExpired       0x00080000
469 #define AR_TxStatusRsvd10       0xfff00000
470 
471 #define AR_SendTimestamp    ds_txstatus2
472 #define AR_BaBitmapLow      ds_txstatus3
473 #define AR_BaBitmapHigh     ds_txstatus4
474 
475 #define AR_TxRSSIAnt10      0x000000ff
476 #define AR_TxRSSIAnt10_S    0
477 #define AR_TxRSSIAnt11      0x0000ff00
478 #define AR_TxRSSIAnt11_S    8
479 #define AR_TxRSSIAnt12      0x00ff0000
480 #define AR_TxRSSIAnt12_S    16
481 #define AR_TxRSSICombined   0xff000000
482 #define AR_TxRSSICombined_S 24
483 
484 #define AR_TxTid	0xf0000000
485 #define AR_TxTid_S	28
486 
487 #define AR_TxEVM0           ds_txstatus5
488 #define AR_TxEVM1           ds_txstatus6
489 #define AR_TxEVM2           ds_txstatus7
490 
491 #define AR_TxDone           0x00000001
492 #define AR_SeqNum           0x00001ffe
493 #define AR_SeqNum_S         1
494 #define AR_TxStatusRsvd80   0x0001e000
495 #define AR_TxOpExceeded     0x00020000
496 #define AR_TxStatusRsvd81   0x001c0000
497 #define AR_FinalTxIdx       0x00600000
498 #define AR_FinalTxIdx_S     21
499 #define AR_TxStatusRsvd82   0x01800000
500 #define AR_PowerMgmt        0x02000000
501 #define AR_TxStatusRsvd83   0xfc000000
502 
503 #define AR_RxCTLRsvd00  0xffffffff
504 
505 #define AR_RxCtlRsvd00  0x00001000
506 #define AR_RxIntrReq    0x00002000
507 #define AR_RxCtlRsvd01  0xffffc000
508 
509 #define AR_RxRSSIAnt00      0x000000ff
510 #define AR_RxRSSIAnt00_S    0
511 #define AR_RxRSSIAnt01      0x0000ff00
512 #define AR_RxRSSIAnt01_S    8
513 #define AR_RxRSSIAnt02      0x00ff0000
514 #define AR_RxRSSIAnt02_S    16
515 #define AR_RxRate           0xff000000
516 #define AR_RxRate_S         24
517 #define AR_RxStatusRsvd00   0xff000000
518 
519 #define AR_DataLen          0x00000fff
520 #define AR_RxMore           0x00001000
521 #define AR_NumDelim         0x003fc000
522 #define AR_NumDelim_S       14
523 #define AR_RxStatusRsvd10   0xff800000
524 
525 #define AR_RcvTimestamp     ds_rxstatus2
526 
527 #define AR_GI               0x00000001
528 #define AR_2040             0x00000002
529 #define AR_Parallel40       0x00000004
530 #define AR_Parallel40_S     2
531 #define AR_RxStatusRsvd30   0x000000f8
532 #define AR_RxAntenna	    0xffffff00
533 #define AR_RxAntenna_S	    8
534 
535 #define AR_RxRSSIAnt10            0x000000ff
536 #define AR_RxRSSIAnt10_S          0
537 #define AR_RxRSSIAnt11            0x0000ff00
538 #define AR_RxRSSIAnt11_S          8
539 #define AR_RxRSSIAnt12            0x00ff0000
540 #define AR_RxRSSIAnt12_S          16
541 #define AR_RxRSSICombined         0xff000000
542 #define AR_RxRSSICombined_S       24
543 
544 #define AR_RxEVM0           ds_rxstatus4
545 #define AR_RxEVM1           ds_rxstatus5
546 #define AR_RxEVM2           ds_rxstatus6
547 
548 #define AR_RxDone           0x00000001
549 #define AR_RxFrameOK        0x00000002
550 #define AR_CRCErr           0x00000004
551 #define AR_DecryptCRCErr    0x00000008
552 #define AR_PHYErr           0x00000010
553 #define AR_MichaelErr       0x00000020
554 #define AR_PreDelimCRCErr   0x00000040
555 #define AR_RxStatusRsvd70   0x00000080
556 #define AR_RxKeyIdxValid    0x00000100
557 #define AR_KeyIdx           0x0000fe00
558 #define AR_KeyIdx_S         9
559 #define AR_PHYErrCode       0x0000ff00
560 #define AR_PHYErrCode_S     8
561 #define AR_RxMoreAggr       0x00010000
562 #define AR_RxAggr           0x00020000
563 #define AR_PostDelimCRCErr  0x00040000
564 #define AR_RxStatusRsvd71   0x3ff80000
565 #define AR_DecryptBusyErr   0x40000000
566 #define AR_KeyMiss          0x80000000
567 
568 enum ath9k_tx_queue {
569 	ATH9K_TX_QUEUE_INACTIVE = 0,
570 	ATH9K_TX_QUEUE_DATA,
571 	ATH9K_TX_QUEUE_BEACON,
572 	ATH9K_TX_QUEUE_CAB,
573 	ATH9K_TX_QUEUE_UAPSD,
574 	ATH9K_TX_QUEUE_PSPOLL
575 };
576 
577 #define	ATH9K_NUM_TX_QUEUES 10
578 
579 /* Used as a queue subtype instead of a WMM AC */
580 #define ATH9K_WME_UPSD	4
581 
582 enum ath9k_tx_queue_flags {
583 	TXQ_FLAG_TXOKINT_ENABLE = 0x0001,
584 	TXQ_FLAG_TXERRINT_ENABLE = 0x0001,
585 	TXQ_FLAG_TXDESCINT_ENABLE = 0x0002,
586 	TXQ_FLAG_TXEOLINT_ENABLE = 0x0004,
587 	TXQ_FLAG_TXURNINT_ENABLE = 0x0008,
588 	TXQ_FLAG_BACKOFF_DISABLE = 0x0010,
589 	TXQ_FLAG_COMPRESSION_ENABLE = 0x0020,
590 	TXQ_FLAG_RDYTIME_EXP_POLICY_ENABLE = 0x0040,
591 	TXQ_FLAG_FRAG_BURST_BACKOFF_ENABLE = 0x0080,
592 };
593 
594 #define ATH9K_TXQ_USEDEFAULT ((u32) -1)
595 #define ATH9K_TXQ_USE_LOCKOUT_BKOFF_DIS 0x00000001
596 
597 #define ATH9K_DECOMP_MASK_SIZE     128
598 #define ATH9K_READY_TIME_LO_BOUND  50
599 #define ATH9K_READY_TIME_HI_BOUND  96
600 
601 enum ath9k_pkt_type {
602 	ATH9K_PKT_TYPE_NORMAL = 0,
603 	ATH9K_PKT_TYPE_ATIM,
604 	ATH9K_PKT_TYPE_PSPOLL,
605 	ATH9K_PKT_TYPE_BEACON,
606 	ATH9K_PKT_TYPE_PROBE_RESP,
607 	ATH9K_PKT_TYPE_CHIRP,
608 	ATH9K_PKT_TYPE_GRP_POLL,
609 };
610 
611 struct ath9k_tx_queue_info {
612 	u32 tqi_ver;
613 	enum ath9k_tx_queue tqi_type;
614 	int tqi_subtype;
615 	enum ath9k_tx_queue_flags tqi_qflags;
616 	u32 tqi_priority;
617 	u32 tqi_aifs;
618 	u32 tqi_cwmin;
619 	u32 tqi_cwmax;
620 	u16 tqi_shretry;
621 	u16 tqi_lgretry;
622 	u32 tqi_cbrPeriod;
623 	u32 tqi_cbrOverflowLimit;
624 	u32 tqi_burstTime;
625 	u32 tqi_readyTime;
626 	u32 tqi_physCompBuf;
627 	u32 tqi_intFlags;
628 };
629 
630 enum ath9k_rx_filter {
631 	ATH9K_RX_FILTER_UCAST = 0x00000001,
632 	ATH9K_RX_FILTER_MCAST = 0x00000002,
633 	ATH9K_RX_FILTER_BCAST = 0x00000004,
634 	ATH9K_RX_FILTER_CONTROL = 0x00000008,
635 	ATH9K_RX_FILTER_BEACON = 0x00000010,
636 	ATH9K_RX_FILTER_PROM = 0x00000020,
637 	ATH9K_RX_FILTER_PROBEREQ = 0x00000080,
638 	ATH9K_RX_FILTER_PHYERR = 0x00000100,
639 	ATH9K_RX_FILTER_MYBEACON = 0x00000200,
640 	ATH9K_RX_FILTER_COMP_BAR = 0x00000400,
641 	ATH9K_RX_FILTER_COMP_BA = 0x00000800,
642 	ATH9K_RX_FILTER_UNCOMP_BA_BAR = 0x00001000,
643 	ATH9K_RX_FILTER_PSPOLL = 0x00004000,
644 	ATH9K_RX_FILTER_PHYRADAR = 0x00002000,
645 	ATH9K_RX_FILTER_MCAST_BCAST_ALL = 0x00008000,
646 };
647 
648 #define ATH9K_RATESERIES_RTS_CTS  0x0001
649 #define ATH9K_RATESERIES_2040     0x0002
650 #define ATH9K_RATESERIES_HALFGI   0x0004
651 #define ATH9K_RATESERIES_STBC     0x0008
652 
653 struct ath9k_11n_rate_series {
654 	u32 Tries;
655 	u32 Rate;
656 	u32 PktDuration;
657 	u32 ChSel;
658 	u32 RateFlags;
659 };
660 
661 enum ath9k_key_type {
662 	ATH9K_KEY_TYPE_CLEAR,
663 	ATH9K_KEY_TYPE_WEP,
664 	ATH9K_KEY_TYPE_AES,
665 	ATH9K_KEY_TYPE_TKIP,
666 };
667 
668 struct ath_hw;
669 struct ath9k_channel;
670 enum ath9k_int;
671 
672 u32 ath9k_hw_gettxbuf(struct ath_hw *ah, u32 q);
673 void ath9k_hw_puttxbuf(struct ath_hw *ah, u32 q, u32 txdp);
674 void ath9k_hw_txstart(struct ath_hw *ah, u32 q);
675 void ath9k_hw_cleartxdesc(struct ath_hw *ah, void *ds);
676 u32 ath9k_hw_numtxpending(struct ath_hw *ah, u32 q);
677 bool ath9k_hw_updatetxtriglevel(struct ath_hw *ah, bool bIncTrigLevel);
678 bool ath9k_hw_stop_dma_queue(struct ath_hw *ah, u32 q);
679 void ath9k_hw_abort_tx_dma(struct ath_hw *ah);
680 void ath9k_hw_gettxintrtxqs(struct ath_hw *ah, u32 *txqs);
681 bool ath9k_hw_set_txq_props(struct ath_hw *ah, int q,
682 			    const struct ath9k_tx_queue_info *qinfo);
683 bool ath9k_hw_get_txq_props(struct ath_hw *ah, int q,
684 			    struct ath9k_tx_queue_info *qinfo);
685 int ath9k_hw_setuptxqueue(struct ath_hw *ah, enum ath9k_tx_queue type,
686 			  const struct ath9k_tx_queue_info *qinfo);
687 bool ath9k_hw_releasetxqueue(struct ath_hw *ah, u32 q);
688 bool ath9k_hw_resettxqueue(struct ath_hw *ah, u32 q);
689 int ath9k_hw_rxprocdesc(struct ath_hw *ah, struct ath_desc *ds,
690 			struct ath_rx_status *rs, u64 tsf);
691 void ath9k_hw_setuprxdesc(struct ath_hw *ah, struct ath_desc *ds,
692 			  u32 size, u32 flags);
693 bool ath9k_hw_setrxabort(struct ath_hw *ah, bool set);
694 void ath9k_hw_putrxbuf(struct ath_hw *ah, u32 rxdp);
695 void ath9k_hw_startpcureceive(struct ath_hw *ah, bool is_scanning);
696 void ath9k_hw_abortpcurecv(struct ath_hw *ah);
697 bool ath9k_hw_stopdmarecv(struct ath_hw *ah, bool *reset);
698 int ath9k_hw_beaconq_setup(struct ath_hw *ah);
699 
700 /* Interrupt Handling */
701 bool ath9k_hw_intrpend(struct ath_hw *ah);
702 void ath9k_hw_set_interrupts(struct ath_hw *ah, enum ath9k_int ints);
703 void ath9k_hw_enable_interrupts(struct ath_hw *ah);
704 void ath9k_hw_disable_interrupts(struct ath_hw *ah);
705 
706 void ar9002_hw_attach_mac_ops(struct ath_hw *ah);
707 
708 #endif /* MAC_H */
709