xref: /freebsd/sys/dev/ath/ath_hal/ah.h (revision 5dcd9c10612684d1c823670cbb5b4715028784e7)
1 /*
2  * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
3  * Copyright (c) 2002-2008 Atheros Communications, Inc.
4  *
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.
8  *
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.
16  *
17  * $FreeBSD$
18  */
19 
20 #ifndef _ATH_AH_H_
21 #define _ATH_AH_H_
22 /*
23  * Atheros Hardware Access Layer
24  *
25  * Clients of the HAL call ath_hal_attach to obtain a reference to an ath_hal
26  * structure for use with the device.  Hardware-related operations that
27  * follow must call back into the HAL through interface, supplying the
28  * reference as the first parameter.
29  */
30 
31 #include "ah_osdep.h"
32 
33 /*
34  * __ahdecl is analogous to _cdecl; it defines the calling
35  * convention used within the HAL.  For most systems this
36  * can just default to be empty and the compiler will (should)
37  * use _cdecl.  For systems where _cdecl is not compatible this
38  * must be defined.  See linux/ah_osdep.h for an example.
39  */
40 #ifndef __ahdecl
41 #define __ahdecl
42 #endif
43 
44 /*
45  * Status codes that may be returned by the HAL.  Note that
46  * interfaces that return a status code set it only when an
47  * error occurs--i.e. you cannot check it for success.
48  */
49 typedef enum {
50 	HAL_OK		= 0,	/* No error */
51 	HAL_ENXIO	= 1,	/* No hardware present */
52 	HAL_ENOMEM	= 2,	/* Memory allocation failed */
53 	HAL_EIO		= 3,	/* Hardware didn't respond as expected */
54 	HAL_EEMAGIC	= 4,	/* EEPROM magic number invalid */
55 	HAL_EEVERSION	= 5,	/* EEPROM version invalid */
56 	HAL_EELOCKED	= 6,	/* EEPROM unreadable */
57 	HAL_EEBADSUM	= 7,	/* EEPROM checksum invalid */
58 	HAL_EEREAD	= 8,	/* EEPROM read problem */
59 	HAL_EEBADMAC	= 9,	/* EEPROM mac address invalid */
60 	HAL_EESIZE	= 10,	/* EEPROM size not supported */
61 	HAL_EEWRITE	= 11,	/* Attempt to change write-locked EEPROM */
62 	HAL_EINVAL	= 12,	/* Invalid parameter to function */
63 	HAL_ENOTSUPP	= 13,	/* Hardware revision not supported */
64 	HAL_ESELFTEST	= 14,	/* Hardware self-test failed */
65 	HAL_EINPROGRESS	= 15,	/* Operation incomplete */
66 	HAL_EEBADREG	= 16,	/* EEPROM invalid regulatory contents */
67 	HAL_EEBADCC	= 17,	/* EEPROM invalid country code */
68 } HAL_STATUS;
69 
70 typedef enum {
71 	AH_FALSE = 0,		/* NB: lots of code assumes false is zero */
72 	AH_TRUE  = 1,
73 } HAL_BOOL;
74 
75 typedef enum {
76 	HAL_CAP_REG_DMN		= 0,	/* current regulatory domain */
77 	HAL_CAP_CIPHER		= 1,	/* hardware supports cipher */
78 	HAL_CAP_TKIP_MIC	= 2,	/* handle TKIP MIC in hardware */
79 	HAL_CAP_TKIP_SPLIT	= 3,	/* hardware TKIP uses split keys */
80 	HAL_CAP_PHYCOUNTERS	= 4,	/* hardware PHY error counters */
81 	HAL_CAP_DIVERSITY	= 5,	/* hardware supports fast diversity */
82 	HAL_CAP_KEYCACHE_SIZE	= 6,	/* number of entries in key cache */
83 	HAL_CAP_NUM_TXQUEUES	= 7,	/* number of hardware xmit queues */
84 	HAL_CAP_VEOL		= 9,	/* hardware supports virtual EOL */
85 	HAL_CAP_PSPOLL		= 10,	/* hardware has working PS-Poll support */
86 	HAL_CAP_DIAG		= 11,	/* hardware diagnostic support */
87 	HAL_CAP_COMPRESSION	= 12,	/* hardware supports compression */
88 	HAL_CAP_BURST		= 13,	/* hardware supports packet bursting */
89 	HAL_CAP_FASTFRAME	= 14,	/* hardware supoprts fast frames */
90 	HAL_CAP_TXPOW		= 15,	/* global tx power limit  */
91 	HAL_CAP_TPC		= 16,	/* per-packet tx power control  */
92 	HAL_CAP_PHYDIAG		= 17,	/* hardware phy error diagnostic */
93 	HAL_CAP_BSSIDMASK	= 18,	/* hardware supports bssid mask */
94 	HAL_CAP_MCAST_KEYSRCH	= 19,	/* hardware has multicast key search */
95 	HAL_CAP_TSF_ADJUST	= 20,	/* hardware has beacon tsf adjust */
96 	/* 21 was HAL_CAP_XR */
97 	HAL_CAP_WME_TKIPMIC 	= 22,   /* hardware can support TKIP MIC when WMM is turned on */
98 	/* 23 was HAL_CAP_CHAN_HALFRATE */
99 	/* 24 was HAL_CAP_CHAN_QUARTERRATE */
100 	HAL_CAP_RFSILENT	= 25,	/* hardware has rfsilent support  */
101 	HAL_CAP_TPC_ACK		= 26,	/* ack txpower with per-packet tpc */
102 	HAL_CAP_TPC_CTS		= 27,	/* cts txpower with per-packet tpc */
103 	HAL_CAP_11D		= 28,   /* 11d beacon support for changing cc */
104 	HAL_CAP_INTMIT		= 29,	/* interference mitigation */
105 	HAL_CAP_RXORN_FATAL	= 30,	/* HAL_INT_RXORN treated as fatal */
106 	HAL_CAP_HT		= 31,   /* hardware can support HT */
107 	HAL_CAP_TX_CHAINMASK	= 32,	/* mask of TX chains supported */
108 	HAL_CAP_RX_CHAINMASK	= 33,	/* mask of RX chains supported */
109 	HAL_CAP_RXTSTAMP_PREC	= 34,	/* rx desc tstamp precision (bits) */
110 	HAL_CAP_BB_HANG		= 35,	/* can baseband hang */
111 	HAL_CAP_MAC_HANG	= 36,	/* can MAC hang */
112 	HAL_CAP_INTRMASK	= 37,	/* bitmask of supported interrupts */
113 	HAL_CAP_BSSIDMATCH	= 38,	/* hardware has disable bssid match */
114 	HAL_CAP_STREAMS		= 39,	/* how many 802.11n spatial streams are available */
115 	HAP_CAP_SPLIT_4KB_TRANS	= 40,	/* hardware supports descriptors straddling a 4k page boundary */
116 } HAL_CAPABILITY_TYPE;
117 
118 /*
119  * "States" for setting the LED.  These correspond to
120  * the possible 802.11 operational states and there may
121  * be a many-to-one mapping between these states and the
122  * actual hardware state for the LED's (i.e. the hardware
123  * may have fewer states).
124  */
125 typedef enum {
126 	HAL_LED_INIT	= 0,
127 	HAL_LED_SCAN	= 1,
128 	HAL_LED_AUTH	= 2,
129 	HAL_LED_ASSOC	= 3,
130 	HAL_LED_RUN	= 4
131 } HAL_LED_STATE;
132 
133 /*
134  * Transmit queue types/numbers.  These are used to tag
135  * each transmit queue in the hardware and to identify a set
136  * of transmit queues for operations such as start/stop dma.
137  */
138 typedef enum {
139 	HAL_TX_QUEUE_INACTIVE	= 0,		/* queue is inactive/unused */
140 	HAL_TX_QUEUE_DATA	= 1,		/* data xmit q's */
141 	HAL_TX_QUEUE_BEACON	= 2,		/* beacon xmit q */
142 	HAL_TX_QUEUE_CAB	= 3,		/* "crap after beacon" xmit q */
143 	HAL_TX_QUEUE_UAPSD	= 4,		/* u-apsd power save xmit q */
144 } HAL_TX_QUEUE;
145 
146 #define	HAL_NUM_TX_QUEUES	10		/* max possible # of queues */
147 
148 /*
149  * Transmit queue subtype.  These map directly to
150  * WME Access Categories (except for UPSD).  Refer
151  * to Table 5 of the WME spec.
152  */
153 typedef enum {
154 	HAL_WME_AC_BK	= 0,			/* background access category */
155 	HAL_WME_AC_BE	= 1, 			/* best effort access category*/
156 	HAL_WME_AC_VI	= 2,			/* video access category */
157 	HAL_WME_AC_VO	= 3,			/* voice access category */
158 	HAL_WME_UPSD	= 4,			/* uplink power save */
159 } HAL_TX_QUEUE_SUBTYPE;
160 
161 /*
162  * Transmit queue flags that control various
163  * operational parameters.
164  */
165 typedef enum {
166 	/*
167 	 * Per queue interrupt enables.  When set the associated
168 	 * interrupt may be delivered for packets sent through
169 	 * the queue.  Without these enabled no interrupts will
170 	 * be delivered for transmits through the queue.
171 	 */
172 	HAL_TXQ_TXOKINT_ENABLE	   = 0x0001,	/* enable TXOK interrupt */
173 	HAL_TXQ_TXERRINT_ENABLE	   = 0x0001,	/* enable TXERR interrupt */
174 	HAL_TXQ_TXDESCINT_ENABLE   = 0x0002,	/* enable TXDESC interrupt */
175 	HAL_TXQ_TXEOLINT_ENABLE	   = 0x0004,	/* enable TXEOL interrupt */
176 	HAL_TXQ_TXURNINT_ENABLE	   = 0x0008,	/* enable TXURN interrupt */
177 	/*
178 	 * Enable hardware compression for packets sent through
179 	 * the queue.  The compression buffer must be setup and
180 	 * packets must have a key entry marked in the tx descriptor.
181 	 */
182 	HAL_TXQ_COMPRESSION_ENABLE  = 0x0010,	/* enable h/w compression */
183 	/*
184 	 * Disable queue when veol is hit or ready time expires.
185 	 * By default the queue is disabled only on reaching the
186 	 * physical end of queue (i.e. a null link ptr in the
187 	 * descriptor chain).
188 	 */
189 	HAL_TXQ_RDYTIME_EXP_POLICY_ENABLE = 0x0020,
190 	/*
191 	 * Schedule frames on delivery of a DBA (DMA Beacon Alert)
192 	 * event.  Frames will be transmitted only when this timer
193 	 * fires, e.g to transmit a beacon in ap or adhoc modes.
194 	 */
195 	HAL_TXQ_DBA_GATED	    = 0x0040,	/* schedule based on DBA */
196 	/*
197 	 * Each transmit queue has a counter that is incremented
198 	 * each time the queue is enabled and decremented when
199 	 * the list of frames to transmit is traversed (or when
200 	 * the ready time for the queue expires).  This counter
201 	 * must be non-zero for frames to be scheduled for
202 	 * transmission.  The following controls disable bumping
203 	 * this counter under certain conditions.  Typically this
204 	 * is used to gate frames based on the contents of another
205 	 * queue (e.g. CAB traffic may only follow a beacon frame).
206 	 * These are meaningful only when frames are scheduled
207 	 * with a non-ASAP policy (e.g. DBA-gated).
208 	 */
209 	HAL_TXQ_CBR_DIS_QEMPTY	    = 0x0080,	/* disable on this q empty */
210 	HAL_TXQ_CBR_DIS_BEMPTY	    = 0x0100,	/* disable on beacon q empty */
211 
212 	/*
213 	 * Fragment burst backoff policy.  Normally the no backoff
214 	 * is done after a successful transmission, the next fragment
215 	 * is sent at SIFS.  If this flag is set backoff is done
216 	 * after each fragment, regardless whether it was ack'd or
217 	 * not, after the backoff count reaches zero a normal channel
218 	 * access procedure is done before the next transmit (i.e.
219 	 * wait AIFS instead of SIFS).
220 	 */
221 	HAL_TXQ_FRAG_BURST_BACKOFF_ENABLE = 0x00800000,
222 	/*
223 	 * Disable post-tx backoff following each frame.
224 	 */
225 	HAL_TXQ_BACKOFF_DISABLE	    = 0x00010000, /* disable post backoff  */
226 	/*
227 	 * DCU arbiter lockout control.  This controls how
228 	 * lower priority tx queues are handled with respect to
229 	 * to a specific queue when multiple queues have frames
230 	 * to send.  No lockout means lower priority queues arbitrate
231 	 * concurrently with this queue.  Intra-frame lockout
232 	 * means lower priority queues are locked out until the
233 	 * current frame transmits (e.g. including backoffs and bursting).
234 	 * Global lockout means nothing lower can arbitrary so
235 	 * long as there is traffic activity on this queue (frames,
236 	 * backoff, etc).
237 	 */
238 	HAL_TXQ_ARB_LOCKOUT_INTRA   = 0x00020000, /* intra-frame lockout */
239 	HAL_TXQ_ARB_LOCKOUT_GLOBAL  = 0x00040000, /* full lockout s */
240 
241 	HAL_TXQ_IGNORE_VIRTCOL	    = 0x00080000, /* ignore virt collisions */
242 	HAL_TXQ_SEQNUM_INC_DIS	    = 0x00100000, /* disable seqnum increment */
243 } HAL_TX_QUEUE_FLAGS;
244 
245 typedef struct {
246 	uint32_t	tqi_ver;		/* hal TXQ version */
247 	HAL_TX_QUEUE_SUBTYPE tqi_subtype;	/* subtype if applicable */
248 	HAL_TX_QUEUE_FLAGS tqi_qflags;		/* flags (see above) */
249 	uint32_t	tqi_priority;		/* (not used) */
250 	uint32_t	tqi_aifs;		/* aifs */
251 	uint32_t	tqi_cwmin;		/* cwMin */
252 	uint32_t	tqi_cwmax;		/* cwMax */
253 	uint16_t	tqi_shretry;		/* rts retry limit */
254 	uint16_t	tqi_lgretry;		/* long retry limit (not used)*/
255 	uint32_t	tqi_cbrPeriod;		/* CBR period (us) */
256 	uint32_t	tqi_cbrOverflowLimit;	/* threshold for CBROVF int */
257 	uint32_t	tqi_burstTime;		/* max burst duration (us) */
258 	uint32_t	tqi_readyTime;		/* frame schedule time (us) */
259 	uint32_t	tqi_compBuf;		/* comp buffer phys addr */
260 } HAL_TXQ_INFO;
261 
262 #define HAL_TQI_NONVAL 0xffff
263 
264 /* token to use for aifs, cwmin, cwmax */
265 #define	HAL_TXQ_USEDEFAULT	((uint32_t) -1)
266 
267 /* compression definitions */
268 #define HAL_COMP_BUF_MAX_SIZE           9216            /* 9K */
269 #define HAL_COMP_BUF_ALIGN_SIZE         512
270 
271 /*
272  * Transmit packet types.  This belongs in ah_desc.h, but
273  * is here so we can give a proper type to various parameters
274  * (and not require everyone include the file).
275  *
276  * NB: These values are intentionally assigned for
277  *     direct use when setting up h/w descriptors.
278  */
279 typedef enum {
280 	HAL_PKT_TYPE_NORMAL	= 0,
281 	HAL_PKT_TYPE_ATIM	= 1,
282 	HAL_PKT_TYPE_PSPOLL	= 2,
283 	HAL_PKT_TYPE_BEACON	= 3,
284 	HAL_PKT_TYPE_PROBE_RESP	= 4,
285 	HAL_PKT_TYPE_CHIRP	= 5,
286 	HAL_PKT_TYPE_GRP_POLL	= 6,
287 	HAL_PKT_TYPE_AMPDU	= 7,
288 } HAL_PKT_TYPE;
289 
290 /* Rx Filter Frame Types */
291 typedef enum {
292 	HAL_RX_FILTER_UCAST	= 0x00000001,	/* Allow unicast frames */
293 	HAL_RX_FILTER_MCAST	= 0x00000002,	/* Allow multicast frames */
294 	HAL_RX_FILTER_BCAST	= 0x00000004,	/* Allow broadcast frames */
295 	HAL_RX_FILTER_CONTROL	= 0x00000008,	/* Allow control frames */
296 	HAL_RX_FILTER_BEACON	= 0x00000010,	/* Allow beacon frames */
297 	HAL_RX_FILTER_PROM	= 0x00000020,	/* Promiscuous mode */
298 	HAL_RX_FILTER_PROBEREQ	= 0x00000080,	/* Allow probe request frames */
299 	HAL_RX_FILTER_PHYERR	= 0x00000100,	/* Allow phy errors */
300 	HAL_RX_FILTER_PHYRADAR	= 0x00000200,	/* Allow phy radar errors */
301 	HAL_RX_FILTER_COMPBAR	= 0x00000400,	/* Allow compressed BAR */
302 	HAL_RX_FILTER_BSSID	= 0x00000800,	/* Disable BSSID match */
303 } HAL_RX_FILTER;
304 
305 typedef enum {
306 	HAL_PM_AWAKE		= 0,
307 	HAL_PM_FULL_SLEEP	= 1,
308 	HAL_PM_NETWORK_SLEEP	= 2,
309 	HAL_PM_UNDEFINED	= 3
310 } HAL_POWER_MODE;
311 
312 /*
313  * NOTE WELL:
314  * These are mapped to take advantage of the common locations for many of
315  * the bits on all of the currently supported MAC chips. This is to make
316  * the ISR as efficient as possible, while still abstracting HW differences.
317  * When new hardware breaks this commonality this enumerated type, as well
318  * as the HAL functions using it, must be modified. All values are directly
319  * mapped unless commented otherwise.
320  */
321 typedef enum {
322 	HAL_INT_RX	= 0x00000001,	/* Non-common mapping */
323 	HAL_INT_RXDESC	= 0x00000002,
324 	HAL_INT_RXNOFRM	= 0x00000008,
325 	HAL_INT_RXEOL	= 0x00000010,
326 	HAL_INT_RXORN	= 0x00000020,
327 	HAL_INT_TX	= 0x00000040,	/* Non-common mapping */
328 	HAL_INT_TXDESC	= 0x00000080,
329 	HAL_INT_TIM_TIMER= 0x00000100,
330 	HAL_INT_TXURN	= 0x00000800,
331 	HAL_INT_MIB	= 0x00001000,
332 	HAL_INT_RXPHY	= 0x00004000,
333 	HAL_INT_RXKCM	= 0x00008000,
334 	HAL_INT_SWBA	= 0x00010000,
335 	HAL_INT_BMISS	= 0x00040000,
336 	HAL_INT_BNR	= 0x00100000,
337 	HAL_INT_TIM	= 0x00200000,	/* Non-common mapping */
338 	HAL_INT_DTIM	= 0x00400000,	/* Non-common mapping */
339 	HAL_INT_DTIMSYNC= 0x00800000,	/* Non-common mapping */
340 	HAL_INT_GPIO	= 0x01000000,
341 	HAL_INT_CABEND	= 0x02000000,	/* Non-common mapping */
342 	HAL_INT_TSFOOR	= 0x04000000,	/* Non-common mapping */
343 	HAL_INT_TBTT	= 0x08000000,	/* Non-common mapping */
344 	HAL_INT_CST	= 0x10000000,	/* Non-common mapping */
345 	HAL_INT_GTT	= 0x20000000,	/* Non-common mapping */
346 	HAL_INT_FATAL	= 0x40000000,	/* Non-common mapping */
347 #define	HAL_INT_GLOBAL	0x80000000	/* Set/clear IER */
348 	HAL_INT_BMISC	= HAL_INT_TIM
349 			| HAL_INT_DTIM
350 			| HAL_INT_DTIMSYNC
351 			| HAL_INT_CABEND
352 			| HAL_INT_TBTT,
353 
354 	/* Interrupt bits that map directly to ISR/IMR bits */
355 	HAL_INT_COMMON  = HAL_INT_RXNOFRM
356 			| HAL_INT_RXDESC
357 			| HAL_INT_RXEOL
358 			| HAL_INT_RXORN
359 			| HAL_INT_TXDESC
360 			| HAL_INT_TXURN
361 			| HAL_INT_MIB
362 			| HAL_INT_RXPHY
363 			| HAL_INT_RXKCM
364 			| HAL_INT_SWBA
365 			| HAL_INT_BMISS
366 			| HAL_INT_BNR
367 			| HAL_INT_GPIO,
368 } HAL_INT;
369 
370 typedef enum {
371 	HAL_GPIO_MUX_OUTPUT		= 0,
372 	HAL_GPIO_MUX_PCIE_ATTENTION_LED	= 1,
373 	HAL_GPIO_MUX_PCIE_POWER_LED	= 2,
374 	HAL_GPIO_MUX_TX_FRAME		= 3,
375 	HAL_GPIO_MUX_RX_CLEAR_EXTERNAL	= 4,
376 	HAL_GPIO_MUX_MAC_NETWORK_LED	= 5,
377 	HAL_GPIO_MUX_MAC_POWER_LED	= 6
378 } HAL_GPIO_MUX_TYPE;
379 
380 typedef enum {
381 	HAL_GPIO_INTR_LOW		= 0,
382 	HAL_GPIO_INTR_HIGH		= 1,
383 	HAL_GPIO_INTR_DISABLE		= 2
384 } HAL_GPIO_INTR_TYPE;
385 
386 typedef enum {
387 	HAL_RFGAIN_INACTIVE		= 0,
388 	HAL_RFGAIN_READ_REQUESTED	= 1,
389 	HAL_RFGAIN_NEED_CHANGE		= 2
390 } HAL_RFGAIN;
391 
392 typedef uint16_t HAL_CTRY_CODE;		/* country code */
393 typedef uint16_t HAL_REG_DOMAIN;		/* regulatory domain code */
394 
395 #define HAL_ANTENNA_MIN_MODE  0
396 #define HAL_ANTENNA_FIXED_A   1
397 #define HAL_ANTENNA_FIXED_B   2
398 #define HAL_ANTENNA_MAX_MODE  3
399 
400 typedef struct {
401 	uint32_t	ackrcv_bad;
402 	uint32_t	rts_bad;
403 	uint32_t	rts_good;
404 	uint32_t	fcs_bad;
405 	uint32_t	beacons;
406 } HAL_MIB_STATS;
407 
408 enum {
409 	HAL_MODE_11A	= 0x001,		/* 11a channels */
410 	HAL_MODE_TURBO	= 0x002,		/* 11a turbo-only channels */
411 	HAL_MODE_11B	= 0x004,		/* 11b channels */
412 	HAL_MODE_PUREG	= 0x008,		/* 11g channels (OFDM only) */
413 #ifdef notdef
414 	HAL_MODE_11G	= 0x010,		/* 11g channels (OFDM/CCK) */
415 #else
416 	HAL_MODE_11G	= 0x008,		/* XXX historical */
417 #endif
418 	HAL_MODE_108G	= 0x020,		/* 11g+Turbo channels */
419 	HAL_MODE_108A	= 0x040,		/* 11a+Turbo channels */
420 	HAL_MODE_11A_HALF_RATE = 0x200,		/* 11a half width channels */
421 	HAL_MODE_11A_QUARTER_RATE = 0x400,	/* 11a quarter width channels */
422 	HAL_MODE_11G_HALF_RATE = 0x800,		/* 11g half width channels */
423 	HAL_MODE_11G_QUARTER_RATE = 0x1000,	/* 11g quarter width channels */
424 	HAL_MODE_11NG_HT20	= 0x008000,
425 	HAL_MODE_11NA_HT20  	= 0x010000,
426 	HAL_MODE_11NG_HT40PLUS	= 0x020000,
427 	HAL_MODE_11NG_HT40MINUS	= 0x040000,
428 	HAL_MODE_11NA_HT40PLUS	= 0x080000,
429 	HAL_MODE_11NA_HT40MINUS	= 0x100000,
430 	HAL_MODE_ALL	= 0xffffff
431 };
432 
433 typedef struct {
434 	int		rateCount;		/* NB: for proper padding */
435 	uint8_t		rateCodeToIndex[144];	/* back mapping */
436 	struct {
437 		uint8_t		valid;		/* valid for rate control use */
438 		uint8_t		phy;		/* CCK/OFDM/XR */
439 		uint32_t	rateKbps;	/* transfer rate in kbs */
440 		uint8_t		rateCode;	/* rate for h/w descriptors */
441 		uint8_t		shortPreamble;	/* mask for enabling short
442 						 * preamble in CCK rate code */
443 		uint8_t		dot11Rate;	/* value for supported rates
444 						 * info element of MLME */
445 		uint8_t		controlRate;	/* index of next lower basic
446 						 * rate; used for dur. calcs */
447 		uint16_t	lpAckDuration;	/* long preamble ACK duration */
448 		uint16_t	spAckDuration;	/* short preamble ACK duration*/
449 	} info[32];
450 } HAL_RATE_TABLE;
451 
452 typedef struct {
453 	u_int		rs_count;		/* number of valid entries */
454 	uint8_t	rs_rates[32];		/* rates */
455 } HAL_RATE_SET;
456 
457 /*
458  * 802.11n specific structures and enums
459  */
460 typedef enum {
461 	HAL_CHAINTYPE_TX	= 1,	/* Tx chain type */
462 	HAL_CHAINTYPE_RX	= 2,	/* RX chain type */
463 } HAL_CHAIN_TYPE;
464 
465 typedef struct {
466 	u_int	Tries;
467 	u_int	Rate;
468 	u_int	PktDuration;
469 	u_int	ChSel;
470 	u_int	RateFlags;
471 #define	HAL_RATESERIES_RTS_CTS		0x0001	/* use rts/cts w/this series */
472 #define	HAL_RATESERIES_2040		0x0002	/* use ext channel for series */
473 #define	HAL_RATESERIES_HALFGI		0x0004	/* use half-gi for series */
474 } HAL_11N_RATE_SERIES;
475 
476 typedef enum {
477 	HAL_HT_MACMODE_20	= 0,	/* 20 MHz operation */
478 	HAL_HT_MACMODE_2040	= 1,	/* 20/40 MHz operation */
479 } HAL_HT_MACMODE;
480 
481 typedef enum {
482 	HAL_HT_PHYMODE_20	= 0,	/* 20 MHz operation */
483 	HAL_HT_PHYMODE_2040	= 1,	/* 20/40 MHz operation */
484 } HAL_HT_PHYMODE;
485 
486 typedef enum {
487 	HAL_HT_EXTPROTSPACING_20 = 0,	/* 20 MHz spacing */
488 	HAL_HT_EXTPROTSPACING_25 = 1,	/* 25 MHz spacing */
489 } HAL_HT_EXTPROTSPACING;
490 
491 
492 typedef enum {
493 	HAL_RX_CLEAR_CTL_LOW	= 0x1,	/* force control channel to appear busy */
494 	HAL_RX_CLEAR_EXT_LOW	= 0x2,	/* force extension channel to appear busy */
495 } HAL_HT_RXCLEAR;
496 
497 /*
498  * Antenna switch control.  By default antenna selection
499  * enables multiple (2) antenna use.  To force use of the
500  * A or B antenna only specify a fixed setting.  Fixing
501  * the antenna will also disable any diversity support.
502  */
503 typedef enum {
504 	HAL_ANT_VARIABLE = 0,			/* variable by programming */
505 	HAL_ANT_FIXED_A	 = 1,			/* fixed antenna A */
506 	HAL_ANT_FIXED_B	 = 2,			/* fixed antenna B */
507 } HAL_ANT_SETTING;
508 
509 typedef enum {
510 	HAL_M_STA	= 1,			/* infrastructure station */
511 	HAL_M_IBSS	= 0,			/* IBSS (adhoc) station */
512 	HAL_M_HOSTAP	= 6,			/* Software Access Point */
513 	HAL_M_MONITOR	= 8			/* Monitor mode */
514 } HAL_OPMODE;
515 
516 typedef struct {
517 	uint8_t		kv_type;		/* one of HAL_CIPHER */
518 	uint8_t		kv_pad;
519 	uint16_t	kv_len;			/* length in bits */
520 	uint8_t		kv_val[16];		/* enough for 128-bit keys */
521 	uint8_t		kv_mic[8];		/* TKIP MIC key */
522 	uint8_t		kv_txmic[8];		/* TKIP TX MIC key (optional) */
523 } HAL_KEYVAL;
524 
525 typedef enum {
526 	HAL_CIPHER_WEP		= 0,
527 	HAL_CIPHER_AES_OCB	= 1,
528 	HAL_CIPHER_AES_CCM	= 2,
529 	HAL_CIPHER_CKIP		= 3,
530 	HAL_CIPHER_TKIP		= 4,
531 	HAL_CIPHER_CLR		= 5,		/* no encryption */
532 
533 	HAL_CIPHER_MIC		= 127		/* TKIP-MIC, not a cipher */
534 } HAL_CIPHER;
535 
536 enum {
537 	HAL_SLOT_TIME_6	 = 6,			/* NB: for turbo mode */
538 	HAL_SLOT_TIME_9	 = 9,
539 	HAL_SLOT_TIME_20 = 20,
540 };
541 
542 /*
543  * Per-station beacon timer state.  Note that the specified
544  * beacon interval (given in TU's) can also include flags
545  * to force a TSF reset and to enable the beacon xmit logic.
546  * If bs_cfpmaxduration is non-zero the hardware is setup to
547  * coexist with a PCF-capable AP.
548  */
549 typedef struct {
550 	uint32_t	bs_nexttbtt;		/* next beacon in TU */
551 	uint32_t	bs_nextdtim;		/* next DTIM in TU */
552 	uint32_t	bs_intval;		/* beacon interval+flags */
553 #define	HAL_BEACON_PERIOD	0x0000ffff	/* beacon interval period */
554 #define	HAL_BEACON_ENA		0x00800000	/* beacon xmit enable */
555 #define	HAL_BEACON_RESET_TSF	0x01000000	/* clear TSF */
556 	uint32_t	bs_dtimperiod;
557 	uint16_t	bs_cfpperiod;		/* CFP period in TU */
558 	uint16_t	bs_cfpmaxduration;	/* max CFP duration in TU */
559 	uint32_t	bs_cfpnext;		/* next CFP in TU */
560 	uint16_t	bs_timoffset;		/* byte offset to TIM bitmap */
561 	uint16_t	bs_bmissthreshold;	/* beacon miss threshold */
562 	uint32_t	bs_sleepduration;	/* max sleep duration */
563 } HAL_BEACON_STATE;
564 
565 /*
566  * Like HAL_BEACON_STATE but for non-station mode setup.
567  * NB: see above flag definitions for bt_intval.
568  */
569 typedef struct {
570 	uint32_t	bt_intval;		/* beacon interval+flags */
571 	uint32_t	bt_nexttbtt;		/* next beacon in TU */
572 	uint32_t	bt_nextatim;		/* next ATIM in TU */
573 	uint32_t	bt_nextdba;		/* next DBA in 1/8th TU */
574 	uint32_t	bt_nextswba;		/* next SWBA in 1/8th TU */
575 	uint32_t	bt_flags;		/* timer enables */
576 #define HAL_BEACON_TBTT_EN	0x00000001
577 #define HAL_BEACON_DBA_EN	0x00000002
578 #define HAL_BEACON_SWBA_EN	0x00000004
579 } HAL_BEACON_TIMERS;
580 
581 /*
582  * Per-node statistics maintained by the driver for use in
583  * optimizing signal quality and other operational aspects.
584  */
585 typedef struct {
586 	uint32_t	ns_avgbrssi;	/* average beacon rssi */
587 	uint32_t	ns_avgrssi;	/* average data rssi */
588 	uint32_t	ns_avgtxrssi;	/* average tx rssi */
589 } HAL_NODE_STATS;
590 
591 #define	HAL_RSSI_EP_MULTIPLIER	(1<<7)	/* pow2 to optimize out * and / */
592 
593 struct ath_desc;
594 struct ath_tx_status;
595 struct ath_rx_status;
596 struct ieee80211_channel;
597 
598 /*
599  * Hardware Access Layer (HAL) API.
600  *
601  * Clients of the HAL call ath_hal_attach to obtain a reference to an
602  * ath_hal structure for use with the device.  Hardware-related operations
603  * that follow must call back into the HAL through interface, supplying
604  * the reference as the first parameter.  Note that before using the
605  * reference returned by ath_hal_attach the caller should verify the
606  * ABI version number.
607  */
608 struct ath_hal {
609 	uint32_t	ah_magic;	/* consistency check magic number */
610 	uint16_t	ah_devid;	/* PCI device ID */
611 	uint16_t	ah_subvendorid;	/* PCI subvendor ID */
612 	HAL_SOFTC	ah_sc;		/* back pointer to driver/os state */
613 	HAL_BUS_TAG	ah_st;		/* params for register r+w */
614 	HAL_BUS_HANDLE	ah_sh;
615 	HAL_CTRY_CODE	ah_countryCode;
616 
617 	uint32_t	ah_macVersion;	/* MAC version id */
618 	uint16_t	ah_macRev;	/* MAC revision */
619 	uint16_t	ah_phyRev;	/* PHY revision */
620 	/* NB: when only one radio is present the rev is in 5Ghz */
621 	uint16_t	ah_analog5GhzRev;/* 5GHz radio revision */
622 	uint16_t	ah_analog2GhzRev;/* 2GHz radio revision */
623 
624 	uint16_t	*ah_eepromdata;	/* eeprom buffer, if needed */
625 
626 	const HAL_RATE_TABLE *__ahdecl(*ah_getRateTable)(struct ath_hal *,
627 				u_int mode);
628 	void	  __ahdecl(*ah_detach)(struct ath_hal*);
629 
630 	/* Reset functions */
631 	HAL_BOOL  __ahdecl(*ah_reset)(struct ath_hal *, HAL_OPMODE,
632 				struct ieee80211_channel *,
633 				HAL_BOOL bChannelChange, HAL_STATUS *status);
634 	HAL_BOOL  __ahdecl(*ah_phyDisable)(struct ath_hal *);
635 	HAL_BOOL  __ahdecl(*ah_disable)(struct ath_hal *);
636 	void	  __ahdecl(*ah_configPCIE)(struct ath_hal *, HAL_BOOL restore);
637 	void	  __ahdecl(*ah_disablePCIE)(struct ath_hal *);
638 	void	  __ahdecl(*ah_setPCUConfig)(struct ath_hal *);
639 	HAL_BOOL  __ahdecl(*ah_perCalibration)(struct ath_hal*,
640 			struct ieee80211_channel *, HAL_BOOL *);
641 	HAL_BOOL  __ahdecl(*ah_perCalibrationN)(struct ath_hal *,
642 			struct ieee80211_channel *, u_int chainMask,
643 			HAL_BOOL longCal, HAL_BOOL *isCalDone);
644 	HAL_BOOL  __ahdecl(*ah_resetCalValid)(struct ath_hal *,
645 			const struct ieee80211_channel *);
646 	HAL_BOOL  __ahdecl(*ah_setTxPower)(struct ath_hal *,
647 	    		const struct ieee80211_channel *, uint16_t *);
648 	HAL_BOOL  __ahdecl(*ah_setTxPowerLimit)(struct ath_hal *, uint32_t);
649 	HAL_BOOL  __ahdecl(*ah_setBoardValues)(struct ath_hal *,
650 	    		const struct ieee80211_channel *);
651 
652 	/* Transmit functions */
653 	HAL_BOOL  __ahdecl(*ah_updateTxTrigLevel)(struct ath_hal*,
654 				HAL_BOOL incTrigLevel);
655 	int	  __ahdecl(*ah_setupTxQueue)(struct ath_hal *, HAL_TX_QUEUE,
656 				const HAL_TXQ_INFO *qInfo);
657 	HAL_BOOL  __ahdecl(*ah_setTxQueueProps)(struct ath_hal *, int q,
658 				const HAL_TXQ_INFO *qInfo);
659 	HAL_BOOL  __ahdecl(*ah_getTxQueueProps)(struct ath_hal *, int q,
660 				HAL_TXQ_INFO *qInfo);
661 	HAL_BOOL  __ahdecl(*ah_releaseTxQueue)(struct ath_hal *ah, u_int q);
662 	HAL_BOOL  __ahdecl(*ah_resetTxQueue)(struct ath_hal *ah, u_int q);
663 	uint32_t __ahdecl(*ah_getTxDP)(struct ath_hal*, u_int);
664 	HAL_BOOL  __ahdecl(*ah_setTxDP)(struct ath_hal*, u_int, uint32_t txdp);
665 	uint32_t __ahdecl(*ah_numTxPending)(struct ath_hal *, u_int q);
666 	HAL_BOOL  __ahdecl(*ah_startTxDma)(struct ath_hal*, u_int);
667 	HAL_BOOL  __ahdecl(*ah_stopTxDma)(struct ath_hal*, u_int);
668 	HAL_BOOL  __ahdecl(*ah_setupTxDesc)(struct ath_hal *, struct ath_desc *,
669 				u_int pktLen, u_int hdrLen,
670 				HAL_PKT_TYPE type, u_int txPower,
671 				u_int txRate0, u_int txTries0,
672 				u_int keyIx, u_int antMode, u_int flags,
673 				u_int rtsctsRate, u_int rtsctsDuration,
674 				u_int compicvLen, u_int compivLen,
675 				u_int comp);
676 	HAL_BOOL  __ahdecl(*ah_setupXTxDesc)(struct ath_hal *, struct ath_desc*,
677 				u_int txRate1, u_int txTries1,
678 				u_int txRate2, u_int txTries2,
679 				u_int txRate3, u_int txTries3);
680 	HAL_BOOL  __ahdecl(*ah_fillTxDesc)(struct ath_hal *, struct ath_desc *,
681 				u_int segLen, HAL_BOOL firstSeg,
682 				HAL_BOOL lastSeg, const struct ath_desc *);
683 	HAL_STATUS __ahdecl(*ah_procTxDesc)(struct ath_hal *,
684 				struct ath_desc *, struct ath_tx_status *);
685 	void	   __ahdecl(*ah_getTxIntrQueue)(struct ath_hal *, uint32_t *);
686 	void	   __ahdecl(*ah_reqTxIntrDesc)(struct ath_hal *, struct ath_desc*);
687 	HAL_BOOL	__ahdecl(*ah_getTxCompletionRates)(struct ath_hal *,
688 				const struct ath_desc *ds, int *rates, int *tries);
689 
690 	/* Receive Functions */
691 	uint32_t __ahdecl(*ah_getRxDP)(struct ath_hal*);
692 	void	  __ahdecl(*ah_setRxDP)(struct ath_hal*, uint32_t rxdp);
693 	void	  __ahdecl(*ah_enableReceive)(struct ath_hal*);
694 	HAL_BOOL  __ahdecl(*ah_stopDmaReceive)(struct ath_hal*);
695 	void	  __ahdecl(*ah_startPcuReceive)(struct ath_hal*);
696 	void	  __ahdecl(*ah_stopPcuReceive)(struct ath_hal*);
697 	void	  __ahdecl(*ah_setMulticastFilter)(struct ath_hal*,
698 				uint32_t filter0, uint32_t filter1);
699 	HAL_BOOL  __ahdecl(*ah_setMulticastFilterIndex)(struct ath_hal*,
700 				uint32_t index);
701 	HAL_BOOL  __ahdecl(*ah_clrMulticastFilterIndex)(struct ath_hal*,
702 				uint32_t index);
703 	uint32_t __ahdecl(*ah_getRxFilter)(struct ath_hal*);
704 	void	  __ahdecl(*ah_setRxFilter)(struct ath_hal*, uint32_t);
705 	HAL_BOOL  __ahdecl(*ah_setupRxDesc)(struct ath_hal *, struct ath_desc *,
706 				uint32_t size, u_int flags);
707 	HAL_STATUS __ahdecl(*ah_procRxDesc)(struct ath_hal *,
708 				struct ath_desc *, uint32_t phyAddr,
709 				struct ath_desc *next, uint64_t tsf,
710 				struct ath_rx_status *);
711 	void	  __ahdecl(*ah_rxMonitor)(struct ath_hal *,
712 				const HAL_NODE_STATS *,
713 				const struct ieee80211_channel *);
714 	void      __ahdecl(*ah_aniPoll)(struct ath_hal *,
715 				const struct ieee80211_channel *);
716 	void	  __ahdecl(*ah_procMibEvent)(struct ath_hal *,
717 				const HAL_NODE_STATS *);
718 
719 	/* Misc Functions */
720 	HAL_STATUS __ahdecl(*ah_getCapability)(struct ath_hal *,
721 				HAL_CAPABILITY_TYPE, uint32_t capability,
722 				uint32_t *result);
723 	HAL_BOOL   __ahdecl(*ah_setCapability)(struct ath_hal *,
724 				HAL_CAPABILITY_TYPE, uint32_t capability,
725 				uint32_t setting, HAL_STATUS *);
726 	HAL_BOOL   __ahdecl(*ah_getDiagState)(struct ath_hal *, int request,
727 				const void *args, uint32_t argsize,
728 				void **result, uint32_t *resultsize);
729 	void	  __ahdecl(*ah_getMacAddress)(struct ath_hal *, uint8_t *);
730 	HAL_BOOL  __ahdecl(*ah_setMacAddress)(struct ath_hal *, const uint8_t*);
731 	void	  __ahdecl(*ah_getBssIdMask)(struct ath_hal *, uint8_t *);
732 	HAL_BOOL  __ahdecl(*ah_setBssIdMask)(struct ath_hal *, const uint8_t*);
733 	HAL_BOOL  __ahdecl(*ah_setRegulatoryDomain)(struct ath_hal*,
734 				uint16_t, HAL_STATUS *);
735 	void	  __ahdecl(*ah_setLedState)(struct ath_hal*, HAL_LED_STATE);
736 	void	  __ahdecl(*ah_writeAssocid)(struct ath_hal*,
737 				const uint8_t *bssid, uint16_t assocId);
738 	HAL_BOOL  __ahdecl(*ah_gpioCfgOutput)(struct ath_hal *,
739 				uint32_t gpio, HAL_GPIO_MUX_TYPE);
740 	HAL_BOOL  __ahdecl(*ah_gpioCfgInput)(struct ath_hal *, uint32_t gpio);
741 	uint32_t __ahdecl(*ah_gpioGet)(struct ath_hal *, uint32_t gpio);
742 	HAL_BOOL  __ahdecl(*ah_gpioSet)(struct ath_hal *,
743 				uint32_t gpio, uint32_t val);
744 	void	  __ahdecl(*ah_gpioSetIntr)(struct ath_hal*, u_int, uint32_t);
745 	uint32_t __ahdecl(*ah_getTsf32)(struct ath_hal*);
746 	uint64_t __ahdecl(*ah_getTsf64)(struct ath_hal*);
747 	void	  __ahdecl(*ah_resetTsf)(struct ath_hal*);
748 	HAL_BOOL  __ahdecl(*ah_detectCardPresent)(struct ath_hal*);
749 	void	  __ahdecl(*ah_updateMibCounters)(struct ath_hal*,
750 				HAL_MIB_STATS*);
751 	HAL_RFGAIN __ahdecl(*ah_getRfGain)(struct ath_hal*);
752 	u_int	  __ahdecl(*ah_getDefAntenna)(struct ath_hal*);
753 	void	  __ahdecl(*ah_setDefAntenna)(struct ath_hal*, u_int);
754 	HAL_ANT_SETTING	 __ahdecl(*ah_getAntennaSwitch)(struct ath_hal*);
755 	HAL_BOOL  __ahdecl(*ah_setAntennaSwitch)(struct ath_hal*,
756 				HAL_ANT_SETTING);
757 	HAL_BOOL  __ahdecl(*ah_setSifsTime)(struct ath_hal*, u_int);
758 	u_int	  __ahdecl(*ah_getSifsTime)(struct ath_hal*);
759 	HAL_BOOL  __ahdecl(*ah_setSlotTime)(struct ath_hal*, u_int);
760 	u_int	  __ahdecl(*ah_getSlotTime)(struct ath_hal*);
761 	HAL_BOOL  __ahdecl(*ah_setAckTimeout)(struct ath_hal*, u_int);
762 	u_int	  __ahdecl(*ah_getAckTimeout)(struct ath_hal*);
763 	HAL_BOOL  __ahdecl(*ah_setAckCTSRate)(struct ath_hal*, u_int);
764 	u_int	  __ahdecl(*ah_getAckCTSRate)(struct ath_hal*);
765 	HAL_BOOL  __ahdecl(*ah_setCTSTimeout)(struct ath_hal*, u_int);
766 	u_int	  __ahdecl(*ah_getCTSTimeout)(struct ath_hal*);
767 	HAL_BOOL  __ahdecl(*ah_setDecompMask)(struct ath_hal*, uint16_t, int);
768 	void	  __ahdecl(*ah_setCoverageClass)(struct ath_hal*, uint8_t, int);
769 
770 	/* Key Cache Functions */
771 	uint32_t __ahdecl(*ah_getKeyCacheSize)(struct ath_hal*);
772 	HAL_BOOL  __ahdecl(*ah_resetKeyCacheEntry)(struct ath_hal*, uint16_t);
773 	HAL_BOOL  __ahdecl(*ah_isKeyCacheEntryValid)(struct ath_hal *,
774 				uint16_t);
775 	HAL_BOOL  __ahdecl(*ah_setKeyCacheEntry)(struct ath_hal*,
776 				uint16_t, const HAL_KEYVAL *,
777 				const uint8_t *, int);
778 	HAL_BOOL  __ahdecl(*ah_setKeyCacheEntryMac)(struct ath_hal*,
779 				uint16_t, const uint8_t *);
780 
781 	/* Power Management Functions */
782 	HAL_BOOL  __ahdecl(*ah_setPowerMode)(struct ath_hal*,
783 				HAL_POWER_MODE mode, int setChip);
784 	HAL_POWER_MODE __ahdecl(*ah_getPowerMode)(struct ath_hal*);
785 	int16_t   __ahdecl(*ah_getChanNoise)(struct ath_hal *,
786 				const struct ieee80211_channel *);
787 
788 	/* Beacon Management Functions */
789 	void	  __ahdecl(*ah_setBeaconTimers)(struct ath_hal*,
790 				const HAL_BEACON_TIMERS *);
791 	/* NB: deprecated, use ah_setBeaconTimers instead */
792 	void	  __ahdecl(*ah_beaconInit)(struct ath_hal *,
793 				uint32_t nexttbtt, uint32_t intval);
794 	void	  __ahdecl(*ah_setStationBeaconTimers)(struct ath_hal*,
795 				const HAL_BEACON_STATE *);
796 	void	  __ahdecl(*ah_resetStationBeaconTimers)(struct ath_hal*);
797 
798 	/* 802.11n Functions */
799 	HAL_BOOL  __ahdecl(*ah_chainTxDesc)(struct ath_hal *,
800 				struct ath_desc *, u_int, u_int, HAL_PKT_TYPE,
801 				u_int, HAL_CIPHER, uint8_t, u_int, HAL_BOOL,
802 				HAL_BOOL);
803 	HAL_BOOL  __ahdecl(*ah_setupFirstTxDesc)(struct ath_hal *,
804 				struct ath_desc *, u_int, u_int, u_int,
805 				u_int, u_int, u_int, u_int, u_int);
806 	HAL_BOOL  __ahdecl(*ah_setupLastTxDesc)(struct ath_hal *,
807 				struct ath_desc *, const struct ath_desc *);
808 	void	  __ahdecl(*ah_set11nRateScenario)(struct ath_hal *,
809 	    			struct ath_desc *, u_int, u_int,
810 				HAL_11N_RATE_SERIES [], u_int, u_int);
811 	void	  __ahdecl(*ah_set11nAggrMiddle)(struct ath_hal *,
812 	    			struct ath_desc *, u_int);
813 	void	  __ahdecl(*ah_clr11nAggr)(struct ath_hal *,
814 	    			struct ath_desc *);
815 	void	  __ahdecl(*ah_set11nBurstDuration)(struct ath_hal *,
816 	    			struct ath_desc *, u_int);
817 	uint32_t  __ahdecl(*ah_get11nExtBusy)(struct ath_hal *);
818 	void      __ahdecl(*ah_set11nMac2040)(struct ath_hal *,
819 				HAL_HT_MACMODE);
820 	HAL_HT_RXCLEAR __ahdecl(*ah_get11nRxClear)(struct ath_hal *ah);
821 	void	  __ahdecl(*ah_set11nRxClear)(struct ath_hal *,
822 	    			HAL_HT_RXCLEAR);
823 
824 	/* Interrupt functions */
825 	HAL_BOOL  __ahdecl(*ah_isInterruptPending)(struct ath_hal*);
826 	HAL_BOOL  __ahdecl(*ah_getPendingInterrupts)(struct ath_hal*, HAL_INT*);
827 	HAL_INT	  __ahdecl(*ah_getInterrupts)(struct ath_hal*);
828 	HAL_INT	  __ahdecl(*ah_setInterrupts)(struct ath_hal*, HAL_INT);
829 };
830 
831 /*
832  * Check the PCI vendor ID and device ID against Atheros' values
833  * and return a printable description for any Atheros hardware.
834  * AH_NULL is returned if the ID's do not describe Atheros hardware.
835  */
836 extern	const char *__ahdecl ath_hal_probe(uint16_t vendorid, uint16_t devid);
837 
838 /*
839  * Attach the HAL for use with the specified device.  The device is
840  * defined by the PCI device ID.  The caller provides an opaque pointer
841  * to an upper-layer data structure (HAL_SOFTC) that is stored in the
842  * HAL state block for later use.  Hardware register accesses are done
843  * using the specified bus tag and handle.  On successful return a
844  * reference to a state block is returned that must be supplied in all
845  * subsequent HAL calls.  Storage associated with this reference is
846  * dynamically allocated and must be freed by calling the ah_detach
847  * method when the client is done.  If the attach operation fails a
848  * null (AH_NULL) reference will be returned and a status code will
849  * be returned if the status parameter is non-zero.
850  */
851 extern	struct ath_hal * __ahdecl ath_hal_attach(uint16_t devid, HAL_SOFTC,
852 		HAL_BUS_TAG, HAL_BUS_HANDLE, uint16_t *eepromdata, HAL_STATUS* status);
853 
854 extern	const char *ath_hal_mac_name(struct ath_hal *);
855 extern	const char *ath_hal_rf_name(struct ath_hal *);
856 
857 /*
858  * Regulatory interfaces.  Drivers should use ath_hal_init_channels to
859  * request a set of channels for a particular country code and/or
860  * regulatory domain.  If CTRY_DEFAULT and SKU_NONE are specified then
861  * this list is constructed according to the contents of the EEPROM.
862  * ath_hal_getchannels acts similarly but does not alter the operating
863  * state; this can be used to collect information for a particular
864  * regulatory configuration.  Finally ath_hal_set_channels installs a
865  * channel list constructed outside the driver.  The HAL will adopt the
866  * channel list and setup internal state according to the specified
867  * regulatory configuration (e.g. conformance test limits).
868  *
869  * For all interfaces the channel list is returned in the supplied array.
870  * maxchans defines the maximum size of this array.  nchans contains the
871  * actual number of channels returned.  If a problem occurred then a
872  * status code != HAL_OK is returned.
873  */
874 struct ieee80211_channel;
875 
876 /*
877  * Return a list of channels according to the specified regulatory.
878  */
879 extern	HAL_STATUS __ahdecl ath_hal_getchannels(struct ath_hal *,
880     struct ieee80211_channel *chans, u_int maxchans, int *nchans,
881     u_int modeSelect, HAL_CTRY_CODE cc, HAL_REG_DOMAIN regDmn,
882     HAL_BOOL enableExtendedChannels);
883 
884 /*
885  * Return a list of channels and install it as the current operating
886  * regulatory list.
887  */
888 extern	HAL_STATUS __ahdecl ath_hal_init_channels(struct ath_hal *,
889     struct ieee80211_channel *chans, u_int maxchans, int *nchans,
890     u_int modeSelect, HAL_CTRY_CODE cc, HAL_REG_DOMAIN rd,
891     HAL_BOOL enableExtendedChannels);
892 
893 /*
894  * Install the list of channels as the current operating regulatory
895  * and setup related state according to the country code and sku.
896  */
897 extern	HAL_STATUS __ahdecl ath_hal_set_channels(struct ath_hal *,
898     struct ieee80211_channel *chans, int nchans,
899     HAL_CTRY_CODE cc, HAL_REG_DOMAIN regDmn);
900 
901 /*
902  * Calibrate noise floor data following a channel scan or similar.
903  * This must be called prior retrieving noise floor data.
904  */
905 extern	void __ahdecl ath_hal_process_noisefloor(struct ath_hal *ah);
906 
907 /*
908  * Return bit mask of wireless modes supported by the hardware.
909  */
910 extern	u_int __ahdecl ath_hal_getwirelessmodes(struct ath_hal*);
911 
912 /*
913  * Calculate the packet TX time for a legacy or 11n frame
914  */
915 extern uint32_t __ahdecl ath_hal_pkt_txtime(struct ath_hal *ah,
916     const HAL_RATE_TABLE *rates, uint32_t frameLen,
917     uint16_t rateix, HAL_BOOL isht40, HAL_BOOL shortPreamble);
918 
919 /*
920  * Calculate the duration of an 11n frame.
921  */
922 extern uint32_t __ahdecl ath_computedur_ht(uint32_t frameLen, uint16_t rate,
923     int streams, HAL_BOOL isht40, HAL_BOOL isShortGI);
924 
925 /*
926  * Calculate the transmit duration of a legacy frame.
927  */
928 extern uint16_t __ahdecl ath_hal_computetxtime(struct ath_hal *,
929 		const HAL_RATE_TABLE *rates, uint32_t frameLen,
930 		uint16_t rateix, HAL_BOOL shortPreamble);
931 #endif /* _ATH_AH_H_ */
932