if_athvar.h revision 147067
1116743Ssam/*-
2139530Ssam * Copyright (c) 2002-2005 Sam Leffler, Errno Consulting
3116743Ssam * All rights reserved.
4116743Ssam *
5116743Ssam * Redistribution and use in source and binary forms, with or without
6116743Ssam * modification, are permitted provided that the following conditions
7116743Ssam * are met:
8116743Ssam * 1. Redistributions of source code must retain the above copyright
9116743Ssam *    notice, this list of conditions and the following disclaimer,
10116743Ssam *    without modification.
11116743Ssam * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12116743Ssam *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13116743Ssam *    redistribution must be conditioned upon including a substantially
14116743Ssam *    similar Disclaimer requirement for further binary redistribution.
15116743Ssam * 3. Neither the names of the above-listed copyright holders nor the names
16116743Ssam *    of any contributors may be used to endorse or promote products derived
17116743Ssam *    from this software without specific prior written permission.
18116743Ssam *
19116743Ssam * Alternatively, this software may be distributed under the terms of the
20116743Ssam * GNU General Public License ("GPL") version 2 as published by the Free
21116743Ssam * Software Foundation.
22116743Ssam *
23116743Ssam * NO WARRANTY
24116743Ssam * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25116743Ssam * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26116743Ssam * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
27116743Ssam * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
28116743Ssam * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
29116743Ssam * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30116743Ssam * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31116743Ssam * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
32116743Ssam * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33116743Ssam * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
34116743Ssam * THE POSSIBILITY OF SUCH DAMAGES.
35116743Ssam *
36116743Ssam * $FreeBSD: head/sys/dev/ath/if_athvar.h 147067 2005-06-07 00:12:40Z sam $
37116743Ssam */
38116743Ssam
39116743Ssam/*
40116743Ssam * Defintions for the Atheros Wireless LAN controller driver.
41116743Ssam */
42116743Ssam#ifndef _DEV_ATH_ATHVAR_H
43116743Ssam#define _DEV_ATH_ATHVAR_H
44116743Ssam
45116743Ssam#include <sys/taskqueue.h>
46116743Ssam
47116743Ssam#include <contrib/dev/ath/ah.h>
48119783Ssam#include <net80211/ieee80211_radiotap.h>
49116743Ssam#include <dev/ath/if_athioctl.h>
50138570Ssam#include <dev/ath/if_athrate.h>
51116743Ssam
52116743Ssam#define	ATH_TIMEOUT		1000
53116743Ssam
54116743Ssam#define	ATH_RXBUF	40		/* number of RX buffers */
55140438Ssam#define	ATH_TXBUF	100		/* number of TX buffers */
56140438Ssam#define	ATH_TXDESC	10		/* number of descriptors per buffer */
57138570Ssam#define	ATH_TXMAXTRY	11		/* max number of transmit attempts */
58138570Ssam#define	ATH_TXINTR_PERIOD 5		/* max number of batched tx descriptors */
59116743Ssam
60147067Ssam#define	ATH_BEACON_AIFS_DEFAULT	 0	/* default aifs for ap beacon q */
61147067Ssam#define	ATH_BEACON_CWMIN_DEFAULT 0	/* default cwmin for ap beacon q */
62147067Ssam#define	ATH_BEACON_CWMAX_DEFAULT 0	/* default cwmax for ap beacon q */
63147067Ssam
64147057Ssam/*
65147057Ssam * The key cache is used for h/w cipher state and also for
66147057Ssam * tracking station state such as the current tx antenna.
67147057Ssam * We also setup a mapping table between key cache slot indices
68147057Ssam * and station state to short-circuit node lookups on rx.
69147057Ssam * Different parts have different size key caches.  We handle
70147057Ssam * up to ATH_KEYMAX entries (could dynamically allocate state).
71147057Ssam */
72147057Ssam#define	ATH_KEYMAX	128		/* max key cache size we handle */
73147057Ssam#define	ATH_KEYBYTES	(ATH_KEYMAX/NBBY)	/* storage space in bytes */
74147057Ssam
75138570Ssam/* driver-specific node state */
76116743Ssamstruct ath_node {
77119150Ssam	struct ieee80211_node an_node;	/* base class */
78138570Ssam	u_int8_t	an_tx_mgtrate;	/* h/w rate for management/ctl frames */
79138570Ssam	u_int8_t	an_tx_mgtratesp;/* short preamble h/w rate for " " */
80138570Ssam	u_int32_t	an_avgrssi;	/* average rssi over all rx frames */
81138570Ssam	HAL_NODE_STATS	an_halstats;	/* rssi statistics used by hal */
82138570Ssam	/* variable-length rate control state follows */
83116743Ssam};
84138570Ssam#define	ATH_NODE(ni)	((struct ath_node *)(ni))
85138570Ssam#define	ATH_NODE_CONST(ni)	((const struct ath_node *)(ni))
86116743Ssam
87138570Ssam#define ATH_RSSI_LPF_LEN	10
88138570Ssam#define ATH_RSSI_DUMMY_MARKER	0x127
89138570Ssam#define ATH_EP_MUL(x, mul)	((x) * (mul))
90138570Ssam#define ATH_RSSI_IN(x)		(ATH_EP_MUL((x), HAL_RSSI_EP_MULTIPLIER))
91138570Ssam#define ATH_LPF_RSSI(x, y, len) \
92138570Ssam    ((x != ATH_RSSI_DUMMY_MARKER) ? (((x) * ((len) - 1) + (y)) / (len)) : (y))
93138570Ssam#define ATH_RSSI_LPF(x, y) do {						\
94138570Ssam    if ((y) >= -20)							\
95138570Ssam    	x = ATH_LPF_RSSI((x), ATH_RSSI_IN((y)), ATH_RSSI_LPF_LEN);	\
96138570Ssam} while (0)
97138570Ssam
98116743Ssamstruct ath_buf {
99138570Ssam	STAILQ_ENTRY(ath_buf)	bf_list;
100116743Ssam	int			bf_nseg;
101116743Ssam	struct ath_desc		*bf_desc;	/* virtual addr of desc */
102116743Ssam	bus_addr_t		bf_daddr;	/* physical addr of desc */
103138570Ssam	bus_dmamap_t		bf_dmamap;	/* DMA map for mbuf chain */
104116743Ssam	struct mbuf		*bf_m;		/* mbuf for buf */
105116743Ssam	struct ieee80211_node	*bf_node;	/* pointer to the node */
106116743Ssam	bus_size_t		bf_mapsize;
107140438Ssam#define	ATH_MAX_SCATTER		ATH_TXDESC	/* max(tx,rx,beacon) desc's */
108116743Ssam	bus_dma_segment_t	bf_segs[ATH_MAX_SCATTER];
109116743Ssam};
110138570Ssamtypedef STAILQ_HEAD(, ath_buf) ath_bufhead;
111116743Ssam
112138570Ssam/*
113138570Ssam * DMA state for tx/rx descriptors.
114138570Ssam */
115138570Ssamstruct ath_descdma {
116138570Ssam	const char*		dd_name;
117138570Ssam	struct ath_desc		*dd_desc;	/* descriptors */
118138570Ssam	bus_addr_t		dd_desc_paddr;	/* physical addr of dd_desc */
119138570Ssam	bus_addr_t		dd_desc_len;	/* size of dd_desc */
120138570Ssam	bus_dma_segment_t	dd_dseg;
121138570Ssam	bus_dma_tag_t		dd_dmat;	/* bus DMA tag */
122138570Ssam	bus_dmamap_t		dd_dmamap;	/* DMA map for descriptors */
123138570Ssam	struct ath_buf		*dd_bufptr;	/* associated buffers */
124138570Ssam};
125138570Ssam
126138570Ssam/*
127138570Ssam * Data transmit queue state.  One of these exists for each
128138570Ssam * hardware transmit queue.  Packets sent to us from above
129138570Ssam * are assigned to queues based on their priority.  Not all
130138570Ssam * devices support a complete set of hardware transmit queues.
131138570Ssam * For those devices the array sc_ac2q will map multiple
132138570Ssam * priorities to fewer hardware queues (typically all to one
133138570Ssam * hardware queue).
134138570Ssam */
135138570Ssamstruct ath_txq {
136138570Ssam	u_int			axq_qnum;	/* hardware q number */
137138570Ssam	u_int			axq_depth;	/* queue depth (stat only) */
138138570Ssam	u_int			axq_intrcnt;	/* interrupt count */
139138570Ssam	u_int32_t		*axq_link;	/* link ptr in last TX desc */
140138570Ssam	STAILQ_HEAD(, ath_buf)	axq_q;		/* transmit queue */
141138570Ssam	struct mtx		axq_lock;	/* lock on q and link */
142144346Ssam	/*
143144346Ssam	 * State for patching up CTS when bursting.
144144346Ssam	 */
145144346Ssam	struct	ath_buf		*axq_linkbuf;	/* va of last buffer */
146144346Ssam	struct	ath_desc	*axq_lastdsWithCTS;
147144346Ssam						/* first desc of last descriptor
148144346Ssam						 * that contains CTS
149144346Ssam						 */
150144346Ssam	struct	ath_desc	*axq_gatingds;	/* final desc of the gating desc
151144346Ssam						 * that determines whether
152144346Ssam						 * lastdsWithCTS has been DMA'ed
153144346Ssam						 * or not
154144346Ssam						 */
155138570Ssam};
156138570Ssam
157138570Ssam#define	ATH_TXQ_LOCK_INIT(_sc, _tq) \
158138570Ssam	mtx_init(&(_tq)->axq_lock, \
159138570Ssam		device_get_nameunit((_sc)->sc_dev), "xmit q", MTX_DEF)
160138570Ssam#define	ATH_TXQ_LOCK_DESTROY(_tq)	mtx_destroy(&(_tq)->axq_lock)
161138570Ssam#define	ATH_TXQ_LOCK(_tq)		mtx_lock(&(_tq)->axq_lock)
162138570Ssam#define	ATH_TXQ_UNLOCK(_tq)		mtx_unlock(&(_tq)->axq_lock)
163138570Ssam#define	ATH_TXQ_LOCK_ASSERT(_tq)	mtx_assert(&(_tq)->axq_lock, MA_OWNED)
164138570Ssam
165138570Ssam#define ATH_TXQ_INSERT_TAIL(_tq, _elm, _field) do { \
166138570Ssam	STAILQ_INSERT_TAIL(&(_tq)->axq_q, (_elm), _field); \
167138570Ssam	(_tq)->axq_depth++; \
168138570Ssam} while (0)
169138570Ssam#define ATH_TXQ_REMOVE_HEAD(_tq, _field) do { \
170138570Ssam	STAILQ_REMOVE_HEAD(&(_tq)->axq_q, _field); \
171138570Ssam	(_tq)->axq_depth--; \
172138570Ssam} while (0)
173138570Ssam
174116743Ssamstruct ath_softc {
175138570Ssam	struct arpcom		sc_arp;		/* interface common */
176138570Ssam	struct ath_stats	sc_stats;	/* interface statistics */
177116743Ssam	struct ieee80211com	sc_ic;		/* IEEE 802.11 common */
178138570Ssam	int			sc_regdomain;
179138570Ssam	int			sc_countrycode;
180138570Ssam	int			sc_debug;
181138570Ssam	void			(*sc_recv_mgmt)(struct ieee80211com *,
182138570Ssam					struct mbuf *,
183138570Ssam					struct ieee80211_node *,
184138570Ssam					int, int, u_int32_t);
185117812Ssam	int			(*sc_newstate)(struct ieee80211com *,
186117812Ssam					enum ieee80211_state, int);
187138570Ssam	void 			(*sc_node_free)(struct ieee80211_node *);
188116743Ssam	device_t		sc_dev;
189116743Ssam	bus_space_tag_t		sc_st;		/* bus space tag */
190116743Ssam	bus_space_handle_t	sc_sh;		/* bus space handle */
191116743Ssam	bus_dma_tag_t		sc_dmat;	/* bus DMA tag */
192116743Ssam	struct mtx		sc_mtx;		/* master lock (recursive) */
193116743Ssam	struct ath_hal		*sc_ah;		/* Atheros HAL */
194138570Ssam	struct ath_ratectrl	*sc_rc;		/* tx rate control support */
195138570Ssam	void			(*sc_setdefantenna)(struct ath_softc *, u_int);
196147057Ssam	unsigned int		sc_invalid : 1,	/* disable hardware accesses */
197138570Ssam				sc_mrretry : 1,	/* multi-rate retry support */
198138570Ssam				sc_softled : 1,	/* enable LED gpio status */
199138570Ssam				sc_splitmic: 1,	/* split TKIP MIC keys */
200138570Ssam				sc_needmib : 1,	/* enable MIB stats intr */
201138570Ssam				sc_hasdiversity : 1,/* rx diversity available */
202138570Ssam				sc_diversity : 1,/* enable rx diversity */
203138570Ssam				sc_hasveol : 1,	/* tx VEOL support */
204140432Ssam				sc_hastpc  : 1,	/* per-packet TPC support */
205140432Ssam				sc_ledstate: 1,	/* LED on/off state */
206144961Ssam				sc_blinking: 1,	/* LED blink operation active */
207147057Ssam				sc_mcastkey: 1,	/* mcast key cache search */
208147057Ssam				sc_hasclrkey:1;	/* CLR key supported */
209116743Ssam						/* rate tables */
210116743Ssam	const HAL_RATE_TABLE	*sc_rates[IEEE80211_MODE_MAX];
211116743Ssam	const HAL_RATE_TABLE	*sc_currates;	/* current rate table */
212116743Ssam	enum ieee80211_phymode	sc_curmode;	/* current phy mode */
213138570Ssam	u_int16_t		sc_curtxpow;	/* current tx power limit */
214138570Ssam	HAL_CHANNEL		sc_curchan;	/* current h/w channel */
215116743Ssam	u_int8_t		sc_rixmap[256];	/* IEEE to h/w rate table ix */
216140432Ssam	struct {
217140432Ssam		u_int8_t	ieeerate;	/* IEEE rate */
218140761Ssam		u_int8_t	rxflags;	/* radiotap rx flags */
219140761Ssam		u_int8_t	txflags;	/* radiotap tx flags */
220140432Ssam		u_int16_t	ledon;		/* softled on time */
221140432Ssam		u_int16_t	ledoff;		/* softled off time */
222140432Ssam	} sc_hwmap[32];				/* h/w rate ix mappings */
223138570Ssam	u_int8_t		sc_protrix;	/* protection rate index */
224138570Ssam	u_int			sc_txantenna;	/* tx antenna (fixed or auto) */
225116743Ssam	HAL_INT			sc_imask;	/* interrupt mask copy */
226138570Ssam	u_int			sc_keymax;	/* size of key cache */
227147057Ssam	u_int8_t		sc_keymap[ATH_KEYBYTES];/* key use bit map */
228147057Ssam	struct ieee80211_node	*sc_keyixmap[ATH_KEYMAX];/* key ix->node map */
229116743Ssam
230140432Ssam	u_int			sc_ledpin;	/* GPIO pin for driving LED */
231140432Ssam	u_int			sc_ledon;	/* pin setting for LED on */
232140432Ssam	u_int			sc_ledidle;	/* idle polling interval */
233140432Ssam	int			sc_ledevent;	/* time of last LED event */
234140432Ssam	u_int8_t		sc_rxrate;	/* current rx rate for LED */
235140432Ssam	u_int8_t		sc_txrate;	/* current tx rate for LED */
236140432Ssam	u_int16_t		sc_ledoff;	/* off time for current blink */
237140432Ssam	struct callout		sc_ledtimer;	/* led off timer */
238138570Ssam
239119783Ssam	struct bpf_if		*sc_drvbpf;
240119783Ssam	union {
241119783Ssam		struct ath_tx_radiotap_header th;
242119783Ssam		u_int8_t	pad[64];
243119783Ssam	} u_tx_rt;
244127698Ssam	int			sc_tx_th_len;
245119783Ssam	union {
246140761Ssam		struct ath_rx_radiotap_header th;
247119783Ssam		u_int8_t	pad[64];
248119783Ssam	} u_rx_rt;
249140761Ssam	int			sc_rx_th_len;
250119783Ssam
251116743Ssam	struct task		sc_fataltask;	/* fatal int processing */
252116743Ssam
253138570Ssam	struct ath_descdma	sc_rxdma;	/* RX descriptos */
254138570Ssam	ath_bufhead		sc_rxbuf;	/* receive buffer */
255116743Ssam	u_int32_t		*sc_rxlink;	/* link ptr in last RX desc */
256116743Ssam	struct task		sc_rxtask;	/* rx int processing */
257138570Ssam	struct task		sc_rxorntask;	/* rxorn int processing */
258138570Ssam	u_int8_t		sc_defant;	/* current default antenna */
259138570Ssam	u_int8_t		sc_rxotherant;	/* rx's on non-default antenna*/
260116743Ssam
261138570Ssam	struct ath_descdma	sc_txdma;	/* TX descriptors */
262138570Ssam	ath_bufhead		sc_txbuf;	/* transmit buffer */
263138570Ssam	struct mtx		sc_txbuflock;	/* txbuf lock */
264116743Ssam	int			sc_tx_timer;	/* transmit timeout */
265138570Ssam	u_int			sc_txqsetup;	/* h/w queues setup */
266138570Ssam	u_int			sc_txintrperiod;/* tx interrupt batching */
267138570Ssam	struct ath_txq		sc_txq[HAL_NUM_TX_QUEUES];
268138570Ssam	struct ath_txq		*sc_ac2q[5];	/* WME AC -> h/w q map */
269116743Ssam	struct task		sc_txtask;	/* tx int processing */
270116743Ssam
271138570Ssam	struct ath_descdma	sc_bdma;	/* beacon descriptors */
272138570Ssam	ath_bufhead		sc_bbuf;	/* beacon buffers */
273116743Ssam	u_int			sc_bhalq;	/* HAL q for outgoing beacons */
274138570Ssam	u_int			sc_bmisscount;	/* missed beacon transmits */
275138570Ssam	u_int32_t		sc_ant_tx[8];	/* recent tx frames/antenna */
276138570Ssam	struct ath_txq		*sc_cabq;	/* tx q for cab frames */
277138570Ssam	struct ieee80211_beacon_offsets sc_boff;/* dynamic update state */
278116743Ssam	struct task		sc_bmisstask;	/* bmiss int processing */
279138570Ssam	struct task		sc_bstucktask;	/* stuck beacon processing */
280138570Ssam	enum {
281138570Ssam		OK,				/* no change needed */
282138570Ssam		UPDATE,				/* update pending */
283138570Ssam		COMMIT				/* beacon sent, commit change */
284138570Ssam	} sc_updateslot;			/* slot time update fsm */
285116743Ssam
286116743Ssam	struct callout		sc_cal_ch;	/* callout handle for cals */
287116743Ssam	struct callout		sc_scan_ch;	/* callout handle for scan */
288116743Ssam};
289138570Ssam#define	sc_if			sc_arp.ac_if
290119783Ssam#define	sc_tx_th		u_tx_rt.th
291140761Ssam#define	sc_rx_th		u_rx_rt.th
292116743Ssam
293121100Ssam#define	ATH_LOCK_INIT(_sc) \
294121100Ssam	mtx_init(&(_sc)->sc_mtx, device_get_nameunit((_sc)->sc_dev), \
295121100Ssam		 MTX_NETWORK_LOCK, MTX_DEF | MTX_RECURSE)
296121100Ssam#define	ATH_LOCK_DESTROY(_sc)	mtx_destroy(&(_sc)->sc_mtx)
297121100Ssam#define	ATH_LOCK(_sc)		mtx_lock(&(_sc)->sc_mtx)
298121100Ssam#define	ATH_UNLOCK(_sc)		mtx_unlock(&(_sc)->sc_mtx)
299121100Ssam#define	ATH_LOCK_ASSERT(_sc)	mtx_assert(&(_sc)->sc_mtx, MA_OWNED)
300121100Ssam
301138570Ssam#define	ATH_TXQ_SETUP(sc, i)	((sc)->sc_txqsetup & (1<<i))
302138570Ssam
303121100Ssam#define	ATH_TXBUF_LOCK_INIT(_sc) \
304121100Ssam	mtx_init(&(_sc)->sc_txbuflock, \
305121100Ssam		device_get_nameunit((_sc)->sc_dev), "xmit buf q", MTX_DEF)
306121100Ssam#define	ATH_TXBUF_LOCK_DESTROY(_sc)	mtx_destroy(&(_sc)->sc_txbuflock)
307121100Ssam#define	ATH_TXBUF_LOCK(_sc)		mtx_lock(&(_sc)->sc_txbuflock)
308121100Ssam#define	ATH_TXBUF_UNLOCK(_sc)		mtx_unlock(&(_sc)->sc_txbuflock)
309121100Ssam#define	ATH_TXBUF_LOCK_ASSERT(_sc) \
310121100Ssam	mtx_assert(&(_sc)->sc_txbuflock, MA_OWNED)
311121100Ssam
312116743Ssamint	ath_attach(u_int16_t, struct ath_softc *);
313116743Ssamint	ath_detach(struct ath_softc *);
314116743Ssamvoid	ath_resume(struct ath_softc *);
315116743Ssamvoid	ath_suspend(struct ath_softc *);
316116743Ssamvoid	ath_shutdown(struct ath_softc *);
317116743Ssamvoid	ath_intr(void *);
318116743Ssam
319116743Ssam/*
320116743Ssam * HAL definitions to comply with local coding convention.
321116743Ssam */
322138570Ssam#define	ath_hal_detach(_ah) \
323138570Ssam	((*(_ah)->ah_detach)((_ah)))
324116743Ssam#define	ath_hal_reset(_ah, _opmode, _chan, _outdoor, _pstatus) \
325116743Ssam	((*(_ah)->ah_reset)((_ah), (_opmode), (_chan), (_outdoor), (_pstatus)))
326116743Ssam#define	ath_hal_getratetable(_ah, _mode) \
327116743Ssam	((*(_ah)->ah_getRateTable)((_ah), (_mode)))
328116743Ssam#define	ath_hal_getmac(_ah, _mac) \
329116743Ssam	((*(_ah)->ah_getMacAddress)((_ah), (_mac)))
330138570Ssam#define	ath_hal_setmac(_ah, _mac) \
331138570Ssam	((*(_ah)->ah_setMacAddress)((_ah), (_mac)))
332116743Ssam#define	ath_hal_intrset(_ah, _mask) \
333116743Ssam	((*(_ah)->ah_setInterrupts)((_ah), (_mask)))
334116743Ssam#define	ath_hal_intrget(_ah) \
335116743Ssam	((*(_ah)->ah_getInterrupts)((_ah)))
336116743Ssam#define	ath_hal_intrpend(_ah) \
337116743Ssam	((*(_ah)->ah_isInterruptPending)((_ah)))
338116743Ssam#define	ath_hal_getisr(_ah, _pmask) \
339116743Ssam	((*(_ah)->ah_getPendingInterrupts)((_ah), (_pmask)))
340116743Ssam#define	ath_hal_updatetxtriglevel(_ah, _inc) \
341116743Ssam	((*(_ah)->ah_updateTxTrigLevel)((_ah), (_inc)))
342116743Ssam#define	ath_hal_setpower(_ah, _mode, _sleepduration) \
343116743Ssam	((*(_ah)->ah_setPowerMode)((_ah), (_mode), AH_TRUE, (_sleepduration)))
344138570Ssam#define	ath_hal_keycachesize(_ah) \
345138570Ssam	((*(_ah)->ah_getKeyCacheSize)((_ah)))
346116743Ssam#define	ath_hal_keyreset(_ah, _ix) \
347116743Ssam	((*(_ah)->ah_resetKeyCacheEntry)((_ah), (_ix)))
348138570Ssam#define	ath_hal_keyset(_ah, _ix, _pk, _mac) \
349138570Ssam	((*(_ah)->ah_setKeyCacheEntry)((_ah), (_ix), (_pk), (_mac), AH_FALSE))
350116743Ssam#define	ath_hal_keyisvalid(_ah, _ix) \
351116743Ssam	(((*(_ah)->ah_isKeyCacheEntryValid)((_ah), (_ix))))
352116743Ssam#define	ath_hal_keysetmac(_ah, _ix, _mac) \
353116743Ssam	((*(_ah)->ah_setKeyCacheEntryMac)((_ah), (_ix), (_mac)))
354116743Ssam#define	ath_hal_getrxfilter(_ah) \
355116743Ssam	((*(_ah)->ah_getRxFilter)((_ah)))
356116743Ssam#define	ath_hal_setrxfilter(_ah, _filter) \
357116743Ssam	((*(_ah)->ah_setRxFilter)((_ah), (_filter)))
358116743Ssam#define	ath_hal_setmcastfilter(_ah, _mfilt0, _mfilt1) \
359116743Ssam	((*(_ah)->ah_setMulticastFilter)((_ah), (_mfilt0), (_mfilt1)))
360116743Ssam#define	ath_hal_waitforbeacon(_ah, _bf) \
361116743Ssam	((*(_ah)->ah_waitForBeaconDone)((_ah), (_bf)->bf_daddr))
362116743Ssam#define	ath_hal_putrxbuf(_ah, _bufaddr) \
363116743Ssam	((*(_ah)->ah_setRxDP)((_ah), (_bufaddr)))
364116743Ssam#define	ath_hal_gettsf32(_ah) \
365116743Ssam	((*(_ah)->ah_getTsf32)((_ah)))
366116743Ssam#define	ath_hal_gettsf64(_ah) \
367116743Ssam	((*(_ah)->ah_getTsf64)((_ah)))
368116743Ssam#define	ath_hal_resettsf(_ah) \
369116743Ssam	((*(_ah)->ah_resetTsf)((_ah)))
370116743Ssam#define	ath_hal_rxena(_ah) \
371116743Ssam	((*(_ah)->ah_enableReceive)((_ah)))
372116743Ssam#define	ath_hal_puttxbuf(_ah, _q, _bufaddr) \
373116743Ssam	((*(_ah)->ah_setTxDP)((_ah), (_q), (_bufaddr)))
374116743Ssam#define	ath_hal_gettxbuf(_ah, _q) \
375116743Ssam	((*(_ah)->ah_getTxDP)((_ah), (_q)))
376138570Ssam#define	ath_hal_numtxpending(_ah, _q) \
377138570Ssam	((*(_ah)->ah_numTxPending)((_ah), (_q)))
378116743Ssam#define	ath_hal_getrxbuf(_ah) \
379116743Ssam	((*(_ah)->ah_getRxDP)((_ah)))
380116743Ssam#define	ath_hal_txstart(_ah, _q) \
381116743Ssam	((*(_ah)->ah_startTxDma)((_ah), (_q)))
382116743Ssam#define	ath_hal_setchannel(_ah, _chan) \
383116743Ssam	((*(_ah)->ah_setChannel)((_ah), (_chan)))
384116743Ssam#define	ath_hal_calibrate(_ah, _chan) \
385116743Ssam	((*(_ah)->ah_perCalibration)((_ah), (_chan)))
386116743Ssam#define	ath_hal_setledstate(_ah, _state) \
387116743Ssam	((*(_ah)->ah_setLedState)((_ah), (_state)))
388138570Ssam#define	ath_hal_beaconinit(_ah, _nextb, _bperiod) \
389138570Ssam	((*(_ah)->ah_beaconInit)((_ah), (_nextb), (_bperiod)))
390116743Ssam#define	ath_hal_beaconreset(_ah) \
391116743Ssam	((*(_ah)->ah_resetStationBeaconTimers)((_ah)))
392138570Ssam#define	ath_hal_beacontimers(_ah, _bs) \
393138570Ssam	((*(_ah)->ah_setStationBeaconTimers)((_ah), (_bs)))
394116743Ssam#define	ath_hal_setassocid(_ah, _bss, _associd) \
395138570Ssam	((*(_ah)->ah_writeAssocid)((_ah), (_bss), (_associd)))
396138570Ssam#define	ath_hal_phydisable(_ah) \
397138570Ssam	((*(_ah)->ah_phyDisable)((_ah)))
398138570Ssam#define	ath_hal_setopmode(_ah) \
399138570Ssam	((*(_ah)->ah_setPCUConfig)((_ah)))
400116743Ssam#define	ath_hal_stoptxdma(_ah, _qnum) \
401116743Ssam	((*(_ah)->ah_stopTxDma)((_ah), (_qnum)))
402116743Ssam#define	ath_hal_stoppcurecv(_ah) \
403116743Ssam	((*(_ah)->ah_stopPcuReceive)((_ah)))
404116743Ssam#define	ath_hal_startpcurecv(_ah) \
405116743Ssam	((*(_ah)->ah_startPcuReceive)((_ah)))
406116743Ssam#define	ath_hal_stopdmarecv(_ah) \
407116743Ssam	((*(_ah)->ah_stopDmaReceive)((_ah)))
408138570Ssam#define	ath_hal_getdiagstate(_ah, _id, _indata, _insize, _outdata, _outsize) \
409138570Ssam	((*(_ah)->ah_getDiagState)((_ah), (_id), \
410138570Ssam		(_indata), (_insize), (_outdata), (_outsize)))
411116743Ssam#define	ath_hal_setuptxqueue(_ah, _type, _irq) \
412116743Ssam	((*(_ah)->ah_setupTxQueue)((_ah), (_type), (_irq)))
413116743Ssam#define	ath_hal_resettxqueue(_ah, _q) \
414116743Ssam	((*(_ah)->ah_resetTxQueue)((_ah), (_q)))
415116743Ssam#define	ath_hal_releasetxqueue(_ah, _q) \
416116743Ssam	((*(_ah)->ah_releaseTxQueue)((_ah), (_q)))
417138570Ssam#define	ath_hal_gettxqueueprops(_ah, _q, _qi) \
418138570Ssam	((*(_ah)->ah_getTxQueueProps)((_ah), (_q), (_qi)))
419138570Ssam#define	ath_hal_settxqueueprops(_ah, _q, _qi) \
420138570Ssam	((*(_ah)->ah_setTxQueueProps)((_ah), (_q), (_qi)))
421116743Ssam#define	ath_hal_getrfgain(_ah) \
422116743Ssam	((*(_ah)->ah_getRfGain)((_ah)))
423138570Ssam#define	ath_hal_getdefantenna(_ah) \
424138570Ssam	((*(_ah)->ah_getDefAntenna)((_ah)))
425138570Ssam#define	ath_hal_setdefantenna(_ah, _ant) \
426138570Ssam	((*(_ah)->ah_setDefAntenna)((_ah), (_ant)))
427138570Ssam#define	ath_hal_rxmonitor(_ah, _arg) \
428138570Ssam	((*(_ah)->ah_rxMonitor)((_ah), (_arg)))
429138570Ssam#define	ath_hal_mibevent(_ah, _stats) \
430138570Ssam	((*(_ah)->ah_procMibEvent)((_ah), (_stats)))
431138570Ssam#define	ath_hal_setslottime(_ah, _us) \
432138570Ssam	((*(_ah)->ah_setSlotTime)((_ah), (_us)))
433138570Ssam#define	ath_hal_getslottime(_ah) \
434138570Ssam	((*(_ah)->ah_getSlotTime)((_ah)))
435138570Ssam#define	ath_hal_setacktimeout(_ah, _us) \
436138570Ssam	((*(_ah)->ah_setAckTimeout)((_ah), (_us)))
437138570Ssam#define	ath_hal_getacktimeout(_ah) \
438138570Ssam	((*(_ah)->ah_getAckTimeout)((_ah)))
439138570Ssam#define	ath_hal_setctstimeout(_ah, _us) \
440138570Ssam	((*(_ah)->ah_setCTSTimeout)((_ah), (_us)))
441138570Ssam#define	ath_hal_getctstimeout(_ah) \
442138570Ssam	((*(_ah)->ah_getCTSTimeout)((_ah)))
443138570Ssam#define	ath_hal_getcapability(_ah, _cap, _param, _result) \
444138570Ssam	((*(_ah)->ah_getCapability)((_ah), (_cap), (_param), (_result)))
445138570Ssam#define	ath_hal_setcapability(_ah, _cap, _param, _v, _status) \
446138570Ssam	((*(_ah)->ah_setCapability)((_ah), (_cap), (_param), (_v), (_status)))
447138570Ssam#define	ath_hal_ciphersupported(_ah, _cipher) \
448138570Ssam	(ath_hal_getcapability(_ah, HAL_CAP_CIPHER, _cipher, NULL) == HAL_OK)
449138570Ssam#define	ath_hal_getregdomain(_ah, _prd) \
450138570Ssam	ath_hal_getcapability(_ah, HAL_CAP_REG_DMN, 0, (_prd))
451138570Ssam#define	ath_hal_getcountrycode(_ah, _pcc) \
452138570Ssam	(*(_pcc) = (_ah)->ah_countryCode)
453138570Ssam#define	ath_hal_tkipsplit(_ah) \
454138570Ssam	(ath_hal_getcapability(_ah, HAL_CAP_TKIP_SPLIT, 0, NULL) == HAL_OK)
455138570Ssam#define	ath_hal_hwphycounters(_ah) \
456138570Ssam	(ath_hal_getcapability(_ah, HAL_CAP_PHYCOUNTERS, 0, NULL) == HAL_OK)
457138570Ssam#define	ath_hal_hasdiversity(_ah) \
458138570Ssam	(ath_hal_getcapability(_ah, HAL_CAP_DIVERSITY, 0, NULL) == HAL_OK)
459138570Ssam#define	ath_hal_getdiversity(_ah) \
460138570Ssam	(ath_hal_getcapability(_ah, HAL_CAP_DIVERSITY, 1, NULL) == HAL_OK)
461138570Ssam#define	ath_hal_setdiversity(_ah, _v) \
462138570Ssam	ath_hal_setcapability(_ah, HAL_CAP_DIVERSITY, 1, _v, NULL)
463138570Ssam#define	ath_hal_getdiag(_ah, _pv) \
464138570Ssam	(ath_hal_getcapability(_ah, HAL_CAP_DIAG, 0, _pv) == HAL_OK)
465138570Ssam#define	ath_hal_setdiag(_ah, _v) \
466138570Ssam	ath_hal_setcapability(_ah, HAL_CAP_DIAG, 0, _v, NULL)
467138570Ssam#define	ath_hal_getnumtxqueues(_ah, _pv) \
468138570Ssam	(ath_hal_getcapability(_ah, HAL_CAP_NUM_TXQUEUES, 0, _pv) == HAL_OK)
469138570Ssam#define	ath_hal_hasveol(_ah) \
470138570Ssam	(ath_hal_getcapability(_ah, HAL_CAP_VEOL, 0, NULL) == HAL_OK)
471138570Ssam#define	ath_hal_hastxpowlimit(_ah) \
472138570Ssam	(ath_hal_getcapability(_ah, HAL_CAP_TXPOW, 0, NULL) == HAL_OK)
473138570Ssam#define	ath_hal_settxpowlimit(_ah, _pow) \
474138570Ssam	((*(_ah)->ah_setTxPowerLimit)((_ah), (_pow)))
475138570Ssam#define	ath_hal_gettxpowlimit(_ah, _ppow) \
476138570Ssam	(ath_hal_getcapability(_ah, HAL_CAP_TXPOW, 1, _ppow) == HAL_OK)
477138570Ssam#define	ath_hal_getmaxtxpow(_ah, _ppow) \
478138570Ssam	(ath_hal_getcapability(_ah, HAL_CAP_TXPOW, 2, _ppow) == HAL_OK)
479138570Ssam#define	ath_hal_gettpscale(_ah, _scale) \
480138570Ssam	(ath_hal_getcapability(_ah, HAL_CAP_TXPOW, 3, _scale) == HAL_OK)
481138570Ssam#define	ath_hal_settpscale(_ah, _v) \
482138570Ssam	ath_hal_setcapability(_ah, HAL_CAP_TXPOW, 3, _v, NULL)
483138570Ssam#define	ath_hal_hastpc(_ah) \
484138570Ssam	(ath_hal_getcapability(_ah, HAL_CAP_TPC, 0, NULL) == HAL_OK)
485138570Ssam#define	ath_hal_gettpc(_ah) \
486138570Ssam	(ath_hal_getcapability(_ah, HAL_CAP_TPC, 1, NULL) == HAL_OK)
487138570Ssam#define	ath_hal_settpc(_ah, _v) \
488138570Ssam	ath_hal_setcapability(_ah, HAL_CAP_TPC, 1, _v, NULL)
489138570Ssam#define	ath_hal_hasbursting(_ah) \
490138570Ssam	(ath_hal_getcapability(_ah, HAL_CAP_BURST, 0, NULL) == HAL_OK)
491147057Ssam#ifdef notyet
492147057Ssam#define	ath_hal_hasmcastkeysearch(_ah) \
493147057Ssam	(ath_hal_getcapability(_ah, HAL_CAP_MCAST_KEYSRCH, 0, NULL) == HAL_OK)
494147057Ssam#define	ath_hal_getmcastkeysearch(_ah) \
495147057Ssam	(ath_hal_getcapability(_ah, HAL_CAP_MCAST_KEYSRCH, 1, NULL) == HAL_OK)
496147057Ssam#else
497147057Ssam#define	ath_hal_getmcastkeysearch(_ah)	0
498147057Ssam#endif
499116743Ssam
500116743Ssam#define	ath_hal_setuprxdesc(_ah, _ds, _size, _intreq) \
501116743Ssam	((*(_ah)->ah_setupRxDesc)((_ah), (_ds), (_size), (_intreq)))
502123044Ssam#define	ath_hal_rxprocdesc(_ah, _ds, _dspa, _dsnext) \
503123044Ssam	((*(_ah)->ah_procRxDesc)((_ah), (_ds), (_dspa), (_dsnext)))
504116743Ssam#define	ath_hal_setuptxdesc(_ah, _ds, _plen, _hlen, _atype, _txpow, \
505116743Ssam		_txr0, _txtr0, _keyix, _ant, _flags, \
506116743Ssam		_rtsrate, _rtsdura) \
507116743Ssam	((*(_ah)->ah_setupTxDesc)((_ah), (_ds), (_plen), (_hlen), (_atype), \
508116743Ssam		(_txpow), (_txr0), (_txtr0), (_keyix), (_ant), \
509116743Ssam		(_flags), (_rtsrate), (_rtsdura)))
510138570Ssam#define	ath_hal_setupxtxdesc(_ah, _ds, \
511116743Ssam		_txr1, _txtr1, _txr2, _txtr2, _txr3, _txtr3) \
512138570Ssam	((*(_ah)->ah_setupXTxDesc)((_ah), (_ds), \
513116743Ssam		(_txr1), (_txtr1), (_txr2), (_txtr2), (_txr3), (_txtr3)))
514138570Ssam#define	ath_hal_filltxdesc(_ah, _ds, _l, _first, _last, _ds0) \
515138570Ssam	((*(_ah)->ah_fillTxDesc)((_ah), (_ds), (_l), (_first), (_last), (_ds0)))
516116743Ssam#define	ath_hal_txprocdesc(_ah, _ds) \
517116743Ssam	((*(_ah)->ah_procTxDesc)((_ah), (_ds)))
518138570Ssam#define	ath_hal_updateCTSForBursting(_ah, _ds, _prevds, _prevdsWithCTS, \
519138570Ssam		_gatingds,  _txOpLimit, _ctsDuration) \
520138570Ssam	((*(_ah)->ah_updateCTSForBursting)((_ah), (_ds), (_prevds), \
521138570Ssam		(_prevdsWithCTS), (_gatingds), (_txOpLimit), (_ctsDuration)))
522116743Ssam
523138570Ssam#define ath_hal_gpioCfgOutput(_ah, _gpio) \
524138570Ssam        ((*(_ah)->ah_gpioCfgOutput)((_ah), (_gpio)))
525138570Ssam#define ath_hal_gpioset(_ah, _gpio, _b) \
526138570Ssam        ((*(_ah)->ah_gpioSet)((_ah), (_gpio), (_b)))
527138570Ssam
528116743Ssam#endif /* _DEV_ATH_ATHVAR_H */
529