xref: /freebsd/sys/dev/ath/if_athvar.h (revision f856af0466c076beef4ea9b15d088e1119a945b8)
1 /*-
2  * Copyright (c) 2002-2006 Sam Leffler, Errno Consulting
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer,
10  *    without modification.
11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13  *    redistribution must be conditioned upon including a substantially
14  *    similar Disclaimer requirement for further binary redistribution.
15  * 3. Neither the names of the above-listed copyright holders nor the names
16  *    of any contributors may be used to endorse or promote products derived
17  *    from this software without specific prior written permission.
18  *
19  * Alternatively, this software may be distributed under the terms of the
20  * GNU General Public License ("GPL") version 2 as published by the Free
21  * Software Foundation.
22  *
23  * NO WARRANTY
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
27  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
28  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
29  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
32  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
34  * THE POSSIBILITY OF SUCH DAMAGES.
35  *
36  * $FreeBSD$
37  */
38 
39 /*
40  * Defintions for the Atheros Wireless LAN controller driver.
41  */
42 #ifndef _DEV_ATH_ATHVAR_H
43 #define _DEV_ATH_ATHVAR_H
44 
45 #include <sys/taskqueue.h>
46 
47 #include <contrib/dev/ath/ah.h>
48 #include <contrib/dev/ath/ah_desc.h>
49 #include <net80211/ieee80211_radiotap.h>
50 #include <dev/ath/if_athioctl.h>
51 #include <dev/ath/if_athrate.h>
52 
53 #define	ATH_TIMEOUT		1000
54 
55 #ifndef ATH_RXBUF
56 #define	ATH_RXBUF	40		/* number of RX buffers */
57 #endif
58 #ifndef ATH_TXBUF
59 #define	ATH_TXBUF	100		/* number of TX buffers */
60 #endif
61 #define	ATH_TXDESC	10		/* number of descriptors per buffer */
62 #define	ATH_TXMAXTRY	11		/* max number of transmit attempts */
63 #define	ATH_TXMGTTRY	4		/* xmit attempts for mgt/ctl frames */
64 #define	ATH_TXINTR_PERIOD 5		/* max number of batched tx descriptors */
65 
66 #define	ATH_BEACON_AIFS_DEFAULT	 0	/* default aifs for ap beacon q */
67 #define	ATH_BEACON_CWMIN_DEFAULT 0	/* default cwmin for ap beacon q */
68 #define	ATH_BEACON_CWMAX_DEFAULT 0	/* default cwmax for ap beacon q */
69 
70 /*
71  * The key cache is used for h/w cipher state and also for
72  * tracking station state such as the current tx antenna.
73  * We also setup a mapping table between key cache slot indices
74  * and station state to short-circuit node lookups on rx.
75  * Different parts have different size key caches.  We handle
76  * up to ATH_KEYMAX entries (could dynamically allocate state).
77  */
78 #define	ATH_KEYMAX	128		/* max key cache size we handle */
79 #define	ATH_KEYBYTES	(ATH_KEYMAX/NBBY)	/* storage space in bytes */
80 
81 /* driver-specific node state */
82 struct ath_node {
83 	struct ieee80211_node an_node;	/* base class */
84 	u_int32_t	an_avgrssi;	/* average rssi over all rx frames */
85 	/* variable-length rate control state follows */
86 };
87 #define	ATH_NODE(ni)	((struct ath_node *)(ni))
88 #define	ATH_NODE_CONST(ni)	((const struct ath_node *)(ni))
89 
90 #define ATH_RSSI_LPF_LEN	10
91 #define ATH_RSSI_DUMMY_MARKER	0x127
92 #define ATH_EP_MUL(x, mul)	((x) * (mul))
93 #define ATH_RSSI_IN(x)		(ATH_EP_MUL((x), HAL_RSSI_EP_MULTIPLIER))
94 #define ATH_LPF_RSSI(x, y, len) \
95     ((x != ATH_RSSI_DUMMY_MARKER) ? (((x) * ((len) - 1) + (y)) / (len)) : (y))
96 #define ATH_RSSI_LPF(x, y) do {						\
97     if ((y) >= -20)							\
98     	x = ATH_LPF_RSSI((x), ATH_RSSI_IN((y)), ATH_RSSI_LPF_LEN);	\
99 } while (0)
100 
101 struct ath_buf {
102 	STAILQ_ENTRY(ath_buf)	bf_list;
103 	int			bf_nseg;
104 	int			bf_flags;	/* tx descriptor flags */
105 	struct ath_desc		*bf_desc;	/* virtual addr of desc */
106 	struct ath_desc_status	bf_status;	/* tx/rx status */
107 	bus_addr_t		bf_daddr;	/* physical addr of desc */
108 	bus_dmamap_t		bf_dmamap;	/* DMA map for mbuf chain */
109 	struct mbuf		*bf_m;		/* mbuf for buf */
110 	struct ieee80211_node	*bf_node;	/* pointer to the node */
111 	bus_size_t		bf_mapsize;
112 #define	ATH_MAX_SCATTER		ATH_TXDESC	/* max(tx,rx,beacon) desc's */
113 	bus_dma_segment_t	bf_segs[ATH_MAX_SCATTER];
114 };
115 typedef STAILQ_HEAD(, ath_buf) ath_bufhead;
116 
117 /*
118  * DMA state for tx/rx descriptors.
119  */
120 struct ath_descdma {
121 	const char*		dd_name;
122 	struct ath_desc		*dd_desc;	/* descriptors */
123 	bus_addr_t		dd_desc_paddr;	/* physical addr of dd_desc */
124 	bus_size_t		dd_desc_len;	/* size of dd_desc */
125 	bus_dma_segment_t	dd_dseg;
126 	bus_dma_tag_t		dd_dmat;	/* bus DMA tag */
127 	bus_dmamap_t		dd_dmamap;	/* DMA map for descriptors */
128 	struct ath_buf		*dd_bufptr;	/* associated buffers */
129 };
130 
131 /*
132  * Data transmit queue state.  One of these exists for each
133  * hardware transmit queue.  Packets sent to us from above
134  * are assigned to queues based on their priority.  Not all
135  * devices support a complete set of hardware transmit queues.
136  * For those devices the array sc_ac2q will map multiple
137  * priorities to fewer hardware queues (typically all to one
138  * hardware queue).
139  */
140 struct ath_txq {
141 	u_int			axq_qnum;	/* hardware q number */
142 	u_int			axq_depth;	/* queue depth (stat only) */
143 	u_int			axq_intrcnt;	/* interrupt count */
144 	u_int32_t		*axq_link;	/* link ptr in last TX desc */
145 	STAILQ_HEAD(, ath_buf)	axq_q;		/* transmit queue */
146 	struct mtx		axq_lock;	/* lock on q and link */
147 	char			axq_name[12];	/* e.g. "ath0_txq4" */
148 };
149 
150 #define	ATH_TXQ_LOCK_INIT(_sc, _tq) do { \
151 	snprintf((_tq)->axq_name, sizeof((_tq)->axq_name), "%s_txq%u", \
152 		device_get_nameunit((_sc)->sc_dev), (_tq)->axq_qnum); \
153 	mtx_init(&(_tq)->axq_lock, (_tq)->axq_name, "ath_txq", MTX_DEF); \
154 } while (0)
155 #define	ATH_TXQ_LOCK_DESTROY(_tq)	mtx_destroy(&(_tq)->axq_lock)
156 #define	ATH_TXQ_LOCK(_tq)		mtx_lock(&(_tq)->axq_lock)
157 #define	ATH_TXQ_UNLOCK(_tq)		mtx_unlock(&(_tq)->axq_lock)
158 #define	ATH_TXQ_LOCK_ASSERT(_tq)	mtx_assert(&(_tq)->axq_lock, MA_OWNED)
159 
160 #define ATH_TXQ_INSERT_TAIL(_tq, _elm, _field) do { \
161 	STAILQ_INSERT_TAIL(&(_tq)->axq_q, (_elm), _field); \
162 	(_tq)->axq_depth++; \
163 } while (0)
164 #define ATH_TXQ_REMOVE_HEAD(_tq, _field) do { \
165 	STAILQ_REMOVE_HEAD(&(_tq)->axq_q, _field); \
166 	(_tq)->axq_depth--; \
167 } while (0)
168 
169 struct taskqueue;
170 struct ath_tx99;
171 
172 struct ath_softc {
173 	struct ifnet		*sc_ifp;	/* interface common */
174 	struct ath_stats	sc_stats;	/* interface statistics */
175 	struct ieee80211com	sc_ic;		/* IEEE 802.11 common */
176 	int			sc_debug;
177 	u_int32_t		sc_countrycode;
178 	u_int32_t		sc_regdomain;
179 	void			(*sc_recv_mgmt)(struct ieee80211com *,
180 					struct mbuf *,
181 					struct ieee80211_node *,
182 					int, int, u_int32_t);
183 	int			(*sc_newstate)(struct ieee80211com *,
184 					enum ieee80211_state, int);
185 	void 			(*sc_node_free)(struct ieee80211_node *);
186 	device_t		sc_dev;
187 	HAL_BUS_TAG		sc_st;		/* bus space tag */
188 	HAL_BUS_HANDLE		sc_sh;		/* bus space handle */
189 	bus_dma_tag_t		sc_dmat;	/* bus DMA tag */
190 	struct mtx		sc_mtx;		/* master lock (recursive) */
191 	struct taskqueue	*sc_tq;		/* private task queue */
192 	struct ath_hal		*sc_ah;		/* Atheros HAL */
193 	struct ath_ratectrl	*sc_rc;		/* tx rate control support */
194 	struct ath_tx99		*sc_tx99;	/* tx99 adjunct state */
195 	void			(*sc_setdefantenna)(struct ath_softc *, u_int);
196 	unsigned int		sc_invalid : 1,	/* disable hardware accesses */
197 				sc_mrretry : 1,	/* multi-rate retry support */
198 				sc_softled : 1,	/* enable LED gpio status */
199 				sc_splitmic: 1,	/* split TKIP MIC keys */
200 				sc_needmib : 1,	/* enable MIB stats intr */
201 				sc_diversity : 1,/* enable rx diversity */
202 				sc_hasveol : 1,	/* tx VEOL support */
203 				sc_ledstate: 1,	/* LED on/off state */
204 				sc_blinking: 1,	/* LED blink operation active */
205 				sc_mcastkey: 1,	/* mcast key cache search */
206 				sc_syncbeacon:1,/* sync/resync beacon timers */
207 				sc_hasclrkey:1,	/* CLR key supported */
208 				sc_xchanmode: 1,/* extended channel mode */
209 				sc_outdoor  : 1;/* outdoor operation */
210 						/* rate tables */
211 #define	IEEE80211_MODE_11A_HALF		(IEEE80211_MODE_MAX+0)
212 #define	IEEE80211_MODE_11A_QUARTER	(IEEE80211_MODE_MAX+1)
213 	const HAL_RATE_TABLE	*sc_rates[IEEE80211_MODE_MAX+2];
214 	const HAL_RATE_TABLE	*sc_currates;	/* current rate table */
215 	enum ieee80211_phymode	sc_curmode;	/* current phy mode */
216 	HAL_OPMODE		sc_opmode;	/* current operating mode */
217 	u_int16_t		sc_curtxpow;	/* current tx power limit */
218 	HAL_CHANNEL		sc_curchan;	/* current h/w channel */
219 	u_int8_t		sc_rixmap[256];	/* IEEE to h/w rate table ix */
220 	struct {
221 		u_int8_t	ieeerate;	/* IEEE rate */
222 		u_int8_t	rxflags;	/* radiotap rx flags */
223 		u_int8_t	txflags;	/* radiotap tx flags */
224 		u_int16_t	ledon;		/* softled on time */
225 		u_int16_t	ledoff;		/* softled off time */
226 	} sc_hwmap[32];				/* h/w rate ix mappings */
227 	u_int8_t		sc_minrateix;	/* min h/w rate index */
228 	u_int8_t		sc_mcastrix;	/* mcast h/w rate index */
229 	u_int8_t		sc_protrix;	/* protection rate index */
230 	u_int			sc_mcastrate;	/* ieee rate for mcastrateix */
231 	u_int			sc_txantenna;	/* tx antenna (fixed or auto) */
232 	HAL_INT			sc_imask;	/* interrupt mask copy */
233 	u_int			sc_keymax;	/* size of key cache */
234 	u_int8_t		sc_keymap[ATH_KEYBYTES];/* key use bit map */
235 
236 	u_int			sc_ledpin;	/* GPIO pin for driving LED */
237 	u_int			sc_ledon;	/* pin setting for LED on */
238 	u_int			sc_ledidle;	/* idle polling interval */
239 	int			sc_ledevent;	/* time of last LED event */
240 	u_int8_t		sc_rxrate;	/* current rx rate for LED */
241 	u_int8_t		sc_txrate;	/* current tx rate for LED */
242 	u_int16_t		sc_ledoff;	/* off time for current blink */
243 	struct callout		sc_ledtimer;	/* led off timer */
244 
245 	u_int			sc_rfsilentpin;	/* GPIO pin for rfkill int */
246 	u_int			sc_rfsilentpol;	/* pin setting for rfkill on */
247 
248 	struct bpf_if		*sc_drvbpf;
249 	union {
250 		struct ath_tx_radiotap_header th;
251 		u_int8_t	pad[64];
252 	} u_tx_rt;
253 	int			sc_tx_th_len;
254 	union {
255 		struct ath_rx_radiotap_header th;
256 		u_int8_t	pad[64];
257 	} u_rx_rt;
258 	int			sc_rx_th_len;
259 	u_int			sc_monpass;	/* frames to pass in mon.mode */
260 
261 	struct ath_descdma	sc_rxdma;	/* RX descriptos */
262 	ath_bufhead		sc_rxbuf;	/* receive buffer */
263 	u_int32_t		*sc_rxlink;	/* link ptr in last RX desc */
264 	struct task		sc_rxtask;	/* rx int processing */
265 	struct task		sc_rxorntask;	/* rxorn int processing */
266 	u_int8_t		sc_defant;	/* current default antenna */
267 	u_int8_t		sc_rxotherant;	/* rx's on non-default antenna*/
268 	u_int64_t		sc_lastrx;	/* tsf at last rx'd frame */
269 
270 	struct ath_descdma	sc_txdma;	/* TX descriptors */
271 	ath_bufhead		sc_txbuf;	/* transmit buffer */
272 	struct mtx		sc_txbuflock;	/* txbuf lock */
273 	char			sc_txname[12];	/* e.g. "ath0_buf" */
274 	int			sc_tx_timer;	/* transmit timeout */
275 	u_int			sc_txqsetup;	/* h/w queues setup */
276 	u_int			sc_txintrperiod;/* tx interrupt batching */
277 	struct ath_txq		sc_txq[HAL_NUM_TX_QUEUES];
278 	struct ath_txq		*sc_ac2q[5];	/* WME AC -> h/w q map */
279 	struct task		sc_txtask;	/* tx int processing */
280 
281 	struct ath_descdma	sc_bdma;	/* beacon descriptors */
282 	ath_bufhead		sc_bbuf;	/* beacon buffers */
283 	u_int			sc_bhalq;	/* HAL q for outgoing beacons */
284 	u_int			sc_bmisscount;	/* missed beacon transmits */
285 	u_int32_t		sc_ant_tx[8];	/* recent tx frames/antenna */
286 	struct ath_txq		*sc_cabq;	/* tx q for cab frames */
287 	struct ieee80211_beacon_offsets sc_boff;/* dynamic update state */
288 	struct task		sc_bmisstask;	/* bmiss int processing */
289 	struct task		sc_bstucktask;	/* stuck beacon processing */
290 	enum {
291 		OK,				/* no change needed */
292 		UPDATE,				/* update pending */
293 		COMMIT				/* beacon sent, commit change */
294 	} sc_updateslot;			/* slot time update fsm */
295 	struct ath_txq		sc_mcastq;	/* mcast xmits w/ ps sta's */
296 
297 	struct callout		sc_cal_ch;	/* callout handle for cals */
298 	int			sc_calinterval;	/* current polling interval */
299 	int			sc_caltries;	/* cals at current interval */
300 	HAL_NODE_STATS		sc_halstats;	/* station-mode rssi stats */
301 	struct callout		sc_scan_ch;	/* callout handle for scan */
302 	struct callout		sc_dfs_ch;	/* callout handle for dfs */
303 };
304 #define	sc_tx_th		u_tx_rt.th
305 #define	sc_rx_th		u_rx_rt.th
306 
307 #define	ATH_LOCK_INIT(_sc) \
308 	mtx_init(&(_sc)->sc_mtx, device_get_nameunit((_sc)->sc_dev), \
309 		 MTX_NETWORK_LOCK, MTX_DEF | MTX_RECURSE)
310 #define	ATH_LOCK_DESTROY(_sc)	mtx_destroy(&(_sc)->sc_mtx)
311 #define	ATH_LOCK(_sc)		mtx_lock(&(_sc)->sc_mtx)
312 #define	ATH_UNLOCK(_sc)		mtx_unlock(&(_sc)->sc_mtx)
313 #define	ATH_LOCK_ASSERT(_sc)	mtx_assert(&(_sc)->sc_mtx, MA_OWNED)
314 
315 #define	ATH_TXQ_SETUP(sc, i)	((sc)->sc_txqsetup & (1<<i))
316 
317 #define	ATH_TXBUF_LOCK_INIT(_sc) do { \
318 	snprintf((_sc)->sc_txname, sizeof((_sc)->sc_txname), "%s_buf", \
319 		device_get_nameunit((_sc)->sc_dev)); \
320 	mtx_init(&(_sc)->sc_txbuflock, (_sc)->sc_txname, "ath_buf", MTX_DEF); \
321 } while (0)
322 #define	ATH_TXBUF_LOCK_DESTROY(_sc)	mtx_destroy(&(_sc)->sc_txbuflock)
323 #define	ATH_TXBUF_LOCK(_sc)		mtx_lock(&(_sc)->sc_txbuflock)
324 #define	ATH_TXBUF_UNLOCK(_sc)		mtx_unlock(&(_sc)->sc_txbuflock)
325 #define	ATH_TXBUF_LOCK_ASSERT(_sc) \
326 	mtx_assert(&(_sc)->sc_txbuflock, MA_OWNED)
327 
328 int	ath_attach(u_int16_t, struct ath_softc *);
329 int	ath_detach(struct ath_softc *);
330 void	ath_resume(struct ath_softc *);
331 void	ath_suspend(struct ath_softc *);
332 void	ath_shutdown(struct ath_softc *);
333 void	ath_intr(void *);
334 
335 /*
336  * HAL definitions to comply with local coding convention.
337  */
338 #define	ath_hal_detach(_ah) \
339 	((*(_ah)->ah_detach)((_ah)))
340 #define	ath_hal_reset(_ah, _opmode, _chan, _outdoor, _pstatus) \
341 	((*(_ah)->ah_reset)((_ah), (_opmode), (_chan), (_outdoor), (_pstatus)))
342 #define	ath_hal_getratetable(_ah, _mode) \
343 	((*(_ah)->ah_getRateTable)((_ah), (_mode)))
344 #define	ath_hal_getmac(_ah, _mac) \
345 	((*(_ah)->ah_getMacAddress)((_ah), (_mac)))
346 #define	ath_hal_setmac(_ah, _mac) \
347 	((*(_ah)->ah_setMacAddress)((_ah), (_mac)))
348 #define	ath_hal_intrset(_ah, _mask) \
349 	((*(_ah)->ah_setInterrupts)((_ah), (_mask)))
350 #define	ath_hal_intrget(_ah) \
351 	((*(_ah)->ah_getInterrupts)((_ah)))
352 #define	ath_hal_intrpend(_ah) \
353 	((*(_ah)->ah_isInterruptPending)((_ah)))
354 #define	ath_hal_getisr(_ah, _pmask) \
355 	((*(_ah)->ah_getPendingInterrupts)((_ah), (_pmask)))
356 #define	ath_hal_updatetxtriglevel(_ah, _inc) \
357 	((*(_ah)->ah_updateTxTrigLevel)((_ah), (_inc)))
358 #define	ath_hal_setpower(_ah, _mode) \
359 	((*(_ah)->ah_setPowerMode)((_ah), (_mode), AH_TRUE))
360 #define	ath_hal_keycachesize(_ah) \
361 	((*(_ah)->ah_getKeyCacheSize)((_ah)))
362 #define	ath_hal_keyreset(_ah, _ix) \
363 	((*(_ah)->ah_resetKeyCacheEntry)((_ah), (_ix)))
364 #define	ath_hal_keyset(_ah, _ix, _pk, _mac) \
365 	((*(_ah)->ah_setKeyCacheEntry)((_ah), (_ix), (_pk), (_mac), AH_FALSE))
366 #define	ath_hal_keyisvalid(_ah, _ix) \
367 	(((*(_ah)->ah_isKeyCacheEntryValid)((_ah), (_ix))))
368 #define	ath_hal_keysetmac(_ah, _ix, _mac) \
369 	((*(_ah)->ah_setKeyCacheEntryMac)((_ah), (_ix), (_mac)))
370 #define	ath_hal_getrxfilter(_ah) \
371 	((*(_ah)->ah_getRxFilter)((_ah)))
372 #define	ath_hal_setrxfilter(_ah, _filter) \
373 	((*(_ah)->ah_setRxFilter)((_ah), (_filter)))
374 #define	ath_hal_setmcastfilter(_ah, _mfilt0, _mfilt1) \
375 	((*(_ah)->ah_setMulticastFilter)((_ah), (_mfilt0), (_mfilt1)))
376 #define	ath_hal_waitforbeacon(_ah, _bf) \
377 	((*(_ah)->ah_waitForBeaconDone)((_ah), (_bf)->bf_daddr))
378 #define	ath_hal_putrxbuf(_ah, _bufaddr) \
379 	((*(_ah)->ah_setRxDP)((_ah), (_bufaddr)))
380 #define	ath_hal_gettsf32(_ah) \
381 	((*(_ah)->ah_getTsf32)((_ah)))
382 #define	ath_hal_gettsf64(_ah) \
383 	((*(_ah)->ah_getTsf64)((_ah)))
384 #define	ath_hal_resettsf(_ah) \
385 	((*(_ah)->ah_resetTsf)((_ah)))
386 #define	ath_hal_rxena(_ah) \
387 	((*(_ah)->ah_enableReceive)((_ah)))
388 #define	ath_hal_puttxbuf(_ah, _q, _bufaddr) \
389 	((*(_ah)->ah_setTxDP)((_ah), (_q), (_bufaddr)))
390 #define	ath_hal_gettxbuf(_ah, _q) \
391 	((*(_ah)->ah_getTxDP)((_ah), (_q)))
392 #define	ath_hal_numtxpending(_ah, _q) \
393 	((*(_ah)->ah_numTxPending)((_ah), (_q)))
394 #define	ath_hal_getrxbuf(_ah) \
395 	((*(_ah)->ah_getRxDP)((_ah)))
396 #define	ath_hal_txstart(_ah, _q) \
397 	((*(_ah)->ah_startTxDma)((_ah), (_q)))
398 #define	ath_hal_setchannel(_ah, _chan) \
399 	((*(_ah)->ah_setChannel)((_ah), (_chan)))
400 #define	ath_hal_calibrate(_ah, _chan, _iqcal) \
401 	((*(_ah)->ah_perCalibration)((_ah), (_chan), (_iqcal)))
402 #define	ath_hal_setledstate(_ah, _state) \
403 	((*(_ah)->ah_setLedState)((_ah), (_state)))
404 #define	ath_hal_beaconinit(_ah, _nextb, _bperiod) \
405 	((*(_ah)->ah_beaconInit)((_ah), (_nextb), (_bperiod)))
406 #define	ath_hal_beaconreset(_ah) \
407 	((*(_ah)->ah_resetStationBeaconTimers)((_ah)))
408 #define	ath_hal_beacontimers(_ah, _bs) \
409 	((*(_ah)->ah_setStationBeaconTimers)((_ah), (_bs)))
410 #define	ath_hal_setassocid(_ah, _bss, _associd) \
411 	((*(_ah)->ah_writeAssocid)((_ah), (_bss), (_associd)))
412 #define	ath_hal_phydisable(_ah) \
413 	((*(_ah)->ah_phyDisable)((_ah)))
414 #define	ath_hal_setopmode(_ah) \
415 	((*(_ah)->ah_setPCUConfig)((_ah)))
416 #define	ath_hal_stoptxdma(_ah, _qnum) \
417 	((*(_ah)->ah_stopTxDma)((_ah), (_qnum)))
418 #define	ath_hal_stoppcurecv(_ah) \
419 	((*(_ah)->ah_stopPcuReceive)((_ah)))
420 #define	ath_hal_startpcurecv(_ah) \
421 	((*(_ah)->ah_startPcuReceive)((_ah)))
422 #define	ath_hal_stopdmarecv(_ah) \
423 	((*(_ah)->ah_stopDmaReceive)((_ah)))
424 #define	ath_hal_getdiagstate(_ah, _id, _indata, _insize, _outdata, _outsize) \
425 	((*(_ah)->ah_getDiagState)((_ah), (_id), \
426 		(_indata), (_insize), (_outdata), (_outsize)))
427 #define	ath_hal_getfatalstate(_ah, _outdata, _outsize) \
428 	ath_hal_getdiagstate(_ah, 29, NULL, 0, (void **)(_outdata), _outsize)
429 #define	ath_hal_setuptxqueue(_ah, _type, _irq) \
430 	((*(_ah)->ah_setupTxQueue)((_ah), (_type), (_irq)))
431 #define	ath_hal_resettxqueue(_ah, _q) \
432 	((*(_ah)->ah_resetTxQueue)((_ah), (_q)))
433 #define	ath_hal_releasetxqueue(_ah, _q) \
434 	((*(_ah)->ah_releaseTxQueue)((_ah), (_q)))
435 #define	ath_hal_gettxqueueprops(_ah, _q, _qi) \
436 	((*(_ah)->ah_getTxQueueProps)((_ah), (_q), (_qi)))
437 #define	ath_hal_settxqueueprops(_ah, _q, _qi) \
438 	((*(_ah)->ah_setTxQueueProps)((_ah), (_q), (_qi)))
439 #define	ath_hal_getrfgain(_ah) \
440 	((*(_ah)->ah_getRfGain)((_ah)))
441 #define	ath_hal_getdefantenna(_ah) \
442 	((*(_ah)->ah_getDefAntenna)((_ah)))
443 #define	ath_hal_setdefantenna(_ah, _ant) \
444 	((*(_ah)->ah_setDefAntenna)((_ah), (_ant)))
445 #define	ath_hal_rxmonitor(_ah, _arg, _chan) \
446 	((*(_ah)->ah_rxMonitor)((_ah), (_arg), (_chan)))
447 #define	ath_hal_mibevent(_ah, _stats) \
448 	((*(_ah)->ah_procMibEvent)((_ah), (_stats)))
449 #define	ath_hal_setslottime(_ah, _us) \
450 	((*(_ah)->ah_setSlotTime)((_ah), (_us)))
451 #define	ath_hal_getslottime(_ah) \
452 	((*(_ah)->ah_getSlotTime)((_ah)))
453 #define	ath_hal_setacktimeout(_ah, _us) \
454 	((*(_ah)->ah_setAckTimeout)((_ah), (_us)))
455 #define	ath_hal_getacktimeout(_ah) \
456 	((*(_ah)->ah_getAckTimeout)((_ah)))
457 #define	ath_hal_setctstimeout(_ah, _us) \
458 	((*(_ah)->ah_setCTSTimeout)((_ah), (_us)))
459 #define	ath_hal_getctstimeout(_ah) \
460 	((*(_ah)->ah_getCTSTimeout)((_ah)))
461 #define	ath_hal_getcapability(_ah, _cap, _param, _result) \
462 	((*(_ah)->ah_getCapability)((_ah), (_cap), (_param), (_result)))
463 #define	ath_hal_setcapability(_ah, _cap, _param, _v, _status) \
464 	((*(_ah)->ah_setCapability)((_ah), (_cap), (_param), (_v), (_status)))
465 #define	ath_hal_ciphersupported(_ah, _cipher) \
466 	(ath_hal_getcapability(_ah, HAL_CAP_CIPHER, _cipher, NULL) == HAL_OK)
467 #define	ath_hal_getregdomain(_ah, _prd) \
468 	(ath_hal_getcapability(_ah, HAL_CAP_REG_DMN, 0, (_prd)) == HAL_OK)
469 #define	ath_hal_setregdomain(_ah, _rd) \
470 	((*(_ah)->ah_setRegulatoryDomain)((_ah), (_rd), NULL))
471 #define	ath_hal_getcountrycode(_ah, _pcc) \
472 	(*(_pcc) = (_ah)->ah_countryCode)
473 #define	ath_hal_hastkipsplit(_ah) \
474 	(ath_hal_getcapability(_ah, HAL_CAP_TKIP_SPLIT, 0, NULL) == HAL_OK)
475 #define	ath_hal_gettkipsplit(_ah) \
476 	(ath_hal_getcapability(_ah, HAL_CAP_TKIP_SPLIT, 1, NULL) == HAL_OK)
477 #define	ath_hal_settkipsplit(_ah, _v) \
478 	ath_hal_setcapability(_ah, HAL_CAP_TKIP_SPLIT, 1, _v, NULL)
479 #define	ath_hal_hwphycounters(_ah) \
480 	(ath_hal_getcapability(_ah, HAL_CAP_PHYCOUNTERS, 0, NULL) == HAL_OK)
481 #define	ath_hal_hasdiversity(_ah) \
482 	(ath_hal_getcapability(_ah, HAL_CAP_DIVERSITY, 0, NULL) == HAL_OK)
483 #define	ath_hal_getdiversity(_ah) \
484 	(ath_hal_getcapability(_ah, HAL_CAP_DIVERSITY, 1, NULL) == HAL_OK)
485 #define	ath_hal_setdiversity(_ah, _v) \
486 	ath_hal_setcapability(_ah, HAL_CAP_DIVERSITY, 1, _v, NULL)
487 #define	ath_hal_getdiag(_ah, _pv) \
488 	(ath_hal_getcapability(_ah, HAL_CAP_DIAG, 0, _pv) == HAL_OK)
489 #define	ath_hal_setdiag(_ah, _v) \
490 	ath_hal_setcapability(_ah, HAL_CAP_DIAG, 0, _v, NULL)
491 #define	ath_hal_getnumtxqueues(_ah, _pv) \
492 	(ath_hal_getcapability(_ah, HAL_CAP_NUM_TXQUEUES, 0, _pv) == HAL_OK)
493 #define	ath_hal_hasveol(_ah) \
494 	(ath_hal_getcapability(_ah, HAL_CAP_VEOL, 0, NULL) == HAL_OK)
495 #define	ath_hal_hastxpowlimit(_ah) \
496 	(ath_hal_getcapability(_ah, HAL_CAP_TXPOW, 0, NULL) == HAL_OK)
497 #define	ath_hal_settxpowlimit(_ah, _pow) \
498 	((*(_ah)->ah_setTxPowerLimit)((_ah), (_pow)))
499 #define	ath_hal_gettxpowlimit(_ah, _ppow) \
500 	(ath_hal_getcapability(_ah, HAL_CAP_TXPOW, 1, _ppow) == HAL_OK)
501 #define	ath_hal_getmaxtxpow(_ah, _ppow) \
502 	(ath_hal_getcapability(_ah, HAL_CAP_TXPOW, 2, _ppow) == HAL_OK)
503 #define	ath_hal_gettpscale(_ah, _scale) \
504 	(ath_hal_getcapability(_ah, HAL_CAP_TXPOW, 3, _scale) == HAL_OK)
505 #define	ath_hal_settpscale(_ah, _v) \
506 	ath_hal_setcapability(_ah, HAL_CAP_TXPOW, 3, _v, NULL)
507 #define	ath_hal_hastpc(_ah) \
508 	(ath_hal_getcapability(_ah, HAL_CAP_TPC, 0, NULL) == HAL_OK)
509 #define	ath_hal_gettpc(_ah) \
510 	(ath_hal_getcapability(_ah, HAL_CAP_TPC, 1, NULL) == HAL_OK)
511 #define	ath_hal_settpc(_ah, _v) \
512 	ath_hal_setcapability(_ah, HAL_CAP_TPC, 1, _v, NULL)
513 #define	ath_hal_hasbursting(_ah) \
514 	(ath_hal_getcapability(_ah, HAL_CAP_BURST, 0, NULL) == HAL_OK)
515 #ifdef notyet
516 #define	ath_hal_hasmcastkeysearch(_ah) \
517 	(ath_hal_getcapability(_ah, HAL_CAP_MCAST_KEYSRCH, 0, NULL) == HAL_OK)
518 #define	ath_hal_getmcastkeysearch(_ah) \
519 	(ath_hal_getcapability(_ah, HAL_CAP_MCAST_KEYSRCH, 1, NULL) == HAL_OK)
520 #else
521 #define	ath_hal_getmcastkeysearch(_ah)	0
522 #endif
523 #define	ath_hal_hasrfsilent(_ah) \
524 	(ath_hal_getcapability(_ah, HAL_CAP_RFSILENT, 0, NULL) == HAL_OK)
525 #define	ath_hal_getrfkill(_ah) \
526 	(ath_hal_getcapability(_ah, HAL_CAP_RFSILENT, 1, NULL) == HAL_OK)
527 #define	ath_hal_setrfkill(_ah, _onoff) \
528 	ath_hal_setcapability(_ah, HAL_CAP_RFSILENT, 1, _onoff, NULL)
529 #define	ath_hal_getrfsilent(_ah, _prfsilent) \
530 	(ath_hal_getcapability(_ah, HAL_CAP_RFSILENT, 2, _prfsilent) == HAL_OK)
531 #define	ath_hal_setrfsilent(_ah, _rfsilent) \
532 	ath_hal_setcapability(_ah, HAL_CAP_RFSILENT, 2, _rfsilent, NULL)
533 #define	ath_hal_gettpack(_ah, _ptpack) \
534 	(ath_hal_getcapability(_ah, HAL_CAP_TPC_ACK, 0, _ptpack) == HAL_OK)
535 #define	ath_hal_settpack(_ah, _tpack) \
536 	ath_hal_setcapability(_ah, HAL_CAP_TPC_ACK, 0, _tpack, NULL)
537 #define	ath_hal_gettpcts(_ah, _ptpcts) \
538 	(ath_hal_getcapability(_ah, HAL_CAP_TPC_CTS, 0, _ptpcts) == HAL_OK)
539 #define	ath_hal_settpcts(_ah, _tpcts) \
540 	ath_hal_setcapability(_ah, HAL_CAP_TPC_CTS, 0, _tpcts, NULL)
541 #if HAL_ABI_VERSION < 0x05120700
542 #define	ath_hal_process_noisefloor(_ah)
543 #define	ath_hal_getchannoise(_ah, _c)	(-96)
544 #define	HAL_CAP_TPC_ACK	100
545 #define	HAL_CAP_TPC_CTS	101
546 #else
547 #define	ath_hal_getchannoise(_ah, _c) \
548 	((*(_ah)->ah_getChanNoise)((_ah), (_c)))
549 #endif
550 #if HAL_ABI_VERSION < 0x05122200
551 #define	HAL_TXQ_TXOKINT_ENABLE	TXQ_FLAG_TXOKINT_ENABLE
552 #define	HAL_TXQ_TXERRINT_ENABLE	TXQ_FLAG_TXERRINT_ENABLE
553 #define	HAL_TXQ_TXDESCINT_ENABLE TXQ_FLAG_TXDESCINT_ENABLE
554 #define	HAL_TXQ_TXEOLINT_ENABLE	TXQ_FLAG_TXEOLINT_ENABLE
555 #define	HAL_TXQ_TXURNINT_ENABLE	TXQ_FLAG_TXURNINT_ENABLE
556 #endif
557 #if HAL_ABI_VERSION < 0x06102501
558 #define	ath_hal_ispublicsafetysku(ah) \
559 	(((ah)->ah_regdomain == 0 && (ah)->ah_countryCode == 842) || \
560 	 (ah)->ah_regdomain == 0x12)
561 #endif
562 
563 #define	ath_hal_setuprxdesc(_ah, _ds, _size, _intreq) \
564 	((*(_ah)->ah_setupRxDesc)((_ah), (_ds), (_size), (_intreq)))
565 #define	ath_hal_rxprocdesc(_ah, _ds, _dspa, _dsnext, _rs) \
566 	((*(_ah)->ah_procRxDesc)((_ah), (_ds), (_dspa), (_dsnext), 0, (_rs)))
567 #define	ath_hal_setuptxdesc(_ah, _ds, _plen, _hlen, _atype, _txpow, \
568 		_txr0, _txtr0, _keyix, _ant, _flags, \
569 		_rtsrate, _rtsdura) \
570 	((*(_ah)->ah_setupTxDesc)((_ah), (_ds), (_plen), (_hlen), (_atype), \
571 		(_txpow), (_txr0), (_txtr0), (_keyix), (_ant), \
572 		(_flags), (_rtsrate), (_rtsdura), 0, 0, 0))
573 #define	ath_hal_setupxtxdesc(_ah, _ds, \
574 		_txr1, _txtr1, _txr2, _txtr2, _txr3, _txtr3) \
575 	((*(_ah)->ah_setupXTxDesc)((_ah), (_ds), \
576 		(_txr1), (_txtr1), (_txr2), (_txtr2), (_txr3), (_txtr3)))
577 #define	ath_hal_filltxdesc(_ah, _ds, _l, _first, _last, _ds0) \
578 	((*(_ah)->ah_fillTxDesc)((_ah), (_ds), (_l), (_first), (_last), (_ds0)))
579 #define	ath_hal_txprocdesc(_ah, _ds, _ts) \
580 	((*(_ah)->ah_procTxDesc)((_ah), (_ds), (_ts)))
581 #define	ath_hal_gettxintrtxqs(_ah, _txqs) \
582 	((*(_ah)->ah_getTxIntrQueue)((_ah), (_txqs)))
583 
584 #define ath_hal_gpioCfgOutput(_ah, _gpio) \
585         ((*(_ah)->ah_gpioCfgOutput)((_ah), (_gpio)))
586 #define ath_hal_gpioset(_ah, _gpio, _b) \
587         ((*(_ah)->ah_gpioSet)((_ah), (_gpio), (_b)))
588 #define ath_hal_gpioget(_ah, _gpio) \
589         ((*(_ah)->ah_gpioGet)((_ah), (_gpio)))
590 #define ath_hal_gpiosetintr(_ah, _gpio, _b) \
591         ((*(_ah)->ah_gpioSetIntr)((_ah), (_gpio), (_b)))
592 
593 #define ath_hal_radar_wait(_ah, _chan) \
594 	((*(_ah)->ah_radarWait)((_ah), (_chan)))
595 
596 #endif /* _DEV_ATH_ATHVAR_H */
597