xref: /freebsd/sys/dev/ath/if_athvar.h (revision aa24f48b361effe51163877d84f1b70d32b77e04)
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 <machine/atomic.h>
39 
40 #include <dev/ath/ath_hal/ah.h>
41 #include <dev/ath/ath_hal/ah_desc.h>
42 #include <net80211/ieee80211_radiotap.h>
43 #include <dev/ath/if_athioctl.h>
44 #include <dev/ath/if_athrate.h>
45 #ifdef	ATH_DEBUG_ALQ
46 #include <dev/ath/if_ath_alq.h>
47 #endif
48 
49 #define	ATH_TIMEOUT		1000
50 
51 /*
52  * There is a separate TX ath_buf pool for management frames.
53  * This ensures that management frames such as probe responses
54  * and BAR frames can be transmitted during periods of high
55  * TX activity.
56  */
57 #define	ATH_MGMT_TXBUF		32
58 
59 /*
60  * 802.11n requires more TX and RX buffers to do AMPDU.
61  */
62 #ifdef	ATH_ENABLE_11N
63 #define	ATH_TXBUF	512
64 #define	ATH_RXBUF	512
65 #endif
66 
67 #ifndef ATH_RXBUF
68 #define	ATH_RXBUF	40		/* number of RX buffers */
69 #endif
70 #ifndef ATH_TXBUF
71 #define	ATH_TXBUF	200		/* number of TX buffers */
72 #endif
73 #define	ATH_BCBUF	4		/* number of beacon buffers */
74 
75 #define	ATH_TXDESC	10		/* number of descriptors per buffer */
76 #define	ATH_TXMAXTRY	11		/* max number of transmit attempts */
77 #define	ATH_TXMGTTRY	4		/* xmit attempts for mgt/ctl frames */
78 #define	ATH_TXINTR_PERIOD 5		/* max number of batched tx descriptors */
79 
80 #define	ATH_BEACON_AIFS_DEFAULT	 1	/* default aifs for ap beacon q */
81 #define	ATH_BEACON_CWMIN_DEFAULT 0	/* default cwmin for ap beacon q */
82 #define	ATH_BEACON_CWMAX_DEFAULT 0	/* default cwmax for ap beacon q */
83 
84 /*
85  * The following bits can be set during the PCI (and perhaps non-PCI
86  * later) device probe path.
87  *
88  * It controls some of the driver and HAL behaviour.
89  */
90 
91 #define	ATH_PCI_CUS198		0x0001
92 #define	ATH_PCI_CUS230		0x0002
93 #define	ATH_PCI_CUS217		0x0004
94 #define	ATH_PCI_CUS252		0x0008
95 #define	ATH_PCI_WOW		0x0010
96 #define	ATH_PCI_BT_ANT_DIV	0x0020
97 #define	ATH_PCI_D3_L1_WAR	0x0040
98 #define	ATH_PCI_AR9565_1ANT	0x0080
99 #define	ATH_PCI_AR9565_2ANT	0x0100
100 #define	ATH_PCI_NO_PLL_PWRSAVE	0x0200
101 #define	ATH_PCI_KILLER		0x0400
102 
103 /*
104  * The key cache is used for h/w cipher state and also for
105  * tracking station state such as the current tx antenna.
106  * We also setup a mapping table between key cache slot indices
107  * and station state to short-circuit node lookups on rx.
108  * Different parts have different size key caches.  We handle
109  * up to ATH_KEYMAX entries (could dynamically allocate state).
110  */
111 #define	ATH_KEYMAX	128		/* max key cache size we handle */
112 #define	ATH_KEYBYTES	(ATH_KEYMAX/NBBY)	/* storage space in bytes */
113 
114 struct taskqueue;
115 struct kthread;
116 struct ath_buf;
117 
118 #define	ATH_TID_MAX_BUFS	(2 * IEEE80211_AGGR_BAWMAX)
119 
120 /*
121  * Per-TID state
122  *
123  * Note that TID 16 (WME_NUM_TID+1) is for handling non-QoS frames.
124  */
125 struct ath_tid {
126 	TAILQ_HEAD(,ath_buf)	tid_q;		/* pending buffers */
127 	struct ath_node		*an;		/* pointer to parent */
128 	int			tid;		/* tid */
129 	int			ac;		/* which AC gets this traffic */
130 	int			hwq_depth;	/* how many buffers are on HW */
131 	u_int			axq_depth;	/* SW queue depth */
132 
133 	struct {
134 		TAILQ_HEAD(,ath_buf)	tid_q;		/* filtered queue */
135 		u_int			axq_depth;	/* SW queue depth */
136 	} filtq;
137 
138 	/*
139 	 * Entry on the ath_txq; when there's traffic
140 	 * to send
141 	 */
142 	TAILQ_ENTRY(ath_tid)	axq_qelem;
143 	int			sched;
144 	int			paused;	/* >0 if the TID has been paused */
145 
146 	/*
147 	 * These are flags - perhaps later collapse
148 	 * down to a single uint32_t ?
149 	 */
150 	int			addba_tx_pending;	/* TX ADDBA pending */
151 	int			bar_wait;	/* waiting for BAR */
152 	int			bar_tx;		/* BAR TXed */
153 	int			isfiltered;	/* is this node currently filtered */
154 
155 	/*
156 	 * Is the TID being cleaned up after a transition
157 	 * from aggregation to non-aggregation?
158 	 * When this is set to 1, this TID will be paused
159 	 * and no further traffic will be queued until all
160 	 * the hardware packets pending for this TID have been
161 	 * TXed/completed; at which point (non-aggregation)
162 	 * traffic will resume being TXed.
163 	 */
164 	int			cleanup_inprogress;
165 	/*
166 	 * How many hardware-queued packets are
167 	 * waiting to be cleaned up.
168 	 * This is only valid if cleanup_inprogress is 1.
169 	 */
170 	int			incomp;
171 
172 	/*
173 	 * The following implements a ring representing
174 	 * the frames in the current BAW.
175 	 * To avoid copying the array content each time
176 	 * the BAW is moved, the baw_head/baw_tail point
177 	 * to the current BAW begin/end; when the BAW is
178 	 * shifted the head/tail of the array are also
179 	 * appropriately shifted.
180 	 */
181 	/* active tx buffers, beginning at current BAW */
182 	struct ath_buf		*tx_buf[ATH_TID_MAX_BUFS];
183 	/* where the baw head is in the array */
184 	int			baw_head;
185 	/* where the BAW tail is in the array */
186 	int			baw_tail;
187 };
188 
189 /* driver-specific node state */
190 struct ath_node {
191 	struct ieee80211_node an_node;	/* base class */
192 	u_int8_t	an_mgmtrix;	/* min h/w rate index */
193 	u_int8_t	an_mcastrix;	/* mcast h/w rate index */
194 	uint32_t	an_is_powersave;	/* node is sleeping */
195 	uint32_t	an_stack_psq;		/* net80211 psq isn't empty */
196 	uint32_t	an_tim_set;		/* TIM has been set */
197 	struct ath_buf	*an_ff_buf[WME_NUM_AC]; /* ff staging area */
198 	struct ath_tid	an_tid[IEEE80211_TID_SIZE];	/* per-TID state */
199 	char		an_name[32];	/* eg "wlan0_a1" */
200 	struct mtx	an_mtx;		/* protecting the rate control state */
201 	uint32_t	an_swq_depth;	/* how many SWQ packets for this
202 					   node */
203 	int			clrdmask;	/* has clrdmask been set */
204 	uint32_t	an_leak_count;	/* How many frames to leak during pause */
205 	/* variable-length rate control state follows */
206 };
207 #define	ATH_NODE(ni)	((struct ath_node *)(ni))
208 #define	ATH_NODE_CONST(ni)	((const struct ath_node *)(ni))
209 
210 #define ATH_RSSI_LPF_LEN	10
211 #define ATH_RSSI_DUMMY_MARKER	0x127
212 #define ATH_EP_MUL(x, mul)	((x) * (mul))
213 #define ATH_RSSI_IN(x)		(ATH_EP_MUL((x), HAL_RSSI_EP_MULTIPLIER))
214 #define ATH_LPF_RSSI(x, y, len) \
215     ((x != ATH_RSSI_DUMMY_MARKER) ? (((x) * ((len) - 1) + (y)) / (len)) : (y))
216 #define ATH_RSSI_LPF(x, y) do {						\
217     if ((y) >= -20)							\
218     	x = ATH_LPF_RSSI((x), ATH_RSSI_IN((y)), ATH_RSSI_LPF_LEN);	\
219 } while (0)
220 #define	ATH_EP_RND(x,mul) \
221 	((((x)%(mul)) >= ((mul)/2)) ? ((x) + ((mul) - 1)) / (mul) : (x)/(mul))
222 #define	ATH_RSSI(x)		ATH_EP_RND(x, HAL_RSSI_EP_MULTIPLIER)
223 
224 typedef enum {
225 	ATH_BUFTYPE_NORMAL	= 0,
226 	ATH_BUFTYPE_MGMT	= 1,
227 } ath_buf_type_t;
228 
229 struct ath_buf {
230 	TAILQ_ENTRY(ath_buf)	bf_list;
231 	struct ath_buf *	bf_next;	/* next buffer in the aggregate */
232 	int			bf_nseg;
233 	HAL_STATUS		bf_rxstatus;
234 	uint16_t		bf_flags;	/* status flags (below) */
235 	uint16_t		bf_descid;	/* 16 bit descriptor ID */
236 	struct ath_desc		*bf_desc;	/* virtual addr of desc */
237 	struct ath_desc_status	bf_status;	/* tx/rx status */
238 	bus_addr_t		bf_daddr;	/* physical addr of desc */
239 	bus_dmamap_t		bf_dmamap;	/* DMA map for mbuf chain */
240 	struct mbuf		*bf_m;		/* mbuf for buf */
241 	struct ieee80211_node	*bf_node;	/* pointer to the node */
242 	struct ath_desc		*bf_lastds;	/* last descriptor for comp status */
243 	struct ath_buf		*bf_last;	/* last buffer in aggregate, or self for non-aggregate */
244 	bus_size_t		bf_mapsize;
245 #define	ATH_MAX_SCATTER		ATH_TXDESC	/* max(tx,rx,beacon) desc's */
246 	bus_dma_segment_t	bf_segs[ATH_MAX_SCATTER];
247 	uint32_t		bf_nextfraglen;	/* length of next fragment */
248 
249 	/* Completion function to call on TX complete (fail or not) */
250 	/*
251 	 * "fail" here is set to 1 if the queue entries were removed
252 	 * through a call to ath_tx_draintxq().
253 	 */
254 	void(* bf_comp) (struct ath_softc *sc, struct ath_buf *bf, int fail);
255 
256 	/* This state is kept to support software retries and aggregation */
257 	struct {
258 		uint16_t bfs_seqno;	/* sequence number of this packet */
259 		uint16_t bfs_ndelim;	/* number of delims for padding */
260 
261 		uint8_t bfs_retries;	/* retry count */
262 		uint8_t bfs_tid;	/* packet TID (or TID_MAX for no QoS) */
263 		uint8_t bfs_nframes;	/* number of frames in aggregate */
264 		uint8_t bfs_pri;	/* packet AC priority */
265 		uint8_t bfs_tx_queue;	/* destination hardware TX queue */
266 
267 		u_int32_t bfs_aggr:1,		/* part of aggregate? */
268 		    bfs_aggrburst:1,	/* part of aggregate burst? */
269 		    bfs_isretried:1,	/* retried frame? */
270 		    bfs_dobaw:1,	/* actually check against BAW? */
271 		    bfs_addedbaw:1,	/* has been added to the BAW */
272 		    bfs_shpream:1,	/* use short preamble */
273 		    bfs_istxfrag:1,	/* is fragmented */
274 		    bfs_ismrr:1,	/* do multi-rate TX retry */
275 		    bfs_doprot:1,	/* do RTS/CTS based protection */
276 		    bfs_doratelookup:1;	/* do rate lookup before each TX */
277 
278 		/*
279 		 * These fields are passed into the
280 		 * descriptor setup functions.
281 		 */
282 
283 		/* Make this an 8 bit value? */
284 		HAL_PKT_TYPE bfs_atype;	/* packet type */
285 
286 		uint32_t bfs_pktlen;	/* length of this packet */
287 
288 		uint16_t bfs_hdrlen;	/* length of this packet header */
289 		uint16_t bfs_al;	/* length of aggregate */
290 
291 		uint16_t bfs_txflags;	/* HAL (tx) descriptor flags */
292 		uint8_t bfs_txrate0;	/* first TX rate */
293 		uint8_t bfs_try0;		/* first try count */
294 
295 		uint16_t bfs_txpower;	/* tx power */
296 		uint8_t bfs_ctsrate0;	/* Non-zero - use this as ctsrate */
297 		uint8_t bfs_ctsrate;	/* CTS rate */
298 
299 		/* 16 bit? */
300 		int32_t bfs_keyix;		/* crypto key index */
301 		int32_t bfs_txantenna;	/* TX antenna config */
302 
303 		/* Make this an 8 bit value? */
304 		enum ieee80211_protmode bfs_protmode;
305 
306 		/* 16 bit? */
307 		uint32_t bfs_ctsduration;	/* CTS duration (pre-11n NICs) */
308 		struct ath_rc_series bfs_rc[ATH_RC_NUM];	/* non-11n TX series */
309 	} bf_state;
310 };
311 typedef TAILQ_HEAD(ath_bufhead_s, ath_buf) ath_bufhead;
312 
313 #define	ATH_BUF_MGMT	0x00000001	/* (tx) desc is a mgmt desc */
314 #define	ATH_BUF_BUSY	0x00000002	/* (tx) desc owned by h/w */
315 #define	ATH_BUF_FIFOEND	0x00000004
316 #define	ATH_BUF_FIFOPTR	0x00000008
317 #define	ATH_BUF_TOA_PROBE	0x00000010	/* ToD/ToA exchange probe */
318 
319 #define	ATH_BUF_FLAGS_CLONE	(ATH_BUF_MGMT | ATH_BUF_TOA_PROBE)
320 
321 /*
322  * DMA state for tx/rx descriptors.
323  */
324 struct ath_descdma {
325 	const char*		dd_name;
326 	struct ath_desc		*dd_desc;	/* descriptors */
327 	int			dd_descsize;	/* size of single descriptor */
328 	bus_addr_t		dd_desc_paddr;	/* physical addr of dd_desc */
329 	bus_size_t		dd_desc_len;	/* size of dd_desc */
330 	bus_dma_segment_t	dd_dseg;
331 	bus_dma_tag_t		dd_dmat;	/* bus DMA tag */
332 	bus_dmamap_t		dd_dmamap;	/* DMA map for descriptors */
333 	struct ath_buf		*dd_bufptr;	/* associated buffers */
334 };
335 
336 /*
337  * Data transmit queue state.  One of these exists for each
338  * hardware transmit queue.  Packets sent to us from above
339  * are assigned to queues based on their priority.  Not all
340  * devices support a complete set of hardware transmit queues.
341  * For those devices the array sc_ac2q will map multiple
342  * priorities to fewer hardware queues (typically all to one
343  * hardware queue).
344  */
345 struct ath_txq {
346 	struct ath_softc	*axq_softc;	/* Needed for scheduling */
347 	u_int			axq_qnum;	/* hardware q number */
348 #define	ATH_TXQ_SWQ	(HAL_NUM_TX_QUEUES+1)	/* qnum for s/w only queue */
349 	u_int			axq_ac;		/* WME AC */
350 	u_int			axq_flags;
351 //#define	ATH_TXQ_PUTPENDING	0x0001		/* ath_hal_puttxbuf pending */
352 #define	ATH_TXQ_PUTRUNNING	0x0002		/* ath_hal_puttxbuf has been called */
353 	u_int			axq_depth;	/* queue depth (stat only) */
354 	u_int			axq_aggr_depth;	/* how many aggregates are queued */
355 	u_int			axq_intrcnt;	/* interrupt count */
356 	u_int32_t		*axq_link;	/* link ptr in last TX desc */
357 	TAILQ_HEAD(axq_q_s, ath_buf)	axq_q;		/* transmit queue */
358 	struct mtx		axq_lock;	/* lock on q and link */
359 
360 	/*
361 	 * This is the FIFO staging buffer when doing EDMA.
362 	 *
363 	 * For legacy chips, we just push the head pointer to
364 	 * the hardware and we ignore this list.
365 	 *
366 	 * For EDMA, the staging buffer is treated as normal;
367 	 * when it's time to push a list of frames to the hardware
368 	 * we move that list here and we stamp buffers with
369 	 * flags to identify the beginning/end of that particular
370 	 * FIFO entry.
371 	 */
372 	struct {
373 		TAILQ_HEAD(axq_q_f_s, ath_buf)	axq_q;
374 		u_int				axq_depth;	/* how many frames (1 per legacy, 1 per A-MPDU list) are in the FIFO queue */
375 	} fifo;
376 	u_int			axq_fifo_depth;	/* how many FIFO slots are active */
377 
378 	/*
379 	 * XXX the holdingbf field is protected by the TXBUF lock
380 	 * for now, NOT the TXQ lock.
381 	 *
382 	 * Architecturally, it would likely be better to move
383 	 * the holdingbf field to a separate array in ath_softc
384 	 * just to highlight that it's not protected by the normal
385 	 * TX path lock.
386 	 */
387 	struct ath_buf		*axq_holdingbf;	/* holding TX buffer */
388 	char			axq_name[12];	/* e.g. "ath0_txq4" */
389 
390 	/* Per-TID traffic queue for software -> hardware TX */
391 	/*
392 	 * This is protected by the general TX path lock, not (for now)
393 	 * by the TXQ lock.
394 	 */
395 	TAILQ_HEAD(axq_t_s,ath_tid)	axq_tidq;
396 };
397 
398 #define	ATH_TXQ_LOCK_INIT(_sc, _tq) do { \
399 	    snprintf((_tq)->axq_name, sizeof((_tq)->axq_name), "%s_txq%u", \
400 	      device_get_nameunit((_sc)->sc_dev), (_tq)->axq_qnum); \
401 	    mtx_init(&(_tq)->axq_lock, (_tq)->axq_name, NULL, MTX_DEF); \
402 	} while (0)
403 #define	ATH_TXQ_LOCK_DESTROY(_tq)	mtx_destroy(&(_tq)->axq_lock)
404 #define	ATH_TXQ_LOCK(_tq)		mtx_lock(&(_tq)->axq_lock)
405 #define	ATH_TXQ_UNLOCK(_tq)		mtx_unlock(&(_tq)->axq_lock)
406 #define	ATH_TXQ_LOCK_ASSERT(_tq)	mtx_assert(&(_tq)->axq_lock, MA_OWNED)
407 #define	ATH_TXQ_UNLOCK_ASSERT(_tq)	mtx_assert(&(_tq)->axq_lock,	\
408 					    MA_NOTOWNED)
409 
410 
411 #define	ATH_NODE_LOCK(_an)		mtx_lock(&(_an)->an_mtx)
412 #define	ATH_NODE_UNLOCK(_an)		mtx_unlock(&(_an)->an_mtx)
413 #define	ATH_NODE_LOCK_ASSERT(_an)	mtx_assert(&(_an)->an_mtx, MA_OWNED)
414 #define	ATH_NODE_UNLOCK_ASSERT(_an)	mtx_assert(&(_an)->an_mtx,	\
415 					    MA_NOTOWNED)
416 
417 /*
418  * These are for the hardware queue.
419  */
420 #define ATH_TXQ_INSERT_HEAD(_tq, _elm, _field) do { \
421 	TAILQ_INSERT_HEAD(&(_tq)->axq_q, (_elm), _field); \
422 	(_tq)->axq_depth++; \
423 } while (0)
424 #define ATH_TXQ_INSERT_TAIL(_tq, _elm, _field) do { \
425 	TAILQ_INSERT_TAIL(&(_tq)->axq_q, (_elm), _field); \
426 	(_tq)->axq_depth++; \
427 } while (0)
428 #define ATH_TXQ_REMOVE(_tq, _elm, _field) do { \
429 	TAILQ_REMOVE(&(_tq)->axq_q, _elm, _field); \
430 	(_tq)->axq_depth--; \
431 } while (0)
432 #define	ATH_TXQ_FIRST(_tq)		TAILQ_FIRST(&(_tq)->axq_q)
433 #define	ATH_TXQ_LAST(_tq, _field)	TAILQ_LAST(&(_tq)->axq_q, _field)
434 
435 /*
436  * These are for the TID software queue.
437  */
438 #define ATH_TID_INSERT_HEAD(_tq, _elm, _field) do { \
439 	TAILQ_INSERT_HEAD(&(_tq)->tid_q, (_elm), _field); \
440 	(_tq)->axq_depth++; \
441 	(_tq)->an->an_swq_depth++; \
442 } while (0)
443 #define ATH_TID_INSERT_TAIL(_tq, _elm, _field) do { \
444 	TAILQ_INSERT_TAIL(&(_tq)->tid_q, (_elm), _field); \
445 	(_tq)->axq_depth++; \
446 	(_tq)->an->an_swq_depth++; \
447 } while (0)
448 #define ATH_TID_REMOVE(_tq, _elm, _field) do { \
449 	TAILQ_REMOVE(&(_tq)->tid_q, _elm, _field); \
450 	(_tq)->axq_depth--; \
451 	(_tq)->an->an_swq_depth--; \
452 } while (0)
453 #define	ATH_TID_FIRST(_tq)		TAILQ_FIRST(&(_tq)->tid_q)
454 #define	ATH_TID_LAST(_tq, _field)	TAILQ_LAST(&(_tq)->tid_q, _field)
455 
456 /*
457  * These are for the TID filtered frame queue
458  */
459 #define ATH_TID_FILT_INSERT_HEAD(_tq, _elm, _field) do { \
460 	TAILQ_INSERT_HEAD(&(_tq)->filtq.tid_q, (_elm), _field); \
461 	(_tq)->axq_depth++; \
462 	(_tq)->an->an_swq_depth++; \
463 } while (0)
464 #define ATH_TID_FILT_INSERT_TAIL(_tq, _elm, _field) do { \
465 	TAILQ_INSERT_TAIL(&(_tq)->filtq.tid_q, (_elm), _field); \
466 	(_tq)->axq_depth++; \
467 	(_tq)->an->an_swq_depth++; \
468 } while (0)
469 #define ATH_TID_FILT_REMOVE(_tq, _elm, _field) do { \
470 	TAILQ_REMOVE(&(_tq)->filtq.tid_q, _elm, _field); \
471 	(_tq)->axq_depth--; \
472 	(_tq)->an->an_swq_depth--; \
473 } while (0)
474 #define	ATH_TID_FILT_FIRST(_tq)		TAILQ_FIRST(&(_tq)->filtq.tid_q)
475 #define	ATH_TID_FILT_LAST(_tq, _field)	TAILQ_LAST(&(_tq)->filtq.tid_q,_field)
476 
477 struct ath_vap {
478 	struct ieee80211vap av_vap;	/* base class */
479 	int		av_bslot;	/* beacon slot index */
480 	struct ath_buf	*av_bcbuf;	/* beacon buffer */
481 	struct ath_txq	av_mcastq;	/* buffered mcast s/w queue */
482 
483 	void		(*av_recv_mgmt)(struct ieee80211_node *,
484 				struct mbuf *, int,
485 				const struct ieee80211_rx_stats *, int, int);
486 	int		(*av_newstate)(struct ieee80211vap *,
487 				enum ieee80211_state, int);
488 	void		(*av_bmiss)(struct ieee80211vap *);
489 	void		(*av_node_ps)(struct ieee80211_node *, int);
490 	int		(*av_set_tim)(struct ieee80211_node *, int);
491 	void		(*av_recv_pspoll)(struct ieee80211_node *,
492 				struct mbuf *);
493 	struct ieee80211_quiet_ie	quiet_ie;
494 };
495 #define	ATH_VAP(vap)	((struct ath_vap *)(vap))
496 
497 struct taskqueue;
498 struct ath_tx99;
499 
500 /*
501  * Whether to reset the TX/RX queue with or without
502  * a queue flush.
503  */
504 typedef enum {
505 	ATH_RESET_DEFAULT = 0,
506 	ATH_RESET_NOLOSS = 1,
507 	ATH_RESET_FULL = 2,
508 } ATH_RESET_TYPE;
509 
510 struct ath_rx_methods {
511 	void		(*recv_sched_queue)(struct ath_softc *sc,
512 			    HAL_RX_QUEUE q, int dosched);
513 	void		(*recv_sched)(struct ath_softc *sc, int dosched);
514 	void		(*recv_stop)(struct ath_softc *sc, int dodelay);
515 	int		(*recv_start)(struct ath_softc *sc);
516 	void		(*recv_flush)(struct ath_softc *sc);
517 	void		(*recv_tasklet)(void *arg, int npending);
518 	int		(*recv_rxbuf_init)(struct ath_softc *sc,
519 			    struct ath_buf *bf);
520 	int		(*recv_setup)(struct ath_softc *sc);
521 	int		(*recv_teardown)(struct ath_softc *sc);
522 };
523 
524 /*
525  * Represent the current state of the RX FIFO.
526  */
527 struct ath_rx_edma {
528 	struct ath_buf	**m_fifo;
529 	int		m_fifolen;
530 	int		m_fifo_head;
531 	int		m_fifo_tail;
532 	int		m_fifo_depth;
533 	struct mbuf	*m_rxpending;
534 	struct ath_buf	*m_holdbf;
535 };
536 
537 struct ath_tx_edma_fifo {
538 	struct ath_buf	**m_fifo;
539 	int		m_fifolen;
540 	int		m_fifo_head;
541 	int		m_fifo_tail;
542 	int		m_fifo_depth;
543 };
544 
545 struct ath_tx_methods {
546 	int		(*xmit_setup)(struct ath_softc *sc);
547 	int		(*xmit_teardown)(struct ath_softc *sc);
548 	void		(*xmit_attach_comp_func)(struct ath_softc *sc);
549 
550 	void		(*xmit_dma_restart)(struct ath_softc *sc,
551 			    struct ath_txq *txq);
552 	void		(*xmit_handoff)(struct ath_softc *sc,
553 			    struct ath_txq *txq, struct ath_buf *bf);
554 	void		(*xmit_drain)(struct ath_softc *sc,
555 			    ATH_RESET_TYPE reset_type);
556 };
557 
558 struct ath_softc {
559 	struct ieee80211com	sc_ic;
560 	struct ath_stats	sc_stats;	/* device statistics */
561 	struct ath_tx_aggr_stats	sc_aggr_stats;
562 	struct ath_intr_stats	sc_intr_stats;
563 	uint64_t		sc_debug;
564 	uint64_t		sc_ktrdebug;
565 	int			sc_nvaps;	/* # vaps */
566 	int			sc_nstavaps;	/* # station vaps */
567 	int			sc_nmeshvaps;	/* # mbss vaps */
568 	u_int8_t		sc_hwbssidmask[IEEE80211_ADDR_LEN];
569 	u_int8_t		sc_nbssid0;	/* # vap's using base mac */
570 	uint32_t		sc_bssidmask;	/* bssid mask */
571 
572 	struct ath_rx_methods	sc_rx;
573 	struct ath_rx_edma	sc_rxedma[HAL_NUM_RX_QUEUES];	/* HP/LP queues */
574 	ath_bufhead		sc_rx_rxlist[HAL_NUM_RX_QUEUES];	/* deferred RX completion */
575 	struct ath_tx_methods	sc_tx;
576 	struct ath_tx_edma_fifo	sc_txedma[HAL_NUM_TX_QUEUES];
577 
578 	/*
579 	 * This is (currently) protected by the TX queue lock;
580 	 * it should migrate to a separate lock later
581 	 * so as to minimise contention.
582 	 */
583 	ath_bufhead		sc_txbuf_list;
584 
585 	int			sc_rx_statuslen;
586 	int			sc_tx_desclen;
587 	int			sc_tx_statuslen;
588 	int			sc_tx_nmaps;	/* Number of TX maps */
589 	int			sc_edma_bufsize;
590 	int			sc_rx_stopped;	/* XXX only for EDMA */
591 	int			sc_rx_resetted;	/* XXX only for EDMA */
592 
593 	void 			(*sc_node_cleanup)(struct ieee80211_node *);
594 	void 			(*sc_node_free)(struct ieee80211_node *);
595 	device_t		sc_dev;
596 	HAL_BUS_TAG		sc_st;		/* bus space tag */
597 	HAL_BUS_HANDLE		sc_sh;		/* bus space handle */
598 	bus_dma_tag_t		sc_dmat;	/* bus DMA tag */
599 	struct mtx		sc_mtx;		/* master lock (recursive) */
600 	struct mtx		sc_pcu_mtx;	/* PCU access mutex */
601 	char			sc_pcu_mtx_name[32];
602 	struct mtx		sc_rx_mtx;	/* RX access mutex */
603 	char			sc_rx_mtx_name[32];
604 	struct mtx		sc_tx_mtx;	/* TX handling/comp mutex */
605 	char			sc_tx_mtx_name[32];
606 	struct mtx		sc_tx_ic_mtx;	/* TX queue mutex */
607 	char			sc_tx_ic_mtx_name[32];
608 	struct taskqueue	*sc_tq;		/* private task queue */
609 	struct ath_hal		*sc_ah;		/* Atheros HAL */
610 	struct ath_ratectrl	*sc_rc;		/* tx rate control support */
611 	struct ath_tx99		*sc_tx99;	/* tx99 adjunct state */
612 	void			(*sc_setdefantenna)(struct ath_softc *, u_int);
613 
614 	/*
615 	 * First set of flags.
616 	 */
617 	uint32_t		sc_invalid  : 1,/* disable hardware accesses */
618 				sc_mrretry  : 1,/* multi-rate retry support */
619 				sc_mrrprot  : 1,/* MRR + protection support */
620 				sc_softled  : 1,/* enable LED gpio status */
621 				sc_hardled  : 1,/* enable MAC LED status */
622 				sc_splitmic : 1,/* split TKIP MIC keys */
623 				sc_needmib  : 1,/* enable MIB stats intr */
624 				sc_diversity: 1,/* enable rx diversity */
625 				sc_hasveol  : 1,/* tx VEOL support */
626 				sc_ledstate : 1,/* LED on/off state */
627 				sc_blinking : 1,/* LED blink operation active */
628 				sc_mcastkey : 1,/* mcast key cache search */
629 				sc_scanning : 1,/* scanning active */
630 				sc_syncbeacon:1,/* sync/resync beacon timers */
631 				sc_hasclrkey: 1,/* CLR key supported */
632 				sc_xchanmode: 1,/* extended channel mode */
633 				sc_outdoor  : 1,/* outdoor operation */
634 				sc_dturbo   : 1,/* dynamic turbo in use */
635 				sc_hasbmask : 1,/* bssid mask support */
636 				sc_hasbmatch: 1,/* bssid match disable support*/
637 				sc_hastsfadd: 1,/* tsf adjust support */
638 				sc_beacons  : 1,/* beacons running */
639 				sc_swbmiss  : 1,/* sta mode using sw bmiss */
640 				sc_stagbeacons:1,/* use staggered beacons */
641 				sc_wmetkipmic:1,/* can do WME+TKIP MIC */
642 				sc_resume_up: 1,/* on resume, start all vaps */
643 				sc_tdma	    : 1,/* TDMA in use */
644 				sc_setcca   : 1,/* set/clr CCA with TDMA */
645 				sc_resetcal : 1,/* reset cal state next trip */
646 				sc_rxslink  : 1,/* do self-linked final descriptor */
647 				sc_rxtsf32  : 1,/* RX dec TSF is 32 bits */
648 				sc_isedma   : 1,/* supports EDMA */
649 				sc_do_mybeacon : 1; /* supports mybeacon */
650 
651 	/*
652 	 * Second set of flags.
653 	 */
654 	u_int32_t		sc_running  : 1,	/* initialized */
655 				sc_use_ent  : 1,
656 				sc_rx_stbc  : 1,
657 				sc_tx_stbc  : 1,
658 				sc_has_ldpc : 1,
659 				sc_hasenforcetxop : 1, /* support enforce TxOP */
660 				sc_hasdivcomb : 1,     /* RX diversity combining */
661 				sc_rx_lnamixer : 1,    /* RX using LNA mixing */
662 				sc_btcoex_mci : 1;     /* MCI bluetooth coex */
663 
664 	int			sc_cabq_enable;	/* Enable cabq transmission */
665 
666 	/*
667 	 * Enterprise mode configuration for AR9380 and later chipsets.
668 	 */
669 	uint32_t		sc_ent_cfg;
670 
671 	uint32_t		sc_eerd;	/* regdomain from EEPROM */
672 	uint32_t		sc_eecc;	/* country code from EEPROM */
673 						/* rate tables */
674 	const HAL_RATE_TABLE	*sc_rates[IEEE80211_MODE_MAX];
675 	const HAL_RATE_TABLE	*sc_currates;	/* current rate table */
676 	enum ieee80211_phymode	sc_curmode;	/* current phy mode */
677 	HAL_OPMODE		sc_opmode;	/* current operating mode */
678 	u_int16_t		sc_curtxpow;	/* current tx power limit */
679 	u_int16_t		sc_curaid;	/* current association id */
680 	struct ieee80211_channel *sc_curchan;	/* current installed channel */
681 	u_int8_t		sc_curbssid[IEEE80211_ADDR_LEN];
682 	u_int8_t		sc_rixmap[256];	/* IEEE to h/w rate table ix */
683 	struct {
684 		u_int8_t	ieeerate;	/* IEEE rate */
685 		u_int8_t	rxflags;	/* radiotap rx flags */
686 		u_int8_t	txflags;	/* radiotap tx flags */
687 		u_int16_t	ledon;		/* softled on time */
688 		u_int16_t	ledoff;		/* softled off time */
689 	} sc_hwmap[32];				/* h/w rate ix mappings */
690 	u_int8_t		sc_protrix;	/* protection rate index */
691 	u_int8_t		sc_lastdatarix;	/* last data frame rate index */
692 	u_int			sc_mcastrate;	/* ieee rate for mcastrateix */
693 	u_int			sc_fftxqmin;	/* min frames before staging */
694 	u_int			sc_fftxqmax;	/* max frames before drop */
695 	u_int			sc_txantenna;	/* tx antenna (fixed or auto) */
696 
697 	HAL_INT			sc_imask;	/* interrupt mask copy */
698 
699 	/*
700 	 * These are modified in the interrupt handler as well as
701 	 * the task queues and other contexts. Thus these must be
702 	 * protected by a mutex, or they could clash.
703 	 *
704 	 * For now, access to these is behind the ATH_LOCK,
705 	 * just to save time.
706 	 */
707 	uint32_t		sc_txq_active;	/* bitmap of active TXQs */
708 	uint32_t		sc_kickpcu;	/* whether to kick the PCU */
709 	uint32_t		sc_rxproc_cnt;	/* In RX processing */
710 	uint32_t		sc_txproc_cnt;	/* In TX processing */
711 	uint32_t		sc_txstart_cnt;	/* In TX output (raw/start) */
712 	uint32_t		sc_inreset_cnt;	/* In active reset/chanchange */
713 	uint32_t		sc_txrx_cnt;	/* refcount on stop/start'ing TX */
714 	uint32_t		sc_intr_cnt;	/* refcount on interrupt handling */
715 
716 	u_int			sc_keymax;	/* size of key cache */
717 	u_int8_t		sc_keymap[ATH_KEYBYTES];/* key use bit map */
718 
719 	/*
720 	 * Software based LED blinking
721 	 */
722 	u_int			sc_ledpin;	/* GPIO pin for driving LED */
723 	u_int			sc_ledon;	/* pin setting for LED on */
724 	u_int			sc_ledidle;	/* idle polling interval */
725 	int			sc_ledevent;	/* time of last LED event */
726 	u_int8_t		sc_txrix;	/* current tx rate for LED */
727 	u_int16_t		sc_ledoff;	/* off time for current blink */
728 	struct callout		sc_ledtimer;	/* led off timer */
729 
730 	/*
731 	 * Hardware based LED blinking
732 	 */
733 	int			sc_led_pwr_pin;	/* MAC power LED GPIO pin */
734 	int			sc_led_net_pin;	/* MAC network LED GPIO pin */
735 
736 	u_int			sc_rfsilentpin;	/* GPIO pin for rfkill int */
737 	u_int			sc_rfsilentpol;	/* pin setting for rfkill on */
738 
739 	struct ath_descdma	sc_rxdma;	/* RX descriptors */
740 	ath_bufhead		sc_rxbuf;	/* receive buffer */
741 	u_int32_t		*sc_rxlink;	/* link ptr in last RX desc */
742 	struct task		sc_rxtask;	/* rx int processing */
743 	u_int8_t		sc_defant;	/* current default antenna */
744 	u_int8_t		sc_rxotherant;	/* rx's on non-default antenna*/
745 	u_int64_t		sc_lastrx;	/* tsf at last rx'd frame */
746 	struct ath_rx_status	*sc_lastrs;	/* h/w status of last rx */
747 	struct ath_rx_radiotap_header sc_rx_th;
748 	int			sc_rx_th_len;
749 	u_int			sc_monpass;	/* frames to pass in mon.mode */
750 
751 	struct ath_descdma	sc_txdma;	/* TX descriptors */
752 	uint16_t		sc_txbuf_descid;
753 	ath_bufhead		sc_txbuf;	/* transmit buffer */
754 	int			sc_txbuf_cnt;	/* how many buffers avail */
755 	struct ath_descdma	sc_txdma_mgmt;	/* mgmt TX descriptors */
756 	ath_bufhead		sc_txbuf_mgmt;	/* mgmt transmit buffer */
757 	struct ath_descdma	sc_txsdma;	/* EDMA TX status desc's */
758 	struct mtx		sc_txbuflock;	/* txbuf lock */
759 	char			sc_txname[12];	/* e.g. "ath0_buf" */
760 	u_int			sc_txqsetup;	/* h/w queues setup */
761 	u_int			sc_txintrperiod;/* tx interrupt batching */
762 	struct ath_txq		sc_txq[HAL_NUM_TX_QUEUES];
763 	struct ath_txq		*sc_ac2q[5];	/* WME AC -> h/w q map */
764 	struct task		sc_txtask;	/* tx int processing */
765 	struct task		sc_txqtask;	/* tx proc processing */
766 
767 	struct ath_descdma	sc_txcompdma;	/* TX EDMA completion */
768 	struct mtx		sc_txcomplock;	/* TX EDMA completion lock */
769 	char			sc_txcompname[12];	/* eg ath0_txcomp */
770 
771 	int			sc_wd_timer;	/* count down for wd timer */
772 	struct callout		sc_wd_ch;	/* tx watchdog timer */
773 	struct ath_tx_radiotap_header sc_tx_th;
774 	int			sc_tx_th_len;
775 
776 	struct ath_descdma	sc_bdma;	/* beacon descriptors */
777 	ath_bufhead		sc_bbuf;	/* beacon buffers */
778 	u_int			sc_bhalq;	/* HAL q for outgoing beacons */
779 	u_int			sc_bmisscount;	/* missed beacon transmits */
780 	u_int32_t		sc_ant_tx[8];	/* recent tx frames/antenna */
781 	struct ath_txq		*sc_cabq;	/* tx q for cab frames */
782 	struct task		sc_bmisstask;	/* bmiss int processing */
783 	struct task		sc_bstucktask;	/* stuck beacon processing */
784 	struct task		sc_resettask;	/* interface reset task */
785 	struct task		sc_fataltask;	/* fatal task */
786 	enum {
787 		OK,				/* no change needed */
788 		UPDATE,				/* update pending */
789 		COMMIT				/* beacon sent, commit change */
790 	} sc_updateslot;			/* slot time update fsm */
791 	int			sc_slotupdate;	/* slot to advance fsm */
792 	struct ieee80211vap	*sc_bslot[ATH_BCBUF];
793 	int			sc_nbcnvaps;	/* # vaps with beacons */
794 
795 	struct callout		sc_cal_ch;	/* callout handle for cals */
796 	int			sc_lastlongcal;	/* last long cal completed */
797 	int			sc_lastcalreset;/* last cal reset done */
798 	int			sc_lastani;	/* last ANI poll */
799 	int			sc_lastshortcal;	/* last short calibration */
800 	HAL_BOOL		sc_doresetcal;	/* Yes, we're doing a reset cal atm */
801 	HAL_NODE_STATS		sc_halstats;	/* station-mode rssi stats */
802 	u_int			sc_tdmadbaprep;	/* TDMA DBA prep time */
803 	u_int			sc_tdmaswbaprep;/* TDMA SWBA prep time */
804 	u_int			sc_tdmaswba;	/* TDMA SWBA counter */
805 	u_int32_t		sc_tdmabintval;	/* TDMA beacon interval (TU) */
806 	u_int32_t		sc_tdmaguard;	/* TDMA guard time (usec) */
807 	u_int			sc_tdmaslotlen;	/* TDMA slot length (usec) */
808 	u_int32_t		sc_avgtsfdeltap;/* TDMA slot adjust (+) */
809 	u_int32_t		sc_avgtsfdeltam;/* TDMA slot adjust (-) */
810 	uint16_t		*sc_eepromdata;	/* Local eeprom data, if AR9100 */
811 	uint32_t		sc_txchainmask;	/* hardware TX chainmask */
812 	uint32_t		sc_rxchainmask;	/* hardware RX chainmask */
813 	uint32_t		sc_cur_txchainmask;	/* currently configured TX chainmask */
814 	uint32_t		sc_cur_rxchainmask;	/* currently configured RX chainmask */
815 	uint32_t		sc_rts_aggr_limit;	/* TX limit on RTS aggregates */
816 	int			sc_aggr_limit;	/* TX limit on all aggregates */
817 	int			sc_delim_min_pad;	/* Minimum delimiter count */
818 
819 	/* Queue limits */
820 
821 	/*
822 	 * To avoid queue starvation in congested conditions,
823 	 * these parameters tune the maximum number of frames
824 	 * queued to the data/mcastq before they're dropped.
825 	 *
826 	 * This is to prevent:
827 	 * + a single destination overwhelming everything, including
828 	 *   management/multicast frames;
829 	 * + multicast frames overwhelming everything (when the
830 	 *   air is sufficiently busy that cabq can't drain.)
831 	 * + A node in powersave shouldn't be allowed to exhaust
832 	 *   all available mbufs;
833 	 *
834 	 * These implement:
835 	 * + data_minfree is the maximum number of free buffers
836 	 *   overall to successfully allow a data frame.
837 	 *
838 	 * + mcastq_maxdepth is the maximum depth allowed of the cabq.
839 	 */
840 	int			sc_txq_node_maxdepth;
841 	int			sc_txq_data_minfree;
842 	int			sc_txq_mcastq_maxdepth;
843 	int			sc_txq_node_psq_maxdepth;
844 
845 	/*
846 	 * Software queue twiddles
847 	 *
848 	 * hwq_limit_nonaggr:
849 	 *		when to begin limiting non-aggregate frames to the
850 	 *		hardware queue, regardless of the TID.
851 	 * hwq_limit_aggr:
852 	 *		when to begin limiting A-MPDU frames to the
853 	 *		hardware queue, regardless of the TID.
854 	 * tid_hwq_lo:	how low the per-TID hwq count has to be before the
855 	 *		TID will be scheduled again
856 	 * tid_hwq_hi:	how many frames to queue to the HWQ before the TID
857 	 *		stops being scheduled.
858 	 */
859 	int			sc_hwq_limit_nonaggr;
860 	int			sc_hwq_limit_aggr;
861 	int			sc_tid_hwq_lo;
862 	int			sc_tid_hwq_hi;
863 
864 	/* DFS related state */
865 	void			*sc_dfs;	/* Used by an optional DFS module */
866 	int			sc_dodfs;	/* Whether to enable DFS rx filter bits */
867 	struct task		sc_dfstask;	/* DFS processing task */
868 
869 	/* Spectral related state */
870 	void			*sc_spectral;
871 	int			sc_dospectral;
872 
873 	/* LNA diversity related state */
874 	void			*sc_lna_div;
875 	int			sc_dolnadiv;
876 
877 	/* ALQ */
878 #ifdef	ATH_DEBUG_ALQ
879 	struct if_ath_alq sc_alq;
880 #endif
881 
882 	/* TX AMPDU handling */
883 	int			(*sc_addba_request)(struct ieee80211_node *,
884 				    struct ieee80211_tx_ampdu *, int, int, int);
885 	int			(*sc_addba_response)(struct ieee80211_node *,
886 				    struct ieee80211_tx_ampdu *, int, int, int);
887 	void			(*sc_addba_stop)(struct ieee80211_node *,
888 				    struct ieee80211_tx_ampdu *);
889 	void			(*sc_addba_response_timeout)
890 				    (struct ieee80211_node *,
891 				    struct ieee80211_tx_ampdu *);
892 	void			(*sc_bar_response)(struct ieee80211_node *ni,
893 				    struct ieee80211_tx_ampdu *tap,
894 				    int status);
895 
896 	/*
897 	 * Powersave state tracking.
898 	 *
899 	 * target/cur powerstate is the chip power state.
900 	 * target selfgen state is the self-generated frames
901 	 *   state.  The chip can be awake but transmitted frames
902 	 *   can have the PWRMGT bit set to 1 so the destination
903 	 *   thinks the node is asleep.
904 	 */
905 	HAL_POWER_MODE		sc_target_powerstate;
906 	HAL_POWER_MODE		sc_target_selfgen_state;
907 
908 	HAL_POWER_MODE		sc_cur_powerstate;
909 
910 	int			sc_powersave_refcnt;
911 
912 	/* ATH_PCI_* flags */
913 	uint32_t		sc_pci_devinfo;
914 
915 	/* BT coex */
916 	struct {
917 		struct ath_descdma buf;
918 
919 		/* gpm/sched buffer, saved pointers */
920 		char *sched_buf;
921 		bus_addr_t sched_paddr;
922 		char *gpm_buf;
923 		bus_addr_t gpm_paddr;
924 
925 		uint32_t wlan_channels[4];
926 	} sc_btcoex;
927 };
928 
929 #define	ATH_LOCK_INIT(_sc) \
930 	mtx_init(&(_sc)->sc_mtx, device_get_nameunit((_sc)->sc_dev), \
931 		 NULL, MTX_DEF | MTX_RECURSE)
932 #define	ATH_LOCK_DESTROY(_sc)	mtx_destroy(&(_sc)->sc_mtx)
933 #define	ATH_LOCK(_sc)		mtx_lock(&(_sc)->sc_mtx)
934 #define	ATH_UNLOCK(_sc)		mtx_unlock(&(_sc)->sc_mtx)
935 #define	ATH_LOCK_ASSERT(_sc)	mtx_assert(&(_sc)->sc_mtx, MA_OWNED)
936 #define	ATH_UNLOCK_ASSERT(_sc)	mtx_assert(&(_sc)->sc_mtx, MA_NOTOWNED)
937 
938 /*
939  * The TX lock is non-reentrant and serialises the TX frame send
940  * and completion operations.
941  */
942 #define	ATH_TX_LOCK_INIT(_sc) do {\
943 	snprintf((_sc)->sc_tx_mtx_name,				\
944 	    sizeof((_sc)->sc_tx_mtx_name),				\
945 	    "%s TX lock",						\
946 	    device_get_nameunit((_sc)->sc_dev));			\
947 	mtx_init(&(_sc)->sc_tx_mtx, (_sc)->sc_tx_mtx_name,		\
948 		 NULL, MTX_DEF);					\
949 	} while (0)
950 #define	ATH_TX_LOCK_DESTROY(_sc)	mtx_destroy(&(_sc)->sc_tx_mtx)
951 #define	ATH_TX_LOCK(_sc)		mtx_lock(&(_sc)->sc_tx_mtx)
952 #define	ATH_TX_UNLOCK(_sc)		mtx_unlock(&(_sc)->sc_tx_mtx)
953 #define	ATH_TX_LOCK_ASSERT(_sc)	mtx_assert(&(_sc)->sc_tx_mtx,	\
954 		MA_OWNED)
955 #define	ATH_TX_UNLOCK_ASSERT(_sc)	mtx_assert(&(_sc)->sc_tx_mtx,	\
956 		MA_NOTOWNED)
957 #define	ATH_TX_TRYLOCK(_sc)	(mtx_owned(&(_sc)->sc_tx_mtx) != 0 &&	\
958 					mtx_trylock(&(_sc)->sc_tx_mtx))
959 
960 /*
961  * The PCU lock is non-recursive and should be treated as a spinlock.
962  * Although currently the interrupt code is run in netisr context and
963  * doesn't require this, this may change in the future.
964  * Please keep this in mind when protecting certain code paths
965  * with the PCU lock.
966  *
967  * The PCU lock is used to serialise access to the PCU so things such
968  * as TX, RX, state change (eg channel change), channel reset and updates
969  * from interrupt context (eg kickpcu, txqactive bits) do not clash.
970  *
971  * Although the current single-thread taskqueue mechanism protects the
972  * majority of these situations by simply serialising them, there are
973  * a few others which occur at the same time. These include the TX path
974  * (which only acquires ATH_LOCK when recycling buffers to the free list),
975  * ath_set_channel, the channel scanning API and perhaps quite a bit more.
976  */
977 #define	ATH_PCU_LOCK_INIT(_sc) do {\
978 	snprintf((_sc)->sc_pcu_mtx_name,				\
979 	    sizeof((_sc)->sc_pcu_mtx_name),				\
980 	    "%s PCU lock",						\
981 	    device_get_nameunit((_sc)->sc_dev));			\
982 	mtx_init(&(_sc)->sc_pcu_mtx, (_sc)->sc_pcu_mtx_name,		\
983 		 NULL, MTX_DEF);					\
984 	} while (0)
985 #define	ATH_PCU_LOCK_DESTROY(_sc)	mtx_destroy(&(_sc)->sc_pcu_mtx)
986 #define	ATH_PCU_LOCK(_sc)		mtx_lock(&(_sc)->sc_pcu_mtx)
987 #define	ATH_PCU_UNLOCK(_sc)		mtx_unlock(&(_sc)->sc_pcu_mtx)
988 #define	ATH_PCU_LOCK_ASSERT(_sc)	mtx_assert(&(_sc)->sc_pcu_mtx,	\
989 		MA_OWNED)
990 #define	ATH_PCU_UNLOCK_ASSERT(_sc)	mtx_assert(&(_sc)->sc_pcu_mtx,	\
991 		MA_NOTOWNED)
992 
993 /*
994  * The RX lock is primarily a(nother) workaround to ensure that the
995  * RX FIFO/list isn't modified by various execution paths.
996  * Even though RX occurs in a single context (the ath taskqueue), the
997  * RX path can be executed via various reset/channel change paths.
998  */
999 #define	ATH_RX_LOCK_INIT(_sc) do {\
1000 	snprintf((_sc)->sc_rx_mtx_name,					\
1001 	    sizeof((_sc)->sc_rx_mtx_name),				\
1002 	    "%s RX lock",						\
1003 	    device_get_nameunit((_sc)->sc_dev));			\
1004 	mtx_init(&(_sc)->sc_rx_mtx, (_sc)->sc_rx_mtx_name,		\
1005 		 NULL, MTX_DEF);					\
1006 	} while (0)
1007 #define	ATH_RX_LOCK_DESTROY(_sc)	mtx_destroy(&(_sc)->sc_rx_mtx)
1008 #define	ATH_RX_LOCK(_sc)		mtx_lock(&(_sc)->sc_rx_mtx)
1009 #define	ATH_RX_UNLOCK(_sc)		mtx_unlock(&(_sc)->sc_rx_mtx)
1010 #define	ATH_RX_LOCK_ASSERT(_sc)	mtx_assert(&(_sc)->sc_rx_mtx,	\
1011 		MA_OWNED)
1012 #define	ATH_RX_UNLOCK_ASSERT(_sc)	mtx_assert(&(_sc)->sc_rx_mtx,	\
1013 		MA_NOTOWNED)
1014 
1015 #define	ATH_TXQ_SETUP(sc, i)	((sc)->sc_txqsetup & (1<<i))
1016 
1017 #define	ATH_TXBUF_LOCK_INIT(_sc) do { \
1018 	snprintf((_sc)->sc_txname, sizeof((_sc)->sc_txname), "%s_buf", \
1019 		device_get_nameunit((_sc)->sc_dev)); \
1020 	mtx_init(&(_sc)->sc_txbuflock, (_sc)->sc_txname, NULL, MTX_DEF); \
1021 } while (0)
1022 #define	ATH_TXBUF_LOCK_DESTROY(_sc)	mtx_destroy(&(_sc)->sc_txbuflock)
1023 #define	ATH_TXBUF_LOCK(_sc)		mtx_lock(&(_sc)->sc_txbuflock)
1024 #define	ATH_TXBUF_UNLOCK(_sc)		mtx_unlock(&(_sc)->sc_txbuflock)
1025 #define	ATH_TXBUF_LOCK_ASSERT(_sc) \
1026 	mtx_assert(&(_sc)->sc_txbuflock, MA_OWNED)
1027 #define	ATH_TXBUF_UNLOCK_ASSERT(_sc) \
1028 	mtx_assert(&(_sc)->sc_txbuflock, MA_NOTOWNED)
1029 
1030 #define	ATH_TXSTATUS_LOCK_INIT(_sc) do { \
1031 	snprintf((_sc)->sc_txcompname, sizeof((_sc)->sc_txcompname), \
1032 		"%s_buf", \
1033 		device_get_nameunit((_sc)->sc_dev)); \
1034 	mtx_init(&(_sc)->sc_txcomplock, (_sc)->sc_txcompname, NULL, \
1035 		MTX_DEF); \
1036 } while (0)
1037 #define	ATH_TXSTATUS_LOCK_DESTROY(_sc)	mtx_destroy(&(_sc)->sc_txcomplock)
1038 #define	ATH_TXSTATUS_LOCK(_sc)		mtx_lock(&(_sc)->sc_txcomplock)
1039 #define	ATH_TXSTATUS_UNLOCK(_sc)	mtx_unlock(&(_sc)->sc_txcomplock)
1040 #define	ATH_TXSTATUS_LOCK_ASSERT(_sc) \
1041 	mtx_assert(&(_sc)->sc_txcomplock, MA_OWNED)
1042 
1043 int	ath_attach(u_int16_t, struct ath_softc *);
1044 int	ath_detach(struct ath_softc *);
1045 void	ath_resume(struct ath_softc *);
1046 void	ath_suspend(struct ath_softc *);
1047 void	ath_shutdown(struct ath_softc *);
1048 void	ath_intr(void *);
1049 
1050 /*
1051  * HAL definitions to comply with local coding convention.
1052  */
1053 #define	ath_hal_detach(_ah) \
1054 	((*(_ah)->ah_detach)((_ah)))
1055 #define	ath_hal_reset(_ah, _opmode, _chan, _fullreset, _resettype, _pstatus) \
1056 	((*(_ah)->ah_reset)((_ah), (_opmode), (_chan), (_fullreset), \
1057 	    (_resettype), (_pstatus)))
1058 #define	ath_hal_macversion(_ah) \
1059 	(((_ah)->ah_macVersion << 4) | ((_ah)->ah_macRev))
1060 #define	ath_hal_getratetable(_ah, _mode) \
1061 	((*(_ah)->ah_getRateTable)((_ah), (_mode)))
1062 #define	ath_hal_getmac(_ah, _mac) \
1063 	((*(_ah)->ah_getMacAddress)((_ah), (_mac)))
1064 #define	ath_hal_setmac(_ah, _mac) \
1065 	((*(_ah)->ah_setMacAddress)((_ah), (_mac)))
1066 #define	ath_hal_getbssidmask(_ah, _mask) \
1067 	((*(_ah)->ah_getBssIdMask)((_ah), (_mask)))
1068 #define	ath_hal_setbssidmask(_ah, _mask) \
1069 	((*(_ah)->ah_setBssIdMask)((_ah), (_mask)))
1070 #define	ath_hal_intrset(_ah, _mask) \
1071 	((*(_ah)->ah_setInterrupts)((_ah), (_mask)))
1072 #define	ath_hal_intrget(_ah) \
1073 	((*(_ah)->ah_getInterrupts)((_ah)))
1074 #define	ath_hal_intrpend(_ah) \
1075 	((*(_ah)->ah_isInterruptPending)((_ah)))
1076 #define	ath_hal_getisr(_ah, _pmask) \
1077 	((*(_ah)->ah_getPendingInterrupts)((_ah), (_pmask)))
1078 #define	ath_hal_updatetxtriglevel(_ah, _inc) \
1079 	((*(_ah)->ah_updateTxTrigLevel)((_ah), (_inc)))
1080 #define	ath_hal_setpower(_ah, _mode) \
1081 	((*(_ah)->ah_setPowerMode)((_ah), (_mode), AH_TRUE))
1082 #define	ath_hal_setselfgenpower(_ah, _mode) \
1083 	((*(_ah)->ah_setPowerMode)((_ah), (_mode), AH_FALSE))
1084 #define	ath_hal_keycachesize(_ah) \
1085 	((*(_ah)->ah_getKeyCacheSize)((_ah)))
1086 #define	ath_hal_keyreset(_ah, _ix) \
1087 	((*(_ah)->ah_resetKeyCacheEntry)((_ah), (_ix)))
1088 #define	ath_hal_keyset(_ah, _ix, _pk, _mac) \
1089 	((*(_ah)->ah_setKeyCacheEntry)((_ah), (_ix), (_pk), (_mac), AH_FALSE))
1090 #define	ath_hal_keyisvalid(_ah, _ix) \
1091 	(((*(_ah)->ah_isKeyCacheEntryValid)((_ah), (_ix))))
1092 #define	ath_hal_keysetmac(_ah, _ix, _mac) \
1093 	((*(_ah)->ah_setKeyCacheEntryMac)((_ah), (_ix), (_mac)))
1094 #define	ath_hal_getrxfilter(_ah) \
1095 	((*(_ah)->ah_getRxFilter)((_ah)))
1096 #define	ath_hal_setrxfilter(_ah, _filter) \
1097 	((*(_ah)->ah_setRxFilter)((_ah), (_filter)))
1098 #define	ath_hal_setmcastfilter(_ah, _mfilt0, _mfilt1) \
1099 	((*(_ah)->ah_setMulticastFilter)((_ah), (_mfilt0), (_mfilt1)))
1100 #define	ath_hal_waitforbeacon(_ah, _bf) \
1101 	((*(_ah)->ah_waitForBeaconDone)((_ah), (_bf)->bf_daddr))
1102 #define	ath_hal_putrxbuf(_ah, _bufaddr, _rxq) \
1103 	((*(_ah)->ah_setRxDP)((_ah), (_bufaddr), (_rxq)))
1104 /* NB: common across all chips */
1105 #define	AR_TSF_L32	0x804c	/* MAC local clock lower 32 bits */
1106 #define	ath_hal_gettsf32(_ah) \
1107 	OS_REG_READ(_ah, AR_TSF_L32)
1108 #define	ath_hal_gettsf64(_ah) \
1109 	((*(_ah)->ah_getTsf64)((_ah)))
1110 #define	ath_hal_settsf64(_ah, _val) \
1111 	((*(_ah)->ah_setTsf64)((_ah), (_val)))
1112 #define	ath_hal_resettsf(_ah) \
1113 	((*(_ah)->ah_resetTsf)((_ah)))
1114 #define	ath_hal_rxena(_ah) \
1115 	((*(_ah)->ah_enableReceive)((_ah)))
1116 #define	ath_hal_puttxbuf(_ah, _q, _bufaddr) \
1117 	((*(_ah)->ah_setTxDP)((_ah), (_q), (_bufaddr)))
1118 #define	ath_hal_gettxbuf(_ah, _q) \
1119 	((*(_ah)->ah_getTxDP)((_ah), (_q)))
1120 #define	ath_hal_numtxpending(_ah, _q) \
1121 	((*(_ah)->ah_numTxPending)((_ah), (_q)))
1122 #define	ath_hal_getrxbuf(_ah, _rxq) \
1123 	((*(_ah)->ah_getRxDP)((_ah), (_rxq)))
1124 #define	ath_hal_txstart(_ah, _q) \
1125 	((*(_ah)->ah_startTxDma)((_ah), (_q)))
1126 #define	ath_hal_setchannel(_ah, _chan) \
1127 	((*(_ah)->ah_setChannel)((_ah), (_chan)))
1128 #define	ath_hal_calibrate(_ah, _chan, _iqcal) \
1129 	((*(_ah)->ah_perCalibration)((_ah), (_chan), (_iqcal)))
1130 #define	ath_hal_calibrateN(_ah, _chan, _lcal, _isdone) \
1131 	((*(_ah)->ah_perCalibrationN)((_ah), (_chan), 0x1, (_lcal), (_isdone)))
1132 #define	ath_hal_calreset(_ah, _chan) \
1133 	((*(_ah)->ah_resetCalValid)((_ah), (_chan)))
1134 #define	ath_hal_setledstate(_ah, _state) \
1135 	((*(_ah)->ah_setLedState)((_ah), (_state)))
1136 #define	ath_hal_beaconinit(_ah, _nextb, _bperiod) \
1137 	((*(_ah)->ah_beaconInit)((_ah), (_nextb), (_bperiod)))
1138 #define	ath_hal_beaconreset(_ah) \
1139 	((*(_ah)->ah_resetStationBeaconTimers)((_ah)))
1140 #define	ath_hal_beaconsettimers(_ah, _bt) \
1141 	((*(_ah)->ah_setBeaconTimers)((_ah), (_bt)))
1142 #define	ath_hal_beacontimers(_ah, _bs) \
1143 	((*(_ah)->ah_setStationBeaconTimers)((_ah), (_bs)))
1144 #define	ath_hal_getnexttbtt(_ah) \
1145 	((*(_ah)->ah_getNextTBTT)((_ah)))
1146 #define	ath_hal_setassocid(_ah, _bss, _associd) \
1147 	((*(_ah)->ah_writeAssocid)((_ah), (_bss), (_associd)))
1148 #define	ath_hal_phydisable(_ah) \
1149 	((*(_ah)->ah_phyDisable)((_ah)))
1150 #define	ath_hal_setopmode(_ah) \
1151 	((*(_ah)->ah_setPCUConfig)((_ah)))
1152 #define	ath_hal_stoptxdma(_ah, _qnum) \
1153 	((*(_ah)->ah_stopTxDma)((_ah), (_qnum)))
1154 #define	ath_hal_stoppcurecv(_ah) \
1155 	((*(_ah)->ah_stopPcuReceive)((_ah)))
1156 #define	ath_hal_startpcurecv(_ah) \
1157 	((*(_ah)->ah_startPcuReceive)((_ah)))
1158 #define	ath_hal_stopdmarecv(_ah) \
1159 	((*(_ah)->ah_stopDmaReceive)((_ah)))
1160 #define	ath_hal_getdiagstate(_ah, _id, _indata, _insize, _outdata, _outsize) \
1161 	((*(_ah)->ah_getDiagState)((_ah), (_id), \
1162 		(_indata), (_insize), (_outdata), (_outsize)))
1163 #define	ath_hal_getfatalstate(_ah, _outdata, _outsize) \
1164 	ath_hal_getdiagstate(_ah, 29, NULL, 0, (_outdata), _outsize)
1165 #define	ath_hal_setuptxqueue(_ah, _type, _irq) \
1166 	((*(_ah)->ah_setupTxQueue)((_ah), (_type), (_irq)))
1167 #define	ath_hal_resettxqueue(_ah, _q) \
1168 	((*(_ah)->ah_resetTxQueue)((_ah), (_q)))
1169 #define	ath_hal_releasetxqueue(_ah, _q) \
1170 	((*(_ah)->ah_releaseTxQueue)((_ah), (_q)))
1171 #define	ath_hal_gettxqueueprops(_ah, _q, _qi) \
1172 	((*(_ah)->ah_getTxQueueProps)((_ah), (_q), (_qi)))
1173 #define	ath_hal_settxqueueprops(_ah, _q, _qi) \
1174 	((*(_ah)->ah_setTxQueueProps)((_ah), (_q), (_qi)))
1175 /* NB: common across all chips */
1176 #define	AR_Q_TXE	0x0840	/* MAC Transmit Queue enable */
1177 #define	ath_hal_txqenabled(_ah, _qnum) \
1178 	(OS_REG_READ(_ah, AR_Q_TXE) & (1<<(_qnum)))
1179 #define	ath_hal_getrfgain(_ah) \
1180 	((*(_ah)->ah_getRfGain)((_ah)))
1181 #define	ath_hal_getdefantenna(_ah) \
1182 	((*(_ah)->ah_getDefAntenna)((_ah)))
1183 #define	ath_hal_setdefantenna(_ah, _ant) \
1184 	((*(_ah)->ah_setDefAntenna)((_ah), (_ant)))
1185 #define	ath_hal_rxmonitor(_ah, _arg, _chan) \
1186 	((*(_ah)->ah_rxMonitor)((_ah), (_arg), (_chan)))
1187 #define	ath_hal_ani_poll(_ah, _chan) \
1188 	((*(_ah)->ah_aniPoll)((_ah), (_chan)))
1189 #define	ath_hal_mibevent(_ah, _stats) \
1190 	((*(_ah)->ah_procMibEvent)((_ah), (_stats)))
1191 #define	ath_hal_setslottime(_ah, _us) \
1192 	((*(_ah)->ah_setSlotTime)((_ah), (_us)))
1193 #define	ath_hal_getslottime(_ah) \
1194 	((*(_ah)->ah_getSlotTime)((_ah)))
1195 #define	ath_hal_setacktimeout(_ah, _us) \
1196 	((*(_ah)->ah_setAckTimeout)((_ah), (_us)))
1197 #define	ath_hal_getacktimeout(_ah) \
1198 	((*(_ah)->ah_getAckTimeout)((_ah)))
1199 #define	ath_hal_setctstimeout(_ah, _us) \
1200 	((*(_ah)->ah_setCTSTimeout)((_ah), (_us)))
1201 #define	ath_hal_getctstimeout(_ah) \
1202 	((*(_ah)->ah_getCTSTimeout)((_ah)))
1203 #define	ath_hal_getcapability(_ah, _cap, _param, _result) \
1204 	((*(_ah)->ah_getCapability)((_ah), (_cap), (_param), (_result)))
1205 #define	ath_hal_setcapability(_ah, _cap, _param, _v, _status) \
1206 	((*(_ah)->ah_setCapability)((_ah), (_cap), (_param), (_v), (_status)))
1207 #define	ath_hal_ciphersupported(_ah, _cipher) \
1208 	(ath_hal_getcapability(_ah, HAL_CAP_CIPHER, _cipher, NULL) == HAL_OK)
1209 #define	ath_hal_getregdomain(_ah, _prd) \
1210 	(ath_hal_getcapability(_ah, HAL_CAP_REG_DMN, 0, (_prd)) == HAL_OK)
1211 #define	ath_hal_setregdomain(_ah, _rd) \
1212 	ath_hal_setcapability(_ah, HAL_CAP_REG_DMN, 0, _rd, NULL)
1213 #define	ath_hal_getcountrycode(_ah, _pcc) \
1214 	(*(_pcc) = (_ah)->ah_countryCode)
1215 #define	ath_hal_gettkipmic(_ah) \
1216 	(ath_hal_getcapability(_ah, HAL_CAP_TKIP_MIC, 1, NULL) == HAL_OK)
1217 #define	ath_hal_settkipmic(_ah, _v) \
1218 	ath_hal_setcapability(_ah, HAL_CAP_TKIP_MIC, 1, _v, NULL)
1219 #define	ath_hal_hastkipsplit(_ah) \
1220 	(ath_hal_getcapability(_ah, HAL_CAP_TKIP_SPLIT, 0, NULL) == HAL_OK)
1221 #define	ath_hal_gettkipsplit(_ah) \
1222 	(ath_hal_getcapability(_ah, HAL_CAP_TKIP_SPLIT, 1, NULL) == HAL_OK)
1223 #define	ath_hal_settkipsplit(_ah, _v) \
1224 	ath_hal_setcapability(_ah, HAL_CAP_TKIP_SPLIT, 1, _v, NULL)
1225 #define	ath_hal_haswmetkipmic(_ah) \
1226 	(ath_hal_getcapability(_ah, HAL_CAP_WME_TKIPMIC, 0, NULL) == HAL_OK)
1227 #define	ath_hal_hwphycounters(_ah) \
1228 	(ath_hal_getcapability(_ah, HAL_CAP_PHYCOUNTERS, 0, NULL) == HAL_OK)
1229 #define	ath_hal_hasdiversity(_ah) \
1230 	(ath_hal_getcapability(_ah, HAL_CAP_DIVERSITY, 0, NULL) == HAL_OK)
1231 #define	ath_hal_getdiversity(_ah) \
1232 	(ath_hal_getcapability(_ah, HAL_CAP_DIVERSITY, 1, NULL) == HAL_OK)
1233 #define	ath_hal_setdiversity(_ah, _v) \
1234 	ath_hal_setcapability(_ah, HAL_CAP_DIVERSITY, 1, _v, NULL)
1235 #define	ath_hal_getantennaswitch(_ah) \
1236 	((*(_ah)->ah_getAntennaSwitch)((_ah)))
1237 #define	ath_hal_setantennaswitch(_ah, _v) \
1238 	((*(_ah)->ah_setAntennaSwitch)((_ah), (_v)))
1239 #define	ath_hal_getdiag(_ah, _pv) \
1240 	(ath_hal_getcapability(_ah, HAL_CAP_DIAG, 0, _pv) == HAL_OK)
1241 #define	ath_hal_setdiag(_ah, _v) \
1242 	ath_hal_setcapability(_ah, HAL_CAP_DIAG, 0, _v, NULL)
1243 #define	ath_hal_getnumtxqueues(_ah, _pv) \
1244 	(ath_hal_getcapability(_ah, HAL_CAP_NUM_TXQUEUES, 0, _pv) == HAL_OK)
1245 #define	ath_hal_hasveol(_ah) \
1246 	(ath_hal_getcapability(_ah, HAL_CAP_VEOL, 0, NULL) == HAL_OK)
1247 #define	ath_hal_hastxpowlimit(_ah) \
1248 	(ath_hal_getcapability(_ah, HAL_CAP_TXPOW, 0, NULL) == HAL_OK)
1249 #define	ath_hal_settxpowlimit(_ah, _pow) \
1250 	((*(_ah)->ah_setTxPowerLimit)((_ah), (_pow)))
1251 #define	ath_hal_gettxpowlimit(_ah, _ppow) \
1252 	(ath_hal_getcapability(_ah, HAL_CAP_TXPOW, 1, _ppow) == HAL_OK)
1253 #define	ath_hal_getmaxtxpow(_ah, _ppow) \
1254 	(ath_hal_getcapability(_ah, HAL_CAP_TXPOW, 2, _ppow) == HAL_OK)
1255 #define	ath_hal_gettpscale(_ah, _scale) \
1256 	(ath_hal_getcapability(_ah, HAL_CAP_TXPOW, 3, _scale) == HAL_OK)
1257 #define	ath_hal_settpscale(_ah, _v) \
1258 	ath_hal_setcapability(_ah, HAL_CAP_TXPOW, 3, _v, NULL)
1259 #define	ath_hal_hastpc(_ah) \
1260 	(ath_hal_getcapability(_ah, HAL_CAP_TPC, 0, NULL) == HAL_OK)
1261 #define	ath_hal_gettpc(_ah) \
1262 	(ath_hal_getcapability(_ah, HAL_CAP_TPC, 1, NULL) == HAL_OK)
1263 #define	ath_hal_settpc(_ah, _v) \
1264 	ath_hal_setcapability(_ah, HAL_CAP_TPC, 1, _v, NULL)
1265 #define	ath_hal_hasbursting(_ah) \
1266 	(ath_hal_getcapability(_ah, HAL_CAP_BURST, 0, NULL) == HAL_OK)
1267 #define	ath_hal_setmcastkeysearch(_ah, _v) \
1268 	ath_hal_setcapability(_ah, HAL_CAP_MCAST_KEYSRCH, 0, _v, NULL)
1269 #define	ath_hal_hasmcastkeysearch(_ah) \
1270 	(ath_hal_getcapability(_ah, HAL_CAP_MCAST_KEYSRCH, 0, NULL) == HAL_OK)
1271 #define	ath_hal_getmcastkeysearch(_ah) \
1272 	(ath_hal_getcapability(_ah, HAL_CAP_MCAST_KEYSRCH, 1, NULL) == HAL_OK)
1273 #define	ath_hal_hasfastframes(_ah) \
1274 	(ath_hal_getcapability(_ah, HAL_CAP_FASTFRAME, 0, NULL) == HAL_OK)
1275 #define	ath_hal_hasbssidmask(_ah) \
1276 	(ath_hal_getcapability(_ah, HAL_CAP_BSSIDMASK, 0, NULL) == HAL_OK)
1277 #define	ath_hal_hasbssidmatch(_ah) \
1278 	(ath_hal_getcapability(_ah, HAL_CAP_BSSIDMATCH, 0, NULL) == HAL_OK)
1279 #define	ath_hal_hastsfadjust(_ah) \
1280 	(ath_hal_getcapability(_ah, HAL_CAP_TSF_ADJUST, 0, NULL) == HAL_OK)
1281 #define	ath_hal_gettsfadjust(_ah) \
1282 	(ath_hal_getcapability(_ah, HAL_CAP_TSF_ADJUST, 1, NULL) == HAL_OK)
1283 #define	ath_hal_settsfadjust(_ah, _onoff) \
1284 	ath_hal_setcapability(_ah, HAL_CAP_TSF_ADJUST, 1, _onoff, NULL)
1285 #define	ath_hal_hasrfsilent(_ah) \
1286 	(ath_hal_getcapability(_ah, HAL_CAP_RFSILENT, 0, NULL) == HAL_OK)
1287 #define	ath_hal_getrfkill(_ah) \
1288 	(ath_hal_getcapability(_ah, HAL_CAP_RFSILENT, 1, NULL) == HAL_OK)
1289 #define	ath_hal_setrfkill(_ah, _onoff) \
1290 	ath_hal_setcapability(_ah, HAL_CAP_RFSILENT, 1, _onoff, NULL)
1291 #define	ath_hal_getrfsilent(_ah, _prfsilent) \
1292 	(ath_hal_getcapability(_ah, HAL_CAP_RFSILENT, 2, _prfsilent) == HAL_OK)
1293 #define	ath_hal_setrfsilent(_ah, _rfsilent) \
1294 	ath_hal_setcapability(_ah, HAL_CAP_RFSILENT, 2, _rfsilent, NULL)
1295 #define	ath_hal_gettpack(_ah, _ptpack) \
1296 	(ath_hal_getcapability(_ah, HAL_CAP_TPC_ACK, 0, _ptpack) == HAL_OK)
1297 #define	ath_hal_settpack(_ah, _tpack) \
1298 	ath_hal_setcapability(_ah, HAL_CAP_TPC_ACK, 0, _tpack, NULL)
1299 #define	ath_hal_gettpcts(_ah, _ptpcts) \
1300 	(ath_hal_getcapability(_ah, HAL_CAP_TPC_CTS, 0, _ptpcts) == HAL_OK)
1301 #define	ath_hal_settpcts(_ah, _tpcts) \
1302 	ath_hal_setcapability(_ah, HAL_CAP_TPC_CTS, 0, _tpcts, NULL)
1303 #define	ath_hal_hasintmit(_ah) \
1304 	(ath_hal_getcapability(_ah, HAL_CAP_INTMIT, \
1305 	HAL_CAP_INTMIT_PRESENT, NULL) == HAL_OK)
1306 #define	ath_hal_getintmit(_ah) \
1307 	(ath_hal_getcapability(_ah, HAL_CAP_INTMIT, \
1308 	HAL_CAP_INTMIT_ENABLE, NULL) == HAL_OK)
1309 #define	ath_hal_setintmit(_ah, _v) \
1310 	ath_hal_setcapability(_ah, HAL_CAP_INTMIT, \
1311 	HAL_CAP_INTMIT_ENABLE, _v, NULL)
1312 #define	ath_hal_hasmybeacon(_ah) \
1313 	(ath_hal_getcapability(_ah, HAL_CAP_DO_MYBEACON, 1, NULL) == HAL_OK)
1314 
1315 #define	ath_hal_hasenforcetxop(_ah) \
1316 	(ath_hal_getcapability(_ah, HAL_CAP_ENFORCE_TXOP, 0, NULL) == HAL_OK)
1317 #define	ath_hal_getenforcetxop(_ah) \
1318 	(ath_hal_getcapability(_ah, HAL_CAP_ENFORCE_TXOP, 1, NULL) == HAL_OK)
1319 #define	ath_hal_setenforcetxop(_ah, _v) \
1320 	ath_hal_setcapability(_ah, HAL_CAP_ENFORCE_TXOP, 1, _v, NULL)
1321 
1322 #define	ath_hal_hasrxlnamixer(_ah) \
1323 	(ath_hal_getcapability(_ah, HAL_CAP_RX_LNA_MIXING, 0, NULL) == HAL_OK)
1324 
1325 #define	ath_hal_hasdivantcomb(_ah) \
1326 	(ath_hal_getcapability(_ah, HAL_CAP_ANT_DIV_COMB, 0, NULL) == HAL_OK)
1327 #define	ath_hal_hasldpc(_ah) \
1328 	(ath_hal_getcapability(_ah, HAL_CAP_LDPC, 0, NULL) == HAL_OK)
1329 #define	ath_hal_hasldpcwar(_ah) \
1330 	(ath_hal_getcapability(_ah, HAL_CAP_LDPCWAR, 0, NULL) == HAL_OK)
1331 
1332 /* EDMA definitions */
1333 #define	ath_hal_hasedma(_ah) \
1334 	(ath_hal_getcapability(_ah, HAL_CAP_ENHANCED_DMA_SUPPORT,	\
1335 	0, NULL) == HAL_OK)
1336 #define	ath_hal_getrxfifodepth(_ah, _qtype, _req) \
1337 	(ath_hal_getcapability(_ah, HAL_CAP_RXFIFODEPTH, _qtype, _req)	\
1338 	== HAL_OK)
1339 #define	ath_hal_getntxmaps(_ah, _req) \
1340 	(ath_hal_getcapability(_ah, HAL_CAP_NUM_TXMAPS, 0, _req)	\
1341 	== HAL_OK)
1342 #define	ath_hal_gettxdesclen(_ah, _req) \
1343 	(ath_hal_getcapability(_ah, HAL_CAP_TXDESCLEN, 0, _req)		\
1344 	== HAL_OK)
1345 #define	ath_hal_gettxstatuslen(_ah, _req) \
1346 	(ath_hal_getcapability(_ah, HAL_CAP_TXSTATUSLEN, 0, _req)	\
1347 	== HAL_OK)
1348 #define	ath_hal_getrxstatuslen(_ah, _req) \
1349 	(ath_hal_getcapability(_ah, HAL_CAP_RXSTATUSLEN, 0, _req)	\
1350 	== HAL_OK)
1351 #define	ath_hal_setrxbufsize(_ah, _req) \
1352 	(ath_hal_setcapability(_ah, HAL_CAP_RXBUFSIZE, 0, _req, NULL)	\
1353 	== HAL_OK)
1354 
1355 #define	ath_hal_getchannoise(_ah, _c) \
1356 	((*(_ah)->ah_getChanNoise)((_ah), (_c)))
1357 
1358 /* 802.11n HAL methods */
1359 #define	ath_hal_getrxchainmask(_ah, _prxchainmask) \
1360 	(ath_hal_getcapability(_ah, HAL_CAP_RX_CHAINMASK, 0, _prxchainmask))
1361 #define	ath_hal_gettxchainmask(_ah, _ptxchainmask) \
1362 	(ath_hal_getcapability(_ah, HAL_CAP_TX_CHAINMASK, 0, _ptxchainmask))
1363 #define	ath_hal_setrxchainmask(_ah, _rx) \
1364 	(ath_hal_setcapability(_ah, HAL_CAP_RX_CHAINMASK, 1, _rx, NULL))
1365 #define	ath_hal_settxchainmask(_ah, _tx) \
1366 	(ath_hal_setcapability(_ah, HAL_CAP_TX_CHAINMASK, 1, _tx, NULL))
1367 #define	ath_hal_split4ktrans(_ah) \
1368 	(ath_hal_getcapability(_ah, HAL_CAP_SPLIT_4KB_TRANS, \
1369 	0, NULL) == HAL_OK)
1370 #define	ath_hal_self_linked_final_rxdesc(_ah) \
1371 	(ath_hal_getcapability(_ah, HAL_CAP_RXDESC_SELFLINK, \
1372 	0, NULL) == HAL_OK)
1373 #define	ath_hal_gtxto_supported(_ah) \
1374 	(ath_hal_getcapability(_ah, HAL_CAP_GTXTO, 0, NULL) == HAL_OK)
1375 #define	ath_hal_get_rx_tsf_prec(_ah, _pr) \
1376 	(ath_hal_getcapability((_ah), HAL_CAP_RXTSTAMP_PREC, 0, (_pr)) \
1377 	    == HAL_OK)
1378 #define	ath_hal_get_tx_tsf_prec(_ah, _pr) \
1379 	(ath_hal_getcapability((_ah), HAL_CAP_TXTSTAMP_PREC, 0, (_pr)) \
1380 	    == HAL_OK)
1381 #define	ath_hal_setuprxdesc(_ah, _ds, _size, _intreq) \
1382 	((*(_ah)->ah_setupRxDesc)((_ah), (_ds), (_size), (_intreq)))
1383 #define	ath_hal_rxprocdesc(_ah, _ds, _dspa, _dsnext, _rs) \
1384 	((*(_ah)->ah_procRxDesc)((_ah), (_ds), (_dspa), (_dsnext), 0, (_rs)))
1385 #define	ath_hal_setuptxdesc(_ah, _ds, _plen, _hlen, _atype, _txpow, \
1386 		_txr0, _txtr0, _keyix, _ant, _flags, \
1387 		_rtsrate, _rtsdura) \
1388 	((*(_ah)->ah_setupTxDesc)((_ah), (_ds), (_plen), (_hlen), (_atype), \
1389 		(_txpow), (_txr0), (_txtr0), (_keyix), (_ant), \
1390 		(_flags), (_rtsrate), (_rtsdura), 0, 0, 0))
1391 #define	ath_hal_setupxtxdesc(_ah, _ds, \
1392 		_txr1, _txtr1, _txr2, _txtr2, _txr3, _txtr3) \
1393 	((*(_ah)->ah_setupXTxDesc)((_ah), (_ds), \
1394 		(_txr1), (_txtr1), (_txr2), (_txtr2), (_txr3), (_txtr3)))
1395 #define	ath_hal_filltxdesc(_ah, _ds, _b, _l, _did, _qid, _first, _last, _ds0) \
1396 	((*(_ah)->ah_fillTxDesc)((_ah), (_ds), (_b), (_l), (_did), (_qid), \
1397 		(_first), (_last), (_ds0)))
1398 #define	ath_hal_txprocdesc(_ah, _ds, _ts) \
1399 	((*(_ah)->ah_procTxDesc)((_ah), (_ds), (_ts)))
1400 #define	ath_hal_gettxintrtxqs(_ah, _txqs) \
1401 	((*(_ah)->ah_getTxIntrQueue)((_ah), (_txqs)))
1402 #define ath_hal_gettxcompletionrates(_ah, _ds, _rates, _tries) \
1403 	((*(_ah)->ah_getTxCompletionRates)((_ah), (_ds), (_rates), (_tries)))
1404 #define ath_hal_settxdesclink(_ah, _ds, _link) \
1405 	((*(_ah)->ah_setTxDescLink)((_ah), (_ds), (_link)))
1406 #define ath_hal_gettxdesclink(_ah, _ds, _link) \
1407 	((*(_ah)->ah_getTxDescLink)((_ah), (_ds), (_link)))
1408 #define ath_hal_gettxdesclinkptr(_ah, _ds, _linkptr) \
1409 	((*(_ah)->ah_getTxDescLinkPtr)((_ah), (_ds), (_linkptr)))
1410 #define	ath_hal_setuptxstatusring(_ah, _tsstart, _tspstart, _size) \
1411 	((*(_ah)->ah_setupTxStatusRing)((_ah), (_tsstart), (_tspstart), \
1412 		(_size)))
1413 #define	ath_hal_gettxrawtxdesc(_ah, _txstatus) \
1414 	((*(_ah)->ah_getTxRawTxDesc)((_ah), (_txstatus)))
1415 
1416 #define	ath_hal_setupfirsttxdesc(_ah, _ds, _aggrlen, _flags, _txpower, \
1417 		_txr0, _txtr0, _antm, _rcr, _rcd) \
1418 	((*(_ah)->ah_setupFirstTxDesc)((_ah), (_ds), (_aggrlen), (_flags), \
1419 	(_txpower), (_txr0), (_txtr0), (_antm), (_rcr), (_rcd)))
1420 #define	ath_hal_chaintxdesc(_ah, _ds, _bl, _sl, _pktlen, _hdrlen, _type, \
1421 	_keyix, _cipher, _delims, _first, _last, _lastaggr) \
1422 	((*(_ah)->ah_chainTxDesc)((_ah), (_ds), (_bl), (_sl), \
1423 	(_pktlen), (_hdrlen), (_type), (_keyix), (_cipher), (_delims), \
1424 	(_first), (_last), (_lastaggr)))
1425 #define	ath_hal_setuplasttxdesc(_ah, _ds, _ds0) \
1426 	((*(_ah)->ah_setupLastTxDesc)((_ah), (_ds), (_ds0)))
1427 
1428 #define	ath_hal_set11nratescenario(_ah, _ds, _dur, _rt, _series, _ns, _flags) \
1429 	((*(_ah)->ah_set11nRateScenario)((_ah), (_ds), (_dur), (_rt), \
1430 	(_series), (_ns), (_flags)))
1431 
1432 #define	ath_hal_set11n_aggr_first(_ah, _ds, _len, _num) \
1433 	((*(_ah)->ah_set11nAggrFirst)((_ah), (_ds), (_len), (_num)))
1434 #define	ath_hal_set11n_aggr_middle(_ah, _ds, _num) \
1435 	((*(_ah)->ah_set11nAggrMiddle)((_ah), (_ds), (_num)))
1436 #define	ath_hal_set11n_aggr_last(_ah, _ds) \
1437 	((*(_ah)->ah_set11nAggrLast)((_ah), (_ds)))
1438 
1439 #define	ath_hal_set11nburstduration(_ah, _ds, _dur) \
1440 	((*(_ah)->ah_set11nBurstDuration)((_ah), (_ds), (_dur)))
1441 #define	ath_hal_clr11n_aggr(_ah, _ds) \
1442 	((*(_ah)->ah_clr11nAggr)((_ah), (_ds)))
1443 #define	ath_hal_set11n_virtmorefrag(_ah, _ds, _v) \
1444 	((*(_ah)->ah_set11nVirtMoreFrag)((_ah), (_ds), (_v)))
1445 
1446 #define	ath_hal_gpioCfgOutput(_ah, _gpio, _type) \
1447 	((*(_ah)->ah_gpioCfgOutput)((_ah), (_gpio), (_type)))
1448 #define	ath_hal_gpioset(_ah, _gpio, _b) \
1449 	((*(_ah)->ah_gpioSet)((_ah), (_gpio), (_b)))
1450 #define	ath_hal_gpioget(_ah, _gpio) \
1451 	((*(_ah)->ah_gpioGet)((_ah), (_gpio)))
1452 #define	ath_hal_gpiosetintr(_ah, _gpio, _b) \
1453 	((*(_ah)->ah_gpioSetIntr)((_ah), (_gpio), (_b)))
1454 
1455 /*
1456  * PCIe suspend/resume/poweron/poweroff related macros
1457  */
1458 #define	ath_hal_enablepcie(_ah, _restore, _poweroff) \
1459 	((*(_ah)->ah_configPCIE)((_ah), (_restore), (_poweroff)))
1460 #define	ath_hal_disablepcie(_ah) \
1461 	((*(_ah)->ah_disablePCIE)((_ah)))
1462 
1463 /*
1464  * This is badly-named; you need to set the correct parameters
1465  * to begin to receive useful radar events; and even then
1466  * it doesn't "enable" DFS. See the ath_dfs/null/ module for
1467  * more information.
1468  */
1469 #define	ath_hal_enabledfs(_ah, _param) \
1470 	((*(_ah)->ah_enableDfs)((_ah), (_param)))
1471 #define	ath_hal_getdfsthresh(_ah, _param) \
1472 	((*(_ah)->ah_getDfsThresh)((_ah), (_param)))
1473 #define	ath_hal_getdfsdefaultthresh(_ah, _param) \
1474 	((*(_ah)->ah_getDfsDefaultThresh)((_ah), (_param)))
1475 #define	ath_hal_procradarevent(_ah, _rxs, _fulltsf, _buf, _event) \
1476 	((*(_ah)->ah_procRadarEvent)((_ah), (_rxs), (_fulltsf), \
1477 	(_buf), (_event)))
1478 #define	ath_hal_is_fast_clock_enabled(_ah) \
1479 	((*(_ah)->ah_isFastClockEnabled)((_ah)))
1480 #define	ath_hal_radar_wait(_ah, _chan) \
1481 	((*(_ah)->ah_radarWait)((_ah), (_chan)))
1482 #define	ath_hal_get_mib_cycle_counts(_ah, _sample) \
1483 	((*(_ah)->ah_getMibCycleCounts)((_ah), (_sample)))
1484 #define	ath_hal_get_chan_ext_busy(_ah) \
1485 	((*(_ah)->ah_get11nExtBusy)((_ah)))
1486 #define	ath_hal_setchainmasks(_ah, _txchainmask, _rxchainmask) \
1487 	((*(_ah)->ah_setChainMasks)((_ah), (_txchainmask), (_rxchainmask)))
1488 #define	ath_hal_set_quiet(_ah, _p, _d, _o, _f) \
1489 	((*(_ah)->ah_setQuiet)((_ah), (_p), (_d), (_o), (_f)))
1490 
1491 #define	ath_hal_spectral_supported(_ah) \
1492 	(ath_hal_getcapability(_ah, HAL_CAP_SPECTRAL_SCAN, 0, NULL) == HAL_OK)
1493 #define	ath_hal_spectral_get_config(_ah, _p) \
1494 	((*(_ah)->ah_spectralGetConfig)((_ah), (_p)))
1495 #define	ath_hal_spectral_configure(_ah, _p) \
1496 	((*(_ah)->ah_spectralConfigure)((_ah), (_p)))
1497 #define	ath_hal_spectral_start(_ah) \
1498 	((*(_ah)->ah_spectralStart)((_ah)))
1499 #define	ath_hal_spectral_stop(_ah) \
1500 	((*(_ah)->ah_spectralStop)((_ah)))
1501 
1502 #define	ath_hal_btcoex_supported(_ah) \
1503 	(ath_hal_getcapability(_ah, HAL_CAP_BT_COEX, 0, NULL) == HAL_OK)
1504 #define	ath_hal_btcoex_set_info(_ah, _info) \
1505 	((*(_ah)->ah_btCoexSetInfo)((_ah), (_info)))
1506 #define	ath_hal_btcoex_set_config(_ah, _cfg) \
1507 	((*(_ah)->ah_btCoexSetConfig)((_ah), (_cfg)))
1508 #define	ath_hal_btcoex_set_qcu_thresh(_ah, _qcuid) \
1509 	((*(_ah)->ah_btCoexSetQcuThresh)((_ah), (_qcuid)))
1510 #define	ath_hal_btcoex_set_weights(_ah, _weight) \
1511 	((*(_ah)->ah_btCoexSetWeights)((_ah), (_weight)))
1512 #define	ath_hal_btcoex_set_bmiss_thresh(_ah, _thr) \
1513 	((*(_ah)->ah_btCoexSetBmissThresh)((_ah), (_thr)))
1514 #define	ath_hal_btcoex_set_parameter(_ah, _attrib, _val) \
1515 	((*(_ah)->ah_btCoexSetParameter)((_ah), (_attrib), (_val)))
1516 #define	ath_hal_btcoex_enable(_ah) \
1517 	((*(_ah)->ah_btCoexEnable)((_ah)))
1518 #define	ath_hal_btcoex_disable(_ah) \
1519 	((*(_ah)->ah_btCoexDisable)((_ah)))
1520 
1521 #define	ath_hal_btcoex_mci_setup(_ah, _gp, _gb, _gl, _sp) \
1522 	((*(_ah)->ah_btMciSetup)((_ah), (_gp), (_gb), (_gl), (_sp)))
1523 #define	ath_hal_btcoex_mci_send_message(_ah, _h, _f, _p, _l, _wd, _cbt) \
1524 	((*(_ah)->ah_btMciSendMessage)((_ah), (_h), (_f), (_p), (_l), (_wd), (_cbt)))
1525 #define	ath_hal_btcoex_mci_get_interrupt(_ah, _mi, _mm) \
1526 	((*(_ah)->ah_btMciGetInterrupt)((_ah), (_mi), (_mm)))
1527 #define	ath_hal_btcoex_mci_state(_ah, _st, _pd) \
1528 	((*(_ah)->ah_btMciState)((_ah), (_st), (_pd)))
1529 #define	ath_hal_btcoex_mci_detach(_ah) \
1530 	((*(_ah)->ah_btMciDetach)((_ah)))
1531 
1532 #define	ath_hal_div_comb_conf_get(_ah, _conf) \
1533 	((*(_ah)->ah_divLnaConfGet)((_ah), (_conf)))
1534 #define	ath_hal_div_comb_conf_set(_ah, _conf) \
1535 	((*(_ah)->ah_divLnaConfSet)((_ah), (_conf)))
1536 
1537 #endif /* _DEV_ATH_ATHVAR_H */
1538