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