ah.h revision 239605
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: head/sys/dev/ath/ath_hal/ah.h 239605 2012-08-23 03:25:09Z adrian $
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 * The maximum number of TX/RX chains supported.
35 * This is intended to be used by various statistics gathering operations
36 * (NF, RSSI, EVM).
37 */
38#define	AH_MIMO_MAX_CHAINS		3
39#define	AH_MIMO_MAX_EVM_PILOTS		6
40
41/*
42 * __ahdecl is analogous to _cdecl; it defines the calling
43 * convention used within the HAL.  For most systems this
44 * can just default to be empty and the compiler will (should)
45 * use _cdecl.  For systems where _cdecl is not compatible this
46 * must be defined.  See linux/ah_osdep.h for an example.
47 */
48#ifndef __ahdecl
49#define __ahdecl
50#endif
51
52/*
53 * Status codes that may be returned by the HAL.  Note that
54 * interfaces that return a status code set it only when an
55 * error occurs--i.e. you cannot check it for success.
56 */
57typedef enum {
58	HAL_OK		= 0,	/* No error */
59	HAL_ENXIO	= 1,	/* No hardware present */
60	HAL_ENOMEM	= 2,	/* Memory allocation failed */
61	HAL_EIO		= 3,	/* Hardware didn't respond as expected */
62	HAL_EEMAGIC	= 4,	/* EEPROM magic number invalid */
63	HAL_EEVERSION	= 5,	/* EEPROM version invalid */
64	HAL_EELOCKED	= 6,	/* EEPROM unreadable */
65	HAL_EEBADSUM	= 7,	/* EEPROM checksum invalid */
66	HAL_EEREAD	= 8,	/* EEPROM read problem */
67	HAL_EEBADMAC	= 9,	/* EEPROM mac address invalid */
68	HAL_EESIZE	= 10,	/* EEPROM size not supported */
69	HAL_EEWRITE	= 11,	/* Attempt to change write-locked EEPROM */
70	HAL_EINVAL	= 12,	/* Invalid parameter to function */
71	HAL_ENOTSUPP	= 13,	/* Hardware revision not supported */
72	HAL_ESELFTEST	= 14,	/* Hardware self-test failed */
73	HAL_EINPROGRESS	= 15,	/* Operation incomplete */
74	HAL_EEBADREG	= 16,	/* EEPROM invalid regulatory contents */
75	HAL_EEBADCC	= 17,	/* EEPROM invalid country code */
76	HAL_INV_PMODE	= 18,	/* Couldn't bring out of sleep state */
77} HAL_STATUS;
78
79typedef enum {
80	AH_FALSE = 0,		/* NB: lots of code assumes false is zero */
81	AH_TRUE  = 1,
82} HAL_BOOL;
83
84typedef enum {
85	HAL_CAP_REG_DMN		= 0,	/* current regulatory domain */
86	HAL_CAP_CIPHER		= 1,	/* hardware supports cipher */
87	HAL_CAP_TKIP_MIC	= 2,	/* handle TKIP MIC in hardware */
88	HAL_CAP_TKIP_SPLIT	= 3,	/* hardware TKIP uses split keys */
89	HAL_CAP_PHYCOUNTERS	= 4,	/* hardware PHY error counters */
90	HAL_CAP_DIVERSITY	= 5,	/* hardware supports fast diversity */
91	HAL_CAP_KEYCACHE_SIZE	= 6,	/* number of entries in key cache */
92	HAL_CAP_NUM_TXQUEUES	= 7,	/* number of hardware xmit queues */
93	HAL_CAP_VEOL		= 9,	/* hardware supports virtual EOL */
94	HAL_CAP_PSPOLL		= 10,	/* hardware has working PS-Poll support */
95	HAL_CAP_DIAG		= 11,	/* hardware diagnostic support */
96	HAL_CAP_COMPRESSION	= 12,	/* hardware supports compression */
97	HAL_CAP_BURST		= 13,	/* hardware supports packet bursting */
98	HAL_CAP_FASTFRAME	= 14,	/* hardware supoprts fast frames */
99	HAL_CAP_TXPOW		= 15,	/* global tx power limit  */
100	HAL_CAP_TPC		= 16,	/* per-packet tx power control  */
101	HAL_CAP_PHYDIAG		= 17,	/* hardware phy error diagnostic */
102	HAL_CAP_BSSIDMASK	= 18,	/* hardware supports bssid mask */
103	HAL_CAP_MCAST_KEYSRCH	= 19,	/* hardware has multicast key search */
104	HAL_CAP_TSF_ADJUST	= 20,	/* hardware has beacon tsf adjust */
105	/* 21 was HAL_CAP_XR */
106	HAL_CAP_WME_TKIPMIC 	= 22,   /* hardware can support TKIP MIC when WMM is turned on */
107	/* 23 was HAL_CAP_CHAN_HALFRATE */
108	/* 24 was HAL_CAP_CHAN_QUARTERRATE */
109	HAL_CAP_RFSILENT	= 25,	/* hardware has rfsilent support  */
110	HAL_CAP_TPC_ACK		= 26,	/* ack txpower with per-packet tpc */
111	HAL_CAP_TPC_CTS		= 27,	/* cts txpower with per-packet tpc */
112	HAL_CAP_11D		= 28,   /* 11d beacon support for changing cc */
113	HAL_CAP_PCIE_PS		= 29,
114	HAL_CAP_HT		= 30,   /* hardware can support HT */
115	HAL_CAP_GTXTO		= 31,	/* hardware supports global tx timeout */
116	HAL_CAP_FAST_CC		= 32,	/* hardware supports fast channel change */
117	HAL_CAP_TX_CHAINMASK	= 33,	/* mask of TX chains supported */
118	HAL_CAP_RX_CHAINMASK	= 34,	/* mask of RX chains supported */
119	HAL_CAP_NUM_GPIO_PINS	= 36,	/* number of GPIO pins */
120
121	HAL_CAP_CST		= 38,	/* hardware supports carrier sense timeout */
122
123	HAL_CAP_RIFS_RX		= 39,
124	HAL_CAP_RIFS_TX		= 40,
125	HAL_CAP_FORCE_PPM	= 41,
126	HAL_CAP_RTS_AGGR_LIMIT	= 42,	/* aggregation limit with RTS */
127	HAL_CAP_4ADDR_AGGR	= 43,	/* hardware is capable of 4addr aggregation */
128	HAL_CAP_DFS_DMN		= 44,	/* current DFS domain */
129	HAL_CAP_EXT_CHAN_DFS	= 45,	/* DFS support for extension channel */
130	HAL_CAP_COMBINED_RADAR_RSSI	= 46,	/* Is combined RSSI for radar accurate */
131
132	HAL_CAP_AUTO_SLEEP	= 48,	/* hardware can go to network sleep
133					   automatically after waking up to receive TIM */
134	HAL_CAP_MBSSID_AGGR_SUPPORT	= 49, /* Support for mBSSID Aggregation */
135	HAL_CAP_SPLIT_4KB_TRANS	= 50,	/* hardware supports descriptors straddling a 4k page boundary */
136	HAL_CAP_REG_FLAG	= 51,	/* Regulatory domain flags */
137	HAL_CAP_BB_RIFS_HANG	= 52,
138	HAL_CAP_RIFS_RX_ENABLED	= 53,
139	HAL_CAP_BB_DFS_HANG	= 54,
140
141	HAL_CAP_BT_COEX		= 60,	/* hardware is capable of bluetooth coexistence */
142	HAL_CAP_DYNAMIC_SMPS	= 61,	/* Dynamic MIMO Power Save hardware support */
143
144	HAL_CAP_DS		= 67,	/* 2 stream */
145	HAL_CAP_BB_RX_CLEAR_STUCK_HANG	= 68,
146	HAL_CAP_MAC_HANG	= 69,	/* can MAC hang */
147	HAL_CAP_MFP		= 70,	/* Management Frame Protection in hardware */
148
149	HAL_CAP_TS		= 72,	/* 3 stream */
150
151	HAL_CAP_ENHANCED_DMA_SUPPORT	= 75,	/* DMA FIFO support */
152	HAL_CAP_NUM_TXMAPS	= 76,	/* Number of buffers in a transmit descriptor */
153	HAL_CAP_TXDESCLEN	= 77,	/* Length of transmit descriptor */
154	HAL_CAP_TXSTATUSLEN	= 78,	/* Length of transmit status descriptor */
155	HAL_CAP_RXSTATUSLEN	= 79,	/* Length of transmit status descriptor */
156	HAL_CAP_RXFIFODEPTH	= 80,	/* Receive hardware FIFO depth */
157	HAL_CAP_RXBUFSIZE	= 81,	/* Receive Buffer Length */
158	HAL_CAP_NUM_MR_RETRIES	= 82,	/* limit on multirate retries */
159
160	HAL_CAP_OL_PWRCTRL	= 84,	/* Open loop TX power control */
161
162	HAL_CAP_BB_PANIC_WATCHDOG	= 92,
163
164	HAL_CAP_HT20_SGI	= 96,	/* hardware supports HT20 short GI */
165
166	HAL_CAP_RXTSTAMP_PREC	= 100,	/* rx desc tstamp precision (bits) */
167	HAL_CAP_ENHANCED_DFS_SUPPORT	= 117,	/* hardware supports enhanced DFS */
168
169	/* The following are private to the FreeBSD HAL (224 onward) */
170
171	HAL_CAP_INTMIT		= 229,	/* interference mitigation */
172	HAL_CAP_RXORN_FATAL	= 230,	/* HAL_INT_RXORN treated as fatal */
173	HAL_CAP_BB_HANG		= 235,	/* can baseband hang */
174	HAL_CAP_INTRMASK	= 237,	/* bitmask of supported interrupts */
175	HAL_CAP_BSSIDMATCH	= 238,	/* hardware has disable bssid match */
176	HAL_CAP_STREAMS		= 239,	/* how many 802.11n spatial streams are available */
177	HAL_CAP_RXDESC_SELFLINK	= 242,	/* support a self-linked tail RX descriptor */
178	HAL_CAP_LONG_RXDESC_TSF	= 243,	/* hardware supports 32bit TSF in RX descriptor */
179	HAL_CAP_BB_READ_WAR	= 244,	/* baseband read WAR */
180	HAL_CAP_SERIALISE_WAR	= 245,	/* serialise register access on PCI */
181} HAL_CAPABILITY_TYPE;
182
183/*
184 * "States" for setting the LED.  These correspond to
185 * the possible 802.11 operational states and there may
186 * be a many-to-one mapping between these states and the
187 * actual hardware state for the LED's (i.e. the hardware
188 * may have fewer states).
189 */
190typedef enum {
191	HAL_LED_INIT	= 0,
192	HAL_LED_SCAN	= 1,
193	HAL_LED_AUTH	= 2,
194	HAL_LED_ASSOC	= 3,
195	HAL_LED_RUN	= 4
196} HAL_LED_STATE;
197
198/*
199 * Transmit queue types/numbers.  These are used to tag
200 * each transmit queue in the hardware and to identify a set
201 * of transmit queues for operations such as start/stop dma.
202 */
203typedef enum {
204	HAL_TX_QUEUE_INACTIVE	= 0,		/* queue is inactive/unused */
205	HAL_TX_QUEUE_DATA	= 1,		/* data xmit q's */
206	HAL_TX_QUEUE_BEACON	= 2,		/* beacon xmit q */
207	HAL_TX_QUEUE_CAB	= 3,		/* "crap after beacon" xmit q */
208	HAL_TX_QUEUE_UAPSD	= 4,		/* u-apsd power save xmit q */
209	HAL_TX_QUEUE_PSPOLL	= 5,		/* power save poll xmit q */
210	HAL_TX_QUEUE_CFEND	= 6,
211	HAL_TX_QUEUE_PAPRD	= 7,
212} HAL_TX_QUEUE;
213
214#define	HAL_NUM_TX_QUEUES	10		/* max possible # of queues */
215
216typedef enum {
217	HAL_RX_QUEUE_HP = 0,			/* high priority recv queue */
218	HAL_RX_QUEUE_LP = 1,			/* low priority recv queue */
219} HAL_RX_QUEUE;
220
221#define	HAL_NUM_RX_QUEUES	2		/* max possible # of queues */
222
223#define	HAL_TXFIFO_DEPTH	8		/* transmit fifo depth */
224
225/*
226 * Transmit queue subtype.  These map directly to
227 * WME Access Categories (except for UPSD).  Refer
228 * to Table 5 of the WME spec.
229 */
230typedef enum {
231	HAL_WME_AC_BK	= 0,			/* background access category */
232	HAL_WME_AC_BE	= 1, 			/* best effort access category*/
233	HAL_WME_AC_VI	= 2,			/* video access category */
234	HAL_WME_AC_VO	= 3,			/* voice access category */
235	HAL_WME_UPSD	= 4,			/* uplink power save */
236} HAL_TX_QUEUE_SUBTYPE;
237
238/*
239 * Transmit queue flags that control various
240 * operational parameters.
241 */
242typedef enum {
243	/*
244	 * Per queue interrupt enables.  When set the associated
245	 * interrupt may be delivered for packets sent through
246	 * the queue.  Without these enabled no interrupts will
247	 * be delivered for transmits through the queue.
248	 */
249	HAL_TXQ_TXOKINT_ENABLE	   = 0x0001,	/* enable TXOK interrupt */
250	HAL_TXQ_TXERRINT_ENABLE	   = 0x0001,	/* enable TXERR interrupt */
251	HAL_TXQ_TXDESCINT_ENABLE   = 0x0002,	/* enable TXDESC interrupt */
252	HAL_TXQ_TXEOLINT_ENABLE	   = 0x0004,	/* enable TXEOL interrupt */
253	HAL_TXQ_TXURNINT_ENABLE	   = 0x0008,	/* enable TXURN interrupt */
254	/*
255	 * Enable hardware compression for packets sent through
256	 * the queue.  The compression buffer must be setup and
257	 * packets must have a key entry marked in the tx descriptor.
258	 */
259	HAL_TXQ_COMPRESSION_ENABLE  = 0x0010,	/* enable h/w compression */
260	/*
261	 * Disable queue when veol is hit or ready time expires.
262	 * By default the queue is disabled only on reaching the
263	 * physical end of queue (i.e. a null link ptr in the
264	 * descriptor chain).
265	 */
266	HAL_TXQ_RDYTIME_EXP_POLICY_ENABLE = 0x0020,
267	/*
268	 * Schedule frames on delivery of a DBA (DMA Beacon Alert)
269	 * event.  Frames will be transmitted only when this timer
270	 * fires, e.g to transmit a beacon in ap or adhoc modes.
271	 */
272	HAL_TXQ_DBA_GATED	    = 0x0040,	/* schedule based on DBA */
273	/*
274	 * Each transmit queue has a counter that is incremented
275	 * each time the queue is enabled and decremented when
276	 * the list of frames to transmit is traversed (or when
277	 * the ready time for the queue expires).  This counter
278	 * must be non-zero for frames to be scheduled for
279	 * transmission.  The following controls disable bumping
280	 * this counter under certain conditions.  Typically this
281	 * is used to gate frames based on the contents of another
282	 * queue (e.g. CAB traffic may only follow a beacon frame).
283	 * These are meaningful only when frames are scheduled
284	 * with a non-ASAP policy (e.g. DBA-gated).
285	 */
286	HAL_TXQ_CBR_DIS_QEMPTY	    = 0x0080,	/* disable on this q empty */
287	HAL_TXQ_CBR_DIS_BEMPTY	    = 0x0100,	/* disable on beacon q empty */
288
289	/*
290	 * Fragment burst backoff policy.  Normally the no backoff
291	 * is done after a successful transmission, the next fragment
292	 * is sent at SIFS.  If this flag is set backoff is done
293	 * after each fragment, regardless whether it was ack'd or
294	 * not, after the backoff count reaches zero a normal channel
295	 * access procedure is done before the next transmit (i.e.
296	 * wait AIFS instead of SIFS).
297	 */
298	HAL_TXQ_FRAG_BURST_BACKOFF_ENABLE = 0x00800000,
299	/*
300	 * Disable post-tx backoff following each frame.
301	 */
302	HAL_TXQ_BACKOFF_DISABLE	    = 0x00010000, /* disable post backoff  */
303	/*
304	 * DCU arbiter lockout control.  This controls how
305	 * lower priority tx queues are handled with respect to
306	 * to a specific queue when multiple queues have frames
307	 * to send.  No lockout means lower priority queues arbitrate
308	 * concurrently with this queue.  Intra-frame lockout
309	 * means lower priority queues are locked out until the
310	 * current frame transmits (e.g. including backoffs and bursting).
311	 * Global lockout means nothing lower can arbitrary so
312	 * long as there is traffic activity on this queue (frames,
313	 * backoff, etc).
314	 */
315	HAL_TXQ_ARB_LOCKOUT_INTRA   = 0x00020000, /* intra-frame lockout */
316	HAL_TXQ_ARB_LOCKOUT_GLOBAL  = 0x00040000, /* full lockout s */
317
318	HAL_TXQ_IGNORE_VIRTCOL	    = 0x00080000, /* ignore virt collisions */
319	HAL_TXQ_SEQNUM_INC_DIS	    = 0x00100000, /* disable seqnum increment */
320} HAL_TX_QUEUE_FLAGS;
321
322typedef struct {
323	uint32_t	tqi_ver;		/* hal TXQ version */
324	HAL_TX_QUEUE_SUBTYPE tqi_subtype;	/* subtype if applicable */
325	HAL_TX_QUEUE_FLAGS tqi_qflags;		/* flags (see above) */
326	uint32_t	tqi_priority;		/* (not used) */
327	uint32_t	tqi_aifs;		/* aifs */
328	uint32_t	tqi_cwmin;		/* cwMin */
329	uint32_t	tqi_cwmax;		/* cwMax */
330	uint16_t	tqi_shretry;		/* rts retry limit */
331	uint16_t	tqi_lgretry;		/* long retry limit (not used)*/
332	uint32_t	tqi_cbrPeriod;		/* CBR period (us) */
333	uint32_t	tqi_cbrOverflowLimit;	/* threshold for CBROVF int */
334	uint32_t	tqi_burstTime;		/* max burst duration (us) */
335	uint32_t	tqi_readyTime;		/* frame schedule time (us) */
336	uint32_t	tqi_compBuf;		/* comp buffer phys addr */
337} HAL_TXQ_INFO;
338
339#define HAL_TQI_NONVAL 0xffff
340
341/* token to use for aifs, cwmin, cwmax */
342#define	HAL_TXQ_USEDEFAULT	((uint32_t) -1)
343
344/* compression definitions */
345#define HAL_COMP_BUF_MAX_SIZE           9216            /* 9K */
346#define HAL_COMP_BUF_ALIGN_SIZE         512
347
348/*
349 * Transmit packet types.  This belongs in ah_desc.h, but
350 * is here so we can give a proper type to various parameters
351 * (and not require everyone include the file).
352 *
353 * NB: These values are intentionally assigned for
354 *     direct use when setting up h/w descriptors.
355 */
356typedef enum {
357	HAL_PKT_TYPE_NORMAL	= 0,
358	HAL_PKT_TYPE_ATIM	= 1,
359	HAL_PKT_TYPE_PSPOLL	= 2,
360	HAL_PKT_TYPE_BEACON	= 3,
361	HAL_PKT_TYPE_PROBE_RESP	= 4,
362	HAL_PKT_TYPE_CHIRP	= 5,
363	HAL_PKT_TYPE_GRP_POLL	= 6,
364	HAL_PKT_TYPE_AMPDU	= 7,
365} HAL_PKT_TYPE;
366
367/* Rx Filter Frame Types */
368typedef enum {
369	/*
370	 * These bits correspond to AR_RX_FILTER for all chips.
371	 * Not all bits are supported by all chips.
372	 */
373	HAL_RX_FILTER_UCAST	= 0x00000001,	/* Allow unicast frames */
374	HAL_RX_FILTER_MCAST	= 0x00000002,	/* Allow multicast frames */
375	HAL_RX_FILTER_BCAST	= 0x00000004,	/* Allow broadcast frames */
376	HAL_RX_FILTER_CONTROL	= 0x00000008,	/* Allow control frames */
377	HAL_RX_FILTER_BEACON	= 0x00000010,	/* Allow beacon frames */
378	HAL_RX_FILTER_PROM	= 0x00000020,	/* Promiscuous mode */
379	HAL_RX_FILTER_PROBEREQ	= 0x00000080,	/* Allow probe request frames */
380	HAL_RX_FILTER_PHYERR	= 0x00000100,	/* Allow phy errors */
381	HAL_RX_FILTER_COMPBAR	= 0x00000400,	/* Allow compressed BAR */
382	HAL_RX_FILTER_COMP_BA	= 0x00000800,	/* Allow compressed blockack */
383	HAL_RX_FILTER_PHYRADAR	= 0x00002000,	/* Allow phy radar errors */
384	HAL_RX_FILTER_PSPOLL	= 0x00004000,	/* Allow PS-POLL frames */
385	HAL_RX_FILTER_MCAST_BCAST_ALL	= 0x00008000,
386						/* Allow all mcast/bcast frames */
387
388	/*
389	 * Magic RX filter flags that aren't targetting hardware bits
390	 * but instead the HAL sets individual bits - eg PHYERR will result
391	 * in OFDM/CCK timing error frames being received.
392	 */
393	HAL_RX_FILTER_BSSID	= 0x40000000,	/* Disable BSSID match */
394} HAL_RX_FILTER;
395
396typedef enum {
397	HAL_PM_AWAKE		= 0,
398	HAL_PM_FULL_SLEEP	= 1,
399	HAL_PM_NETWORK_SLEEP	= 2,
400	HAL_PM_UNDEFINED	= 3
401} HAL_POWER_MODE;
402
403/*
404 * NOTE WELL:
405 * These are mapped to take advantage of the common locations for many of
406 * the bits on all of the currently supported MAC chips. This is to make
407 * the ISR as efficient as possible, while still abstracting HW differences.
408 * When new hardware breaks this commonality this enumerated type, as well
409 * as the HAL functions using it, must be modified. All values are directly
410 * mapped unless commented otherwise.
411 */
412typedef enum {
413	HAL_INT_RX	= 0x00000001,	/* Non-common mapping */
414	HAL_INT_RXDESC	= 0x00000002,	/* Legacy mapping */
415	HAL_INT_RXERR	= 0x00000004,
416	HAL_INT_RXHP	= 0x00000001,	/* EDMA */
417	HAL_INT_RXLP	= 0x00000002,	/* EDMA */
418	HAL_INT_RXNOFRM	= 0x00000008,
419	HAL_INT_RXEOL	= 0x00000010,
420	HAL_INT_RXORN	= 0x00000020,
421	HAL_INT_TX	= 0x00000040,	/* Non-common mapping */
422	HAL_INT_TXDESC	= 0x00000080,
423	HAL_INT_TIM_TIMER= 0x00000100,
424	HAL_INT_MCI	= 0x00000200,
425	HAL_INT_BBPANIC	= 0x00000400,
426	HAL_INT_TXURN	= 0x00000800,
427	HAL_INT_MIB	= 0x00001000,
428	HAL_INT_RXPHY	= 0x00004000,
429	HAL_INT_RXKCM	= 0x00008000,
430	HAL_INT_SWBA	= 0x00010000,
431	HAL_INT_BRSSI	= 0x00020000,
432	HAL_INT_BMISS	= 0x00040000,
433	HAL_INT_BNR	= 0x00100000,
434	HAL_INT_TIM	= 0x00200000,	/* Non-common mapping */
435	HAL_INT_DTIM	= 0x00400000,	/* Non-common mapping */
436	HAL_INT_DTIMSYNC= 0x00800000,	/* Non-common mapping */
437	HAL_INT_GPIO	= 0x01000000,
438	HAL_INT_CABEND	= 0x02000000,	/* Non-common mapping */
439	HAL_INT_TSFOOR	= 0x04000000,	/* Non-common mapping */
440	HAL_INT_TBTT	= 0x08000000,	/* Non-common mapping */
441	/* Atheros ref driver has a generic timer interrupt now..*/
442	HAL_INT_GENTIMER	= 0x08000000,   /* Non-common mapping */
443	HAL_INT_CST	= 0x10000000,	/* Non-common mapping */
444	HAL_INT_GTT	= 0x20000000,	/* Non-common mapping */
445	HAL_INT_FATAL	= 0x40000000,	/* Non-common mapping */
446#define	HAL_INT_GLOBAL	0x80000000	/* Set/clear IER */
447	HAL_INT_BMISC	= HAL_INT_TIM
448			| HAL_INT_DTIM
449			| HAL_INT_DTIMSYNC
450			| HAL_INT_CABEND
451			| HAL_INT_TBTT,
452
453	/* Interrupt bits that map directly to ISR/IMR bits */
454	HAL_INT_COMMON  = HAL_INT_RXNOFRM
455			| HAL_INT_RXDESC
456			| HAL_INT_RXEOL
457			| HAL_INT_RXORN
458			| HAL_INT_TXDESC
459			| HAL_INT_TXURN
460			| HAL_INT_MIB
461			| HAL_INT_RXPHY
462			| HAL_INT_RXKCM
463			| HAL_INT_SWBA
464			| HAL_INT_BMISS
465			| HAL_INT_BRSSI
466			| HAL_INT_BNR
467			| HAL_INT_GPIO,
468} HAL_INT;
469
470/*
471 * MSI vector assignments
472 */
473typedef enum {
474	HAL_MSIVEC_MISC = 0,
475	HAL_MSIVEC_TX   = 1,
476	HAL_MSIVEC_RXLP = 2,
477	HAL_MSIVEC_RXHP = 3,
478} HAL_MSIVEC;
479
480typedef enum {
481	HAL_INT_LINE = 0,
482	HAL_INT_MSI  = 1,
483} HAL_INT_TYPE;
484
485/* For interrupt mitigation registers */
486typedef enum {
487	HAL_INT_RX_FIRSTPKT=0,
488	HAL_INT_RX_LASTPKT,
489	HAL_INT_TX_FIRSTPKT,
490	HAL_INT_TX_LASTPKT,
491	HAL_INT_THRESHOLD
492} HAL_INT_MITIGATION;
493
494typedef enum {
495	HAL_GPIO_OUTPUT_MUX_AS_OUTPUT		= 0,
496	HAL_GPIO_OUTPUT_MUX_PCIE_ATTENTION_LED	= 1,
497	HAL_GPIO_OUTPUT_MUX_PCIE_POWER_LED	= 2,
498	HAL_GPIO_OUTPUT_MUX_MAC_NETWORK_LED	= 3,
499	HAL_GPIO_OUTPUT_MUX_MAC_POWER_LED	= 4,
500	HAL_GPIO_OUTPUT_MUX_AS_WLAN_ACTIVE	= 5,
501	HAL_GPIO_OUTPUT_MUX_AS_TX_FRAME		= 6
502} HAL_GPIO_MUX_TYPE;
503
504typedef enum {
505	HAL_GPIO_INTR_LOW		= 0,
506	HAL_GPIO_INTR_HIGH		= 1,
507	HAL_GPIO_INTR_DISABLE		= 2
508} HAL_GPIO_INTR_TYPE;
509
510typedef enum {
511	HAL_RFGAIN_INACTIVE		= 0,
512	HAL_RFGAIN_READ_REQUESTED	= 1,
513	HAL_RFGAIN_NEED_CHANGE		= 2
514} HAL_RFGAIN;
515
516typedef uint16_t HAL_CTRY_CODE;		/* country code */
517typedef uint16_t HAL_REG_DOMAIN;		/* regulatory domain code */
518
519#define HAL_ANTENNA_MIN_MODE  0
520#define HAL_ANTENNA_FIXED_A   1
521#define HAL_ANTENNA_FIXED_B   2
522#define HAL_ANTENNA_MAX_MODE  3
523
524typedef struct {
525	uint32_t	ackrcv_bad;
526	uint32_t	rts_bad;
527	uint32_t	rts_good;
528	uint32_t	fcs_bad;
529	uint32_t	beacons;
530} HAL_MIB_STATS;
531
532enum {
533	HAL_MODE_11A	= 0x001,		/* 11a channels */
534	HAL_MODE_TURBO	= 0x002,		/* 11a turbo-only channels */
535	HAL_MODE_11B	= 0x004,		/* 11b channels */
536	HAL_MODE_PUREG	= 0x008,		/* 11g channels (OFDM only) */
537#ifdef notdef
538	HAL_MODE_11G	= 0x010,		/* 11g channels (OFDM/CCK) */
539#else
540	HAL_MODE_11G	= 0x008,		/* XXX historical */
541#endif
542	HAL_MODE_108G	= 0x020,		/* 11g+Turbo channels */
543	HAL_MODE_108A	= 0x040,		/* 11a+Turbo channels */
544	HAL_MODE_11A_HALF_RATE = 0x200,		/* 11a half width channels */
545	HAL_MODE_11A_QUARTER_RATE = 0x400,	/* 11a quarter width channels */
546	HAL_MODE_11G_HALF_RATE = 0x800,		/* 11g half width channels */
547	HAL_MODE_11G_QUARTER_RATE = 0x1000,	/* 11g quarter width channels */
548	HAL_MODE_11NG_HT20	= 0x008000,
549	HAL_MODE_11NA_HT20  	= 0x010000,
550	HAL_MODE_11NG_HT40PLUS	= 0x020000,
551	HAL_MODE_11NG_HT40MINUS	= 0x040000,
552	HAL_MODE_11NA_HT40PLUS	= 0x080000,
553	HAL_MODE_11NA_HT40MINUS	= 0x100000,
554	HAL_MODE_ALL	= 0xffffff
555};
556
557typedef struct {
558	int		rateCount;		/* NB: for proper padding */
559	uint8_t		rateCodeToIndex[256];	/* back mapping */
560	struct {
561		uint8_t		valid;		/* valid for rate control use */
562		uint8_t		phy;		/* CCK/OFDM/XR */
563		uint32_t	rateKbps;	/* transfer rate in kbs */
564		uint8_t		rateCode;	/* rate for h/w descriptors */
565		uint8_t		shortPreamble;	/* mask for enabling short
566						 * preamble in CCK rate code */
567		uint8_t		dot11Rate;	/* value for supported rates
568						 * info element of MLME */
569		uint8_t		controlRate;	/* index of next lower basic
570						 * rate; used for dur. calcs */
571		uint16_t	lpAckDuration;	/* long preamble ACK duration */
572		uint16_t	spAckDuration;	/* short preamble ACK duration*/
573	} info[64];
574} HAL_RATE_TABLE;
575
576typedef struct {
577	u_int		rs_count;		/* number of valid entries */
578	uint8_t	rs_rates[64];		/* rates */
579} HAL_RATE_SET;
580
581/*
582 * 802.11n specific structures and enums
583 */
584typedef enum {
585	HAL_CHAINTYPE_TX	= 1,	/* Tx chain type */
586	HAL_CHAINTYPE_RX	= 2,	/* RX chain type */
587} HAL_CHAIN_TYPE;
588
589typedef struct {
590	u_int	Tries;
591	u_int	Rate;		/* hardware rate code */
592	u_int	RateIndex;	/* rate series table index */
593	u_int	PktDuration;
594	u_int	ChSel;
595	u_int	RateFlags;
596#define	HAL_RATESERIES_RTS_CTS		0x0001	/* use rts/cts w/this series */
597#define	HAL_RATESERIES_2040		0x0002	/* use ext channel for series */
598#define	HAL_RATESERIES_HALFGI		0x0004	/* use half-gi for series */
599#define	HAL_RATESERIES_STBC		0x0008	/* use STBC for series */
600	u_int	tx_power_cap;
601} HAL_11N_RATE_SERIES;
602
603typedef enum {
604	HAL_HT_MACMODE_20	= 0,	/* 20 MHz operation */
605	HAL_HT_MACMODE_2040	= 1,	/* 20/40 MHz operation */
606} HAL_HT_MACMODE;
607
608typedef enum {
609	HAL_HT_PHYMODE_20	= 0,	/* 20 MHz operation */
610	HAL_HT_PHYMODE_2040	= 1,	/* 20/40 MHz operation */
611} HAL_HT_PHYMODE;
612
613typedef enum {
614	HAL_HT_EXTPROTSPACING_20 = 0,	/* 20 MHz spacing */
615	HAL_HT_EXTPROTSPACING_25 = 1,	/* 25 MHz spacing */
616} HAL_HT_EXTPROTSPACING;
617
618
619typedef enum {
620	HAL_RX_CLEAR_CTL_LOW	= 0x1,	/* force control channel to appear busy */
621	HAL_RX_CLEAR_EXT_LOW	= 0x2,	/* force extension channel to appear busy */
622} HAL_HT_RXCLEAR;
623
624/*
625 * Antenna switch control.  By default antenna selection
626 * enables multiple (2) antenna use.  To force use of the
627 * A or B antenna only specify a fixed setting.  Fixing
628 * the antenna will also disable any diversity support.
629 */
630typedef enum {
631	HAL_ANT_VARIABLE = 0,			/* variable by programming */
632	HAL_ANT_FIXED_A	 = 1,			/* fixed antenna A */
633	HAL_ANT_FIXED_B	 = 2,			/* fixed antenna B */
634} HAL_ANT_SETTING;
635
636typedef enum {
637	HAL_M_STA	= 1,			/* infrastructure station */
638	HAL_M_IBSS	= 0,			/* IBSS (adhoc) station */
639	HAL_M_HOSTAP	= 6,			/* Software Access Point */
640	HAL_M_MONITOR	= 8			/* Monitor mode */
641} HAL_OPMODE;
642
643typedef struct {
644	uint8_t		kv_type;		/* one of HAL_CIPHER */
645	uint8_t		kv_apsd;		/* Mask for APSD enabled ACs */
646	uint16_t	kv_len;			/* length in bits */
647	uint8_t		kv_val[16];		/* enough for 128-bit keys */
648	uint8_t		kv_mic[8];		/* TKIP MIC key */
649	uint8_t		kv_txmic[8];		/* TKIP TX MIC key (optional) */
650} HAL_KEYVAL;
651
652typedef enum {
653	HAL_CIPHER_WEP		= 0,
654	HAL_CIPHER_AES_OCB	= 1,
655	HAL_CIPHER_AES_CCM	= 2,
656	HAL_CIPHER_CKIP		= 3,
657	HAL_CIPHER_TKIP		= 4,
658	HAL_CIPHER_CLR		= 5,		/* no encryption */
659
660	HAL_CIPHER_MIC		= 127		/* TKIP-MIC, not a cipher */
661} HAL_CIPHER;
662
663enum {
664	HAL_SLOT_TIME_6	 = 6,			/* NB: for turbo mode */
665	HAL_SLOT_TIME_9	 = 9,
666	HAL_SLOT_TIME_20 = 20,
667};
668
669/*
670 * Per-station beacon timer state.  Note that the specified
671 * beacon interval (given in TU's) can also include flags
672 * to force a TSF reset and to enable the beacon xmit logic.
673 * If bs_cfpmaxduration is non-zero the hardware is setup to
674 * coexist with a PCF-capable AP.
675 */
676typedef struct {
677	uint32_t	bs_nexttbtt;		/* next beacon in TU */
678	uint32_t	bs_nextdtim;		/* next DTIM in TU */
679	uint32_t	bs_intval;		/* beacon interval+flags */
680#define	HAL_BEACON_PERIOD	0x0000ffff	/* beacon interval period */
681#define	HAL_BEACON_ENA		0x00800000	/* beacon xmit enable */
682#define	HAL_BEACON_RESET_TSF	0x01000000	/* clear TSF */
683	uint32_t	bs_dtimperiod;
684	uint16_t	bs_cfpperiod;		/* CFP period in TU */
685	uint16_t	bs_cfpmaxduration;	/* max CFP duration in TU */
686	uint32_t	bs_cfpnext;		/* next CFP in TU */
687	uint16_t	bs_timoffset;		/* byte offset to TIM bitmap */
688	uint16_t	bs_bmissthreshold;	/* beacon miss threshold */
689	uint32_t	bs_sleepduration;	/* max sleep duration */
690} HAL_BEACON_STATE;
691
692/*
693 * Like HAL_BEACON_STATE but for non-station mode setup.
694 * NB: see above flag definitions for bt_intval.
695 */
696typedef struct {
697	uint32_t	bt_intval;		/* beacon interval+flags */
698	uint32_t	bt_nexttbtt;		/* next beacon in TU */
699	uint32_t	bt_nextatim;		/* next ATIM in TU */
700	uint32_t	bt_nextdba;		/* next DBA in 1/8th TU */
701	uint32_t	bt_nextswba;		/* next SWBA in 1/8th TU */
702	uint32_t	bt_flags;		/* timer enables */
703#define HAL_BEACON_TBTT_EN	0x00000001
704#define HAL_BEACON_DBA_EN	0x00000002
705#define HAL_BEACON_SWBA_EN	0x00000004
706} HAL_BEACON_TIMERS;
707
708/*
709 * Per-node statistics maintained by the driver for use in
710 * optimizing signal quality and other operational aspects.
711 */
712typedef struct {
713	uint32_t	ns_avgbrssi;	/* average beacon rssi */
714	uint32_t	ns_avgrssi;	/* average data rssi */
715	uint32_t	ns_avgtxrssi;	/* average tx rssi */
716} HAL_NODE_STATS;
717
718#define	HAL_RSSI_EP_MULTIPLIER	(1<<7)	/* pow2 to optimize out * and / */
719
720struct ath_desc;
721struct ath_tx_status;
722struct ath_rx_status;
723struct ieee80211_channel;
724
725/*
726 * This is a channel survey sample entry.
727 *
728 * The AR5212 ANI routines fill these samples. The ANI code then uses it
729 * when calculating listen time; it is also exported via a diagnostic
730 * API.
731 */
732typedef struct {
733	uint32_t        seq_num;
734	uint32_t        tx_busy;
735	uint32_t        rx_busy;
736	uint32_t        chan_busy;
737	uint32_t        ext_chan_busy;
738	uint32_t        cycle_count;
739	/* XXX TODO */
740	uint32_t        ofdm_phyerr_count;
741	uint32_t        cck_phyerr_count;
742} HAL_SURVEY_SAMPLE;
743
744/*
745 * This provides 3.2 seconds of sample space given an
746 * ANI time of 1/10th of a second. This may not be enough!
747 */
748#define	CHANNEL_SURVEY_SAMPLE_COUNT	32
749
750typedef struct {
751	HAL_SURVEY_SAMPLE samples[CHANNEL_SURVEY_SAMPLE_COUNT];
752	uint32_t cur_sample;	/* current sample in sequence */
753	uint32_t cur_seq;	/* current sequence number */
754} HAL_CHANNEL_SURVEY;
755
756/*
757 * ANI commands.
758 *
759 * These are used both internally and externally via the diagnostic
760 * API.
761 *
762 * Note that this is NOT the ANI commands being used via the INTMIT
763 * capability - that has a different mapping for some reason.
764 */
765typedef enum {
766	HAL_ANI_PRESENT = 0,			/* is ANI support present */
767	HAL_ANI_NOISE_IMMUNITY_LEVEL = 1,	/* set level */
768	HAL_ANI_OFDM_WEAK_SIGNAL_DETECTION = 2,	/* enable/disable */
769	HAL_ANI_CCK_WEAK_SIGNAL_THR = 3,	/* enable/disable */
770	HAL_ANI_FIRSTEP_LEVEL = 4,		/* set level */
771	HAL_ANI_SPUR_IMMUNITY_LEVEL = 5,	/* set level */
772	HAL_ANI_MODE = 6,			/* 0 => manual, 1 => auto (XXX do not change) */
773	HAL_ANI_PHYERR_RESET = 7,		/* reset phy error stats */
774	HAL_ANI_MRC_CCK = 8,
775} HAL_ANI_CMD;
776
777/*
778 * This is the layout of the ANI INTMIT capability.
779 *
780 * Notice that the command values differ to HAL_ANI_CMD.
781 */
782typedef enum {
783	HAL_CAP_INTMIT_PRESENT = 0,
784	HAL_CAP_INTMIT_ENABLE = 1,
785	HAL_CAP_INTMIT_NOISE_IMMUNITY_LEVEL = 2,
786	HAL_CAP_INTMIT_OFDM_WEAK_SIGNAL_LEVEL = 3,
787	HAL_CAP_INTMIT_CCK_WEAK_SIGNAL_THR = 4,
788	HAL_CAP_INTMIT_FIRSTEP_LEVEL = 5,
789	HAL_CAP_INTMIT_SPUR_IMMUNITY_LEVEL = 6
790} HAL_CAP_INTMIT_CMD;
791
792/* DFS defines */
793typedef struct {
794	int32_t		pe_firpwr;	/* FIR pwr out threshold */
795	int32_t		pe_rrssi;	/* Radar rssi thresh */
796	int32_t		pe_height;	/* Pulse height thresh */
797	int32_t		pe_prssi;	/* Pulse rssi thresh */
798	int32_t		pe_inband;	/* Inband thresh */
799
800	/* The following params are only for AR5413 and later */
801	u_int32_t	pe_relpwr;	/* Relative power threshold in 0.5dB steps */
802	u_int32_t	pe_relstep;	/* Pulse Relative step threshold in 0.5dB steps */
803	u_int32_t	pe_maxlen;	/* Max length of radar sign in 0.8us units */
804	int32_t		pe_usefir128;	/* Use the average in-band power measured over 128 cycles */
805	int32_t		pe_blockradar;	/*
806					 * Enable to block radar check if pkt detect is done via OFDM
807					 * weak signal detect or pkt is detected immediately after tx
808					 * to rx transition
809					 */
810	int32_t		pe_enmaxrssi;	/*
811					 * Enable to use the max rssi instead of the last rssi during
812					 * fine gain changes for radar detection
813					 */
814	int32_t		pe_extchannel;	/* Enable DFS on ext channel */
815	int32_t		pe_enabled;	/* Whether radar detection is enabled */
816	int32_t		pe_enrelpwr;
817	int32_t		pe_en_relstep_check;
818} HAL_PHYERR_PARAM;
819
820#define	HAL_PHYERR_PARAM_NOVAL	65535
821
822/*
823 * DFS operating mode flags.
824 */
825typedef enum {
826	HAL_DFS_UNINIT_DOMAIN	= 0,	/* Uninitialized dfs domain */
827	HAL_DFS_FCC_DOMAIN	= 1,	/* FCC3 dfs domain */
828	HAL_DFS_ETSI_DOMAIN	= 2,	/* ETSI dfs domain */
829	HAL_DFS_MKK4_DOMAIN	= 3,	/* Japan dfs domain */
830} HAL_DFS_DOMAIN;
831
832/*
833 * Flag for setting QUIET period
834 */
835typedef enum {
836	HAL_QUIET_DISABLE		= 0x0,
837	HAL_QUIET_ENABLE		= 0x1,
838	HAL_QUIET_ADD_CURRENT_TSF	= 0x2,	/* add current TSF to next_start offset */
839	HAL_QUIET_ADD_SWBA_RESP_TIME	= 0x4,	/* add beacon response time to next_start offset */
840} HAL_QUIET_FLAG;
841
842#define	HAL_DFS_EVENT_PRICH		0x0000001
843#define	HAL_DFS_EVENT_EXTCH		0x0000002
844#define	HAL_DFS_EVENT_EXTEARLY		0x0000004
845#define	HAL_DFS_EVENT_ISDC		0x0000008
846
847struct hal_dfs_event {
848	uint64_t	re_full_ts;	/* 64-bit full timestamp from interrupt time */
849	uint32_t	re_ts;		/* Original 15 bit recv timestamp */
850	uint8_t		re_rssi;	/* rssi of radar event */
851	uint8_t		re_dur;		/* duration of radar pulse */
852	uint32_t	re_flags;	/* Flags (see above) */
853};
854typedef struct hal_dfs_event HAL_DFS_EVENT;
855
856/*
857 * BT Co-existence definitions
858 */
859typedef enum {
860	HAL_BT_MODULE_CSR_BC4	= 0,	/* CSR BlueCore v4 */
861	HAL_BT_MODULE_JANUS	= 1,	/* Kite + Valkyrie combo */
862	HAL_BT_MODULE_HELIUS	= 2,	/* Kiwi + Valkyrie combo */
863	HAL_MAX_BT_MODULES
864} HAL_BT_MODULE;
865
866typedef struct {
867	HAL_BT_MODULE	bt_module;
868	u_int8_t	bt_coex_config;
869	u_int8_t	bt_gpio_bt_active;
870	u_int8_t	bt_gpio_bt_priority;
871	u_int8_t	bt_gpio_wlan_active;
872	u_int8_t	bt_active_polarity;
873	HAL_BOOL	bt_single_ant;
874	u_int8_t	bt_dutyCycle;
875	u_int8_t	bt_isolation;
876	u_int8_t	bt_period;
877} HAL_BT_COEX_INFO;
878
879typedef enum {
880	HAL_BT_COEX_MODE_LEGACY		= 0,	/* legacy rx_clear mode */
881	HAL_BT_COEX_MODE_UNSLOTTED	= 1,	/* untimed/unslotted mode */
882	HAL_BT_COEX_MODE_SLOTTED	= 2,	/* slotted mode */
883	HAL_BT_COEX_MODE_DISALBED	= 3,	/* coexistence disabled */
884} HAL_BT_COEX_MODE;
885
886typedef enum {
887	HAL_BT_COEX_CFG_NONE,		/* No bt coex enabled */
888	HAL_BT_COEX_CFG_2WIRE_2CH,	/* 2-wire with 2 chains */
889	HAL_BT_COEX_CFG_2WIRE_CH1,	/* 2-wire with ch1 */
890	HAL_BT_COEX_CFG_2WIRE_CH0,	/* 2-wire with ch0 */
891	HAL_BT_COEX_CFG_3WIRE,		/* 3-wire */
892	HAL_BT_COEX_CFG_MCI		/* MCI */
893} HAL_BT_COEX_CFG;
894
895typedef enum {
896	HAL_BT_COEX_SET_ACK_PWR		= 0,	/* Change ACK power setting */
897	HAL_BT_COEX_LOWER_TX_PWR,		/* Change transmit power */
898	HAL_BT_COEX_ANTENNA_DIVERSITY,	/* Enable RX diversity for Kite */
899} HAL_BT_COEX_SET_PARAMETER;
900
901#define	HAL_BT_COEX_FLAG_LOW_ACK_PWR	0x00000001
902#define	HAL_BT_COEX_FLAG_LOWER_TX_PWR	0x00000002
903/* Check Rx Diversity is allowed */
904#define	HAL_BT_COEX_FLAG_ANT_DIV_ALLOW	0x00000004
905/* Check Diversity is on or off */
906#define	HAL_BT_COEX_FLAG_ANT_DIV_ENABLE	0x00000008
907
908#define	HAL_BT_COEX_ANTDIV_CONTROL1_ENABLE	0x0b
909/* main: LNA1, alt: LNA2 */
910#define	HAL_BT_COEX_ANTDIV_CONTROL2_ENABLE	0x09
911#define	HAL_BT_COEX_ANTDIV_CONTROL1_FIXED_A	0x04
912#define	HAL_BT_COEX_ANTDIV_CONTROL2_FIXED_A	0x09
913#define	HAL_BT_COEX_ANTDIV_CONTROL1_FIXED_B	0x02
914#define	HAL_BT_COEX_ANTDIV_CONTROL2_FIXED_B	0x06
915
916#define	HAL_BT_COEX_ISOLATION_FOR_NO_COEX	30
917
918#define	HAL_BT_COEX_ANT_DIV_SWITCH_COM	0x66666666
919
920#define	HAL_BT_COEX_HELIUS_CHAINMASK	0x02
921
922#define	HAL_BT_COEX_LOW_ACK_POWER	0x0
923#define	HAL_BT_COEX_HIGH_ACK_POWER	0x3f3f3f
924
925typedef enum {
926	HAL_BT_COEX_NO_STOMP = 0,
927	HAL_BT_COEX_STOMP_ALL,
928	HAL_BT_COEX_STOMP_LOW,
929	HAL_BT_COEX_STOMP_NONE,
930	HAL_BT_COEX_STOMP_ALL_FORCE,
931	HAL_BT_COEX_STOMP_LOW_FORCE,
932} HAL_BT_COEX_STOMP_TYPE;
933
934typedef struct {
935	/* extend rx_clear after tx/rx to protect the burst (in usec). */
936	u_int8_t	bt_time_extend;
937
938	/*
939	 * extend rx_clear as long as txsm is
940	 * transmitting or waiting for ack.
941	 */
942	HAL_BOOL	bt_txstate_extend;
943
944	/*
945	 * extend rx_clear so that when tx_frame
946	 * is asserted, rx_clear will drop.
947	 */
948	HAL_BOOL	bt_txframe_extend;
949
950	/*
951	 * coexistence mode
952	 */
953	HAL_BT_COEX_MODE	bt_mode;
954
955	/*
956	 * treat BT high priority traffic as
957	 * a quiet collision
958	 */
959	HAL_BOOL	bt_quiet_collision;
960
961	/*
962	 * invert rx_clear as WLAN_ACTIVE
963	 */
964	HAL_BOOL	bt_rxclear_polarity;
965
966	/*
967	 * slotted mode only. indicate the time in usec
968	 * from the rising edge of BT_ACTIVE to the time
969	 * BT_PRIORITY can be sampled to indicate priority.
970	 */
971	u_int8_t	bt_priority_time;
972
973	/*
974	 * slotted mode only. indicate the time in usec
975	 * from the rising edge of BT_ACTIVE to the time
976	 * BT_PRIORITY can be sampled to indicate tx/rx and
977	 * BT_FREQ is sampled.
978	 */
979	u_int8_t	bt_first_slot_time;
980
981	/*
982	 * slotted mode only. rx_clear and bt_ant decision
983	 * will be held the entire time that BT_ACTIVE is asserted,
984	 * otherwise the decision is made before every slot boundry.
985	 */
986	HAL_BOOL	bt_hold_rxclear;
987} HAL_BT_COEX_CONFIG;
988
989typedef struct
990{
991	int ah_debug;			/* only used if AH_DEBUG is defined */
992	int ah_ar5416_biasadj;		/* enable AR2133 radio specific bias fiddling */
993
994	/* NB: these are deprecated; they exist for now for compatibility */
995	int ah_dma_beacon_response_time;/* in TU's */
996	int ah_sw_beacon_response_time;	/* in TU's */
997	int ah_additional_swba_backoff;	/* in TU's */
998	int ah_force_full_reset;	/* force full chip reset rather then warm reset */
999	int ah_serialise_reg_war;	/* force serialisation of register IO */
1000} HAL_OPS_CONFIG;
1001
1002/*
1003 * Hardware Access Layer (HAL) API.
1004 *
1005 * Clients of the HAL call ath_hal_attach to obtain a reference to an
1006 * ath_hal structure for use with the device.  Hardware-related operations
1007 * that follow must call back into the HAL through interface, supplying
1008 * the reference as the first parameter.  Note that before using the
1009 * reference returned by ath_hal_attach the caller should verify the
1010 * ABI version number.
1011 */
1012struct ath_hal {
1013	uint32_t	ah_magic;	/* consistency check magic number */
1014	uint16_t	ah_devid;	/* PCI device ID */
1015	uint16_t	ah_subvendorid;	/* PCI subvendor ID */
1016	HAL_SOFTC	ah_sc;		/* back pointer to driver/os state */
1017	HAL_BUS_TAG	ah_st;		/* params for register r+w */
1018	HAL_BUS_HANDLE	ah_sh;
1019	HAL_CTRY_CODE	ah_countryCode;
1020
1021	uint32_t	ah_macVersion;	/* MAC version id */
1022	uint16_t	ah_macRev;	/* MAC revision */
1023	uint16_t	ah_phyRev;	/* PHY revision */
1024	/* NB: when only one radio is present the rev is in 5Ghz */
1025	uint16_t	ah_analog5GhzRev;/* 5GHz radio revision */
1026	uint16_t	ah_analog2GhzRev;/* 2GHz radio revision */
1027
1028	uint16_t	*ah_eepromdata;	/* eeprom buffer, if needed */
1029
1030	uint32_t	ah_intrstate[8];	/* last int state */
1031	uint32_t	ah_syncstate;		/* last sync intr state */
1032
1033	HAL_OPS_CONFIG ah_config;
1034	const HAL_RATE_TABLE *__ahdecl(*ah_getRateTable)(struct ath_hal *,
1035				u_int mode);
1036	void	  __ahdecl(*ah_detach)(struct ath_hal*);
1037
1038	/* Reset functions */
1039	HAL_BOOL  __ahdecl(*ah_reset)(struct ath_hal *, HAL_OPMODE,
1040				struct ieee80211_channel *,
1041				HAL_BOOL bChannelChange, HAL_STATUS *status);
1042	HAL_BOOL  __ahdecl(*ah_phyDisable)(struct ath_hal *);
1043	HAL_BOOL  __ahdecl(*ah_disable)(struct ath_hal *);
1044	void	  __ahdecl(*ah_configPCIE)(struct ath_hal *, HAL_BOOL restore,
1045				HAL_BOOL power_off);
1046	void	  __ahdecl(*ah_disablePCIE)(struct ath_hal *);
1047	void	  __ahdecl(*ah_setPCUConfig)(struct ath_hal *);
1048	HAL_BOOL  __ahdecl(*ah_perCalibration)(struct ath_hal*,
1049			struct ieee80211_channel *, HAL_BOOL *);
1050	HAL_BOOL  __ahdecl(*ah_perCalibrationN)(struct ath_hal *,
1051			struct ieee80211_channel *, u_int chainMask,
1052			HAL_BOOL longCal, HAL_BOOL *isCalDone);
1053	HAL_BOOL  __ahdecl(*ah_resetCalValid)(struct ath_hal *,
1054			const struct ieee80211_channel *);
1055	HAL_BOOL  __ahdecl(*ah_setTxPower)(struct ath_hal *,
1056	    		const struct ieee80211_channel *, uint16_t *);
1057	HAL_BOOL  __ahdecl(*ah_setTxPowerLimit)(struct ath_hal *, uint32_t);
1058	HAL_BOOL  __ahdecl(*ah_setBoardValues)(struct ath_hal *,
1059	    		const struct ieee80211_channel *);
1060
1061	/* Transmit functions */
1062	HAL_BOOL  __ahdecl(*ah_updateTxTrigLevel)(struct ath_hal*,
1063				HAL_BOOL incTrigLevel);
1064	int	  __ahdecl(*ah_setupTxQueue)(struct ath_hal *, HAL_TX_QUEUE,
1065				const HAL_TXQ_INFO *qInfo);
1066	HAL_BOOL  __ahdecl(*ah_setTxQueueProps)(struct ath_hal *, int q,
1067				const HAL_TXQ_INFO *qInfo);
1068	HAL_BOOL  __ahdecl(*ah_getTxQueueProps)(struct ath_hal *, int q,
1069				HAL_TXQ_INFO *qInfo);
1070	HAL_BOOL  __ahdecl(*ah_releaseTxQueue)(struct ath_hal *ah, u_int q);
1071	HAL_BOOL  __ahdecl(*ah_resetTxQueue)(struct ath_hal *ah, u_int q);
1072	uint32_t __ahdecl(*ah_getTxDP)(struct ath_hal*, u_int);
1073	HAL_BOOL  __ahdecl(*ah_setTxDP)(struct ath_hal*, u_int, uint32_t txdp);
1074	uint32_t __ahdecl(*ah_numTxPending)(struct ath_hal *, u_int q);
1075	HAL_BOOL  __ahdecl(*ah_startTxDma)(struct ath_hal*, u_int);
1076	HAL_BOOL  __ahdecl(*ah_stopTxDma)(struct ath_hal*, u_int);
1077	HAL_BOOL  __ahdecl(*ah_setupTxDesc)(struct ath_hal *, struct ath_desc *,
1078				u_int pktLen, u_int hdrLen,
1079				HAL_PKT_TYPE type, u_int txPower,
1080				u_int txRate0, u_int txTries0,
1081				u_int keyIx, u_int antMode, u_int flags,
1082				u_int rtsctsRate, u_int rtsctsDuration,
1083				u_int compicvLen, u_int compivLen,
1084				u_int comp);
1085	HAL_BOOL  __ahdecl(*ah_setupXTxDesc)(struct ath_hal *, struct ath_desc*,
1086				u_int txRate1, u_int txTries1,
1087				u_int txRate2, u_int txTries2,
1088				u_int txRate3, u_int txTries3);
1089	HAL_BOOL  __ahdecl(*ah_fillTxDesc)(struct ath_hal *, struct ath_desc *,
1090				HAL_DMA_ADDR *bufAddrList, uint32_t *segLenList,
1091				u_int descId, u_int qcuId, HAL_BOOL firstSeg,
1092				HAL_BOOL lastSeg, const struct ath_desc *);
1093	HAL_STATUS __ahdecl(*ah_procTxDesc)(struct ath_hal *,
1094				struct ath_desc *, struct ath_tx_status *);
1095	void	   __ahdecl(*ah_getTxIntrQueue)(struct ath_hal *, uint32_t *);
1096	void	   __ahdecl(*ah_reqTxIntrDesc)(struct ath_hal *, struct ath_desc*);
1097	HAL_BOOL	__ahdecl(*ah_getTxCompletionRates)(struct ath_hal *,
1098				const struct ath_desc *ds, int *rates, int *tries);
1099	void	  __ahdecl(*ah_setTxDescLink)(struct ath_hal *ah, void *ds,
1100				uint32_t link);
1101	void	  __ahdecl(*ah_getTxDescLink)(struct ath_hal *ah, void *ds,
1102				uint32_t *link);
1103	void	  __ahdecl(*ah_getTxDescLinkPtr)(struct ath_hal *ah, void *ds,
1104				uint32_t **linkptr);
1105	void	  __ahdecl(*ah_setupTxStatusRing)(struct ath_hal *,
1106				void *ts_start, uint32_t ts_paddr_start,
1107				uint16_t size);
1108
1109	/* Receive Functions */
1110	uint32_t __ahdecl(*ah_getRxDP)(struct ath_hal*, HAL_RX_QUEUE);
1111	void	  __ahdecl(*ah_setRxDP)(struct ath_hal*, uint32_t rxdp, HAL_RX_QUEUE);
1112	void	  __ahdecl(*ah_enableReceive)(struct ath_hal*);
1113	HAL_BOOL  __ahdecl(*ah_stopDmaReceive)(struct ath_hal*);
1114	void	  __ahdecl(*ah_startPcuReceive)(struct ath_hal*);
1115	void	  __ahdecl(*ah_stopPcuReceive)(struct ath_hal*);
1116	void	  __ahdecl(*ah_setMulticastFilter)(struct ath_hal*,
1117				uint32_t filter0, uint32_t filter1);
1118	HAL_BOOL  __ahdecl(*ah_setMulticastFilterIndex)(struct ath_hal*,
1119				uint32_t index);
1120	HAL_BOOL  __ahdecl(*ah_clrMulticastFilterIndex)(struct ath_hal*,
1121				uint32_t index);
1122	uint32_t __ahdecl(*ah_getRxFilter)(struct ath_hal*);
1123	void	  __ahdecl(*ah_setRxFilter)(struct ath_hal*, uint32_t);
1124	HAL_BOOL  __ahdecl(*ah_setupRxDesc)(struct ath_hal *, struct ath_desc *,
1125				uint32_t size, u_int flags);
1126	HAL_STATUS __ahdecl(*ah_procRxDesc)(struct ath_hal *,
1127				struct ath_desc *, uint32_t phyAddr,
1128				struct ath_desc *next, uint64_t tsf,
1129				struct ath_rx_status *);
1130	void	  __ahdecl(*ah_rxMonitor)(struct ath_hal *,
1131				const HAL_NODE_STATS *,
1132				const struct ieee80211_channel *);
1133	void      __ahdecl(*ah_aniPoll)(struct ath_hal *,
1134				const struct ieee80211_channel *);
1135	void	  __ahdecl(*ah_procMibEvent)(struct ath_hal *,
1136				const HAL_NODE_STATS *);
1137	void	  __ahdecl(*ah_rxAntCombDiversity)(struct ath_hal *,
1138				struct ath_rx_status *,
1139				unsigned long, int);
1140
1141	/* Misc Functions */
1142	HAL_STATUS __ahdecl(*ah_getCapability)(struct ath_hal *,
1143				HAL_CAPABILITY_TYPE, uint32_t capability,
1144				uint32_t *result);
1145	HAL_BOOL   __ahdecl(*ah_setCapability)(struct ath_hal *,
1146				HAL_CAPABILITY_TYPE, uint32_t capability,
1147				uint32_t setting, HAL_STATUS *);
1148	HAL_BOOL   __ahdecl(*ah_getDiagState)(struct ath_hal *, int request,
1149				const void *args, uint32_t argsize,
1150				void **result, uint32_t *resultsize);
1151	void	  __ahdecl(*ah_getMacAddress)(struct ath_hal *, uint8_t *);
1152	HAL_BOOL  __ahdecl(*ah_setMacAddress)(struct ath_hal *, const uint8_t*);
1153	void	  __ahdecl(*ah_getBssIdMask)(struct ath_hal *, uint8_t *);
1154	HAL_BOOL  __ahdecl(*ah_setBssIdMask)(struct ath_hal *, const uint8_t*);
1155	HAL_BOOL  __ahdecl(*ah_setRegulatoryDomain)(struct ath_hal*,
1156				uint16_t, HAL_STATUS *);
1157	void	  __ahdecl(*ah_setLedState)(struct ath_hal*, HAL_LED_STATE);
1158	void	  __ahdecl(*ah_writeAssocid)(struct ath_hal*,
1159				const uint8_t *bssid, uint16_t assocId);
1160	HAL_BOOL  __ahdecl(*ah_gpioCfgOutput)(struct ath_hal *,
1161				uint32_t gpio, HAL_GPIO_MUX_TYPE);
1162	HAL_BOOL  __ahdecl(*ah_gpioCfgInput)(struct ath_hal *, uint32_t gpio);
1163	uint32_t __ahdecl(*ah_gpioGet)(struct ath_hal *, uint32_t gpio);
1164	HAL_BOOL  __ahdecl(*ah_gpioSet)(struct ath_hal *,
1165				uint32_t gpio, uint32_t val);
1166	void	  __ahdecl(*ah_gpioSetIntr)(struct ath_hal*, u_int, uint32_t);
1167	uint32_t __ahdecl(*ah_getTsf32)(struct ath_hal*);
1168	uint64_t __ahdecl(*ah_getTsf64)(struct ath_hal*);
1169	void	  __ahdecl(*ah_resetTsf)(struct ath_hal*);
1170	HAL_BOOL  __ahdecl(*ah_detectCardPresent)(struct ath_hal*);
1171	void	  __ahdecl(*ah_updateMibCounters)(struct ath_hal*,
1172				HAL_MIB_STATS*);
1173	HAL_RFGAIN __ahdecl(*ah_getRfGain)(struct ath_hal*);
1174	u_int	  __ahdecl(*ah_getDefAntenna)(struct ath_hal*);
1175	void	  __ahdecl(*ah_setDefAntenna)(struct ath_hal*, u_int);
1176	HAL_ANT_SETTING	 __ahdecl(*ah_getAntennaSwitch)(struct ath_hal*);
1177	HAL_BOOL  __ahdecl(*ah_setAntennaSwitch)(struct ath_hal*,
1178				HAL_ANT_SETTING);
1179	HAL_BOOL  __ahdecl(*ah_setSifsTime)(struct ath_hal*, u_int);
1180	u_int	  __ahdecl(*ah_getSifsTime)(struct ath_hal*);
1181	HAL_BOOL  __ahdecl(*ah_setSlotTime)(struct ath_hal*, u_int);
1182	u_int	  __ahdecl(*ah_getSlotTime)(struct ath_hal*);
1183	HAL_BOOL  __ahdecl(*ah_setAckTimeout)(struct ath_hal*, u_int);
1184	u_int	  __ahdecl(*ah_getAckTimeout)(struct ath_hal*);
1185	HAL_BOOL  __ahdecl(*ah_setAckCTSRate)(struct ath_hal*, u_int);
1186	u_int	  __ahdecl(*ah_getAckCTSRate)(struct ath_hal*);
1187	HAL_BOOL  __ahdecl(*ah_setCTSTimeout)(struct ath_hal*, u_int);
1188	u_int	  __ahdecl(*ah_getCTSTimeout)(struct ath_hal*);
1189	HAL_BOOL  __ahdecl(*ah_setDecompMask)(struct ath_hal*, uint16_t, int);
1190	void	  __ahdecl(*ah_setCoverageClass)(struct ath_hal*, uint8_t, int);
1191	HAL_STATUS	__ahdecl(*ah_setQuiet)(struct ath_hal *ah, uint32_t period,
1192				uint32_t duration, uint32_t nextStart,
1193				HAL_QUIET_FLAG flag);
1194
1195	/* DFS functions */
1196	void	  __ahdecl(*ah_enableDfs)(struct ath_hal *ah,
1197				HAL_PHYERR_PARAM *pe);
1198	void	  __ahdecl(*ah_getDfsThresh)(struct ath_hal *ah,
1199				HAL_PHYERR_PARAM *pe);
1200	HAL_BOOL  __ahdecl(*ah_procRadarEvent)(struct ath_hal *ah,
1201				struct ath_rx_status *rxs, uint64_t fulltsf,
1202				const char *buf, HAL_DFS_EVENT *event);
1203	HAL_BOOL  __ahdecl(*ah_isFastClockEnabled)(struct ath_hal *ah);
1204
1205	/* Key Cache Functions */
1206	uint32_t __ahdecl(*ah_getKeyCacheSize)(struct ath_hal*);
1207	HAL_BOOL  __ahdecl(*ah_resetKeyCacheEntry)(struct ath_hal*, uint16_t);
1208	HAL_BOOL  __ahdecl(*ah_isKeyCacheEntryValid)(struct ath_hal *,
1209				uint16_t);
1210	HAL_BOOL  __ahdecl(*ah_setKeyCacheEntry)(struct ath_hal*,
1211				uint16_t, const HAL_KEYVAL *,
1212				const uint8_t *, int);
1213	HAL_BOOL  __ahdecl(*ah_setKeyCacheEntryMac)(struct ath_hal*,
1214				uint16_t, const uint8_t *);
1215
1216	/* Power Management Functions */
1217	HAL_BOOL  __ahdecl(*ah_setPowerMode)(struct ath_hal*,
1218				HAL_POWER_MODE mode, int setChip);
1219	HAL_POWER_MODE __ahdecl(*ah_getPowerMode)(struct ath_hal*);
1220	int16_t   __ahdecl(*ah_getChanNoise)(struct ath_hal *,
1221				const struct ieee80211_channel *);
1222
1223	/* Beacon Management Functions */
1224	void	  __ahdecl(*ah_setBeaconTimers)(struct ath_hal*,
1225				const HAL_BEACON_TIMERS *);
1226	/* NB: deprecated, use ah_setBeaconTimers instead */
1227	void	  __ahdecl(*ah_beaconInit)(struct ath_hal *,
1228				uint32_t nexttbtt, uint32_t intval);
1229	void	  __ahdecl(*ah_setStationBeaconTimers)(struct ath_hal*,
1230				const HAL_BEACON_STATE *);
1231	void	  __ahdecl(*ah_resetStationBeaconTimers)(struct ath_hal*);
1232	uint64_t  __ahdecl(*ah_getNextTBTT)(struct ath_hal *);
1233
1234	/* 802.11n Functions */
1235	HAL_BOOL  __ahdecl(*ah_chainTxDesc)(struct ath_hal *,
1236				struct ath_desc *,
1237				HAL_DMA_ADDR *bufAddrList,
1238				uint32_t *segLenList,
1239				u_int, u_int, HAL_PKT_TYPE,
1240				u_int, HAL_CIPHER, uint8_t, HAL_BOOL,
1241				HAL_BOOL, HAL_BOOL);
1242	HAL_BOOL  __ahdecl(*ah_setupFirstTxDesc)(struct ath_hal *,
1243				struct ath_desc *, u_int, u_int, u_int,
1244				u_int, u_int, u_int, u_int, u_int);
1245	HAL_BOOL  __ahdecl(*ah_setupLastTxDesc)(struct ath_hal *,
1246				struct ath_desc *, const struct ath_desc *);
1247	void	  __ahdecl(*ah_set11nRateScenario)(struct ath_hal *,
1248	    			struct ath_desc *, u_int, u_int,
1249				HAL_11N_RATE_SERIES [], u_int, u_int);
1250	void	  __ahdecl(*ah_set11nAggrFirst)(struct ath_hal *,
1251				struct ath_desc *, u_int);
1252	void	  __ahdecl(*ah_set11nAggrMiddle)(struct ath_hal *,
1253	    			struct ath_desc *, u_int);
1254	void	  __ahdecl(*ah_set11nAggrLast)(struct ath_hal *,
1255				struct ath_desc *);
1256	void	  __ahdecl(*ah_clr11nAggr)(struct ath_hal *,
1257	    			struct ath_desc *);
1258	void	  __ahdecl(*ah_set11nBurstDuration)(struct ath_hal *,
1259	    			struct ath_desc *, u_int);
1260	HAL_BOOL  __ahdecl(*ah_getMibCycleCounts) (struct ath_hal *,
1261				HAL_SURVEY_SAMPLE *);
1262
1263	uint32_t  __ahdecl(*ah_get11nExtBusy)(struct ath_hal *);
1264	void      __ahdecl(*ah_set11nMac2040)(struct ath_hal *,
1265				HAL_HT_MACMODE);
1266	HAL_HT_RXCLEAR __ahdecl(*ah_get11nRxClear)(struct ath_hal *ah);
1267	void	  __ahdecl(*ah_set11nRxClear)(struct ath_hal *,
1268	    			HAL_HT_RXCLEAR);
1269
1270	/* Interrupt functions */
1271	HAL_BOOL  __ahdecl(*ah_isInterruptPending)(struct ath_hal*);
1272	HAL_BOOL  __ahdecl(*ah_getPendingInterrupts)(struct ath_hal*, HAL_INT*);
1273	HAL_INT	  __ahdecl(*ah_getInterrupts)(struct ath_hal*);
1274	HAL_INT	  __ahdecl(*ah_setInterrupts)(struct ath_hal*, HAL_INT);
1275};
1276
1277/*
1278 * Check the PCI vendor ID and device ID against Atheros' values
1279 * and return a printable description for any Atheros hardware.
1280 * AH_NULL is returned if the ID's do not describe Atheros hardware.
1281 */
1282extern	const char *__ahdecl ath_hal_probe(uint16_t vendorid, uint16_t devid);
1283
1284/*
1285 * Attach the HAL for use with the specified device.  The device is
1286 * defined by the PCI device ID.  The caller provides an opaque pointer
1287 * to an upper-layer data structure (HAL_SOFTC) that is stored in the
1288 * HAL state block for later use.  Hardware register accesses are done
1289 * using the specified bus tag and handle.  On successful return a
1290 * reference to a state block is returned that must be supplied in all
1291 * subsequent HAL calls.  Storage associated with this reference is
1292 * dynamically allocated and must be freed by calling the ah_detach
1293 * method when the client is done.  If the attach operation fails a
1294 * null (AH_NULL) reference will be returned and a status code will
1295 * be returned if the status parameter is non-zero.
1296 */
1297extern	struct ath_hal * __ahdecl ath_hal_attach(uint16_t devid, HAL_SOFTC,
1298		HAL_BUS_TAG, HAL_BUS_HANDLE, uint16_t *eepromdata, HAL_STATUS* status);
1299
1300extern	const char *ath_hal_mac_name(struct ath_hal *);
1301extern	const char *ath_hal_rf_name(struct ath_hal *);
1302
1303/*
1304 * Regulatory interfaces.  Drivers should use ath_hal_init_channels to
1305 * request a set of channels for a particular country code and/or
1306 * regulatory domain.  If CTRY_DEFAULT and SKU_NONE are specified then
1307 * this list is constructed according to the contents of the EEPROM.
1308 * ath_hal_getchannels acts similarly but does not alter the operating
1309 * state; this can be used to collect information for a particular
1310 * regulatory configuration.  Finally ath_hal_set_channels installs a
1311 * channel list constructed outside the driver.  The HAL will adopt the
1312 * channel list and setup internal state according to the specified
1313 * regulatory configuration (e.g. conformance test limits).
1314 *
1315 * For all interfaces the channel list is returned in the supplied array.
1316 * maxchans defines the maximum size of this array.  nchans contains the
1317 * actual number of channels returned.  If a problem occurred then a
1318 * status code != HAL_OK is returned.
1319 */
1320struct ieee80211_channel;
1321
1322/*
1323 * Return a list of channels according to the specified regulatory.
1324 */
1325extern	HAL_STATUS __ahdecl ath_hal_getchannels(struct ath_hal *,
1326    struct ieee80211_channel *chans, u_int maxchans, int *nchans,
1327    u_int modeSelect, HAL_CTRY_CODE cc, HAL_REG_DOMAIN regDmn,
1328    HAL_BOOL enableExtendedChannels);
1329
1330/*
1331 * Return a list of channels and install it as the current operating
1332 * regulatory list.
1333 */
1334extern	HAL_STATUS __ahdecl ath_hal_init_channels(struct ath_hal *,
1335    struct ieee80211_channel *chans, u_int maxchans, int *nchans,
1336    u_int modeSelect, HAL_CTRY_CODE cc, HAL_REG_DOMAIN rd,
1337    HAL_BOOL enableExtendedChannels);
1338
1339/*
1340 * Install the list of channels as the current operating regulatory
1341 * and setup related state according to the country code and sku.
1342 */
1343extern	HAL_STATUS __ahdecl ath_hal_set_channels(struct ath_hal *,
1344    struct ieee80211_channel *chans, int nchans,
1345    HAL_CTRY_CODE cc, HAL_REG_DOMAIN regDmn);
1346
1347/*
1348 * Fetch the ctl/ext noise floor values reported by a MIMO
1349 * radio. Returns 1 for valid results, 0 for invalid channel.
1350 */
1351extern int __ahdecl ath_hal_get_mimo_chan_noise(struct ath_hal *ah,
1352    const struct ieee80211_channel *chan, int16_t *nf_ctl,
1353    int16_t *nf_ext);
1354
1355/*
1356 * Calibrate noise floor data following a channel scan or similar.
1357 * This must be called prior retrieving noise floor data.
1358 */
1359extern	void __ahdecl ath_hal_process_noisefloor(struct ath_hal *ah);
1360
1361/*
1362 * Return bit mask of wireless modes supported by the hardware.
1363 */
1364extern	u_int __ahdecl ath_hal_getwirelessmodes(struct ath_hal*);
1365
1366/*
1367 * Calculate the packet TX time for a legacy or 11n frame
1368 */
1369extern uint32_t __ahdecl ath_hal_pkt_txtime(struct ath_hal *ah,
1370    const HAL_RATE_TABLE *rates, uint32_t frameLen,
1371    uint16_t rateix, HAL_BOOL isht40, HAL_BOOL shortPreamble);
1372
1373/*
1374 * Calculate the duration of an 11n frame.
1375 */
1376extern uint32_t __ahdecl ath_computedur_ht(uint32_t frameLen, uint16_t rate,
1377    int streams, HAL_BOOL isht40, HAL_BOOL isShortGI);
1378
1379/*
1380 * Calculate the transmit duration of a legacy frame.
1381 */
1382extern uint16_t __ahdecl ath_hal_computetxtime(struct ath_hal *,
1383		const HAL_RATE_TABLE *rates, uint32_t frameLen,
1384		uint16_t rateix, HAL_BOOL shortPreamble);
1385
1386/*
1387 * Adjust the TSF.
1388 */
1389extern void __ahdecl ath_hal_adjusttsf(struct ath_hal *ah, int32_t tsfdelta);
1390
1391/*
1392 * Enable or disable CCA.
1393 */
1394void __ahdecl ath_hal_setcca(struct ath_hal *ah, int ena);
1395
1396/*
1397 * Get CCA setting.
1398 */
1399int __ahdecl ath_hal_getcca(struct ath_hal *ah);
1400
1401/*
1402 * Read EEPROM data from ah_eepromdata
1403 */
1404HAL_BOOL __ahdecl ath_hal_EepromDataRead(struct ath_hal *ah,
1405		u_int off, uint16_t *data);
1406
1407#endif /* _ATH_AH_H_ */
1408