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