2 * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
3 * Copyright (c) 2002-2008 Atheros Communications, Inc.
5 * Permission to use, copy, modify, and/or distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 * $FreeBSD: head/sys/dev/ath/ath_hal/ar5416/ar5416desc.h 203158 2010-01-29 10:07:17Z rpaulo $
20 #ifndef _ATH_AR5416_DESC_H_
21 #define _ATH_AR5416_DESC_H
24 * Hardware-specific descriptor structures.
28 /* XXX Need to replace this with a dynamic
29 * method of determining Owl2 if possible
31 #define _get_index(_ah) ( IS_5416V1(_ah) ? -4 : 0 )
32 #define AR5416_DS_TXSTATUS(_ah, _ads) \
33 ((uint32_t*)(&(_ads)->u.tx.status[_get_index(_ah)]))
34 #define AR5416_DS_TXSTATUS_CONST(_ah, _ads) \
35 ((const uint32_t*)(&(_ads)->u.tx.status[_get_index(_ah)]))
37 #define AR5416_NUM_TX_STATUS 10 /* Number of TX status words */
38 /* Clear the whole descriptor */
39 #define AR5416_DESC_TX_CTL_SZ sizeof(struct ar5416_tx_desc)
41 struct ar5416_tx_desc { /* tx desc has 12 control words + 10 status words */
52 uint32_t status[AR5416_NUM_TX_STATUS];
55 struct ar5416_rx_desc { /* rx desc has 2 control words + 9 status words */
69 uint32_t ds_link; /* link pointer */
70 uint32_t ds_data; /* data buffer pointer */
71 uint32_t ds_ctl0; /* DMA control 0 */
72 uint32_t ds_ctl1; /* DMA control 1 */
74 struct ar5416_tx_desc tx;
75 struct ar5416_rx_desc rx;
78 #define AR5416DESC(_ds) ((struct ar5416_desc *)(_ds))
79 #define AR5416DESC_CONST(_ds) ((const struct ar5416_desc *)(_ds))
81 #define ds_ctl2 u.tx.ctl2
82 #define ds_ctl3 u.tx.ctl3
83 #define ds_ctl4 u.tx.ctl4
84 #define ds_ctl5 u.tx.ctl5
85 #define ds_ctl6 u.tx.ctl6
86 #define ds_ctl7 u.tx.ctl7
87 #define ds_ctl8 u.tx.ctl8
88 #define ds_ctl9 u.tx.ctl9
89 #define ds_ctl10 u.tx.ctl10
90 #define ds_ctl11 u.tx.ctl11
92 #define ds_rxstatus0 u.rx.status0
93 #define ds_rxstatus1 u.rx.status1
94 #define ds_rxstatus2 u.rx.status2
95 #define ds_rxstatus3 u.rx.status3
96 #define ds_rxstatus4 u.rx.status4
97 #define ds_rxstatus5 u.rx.status5
98 #define ds_rxstatus6 u.rx.status6
99 #define ds_rxstatus7 u.rx.status7
100 #define ds_rxstatus8 u.rx.status8
107 #define AR_FrameLen 0x00000fff
108 #define AR_VirtMoreFrag 0x00001000
109 #define AR_TxCtlRsvd00 0x0000e000
110 #define AR_XmitPower 0x003f0000
111 #define AR_XmitPower_S 16
112 #define AR_RTSEnable 0x00400000
113 #define AR_VEOL 0x00800000
114 #define AR_ClrDestMask 0x01000000
115 #define AR_TxCtlRsvd01 0x1e000000
116 #define AR_TxIntrReq 0x20000000
117 #define AR_DestIdxValid 0x40000000
118 #define AR_CTSEnable 0x80000000
121 #define AR_BufLen 0x00000fff
122 #define AR_TxMore 0x00001000
123 #define AR_DestIdx 0x000fe000
124 #define AR_DestIdx_S 13
125 #define AR_FrameType 0x00f00000
126 #define AR_FrameType_S 20
127 #define AR_NoAck 0x01000000
128 #define AR_InsertTS 0x02000000
129 #define AR_CorruptFCS 0x04000000
130 #define AR_ExtOnly 0x08000000
131 #define AR_ExtAndCtl 0x10000000
132 #define AR_MoreAggr 0x20000000
133 #define AR_IsAggr 0x40000000
134 #define AR_MoreRifs 0x80000000
137 #define AR_BurstDur 0x00007fff
138 #define AR_BurstDur_S 0
139 #define AR_DurUpdateEn 0x00008000
140 #define AR_XmitDataTries0 0x000f0000
141 #define AR_XmitDataTries0_S 16
142 #define AR_XmitDataTries1 0x00f00000
143 #define AR_XmitDataTries1_S 20
144 #define AR_XmitDataTries2 0x0f000000
145 #define AR_XmitDataTries2_S 24
146 #define AR_XmitDataTries3 0xf0000000
147 #define AR_XmitDataTries3_S 28
150 #define AR_XmitRate0 0x000000ff
151 #define AR_XmitRate0_S 0
152 #define AR_XmitRate1 0x0000ff00
153 #define AR_XmitRate1_S 8
154 #define AR_XmitRate2 0x00ff0000
155 #define AR_XmitRate2_S 16
156 #define AR_XmitRate3 0xff000000
157 #define AR_XmitRate3_S 24
160 #define AR_PacketDur0 0x00007fff
161 #define AR_PacketDur0_S 0
162 #define AR_RTSCTSQual0 0x00008000
163 #define AR_PacketDur1 0x7fff0000
164 #define AR_PacketDur1_S 16
165 #define AR_RTSCTSQual1 0x80000000
168 #define AR_PacketDur2 0x00007fff
169 #define AR_PacketDur2_S 0
170 #define AR_RTSCTSQual2 0x00008000
171 #define AR_PacketDur3 0x7fff0000
172 #define AR_PacketDur3_S 16
173 #define AR_RTSCTSQual3 0x80000000
176 #define AR_AggrLen 0x0000ffff
177 #define AR_AggrLen_S 0
178 #define AR_TxCtlRsvd60 0x00030000
179 #define AR_PadDelim 0x03fc0000
180 #define AR_PadDelim_S 18
181 #define AR_EncrType 0x0c000000
182 #define AR_EncrType_S 26
183 #define AR_TxCtlRsvd61 0xf0000000
186 #define AR_2040_0 0x00000001
187 #define AR_GI0 0x00000002
188 #define AR_ChainSel0 0x0000001c
189 #define AR_ChainSel0_S 2
190 #define AR_2040_1 0x00000020
191 #define AR_GI1 0x00000040
192 #define AR_ChainSel1 0x00000380
193 #define AR_ChainSel1_S 7
194 #define AR_2040_2 0x00000400
195 #define AR_GI2 0x00000800
196 #define AR_ChainSel2 0x00007000
197 #define AR_ChainSel2_S 12
198 #define AR_2040_3 0x00008000
199 #define AR_GI3 0x00010000
200 #define AR_ChainSel3 0x000e0000
201 #define AR_ChainSel3_S 17
202 #define AR_RTSCTSRate 0x0ff00000
203 #define AR_RTSCTSRate_S 20
204 #define AR_STBC0 0x10000000
205 #define AR_STBC1 0x20000000
206 #define AR_STBC2 0x40000000
207 #define AR_STBC3 0x80000000
214 #define AR_TxRSSIAnt00 0x000000ff
215 #define AR_TxRSSIAnt00_S 0
216 #define AR_TxRSSIAnt01 0x0000ff00
217 #define AR_TxRSSIAnt01_S 8
218 #define AR_TxRSSIAnt02 0x00ff0000
219 #define AR_TxRSSIAnt02_S 16
220 #define AR_TxStatusRsvd00 0x3f000000
221 #define AR_TxBaStatus 0x40000000
222 #define AR_TxStatusRsvd01 0x80000000
225 #define AR_FrmXmitOK 0x00000001
226 #define AR_ExcessiveRetries 0x00000002
227 #define AR_FIFOUnderrun 0x00000004
228 #define AR_Filtered 0x00000008
229 #define AR_RTSFailCnt 0x000000f0
230 #define AR_RTSFailCnt_S 4
231 #define AR_DataFailCnt 0x00000f00
232 #define AR_DataFailCnt_S 8
233 #define AR_VirtRetryCnt 0x0000f000
234 #define AR_VirtRetryCnt_S 12
235 #define AR_TxDelimUnderrun 0x00010000
236 #define AR_TxDelimUnderrun_S 13
237 #define AR_TxDataUnderrun 0x00020000
238 #define AR_TxDataUnderrun_S 14
239 #define AR_DescCfgErr 0x00040000
240 #define AR_DescCfgErr_S 15
241 #define AR_TxTimerExpired 0x00080000
242 #define AR_TxStatusRsvd10 0xfff00000
245 #define AR_SendTimestamp(_ptr) (_ptr)[2]
248 #define AR_BaBitmapLow(_ptr) (_ptr)[3]
251 #define AR_BaBitmapHigh(_ptr) (_ptr)[4]
254 #define AR_TxRSSIAnt10 0x000000ff
255 #define AR_TxRSSIAnt10_S 0
256 #define AR_TxRSSIAnt11 0x0000ff00
257 #define AR_TxRSSIAnt11_S 8
258 #define AR_TxRSSIAnt12 0x00ff0000
259 #define AR_TxRSSIAnt12_S 16
260 #define AR_TxRSSICombined 0xff000000
261 #define AR_TxRSSICombined_S 24
264 #define AR_TxEVM0(_ptr) (_ptr)[6]
267 #define AR_TxEVM1(_ptr) (_ptr)[7]
270 #define AR_TxEVM2(_ptr) (_ptr)[8]
273 #define AR_TxDone 0x00000001
274 #define AR_SeqNum 0x00001ffe
275 #define AR_SeqNum_S 1
276 #define AR_TxStatusRsvd80 0x0001e000
277 #define AR_TxOpExceeded 0x00020000
278 #define AR_TxStatusRsvd81 0x001c0000
279 #define AR_FinalTxIdx 0x00600000
280 #define AR_FinalTxIdx_S 21
281 #define AR_TxStatusRsvd82 0x01800000
282 #define AR_PowerMgmt 0x02000000
283 #define AR_TxStatusRsvd83 0xfc000000
290 #define AR_RxCTLRsvd00 0xffffffff
293 #define AR_BufLen 0x00000fff
294 #define AR_RxCtlRsvd00 0x00001000
295 #define AR_RxIntrReq 0x00002000
296 #define AR_RxCtlRsvd01 0xffffc000
303 #define AR_RxRSSIAnt00 0x000000ff
304 #define AR_RxRSSIAnt00_S 0
305 #define AR_RxRSSIAnt01 0x0000ff00
306 #define AR_RxRSSIAnt01_S 8
307 #define AR_RxRSSIAnt02 0x00ff0000
308 #define AR_RxRSSIAnt02_S 16
311 #define AR_RxStatusRsvd00 0xff000000
313 #define AR_RxRate 0xff000000
314 #define AR_RxRate_S 24
317 #define AR_DataLen 0x00000fff
318 #define AR_RxMore 0x00001000
319 #define AR_NumDelim 0x003fc000
320 #define AR_NumDelim_S 14
321 #define AR_RxStatusRsvd10 0xff800000
324 #define AR_RcvTimestamp ds_rxstatus2
327 #define AR_GI 0x00000001
328 #define AR_2040 0x00000002
331 #define AR_RxRateV1 0x000003fc
332 #define AR_RxRateV1_S 2
333 #define AR_Parallel40 0x00000400
334 #define AR_RxStatusRsvd30 0xfffff800
336 #define AR_DupFrame 0x00000004
337 #define AR_RxAntenna 0xffffff00
338 #define AR_RxAntenna_S 8
341 #define AR_RxRSSIAnt10 0x000000ff
342 #define AR_RxRSSIAnt10_S 0
343 #define AR_RxRSSIAnt11 0x0000ff00
344 #define AR_RxRSSIAnt11_S 8
345 #define AR_RxRSSIAnt12 0x00ff0000
346 #define AR_RxRSSIAnt12_S 16
347 #define AR_RxRSSICombined 0xff000000
348 #define AR_RxRSSICombined_S 24
351 #define AR_RxEVM0 ds_rxstatus5
354 #define AR_RxEVM1 ds_rxstatus6
357 #define AR_RxEVM2 ds_rxstatus7
360 #define AR_RxDone 0x00000001
361 #define AR_RxFrameOK 0x00000002
362 #define AR_CRCErr 0x00000004
363 #define AR_DecryptCRCErr 0x00000008
364 #define AR_PHYErr 0x00000010
365 #define AR_MichaelErr 0x00000020
366 #define AR_PreDelimCRCErr 0x00000040
367 #define AR_RxStatusRsvd70 0x00000080
368 #define AR_RxKeyIdxValid 0x00000100
369 #define AR_KeyIdx 0x0000fe00
370 #define AR_KeyIdx_S 9
371 #define AR_PHYErrCode 0x0000ff00
372 #define AR_PHYErrCode_S 8
373 #define AR_RxMoreAggr 0x00010000
374 #define AR_RxAggr 0x00020000
375 #define AR_PostDelimCRCErr 0x00040000
376 #define AR_RxStatusRsvd71 0x2ff80000
377 #define AR_HiRxChain 0x10000000
378 #define AR_DecryptBusyErr 0x40000000
379 #define AR_KeyMiss 0x80000000
381 #define TXCTL_OFFSET(ah) 2
382 #define TXCTL_NUMWORDS(ah) (AR_SREV_5416_V20_OR_LATER(ah) ? 12 : 8)
383 #define TXSTATUS_OFFSET(ah) (AR_SREV_5416_V20_OR_LATER(ah) ? 14 : 10)
384 #define TXSTATUS_NUMWORDS(ah) 10
386 #define RXCTL_OFFSET(ah) 3
387 #define RXCTL_NUMWORDS(ah) 1
388 #define RXSTATUS_OFFSET(ah) 4
389 #define RXSTATUS_NUMWORDS(ah) 9
390 #define RXSTATUS_RATE(ah, ads) \
391 (AR_SREV_OWL_20_OR_LATER(ah) ? \
392 MS((ads)->ds_rxstatus0, AR_RxRate) : \
393 ((ads)->ds_rxstatus3 >> 2) & 0xFF)
394 #define RXSTATUS_DUPLICATE(ah, ads) \
395 (AR_SREV_OWL_20_OR_LATER(ah) ? \
396 MS((ads)->ds_rxstatus3, AR_Parallel40) : \
397 ((ads)->ds_rxstatus3 >> 10) & 0x1)
398 #endif /* _ATH_AR5416_DESC_H_ */