Merge branch 'vendor/TCSH'
[dragonfly.git] / sys / dev / netif / ath / ath_hal / ah.h
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  * 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_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  */
57 typedef 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
79 typedef enum {
80         AH_FALSE = 0,           /* NB: lots of code assumes false is zero */
81         AH_TRUE  = 1,
82 } HAL_BOOL;
83
84 typedef 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         HAL_CAP_RIFS_RX         = 39,
123         HAL_CAP_RIFS_TX         = 40,
124         HAL_CAP_FORCE_PPM       = 41,
125         HAL_CAP_RTS_AGGR_LIMIT  = 42,   /* aggregation limit with RTS */
126         HAL_CAP_4ADDR_AGGR      = 43,   /* hardware is capable of 4addr aggregation */
127         HAL_CAP_DFS_DMN         = 44,   /* current DFS domain */
128         HAL_CAP_EXT_CHAN_DFS    = 45,   /* DFS support for extension channel */
129         HAL_CAP_COMBINED_RADAR_RSSI     = 46,   /* Is combined RSSI for radar accurate */
130
131         HAL_CAP_AUTO_SLEEP      = 48,   /* hardware can go to network sleep
132                                            automatically after waking up to receive TIM */
133         HAL_CAP_MBSSID_AGGR_SUPPORT     = 49, /* Support for mBSSID Aggregation */
134         HAL_CAP_SPLIT_4KB_TRANS = 50,   /* hardware supports descriptors straddling a 4k page boundary */
135         HAL_CAP_REG_FLAG        = 51,   /* Regulatory domain flags */
136         HAL_CAP_BB_RIFS_HANG    = 52,
137         HAL_CAP_RIFS_RX_ENABLED = 53,
138         HAL_CAP_BB_DFS_HANG     = 54,
139
140         HAL_CAP_RX_STBC         = 58,
141         HAL_CAP_TX_STBC         = 59,
142
143         HAL_CAP_BT_COEX         = 60,   /* hardware is capable of bluetooth coexistence */
144         HAL_CAP_DYNAMIC_SMPS    = 61,   /* Dynamic MIMO Power Save hardware support */
145
146         HAL_CAP_DS              = 67,   /* 2 stream */
147         HAL_CAP_BB_RX_CLEAR_STUCK_HANG  = 68,
148         HAL_CAP_MAC_HANG        = 69,   /* can MAC hang */
149         HAL_CAP_MFP             = 70,   /* Management Frame Protection in hardware */
150
151         HAL_CAP_TS              = 72,   /* 3 stream */
152
153         HAL_CAP_ENHANCED_DMA_SUPPORT    = 75,   /* DMA FIFO support */
154         HAL_CAP_NUM_TXMAPS      = 76,   /* Number of buffers in a transmit descriptor */
155         HAL_CAP_TXDESCLEN       = 77,   /* Length of transmit descriptor */
156         HAL_CAP_TXSTATUSLEN     = 78,   /* Length of transmit status descriptor */
157         HAL_CAP_RXSTATUSLEN     = 79,   /* Length of transmit status descriptor */
158         HAL_CAP_RXFIFODEPTH     = 80,   /* Receive hardware FIFO depth */
159         HAL_CAP_RXBUFSIZE       = 81,   /* Receive Buffer Length */
160         HAL_CAP_NUM_MR_RETRIES  = 82,   /* limit on multirate retries */
161         HAL_CAP_OL_PWRCTRL      = 84,   /* Open loop TX power control */
162         HAL_CAP_SPECTRAL_SCAN   = 90,   /* Hardware supports spectral scan */
163
164         HAL_CAP_BB_PANIC_WATCHDOG       = 92,
165
166         HAL_CAP_HT20_SGI        = 96,   /* hardware supports HT20 short GI */
167
168         HAL_CAP_LDPC            = 99,
169
170         HAL_CAP_RXTSTAMP_PREC   = 100,  /* rx desc tstamp precision (bits) */
171
172         HAL_CAP_ANT_DIV_COMB    = 105,  /* Enable antenna diversity/combining */
173         HAL_CAP_PHYRESTART_CLR_WAR      = 106,  /* in some cases, clear phy restart to fix bb hang */
174         HAL_CAP_ENTERPRISE_MODE = 107,  /* Enterprise mode features */
175         HAL_CAP_LDPCWAR         = 108,
176         HAL_CAP_CHANNEL_SWITCH_TIME_USEC        = 109,  /* Channel change time, usec */
177         HAL_CAP_ENABLE_APM      = 110,  /* APM enabled */
178         HAL_CAP_PCIE_LCR_EXTSYNC_EN     = 111,
179         HAL_CAP_PCIE_LCR_OFFSET = 112,
180
181         HAL_CAP_ENHANCED_DFS_SUPPORT    = 117,  /* hardware supports enhanced DFS */
182         HAL_CAP_MCI             = 118,
183         HAL_CAP_SMARTANTENNA    = 119,
184         HAL_CAP_TRAFFIC_FAST_RECOVER    = 120,
185         HAL_CAP_TX_DIVERSITY    = 121,
186         HAL_CAP_CRDC            = 122,
187
188         /* The following are private to the FreeBSD HAL (224 onward) */
189
190         HAL_CAP_INTMIT          = 229,  /* interference mitigation */
191         HAL_CAP_RXORN_FATAL     = 230,  /* HAL_INT_RXORN treated as fatal */
192         HAL_CAP_BB_HANG         = 235,  /* can baseband hang */
193         HAL_CAP_INTRMASK        = 237,  /* bitmask of supported interrupts */
194         HAL_CAP_BSSIDMATCH      = 238,  /* hardware has disable bssid match */
195         HAL_CAP_STREAMS         = 239,  /* how many 802.11n spatial streams are available */
196         HAL_CAP_RXDESC_SELFLINK = 242,  /* support a self-linked tail RX descriptor */
197         HAL_CAP_LONG_RXDESC_TSF = 243,  /* hardware supports 32bit TSF in RX descriptor */
198         HAL_CAP_BB_READ_WAR     = 244,  /* baseband read WAR */
199         HAL_CAP_SERIALISE_WAR   = 245,  /* serialise register access on PCI */
200         HAL_CAP_ENFORCE_TXOP    = 246,  /* Enforce TXOP if supported */
201         HAL_CAP_RX_LNA_MIXING   = 247,  /* RX hardware uses LNA mixing */
202         HAL_CAP_DO_MYBEACON     = 248,  /* Supports HAL_RX_FILTER_MYBEACON */
203 } HAL_CAPABILITY_TYPE;
204
205 /* 
206  * "States" for setting the LED.  These correspond to
207  * the possible 802.11 operational states and there may
208  * be a many-to-one mapping between these states and the
209  * actual hardware state for the LED's (i.e. the hardware
210  * may have fewer states).
211  */
212 typedef enum {
213         HAL_LED_INIT    = 0,
214         HAL_LED_SCAN    = 1,
215         HAL_LED_AUTH    = 2,
216         HAL_LED_ASSOC   = 3,
217         HAL_LED_RUN     = 4
218 } HAL_LED_STATE;
219
220 /*
221  * Transmit queue types/numbers.  These are used to tag
222  * each transmit queue in the hardware and to identify a set
223  * of transmit queues for operations such as start/stop dma.
224  */
225 typedef enum {
226         HAL_TX_QUEUE_INACTIVE   = 0,            /* queue is inactive/unused */
227         HAL_TX_QUEUE_DATA       = 1,            /* data xmit q's */
228         HAL_TX_QUEUE_BEACON     = 2,            /* beacon xmit q */
229         HAL_TX_QUEUE_CAB        = 3,            /* "crap after beacon" xmit q */
230         HAL_TX_QUEUE_UAPSD      = 4,            /* u-apsd power save xmit q */
231         HAL_TX_QUEUE_PSPOLL     = 5,            /* power save poll xmit q */
232         HAL_TX_QUEUE_CFEND      = 6,
233         HAL_TX_QUEUE_PAPRD      = 7,
234 } HAL_TX_QUEUE;
235
236 #define HAL_NUM_TX_QUEUES       10              /* max possible # of queues */
237
238 /*
239  * Receive queue types.  These are used to tag
240  * each transmit queue in the hardware and to identify a set
241  * of transmit queues for operations such as start/stop dma.
242  */
243 typedef enum {
244         HAL_RX_QUEUE_HP = 0,                    /* high priority recv queue */
245         HAL_RX_QUEUE_LP = 1,                    /* low priority recv queue */
246 } HAL_RX_QUEUE;
247
248 #define HAL_NUM_RX_QUEUES       2               /* max possible # of queues */
249
250 #define HAL_TXFIFO_DEPTH        8               /* transmit fifo depth */
251
252 /*
253  * Transmit queue subtype.  These map directly to
254  * WME Access Categories (except for UPSD).  Refer
255  * to Table 5 of the WME spec.
256  */
257 typedef enum {
258         HAL_WME_AC_BK   = 0,                    /* background access category */
259         HAL_WME_AC_BE   = 1,                    /* best effort access category*/
260         HAL_WME_AC_VI   = 2,                    /* video access category */
261         HAL_WME_AC_VO   = 3,                    /* voice access category */
262         HAL_WME_UPSD    = 4,                    /* uplink power save */
263 } HAL_TX_QUEUE_SUBTYPE;
264
265 /*
266  * Transmit queue flags that control various
267  * operational parameters.
268  */
269 typedef enum {
270         /*
271          * Per queue interrupt enables.  When set the associated
272          * interrupt may be delivered for packets sent through
273          * the queue.  Without these enabled no interrupts will
274          * be delivered for transmits through the queue.
275          */
276         HAL_TXQ_TXOKINT_ENABLE     = 0x0001,    /* enable TXOK interrupt */
277         HAL_TXQ_TXERRINT_ENABLE    = 0x0001,    /* enable TXERR interrupt */
278         HAL_TXQ_TXDESCINT_ENABLE   = 0x0002,    /* enable TXDESC interrupt */
279         HAL_TXQ_TXEOLINT_ENABLE    = 0x0004,    /* enable TXEOL interrupt */
280         HAL_TXQ_TXURNINT_ENABLE    = 0x0008,    /* enable TXURN interrupt */
281         /*
282          * Enable hardware compression for packets sent through
283          * the queue.  The compression buffer must be setup and
284          * packets must have a key entry marked in the tx descriptor.
285          */
286         HAL_TXQ_COMPRESSION_ENABLE  = 0x0010,   /* enable h/w compression */
287         /*
288          * Disable queue when veol is hit or ready time expires.
289          * By default the queue is disabled only on reaching the
290          * physical end of queue (i.e. a null link ptr in the
291          * descriptor chain).
292          */
293         HAL_TXQ_RDYTIME_EXP_POLICY_ENABLE = 0x0020,
294         /*
295          * Schedule frames on delivery of a DBA (DMA Beacon Alert)
296          * event.  Frames will be transmitted only when this timer
297          * fires, e.g to transmit a beacon in ap or adhoc modes.
298          */
299         HAL_TXQ_DBA_GATED           = 0x0040,   /* schedule based on DBA */
300         /*
301          * Each transmit queue has a counter that is incremented
302          * each time the queue is enabled and decremented when
303          * the list of frames to transmit is traversed (or when
304          * the ready time for the queue expires).  This counter
305          * must be non-zero for frames to be scheduled for
306          * transmission.  The following controls disable bumping
307          * this counter under certain conditions.  Typically this
308          * is used to gate frames based on the contents of another
309          * queue (e.g. CAB traffic may only follow a beacon frame).
310          * These are meaningful only when frames are scheduled
311          * with a non-ASAP policy (e.g. DBA-gated).
312          */
313         HAL_TXQ_CBR_DIS_QEMPTY      = 0x0080,   /* disable on this q empty */
314         HAL_TXQ_CBR_DIS_BEMPTY      = 0x0100,   /* disable on beacon q empty */
315
316         /*
317          * Fragment burst backoff policy.  Normally the no backoff
318          * is done after a successful transmission, the next fragment
319          * is sent at SIFS.  If this flag is set backoff is done
320          * after each fragment, regardless whether it was ack'd or
321          * not, after the backoff count reaches zero a normal channel
322          * access procedure is done before the next transmit (i.e.
323          * wait AIFS instead of SIFS).
324          */
325         HAL_TXQ_FRAG_BURST_BACKOFF_ENABLE = 0x00800000,
326         /*
327          * Disable post-tx backoff following each frame.
328          */
329         HAL_TXQ_BACKOFF_DISABLE     = 0x00010000, /* disable post backoff  */
330         /*
331          * DCU arbiter lockout control.  This controls how
332          * lower priority tx queues are handled with respect to
333          * to a specific queue when multiple queues have frames
334          * to send.  No lockout means lower priority queues arbitrate
335          * concurrently with this queue.  Intra-frame lockout
336          * means lower priority queues are locked out until the
337          * current frame transmits (e.g. including backoffs and bursting).
338          * Global lockout means nothing lower can arbitrary so
339          * long as there is traffic activity on this queue (frames,
340          * backoff, etc).
341          */
342         HAL_TXQ_ARB_LOCKOUT_INTRA   = 0x00020000, /* intra-frame lockout */
343         HAL_TXQ_ARB_LOCKOUT_GLOBAL  = 0x00040000, /* full lockout s */
344
345         HAL_TXQ_IGNORE_VIRTCOL      = 0x00080000, /* ignore virt collisions */
346         HAL_TXQ_SEQNUM_INC_DIS      = 0x00100000, /* disable seqnum increment */
347 } HAL_TX_QUEUE_FLAGS;
348
349 typedef struct {
350         uint32_t        tqi_ver;                /* hal TXQ version */
351         HAL_TX_QUEUE_SUBTYPE tqi_subtype;       /* subtype if applicable */
352         HAL_TX_QUEUE_FLAGS tqi_qflags;          /* flags (see above) */
353         uint32_t        tqi_priority;           /* (not used) */
354         uint32_t        tqi_aifs;               /* aifs */
355         uint32_t        tqi_cwmin;              /* cwMin */
356         uint32_t        tqi_cwmax;              /* cwMax */
357         uint16_t        tqi_shretry;            /* rts retry limit */
358         uint16_t        tqi_lgretry;            /* long retry limit (not used)*/
359         uint32_t        tqi_cbrPeriod;          /* CBR period (us) */
360         uint32_t        tqi_cbrOverflowLimit;   /* threshold for CBROVF int */
361         uint32_t        tqi_burstTime;          /* max burst duration (us) */
362         uint32_t        tqi_readyTime;          /* frame schedule time (us) */
363         uint32_t        tqi_compBuf;            /* comp buffer phys addr */
364 } HAL_TXQ_INFO;
365
366 #define HAL_TQI_NONVAL 0xffff
367
368 /* token to use for aifs, cwmin, cwmax */
369 #define HAL_TXQ_USEDEFAULT      ((uint32_t) -1)
370
371 /* compression definitions */
372 #define HAL_COMP_BUF_MAX_SIZE           9216            /* 9K */
373 #define HAL_COMP_BUF_ALIGN_SIZE         512
374
375 /*
376  * Transmit packet types.  This belongs in ah_desc.h, but
377  * is here so we can give a proper type to various parameters
378  * (and not require everyone include the file).
379  *
380  * NB: These values are intentionally assigned for
381  *     direct use when setting up h/w descriptors.
382  */
383 typedef enum {
384         HAL_PKT_TYPE_NORMAL     = 0,
385         HAL_PKT_TYPE_ATIM       = 1,
386         HAL_PKT_TYPE_PSPOLL     = 2,
387         HAL_PKT_TYPE_BEACON     = 3,
388         HAL_PKT_TYPE_PROBE_RESP = 4,
389         HAL_PKT_TYPE_CHIRP      = 5,
390         HAL_PKT_TYPE_GRP_POLL   = 6,
391         HAL_PKT_TYPE_AMPDU      = 7,
392 } HAL_PKT_TYPE;
393
394 /* Rx Filter Frame Types */
395 typedef enum {
396         /*
397          * These bits correspond to AR_RX_FILTER for all chips.
398          * Not all bits are supported by all chips.
399          */
400         HAL_RX_FILTER_UCAST     = 0x00000001,   /* Allow unicast frames */
401         HAL_RX_FILTER_MCAST     = 0x00000002,   /* Allow multicast frames */
402         HAL_RX_FILTER_BCAST     = 0x00000004,   /* Allow broadcast frames */
403         HAL_RX_FILTER_CONTROL   = 0x00000008,   /* Allow control frames */
404         HAL_RX_FILTER_BEACON    = 0x00000010,   /* Allow beacon frames */
405         HAL_RX_FILTER_PROM      = 0x00000020,   /* Promiscuous mode */
406         HAL_RX_FILTER_PROBEREQ  = 0x00000080,   /* Allow probe request frames */
407         HAL_RX_FILTER_PHYERR    = 0x00000100,   /* Allow phy errors */
408         HAL_RX_FILTER_MYBEACON  = 0x00000200,   /* Filter beacons other than mine */
409         HAL_RX_FILTER_COMPBAR   = 0x00000400,   /* Allow compressed BAR */
410         HAL_RX_FILTER_COMP_BA   = 0x00000800,   /* Allow compressed blockack */
411         HAL_RX_FILTER_PHYRADAR  = 0x00002000,   /* Allow phy radar errors */
412         HAL_RX_FILTER_PSPOLL    = 0x00004000,   /* Allow PS-POLL frames */
413         HAL_RX_FILTER_MCAST_BCAST_ALL   = 0x00008000,
414                                                 /* Allow all mcast/bcast frames */
415
416         /*
417          * Magic RX filter flags that aren't targetting hardware bits
418          * but instead the HAL sets individual bits - eg PHYERR will result
419          * in OFDM/CCK timing error frames being received.
420          */
421         HAL_RX_FILTER_BSSID     = 0x40000000,   /* Disable BSSID match */
422 } HAL_RX_FILTER;
423
424 typedef enum {
425         HAL_PM_AWAKE            = 0,
426         HAL_PM_FULL_SLEEP       = 1,
427         HAL_PM_NETWORK_SLEEP    = 2,
428         HAL_PM_UNDEFINED        = 3
429 } HAL_POWER_MODE;
430
431 /*
432  * Enterprise mode flags
433  */
434 #define AH_ENT_DUAL_BAND_DISABLE        0x00000001
435 #define AH_ENT_CHAIN2_DISABLE           0x00000002
436 #define AH_ENT_5MHZ_DISABLE             0x00000004
437 #define AH_ENT_10MHZ_DISABLE            0x00000008
438 #define AH_ENT_49GHZ_DISABLE            0x00000010
439 #define AH_ENT_LOOPBACK_DISABLE         0x00000020
440 #define AH_ENT_TPC_PERF_DISABLE         0x00000040
441 #define AH_ENT_MIN_PKT_SIZE_DISABLE     0x00000080
442 #define AH_ENT_SPECTRAL_PRECISION       0x00000300
443 #define AH_ENT_SPECTRAL_PRECISION_S     8
444 #define AH_ENT_RTSCTS_DELIM_WAR         0x00010000
445
446 #define AH_FIRST_DESC_NDELIMS 60
447
448 /*
449  * NOTE WELL:
450  * These are mapped to take advantage of the common locations for many of
451  * the bits on all of the currently supported MAC chips. This is to make
452  * the ISR as efficient as possible, while still abstracting HW differences.
453  * When new hardware breaks this commonality this enumerated type, as well
454  * as the HAL functions using it, must be modified. All values are directly
455  * mapped unless commented otherwise.
456  */
457 typedef enum {
458         HAL_INT_RX      = 0x00000001,   /* Non-common mapping */
459         HAL_INT_RXDESC  = 0x00000002,   /* Legacy mapping */
460         HAL_INT_RXERR   = 0x00000004,
461         HAL_INT_RXHP    = 0x00000001,   /* EDMA */
462         HAL_INT_RXLP    = 0x00000002,   /* EDMA */
463         HAL_INT_RXNOFRM = 0x00000008,
464         HAL_INT_RXEOL   = 0x00000010,
465         HAL_INT_RXORN   = 0x00000020,
466         HAL_INT_TX      = 0x00000040,   /* Non-common mapping */
467         HAL_INT_TXDESC  = 0x00000080,
468         HAL_INT_TIM_TIMER= 0x00000100,
469         HAL_INT_MCI     = 0x00000200,
470         HAL_INT_BBPANIC = 0x00000400,
471         HAL_INT_TXURN   = 0x00000800,
472         HAL_INT_MIB     = 0x00001000,
473         HAL_INT_RXPHY   = 0x00004000,
474         HAL_INT_RXKCM   = 0x00008000,
475         HAL_INT_SWBA    = 0x00010000,
476         HAL_INT_BRSSI   = 0x00020000,
477         HAL_INT_BMISS   = 0x00040000,
478         HAL_INT_BNR     = 0x00100000,
479         HAL_INT_TIM     = 0x00200000,   /* Non-common mapping */
480         HAL_INT_DTIM    = 0x00400000,   /* Non-common mapping */
481         HAL_INT_DTIMSYNC= 0x00800000,   /* Non-common mapping */
482         HAL_INT_GPIO    = 0x01000000,
483         HAL_INT_CABEND  = 0x02000000,   /* Non-common mapping */
484         HAL_INT_TSFOOR  = 0x04000000,   /* Non-common mapping */
485         HAL_INT_TBTT    = 0x08000000,   /* Non-common mapping */
486         /* Atheros ref driver has a generic timer interrupt now..*/
487         HAL_INT_GENTIMER        = 0x08000000,   /* Non-common mapping */
488         HAL_INT_CST     = 0x10000000,   /* Non-common mapping */
489         HAL_INT_GTT     = 0x20000000,   /* Non-common mapping */
490         HAL_INT_FATAL   = 0x40000000,   /* Non-common mapping */
491 #define HAL_INT_GLOBAL  0x80000000      /* Set/clear IER */
492         HAL_INT_BMISC   = HAL_INT_TIM
493                         | HAL_INT_DTIM
494                         | HAL_INT_DTIMSYNC
495                         | HAL_INT_CABEND
496                         | HAL_INT_TBTT,
497
498         /* Interrupt bits that map directly to ISR/IMR bits */
499         HAL_INT_COMMON  = HAL_INT_RXNOFRM
500                         | HAL_INT_RXDESC
501                         | HAL_INT_RXEOL
502                         | HAL_INT_RXORN
503                         | HAL_INT_TXDESC
504                         | HAL_INT_TXURN
505                         | HAL_INT_MIB
506                         | HAL_INT_RXPHY
507                         | HAL_INT_RXKCM
508                         | HAL_INT_SWBA
509                         | HAL_INT_BMISS
510                         | HAL_INT_BRSSI
511                         | HAL_INT_BNR
512                         | HAL_INT_GPIO,
513 } HAL_INT;
514
515 /*
516  * MSI vector assignments
517  */
518 typedef enum {
519         HAL_MSIVEC_MISC = 0,
520         HAL_MSIVEC_TX   = 1,
521         HAL_MSIVEC_RXLP = 2,
522         HAL_MSIVEC_RXHP = 3,
523 } HAL_MSIVEC;
524
525 typedef enum {
526         HAL_INT_LINE = 0,
527         HAL_INT_MSI  = 1,
528 } HAL_INT_TYPE;
529
530 /* For interrupt mitigation registers */
531 typedef enum {
532         HAL_INT_RX_FIRSTPKT=0,
533         HAL_INT_RX_LASTPKT,
534         HAL_INT_TX_FIRSTPKT,
535         HAL_INT_TX_LASTPKT,
536         HAL_INT_THRESHOLD
537 } HAL_INT_MITIGATION;
538
539 /* XXX this is duplicate information! */
540 typedef struct {
541         u_int32_t       cyclecnt_diff;          /* delta cycle count */
542         u_int32_t       rxclr_cnt;              /* rx clear count */
543         u_int32_t       txframecnt_diff;        /* delta tx frame count */
544         u_int32_t       rxframecnt_diff;        /* delta rx frame count */
545         u_int32_t       listen_time;            /* listen time in msec - time for which ch is free */
546         u_int32_t       ofdmphyerr_cnt;         /* OFDM err count since last reset */
547         u_int32_t       cckphyerr_cnt;          /* CCK err count since last reset */
548         u_int32_t       ofdmphyerrcnt_diff;     /* delta OFDM Phy Error Count */
549         HAL_BOOL        valid;                  /* if the stats are valid*/
550 } HAL_ANISTATS;
551
552 typedef struct {
553         u_int8_t        txctl_offset;
554         u_int8_t        txctl_numwords;
555         u_int8_t        txstatus_offset;
556         u_int8_t        txstatus_numwords;
557
558         u_int8_t        rxctl_offset;
559         u_int8_t        rxctl_numwords;
560         u_int8_t        rxstatus_offset;
561         u_int8_t        rxstatus_numwords;
562
563         u_int8_t        macRevision;
564 } HAL_DESC_INFO;
565
566 typedef enum {
567         HAL_GPIO_OUTPUT_MUX_AS_OUTPUT           = 0,
568         HAL_GPIO_OUTPUT_MUX_PCIE_ATTENTION_LED  = 1,
569         HAL_GPIO_OUTPUT_MUX_PCIE_POWER_LED      = 2,
570         HAL_GPIO_OUTPUT_MUX_MAC_NETWORK_LED     = 3,
571         HAL_GPIO_OUTPUT_MUX_MAC_POWER_LED       = 4,
572         HAL_GPIO_OUTPUT_MUX_AS_WLAN_ACTIVE      = 5,
573         HAL_GPIO_OUTPUT_MUX_AS_TX_FRAME         = 6,
574
575         HAL_GPIO_OUTPUT_MUX_AS_MCI_WLAN_DATA,
576         HAL_GPIO_OUTPUT_MUX_AS_MCI_WLAN_CLK,
577         HAL_GPIO_OUTPUT_MUX_AS_MCI_BT_DATA,
578         HAL_GPIO_OUTPUT_MUX_AS_MCI_BT_CLK,
579         HAL_GPIO_OUTPUT_MUX_AS_WL_IN_TX,
580         HAL_GPIO_OUTPUT_MUX_AS_WL_IN_RX,
581         HAL_GPIO_OUTPUT_MUX_AS_BT_IN_TX,
582         HAL_GPIO_OUTPUT_MUX_AS_BT_IN_RX,
583         HAL_GPIO_OUTPUT_MUX_AS_RUCKUS_STROBE,
584         HAL_GPIO_OUTPUT_MUX_AS_RUCKUS_DATA,
585         HAL_GPIO_OUTPUT_MUX_AS_SMARTANT_CTRL0,
586         HAL_GPIO_OUTPUT_MUX_AS_SMARTANT_CTRL1,
587         HAL_GPIO_OUTPUT_MUX_AS_SMARTANT_CTRL2,
588         HAL_GPIO_OUTPUT_MUX_NUM_ENTRIES
589 } HAL_GPIO_MUX_TYPE;
590
591 typedef enum {
592         HAL_GPIO_INTR_LOW               = 0,
593         HAL_GPIO_INTR_HIGH              = 1,
594         HAL_GPIO_INTR_DISABLE           = 2
595 } HAL_GPIO_INTR_TYPE;
596
597 typedef struct halCounters {
598     u_int32_t   tx_frame_count;
599     u_int32_t   rx_frame_count;
600     u_int32_t   rx_clear_count;
601     u_int32_t   cycle_count;
602     u_int8_t    is_rx_active;     // true (1) or false (0)
603     u_int8_t    is_tx_active;     // true (1) or false (0)
604 } HAL_COUNTERS;
605
606 typedef enum {
607         HAL_RFGAIN_INACTIVE             = 0,
608         HAL_RFGAIN_READ_REQUESTED       = 1,
609         HAL_RFGAIN_NEED_CHANGE          = 2
610 } HAL_RFGAIN;
611
612 typedef uint16_t HAL_CTRY_CODE;         /* country code */
613 typedef uint16_t HAL_REG_DOMAIN;                /* regulatory domain code */
614
615 #define HAL_ANTENNA_MIN_MODE  0
616 #define HAL_ANTENNA_FIXED_A   1
617 #define HAL_ANTENNA_FIXED_B   2
618 #define HAL_ANTENNA_MAX_MODE  3
619
620 typedef struct {
621         uint32_t        ackrcv_bad;
622         uint32_t        rts_bad;
623         uint32_t        rts_good;
624         uint32_t        fcs_bad;
625         uint32_t        beacons;
626 } HAL_MIB_STATS;
627
628 /*
629  * These bits represent what's in ah_currentRDext.
630  */
631 typedef enum {
632         REG_EXT_FCC_MIDBAND             = 0,
633         REG_EXT_JAPAN_MIDBAND           = 1,
634         REG_EXT_FCC_DFS_HT40            = 2,
635         REG_EXT_JAPAN_NONDFS_HT40       = 3,
636         REG_EXT_JAPAN_DFS_HT40          = 4
637 } REG_EXT_BITMAP;
638
639 enum {
640         HAL_MODE_11A    = 0x001,                /* 11a channels */
641         HAL_MODE_TURBO  = 0x002,                /* 11a turbo-only channels */
642         HAL_MODE_11B    = 0x004,                /* 11b channels */
643         HAL_MODE_PUREG  = 0x008,                /* 11g channels (OFDM only) */
644 #ifdef notdef
645         HAL_MODE_11G    = 0x010,                /* 11g channels (OFDM/CCK) */
646 #else
647         HAL_MODE_11G    = 0x008,                /* XXX historical */
648 #endif
649         HAL_MODE_108G   = 0x020,                /* 11g+Turbo channels */
650         HAL_MODE_108A   = 0x040,                /* 11a+Turbo channels */
651         HAL_MODE_11A_HALF_RATE = 0x200,         /* 11a half width channels */
652         HAL_MODE_11A_QUARTER_RATE = 0x400,      /* 11a quarter width channels */
653         HAL_MODE_11G_HALF_RATE = 0x800,         /* 11g half width channels */
654         HAL_MODE_11G_QUARTER_RATE = 0x1000,     /* 11g quarter width channels */
655         HAL_MODE_11NG_HT20      = 0x008000,
656         HAL_MODE_11NA_HT20      = 0x010000,
657         HAL_MODE_11NG_HT40PLUS  = 0x020000,
658         HAL_MODE_11NG_HT40MINUS = 0x040000,
659         HAL_MODE_11NA_HT40PLUS  = 0x080000,
660         HAL_MODE_11NA_HT40MINUS = 0x100000,
661         HAL_MODE_ALL    = 0xffffff
662 };
663
664 typedef struct {
665         int             rateCount;              /* NB: for proper padding */
666         uint8_t         rateCodeToIndex[256];   /* back mapping */
667         struct {
668                 uint8_t         valid;          /* valid for rate control use */
669                 uint8_t         phy;            /* CCK/OFDM/XR */
670                 uint32_t        rateKbps;       /* transfer rate in kbs */
671                 uint8_t         rateCode;       /* rate for h/w descriptors */
672                 uint8_t         shortPreamble;  /* mask for enabling short
673                                                  * preamble in CCK rate code */
674                 uint8_t         dot11Rate;      /* value for supported rates
675                                                  * info element of MLME */
676                 uint8_t         controlRate;    /* index of next lower basic
677                                                  * rate; used for dur. calcs */
678                 uint16_t        lpAckDuration;  /* long preamble ACK duration */
679                 uint16_t        spAckDuration;  /* short preamble ACK duration*/
680         } info[64];
681 } HAL_RATE_TABLE;
682
683 typedef struct {
684         u_int           rs_count;               /* number of valid entries */
685         uint8_t rs_rates[64];           /* rates */
686 } HAL_RATE_SET;
687
688 /*
689  * 802.11n specific structures and enums
690  */
691 typedef enum {
692         HAL_CHAINTYPE_TX        = 1,    /* Tx chain type */
693         HAL_CHAINTYPE_RX        = 2,    /* RX chain type */
694 } HAL_CHAIN_TYPE;
695
696 typedef struct {
697         u_int   Tries;
698         u_int   Rate;           /* hardware rate code */
699         u_int   RateIndex;      /* rate series table index */
700         u_int   PktDuration;
701         u_int   ChSel;
702         u_int   RateFlags;
703 #define HAL_RATESERIES_RTS_CTS          0x0001  /* use rts/cts w/this series */
704 #define HAL_RATESERIES_2040             0x0002  /* use ext channel for series */
705 #define HAL_RATESERIES_HALFGI           0x0004  /* use half-gi for series */
706 #define HAL_RATESERIES_STBC             0x0008  /* use STBC for series */
707         u_int   tx_power_cap;           /* in 1/2 dBm units XXX TODO */
708 } HAL_11N_RATE_SERIES;
709
710 typedef enum {
711         HAL_HT_MACMODE_20       = 0,    /* 20 MHz operation */
712         HAL_HT_MACMODE_2040     = 1,    /* 20/40 MHz operation */
713 } HAL_HT_MACMODE;
714
715 typedef enum {
716         HAL_HT_PHYMODE_20       = 0,    /* 20 MHz operation */
717         HAL_HT_PHYMODE_2040     = 1,    /* 20/40 MHz operation */
718 } HAL_HT_PHYMODE;
719
720 typedef enum {
721         HAL_HT_EXTPROTSPACING_20 = 0,   /* 20 MHz spacing */
722         HAL_HT_EXTPROTSPACING_25 = 1,   /* 25 MHz spacing */
723 } HAL_HT_EXTPROTSPACING;
724
725
726 typedef enum {
727         HAL_RX_CLEAR_CTL_LOW    = 0x1,  /* force control channel to appear busy */
728         HAL_RX_CLEAR_EXT_LOW    = 0x2,  /* force extension channel to appear busy */
729 } HAL_HT_RXCLEAR;
730
731 typedef enum {
732         HAL_FREQ_BAND_5GHZ      = 0,
733         HAL_FREQ_BAND_2GHZ      = 1,
734 } HAL_FREQ_BAND;
735
736 /*
737  * Antenna switch control.  By default antenna selection
738  * enables multiple (2) antenna use.  To force use of the
739  * A or B antenna only specify a fixed setting.  Fixing
740  * the antenna will also disable any diversity support.
741  */
742 typedef enum {
743         HAL_ANT_VARIABLE = 0,                   /* variable by programming */
744         HAL_ANT_FIXED_A  = 1,                   /* fixed antenna A */
745         HAL_ANT_FIXED_B  = 2,                   /* fixed antenna B */
746 } HAL_ANT_SETTING;
747
748 typedef enum {
749         HAL_M_STA       = 1,                    /* infrastructure station */
750         HAL_M_IBSS      = 0,                    /* IBSS (adhoc) station */
751         HAL_M_HOSTAP    = 6,                    /* Software Access Point */
752         HAL_M_MONITOR   = 8                     /* Monitor mode */
753 } HAL_OPMODE;
754
755 typedef struct {
756         uint8_t         kv_type;                /* one of HAL_CIPHER */
757         uint8_t         kv_apsd;                /* Mask for APSD enabled ACs */
758         uint16_t        kv_len;                 /* length in bits */
759         uint8_t         kv_val[16];             /* enough for 128-bit keys */
760         uint8_t         kv_mic[8];              /* TKIP MIC key */
761         uint8_t         kv_txmic[8];            /* TKIP TX MIC key (optional) */
762 } HAL_KEYVAL;
763
764 /*
765  * This is the TX descriptor field which marks the key padding requirement.
766  * The naming is unfortunately unclear.
767  */
768 #define AH_KEYTYPE_MASK     0x0F
769 typedef enum {
770     HAL_KEY_TYPE_CLEAR,
771     HAL_KEY_TYPE_WEP,
772     HAL_KEY_TYPE_AES,
773     HAL_KEY_TYPE_TKIP,
774 } HAL_KEY_TYPE;
775
776 typedef enum {
777         HAL_CIPHER_WEP          = 0,
778         HAL_CIPHER_AES_OCB      = 1,
779         HAL_CIPHER_AES_CCM      = 2,
780         HAL_CIPHER_CKIP         = 3,
781         HAL_CIPHER_TKIP         = 4,
782         HAL_CIPHER_CLR          = 5,            /* no encryption */
783
784         HAL_CIPHER_MIC          = 127           /* TKIP-MIC, not a cipher */
785 } HAL_CIPHER;
786
787 enum {
788         HAL_SLOT_TIME_6  = 6,                   /* NB: for turbo mode */
789         HAL_SLOT_TIME_9  = 9,
790         HAL_SLOT_TIME_20 = 20,
791 };
792
793 /*
794  * Per-station beacon timer state.  Note that the specified
795  * beacon interval (given in TU's) can also include flags
796  * to force a TSF reset and to enable the beacon xmit logic.
797  * If bs_cfpmaxduration is non-zero the hardware is setup to
798  * coexist with a PCF-capable AP.
799  */
800 typedef struct {
801         uint32_t        bs_nexttbtt;            /* next beacon in TU */
802         uint32_t        bs_nextdtim;            /* next DTIM in TU */
803         uint32_t        bs_intval;              /* beacon interval+flags */
804 /*
805  * HAL_BEACON_PERIOD, HAL_BEACON_ENA and HAL_BEACON_RESET_TSF
806  * are all 1:1 correspondances with the pre-11n chip AR_BEACON
807  * register.
808  */
809 #define HAL_BEACON_PERIOD       0x0000ffff      /* beacon interval period */
810 #define HAL_BEACON_PERIOD_TU8   0x0007ffff      /* beacon interval, tu/8 */
811 #define HAL_BEACON_ENA          0x00800000      /* beacon xmit enable */
812 #define HAL_BEACON_RESET_TSF    0x01000000      /* clear TSF */
813 #define HAL_TSFOOR_THRESHOLD    0x00004240      /* TSF OOR thresh (16k uS) */
814         uint32_t        bs_dtimperiod;
815         uint16_t        bs_cfpperiod;           /* CFP period in TU */
816         uint16_t        bs_cfpmaxduration;      /* max CFP duration in TU */
817         uint32_t        bs_cfpnext;             /* next CFP in TU */
818         uint16_t        bs_timoffset;           /* byte offset to TIM bitmap */
819         uint16_t        bs_bmissthreshold;      /* beacon miss threshold */
820         uint32_t        bs_sleepduration;       /* max sleep duration */
821         uint32_t        bs_tsfoor_threshold;    /* TSF out of range threshold */
822 } HAL_BEACON_STATE;
823
824 /*
825  * Like HAL_BEACON_STATE but for non-station mode setup.
826  * NB: see above flag definitions for bt_intval. 
827  */
828 typedef struct {
829         uint32_t        bt_intval;              /* beacon interval+flags */
830         uint32_t        bt_nexttbtt;            /* next beacon in TU */
831         uint32_t        bt_nextatim;            /* next ATIM in TU */
832         uint32_t        bt_nextdba;             /* next DBA in 1/8th TU */
833         uint32_t        bt_nextswba;            /* next SWBA in 1/8th TU */
834         uint32_t        bt_flags;               /* timer enables */
835 #define HAL_BEACON_TBTT_EN      0x00000001
836 #define HAL_BEACON_DBA_EN       0x00000002
837 #define HAL_BEACON_SWBA_EN      0x00000004
838 } HAL_BEACON_TIMERS;
839
840 /*
841  * Per-node statistics maintained by the driver for use in
842  * optimizing signal quality and other operational aspects.
843  */
844 typedef struct {
845         uint32_t        ns_avgbrssi;    /* average beacon rssi */
846         uint32_t        ns_avgrssi;     /* average data rssi */
847         uint32_t        ns_avgtxrssi;   /* average tx rssi */
848 } HAL_NODE_STATS;
849
850 #define HAL_RSSI_EP_MULTIPLIER  (1<<7)  /* pow2 to optimize out * and / */
851
852
853 struct ath_desc;
854 struct ath_tx_status;
855 struct ath_rx_status;
856 struct ieee80211_channel;
857
858 /*
859  * This is a channel survey sample entry.
860  *
861  * The AR5212 ANI routines fill these samples. The ANI code then uses it
862  * when calculating listen time; it is also exported via a diagnostic
863  * API.
864  */
865 typedef struct {
866         uint32_t        seq_num;
867         uint32_t        tx_busy;
868         uint32_t        rx_busy;
869         uint32_t        chan_busy;
870         uint32_t        ext_chan_busy;
871         uint32_t        cycle_count;
872         /* XXX TODO */
873         uint32_t        ofdm_phyerr_count;
874         uint32_t        cck_phyerr_count;
875 } HAL_SURVEY_SAMPLE;
876
877 /*
878  * This provides 3.2 seconds of sample space given an
879  * ANI time of 1/10th of a second. This may not be enough!
880  */
881 #define CHANNEL_SURVEY_SAMPLE_COUNT     32
882
883 typedef struct {
884         HAL_SURVEY_SAMPLE samples[CHANNEL_SURVEY_SAMPLE_COUNT];
885         uint32_t cur_sample;    /* current sample in sequence */
886         uint32_t cur_seq;       /* current sequence number */
887 } HAL_CHANNEL_SURVEY;
888
889 /*
890  * ANI commands.
891  *
892  * These are used both internally and externally via the diagnostic
893  * API.
894  *
895  * Note that this is NOT the ANI commands being used via the INTMIT
896  * capability - that has a different mapping for some reason.
897  */
898 typedef enum {
899         HAL_ANI_PRESENT = 0,                    /* is ANI support present */
900         HAL_ANI_NOISE_IMMUNITY_LEVEL = 1,       /* set level */
901         HAL_ANI_OFDM_WEAK_SIGNAL_DETECTION = 2, /* enable/disable */
902         HAL_ANI_CCK_WEAK_SIGNAL_THR = 3,        /* enable/disable */
903         HAL_ANI_FIRSTEP_LEVEL = 4,              /* set level */
904         HAL_ANI_SPUR_IMMUNITY_LEVEL = 5,        /* set level */
905         HAL_ANI_MODE = 6,                       /* 0 => manual, 1 => auto (XXX do not change) */
906         HAL_ANI_PHYERR_RESET = 7,               /* reset phy error stats */
907         HAL_ANI_MRC_CCK = 8,
908 } HAL_ANI_CMD;
909
910 #define HAL_ANI_ALL             0xffffffff
911
912 /*
913  * This is the layout of the ANI INTMIT capability.
914  *
915  * Notice that the command values differ to HAL_ANI_CMD.
916  */
917 typedef enum {
918         HAL_CAP_INTMIT_PRESENT = 0,
919         HAL_CAP_INTMIT_ENABLE = 1,
920         HAL_CAP_INTMIT_NOISE_IMMUNITY_LEVEL = 2,
921         HAL_CAP_INTMIT_OFDM_WEAK_SIGNAL_LEVEL = 3,
922         HAL_CAP_INTMIT_CCK_WEAK_SIGNAL_THR = 4,
923         HAL_CAP_INTMIT_FIRSTEP_LEVEL = 5,
924         HAL_CAP_INTMIT_SPUR_IMMUNITY_LEVEL = 6
925 } HAL_CAP_INTMIT_CMD;
926
927 typedef struct {
928         int32_t         pe_firpwr;      /* FIR pwr out threshold */
929         int32_t         pe_rrssi;       /* Radar rssi thresh */
930         int32_t         pe_height;      /* Pulse height thresh */
931         int32_t         pe_prssi;       /* Pulse rssi thresh */
932         int32_t         pe_inband;      /* Inband thresh */
933
934         /* The following params are only for AR5413 and later */
935         u_int32_t       pe_relpwr;      /* Relative power threshold in 0.5dB steps */
936         u_int32_t       pe_relstep;     /* Pulse Relative step threshold in 0.5dB steps */
937         u_int32_t       pe_maxlen;      /* Max length of radar sign in 0.8us units */
938         int32_t         pe_usefir128;   /* Use the average in-band power measured over 128 cycles */
939         int32_t         pe_blockradar;  /*
940                                          * Enable to block radar check if pkt detect is done via OFDM
941                                          * weak signal detect or pkt is detected immediately after tx
942                                          * to rx transition
943                                          */
944         int32_t         pe_enmaxrssi;   /*
945                                          * Enable to use the max rssi instead of the last rssi during
946                                          * fine gain changes for radar detection
947                                          */
948         int32_t         pe_extchannel;  /* Enable DFS on ext channel */
949         int32_t         pe_enabled;     /* Whether radar detection is enabled */
950         int32_t         pe_enrelpwr;
951         int32_t         pe_en_relstep_check;
952 } HAL_PHYERR_PARAM;
953
954 #define HAL_PHYERR_PARAM_NOVAL  65535
955
956 typedef struct {
957         u_int16_t       ss_fft_period;  /* Skip interval for FFT reports */
958         u_int16_t       ss_period;      /* Spectral scan period */
959         u_int16_t       ss_count;       /* # of reports to return from ss_active */
960         u_int16_t       ss_short_report;/* Set to report ony 1 set of FFT results */
961         u_int8_t        radar_bin_thresh_sel;   /* strong signal radar FFT threshold configuration */
962         u_int16_t       ss_spectral_pri;                /* are we doing a noise power cal ? */
963         int8_t          ss_nf_cal[AH_MAX_CHAINS*2];     /* nf calibrated values for ctl+ext from eeprom */
964         int8_t          ss_nf_pwr[AH_MAX_CHAINS*2];     /* nf pwr values for ctl+ext from eeprom */
965         int32_t         ss_nf_temp_data;        /* temperature data taken during nf scan */
966         int             ss_enabled;
967         int             ss_active;
968 } HAL_SPECTRAL_PARAM;
969 #define HAL_SPECTRAL_PARAM_NOVAL        0xFFFF
970 #define HAL_SPECTRAL_PARAM_ENABLE       0x8000  /* Enable/Disable if applicable */
971
972 /*
973  * DFS operating mode flags.
974  */
975 typedef enum {
976         HAL_DFS_UNINIT_DOMAIN   = 0,    /* Uninitialized dfs domain */
977         HAL_DFS_FCC_DOMAIN      = 1,    /* FCC3 dfs domain */
978         HAL_DFS_ETSI_DOMAIN     = 2,    /* ETSI dfs domain */
979         HAL_DFS_MKK4_DOMAIN     = 3,    /* Japan dfs domain */
980 } HAL_DFS_DOMAIN;
981
982
983 /*
984  * MFP decryption options for initializing the MAC.
985  */
986 typedef enum {
987         HAL_MFP_QOSDATA = 0,    /* Decrypt MFP frames like QoS data frames. All chips before Merlin. */
988         HAL_MFP_PASSTHRU,       /* Don't decrypt MFP frames at all. Passthrough */
989         HAL_MFP_HW_CRYPTO       /* hardware decryption enabled. Merlin can do it. */
990 } HAL_MFP_OPT_T;
991
992 /* LNA config supported */
993 typedef enum {
994         HAL_ANT_DIV_COMB_LNA1_MINUS_LNA2        = 0,
995         HAL_ANT_DIV_COMB_LNA2                   = 1,
996         HAL_ANT_DIV_COMB_LNA1                   = 2,
997         HAL_ANT_DIV_COMB_LNA1_PLUS_LNA2         = 3,
998 } HAL_ANT_DIV_COMB_LNA_CONF;
999
1000 typedef struct {
1001         u_int8_t        main_lna_conf;
1002         u_int8_t        alt_lna_conf;
1003         u_int8_t        fast_div_bias;
1004         u_int8_t        main_gaintb;
1005         u_int8_t        alt_gaintb;
1006         u_int8_t        antdiv_configgroup;
1007         int8_t          lna1_lna2_delta;
1008 } HAL_ANT_COMB_CONFIG;
1009
1010 #define DEFAULT_ANTDIV_CONFIG_GROUP     0x00
1011 #define HAL_ANTDIV_CONFIG_GROUP_1       0x01
1012 #define HAL_ANTDIV_CONFIG_GROUP_2       0x02
1013 #define HAL_ANTDIV_CONFIG_GROUP_3       0x03
1014
1015 /*
1016  * Flag for setting QUIET period
1017  */
1018 typedef enum {
1019         HAL_QUIET_DISABLE               = 0x0,
1020         HAL_QUIET_ENABLE                = 0x1,
1021         HAL_QUIET_ADD_CURRENT_TSF       = 0x2,  /* add current TSF to next_start offset */
1022         HAL_QUIET_ADD_SWBA_RESP_TIME    = 0x4,  /* add beacon response time to next_start offset */
1023 } HAL_QUIET_FLAG;
1024
1025 #define HAL_DFS_EVENT_PRICH             0x0000001
1026 #define HAL_DFS_EVENT_EXTCH             0x0000002
1027 #define HAL_DFS_EVENT_EXTEARLY          0x0000004
1028 #define HAL_DFS_EVENT_ISDC              0x0000008
1029
1030 struct hal_dfs_event {
1031         uint64_t        re_full_ts;     /* 64-bit full timestamp from interrupt time */
1032         uint32_t        re_ts;          /* Original 15 bit recv timestamp */
1033         uint8_t         re_rssi;        /* rssi of radar event */
1034         uint8_t         re_dur;         /* duration of radar pulse */
1035         uint32_t        re_flags;       /* Flags (see above) */
1036 };
1037 typedef struct hal_dfs_event HAL_DFS_EVENT;
1038
1039 /*
1040  * Generic Timer domain
1041  */
1042 typedef enum {
1043         HAL_GEN_TIMER_TSF = 0,
1044         HAL_GEN_TIMER_TSF2,
1045         HAL_GEN_TIMER_TSF_ANY
1046 } HAL_GEN_TIMER_DOMAIN;
1047
1048 typedef enum {
1049         HAL_RESET_NONE = 0x0,
1050         HAL_RESET_BBPANIC = 0x1,
1051 } HAL_RESET_TYPE;
1052
1053 /*
1054  * BT Co-existence definitions
1055  */
1056 typedef enum {
1057         HAL_BT_MODULE_CSR_BC4   = 0,    /* CSR BlueCore v4 */
1058         HAL_BT_MODULE_JANUS     = 1,    /* Kite + Valkyrie combo */
1059         HAL_BT_MODULE_HELIUS    = 2,    /* Kiwi + Valkyrie combo */
1060         HAL_MAX_BT_MODULES
1061 } HAL_BT_MODULE;
1062
1063 typedef struct {
1064         HAL_BT_MODULE   bt_module;
1065         u_int8_t        bt_coex_config;
1066         u_int8_t        bt_gpio_bt_active;
1067         u_int8_t        bt_gpio_bt_priority;
1068         u_int8_t        bt_gpio_wlan_active;
1069         u_int8_t        bt_active_polarity;
1070         HAL_BOOL        bt_single_ant;
1071         u_int8_t        bt_dutyCycle;
1072         u_int8_t        bt_isolation;
1073         u_int8_t        bt_period;
1074 } HAL_BT_COEX_INFO;
1075
1076 typedef enum {
1077         HAL_BT_COEX_MODE_LEGACY         = 0,    /* legacy rx_clear mode */
1078         HAL_BT_COEX_MODE_UNSLOTTED      = 1,    /* untimed/unslotted mode */
1079         HAL_BT_COEX_MODE_SLOTTED        = 2,    /* slotted mode */
1080         HAL_BT_COEX_MODE_DISALBED       = 3,    /* coexistence disabled */
1081 } HAL_BT_COEX_MODE;
1082
1083 typedef enum {
1084         HAL_BT_COEX_CFG_NONE,           /* No bt coex enabled */
1085         HAL_BT_COEX_CFG_2WIRE_2CH,      /* 2-wire with 2 chains */
1086         HAL_BT_COEX_CFG_2WIRE_CH1,      /* 2-wire with ch1 */
1087         HAL_BT_COEX_CFG_2WIRE_CH0,      /* 2-wire with ch0 */
1088         HAL_BT_COEX_CFG_3WIRE,          /* 3-wire */
1089         HAL_BT_COEX_CFG_MCI             /* MCI */
1090 } HAL_BT_COEX_CFG;
1091
1092 typedef enum {
1093         HAL_BT_COEX_SET_ACK_PWR         = 0,    /* Change ACK power setting */
1094         HAL_BT_COEX_LOWER_TX_PWR,               /* Change transmit power */
1095         HAL_BT_COEX_ANTENNA_DIVERSITY,  /* Enable RX diversity for Kite */
1096         HAL_BT_COEX_MCI_MAX_TX_PWR,     /* Set max tx power for concurrent tx */
1097         HAL_BT_COEX_MCI_FTP_STOMP_RX,   /* Use a different weight for stomp low */
1098 } HAL_BT_COEX_SET_PARAMETER;
1099
1100 #define HAL_BT_COEX_FLAG_LOW_ACK_PWR    0x00000001
1101 #define HAL_BT_COEX_FLAG_LOWER_TX_PWR   0x00000002
1102 /* Check Rx Diversity is allowed */
1103 #define HAL_BT_COEX_FLAG_ANT_DIV_ALLOW  0x00000004
1104 /* Check Diversity is on or off */
1105 #define HAL_BT_COEX_FLAG_ANT_DIV_ENABLE 0x00000008
1106
1107 #define HAL_BT_COEX_ANTDIV_CONTROL1_ENABLE      0x0b
1108 /* main: LNA1, alt: LNA2 */
1109 #define HAL_BT_COEX_ANTDIV_CONTROL2_ENABLE      0x09
1110 #define HAL_BT_COEX_ANTDIV_CONTROL1_FIXED_A     0x04
1111 #define HAL_BT_COEX_ANTDIV_CONTROL2_FIXED_A     0x09
1112 #define HAL_BT_COEX_ANTDIV_CONTROL1_FIXED_B     0x02
1113 #define HAL_BT_COEX_ANTDIV_CONTROL2_FIXED_B     0x06
1114
1115 #define HAL_BT_COEX_ISOLATION_FOR_NO_COEX       30
1116
1117 #define HAL_BT_COEX_ANT_DIV_SWITCH_COM  0x66666666
1118
1119 #define HAL_BT_COEX_HELIUS_CHAINMASK    0x02
1120
1121 #define HAL_BT_COEX_LOW_ACK_POWER       0x0
1122 #define HAL_BT_COEX_HIGH_ACK_POWER      0x3f3f3f
1123
1124 typedef enum {
1125         HAL_BT_COEX_NO_STOMP = 0,
1126         HAL_BT_COEX_STOMP_ALL,
1127         HAL_BT_COEX_STOMP_LOW,
1128         HAL_BT_COEX_STOMP_NONE,
1129         HAL_BT_COEX_STOMP_ALL_FORCE,
1130         HAL_BT_COEX_STOMP_LOW_FORCE,
1131 } HAL_BT_COEX_STOMP_TYPE;
1132
1133 typedef struct {
1134         /* extend rx_clear after tx/rx to protect the burst (in usec). */
1135         u_int8_t        bt_time_extend;
1136
1137         /*
1138          * extend rx_clear as long as txsm is
1139          * transmitting or waiting for ack.
1140          */
1141         HAL_BOOL        bt_txstate_extend;
1142
1143         /*
1144          * extend rx_clear so that when tx_frame
1145          * is asserted, rx_clear will drop.
1146          */
1147         HAL_BOOL        bt_txframe_extend;
1148
1149         /*
1150          * coexistence mode
1151          */
1152         HAL_BT_COEX_MODE        bt_mode;
1153
1154         /*
1155          * treat BT high priority traffic as
1156          * a quiet collision
1157          */
1158         HAL_BOOL        bt_quiet_collision;
1159
1160         /*
1161          * invert rx_clear as WLAN_ACTIVE
1162          */
1163         HAL_BOOL        bt_rxclear_polarity;
1164
1165         /*
1166          * slotted mode only. indicate the time in usec
1167          * from the rising edge of BT_ACTIVE to the time
1168          * BT_PRIORITY can be sampled to indicate priority.
1169          */
1170         u_int8_t        bt_priority_time;
1171
1172         /*
1173          * slotted mode only. indicate the time in usec
1174          * from the rising edge of BT_ACTIVE to the time
1175          * BT_PRIORITY can be sampled to indicate tx/rx and
1176          * BT_FREQ is sampled.
1177          */
1178         u_int8_t        bt_first_slot_time;
1179
1180         /*
1181          * slotted mode only. rx_clear and bt_ant decision
1182          * will be held the entire time that BT_ACTIVE is asserted,
1183          * otherwise the decision is made before every slot boundry.
1184          */
1185         HAL_BOOL        bt_hold_rxclear;
1186 } HAL_BT_COEX_CONFIG;
1187
1188 struct hal_bb_panic_info {
1189         u_int32_t       status;
1190         u_int32_t       tsf;
1191         u_int32_t       phy_panic_wd_ctl1;
1192         u_int32_t       phy_panic_wd_ctl2;
1193         u_int32_t       phy_gen_ctrl;
1194         u_int32_t       rxc_pcnt;
1195         u_int32_t       rxf_pcnt;
1196         u_int32_t       txf_pcnt;
1197         u_int32_t       cycles;
1198         u_int32_t       wd;
1199         u_int32_t       det;
1200         u_int32_t       rdar;
1201         u_int32_t       r_odfm;
1202         u_int32_t       r_cck;
1203         u_int32_t       t_odfm;
1204         u_int32_t       t_cck;
1205         u_int32_t       agc;
1206         u_int32_t       src;
1207 };
1208
1209 /* Serialize Register Access Mode */
1210 typedef enum {
1211         SER_REG_MODE_OFF        = 0,
1212         SER_REG_MODE_ON         = 1,
1213         SER_REG_MODE_AUTO       = 2,
1214 } SER_REG_MODE;
1215
1216 typedef struct
1217 {
1218         int ah_debug;                   /* only used if AH_DEBUG is defined */
1219         int ah_ar5416_biasadj;          /* enable AR2133 radio specific bias fiddling */
1220
1221         /* NB: these are deprecated; they exist for now for compatibility */
1222         int ah_dma_beacon_response_time;/* in TU's */
1223         int ah_sw_beacon_response_time; /* in TU's */
1224         int ah_additional_swba_backoff; /* in TU's */
1225         int ah_force_full_reset;        /* force full chip reset rather then warm reset */
1226         int ah_serialise_reg_war;       /* force serialisation of register IO */
1227
1228         /* XXX these don't belong here, they're just for the ar9300  HAL port effort */
1229         int ath_hal_desc_tpc;           /* Per-packet TPC */
1230         int ath_hal_sta_update_tx_pwr_enable;   /* GreenTX */
1231         int ath_hal_sta_update_tx_pwr_enable_S1;        /* GreenTX */
1232         int ath_hal_sta_update_tx_pwr_enable_S2;        /* GreenTX */
1233         int ath_hal_sta_update_tx_pwr_enable_S3;        /* GreenTX */
1234
1235         /* I'm not sure what the default values for these should be */
1236         int ath_hal_pll_pwr_save;
1237         int ath_hal_pcie_power_save_enable;
1238         int ath_hal_intr_mitigation_rx;
1239         int ath_hal_intr_mitigation_tx;
1240
1241         int ath_hal_pcie_clock_req;
1242 #define AR_PCIE_PLL_PWRSAVE_CONTROL     (1<<0)
1243 #define AR_PCIE_PLL_PWRSAVE_ON_D3       (1<<1)
1244 #define AR_PCIE_PLL_PWRSAVE_ON_D0       (1<<2)
1245
1246         int ath_hal_pcie_waen;
1247         int ath_hal_pcie_ser_des_write;
1248
1249         /* these are important for correct AR9300 behaviour */
1250         int ath_hal_ht_enable;          /* needs to be enabled for AR9300 HT */
1251         int ath_hal_diversity_control;
1252         int ath_hal_antenna_switch_swap;
1253         int ath_hal_ext_lna_ctl_gpio;
1254         int ath_hal_spur_mode;
1255         int ath_hal_6mb_ack;            /* should set this to 1 for 11a/11na? */
1256         int ath_hal_enable_msi;         /* enable MSI interrupts (needed?) */
1257         int ath_hal_beacon_filter_interval;     /* ok to be 0 for now? */
1258
1259         /* For now, set this to 0 - net80211 needs to know about hardware MFP support */
1260         int ath_hal_mfp_support;
1261
1262         int ath_hal_enable_ani; /* should set this.. */
1263         int ath_hal_cwm_ignore_ext_cca;
1264         int ath_hal_show_bb_panic;
1265         int ath_hal_ant_ctrl_comm2g_switch_enable;
1266         int ath_hal_ext_atten_margin_cfg;
1267         int ath_hal_min_gainidx;
1268         int ath_hal_war70c;
1269         uint32_t ath_hal_mci_config;
1270 } HAL_OPS_CONFIG;
1271
1272 /*
1273  * Hardware Access Layer (HAL) API.
1274  *
1275  * Clients of the HAL call ath_hal_attach to obtain a reference to an
1276  * ath_hal structure for use with the device.  Hardware-related operations
1277  * that follow must call back into the HAL through interface, supplying
1278  * the reference as the first parameter.  Note that before using the
1279  * reference returned by ath_hal_attach the caller should verify the
1280  * ABI version number.
1281  */
1282 struct ath_hal {
1283         uint32_t        ah_magic;       /* consistency check magic number */
1284         uint16_t        ah_devid;       /* PCI device ID */
1285         uint16_t        ah_subvendorid; /* PCI subvendor ID */
1286         HAL_SOFTC       ah_sc;          /* back pointer to driver/os state */
1287         HAL_BUS_TAG     ah_st;          /* params for register r+w */
1288         HAL_BUS_HANDLE  ah_sh;
1289         HAL_CTRY_CODE   ah_countryCode;
1290
1291         uint32_t        ah_macVersion;  /* MAC version id */
1292         uint16_t        ah_macRev;      /* MAC revision */
1293         uint16_t        ah_phyRev;      /* PHY revision */
1294         /* NB: when only one radio is present the rev is in 5Ghz */
1295         uint16_t        ah_analog5GhzRev;/* 5GHz radio revision */
1296         uint16_t        ah_analog2GhzRev;/* 2GHz radio revision */
1297
1298         uint16_t        *ah_eepromdata; /* eeprom buffer, if needed */
1299
1300         uint32_t        ah_intrstate[8];        /* last int state */
1301         uint32_t        ah_syncstate;           /* last sync intr state */
1302
1303         /* Current powerstate from HAL calls */
1304         HAL_POWER_MODE  ah_powerMode;
1305
1306         HAL_OPS_CONFIG ah_config;
1307         const HAL_RATE_TABLE *__ahdecl(*ah_getRateTable)(struct ath_hal *,
1308                                 u_int mode);
1309         void      __ahdecl(*ah_detach)(struct ath_hal*);
1310
1311         /* Reset functions */
1312         HAL_BOOL  __ahdecl(*ah_reset)(struct ath_hal *, HAL_OPMODE,
1313                                 struct ieee80211_channel *,
1314                                 HAL_BOOL bChannelChange, HAL_STATUS *status);
1315         HAL_BOOL  __ahdecl(*ah_phyDisable)(struct ath_hal *);
1316         HAL_BOOL  __ahdecl(*ah_disable)(struct ath_hal *);
1317         void      __ahdecl(*ah_configPCIE)(struct ath_hal *, HAL_BOOL restore,
1318                                 HAL_BOOL power_off);
1319         void      __ahdecl(*ah_disablePCIE)(struct ath_hal *);
1320         void      __ahdecl(*ah_setPCUConfig)(struct ath_hal *);
1321         HAL_BOOL  __ahdecl(*ah_perCalibration)(struct ath_hal*,
1322                         struct ieee80211_channel *, HAL_BOOL *);
1323         HAL_BOOL  __ahdecl(*ah_perCalibrationN)(struct ath_hal *,
1324                         struct ieee80211_channel *, u_int chainMask,
1325                         HAL_BOOL longCal, HAL_BOOL *isCalDone);
1326         HAL_BOOL  __ahdecl(*ah_resetCalValid)(struct ath_hal *,
1327                         const struct ieee80211_channel *);
1328         HAL_BOOL  __ahdecl(*ah_setTxPower)(struct ath_hal *,
1329                         const struct ieee80211_channel *, uint16_t *);
1330         HAL_BOOL  __ahdecl(*ah_setTxPowerLimit)(struct ath_hal *, uint32_t);
1331         HAL_BOOL  __ahdecl(*ah_setBoardValues)(struct ath_hal *,
1332                         const struct ieee80211_channel *);
1333
1334         /* Transmit functions */
1335         HAL_BOOL  __ahdecl(*ah_updateTxTrigLevel)(struct ath_hal*,
1336                                 HAL_BOOL incTrigLevel);
1337         int       __ahdecl(*ah_setupTxQueue)(struct ath_hal *, HAL_TX_QUEUE,
1338                                 const HAL_TXQ_INFO *qInfo);
1339         HAL_BOOL  __ahdecl(*ah_setTxQueueProps)(struct ath_hal *, int q, 
1340                                 const HAL_TXQ_INFO *qInfo);
1341         HAL_BOOL  __ahdecl(*ah_getTxQueueProps)(struct ath_hal *, int q, 
1342                                 HAL_TXQ_INFO *qInfo);
1343         HAL_BOOL  __ahdecl(*ah_releaseTxQueue)(struct ath_hal *ah, u_int q);
1344         HAL_BOOL  __ahdecl(*ah_resetTxQueue)(struct ath_hal *ah, u_int q);
1345         uint32_t __ahdecl(*ah_getTxDP)(struct ath_hal*, u_int);
1346         HAL_BOOL  __ahdecl(*ah_setTxDP)(struct ath_hal*, u_int, uint32_t txdp);
1347         uint32_t __ahdecl(*ah_numTxPending)(struct ath_hal *, u_int q);
1348         HAL_BOOL  __ahdecl(*ah_startTxDma)(struct ath_hal*, u_int);
1349         HAL_BOOL  __ahdecl(*ah_stopTxDma)(struct ath_hal*, u_int);
1350         HAL_BOOL  __ahdecl(*ah_setupTxDesc)(struct ath_hal *, struct ath_desc *,
1351                                 u_int pktLen, u_int hdrLen,
1352                                 HAL_PKT_TYPE type, u_int txPower,
1353                                 u_int txRate0, u_int txTries0,
1354                                 u_int keyIx, u_int antMode, u_int flags,
1355                                 u_int rtsctsRate, u_int rtsctsDuration,
1356                                 u_int compicvLen, u_int compivLen,
1357                                 u_int comp);
1358         HAL_BOOL  __ahdecl(*ah_setupXTxDesc)(struct ath_hal *, struct ath_desc*,
1359                                 u_int txRate1, u_int txTries1,
1360                                 u_int txRate2, u_int txTries2,
1361                                 u_int txRate3, u_int txTries3);
1362         HAL_BOOL  __ahdecl(*ah_fillTxDesc)(struct ath_hal *, struct ath_desc *,
1363                                 HAL_DMA_ADDR *bufAddrList, uint32_t *segLenList,
1364                                 u_int descId, u_int qcuId, HAL_BOOL firstSeg,
1365                                 HAL_BOOL lastSeg, const struct ath_desc *);
1366         HAL_STATUS __ahdecl(*ah_procTxDesc)(struct ath_hal *,
1367                                 struct ath_desc *, struct ath_tx_status *);
1368         void       __ahdecl(*ah_getTxIntrQueue)(struct ath_hal *, uint32_t *);
1369         void       __ahdecl(*ah_reqTxIntrDesc)(struct ath_hal *, struct ath_desc*);
1370         HAL_BOOL        __ahdecl(*ah_getTxCompletionRates)(struct ath_hal *,
1371                                 const struct ath_desc *ds, int *rates, int *tries);
1372         void      __ahdecl(*ah_setTxDescLink)(struct ath_hal *ah, void *ds,
1373                                 uint32_t link);
1374         void      __ahdecl(*ah_getTxDescLink)(struct ath_hal *ah, void *ds,
1375                                 uint32_t *link);
1376         void      __ahdecl(*ah_getTxDescLinkPtr)(struct ath_hal *ah, void *ds,
1377                                 uint32_t **linkptr);
1378         void      __ahdecl(*ah_setupTxStatusRing)(struct ath_hal *,
1379                                 void *ts_start, uint32_t ts_paddr_start,
1380                                 uint16_t size);
1381         void      __ahdecl(*ah_getTxRawTxDesc)(struct ath_hal *, u_int32_t *);
1382
1383         /* Receive Functions */
1384         uint32_t __ahdecl(*ah_getRxDP)(struct ath_hal*, HAL_RX_QUEUE);
1385         void      __ahdecl(*ah_setRxDP)(struct ath_hal*, uint32_t rxdp, HAL_RX_QUEUE);
1386         void      __ahdecl(*ah_enableReceive)(struct ath_hal*);
1387         HAL_BOOL  __ahdecl(*ah_stopDmaReceive)(struct ath_hal*);
1388         void      __ahdecl(*ah_startPcuReceive)(struct ath_hal*);
1389         void      __ahdecl(*ah_stopPcuReceive)(struct ath_hal*);
1390         void      __ahdecl(*ah_setMulticastFilter)(struct ath_hal*,
1391                                 uint32_t filter0, uint32_t filter1);
1392         HAL_BOOL  __ahdecl(*ah_setMulticastFilterIndex)(struct ath_hal*,
1393                                 uint32_t index);
1394         HAL_BOOL  __ahdecl(*ah_clrMulticastFilterIndex)(struct ath_hal*,
1395                                 uint32_t index);
1396         uint32_t __ahdecl(*ah_getRxFilter)(struct ath_hal*);
1397         void      __ahdecl(*ah_setRxFilter)(struct ath_hal*, uint32_t);
1398         HAL_BOOL  __ahdecl(*ah_setupRxDesc)(struct ath_hal *, struct ath_desc *,
1399                                 uint32_t size, u_int flags);
1400         HAL_STATUS __ahdecl(*ah_procRxDesc)(struct ath_hal *,
1401                                 struct ath_desc *, uint32_t phyAddr,
1402                                 struct ath_desc *next, uint64_t tsf,
1403                                 struct ath_rx_status *);
1404         void      __ahdecl(*ah_rxMonitor)(struct ath_hal *,
1405                                 const HAL_NODE_STATS *,
1406                                 const struct ieee80211_channel *);
1407         void      __ahdecl(*ah_aniPoll)(struct ath_hal *,
1408                                 const struct ieee80211_channel *);
1409         void      __ahdecl(*ah_procMibEvent)(struct ath_hal *,
1410                                 const HAL_NODE_STATS *);
1411
1412         /* Misc Functions */
1413         HAL_STATUS __ahdecl(*ah_getCapability)(struct ath_hal *,
1414                                 HAL_CAPABILITY_TYPE, uint32_t capability,
1415                                 uint32_t *result);
1416         HAL_BOOL   __ahdecl(*ah_setCapability)(struct ath_hal *,
1417                                 HAL_CAPABILITY_TYPE, uint32_t capability,
1418                                 uint32_t setting, HAL_STATUS *);
1419         HAL_BOOL   __ahdecl(*ah_getDiagState)(struct ath_hal *, int request,
1420                                 const void *args, uint32_t argsize,
1421                                 void **result, uint32_t *resultsize);
1422         void      __ahdecl(*ah_getMacAddress)(struct ath_hal *, uint8_t *);
1423         HAL_BOOL  __ahdecl(*ah_setMacAddress)(struct ath_hal *, const uint8_t*);
1424         void      __ahdecl(*ah_getBssIdMask)(struct ath_hal *, uint8_t *);
1425         HAL_BOOL  __ahdecl(*ah_setBssIdMask)(struct ath_hal *, const uint8_t*);
1426         HAL_BOOL  __ahdecl(*ah_setRegulatoryDomain)(struct ath_hal*,
1427                                 uint16_t, HAL_STATUS *);
1428         void      __ahdecl(*ah_setLedState)(struct ath_hal*, HAL_LED_STATE);
1429         void      __ahdecl(*ah_writeAssocid)(struct ath_hal*,
1430                                 const uint8_t *bssid, uint16_t assocId);
1431         HAL_BOOL  __ahdecl(*ah_gpioCfgOutput)(struct ath_hal *,
1432                                 uint32_t gpio, HAL_GPIO_MUX_TYPE);
1433         HAL_BOOL  __ahdecl(*ah_gpioCfgInput)(struct ath_hal *, uint32_t gpio);
1434         uint32_t __ahdecl(*ah_gpioGet)(struct ath_hal *, uint32_t gpio);
1435         HAL_BOOL  __ahdecl(*ah_gpioSet)(struct ath_hal *,
1436                                 uint32_t gpio, uint32_t val);
1437         void      __ahdecl(*ah_gpioSetIntr)(struct ath_hal*, u_int, uint32_t);
1438         uint32_t __ahdecl(*ah_getTsf32)(struct ath_hal*);
1439         uint64_t __ahdecl(*ah_getTsf64)(struct ath_hal*);
1440         void     __ahdecl(*ah_setTsf64)(struct ath_hal *, uint64_t);
1441         void      __ahdecl(*ah_resetTsf)(struct ath_hal*);
1442         HAL_BOOL  __ahdecl(*ah_detectCardPresent)(struct ath_hal*);
1443         void      __ahdecl(*ah_updateMibCounters)(struct ath_hal*,
1444                                 HAL_MIB_STATS*);
1445         HAL_RFGAIN __ahdecl(*ah_getRfGain)(struct ath_hal*);
1446         u_int     __ahdecl(*ah_getDefAntenna)(struct ath_hal*);
1447         void      __ahdecl(*ah_setDefAntenna)(struct ath_hal*, u_int);
1448         HAL_ANT_SETTING  __ahdecl(*ah_getAntennaSwitch)(struct ath_hal*);
1449         HAL_BOOL  __ahdecl(*ah_setAntennaSwitch)(struct ath_hal*,
1450                                 HAL_ANT_SETTING);
1451         HAL_BOOL  __ahdecl(*ah_setSifsTime)(struct ath_hal*, u_int);
1452         u_int     __ahdecl(*ah_getSifsTime)(struct ath_hal*);
1453         HAL_BOOL  __ahdecl(*ah_setSlotTime)(struct ath_hal*, u_int);
1454         u_int     __ahdecl(*ah_getSlotTime)(struct ath_hal*);
1455         HAL_BOOL  __ahdecl(*ah_setAckTimeout)(struct ath_hal*, u_int);
1456         u_int     __ahdecl(*ah_getAckTimeout)(struct ath_hal*);
1457         HAL_BOOL  __ahdecl(*ah_setAckCTSRate)(struct ath_hal*, u_int);
1458         u_int     __ahdecl(*ah_getAckCTSRate)(struct ath_hal*);
1459         HAL_BOOL  __ahdecl(*ah_setCTSTimeout)(struct ath_hal*, u_int);
1460         u_int     __ahdecl(*ah_getCTSTimeout)(struct ath_hal*);
1461         HAL_BOOL  __ahdecl(*ah_setDecompMask)(struct ath_hal*, uint16_t, int);
1462         void      __ahdecl(*ah_setCoverageClass)(struct ath_hal*, uint8_t, int);
1463         HAL_STATUS      __ahdecl(*ah_setQuiet)(struct ath_hal *ah, uint32_t period,
1464                                 uint32_t duration, uint32_t nextStart,
1465                                 HAL_QUIET_FLAG flag);
1466         void      __ahdecl(*ah_setChainMasks)(struct ath_hal *,
1467                                 uint32_t, uint32_t);
1468
1469         /* DFS functions */
1470         void      __ahdecl(*ah_enableDfs)(struct ath_hal *ah,
1471                                 HAL_PHYERR_PARAM *pe);
1472         void      __ahdecl(*ah_getDfsThresh)(struct ath_hal *ah,
1473                                 HAL_PHYERR_PARAM *pe);
1474         HAL_BOOL  __ahdecl(*ah_getDfsDefaultThresh)(struct ath_hal *ah,
1475                                 HAL_PHYERR_PARAM *pe);
1476         HAL_BOOL  __ahdecl(*ah_procRadarEvent)(struct ath_hal *ah,
1477                                 struct ath_rx_status *rxs, uint64_t fulltsf,
1478                                 const char *buf, HAL_DFS_EVENT *event);
1479         HAL_BOOL  __ahdecl(*ah_isFastClockEnabled)(struct ath_hal *ah);
1480
1481         /* Spectral Scan functions */
1482         void    __ahdecl(*ah_spectralConfigure)(struct ath_hal *ah,
1483                                 HAL_SPECTRAL_PARAM *sp);
1484         void    __ahdecl(*ah_spectralGetConfig)(struct ath_hal *ah,
1485                                 HAL_SPECTRAL_PARAM *sp);
1486         void    __ahdecl(*ah_spectralStart)(struct ath_hal *);
1487         void    __ahdecl(*ah_spectralStop)(struct ath_hal *);
1488         HAL_BOOL        __ahdecl(*ah_spectralIsEnabled)(struct ath_hal *);
1489         HAL_BOOL        __ahdecl(*ah_spectralIsActive)(struct ath_hal *);
1490         /* XXX getNfPri() and getNfExt() */
1491
1492         /* Key Cache Functions */
1493         uint32_t __ahdecl(*ah_getKeyCacheSize)(struct ath_hal*);
1494         HAL_BOOL  __ahdecl(*ah_resetKeyCacheEntry)(struct ath_hal*, uint16_t);
1495         HAL_BOOL  __ahdecl(*ah_isKeyCacheEntryValid)(struct ath_hal *,
1496                                 uint16_t);
1497         HAL_BOOL  __ahdecl(*ah_setKeyCacheEntry)(struct ath_hal*,
1498                                 uint16_t, const HAL_KEYVAL *,
1499                                 const uint8_t *, int);
1500         HAL_BOOL  __ahdecl(*ah_setKeyCacheEntryMac)(struct ath_hal*,
1501                                 uint16_t, const uint8_t *);
1502
1503         /* Power Management Functions */
1504         HAL_BOOL  __ahdecl(*ah_setPowerMode)(struct ath_hal*,
1505                                 HAL_POWER_MODE mode, int setChip);
1506         HAL_POWER_MODE __ahdecl(*ah_getPowerMode)(struct ath_hal*);
1507         int16_t   __ahdecl(*ah_getChanNoise)(struct ath_hal *,
1508                                 const struct ieee80211_channel *);
1509
1510         /* Beacon Management Functions */
1511         void      __ahdecl(*ah_setBeaconTimers)(struct ath_hal*,
1512                                 const HAL_BEACON_TIMERS *);
1513         /* NB: deprecated, use ah_setBeaconTimers instead */
1514         void      __ahdecl(*ah_beaconInit)(struct ath_hal *,
1515                                 uint32_t nexttbtt, uint32_t intval);
1516         void      __ahdecl(*ah_setStationBeaconTimers)(struct ath_hal*,
1517                                 const HAL_BEACON_STATE *);
1518         void      __ahdecl(*ah_resetStationBeaconTimers)(struct ath_hal*);
1519         uint64_t  __ahdecl(*ah_getNextTBTT)(struct ath_hal *);
1520
1521         /* 802.11n Functions */
1522         HAL_BOOL  __ahdecl(*ah_chainTxDesc)(struct ath_hal *,
1523                                 struct ath_desc *,
1524                                 HAL_DMA_ADDR *bufAddrList,
1525                                 uint32_t *segLenList,
1526                                 u_int, u_int, HAL_PKT_TYPE,
1527                                 u_int, HAL_CIPHER, uint8_t, HAL_BOOL,
1528                                 HAL_BOOL, HAL_BOOL);
1529         HAL_BOOL  __ahdecl(*ah_setupFirstTxDesc)(struct ath_hal *,
1530                                 struct ath_desc *, u_int, u_int, u_int,
1531                                 u_int, u_int, u_int, u_int, u_int);
1532         HAL_BOOL  __ahdecl(*ah_setupLastTxDesc)(struct ath_hal *,
1533                                 struct ath_desc *, const struct ath_desc *);
1534         void      __ahdecl(*ah_set11nRateScenario)(struct ath_hal *,
1535                                 struct ath_desc *, u_int, u_int,
1536                                 HAL_11N_RATE_SERIES [], u_int, u_int);
1537
1538         /*
1539          * The next 4 (set11ntxdesc -> set11naggrlast) are specific
1540          * to the EDMA HAL.  Descriptors are chained together by
1541          * using filltxdesc (not ChainTxDesc) and then setting the
1542          * aggregate flags appropriately using first/middle/last.
1543          */
1544         void      __ahdecl(*ah_set11nTxDesc)(struct ath_hal *,
1545                                 void *, u_int, HAL_PKT_TYPE, u_int, u_int,
1546                                 u_int);
1547         void      __ahdecl(*ah_set11nAggrFirst)(struct ath_hal *,
1548                                 struct ath_desc *, u_int, u_int);
1549         void      __ahdecl(*ah_set11nAggrMiddle)(struct ath_hal *,
1550                                 struct ath_desc *, u_int);
1551         void      __ahdecl(*ah_set11nAggrLast)(struct ath_hal *,
1552                                 struct ath_desc *);
1553         void      __ahdecl(*ah_clr11nAggr)(struct ath_hal *,
1554                                 struct ath_desc *);
1555         void      __ahdecl(*ah_set11nBurstDuration)(struct ath_hal *,
1556                                 struct ath_desc *, u_int);
1557         void      __ahdecl(*ah_set11nVirtMoreFrag)(struct ath_hal *,
1558                                 struct ath_desc *, u_int);
1559
1560         HAL_BOOL  __ahdecl(*ah_getMibCycleCounts) (struct ath_hal *,
1561                                 HAL_SURVEY_SAMPLE *);
1562
1563         uint32_t  __ahdecl(*ah_get11nExtBusy)(struct ath_hal *);
1564         void      __ahdecl(*ah_set11nMac2040)(struct ath_hal *,
1565                                 HAL_HT_MACMODE);
1566         HAL_HT_RXCLEAR __ahdecl(*ah_get11nRxClear)(struct ath_hal *ah);
1567         void      __ahdecl(*ah_set11nRxClear)(struct ath_hal *,
1568                                 HAL_HT_RXCLEAR);
1569
1570         /* Interrupt functions */
1571         HAL_BOOL  __ahdecl(*ah_isInterruptPending)(struct ath_hal*);
1572         HAL_BOOL  __ahdecl(*ah_getPendingInterrupts)(struct ath_hal*, HAL_INT*);
1573         HAL_INT   __ahdecl(*ah_getInterrupts)(struct ath_hal*);
1574         HAL_INT   __ahdecl(*ah_setInterrupts)(struct ath_hal*, HAL_INT);
1575
1576         /* Bluetooth Coexistence functions */
1577         void        __ahdecl(*ah_btCoexSetInfo)(struct ath_hal *,
1578                                 HAL_BT_COEX_INFO *);
1579         void        __ahdecl(*ah_btCoexSetConfig)(struct ath_hal *,
1580                                 HAL_BT_COEX_CONFIG *);
1581         void        __ahdecl(*ah_btCoexSetQcuThresh)(struct ath_hal *,
1582                                 int);
1583         void        __ahdecl(*ah_btCoexSetWeights)(struct ath_hal *,
1584                                 uint32_t);
1585         void        __ahdecl(*ah_btCoexSetBmissThresh)(struct ath_hal *,
1586                                 uint32_t);
1587         void        __ahdecl(*ah_btCoexSetParameter)(struct ath_hal *,
1588                                 uint32_t, uint32_t);
1589         void        __ahdecl(*ah_btCoexDisable)(struct ath_hal *);
1590         int         __ahdecl(*ah_btCoexEnable)(struct ath_hal *);
1591
1592         /* Bluetooth MCI methods */
1593         void        __ahdecl(*ah_btMciSetup)(struct ath_hal *,
1594                                 uint32_t, void *, uint16_t, uint32_t);
1595         HAL_BOOL    __ahdecl(*ah_btMciSendMessage)(struct ath_hal *,
1596                                 uint8_t, uint32_t, uint32_t *, uint8_t,
1597                                 HAL_BOOL, HAL_BOOL);
1598         uint32_t    __ahdecl(*ah_btMciGetInterrupt)(struct ath_hal *,
1599                                 uint32_t *, uint32_t *);
1600         uint32_t    __ahdecl(*ah_btMciGetState)(struct ath_hal *,
1601                                 uint32_t, uint32_t *);
1602         void        __ahdecl(*ah_btMciDetach)(struct ath_hal *);
1603
1604         /* LNA diversity configuration */
1605         void        __ahdecl(*ah_divLnaConfGet)(struct ath_hal *,
1606                                 HAL_ANT_COMB_CONFIG *);
1607         void        __ahdecl(*ah_divLnaConfSet)(struct ath_hal *,
1608                                 HAL_ANT_COMB_CONFIG *);
1609 };
1610
1611 /* 
1612  * Check the PCI vendor ID and device ID against Atheros' values
1613  * and return a printable description for any Atheros hardware.
1614  * AH_NULL is returned if the ID's do not describe Atheros hardware.
1615  */
1616 extern  const char *__ahdecl ath_hal_probe(uint16_t vendorid, uint16_t devid);
1617
1618 /*
1619  * Attach the HAL for use with the specified device.  The device is
1620  * defined by the PCI device ID.  The caller provides an opaque pointer
1621  * to an upper-layer data structure (HAL_SOFTC) that is stored in the
1622  * HAL state block for later use.  Hardware register accesses are done
1623  * using the specified bus tag and handle.  On successful return a
1624  * reference to a state block is returned that must be supplied in all
1625  * subsequent HAL calls.  Storage associated with this reference is
1626  * dynamically allocated and must be freed by calling the ah_detach
1627  * method when the client is done.  If the attach operation fails a
1628  * null (AH_NULL) reference will be returned and a status code will
1629  * be returned if the status parameter is non-zero.
1630  */
1631 extern  struct ath_hal * __ahdecl ath_hal_attach(uint16_t devid, HAL_SOFTC,
1632                 HAL_BUS_TAG, HAL_BUS_HANDLE, uint16_t *eepromdata,
1633                 HAL_OPS_CONFIG *ah_config, HAL_STATUS* status);
1634
1635 extern  const char *ath_hal_mac_name(struct ath_hal *);
1636 extern  const char *ath_hal_rf_name(struct ath_hal *);
1637
1638 /*
1639  * Regulatory interfaces.  Drivers should use ath_hal_init_channels to
1640  * request a set of channels for a particular country code and/or
1641  * regulatory domain.  If CTRY_DEFAULT and SKU_NONE are specified then
1642  * this list is constructed according to the contents of the EEPROM.
1643  * ath_hal_getchannels acts similarly but does not alter the operating
1644  * state; this can be used to collect information for a particular
1645  * regulatory configuration.  Finally ath_hal_set_channels installs a
1646  * channel list constructed outside the driver.  The HAL will adopt the
1647  * channel list and setup internal state according to the specified
1648  * regulatory configuration (e.g. conformance test limits).
1649  *
1650  * For all interfaces the channel list is returned in the supplied array.
1651  * maxchans defines the maximum size of this array.  nchans contains the
1652  * actual number of channels returned.  If a problem occurred then a
1653  * status code != HAL_OK is returned.
1654  */
1655 struct ieee80211_channel;
1656
1657 /*
1658  * Return a list of channels according to the specified regulatory.
1659  */
1660 extern  HAL_STATUS __ahdecl ath_hal_getchannels(struct ath_hal *,
1661     struct ieee80211_channel *chans, u_int maxchans, int *nchans,
1662     u_int modeSelect, HAL_CTRY_CODE cc, HAL_REG_DOMAIN regDmn,
1663     HAL_BOOL enableExtendedChannels);
1664
1665 /*
1666  * Return a list of channels and install it as the current operating
1667  * regulatory list.
1668  */
1669 extern  HAL_STATUS __ahdecl ath_hal_init_channels(struct ath_hal *,
1670     struct ieee80211_channel *chans, u_int maxchans, int *nchans,
1671     u_int modeSelect, HAL_CTRY_CODE cc, HAL_REG_DOMAIN rd,
1672     HAL_BOOL enableExtendedChannels);
1673
1674 /*
1675  * Install the list of channels as the current operating regulatory
1676  * and setup related state according to the country code and sku.
1677  */
1678 extern  HAL_STATUS __ahdecl ath_hal_set_channels(struct ath_hal *,
1679     struct ieee80211_channel *chans, int nchans,
1680     HAL_CTRY_CODE cc, HAL_REG_DOMAIN regDmn);
1681
1682 /*
1683  * Fetch the ctl/ext noise floor values reported by a MIMO
1684  * radio. Returns 1 for valid results, 0 for invalid channel.
1685  */
1686 extern int __ahdecl ath_hal_get_mimo_chan_noise(struct ath_hal *ah,
1687     const struct ieee80211_channel *chan, int16_t *nf_ctl,
1688     int16_t *nf_ext);
1689
1690 /*
1691  * Calibrate noise floor data following a channel scan or similar.
1692  * This must be called prior retrieving noise floor data.
1693  */
1694 extern  void __ahdecl ath_hal_process_noisefloor(struct ath_hal *ah);
1695
1696 /*
1697  * Return bit mask of wireless modes supported by the hardware.
1698  */
1699 extern  u_int __ahdecl ath_hal_getwirelessmodes(struct ath_hal*);
1700
1701 /*
1702  * Get the HAL wireless mode for the given channel.
1703  */
1704 extern  int ath_hal_get_curmode(struct ath_hal *ah,
1705     const struct ieee80211_channel *chan);
1706
1707 /*
1708  * Calculate the packet TX time for a legacy or 11n frame
1709  */
1710 extern uint32_t __ahdecl ath_hal_pkt_txtime(struct ath_hal *ah,
1711     const HAL_RATE_TABLE *rates, uint32_t frameLen,
1712     uint16_t rateix, HAL_BOOL isht40, HAL_BOOL shortPreamble);
1713
1714 /*
1715  * Calculate the duration of an 11n frame.
1716  */
1717 extern uint32_t __ahdecl ath_computedur_ht(uint32_t frameLen, uint16_t rate,
1718     int streams, HAL_BOOL isht40, HAL_BOOL isShortGI);
1719
1720 /*
1721  * Calculate the transmit duration of a legacy frame.
1722  */
1723 extern uint16_t __ahdecl ath_hal_computetxtime(struct ath_hal *,
1724                 const HAL_RATE_TABLE *rates, uint32_t frameLen,
1725                 uint16_t rateix, HAL_BOOL shortPreamble);
1726
1727 /*
1728  * Adjust the TSF.
1729  */
1730 extern void __ahdecl ath_hal_adjusttsf(struct ath_hal *ah, int32_t tsfdelta);
1731
1732 /*
1733  * Enable or disable CCA.
1734  */
1735 void __ahdecl ath_hal_setcca(struct ath_hal *ah, int ena);
1736
1737 /*
1738  * Get CCA setting.
1739  */
1740 int __ahdecl ath_hal_getcca(struct ath_hal *ah);
1741
1742 /*
1743  * Read EEPROM data from ah_eepromdata
1744  */
1745 HAL_BOOL __ahdecl ath_hal_EepromDataRead(struct ath_hal *ah,
1746                 u_int off, uint16_t *data);
1747
1748 /*
1749  * For now, simply pass through MFP frames.
1750  */
1751 static inline u_int32_t
1752 ath_hal_get_mfp_qos(struct ath_hal *ah)
1753 {
1754         //return AH_PRIVATE(ah)->ah_mfp_qos;
1755         return HAL_MFP_QOSDATA;
1756 }
1757
1758 #endif /* _ATH_AH_H_ */