xref: /freebsd/sys/dev/ath/if_athvar.h (revision 54ebdd631db8c0bba2baab0155f603a8b5cf014a)
1 /*-
2  * Copyright (c) 2002-2008 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  *
16  * NO WARRANTY
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
22  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
27  * THE POSSIBILITY OF SUCH DAMAGES.
28  *
29  * $FreeBSD$
30  */
31 
32 /*
33  * Defintions for the Atheros Wireless LAN controller driver.
34  */
35 #ifndef _DEV_ATH_ATHVAR_H
36 #define _DEV_ATH_ATHVAR_H
37 
38 #include <dev/ath/ath_hal/ah.h>
39 #include <dev/ath/ath_hal/ah_desc.h>
40 #include <net80211/ieee80211_radiotap.h>
41 #include <dev/ath/if_athioctl.h>
42 #include <dev/ath/if_athrate.h>
43 
44 #define	ATH_TIMEOUT		1000
45 
46 #ifndef ATH_RXBUF
47 #define	ATH_RXBUF	40		/* number of RX buffers */
48 #endif
49 #ifndef ATH_TXBUF
50 #define	ATH_TXBUF	200		/* number of TX buffers */
51 #endif
52 #define	ATH_BCBUF	4		/* number of beacon buffers */
53 
54 #define	ATH_TXDESC	10		/* number of descriptors per buffer */
55 #define	ATH_TXMAXTRY	11		/* max number of transmit attempts */
56 #define	ATH_TXMGTTRY	4		/* xmit attempts for mgt/ctl frames */
57 #define	ATH_TXINTR_PERIOD 5		/* max number of batched tx descriptors */
58 
59 #define	ATH_BEACON_AIFS_DEFAULT	 0	/* default aifs for ap beacon q */
60 #define	ATH_BEACON_CWMIN_DEFAULT 0	/* default cwmin for ap beacon q */
61 #define	ATH_BEACON_CWMAX_DEFAULT 0	/* default cwmax for ap beacon q */
62 
63 /*
64  * The key cache is used for h/w cipher state and also for
65  * tracking station state such as the current tx antenna.
66  * We also setup a mapping table between key cache slot indices
67  * and station state to short-circuit node lookups on rx.
68  * Different parts have different size key caches.  We handle
69  * up to ATH_KEYMAX entries (could dynamically allocate state).
70  */
71 #define	ATH_KEYMAX	128		/* max key cache size we handle */
72 #define	ATH_KEYBYTES	(ATH_KEYMAX/NBBY)	/* storage space in bytes */
73 
74 #define	ATH_FF_TXQMIN	2		/* min txq depth for staging */
75 #define	ATH_FF_TXQMAX	50		/* maximum # of queued frames allowed */
76 #define	ATH_FF_STAGEMAX	5		/* max waiting period for staged frame*/
77 
78 struct taskqueue;
79 struct kthread;
80 struct ath_buf;
81 
82 /* driver-specific node state */
83 struct ath_node {
84 	struct ieee80211_node an_node;	/* base class */
85 	u_int8_t	an_mgmtrix;	/* min h/w rate index */
86 	u_int8_t	an_mcastrix;	/* mcast h/w rate index */
87 	struct ath_buf	*an_ff_buf[WME_NUM_AC]; /* ff staging area */
88 	/* variable-length rate control state follows */
89 };
90 #define	ATH_NODE(ni)	((struct ath_node *)(ni))
91 #define	ATH_NODE_CONST(ni)	((const struct ath_node *)(ni))
92 
93 #define ATH_RSSI_LPF_LEN	10
94 #define ATH_RSSI_DUMMY_MARKER	0x127
95 #define ATH_EP_MUL(x, mul)	((x) * (mul))
96 #define ATH_RSSI_IN(x)		(ATH_EP_MUL((x), HAL_RSSI_EP_MULTIPLIER))
97 #define ATH_LPF_RSSI(x, y, len) \
98     ((x != ATH_RSSI_DUMMY_MARKER) ? (((x) * ((len) - 1) + (y)) / (len)) : (y))
99 #define ATH_RSSI_LPF(x, y) do {						\
100     if ((y) >= -20)							\
101     	x = ATH_LPF_RSSI((x), ATH_RSSI_IN((y)), ATH_RSSI_LPF_LEN);	\
102 } while (0)
103 #define	ATH_EP_RND(x,mul) \
104 	((((x)%(mul)) >= ((mul)/2)) ? ((x) + ((mul) - 1)) / (mul) : (x)/(mul))
105 #define	ATH_RSSI(x)		ATH_EP_RND(x, HAL_RSSI_EP_MULTIPLIER)
106 
107 struct ath_buf {
108 	STAILQ_ENTRY(ath_buf)	bf_list;
109 	TAILQ_ENTRY(ath_buf)	bf_stagelist;	/* stage queue list */
110 	u_int32_t		bf_age;		/* age when placed on stageq */
111 	int			bf_nseg;
112 	int			bf_txflags;	/* tx descriptor flags */
113 	struct ath_desc		*bf_desc;	/* virtual addr of desc */
114 	struct ath_desc_status	bf_status;	/* tx/rx status */
115 	bus_addr_t		bf_daddr;	/* physical addr of desc */
116 	bus_dmamap_t		bf_dmamap;	/* DMA map for mbuf chain */
117 	struct mbuf		*bf_m;		/* mbuf for buf */
118 	struct ieee80211_node	*bf_node;	/* pointer to the node */
119 	bus_size_t		bf_mapsize;
120 #define	ATH_MAX_SCATTER		ATH_TXDESC	/* max(tx,rx,beacon) desc's */
121 	bus_dma_segment_t	bf_segs[ATH_MAX_SCATTER];
122 };
123 typedef STAILQ_HEAD(, ath_buf) ath_bufhead;
124 
125 /*
126  * DMA state for tx/rx descriptors.
127  */
128 struct ath_descdma {
129 	const char*		dd_name;
130 	struct ath_desc		*dd_desc;	/* descriptors */
131 	bus_addr_t		dd_desc_paddr;	/* physical addr of dd_desc */
132 	bus_size_t		dd_desc_len;	/* size of dd_desc */
133 	bus_dma_segment_t	dd_dseg;
134 	bus_dma_tag_t		dd_dmat;	/* bus DMA tag */
135 	bus_dmamap_t		dd_dmamap;	/* DMA map for descriptors */
136 	struct ath_buf		*dd_bufptr;	/* associated buffers */
137 };
138 
139 /*
140  * Data transmit queue state.  One of these exists for each
141  * hardware transmit queue.  Packets sent to us from above
142  * are assigned to queues based on their priority.  Not all
143  * devices support a complete set of hardware transmit queues.
144  * For those devices the array sc_ac2q will map multiple
145  * priorities to fewer hardware queues (typically all to one
146  * hardware queue).
147  */
148 struct ath_txq {
149 	u_int			axq_qnum;	/* hardware q number */
150 #define	ATH_TXQ_SWQ	(HAL_NUM_TX_QUEUES+1)	/* qnum for s/w only queue */
151 	u_int			axq_depth;	/* queue depth (stat only) */
152 	u_int			axq_intrcnt;	/* interrupt count */
153 	u_int32_t		*axq_link;	/* link ptr in last TX desc */
154 	STAILQ_HEAD(, ath_buf)	axq_q;		/* transmit queue */
155 	struct mtx		axq_lock;	/* lock on q and link */
156 	char			axq_name[12];	/* e.g. "ath0_txq4" */
157 	/*
158 	 * Fast-frame state.  The staging queue holds awaiting
159 	 * a fast-frame pairing.  Buffers on this queue are
160 	 * assigned an ``age'' and flushed when they wait too long.
161 	 */
162 	TAILQ_HEAD(axq_headtype, ath_buf) axq_stageq;
163 	u_int32_t		axq_curage;	/* queue age */
164 };
165 
166 #define	ATH_TXQ_LOCK_INIT(_sc, _tq) do { \
167 	snprintf((_tq)->axq_name, sizeof((_tq)->axq_name), "%s_txq%u", \
168 		device_get_nameunit((_sc)->sc_dev), (_tq)->axq_qnum); \
169 	mtx_init(&(_tq)->axq_lock, (_tq)->axq_name, NULL, MTX_DEF); \
170 } while (0)
171 #define	ATH_TXQ_LOCK_DESTROY(_tq)	mtx_destroy(&(_tq)->axq_lock)
172 #define	ATH_TXQ_LOCK(_tq)		mtx_lock(&(_tq)->axq_lock)
173 #define	ATH_TXQ_UNLOCK(_tq)		mtx_unlock(&(_tq)->axq_lock)
174 #define	ATH_TXQ_LOCK_ASSERT(_tq)	mtx_assert(&(_tq)->axq_lock, MA_OWNED)
175 
176 #define ATH_TXQ_INSERT_TAIL(_tq, _elm, _field) do { \
177 	STAILQ_INSERT_TAIL(&(_tq)->axq_q, (_elm), _field); \
178 	(_tq)->axq_depth++; \
179 	(_tq)->axq_curage++; \
180 } while (0)
181 #define ATH_TXQ_REMOVE_HEAD(_tq, _field) do { \
182 	STAILQ_REMOVE_HEAD(&(_tq)->axq_q, _field); \
183 	(_tq)->axq_depth--; \
184 } while (0)
185 /* NB: this does not do the "head empty check" that STAILQ_LAST does */
186 #define	ATH_TXQ_LAST(_tq) \
187 	((struct ath_buf *)(void *) \
188 	 ((char *)((_tq)->axq_q.stqh_last) - __offsetof(struct ath_buf, bf_list)))
189 
190 struct ath_vap {
191 	struct ieee80211vap av_vap;	/* base class */
192 	int		av_bslot;	/* beacon slot index */
193 	struct ath_buf	*av_bcbuf;	/* beacon buffer */
194 	struct ieee80211_beacon_offsets av_boff;/* dynamic update state */
195 	struct ath_txq	av_mcastq;	/* buffered mcast s/w queue */
196 
197 	void		(*av_recv_mgmt)(struct ieee80211_node *,
198 				struct mbuf *, int, int, int, u_int32_t);
199 	int		(*av_newstate)(struct ieee80211vap *,
200 				enum ieee80211_state, int);
201 	void		(*av_bmiss)(struct ieee80211vap *);
202 };
203 #define	ATH_VAP(vap)	((struct ath_vap *)(vap))
204 
205 struct taskqueue;
206 struct ath_tx99;
207 
208 struct ath_softc {
209 	struct ifnet		*sc_ifp;	/* interface common */
210 	struct ath_stats	sc_stats;	/* interface statistics */
211 	int			sc_debug;
212 	int			sc_nvaps;	/* # vaps */
213 	int			sc_nstavaps;	/* # station vaps */
214 	u_int8_t		sc_hwbssidmask[IEEE80211_ADDR_LEN];
215 	u_int8_t		sc_nbssid0;	/* # vap's using base mac */
216 	uint32_t		sc_bssidmask;	/* bssid mask */
217 
218 	void 			(*sc_node_free)(struct ieee80211_node *);
219 	device_t		sc_dev;
220 	HAL_BUS_TAG		sc_st;		/* bus space tag */
221 	HAL_BUS_HANDLE		sc_sh;		/* bus space handle */
222 	bus_dma_tag_t		sc_dmat;	/* bus DMA tag */
223 	struct mtx		sc_mtx;		/* master lock (recursive) */
224 	struct taskqueue	*sc_tq;		/* private task queue */
225 	struct ath_hal		*sc_ah;		/* Atheros HAL */
226 	struct ath_ratectrl	*sc_rc;		/* tx rate control support */
227 	struct ath_tx99		*sc_tx99;	/* tx99 adjunct state */
228 	void			(*sc_setdefantenna)(struct ath_softc *, u_int);
229 	unsigned int		sc_invalid  : 1,/* disable hardware accesses */
230 				sc_mrretry  : 1,/* multi-rate retry support */
231 				sc_softled  : 1,/* enable LED gpio status */
232 				sc_splitmic : 1,/* split TKIP MIC keys */
233 				sc_needmib  : 1,/* enable MIB stats intr */
234 				sc_diversity: 1,/* enable rx diversity */
235 				sc_hasveol  : 1,/* tx VEOL support */
236 				sc_ledstate : 1,/* LED on/off state */
237 				sc_blinking : 1,/* LED blink operation active */
238 				sc_mcastkey : 1,/* mcast key cache search */
239 				sc_scanning : 1,/* scanning active */
240 				sc_syncbeacon:1,/* sync/resync beacon timers */
241 				sc_hasclrkey: 1,/* CLR key supported */
242 				sc_xchanmode: 1,/* extended channel mode */
243 				sc_outdoor  : 1,/* outdoor operation */
244 				sc_dturbo   : 1,/* dynamic turbo in use */
245 				sc_hasbmask : 1,/* bssid mask support */
246 				sc_hastsfadd: 1,/* tsf adjust support */
247 				sc_beacons  : 1,/* beacons running */
248 				sc_swbmiss  : 1,/* sta mode using sw bmiss */
249 				sc_stagbeacons:1,/* use staggered beacons */
250 				sc_wmetkipmic:1,/* can do WME+TKIP MIC */
251 				sc_resume_up: 1,/* on resume, start all vaps */
252 				sc_resetcal : 1;/* reset cal state next trip */
253 	uint32_t		sc_eerd;	/* regdomain from EEPROM */
254 	uint32_t		sc_eecc;	/* country code from EEPROM */
255 						/* rate tables */
256 #define	IEEE80211_MODE_HALF	(IEEE80211_MODE_MAX+0)
257 #define	IEEE80211_MODE_QUARTER	(IEEE80211_MODE_MAX+1)
258 	const HAL_RATE_TABLE	*sc_rates[IEEE80211_MODE_MAX+2];
259 	const HAL_RATE_TABLE	*sc_currates;	/* current rate table */
260 	enum ieee80211_phymode	sc_curmode;	/* current phy mode */
261 	HAL_OPMODE		sc_opmode;	/* current operating mode */
262 	u_int16_t		sc_curtxpow;	/* current tx power limit */
263 	u_int16_t		sc_curaid;	/* current association id */
264 	HAL_CHANNEL		sc_curchan;	/* current h/w channel */
265 	u_int8_t		sc_curbssid[IEEE80211_ADDR_LEN];
266 	u_int8_t		sc_rixmap[256];	/* IEEE to h/w rate table ix */
267 	struct {
268 		u_int8_t	ieeerate;	/* IEEE rate */
269 		u_int8_t	rxflags;	/* radiotap rx flags */
270 		u_int8_t	txflags;	/* radiotap tx flags */
271 		u_int16_t	ledon;		/* softled on time */
272 		u_int16_t	ledoff;		/* softled off time */
273 	} sc_hwmap[32];				/* h/w rate ix mappings */
274 	u_int8_t		sc_protrix;	/* protection rate index */
275 	u_int8_t		sc_lastdatarix;	/* last data frame rate index */
276 	u_int			sc_mcastrate;	/* ieee rate for mcastrateix */
277 	u_int			sc_fftxqmin;	/* min frames before staging */
278 	u_int			sc_fftxqmax;	/* max frames before drop */
279 	u_int			sc_txantenna;	/* tx antenna (fixed or auto) */
280 	HAL_INT			sc_imask;	/* interrupt mask copy */
281 	u_int			sc_keymax;	/* size of key cache */
282 	u_int8_t		sc_keymap[ATH_KEYBYTES];/* key use bit map */
283 
284 	u_int			sc_ledpin;	/* GPIO pin for driving LED */
285 	u_int			sc_ledon;	/* pin setting for LED on */
286 	u_int			sc_ledidle;	/* idle polling interval */
287 	int			sc_ledevent;	/* time of last LED event */
288 	u_int8_t		sc_txrix;	/* current tx rate for LED */
289 	u_int16_t		sc_ledoff;	/* off time for current blink */
290 	struct callout		sc_ledtimer;	/* led off timer */
291 
292 	u_int			sc_rfsilentpin;	/* GPIO pin for rfkill int */
293 	u_int			sc_rfsilentpol;	/* pin setting for rfkill on */
294 
295 	struct ath_tx_radiotap_header sc_tx_th;
296 	int			sc_tx_th_len;
297 	struct ath_rx_radiotap_header sc_rx_th;
298 	int			sc_rx_th_len;
299 	u_int			sc_monpass;	/* frames to pass in mon.mode */
300 
301 	struct ath_descdma	sc_rxdma;	/* RX descriptors */
302 	ath_bufhead		sc_rxbuf;	/* receive buffer */
303 	struct mbuf		*sc_rxpending;	/* pending receive data */
304 	u_int32_t		*sc_rxlink;	/* link ptr in last RX desc */
305 	struct task		sc_rxtask;	/* rx int processing */
306 	u_int8_t		sc_defant;	/* current default antenna */
307 	u_int8_t		sc_rxotherant;	/* rx's on non-default antenna*/
308 	u_int64_t		sc_lastrx;	/* tsf at last rx'd frame */
309 
310 	struct ath_descdma	sc_txdma;	/* TX descriptors */
311 	ath_bufhead		sc_txbuf;	/* transmit buffer */
312 	struct mtx		sc_txbuflock;	/* txbuf lock */
313 	char			sc_txname[12];	/* e.g. "ath0_buf" */
314 	u_int			sc_txqsetup;	/* h/w queues setup */
315 	u_int			sc_txintrperiod;/* tx interrupt batching */
316 	struct ath_txq		sc_txq[HAL_NUM_TX_QUEUES];
317 	struct ath_txq		*sc_ac2q[5];	/* WME AC -> h/w q map */
318 	struct task		sc_txtask;	/* tx int processing */
319 
320 	struct ath_descdma	sc_bdma;	/* beacon descriptors */
321 	ath_bufhead		sc_bbuf;	/* beacon buffers */
322 	u_int			sc_bhalq;	/* HAL q for outgoing beacons */
323 	u_int			sc_bmisscount;	/* missed beacon transmits */
324 	u_int32_t		sc_ant_tx[8];	/* recent tx frames/antenna */
325 	struct ath_txq		*sc_cabq;	/* tx q for cab frames */
326 	struct task		sc_bmisstask;	/* bmiss int processing */
327 	struct task		sc_bstucktask;	/* stuck beacon processing */
328 	enum {
329 		OK,				/* no change needed */
330 		UPDATE,				/* update pending */
331 		COMMIT				/* beacon sent, commit change */
332 	} sc_updateslot;			/* slot time update fsm */
333 	int			sc_slotupdate;	/* slot to advance fsm */
334 	struct ieee80211vap	*sc_bslot[ATH_BCBUF];
335 	int			sc_nbcnvaps;	/* # vaps with beacons */
336 
337 	struct callout		sc_cal_ch;	/* callout handle for cals */
338 	int			sc_lastlongcal;	/* last long cal completed */
339 	int			sc_lastcalreset;/* last cal reset done */
340 	HAL_NODE_STATS		sc_halstats;	/* station-mode rssi stats */
341 };
342 
343 #define	ATH_LOCK_INIT(_sc) \
344 	mtx_init(&(_sc)->sc_mtx, device_get_nameunit((_sc)->sc_dev), \
345 		 NULL, MTX_DEF | MTX_RECURSE)
346 #define	ATH_LOCK_DESTROY(_sc)	mtx_destroy(&(_sc)->sc_mtx)
347 #define	ATH_LOCK(_sc)		mtx_lock(&(_sc)->sc_mtx)
348 #define	ATH_UNLOCK(_sc)		mtx_unlock(&(_sc)->sc_mtx)
349 #define	ATH_LOCK_ASSERT(_sc)	mtx_assert(&(_sc)->sc_mtx, MA_OWNED)
350 
351 #define	ATH_TXQ_SETUP(sc, i)	((sc)->sc_txqsetup & (1<<i))
352 
353 #define	ATH_TXBUF_LOCK_INIT(_sc) do { \
354 	snprintf((_sc)->sc_txname, sizeof((_sc)->sc_txname), "%s_buf", \
355 		device_get_nameunit((_sc)->sc_dev)); \
356 	mtx_init(&(_sc)->sc_txbuflock, (_sc)->sc_txname, NULL, MTX_DEF); \
357 } while (0)
358 #define	ATH_TXBUF_LOCK_DESTROY(_sc)	mtx_destroy(&(_sc)->sc_txbuflock)
359 #define	ATH_TXBUF_LOCK(_sc)		mtx_lock(&(_sc)->sc_txbuflock)
360 #define	ATH_TXBUF_UNLOCK(_sc)		mtx_unlock(&(_sc)->sc_txbuflock)
361 #define	ATH_TXBUF_LOCK_ASSERT(_sc) \
362 	mtx_assert(&(_sc)->sc_txbuflock, MA_OWNED)
363 
364 int	ath_attach(u_int16_t, struct ath_softc *);
365 int	ath_detach(struct ath_softc *);
366 void	ath_resume(struct ath_softc *);
367 void	ath_suspend(struct ath_softc *);
368 void	ath_shutdown(struct ath_softc *);
369 void	ath_intr(void *);
370 
371 /*
372  * HAL definitions to comply with local coding convention.
373  */
374 #define	ath_hal_detach(_ah) \
375 	((*(_ah)->ah_detach)((_ah)))
376 #define	ath_hal_reset(_ah, _opmode, _chan, _outdoor, _pstatus) \
377 	((*(_ah)->ah_reset)((_ah), (_opmode), (_chan), (_outdoor), (_pstatus)))
378 #define	ath_hal_getratetable(_ah, _mode) \
379 	((*(_ah)->ah_getRateTable)((_ah), (_mode)))
380 #define	ath_hal_getmac(_ah, _mac) \
381 	((*(_ah)->ah_getMacAddress)((_ah), (_mac)))
382 #define	ath_hal_setmac(_ah, _mac) \
383 	((*(_ah)->ah_setMacAddress)((_ah), (_mac)))
384 #define	ath_hal_getbssidmask(_ah, _mask) \
385 	((*(_ah)->ah_getBssIdMask)((_ah), (_mask)))
386 #define	ath_hal_setbssidmask(_ah, _mask) \
387 	((*(_ah)->ah_setBssIdMask)((_ah), (_mask)))
388 #define	ath_hal_intrset(_ah, _mask) \
389 	((*(_ah)->ah_setInterrupts)((_ah), (_mask)))
390 #define	ath_hal_intrget(_ah) \
391 	((*(_ah)->ah_getInterrupts)((_ah)))
392 #define	ath_hal_intrpend(_ah) \
393 	((*(_ah)->ah_isInterruptPending)((_ah)))
394 #define	ath_hal_getisr(_ah, _pmask) \
395 	((*(_ah)->ah_getPendingInterrupts)((_ah), (_pmask)))
396 #define	ath_hal_updatetxtriglevel(_ah, _inc) \
397 	((*(_ah)->ah_updateTxTrigLevel)((_ah), (_inc)))
398 #define	ath_hal_setpower(_ah, _mode) \
399 	((*(_ah)->ah_setPowerMode)((_ah), (_mode), AH_TRUE))
400 #define	ath_hal_keycachesize(_ah) \
401 	((*(_ah)->ah_getKeyCacheSize)((_ah)))
402 #define	ath_hal_keyreset(_ah, _ix) \
403 	((*(_ah)->ah_resetKeyCacheEntry)((_ah), (_ix)))
404 #define	ath_hal_keyset(_ah, _ix, _pk, _mac) \
405 	((*(_ah)->ah_setKeyCacheEntry)((_ah), (_ix), (_pk), (_mac), AH_FALSE))
406 #define	ath_hal_keyisvalid(_ah, _ix) \
407 	(((*(_ah)->ah_isKeyCacheEntryValid)((_ah), (_ix))))
408 #define	ath_hal_keysetmac(_ah, _ix, _mac) \
409 	((*(_ah)->ah_setKeyCacheEntryMac)((_ah), (_ix), (_mac)))
410 #define	ath_hal_getrxfilter(_ah) \
411 	((*(_ah)->ah_getRxFilter)((_ah)))
412 #define	ath_hal_setrxfilter(_ah, _filter) \
413 	((*(_ah)->ah_setRxFilter)((_ah), (_filter)))
414 #define	ath_hal_setmcastfilter(_ah, _mfilt0, _mfilt1) \
415 	((*(_ah)->ah_setMulticastFilter)((_ah), (_mfilt0), (_mfilt1)))
416 #define	ath_hal_waitforbeacon(_ah, _bf) \
417 	((*(_ah)->ah_waitForBeaconDone)((_ah), (_bf)->bf_daddr))
418 #define	ath_hal_putrxbuf(_ah, _bufaddr) \
419 	((*(_ah)->ah_setRxDP)((_ah), (_bufaddr)))
420 #define	ath_hal_gettsf32(_ah) \
421 	((*(_ah)->ah_getTsf32)((_ah)))
422 #define	ath_hal_gettsf64(_ah) \
423 	((*(_ah)->ah_getTsf64)((_ah)))
424 #define	ath_hal_resettsf(_ah) \
425 	((*(_ah)->ah_resetTsf)((_ah)))
426 #define	ath_hal_rxena(_ah) \
427 	((*(_ah)->ah_enableReceive)((_ah)))
428 #define	ath_hal_puttxbuf(_ah, _q, _bufaddr) \
429 	((*(_ah)->ah_setTxDP)((_ah), (_q), (_bufaddr)))
430 #define	ath_hal_gettxbuf(_ah, _q) \
431 	((*(_ah)->ah_getTxDP)((_ah), (_q)))
432 #define	ath_hal_numtxpending(_ah, _q) \
433 	((*(_ah)->ah_numTxPending)((_ah), (_q)))
434 #define	ath_hal_getrxbuf(_ah) \
435 	((*(_ah)->ah_getRxDP)((_ah)))
436 #define	ath_hal_txstart(_ah, _q) \
437 	((*(_ah)->ah_startTxDma)((_ah), (_q)))
438 #define	ath_hal_setchannel(_ah, _chan) \
439 	((*(_ah)->ah_setChannel)((_ah), (_chan)))
440 #define	ath_hal_calibrate(_ah, _chan, _iqcal) \
441 	((*(_ah)->ah_perCalibration)((_ah), (_chan), (_iqcal)))
442 #if HAL_ABI_VERSION >= 0x08111000
443 #define	ath_hal_calibrateN(_ah, _chan, _lcal, _isdone) \
444 	((*(_ah)->ah_perCalibrationN)((_ah), (_chan), 0x1, (_lcal), (_isdone)))
445 #define	ath_hal_calreset(_ah, _chan) \
446 	((*(_ah)->ah_resetCalValid)((_ah), (_chan)))
447 #else
448 #define	ath_hal_calibrateN(_ah, _chan, _lcal, _isdone) \
449 	ath_hal_calibrate(_ah, _chan, _isdone)
450 #define	ath_hal_calreset(_ah, _chan)	(0)
451 #endif
452 #define	ath_hal_setledstate(_ah, _state) \
453 	((*(_ah)->ah_setLedState)((_ah), (_state)))
454 #define	ath_hal_beaconinit(_ah, _nextb, _bperiod) \
455 	((*(_ah)->ah_beaconInit)((_ah), (_nextb), (_bperiod)))
456 #define	ath_hal_beaconreset(_ah) \
457 	((*(_ah)->ah_resetStationBeaconTimers)((_ah)))
458 #define	ath_hal_beacontimers(_ah, _bs) \
459 	((*(_ah)->ah_setStationBeaconTimers)((_ah), (_bs)))
460 #define	ath_hal_setassocid(_ah, _bss, _associd) \
461 	((*(_ah)->ah_writeAssocid)((_ah), (_bss), (_associd)))
462 #define	ath_hal_phydisable(_ah) \
463 	((*(_ah)->ah_phyDisable)((_ah)))
464 #define	ath_hal_setopmode(_ah) \
465 	((*(_ah)->ah_setPCUConfig)((_ah)))
466 #define	ath_hal_stoptxdma(_ah, _qnum) \
467 	((*(_ah)->ah_stopTxDma)((_ah), (_qnum)))
468 #define	ath_hal_stoppcurecv(_ah) \
469 	((*(_ah)->ah_stopPcuReceive)((_ah)))
470 #define	ath_hal_startpcurecv(_ah) \
471 	((*(_ah)->ah_startPcuReceive)((_ah)))
472 #define	ath_hal_stopdmarecv(_ah) \
473 	((*(_ah)->ah_stopDmaReceive)((_ah)))
474 #define	ath_hal_getdiagstate(_ah, _id, _indata, _insize, _outdata, _outsize) \
475 	((*(_ah)->ah_getDiagState)((_ah), (_id), \
476 		(_indata), (_insize), (_outdata), (_outsize)))
477 #define	ath_hal_getfatalstate(_ah, _outdata, _outsize) \
478 	ath_hal_getdiagstate(_ah, 29, NULL, 0, (_outdata), _outsize)
479 #define	ath_hal_setuptxqueue(_ah, _type, _irq) \
480 	((*(_ah)->ah_setupTxQueue)((_ah), (_type), (_irq)))
481 #define	ath_hal_resettxqueue(_ah, _q) \
482 	((*(_ah)->ah_resetTxQueue)((_ah), (_q)))
483 #define	ath_hal_releasetxqueue(_ah, _q) \
484 	((*(_ah)->ah_releaseTxQueue)((_ah), (_q)))
485 #define	ath_hal_gettxqueueprops(_ah, _q, _qi) \
486 	((*(_ah)->ah_getTxQueueProps)((_ah), (_q), (_qi)))
487 #define	ath_hal_settxqueueprops(_ah, _q, _qi) \
488 	((*(_ah)->ah_setTxQueueProps)((_ah), (_q), (_qi)))
489 #define	ath_hal_getrfgain(_ah) \
490 	((*(_ah)->ah_getRfGain)((_ah)))
491 #define	ath_hal_getdefantenna(_ah) \
492 	((*(_ah)->ah_getDefAntenna)((_ah)))
493 #define	ath_hal_setdefantenna(_ah, _ant) \
494 	((*(_ah)->ah_setDefAntenna)((_ah), (_ant)))
495 #define	ath_hal_rxmonitor(_ah, _arg, _chan) \
496 	((*(_ah)->ah_rxMonitor)((_ah), (_arg), (_chan)))
497 #define	ath_hal_mibevent(_ah, _stats) \
498 	((*(_ah)->ah_procMibEvent)((_ah), (_stats)))
499 #define	ath_hal_setslottime(_ah, _us) \
500 	((*(_ah)->ah_setSlotTime)((_ah), (_us)))
501 #define	ath_hal_getslottime(_ah) \
502 	((*(_ah)->ah_getSlotTime)((_ah)))
503 #define	ath_hal_setacktimeout(_ah, _us) \
504 	((*(_ah)->ah_setAckTimeout)((_ah), (_us)))
505 #define	ath_hal_getacktimeout(_ah) \
506 	((*(_ah)->ah_getAckTimeout)((_ah)))
507 #define	ath_hal_setctstimeout(_ah, _us) \
508 	((*(_ah)->ah_setCTSTimeout)((_ah), (_us)))
509 #define	ath_hal_getctstimeout(_ah) \
510 	((*(_ah)->ah_getCTSTimeout)((_ah)))
511 #define	ath_hal_getcapability(_ah, _cap, _param, _result) \
512 	((*(_ah)->ah_getCapability)((_ah), (_cap), (_param), (_result)))
513 #define	ath_hal_setcapability(_ah, _cap, _param, _v, _status) \
514 	((*(_ah)->ah_setCapability)((_ah), (_cap), (_param), (_v), (_status)))
515 #define	ath_hal_ciphersupported(_ah, _cipher) \
516 	(ath_hal_getcapability(_ah, HAL_CAP_CIPHER, _cipher, NULL) == HAL_OK)
517 #define	ath_hal_getregdomain(_ah, _prd) \
518 	(ath_hal_getcapability(_ah, HAL_CAP_REG_DMN, 0, (_prd)) == HAL_OK)
519 #if HAL_ABI_VERSION < 0x08090100
520 /* XXX wrong for anything but amd64 and i386 */
521 #if defined(__LP64__)
522 #define	ath_hal_setregdomain(_ah, _rd) \
523 	(*(uint16_t *)(((uint8_t *)&(_ah)[1]) + 176) = (_rd))
524 #else
525 #define	ath_hal_setregdomain(_ah, _rd) \
526 	(*(uint16_t *)(((uint8_t *)&(_ah)[1]) + 128) = (_rd))
527 #endif
528 #else
529 #define	ath_hal_setregdomain(_ah, _rd) \
530 	ath_hal_setcapability(_ah, HAL_CAP_REG_DMN, 0, _rd, NULL)
531 #endif
532 #define	ath_hal_getcountrycode(_ah, _pcc) \
533 	(*(_pcc) = (_ah)->ah_countryCode)
534 #define	ath_hal_gettkipmic(_ah) \
535 	(ath_hal_getcapability(_ah, HAL_CAP_TKIP_MIC, 1, NULL) == HAL_OK)
536 #define	ath_hal_settkipmic(_ah, _v) \
537 	ath_hal_setcapability(_ah, HAL_CAP_TKIP_MIC, 1, _v, NULL)
538 #define	ath_hal_hastkipsplit(_ah) \
539 	(ath_hal_getcapability(_ah, HAL_CAP_TKIP_SPLIT, 0, NULL) == HAL_OK)
540 #define	ath_hal_gettkipsplit(_ah) \
541 	(ath_hal_getcapability(_ah, HAL_CAP_TKIP_SPLIT, 1, NULL) == HAL_OK)
542 #define	ath_hal_settkipsplit(_ah, _v) \
543 	ath_hal_setcapability(_ah, HAL_CAP_TKIP_SPLIT, 1, _v, NULL)
544 #define	ath_hal_haswmetkipmic(_ah) \
545 	(ath_hal_getcapability(_ah, HAL_CAP_WME_TKIPMIC, 0, NULL) == HAL_OK)
546 #define	ath_hal_hwphycounters(_ah) \
547 	(ath_hal_getcapability(_ah, HAL_CAP_PHYCOUNTERS, 0, NULL) == HAL_OK)
548 #define	ath_hal_hasdiversity(_ah) \
549 	(ath_hal_getcapability(_ah, HAL_CAP_DIVERSITY, 0, NULL) == HAL_OK)
550 #define	ath_hal_getdiversity(_ah) \
551 	(ath_hal_getcapability(_ah, HAL_CAP_DIVERSITY, 1, NULL) == HAL_OK)
552 #define	ath_hal_setdiversity(_ah, _v) \
553 	ath_hal_setcapability(_ah, HAL_CAP_DIVERSITY, 1, _v, NULL)
554 #define	ath_hal_getantennaswitch(_ah) \
555 	((*(_ah)->ah_getAntennaSwitch)((_ah)))
556 #define	ath_hal_setantennaswitch(_ah, _v) \
557 	((*(_ah)->ah_setAntennaSwitch)((_ah), (_v)))
558 #define	ath_hal_getdiag(_ah, _pv) \
559 	(ath_hal_getcapability(_ah, HAL_CAP_DIAG, 0, _pv) == HAL_OK)
560 #define	ath_hal_setdiag(_ah, _v) \
561 	ath_hal_setcapability(_ah, HAL_CAP_DIAG, 0, _v, NULL)
562 #define	ath_hal_getnumtxqueues(_ah, _pv) \
563 	(ath_hal_getcapability(_ah, HAL_CAP_NUM_TXQUEUES, 0, _pv) == HAL_OK)
564 #define	ath_hal_hasveol(_ah) \
565 	(ath_hal_getcapability(_ah, HAL_CAP_VEOL, 0, NULL) == HAL_OK)
566 #define	ath_hal_hastxpowlimit(_ah) \
567 	(ath_hal_getcapability(_ah, HAL_CAP_TXPOW, 0, NULL) == HAL_OK)
568 #define	ath_hal_settxpowlimit(_ah, _pow) \
569 	((*(_ah)->ah_setTxPowerLimit)((_ah), (_pow)))
570 #define	ath_hal_gettxpowlimit(_ah, _ppow) \
571 	(ath_hal_getcapability(_ah, HAL_CAP_TXPOW, 1, _ppow) == HAL_OK)
572 #define	ath_hal_getmaxtxpow(_ah, _ppow) \
573 	(ath_hal_getcapability(_ah, HAL_CAP_TXPOW, 2, _ppow) == HAL_OK)
574 #define	ath_hal_gettpscale(_ah, _scale) \
575 	(ath_hal_getcapability(_ah, HAL_CAP_TXPOW, 3, _scale) == HAL_OK)
576 #define	ath_hal_settpscale(_ah, _v) \
577 	ath_hal_setcapability(_ah, HAL_CAP_TXPOW, 3, _v, NULL)
578 #define	ath_hal_hastpc(_ah) \
579 	(ath_hal_getcapability(_ah, HAL_CAP_TPC, 0, NULL) == HAL_OK)
580 #define	ath_hal_gettpc(_ah) \
581 	(ath_hal_getcapability(_ah, HAL_CAP_TPC, 1, NULL) == HAL_OK)
582 #define	ath_hal_settpc(_ah, _v) \
583 	ath_hal_setcapability(_ah, HAL_CAP_TPC, 1, _v, NULL)
584 #define	ath_hal_hasbursting(_ah) \
585 	(ath_hal_getcapability(_ah, HAL_CAP_BURST, 0, NULL) == HAL_OK)
586 #ifdef notyet
587 #define	ath_hal_hasmcastkeysearch(_ah) \
588 	(ath_hal_getcapability(_ah, HAL_CAP_MCAST_KEYSRCH, 0, NULL) == HAL_OK)
589 #define	ath_hal_getmcastkeysearch(_ah) \
590 	(ath_hal_getcapability(_ah, HAL_CAP_MCAST_KEYSRCH, 1, NULL) == HAL_OK)
591 #else
592 #define	ath_hal_getmcastkeysearch(_ah)	0
593 #endif
594 #define	ath_hal_hasfastframes(_ah) \
595 	(ath_hal_getcapability(_ah, HAL_CAP_FASTFRAME, 0, NULL) == HAL_OK)
596 #define	ath_hal_hasbssidmask(_ah) \
597 	(ath_hal_getcapability(_ah, HAL_CAP_BSSIDMASK, 0, NULL) == HAL_OK)
598 #define	ath_hal_hastsfadjust(_ah) \
599 	(ath_hal_getcapability(_ah, HAL_CAP_TSF_ADJUST, 0, NULL) == HAL_OK)
600 #define	ath_hal_gettsfadjust(_ah) \
601 	(ath_hal_getcapability(_ah, HAL_CAP_TSF_ADJUST, 1, NULL) == HAL_OK)
602 #define	ath_hal_settsfadjust(_ah, _onoff) \
603 	ath_hal_setcapability(_ah, HAL_CAP_TSF_ADJUST, 1, _onoff, NULL)
604 #define	ath_hal_hasrfsilent(_ah) \
605 	(ath_hal_getcapability(_ah, HAL_CAP_RFSILENT, 0, NULL) == HAL_OK)
606 #define	ath_hal_getrfkill(_ah) \
607 	(ath_hal_getcapability(_ah, HAL_CAP_RFSILENT, 1, NULL) == HAL_OK)
608 #define	ath_hal_setrfkill(_ah, _onoff) \
609 	ath_hal_setcapability(_ah, HAL_CAP_RFSILENT, 1, _onoff, NULL)
610 #define	ath_hal_getrfsilent(_ah, _prfsilent) \
611 	(ath_hal_getcapability(_ah, HAL_CAP_RFSILENT, 2, _prfsilent) == HAL_OK)
612 #define	ath_hal_setrfsilent(_ah, _rfsilent) \
613 	ath_hal_setcapability(_ah, HAL_CAP_RFSILENT, 2, _rfsilent, NULL)
614 #define	ath_hal_gettpack(_ah, _ptpack) \
615 	(ath_hal_getcapability(_ah, HAL_CAP_TPC_ACK, 0, _ptpack) == HAL_OK)
616 #define	ath_hal_settpack(_ah, _tpack) \
617 	ath_hal_setcapability(_ah, HAL_CAP_TPC_ACK, 0, _tpack, NULL)
618 #define	ath_hal_gettpcts(_ah, _ptpcts) \
619 	(ath_hal_getcapability(_ah, HAL_CAP_TPC_CTS, 0, _ptpcts) == HAL_OK)
620 #define	ath_hal_settpcts(_ah, _tpcts) \
621 	ath_hal_setcapability(_ah, HAL_CAP_TPC_CTS, 0, _tpcts, NULL)
622 #define	ath_hal_hasintmit(_ah) \
623 	(ath_hal_getcapability(_ah, HAL_CAP_INTMIT, 0, NULL) == HAL_OK)
624 #define	ath_hal_getintmit(_ah) \
625 	(ath_hal_getcapability(_ah, HAL_CAP_INTMIT, 1, NULL) == HAL_OK)
626 #define	ath_hal_setintmit(_ah, _v) \
627 	ath_hal_setcapability(_ah, HAL_CAP_INTMIT, 1, _v, NULL)
628 #define	ath_hal_getchannoise(_ah, _c) \
629 	((*(_ah)->ah_getChanNoise)((_ah), (_c)))
630 #if HAL_ABI_VERSION < 0x05122200
631 #define	HAL_TXQ_TXOKINT_ENABLE	TXQ_FLAG_TXOKINT_ENABLE
632 #define	HAL_TXQ_TXERRINT_ENABLE	TXQ_FLAG_TXERRINT_ENABLE
633 #define	HAL_TXQ_TXDESCINT_ENABLE TXQ_FLAG_TXDESCINT_ENABLE
634 #define	HAL_TXQ_TXEOLINT_ENABLE	TXQ_FLAG_TXEOLINT_ENABLE
635 #define	HAL_TXQ_TXURNINT_ENABLE	TXQ_FLAG_TXURNINT_ENABLE
636 #endif
637 #if HAL_ABI_VERSION < 0x06102501
638 #define	ath_hal_ispublicsafetysku(ah) \
639 	(((ah)->ah_regdomain == 0 && (ah)->ah_countryCode == 842) || \
640 	 (ah)->ah_regdomain == 0x12)
641 #endif
642 #if HAL_ABI_VERSION < 0x06122400
643 /* XXX yech, can't get to regdomain so just hack a compat shim */
644 #define	ath_hal_isgsmsku(ah) \
645 	((ah)->ah_countryCode == 843)
646 #endif
647 #if HAL_ABI_VERSION < 0x07050400
648 /* compat shims so code compilers--it won't work though */
649 #define	CHANNEL_HT20		0x10000
650 #define	CHANNEL_HT40PLUS 	0x20000
651 #define	CHANNEL_HT40MINUS 	0x40000
652 #define	HAL_MODE_11NG_HT20	0x008000
653 #define HAL_MODE_11NA_HT20  	0x010000
654 #endif
655 
656 #define	ath_hal_setuprxdesc(_ah, _ds, _size, _intreq) \
657 	((*(_ah)->ah_setupRxDesc)((_ah), (_ds), (_size), (_intreq)))
658 #define	ath_hal_rxprocdesc(_ah, _ds, _dspa, _dsnext, _rs) \
659 	((*(_ah)->ah_procRxDesc)((_ah), (_ds), (_dspa), (_dsnext), 0, (_rs)))
660 #define	ath_hal_setuptxdesc(_ah, _ds, _plen, _hlen, _atype, _txpow, \
661 		_txr0, _txtr0, _keyix, _ant, _flags, \
662 		_rtsrate, _rtsdura) \
663 	((*(_ah)->ah_setupTxDesc)((_ah), (_ds), (_plen), (_hlen), (_atype), \
664 		(_txpow), (_txr0), (_txtr0), (_keyix), (_ant), \
665 		(_flags), (_rtsrate), (_rtsdura), 0, 0, 0))
666 #define	ath_hal_setupxtxdesc(_ah, _ds, \
667 		_txr1, _txtr1, _txr2, _txtr2, _txr3, _txtr3) \
668 	((*(_ah)->ah_setupXTxDesc)((_ah), (_ds), \
669 		(_txr1), (_txtr1), (_txr2), (_txtr2), (_txr3), (_txtr3)))
670 #define	ath_hal_filltxdesc(_ah, _ds, _l, _first, _last, _ds0) \
671 	((*(_ah)->ah_fillTxDesc)((_ah), (_ds), (_l), (_first), (_last), (_ds0)))
672 #define	ath_hal_txprocdesc(_ah, _ds, _ts) \
673 	((*(_ah)->ah_procTxDesc)((_ah), (_ds), (_ts)))
674 #define	ath_hal_gettxintrtxqs(_ah, _txqs) \
675 	((*(_ah)->ah_getTxIntrQueue)((_ah), (_txqs)))
676 
677 #define ath_hal_gpioCfgOutput(_ah, _gpio) \
678         ((*(_ah)->ah_gpioCfgOutput)((_ah), (_gpio)))
679 #define ath_hal_gpioset(_ah, _gpio, _b) \
680         ((*(_ah)->ah_gpioSet)((_ah), (_gpio), (_b)))
681 #define ath_hal_gpioget(_ah, _gpio) \
682         ((*(_ah)->ah_gpioGet)((_ah), (_gpio)))
683 #define ath_hal_gpiosetintr(_ah, _gpio, _b) \
684         ((*(_ah)->ah_gpioSetIntr)((_ah), (_gpio), (_b)))
685 
686 #define ath_hal_radar_wait(_ah, _chan) \
687 	((*(_ah)->ah_radarWait)((_ah), (_chan)))
688 
689 #endif /* _DEV_ATH_ATHVAR_H */
690