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