xref: /freebsd/sys/dev/ath/if_ath_rx.c (revision da759cfa320d5076b075d15ff3f00ab3ba5634fd)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer,
12  *    without modification.
13  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
14  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
15  *    redistribution must be conditioned upon including a substantially
16  *    similar Disclaimer requirement for further binary redistribution.
17  *
18  * NO WARRANTY
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
22  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
23  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
24  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
27  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29  * THE POSSIBILITY OF SUCH DAMAGES.
30  */
31 
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
34 
35 /*
36  * Driver for the Atheros Wireless LAN controller.
37  *
38  * This software is derived from work of Atsushi Onoe; his contribution
39  * is greatly appreciated.
40  */
41 
42 #include "opt_inet.h"
43 #include "opt_ath.h"
44 /*
45  * This is needed for register operations which are performed
46  * by the driver - eg, calls to ath_hal_gettsf32().
47  *
48  * It's also required for any AH_DEBUG checks in here, eg the
49  * module dependencies.
50  */
51 #include "opt_ah.h"
52 #include "opt_wlan.h"
53 
54 #include <sys/param.h>
55 #include <sys/systm.h>
56 #include <sys/sysctl.h>
57 #include <sys/mbuf.h>
58 #include <sys/malloc.h>
59 #include <sys/lock.h>
60 #include <sys/mutex.h>
61 #include <sys/kernel.h>
62 #include <sys/socket.h>
63 #include <sys/sockio.h>
64 #include <sys/errno.h>
65 #include <sys/callout.h>
66 #include <sys/bus.h>
67 #include <sys/endian.h>
68 #include <sys/kthread.h>
69 #include <sys/taskqueue.h>
70 #include <sys/priv.h>
71 #include <sys/module.h>
72 #include <sys/ktr.h>
73 #include <sys/smp.h>	/* for mp_ncpus */
74 
75 #include <machine/bus.h>
76 
77 #include <net/if.h>
78 #include <net/if_var.h>
79 #include <net/if_dl.h>
80 #include <net/if_media.h>
81 #include <net/if_types.h>
82 #include <net/if_arp.h>
83 #include <net/ethernet.h>
84 #include <net/if_llc.h>
85 
86 #include <net80211/ieee80211_var.h>
87 #include <net80211/ieee80211_regdomain.h>
88 #ifdef IEEE80211_SUPPORT_SUPERG
89 #include <net80211/ieee80211_superg.h>
90 #endif
91 #ifdef IEEE80211_SUPPORT_TDMA
92 #include <net80211/ieee80211_tdma.h>
93 #endif
94 
95 #include <net/bpf.h>
96 
97 #ifdef INET
98 #include <netinet/in.h>
99 #include <netinet/if_ether.h>
100 #endif
101 
102 #include <dev/ath/if_athvar.h>
103 #include <dev/ath/ath_hal/ah_devid.h>		/* XXX for softled */
104 #include <dev/ath/ath_hal/ah_diagcodes.h>
105 
106 #include <dev/ath/if_ath_debug.h>
107 #include <dev/ath/if_ath_misc.h>
108 #include <dev/ath/if_ath_tsf.h>
109 #include <dev/ath/if_ath_tx.h>
110 #include <dev/ath/if_ath_sysctl.h>
111 #include <dev/ath/if_ath_led.h>
112 #include <dev/ath/if_ath_keycache.h>
113 #include <dev/ath/if_ath_rx.h>
114 #include <dev/ath/if_ath_beacon.h>
115 #include <dev/ath/if_athdfs.h>
116 #include <dev/ath/if_ath_descdma.h>
117 
118 #ifdef ATH_TX99_DIAG
119 #include <dev/ath/ath_tx99/ath_tx99.h>
120 #endif
121 
122 #ifdef	ATH_DEBUG_ALQ
123 #include <dev/ath/if_ath_alq.h>
124 #endif
125 
126 #include <dev/ath/if_ath_lna_div.h>
127 
128 /*
129  * Calculate the receive filter according to the
130  * operating mode and state:
131  *
132  * o always accept unicast, broadcast, and multicast traffic
133  * o accept PHY error frames when hardware doesn't have MIB support
134  *   to count and we need them for ANI (sta mode only until recently)
135  *   and we are not scanning (ANI is disabled)
136  *   NB: older hal's add rx filter bits out of sight and we need to
137  *	 blindly preserve them
138  * o probe request frames are accepted only when operating in
139  *   hostap, adhoc, mesh, or monitor modes
140  * o enable promiscuous mode
141  *   - when in monitor mode
142  *   - if interface marked PROMISC (assumes bridge setting is filtered)
143  * o accept beacons:
144  *   - when operating in station mode for collecting rssi data when
145  *     the station is otherwise quiet, or
146  *   - when operating in adhoc mode so the 802.11 layer creates
147  *     node table entries for peers,
148  *   - when scanning
149  *   - when doing s/w beacon miss (e.g. for ap+sta)
150  *   - when operating in ap mode in 11g to detect overlapping bss that
151  *     require protection
152  *   - when operating in mesh mode to detect neighbors
153  * o accept control frames:
154  *   - when in monitor mode
155  * XXX HT protection for 11n
156  */
157 u_int32_t
158 ath_calcrxfilter(struct ath_softc *sc)
159 {
160 	struct ieee80211com *ic = &sc->sc_ic;
161 	u_int32_t rfilt;
162 
163 	rfilt = HAL_RX_FILTER_UCAST | HAL_RX_FILTER_BCAST | HAL_RX_FILTER_MCAST;
164 	if (!sc->sc_needmib && !sc->sc_scanning)
165 		rfilt |= HAL_RX_FILTER_PHYERR;
166 	if (ic->ic_opmode != IEEE80211_M_STA)
167 		rfilt |= HAL_RX_FILTER_PROBEREQ;
168 	/* XXX ic->ic_monvaps != 0? */
169 	if (ic->ic_opmode == IEEE80211_M_MONITOR || ic->ic_promisc > 0)
170 		rfilt |= HAL_RX_FILTER_PROM;
171 
172 	/*
173 	 * Only listen to all beacons if we're scanning.
174 	 *
175 	 * Otherwise we only really need to hear beacons from
176 	 * our own BSSID.
177 	 *
178 	 * IBSS? software beacon miss? Just receive all beacons.
179 	 * We need to hear beacons/probe requests from everyone so
180 	 * we can merge ibss.
181 	 */
182 	if (ic->ic_opmode == IEEE80211_M_IBSS || sc->sc_swbmiss) {
183 		rfilt |= HAL_RX_FILTER_BEACON;
184 	} else if (ic->ic_opmode == IEEE80211_M_STA) {
185 		if (sc->sc_do_mybeacon && ! sc->sc_scanning) {
186 			rfilt |= HAL_RX_FILTER_MYBEACON;
187 		} else { /* scanning, non-mybeacon chips */
188 			rfilt |= HAL_RX_FILTER_BEACON;
189 		}
190 	}
191 
192 	/*
193 	 * NB: We don't recalculate the rx filter when
194 	 * ic_protmode changes; otherwise we could do
195 	 * this only when ic_protmode != NONE.
196 	 */
197 	if (ic->ic_opmode == IEEE80211_M_HOSTAP &&
198 	    IEEE80211_IS_CHAN_ANYG(ic->ic_curchan))
199 		rfilt |= HAL_RX_FILTER_BEACON;
200 
201 	/*
202 	 * Enable hardware PS-POLL RX only for hostap mode;
203 	 * STA mode sends PS-POLL frames but never
204 	 * receives them.
205 	 */
206 	if (ath_hal_getcapability(sc->sc_ah, HAL_CAP_PSPOLL,
207 	    0, NULL) == HAL_OK &&
208 	    ic->ic_opmode == IEEE80211_M_HOSTAP)
209 		rfilt |= HAL_RX_FILTER_PSPOLL;
210 
211 	if (sc->sc_nmeshvaps) {
212 		rfilt |= HAL_RX_FILTER_BEACON;
213 		if (sc->sc_hasbmatch)
214 			rfilt |= HAL_RX_FILTER_BSSID;
215 		else
216 			rfilt |= HAL_RX_FILTER_PROM;
217 	}
218 	if (ic->ic_opmode == IEEE80211_M_MONITOR)
219 		rfilt |= HAL_RX_FILTER_CONTROL;
220 
221 	/*
222 	 * Enable RX of compressed BAR frames only when doing
223 	 * 802.11n. Required for A-MPDU.
224 	 */
225 	if (IEEE80211_IS_CHAN_HT(ic->ic_curchan))
226 		rfilt |= HAL_RX_FILTER_COMPBAR;
227 
228 	/*
229 	 * Enable radar PHY errors if requested by the
230 	 * DFS module.
231 	 */
232 	if (sc->sc_dodfs)
233 		rfilt |= HAL_RX_FILTER_PHYRADAR;
234 
235 	/*
236 	 * Enable spectral PHY errors if requested by the
237 	 * spectral module.
238 	 */
239 	if (sc->sc_dospectral)
240 		rfilt |= HAL_RX_FILTER_PHYRADAR;
241 
242 	DPRINTF(sc, ATH_DEBUG_MODE, "%s: RX filter 0x%x, %s\n",
243 	    __func__, rfilt, ieee80211_opmode_name[ic->ic_opmode]);
244 	return rfilt;
245 }
246 
247 static int
248 ath_legacy_rxbuf_init(struct ath_softc *sc, struct ath_buf *bf)
249 {
250 	struct ath_hal *ah = sc->sc_ah;
251 	int error;
252 	struct mbuf *m;
253 	struct ath_desc *ds;
254 
255 	/* XXX TODO: ATH_RX_LOCK_ASSERT(sc); */
256 
257 	m = bf->bf_m;
258 	if (m == NULL) {
259 		/*
260 		 * NB: by assigning a page to the rx dma buffer we
261 		 * implicitly satisfy the Atheros requirement that
262 		 * this buffer be cache-line-aligned and sized to be
263 		 * multiple of the cache line size.  Not doing this
264 		 * causes weird stuff to happen (for the 5210 at least).
265 		 */
266 		m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
267 		if (m == NULL) {
268 			DPRINTF(sc, ATH_DEBUG_ANY,
269 				"%s: no mbuf/cluster\n", __func__);
270 			sc->sc_stats.ast_rx_nombuf++;
271 			return ENOMEM;
272 		}
273 		m->m_pkthdr.len = m->m_len = m->m_ext.ext_size;
274 
275 		error = bus_dmamap_load_mbuf_sg(sc->sc_dmat,
276 					     bf->bf_dmamap, m,
277 					     bf->bf_segs, &bf->bf_nseg,
278 					     BUS_DMA_NOWAIT);
279 		if (error != 0) {
280 			DPRINTF(sc, ATH_DEBUG_ANY,
281 			    "%s: bus_dmamap_load_mbuf_sg failed; error %d\n",
282 			    __func__, error);
283 			sc->sc_stats.ast_rx_busdma++;
284 			m_freem(m);
285 			return error;
286 		}
287 		KASSERT(bf->bf_nseg == 1,
288 			("multi-segment packet; nseg %u", bf->bf_nseg));
289 		bf->bf_m = m;
290 	}
291 	bus_dmamap_sync(sc->sc_dmat, bf->bf_dmamap, BUS_DMASYNC_PREREAD);
292 
293 	/*
294 	 * Setup descriptors.  For receive we always terminate
295 	 * the descriptor list with a self-linked entry so we'll
296 	 * not get overrun under high load (as can happen with a
297 	 * 5212 when ANI processing enables PHY error frames).
298 	 *
299 	 * To insure the last descriptor is self-linked we create
300 	 * each descriptor as self-linked and add it to the end.  As
301 	 * each additional descriptor is added the previous self-linked
302 	 * entry is ``fixed'' naturally.  This should be safe even
303 	 * if DMA is happening.  When processing RX interrupts we
304 	 * never remove/process the last, self-linked, entry on the
305 	 * descriptor list.  This insures the hardware always has
306 	 * someplace to write a new frame.
307 	 */
308 	/*
309 	 * 11N: we can no longer afford to self link the last descriptor.
310 	 * MAC acknowledges BA status as long as it copies frames to host
311 	 * buffer (or rx fifo). This can incorrectly acknowledge packets
312 	 * to a sender if last desc is self-linked.
313 	 */
314 	ds = bf->bf_desc;
315 	if (sc->sc_rxslink)
316 		ds->ds_link = bf->bf_daddr;	/* link to self */
317 	else
318 		ds->ds_link = 0;		/* terminate the list */
319 	ds->ds_data = bf->bf_segs[0].ds_addr;
320 	ath_hal_setuprxdesc(ah, ds
321 		, m->m_len		/* buffer size */
322 		, 0
323 	);
324 
325 	if (sc->sc_rxlink != NULL)
326 		*sc->sc_rxlink = bf->bf_daddr;
327 	sc->sc_rxlink = &ds->ds_link;
328 	return 0;
329 }
330 
331 /*
332  * Intercept management frames to collect beacon rssi data
333  * and to do ibss merges.
334  */
335 void
336 ath_recv_mgmt(struct ieee80211_node *ni, struct mbuf *m,
337 	int subtype, const struct ieee80211_rx_stats *rxs, int rssi, int nf)
338 {
339 	struct ieee80211vap *vap = ni->ni_vap;
340 	struct ath_softc *sc = vap->iv_ic->ic_softc;
341 	uint64_t tsf_beacon_old, tsf_beacon;
342 	uint64_t nexttbtt;
343 	int64_t tsf_delta;
344 	int32_t tsf_delta_bmiss;
345 	int32_t tsf_remainder;
346 	uint64_t tsf_beacon_target;
347 	int tsf_intval;
348 
349 	tsf_beacon_old = ((uint64_t) le32dec(ni->ni_tstamp.data + 4)) << 32;
350 	tsf_beacon_old |= le32dec(ni->ni_tstamp.data);
351 
352 #define	TU_TO_TSF(_tu)	(((u_int64_t)(_tu)) << 10)
353 	tsf_intval = 1;
354 	if (ni->ni_intval > 0) {
355 		tsf_intval = TU_TO_TSF(ni->ni_intval);
356 	}
357 #undef	TU_TO_TSF
358 
359 	/*
360 	 * Call up first so subsequent work can use information
361 	 * potentially stored in the node (e.g. for ibss merge).
362 	 */
363 	ATH_VAP(vap)->av_recv_mgmt(ni, m, subtype, rxs, rssi, nf);
364 	switch (subtype) {
365 	case IEEE80211_FC0_SUBTYPE_BEACON:
366 		/*
367 		 * Always update the per-node beacon RSSI if we're hearing
368 		 * beacons from that node.
369 		 */
370 		ATH_RSSI_LPF(ATH_NODE(ni)->an_node_stats.ns_avgbrssi, rssi);
371 
372 		/*
373 		 * Only do the following processing if it's for
374 		 * the current BSS.
375 		 *
376 		 * In scan and IBSS mode we receive all beacons,
377 		 * which means we need to filter out stuff
378 		 * that isn't for us or we'll end up constantly
379 		 * trying to sync / merge to BSSes that aren't
380 		 * actually us.
381 		 */
382 		if (IEEE80211_ADDR_EQ(ni->ni_bssid, vap->iv_bss->ni_bssid)) {
383 			/* update rssi statistics for use by the hal */
384 			/* XXX unlocked check against vap->iv_bss? */
385 			ATH_RSSI_LPF(sc->sc_halstats.ns_avgbrssi, rssi);
386 
387 
388 			tsf_beacon = ((uint64_t) le32dec(ni->ni_tstamp.data + 4)) << 32;
389 			tsf_beacon |= le32dec(ni->ni_tstamp.data);
390 
391 			nexttbtt = ath_hal_getnexttbtt(sc->sc_ah);
392 
393 			/*
394 			 * Let's calculate the delta and remainder, so we can see
395 			 * if the beacon timer from the AP is varying by more than
396 			 * a few TU.  (Which would be a huge, huge problem.)
397 			 */
398 			tsf_delta = (long long) tsf_beacon - (long long) tsf_beacon_old;
399 
400 			tsf_delta_bmiss = tsf_delta / tsf_intval;
401 
402 			/*
403 			 * If our delta is greater than half the beacon interval,
404 			 * let's round the bmiss value up to the next beacon
405 			 * interval.  Ie, we're running really, really early
406 			 * on the next beacon.
407 			 */
408 			if (tsf_delta % tsf_intval > (tsf_intval / 2))
409 				tsf_delta_bmiss ++;
410 
411 			tsf_beacon_target = tsf_beacon_old +
412 			    (((unsigned long long) tsf_delta_bmiss) * (long long) tsf_intval);
413 
414 			/*
415 			 * The remainder using '%' is between 0 .. intval-1.
416 			 * If we're actually running too fast, then the remainder
417 			 * will be some large number just under intval-1.
418 			 * So we need to look at whether we're running
419 			 * before or after the target beacon interval
420 			 * and if we are, modify how we do the remainder
421 			 * calculation.
422 			 */
423 			if (tsf_beacon < tsf_beacon_target) {
424 				tsf_remainder =
425 				    -(tsf_intval - ((tsf_beacon - tsf_beacon_old) % tsf_intval));
426 			} else {
427 				tsf_remainder = (tsf_beacon - tsf_beacon_old) % tsf_intval;
428 			}
429 
430 			DPRINTF(sc, ATH_DEBUG_BEACON, "%s: old_tsf=%llu (%u), new_tsf=%llu (%u), target_tsf=%llu (%u), delta=%lld, bmiss=%d, remainder=%d\n",
431 			    __func__,
432 			    (unsigned long long) tsf_beacon_old,
433 			    (unsigned int) (tsf_beacon_old >> 10),
434 			    (unsigned long long) tsf_beacon,
435 			    (unsigned int ) (tsf_beacon >> 10),
436 			    (unsigned long long) tsf_beacon_target,
437 			    (unsigned int) (tsf_beacon_target >> 10),
438 			    (long long) tsf_delta,
439 			    tsf_delta_bmiss,
440 			    tsf_remainder);
441 
442 			DPRINTF(sc, ATH_DEBUG_BEACON, "%s: tsf=%llu (%u), nexttbtt=%llu (%u), delta=%d\n",
443 			    __func__,
444 			    (unsigned long long) tsf_beacon,
445 			    (unsigned int) (tsf_beacon >> 10),
446 			    (unsigned long long) nexttbtt,
447 			    (unsigned int) (nexttbtt >> 10),
448 			    (int32_t) tsf_beacon - (int32_t) nexttbtt + tsf_intval);
449 
450 			/* We only do syncbeacon on STA VAPs; not on IBSS */
451 			if (vap->iv_opmode == IEEE80211_M_STA &&
452 			    sc->sc_syncbeacon &&
453 			    ni == vap->iv_bss &&
454 			    (vap->iv_state == IEEE80211_S_RUN || vap->iv_state == IEEE80211_S_SLEEP)) {
455 				DPRINTF(sc, ATH_DEBUG_BEACON,
456 				    "%s: syncbeacon=1; syncing\n",
457 				    __func__);
458 				/*
459 				 * Resync beacon timers using the tsf of the beacon
460 				 * frame we just received.
461 				 */
462 				ath_beacon_config(sc, vap);
463 				sc->sc_syncbeacon = 0;
464 			}
465 		}
466 
467 		/* fall thru... */
468 	case IEEE80211_FC0_SUBTYPE_PROBE_RESP:
469 		if (vap->iv_opmode == IEEE80211_M_IBSS &&
470 		    vap->iv_state == IEEE80211_S_RUN &&
471 		    ieee80211_ibss_merge_check(ni)) {
472 			uint32_t rstamp = sc->sc_lastrs->rs_tstamp;
473 			uint64_t tsf = ath_extend_tsf(sc, rstamp,
474 				ath_hal_gettsf64(sc->sc_ah));
475 			/*
476 			 * Handle ibss merge as needed; check the tsf on the
477 			 * frame before attempting the merge.  The 802.11 spec
478 			 * says the station should change it's bssid to match
479 			 * the oldest station with the same ssid, where oldest
480 			 * is determined by the tsf.  Note that hardware
481 			 * reconfiguration happens through callback to
482 			 * ath_newstate as the state machine will go from
483 			 * RUN -> RUN when this happens.
484 			 */
485 			if (le64toh(ni->ni_tstamp.tsf) >= tsf) {
486 				DPRINTF(sc, ATH_DEBUG_STATE,
487 				    "ibss merge, rstamp %u tsf %ju "
488 				    "tstamp %ju\n", rstamp, (uintmax_t)tsf,
489 				    (uintmax_t)ni->ni_tstamp.tsf);
490 				(void) ieee80211_ibss_merge(ni);
491 			}
492 		}
493 		break;
494 	}
495 }
496 
497 #ifdef	ATH_ENABLE_RADIOTAP_VENDOR_EXT
498 static void
499 ath_rx_tap_vendor(struct ath_softc *sc, struct mbuf *m,
500     const struct ath_rx_status *rs, u_int64_t tsf, int16_t nf)
501 {
502 
503 	/* Fill in the extension bitmap */
504 	sc->sc_rx_th.wr_ext_bitmap = htole32(1 << ATH_RADIOTAP_VENDOR_HEADER);
505 
506 	/* Fill in the vendor header */
507 	sc->sc_rx_th.wr_vh.vh_oui[0] = 0x7f;
508 	sc->sc_rx_th.wr_vh.vh_oui[1] = 0x03;
509 	sc->sc_rx_th.wr_vh.vh_oui[2] = 0x00;
510 
511 	/* XXX what should this be? */
512 	sc->sc_rx_th.wr_vh.vh_sub_ns = 0;
513 	sc->sc_rx_th.wr_vh.vh_skip_len =
514 	    htole16(sizeof(struct ath_radiotap_vendor_hdr));
515 
516 	/* General version info */
517 	sc->sc_rx_th.wr_v.vh_version = 1;
518 
519 	sc->sc_rx_th.wr_v.vh_rx_chainmask = sc->sc_rxchainmask;
520 
521 	/* rssi */
522 	sc->sc_rx_th.wr_v.rssi_ctl[0] = rs->rs_rssi_ctl[0];
523 	sc->sc_rx_th.wr_v.rssi_ctl[1] = rs->rs_rssi_ctl[1];
524 	sc->sc_rx_th.wr_v.rssi_ctl[2] = rs->rs_rssi_ctl[2];
525 	sc->sc_rx_th.wr_v.rssi_ext[0] = rs->rs_rssi_ext[0];
526 	sc->sc_rx_th.wr_v.rssi_ext[1] = rs->rs_rssi_ext[1];
527 	sc->sc_rx_th.wr_v.rssi_ext[2] = rs->rs_rssi_ext[2];
528 
529 	/* evm */
530 	sc->sc_rx_th.wr_v.evm[0] = rs->rs_evm0;
531 	sc->sc_rx_th.wr_v.evm[1] = rs->rs_evm1;
532 	sc->sc_rx_th.wr_v.evm[2] = rs->rs_evm2;
533 	/* These are only populated from the AR9300 or later */
534 	sc->sc_rx_th.wr_v.evm[3] = rs->rs_evm3;
535 	sc->sc_rx_th.wr_v.evm[4] = rs->rs_evm4;
536 
537 	/* direction */
538 	sc->sc_rx_th.wr_v.vh_flags = ATH_VENDOR_PKT_RX;
539 
540 	/* RX rate */
541 	sc->sc_rx_th.wr_v.vh_rx_hwrate = rs->rs_rate;
542 
543 	/* RX flags */
544 	sc->sc_rx_th.wr_v.vh_rs_flags = rs->rs_flags;
545 
546 	if (rs->rs_isaggr)
547 		sc->sc_rx_th.wr_v.vh_flags |= ATH_VENDOR_PKT_ISAGGR;
548 	if (rs->rs_moreaggr)
549 		sc->sc_rx_th.wr_v.vh_flags |= ATH_VENDOR_PKT_MOREAGGR;
550 
551 	/* phyerr info */
552 	if (rs->rs_status & HAL_RXERR_PHY) {
553 		sc->sc_rx_th.wr_v.vh_phyerr_code = rs->rs_phyerr;
554 		sc->sc_rx_th.wr_v.vh_flags |= ATH_VENDOR_PKT_RXPHYERR;
555 	} else {
556 		sc->sc_rx_th.wr_v.vh_phyerr_code = 0xff;
557 	}
558 	sc->sc_rx_th.wr_v.vh_rs_status = rs->rs_status;
559 	sc->sc_rx_th.wr_v.vh_rssi = rs->rs_rssi;
560 }
561 #endif	/* ATH_ENABLE_RADIOTAP_VENDOR_EXT */
562 
563 static void
564 ath_rx_tap(struct ath_softc *sc, struct mbuf *m,
565 	const struct ath_rx_status *rs, u_int64_t tsf, int16_t nf)
566 {
567 #define	CHAN_HT20	htole32(IEEE80211_CHAN_HT20)
568 #define	CHAN_HT40U	htole32(IEEE80211_CHAN_HT40U)
569 #define	CHAN_HT40D	htole32(IEEE80211_CHAN_HT40D)
570 #define	CHAN_HT		(CHAN_HT20|CHAN_HT40U|CHAN_HT40D)
571 	const HAL_RATE_TABLE *rt;
572 	uint8_t rix;
573 
574 	rt = sc->sc_currates;
575 	KASSERT(rt != NULL, ("no rate table, mode %u", sc->sc_curmode));
576 	rix = rt->rateCodeToIndex[rs->rs_rate];
577 	sc->sc_rx_th.wr_rate = sc->sc_hwmap[rix].ieeerate;
578 	sc->sc_rx_th.wr_flags = sc->sc_hwmap[rix].rxflags;
579 
580 	/* 802.11 specific flags */
581 	sc->sc_rx_th.wr_chan_flags &= ~CHAN_HT;
582 	if (rs->rs_status & HAL_RXERR_PHY) {
583 		/*
584 		 * PHY error - make sure the channel flags
585 		 * reflect the actual channel configuration,
586 		 * not the received frame.
587 		 */
588 		if (IEEE80211_IS_CHAN_HT40U(sc->sc_curchan))
589 			sc->sc_rx_th.wr_chan_flags |= CHAN_HT40U;
590 		else if (IEEE80211_IS_CHAN_HT40D(sc->sc_curchan))
591 			sc->sc_rx_th.wr_chan_flags |= CHAN_HT40D;
592 		else if (IEEE80211_IS_CHAN_HT20(sc->sc_curchan))
593 			sc->sc_rx_th.wr_chan_flags |= CHAN_HT20;
594 	} else if (sc->sc_rx_th.wr_rate & IEEE80211_RATE_MCS) {	/* HT rate */
595 		struct ieee80211com *ic = &sc->sc_ic;
596 
597 		if ((rs->rs_flags & HAL_RX_2040) == 0)
598 			sc->sc_rx_th.wr_chan_flags |= CHAN_HT20;
599 		else if (IEEE80211_IS_CHAN_HT40U(ic->ic_curchan))
600 			sc->sc_rx_th.wr_chan_flags |= CHAN_HT40U;
601 		else
602 			sc->sc_rx_th.wr_chan_flags |= CHAN_HT40D;
603 
604 		if (rs->rs_flags & HAL_RX_GI)
605 			sc->sc_rx_th.wr_flags |= IEEE80211_RADIOTAP_F_SHORTGI;
606 	}
607 
608 	sc->sc_rx_th.wr_tsf = htole64(ath_extend_tsf(sc, rs->rs_tstamp, tsf));
609 	if (rs->rs_status & HAL_RXERR_CRC)
610 		sc->sc_rx_th.wr_flags |= IEEE80211_RADIOTAP_F_BADFCS;
611 	/* XXX propagate other error flags from descriptor */
612 	sc->sc_rx_th.wr_antnoise = nf;
613 	sc->sc_rx_th.wr_antsignal = nf + rs->rs_rssi;
614 	sc->sc_rx_th.wr_antenna = rs->rs_antenna;
615 #undef CHAN_HT
616 #undef CHAN_HT20
617 #undef CHAN_HT40U
618 #undef CHAN_HT40D
619 }
620 
621 static void
622 ath_handle_micerror(struct ieee80211com *ic,
623 	struct ieee80211_frame *wh, int keyix)
624 {
625 	struct ieee80211_node *ni;
626 
627 	/* XXX recheck MIC to deal w/ chips that lie */
628 	/* XXX discard MIC errors on !data frames */
629 	ni = ieee80211_find_rxnode(ic, (const struct ieee80211_frame_min *) wh);
630 	if (ni != NULL) {
631 		ieee80211_notify_michael_failure(ni->ni_vap, wh, keyix);
632 		ieee80211_free_node(ni);
633 	}
634 }
635 
636 /*
637  * Process a single packet.
638  *
639  * The mbuf must already be synced, unmapped and removed from bf->bf_m
640  * by this stage.
641  *
642  * The mbuf must be consumed by this routine - either passed up the
643  * net80211 stack, put on the holding queue, or freed.
644  */
645 int
646 ath_rx_pkt(struct ath_softc *sc, struct ath_rx_status *rs, HAL_STATUS status,
647     uint64_t tsf, int nf, HAL_RX_QUEUE qtype, struct ath_buf *bf,
648     struct mbuf *m)
649 {
650 	uint64_t rstamp;
651 	/* XXX TODO: make this an mbuf tag? */
652 	struct ieee80211_rx_stats rxs;
653 	int len, type, i;
654 	struct ieee80211com *ic = &sc->sc_ic;
655 	struct ieee80211_node *ni;
656 	int is_good = 0;
657 	struct ath_rx_edma *re = &sc->sc_rxedma[qtype];
658 
659 	NET_EPOCH_ASSERT();
660 
661 	/*
662 	 * Calculate the correct 64 bit TSF given
663 	 * the TSF64 register value and rs_tstamp.
664 	 */
665 	rstamp = ath_extend_tsf(sc, rs->rs_tstamp, tsf);
666 
667 	/* 802.11 return codes - These aren't specifically errors */
668 	if (rs->rs_flags & HAL_RX_GI)
669 		sc->sc_stats.ast_rx_halfgi++;
670 	if (rs->rs_flags & HAL_RX_2040)
671 		sc->sc_stats.ast_rx_2040++;
672 	if (rs->rs_flags & HAL_RX_DELIM_CRC_PRE)
673 		sc->sc_stats.ast_rx_pre_crc_err++;
674 	if (rs->rs_flags & HAL_RX_DELIM_CRC_POST)
675 		sc->sc_stats.ast_rx_post_crc_err++;
676 	if (rs->rs_flags & HAL_RX_DECRYPT_BUSY)
677 		sc->sc_stats.ast_rx_decrypt_busy_err++;
678 	if (rs->rs_flags & HAL_RX_HI_RX_CHAIN)
679 		sc->sc_stats.ast_rx_hi_rx_chain++;
680 	if (rs->rs_flags & HAL_RX_STBC)
681 		sc->sc_stats.ast_rx_stbc++;
682 
683 	if (rs->rs_status != 0) {
684 		if (rs->rs_status & HAL_RXERR_CRC)
685 			sc->sc_stats.ast_rx_crcerr++;
686 		if (rs->rs_status & HAL_RXERR_FIFO)
687 			sc->sc_stats.ast_rx_fifoerr++;
688 		if (rs->rs_status & HAL_RXERR_PHY) {
689 			sc->sc_stats.ast_rx_phyerr++;
690 			/* Process DFS radar events */
691 			if ((rs->rs_phyerr == HAL_PHYERR_RADAR) ||
692 			    (rs->rs_phyerr == HAL_PHYERR_FALSE_RADAR_EXT)) {
693 				/* Now pass it to the radar processing code */
694 				ath_dfs_process_phy_err(sc, m, rstamp, rs);
695 			}
696 
697 			/* Be suitably paranoid about receiving phy errors out of the stats array bounds */
698 			if (rs->rs_phyerr < 64)
699 				sc->sc_stats.ast_rx_phy[rs->rs_phyerr]++;
700 			goto rx_error;	/* NB: don't count in ierrors */
701 		}
702 		if (rs->rs_status & HAL_RXERR_DECRYPT) {
703 			/*
704 			 * Decrypt error.  If the error occurred
705 			 * because there was no hardware key, then
706 			 * let the frame through so the upper layers
707 			 * can process it.  This is necessary for 5210
708 			 * parts which have no way to setup a ``clear''
709 			 * key cache entry.
710 			 *
711 			 * XXX do key cache faulting
712 			 */
713 			if (rs->rs_keyix == HAL_RXKEYIX_INVALID)
714 				goto rx_accept;
715 			sc->sc_stats.ast_rx_badcrypt++;
716 		}
717 		/*
718 		 * Similar as above - if the failure was a keymiss
719 		 * just punt it up to the upper layers for now.
720 		 */
721 		if (rs->rs_status & HAL_RXERR_KEYMISS) {
722 			sc->sc_stats.ast_rx_keymiss++;
723 			goto rx_accept;
724 		}
725 		if (rs->rs_status & HAL_RXERR_MIC) {
726 			sc->sc_stats.ast_rx_badmic++;
727 			/*
728 			 * Do minimal work required to hand off
729 			 * the 802.11 header for notification.
730 			 */
731 			/* XXX frag's and qos frames */
732 			len = rs->rs_datalen;
733 			if (len >= sizeof (struct ieee80211_frame)) {
734 				ath_handle_micerror(ic,
735 				    mtod(m, struct ieee80211_frame *),
736 				    sc->sc_splitmic ?
737 					rs->rs_keyix-32 : rs->rs_keyix);
738 			}
739 		}
740 		counter_u64_add(ic->ic_ierrors, 1);
741 rx_error:
742 		/*
743 		 * Cleanup any pending partial frame.
744 		 */
745 		if (re->m_rxpending != NULL) {
746 			m_freem(re->m_rxpending);
747 			re->m_rxpending = NULL;
748 		}
749 		/*
750 		 * When a tap is present pass error frames
751 		 * that have been requested.  By default we
752 		 * pass decrypt+mic errors but others may be
753 		 * interesting (e.g. crc).
754 		 */
755 		if (ieee80211_radiotap_active(ic) &&
756 		    (rs->rs_status & sc->sc_monpass)) {
757 			/* NB: bpf needs the mbuf length setup */
758 			len = rs->rs_datalen;
759 			m->m_pkthdr.len = m->m_len = len;
760 			ath_rx_tap(sc, m, rs, rstamp, nf);
761 #ifdef	ATH_ENABLE_RADIOTAP_VENDOR_EXT
762 			ath_rx_tap_vendor(sc, m, rs, rstamp, nf);
763 #endif	/* ATH_ENABLE_RADIOTAP_VENDOR_EXT */
764 			ieee80211_radiotap_rx_all(ic, m);
765 		}
766 		/* XXX pass MIC errors up for s/w reclaculation */
767 		m_freem(m); m = NULL;
768 		goto rx_next;
769 	}
770 rx_accept:
771 	len = rs->rs_datalen;
772 	m->m_len = len;
773 
774 	if (rs->rs_more) {
775 		/*
776 		 * Frame spans multiple descriptors; save
777 		 * it for the next completed descriptor, it
778 		 * will be used to construct a jumbogram.
779 		 */
780 		if (re->m_rxpending != NULL) {
781 			/* NB: max frame size is currently 2 clusters */
782 			sc->sc_stats.ast_rx_toobig++;
783 			m_freem(re->m_rxpending);
784 		}
785 		m->m_pkthdr.len = len;
786 		re->m_rxpending = m;
787 		m = NULL;
788 		goto rx_next;
789 	} else if (re->m_rxpending != NULL) {
790 		/*
791 		 * This is the second part of a jumbogram,
792 		 * chain it to the first mbuf, adjust the
793 		 * frame length, and clear the rxpending state.
794 		 */
795 		re->m_rxpending->m_next = m;
796 		re->m_rxpending->m_pkthdr.len += len;
797 		m = re->m_rxpending;
798 		re->m_rxpending = NULL;
799 	} else {
800 		/*
801 		 * Normal single-descriptor receive; setup packet length.
802 		 */
803 		m->m_pkthdr.len = len;
804 	}
805 
806 	/*
807 	 * Validate rs->rs_antenna.
808 	 *
809 	 * Some users w/ AR9285 NICs have reported crashes
810 	 * here because rs_antenna field is bogusly large.
811 	 * Let's enforce the maximum antenna limit of 8
812 	 * (and it shouldn't be hard coded, but that's a
813 	 * separate problem) and if there's an issue, print
814 	 * out an error and adjust rs_antenna to something
815 	 * sensible.
816 	 *
817 	 * This code should be removed once the actual
818 	 * root cause of the issue has been identified.
819 	 * For example, it may be that the rs_antenna
820 	 * field is only valid for the last frame of
821 	 * an aggregate and it just happens that it is
822 	 * "mostly" right. (This is a general statement -
823 	 * the majority of the statistics are only valid
824 	 * for the last frame in an aggregate.
825 	 */
826 	if (rs->rs_antenna > 7) {
827 		device_printf(sc->sc_dev, "%s: rs_antenna > 7 (%d)\n",
828 		    __func__, rs->rs_antenna);
829 #ifdef	ATH_DEBUG
830 		ath_printrxbuf(sc, bf, 0, status == HAL_OK);
831 #endif /* ATH_DEBUG */
832 		rs->rs_antenna = 0;	/* XXX better than nothing */
833 	}
834 
835 	/*
836 	 * If this is an AR9285/AR9485, then the receive and LNA
837 	 * configuration is stored in RSSI[2] / EXTRSSI[2].
838 	 * We can extract this out to build a much better
839 	 * receive antenna profile.
840 	 *
841 	 * Yes, this just blurts over the above RX antenna field
842 	 * for now.  It's fine, the AR9285 doesn't really use
843 	 * that.
844 	 *
845 	 * Later on we should store away the fine grained LNA
846 	 * information and keep separate counters just for
847 	 * that.  It'll help when debugging the AR9285/AR9485
848 	 * combined diversity code.
849 	 */
850 	if (sc->sc_rx_lnamixer) {
851 		rs->rs_antenna = 0;
852 
853 		/* Bits 0:1 - the LNA configuration used */
854 		rs->rs_antenna |=
855 		    ((rs->rs_rssi_ctl[2] & HAL_RX_LNA_CFG_USED)
856 		      >> HAL_RX_LNA_CFG_USED_S);
857 
858 		/* Bit 2 - the external RX antenna switch */
859 		if (rs->rs_rssi_ctl[2] & HAL_RX_LNA_EXTCFG)
860 			rs->rs_antenna |= 0x4;
861 	}
862 
863 	sc->sc_stats.ast_ant_rx[rs->rs_antenna]++;
864 
865 	/*
866 	 * Populate the rx status block.  When there are bpf
867 	 * listeners we do the additional work to provide
868 	 * complete status.  Otherwise we fill in only the
869 	 * material required by ieee80211_input.  Note that
870 	 * noise setting is filled in above.
871 	 */
872 	if (ieee80211_radiotap_active(ic)) {
873 		ath_rx_tap(sc, m, rs, rstamp, nf);
874 #ifdef	ATH_ENABLE_RADIOTAP_VENDOR_EXT
875 		ath_rx_tap_vendor(sc, m, rs, rstamp, nf);
876 #endif	/* ATH_ENABLE_RADIOTAP_VENDOR_EXT */
877 	}
878 
879 	/*
880 	 * From this point on we assume the frame is at least
881 	 * as large as ieee80211_frame_min; verify that.
882 	 */
883 	if (len < IEEE80211_MIN_LEN) {
884 		if (!ieee80211_radiotap_active(ic)) {
885 			DPRINTF(sc, ATH_DEBUG_RECV,
886 			    "%s: short packet %d\n", __func__, len);
887 			sc->sc_stats.ast_rx_tooshort++;
888 		} else {
889 			/* NB: in particular this captures ack's */
890 			ieee80211_radiotap_rx_all(ic, m);
891 		}
892 		m_freem(m); m = NULL;
893 		goto rx_next;
894 	}
895 
896 	if (IFF_DUMPPKTS(sc, ATH_DEBUG_RECV)) {
897 		const HAL_RATE_TABLE *rt = sc->sc_currates;
898 		uint8_t rix = rt->rateCodeToIndex[rs->rs_rate];
899 
900 		ieee80211_dump_pkt(ic, mtod(m, caddr_t), len,
901 		    sc->sc_hwmap[rix].ieeerate, rs->rs_rssi);
902 	}
903 
904 	m_adj(m, -IEEE80211_CRC_LEN);
905 
906 	/*
907 	 * Locate the node for sender, track state, and then
908 	 * pass the (referenced) node up to the 802.11 layer
909 	 * for its use.
910 	 */
911 	ni = ieee80211_find_rxnode_withkey(ic,
912 		mtod(m, const struct ieee80211_frame_min *),
913 		rs->rs_keyix == HAL_RXKEYIX_INVALID ?
914 			IEEE80211_KEYIX_NONE : rs->rs_keyix);
915 	sc->sc_lastrs = rs;
916 
917 	if (rs->rs_isaggr)
918 		sc->sc_stats.ast_rx_agg++;
919 
920 	/*
921 	 * Populate the per-chain RSSI values where appropriate.
922 	 */
923 	bzero(&rxs, sizeof(rxs));
924 	rxs.r_flags |= IEEE80211_R_NF | IEEE80211_R_RSSI |
925 	    IEEE80211_R_C_CHAIN |
926 	    IEEE80211_R_C_NF |
927 	    IEEE80211_R_C_RSSI |
928 	    IEEE80211_R_TSF64 |
929 	    IEEE80211_R_TSF_START;	/* XXX TODO: validate */
930 	rxs.c_rssi = rs->rs_rssi;
931 	rxs.c_nf = nf;
932 	rxs.c_chain = 3;	/* XXX TODO: check */
933 	rxs.c_rx_tsf = rstamp;
934 
935 	for (i = 0; i < 3; i++) {
936 		rxs.c_rssi_ctl[i] = rs->rs_rssi_ctl[i];
937 		rxs.c_rssi_ext[i] = rs->rs_rssi_ext[i];
938 		/*
939 		 * XXX note: we currently don't track
940 		 * per-chain noisefloor.
941 		 */
942 		rxs.c_nf_ctl[i] = nf;
943 		rxs.c_nf_ext[i] = nf;
944 	}
945 
946 	if (ni != NULL) {
947 		/*
948 		 * Only punt packets for ampdu reorder processing for
949 		 * 11n nodes; net80211 enforces that M_AMPDU is only
950 		 * set for 11n nodes.
951 		 */
952 		if (ni->ni_flags & IEEE80211_NODE_HT)
953 			m->m_flags |= M_AMPDU;
954 
955 		/*
956 		 * Inform rate control about the received RSSI.
957 		 * It can then use this information to potentially drastically
958 		 * alter the available rate based on the RSSI estimate.
959 		 *
960 		 * This is super important when associating to a far away station;
961 		 * you don't want to waste time trying higher rates at some low
962 		 * packet exchange rate (like during DHCP) just to establish
963 		 * that higher MCS rates aren't available.
964 		 */
965 		ATH_RSSI_LPF(ATH_NODE(ni)->an_node_stats.ns_avgrssi,
966 		    rs->rs_rssi);
967 		ath_rate_update_rx_rssi(sc, ATH_NODE(ni),
968 		    ATH_RSSI(ATH_NODE(ni)->an_node_stats.ns_avgrssi));
969 
970 		/*
971 		 * Sending station is known, dispatch directly.
972 		 */
973 		(void) ieee80211_add_rx_params(m, &rxs);
974 		type = ieee80211_input_mimo(ni, m);
975 		ieee80211_free_node(ni);
976 		m = NULL;
977 		/*
978 		 * Arrange to update the last rx timestamp only for
979 		 * frames from our ap when operating in station mode.
980 		 * This assumes the rx key is always setup when
981 		 * associated.
982 		 */
983 		if (ic->ic_opmode == IEEE80211_M_STA &&
984 		    rs->rs_keyix != HAL_RXKEYIX_INVALID)
985 			is_good = 1;
986 	} else {
987 		(void) ieee80211_add_rx_params(m, &rxs);
988 		type = ieee80211_input_mimo_all(ic, m);
989 		m = NULL;
990 	}
991 
992 	/*
993 	 * At this point we have passed the frame up the stack; thus
994 	 * the mbuf is no longer ours.
995 	 */
996 
997 	/*
998 	 * Track legacy station RX rssi and do any rx antenna management.
999 	 */
1000 	ATH_RSSI_LPF(sc->sc_halstats.ns_avgrssi, rs->rs_rssi);
1001 	if (sc->sc_diversity) {
1002 		/*
1003 		 * When using fast diversity, change the default rx
1004 		 * antenna if diversity chooses the other antenna 3
1005 		 * times in a row.
1006 		 */
1007 		if (sc->sc_defant != rs->rs_antenna) {
1008 			if (++sc->sc_rxotherant >= 3)
1009 				ath_setdefantenna(sc, rs->rs_antenna);
1010 		} else
1011 			sc->sc_rxotherant = 0;
1012 	}
1013 
1014 	/* Handle slow diversity if enabled */
1015 	if (sc->sc_dolnadiv) {
1016 		ath_lna_rx_comb_scan(sc, rs, ticks, hz);
1017 	}
1018 
1019 	if (sc->sc_softled) {
1020 		/*
1021 		 * Blink for any data frame.  Otherwise do a
1022 		 * heartbeat-style blink when idle.  The latter
1023 		 * is mainly for station mode where we depend on
1024 		 * periodic beacon frames to trigger the poll event.
1025 		 */
1026 		if (type == IEEE80211_FC0_TYPE_DATA) {
1027 			const HAL_RATE_TABLE *rt = sc->sc_currates;
1028 			ath_led_event(sc,
1029 			    rt->rateCodeToIndex[rs->rs_rate]);
1030 		} else if (ticks - sc->sc_ledevent >= sc->sc_ledidle)
1031 			ath_led_event(sc, 0);
1032 		}
1033 rx_next:
1034 	/*
1035 	 * Debugging - complain if we didn't NULL the mbuf pointer
1036 	 * here.
1037 	 */
1038 	if (m != NULL) {
1039 		device_printf(sc->sc_dev,
1040 		    "%s: mbuf %p should've been freed!\n",
1041 		    __func__,
1042 		    m);
1043 	}
1044 	return (is_good);
1045 }
1046 
1047 #define	ATH_RX_MAX		128
1048 
1049 /*
1050  * XXX TODO: break out the "get buffers" from "call ath_rx_pkt()" like
1051  * the EDMA code does.
1052  *
1053  * XXX TODO: then, do all of the RX list management stuff inside
1054  * ATH_RX_LOCK() so we don't end up potentially racing.  The EDMA
1055  * code is doing it right.
1056  */
1057 static void
1058 ath_rx_proc(struct ath_softc *sc, int resched)
1059 {
1060 #define	PA2DESC(_sc, _pa) \
1061 	((struct ath_desc *)((caddr_t)(_sc)->sc_rxdma.dd_desc + \
1062 		((_pa) - (_sc)->sc_rxdma.dd_desc_paddr)))
1063 	struct ath_buf *bf;
1064 	struct ath_hal *ah = sc->sc_ah;
1065 #ifdef IEEE80211_SUPPORT_SUPERG
1066 	struct ieee80211com *ic = &sc->sc_ic;
1067 #endif
1068 	struct ath_desc *ds;
1069 	struct ath_rx_status *rs;
1070 	struct mbuf *m;
1071 	int ngood;
1072 	HAL_STATUS status;
1073 	int16_t nf;
1074 	u_int64_t tsf;
1075 	int npkts = 0;
1076 	int kickpcu = 0;
1077 	int ret;
1078 
1079 	NET_EPOCH_ASSERT();
1080 
1081 	/* XXX we must not hold the ATH_LOCK here */
1082 	ATH_UNLOCK_ASSERT(sc);
1083 	ATH_PCU_UNLOCK_ASSERT(sc);
1084 
1085 	ATH_PCU_LOCK(sc);
1086 	sc->sc_rxproc_cnt++;
1087 	kickpcu = sc->sc_kickpcu;
1088 	ATH_PCU_UNLOCK(sc);
1089 
1090 	ATH_LOCK(sc);
1091 	ath_power_set_power_state(sc, HAL_PM_AWAKE);
1092 	ATH_UNLOCK(sc);
1093 
1094 	DPRINTF(sc, ATH_DEBUG_RX_PROC, "%s: called\n", __func__);
1095 	ngood = 0;
1096 	nf = ath_hal_getchannoise(ah, sc->sc_curchan);
1097 	sc->sc_stats.ast_rx_noise = nf;
1098 	tsf = ath_hal_gettsf64(ah);
1099 	do {
1100 		/*
1101 		 * Don't process too many packets at a time; give the
1102 		 * TX thread time to also run - otherwise the TX
1103 		 * latency can jump by quite a bit, causing throughput
1104 		 * degredation.
1105 		 */
1106 		if (!kickpcu && npkts >= ATH_RX_MAX)
1107 			break;
1108 
1109 		bf = TAILQ_FIRST(&sc->sc_rxbuf);
1110 		if (sc->sc_rxslink && bf == NULL) {	/* NB: shouldn't happen */
1111 			device_printf(sc->sc_dev, "%s: no buffer!\n", __func__);
1112 			break;
1113 		} else if (bf == NULL) {
1114 			/*
1115 			 * End of List:
1116 			 * this can happen for non-self-linked RX chains
1117 			 */
1118 			sc->sc_stats.ast_rx_hitqueueend++;
1119 			break;
1120 		}
1121 		m = bf->bf_m;
1122 		if (m == NULL) {		/* NB: shouldn't happen */
1123 			/*
1124 			 * If mbuf allocation failed previously there
1125 			 * will be no mbuf; try again to re-populate it.
1126 			 */
1127 			/* XXX make debug msg */
1128 			device_printf(sc->sc_dev, "%s: no mbuf!\n", __func__);
1129 			TAILQ_REMOVE(&sc->sc_rxbuf, bf, bf_list);
1130 			goto rx_proc_next;
1131 		}
1132 		ds = bf->bf_desc;
1133 		if (ds->ds_link == bf->bf_daddr) {
1134 			/* NB: never process the self-linked entry at the end */
1135 			sc->sc_stats.ast_rx_hitqueueend++;
1136 			break;
1137 		}
1138 		/* XXX sync descriptor memory */
1139 		/*
1140 		 * Must provide the virtual address of the current
1141 		 * descriptor, the physical address, and the virtual
1142 		 * address of the next descriptor in the h/w chain.
1143 		 * This allows the HAL to look ahead to see if the
1144 		 * hardware is done with a descriptor by checking the
1145 		 * done bit in the following descriptor and the address
1146 		 * of the current descriptor the DMA engine is working
1147 		 * on.  All this is necessary because of our use of
1148 		 * a self-linked list to avoid rx overruns.
1149 		 */
1150 		rs = &bf->bf_status.ds_rxstat;
1151 		status = ath_hal_rxprocdesc(ah, ds,
1152 				bf->bf_daddr, PA2DESC(sc, ds->ds_link), rs);
1153 #ifdef ATH_DEBUG
1154 		if (sc->sc_debug & ATH_DEBUG_RECV_DESC)
1155 			ath_printrxbuf(sc, bf, 0, status == HAL_OK);
1156 #endif
1157 
1158 #ifdef	ATH_DEBUG_ALQ
1159 		if (if_ath_alq_checkdebug(&sc->sc_alq, ATH_ALQ_EDMA_RXSTATUS))
1160 		    if_ath_alq_post(&sc->sc_alq, ATH_ALQ_EDMA_RXSTATUS,
1161 		    sc->sc_rx_statuslen, (char *) ds);
1162 #endif	/* ATH_DEBUG_ALQ */
1163 
1164 		if (status == HAL_EINPROGRESS)
1165 			break;
1166 
1167 		TAILQ_REMOVE(&sc->sc_rxbuf, bf, bf_list);
1168 		npkts++;
1169 
1170 		/*
1171 		 * Process a single frame.
1172 		 */
1173 		bus_dmamap_sync(sc->sc_dmat, bf->bf_dmamap, BUS_DMASYNC_POSTREAD);
1174 		bus_dmamap_unload(sc->sc_dmat, bf->bf_dmamap);
1175 		bf->bf_m = NULL;
1176 		if (ath_rx_pkt(sc, rs, status, tsf, nf, HAL_RX_QUEUE_HP, bf, m))
1177 			ngood++;
1178 rx_proc_next:
1179 		/*
1180 		 * If there's a holding buffer, insert that onto
1181 		 * the RX list; the hardware is now definitely not pointing
1182 		 * to it now.
1183 		 */
1184 		ret = 0;
1185 		if (sc->sc_rxedma[HAL_RX_QUEUE_HP].m_holdbf != NULL) {
1186 			TAILQ_INSERT_TAIL(&sc->sc_rxbuf,
1187 			    sc->sc_rxedma[HAL_RX_QUEUE_HP].m_holdbf,
1188 			    bf_list);
1189 			ret = ath_rxbuf_init(sc,
1190 			    sc->sc_rxedma[HAL_RX_QUEUE_HP].m_holdbf);
1191 		}
1192 		/*
1193 		 * Next, throw our buffer into the holding entry.  The hardware
1194 		 * may use the descriptor to read the link pointer before
1195 		 * DMAing the next descriptor in to write out a packet.
1196 		 */
1197 		sc->sc_rxedma[HAL_RX_QUEUE_HP].m_holdbf = bf;
1198 	} while (ret == 0);
1199 
1200 	/* rx signal state monitoring */
1201 	ath_hal_rxmonitor(ah, &sc->sc_halstats, sc->sc_curchan);
1202 	if (ngood)
1203 		sc->sc_lastrx = tsf;
1204 
1205 	ATH_KTR(sc, ATH_KTR_RXPROC, 2, "ath_rx_proc: npkts=%d, ngood=%d", npkts, ngood);
1206 	/* Queue DFS tasklet if needed */
1207 	if (resched && ath_dfs_tasklet_needed(sc, sc->sc_curchan))
1208 		taskqueue_enqueue(sc->sc_tq, &sc->sc_dfstask);
1209 
1210 	/*
1211 	 * Now that all the RX frames were handled that
1212 	 * need to be handled, kick the PCU if there's
1213 	 * been an RXEOL condition.
1214 	 */
1215 	if (resched && kickpcu) {
1216 		ATH_PCU_LOCK(sc);
1217 		ATH_KTR(sc, ATH_KTR_ERROR, 0, "ath_rx_proc: kickpcu");
1218 		device_printf(sc->sc_dev, "%s: kickpcu; handled %d packets\n",
1219 		    __func__, npkts);
1220 
1221 		/*
1222 		 * Go through the process of fully tearing down
1223 		 * the RX buffers and reinitialising them.
1224 		 *
1225 		 * There's a hardware bug that causes the RX FIFO
1226 		 * to get confused under certain conditions and
1227 		 * constantly write over the same frame, leading
1228 		 * the RX driver code here to get heavily confused.
1229 		 */
1230 		/*
1231 		 * XXX Has RX DMA stopped enough here to just call
1232 		 *     ath_startrecv()?
1233 		 * XXX Do we need to use the holding buffer to restart
1234 		 *     RX DMA by appending entries to the final
1235 		 *     descriptor?  Quite likely.
1236 		 */
1237 #if 1
1238 		ath_startrecv(sc);
1239 #else
1240 		/*
1241 		 * Disabled for now - it'd be nice to be able to do
1242 		 * this in order to limit the amount of CPU time spent
1243 		 * reinitialising the RX side (and thus minimise RX
1244 		 * drops) however there's a hardware issue that
1245 		 * causes things to get too far out of whack.
1246 		 */
1247 		/*
1248 		 * XXX can we hold the PCU lock here?
1249 		 * Are there any net80211 buffer calls involved?
1250 		 */
1251 		bf = TAILQ_FIRST(&sc->sc_rxbuf);
1252 		ath_hal_putrxbuf(ah, bf->bf_daddr, HAL_RX_QUEUE_HP);
1253 		ath_hal_rxena(ah);		/* enable recv descriptors */
1254 		ath_mode_init(sc);		/* set filters, etc. */
1255 		ath_hal_startpcurecv(ah, (!! sc->sc_scanning));	/* re-enable PCU/DMA engine */
1256 #endif
1257 
1258 		ath_hal_intrset(ah, sc->sc_imask);
1259 		sc->sc_kickpcu = 0;
1260 		ATH_PCU_UNLOCK(sc);
1261 	}
1262 
1263 #ifdef IEEE80211_SUPPORT_SUPERG
1264 	if (resched)
1265 		ieee80211_ff_age_all(ic, 100);
1266 #endif
1267 
1268 	/*
1269 	 * Put the hardware to sleep again if we're done with it.
1270 	 */
1271 	ATH_LOCK(sc);
1272 	ath_power_restore_power_state(sc);
1273 	ATH_UNLOCK(sc);
1274 
1275 	/*
1276 	 * If we hit the maximum number of frames in this round,
1277 	 * reschedule for another immediate pass.  This gives
1278 	 * the TX and TX completion routines time to run, which
1279 	 * will reduce latency.
1280 	 */
1281 	if (npkts >= ATH_RX_MAX)
1282 		sc->sc_rx.recv_sched(sc, resched);
1283 
1284 	ATH_PCU_LOCK(sc);
1285 	sc->sc_rxproc_cnt--;
1286 	ATH_PCU_UNLOCK(sc);
1287 }
1288 #undef	PA2DESC
1289 #undef	ATH_RX_MAX
1290 
1291 /*
1292  * Only run the RX proc if it's not already running.
1293  * Since this may get run as part of the reset/flush path,
1294  * the task can't clash with an existing, running tasklet.
1295  */
1296 static void
1297 ath_legacy_rx_tasklet(void *arg, int npending)
1298 {
1299 	struct ath_softc *sc = arg;
1300 	struct epoch_tracker et;
1301 
1302 	ATH_KTR(sc, ATH_KTR_RXPROC, 1, "ath_rx_proc: pending=%d", npending);
1303 	DPRINTF(sc, ATH_DEBUG_RX_PROC, "%s: pending %u\n", __func__, npending);
1304 	ATH_PCU_LOCK(sc);
1305 	if (sc->sc_inreset_cnt > 0) {
1306 		device_printf(sc->sc_dev,
1307 		    "%s: sc_inreset_cnt > 0; skipping\n", __func__);
1308 		ATH_PCU_UNLOCK(sc);
1309 		return;
1310 	}
1311 	ATH_PCU_UNLOCK(sc);
1312 
1313 	NET_EPOCH_ENTER(et);
1314 	ath_rx_proc(sc, 1);
1315 	NET_EPOCH_EXIT(et);
1316 }
1317 
1318 static void
1319 ath_legacy_flushrecv(struct ath_softc *sc)
1320 {
1321 	struct epoch_tracker et;
1322 	NET_EPOCH_ENTER(et);
1323 	ath_rx_proc(sc, 0);
1324 	NET_EPOCH_EXIT(et);
1325 }
1326 
1327 static void
1328 ath_legacy_flush_rxpending(struct ath_softc *sc)
1329 {
1330 
1331 	/* XXX ATH_RX_LOCK_ASSERT(sc); */
1332 
1333 	if (sc->sc_rxedma[HAL_RX_QUEUE_LP].m_rxpending != NULL) {
1334 		m_freem(sc->sc_rxedma[HAL_RX_QUEUE_LP].m_rxpending);
1335 		sc->sc_rxedma[HAL_RX_QUEUE_LP].m_rxpending = NULL;
1336 	}
1337 	if (sc->sc_rxedma[HAL_RX_QUEUE_HP].m_rxpending != NULL) {
1338 		m_freem(sc->sc_rxedma[HAL_RX_QUEUE_HP].m_rxpending);
1339 		sc->sc_rxedma[HAL_RX_QUEUE_HP].m_rxpending = NULL;
1340 	}
1341 }
1342 
1343 static int
1344 ath_legacy_flush_rxholdbf(struct ath_softc *sc)
1345 {
1346 	struct ath_buf *bf;
1347 
1348 	/* XXX ATH_RX_LOCK_ASSERT(sc); */
1349 	/*
1350 	 * If there are RX holding buffers, free them here and return
1351 	 * them to the list.
1352 	 *
1353 	 * XXX should just verify that bf->bf_m is NULL, as it must
1354 	 * be at this point!
1355 	 */
1356 	bf = sc->sc_rxedma[HAL_RX_QUEUE_HP].m_holdbf;
1357 	if (bf != NULL) {
1358 		if (bf->bf_m != NULL)
1359 			m_freem(bf->bf_m);
1360 		bf->bf_m = NULL;
1361 		TAILQ_INSERT_TAIL(&sc->sc_rxbuf, bf, bf_list);
1362 		(void) ath_rxbuf_init(sc, bf);
1363 	}
1364 	sc->sc_rxedma[HAL_RX_QUEUE_HP].m_holdbf = NULL;
1365 
1366 	bf = sc->sc_rxedma[HAL_RX_QUEUE_LP].m_holdbf;
1367 	if (bf != NULL) {
1368 		if (bf->bf_m != NULL)
1369 			m_freem(bf->bf_m);
1370 		bf->bf_m = NULL;
1371 		TAILQ_INSERT_TAIL(&sc->sc_rxbuf, bf, bf_list);
1372 		(void) ath_rxbuf_init(sc, bf);
1373 	}
1374 	sc->sc_rxedma[HAL_RX_QUEUE_LP].m_holdbf = NULL;
1375 
1376 	return (0);
1377 }
1378 
1379 /*
1380  * Disable the receive h/w in preparation for a reset.
1381  */
1382 static void
1383 ath_legacy_stoprecv(struct ath_softc *sc, int dodelay)
1384 {
1385 #define	PA2DESC(_sc, _pa) \
1386 	((struct ath_desc *)((caddr_t)(_sc)->sc_rxdma.dd_desc + \
1387 		((_pa) - (_sc)->sc_rxdma.dd_desc_paddr)))
1388 	struct ath_hal *ah = sc->sc_ah;
1389 
1390 	ATH_RX_LOCK(sc);
1391 
1392 	ath_hal_stoppcurecv(ah);	/* disable PCU */
1393 	ath_hal_setrxfilter(ah, 0);	/* clear recv filter */
1394 	ath_hal_stopdmarecv(ah);	/* disable DMA engine */
1395 	/*
1396 	 * TODO: see if this particular DELAY() is required; it may be
1397 	 * masking some missing FIFO flush or DMA sync.
1398 	 */
1399 #if 0
1400 	if (dodelay)
1401 #endif
1402 		DELAY(3000);		/* 3ms is long enough for 1 frame */
1403 #ifdef ATH_DEBUG
1404 	if (sc->sc_debug & (ATH_DEBUG_RESET | ATH_DEBUG_FATAL)) {
1405 		struct ath_buf *bf;
1406 		u_int ix;
1407 
1408 		device_printf(sc->sc_dev,
1409 		    "%s: rx queue %p, link %p\n",
1410 		    __func__,
1411 		    (caddr_t)(uintptr_t) ath_hal_getrxbuf(ah, HAL_RX_QUEUE_HP),
1412 		    sc->sc_rxlink);
1413 		ix = 0;
1414 		TAILQ_FOREACH(bf, &sc->sc_rxbuf, bf_list) {
1415 			struct ath_desc *ds = bf->bf_desc;
1416 			struct ath_rx_status *rs = &bf->bf_status.ds_rxstat;
1417 			HAL_STATUS status = ath_hal_rxprocdesc(ah, ds,
1418 				bf->bf_daddr, PA2DESC(sc, ds->ds_link), rs);
1419 			if (status == HAL_OK || (sc->sc_debug & ATH_DEBUG_FATAL))
1420 				ath_printrxbuf(sc, bf, ix, status == HAL_OK);
1421 			ix++;
1422 		}
1423 	}
1424 #endif
1425 
1426 	(void) ath_legacy_flush_rxpending(sc);
1427 	(void) ath_legacy_flush_rxholdbf(sc);
1428 
1429 	sc->sc_rxlink = NULL;		/* just in case */
1430 
1431 	ATH_RX_UNLOCK(sc);
1432 #undef PA2DESC
1433 }
1434 
1435 /*
1436  * XXX TODO: something was calling startrecv without calling
1437  * stoprecv.  Let's figure out what/why.  It was showing up
1438  * as a mbuf leak (rxpending) and ath_buf leak (holdbf.)
1439  */
1440 
1441 /*
1442  * Enable the receive h/w following a reset.
1443  */
1444 static int
1445 ath_legacy_startrecv(struct ath_softc *sc)
1446 {
1447 	struct ath_hal *ah = sc->sc_ah;
1448 	struct ath_buf *bf;
1449 
1450 	ATH_RX_LOCK(sc);
1451 
1452 	/*
1453 	 * XXX should verify these are already all NULL!
1454 	 */
1455 	sc->sc_rxlink = NULL;
1456 	(void) ath_legacy_flush_rxpending(sc);
1457 	(void) ath_legacy_flush_rxholdbf(sc);
1458 
1459 	/*
1460 	 * Re-chain all of the buffers in the RX buffer list.
1461 	 */
1462 	TAILQ_FOREACH(bf, &sc->sc_rxbuf, bf_list) {
1463 		int error = ath_rxbuf_init(sc, bf);
1464 		if (error != 0) {
1465 			DPRINTF(sc, ATH_DEBUG_RECV,
1466 				"%s: ath_rxbuf_init failed %d\n",
1467 				__func__, error);
1468 			return error;
1469 		}
1470 	}
1471 
1472 	bf = TAILQ_FIRST(&sc->sc_rxbuf);
1473 	ath_hal_putrxbuf(ah, bf->bf_daddr, HAL_RX_QUEUE_HP);
1474 	ath_hal_rxena(ah);		/* enable recv descriptors */
1475 	ath_mode_init(sc);		/* set filters, etc. */
1476 	ath_hal_startpcurecv(ah, (!! sc->sc_scanning));	/* re-enable PCU/DMA engine */
1477 
1478 	ATH_RX_UNLOCK(sc);
1479 	return 0;
1480 }
1481 
1482 static int
1483 ath_legacy_dma_rxsetup(struct ath_softc *sc)
1484 {
1485 	int error;
1486 
1487 	error = ath_descdma_setup(sc, &sc->sc_rxdma, &sc->sc_rxbuf,
1488 	    "rx", sizeof(struct ath_desc), ath_rxbuf, 1);
1489 	if (error != 0)
1490 		return (error);
1491 
1492 	return (0);
1493 }
1494 
1495 static int
1496 ath_legacy_dma_rxteardown(struct ath_softc *sc)
1497 {
1498 
1499 	if (sc->sc_rxdma.dd_desc_len != 0)
1500 		ath_descdma_cleanup(sc, &sc->sc_rxdma, &sc->sc_rxbuf);
1501 	return (0);
1502 }
1503 
1504 static void
1505 ath_legacy_recv_sched(struct ath_softc *sc, int dosched)
1506 {
1507 
1508 	taskqueue_enqueue(sc->sc_tq, &sc->sc_rxtask);
1509 }
1510 
1511 static void
1512 ath_legacy_recv_sched_queue(struct ath_softc *sc, HAL_RX_QUEUE q,
1513     int dosched)
1514 {
1515 
1516 	taskqueue_enqueue(sc->sc_tq, &sc->sc_rxtask);
1517 }
1518 
1519 void
1520 ath_recv_setup_legacy(struct ath_softc *sc)
1521 {
1522 
1523 	/* Sensible legacy defaults */
1524 	/*
1525 	 * XXX this should be changed to properly support the
1526 	 * exact RX descriptor size for each HAL.
1527 	 */
1528 	sc->sc_rx_statuslen = sizeof(struct ath_desc);
1529 
1530 	sc->sc_rx.recv_start = ath_legacy_startrecv;
1531 	sc->sc_rx.recv_stop = ath_legacy_stoprecv;
1532 	sc->sc_rx.recv_flush = ath_legacy_flushrecv;
1533 	sc->sc_rx.recv_tasklet = ath_legacy_rx_tasklet;
1534 	sc->sc_rx.recv_rxbuf_init = ath_legacy_rxbuf_init;
1535 
1536 	sc->sc_rx.recv_setup = ath_legacy_dma_rxsetup;
1537 	sc->sc_rx.recv_teardown = ath_legacy_dma_rxteardown;
1538 	sc->sc_rx.recv_sched = ath_legacy_recv_sched;
1539 	sc->sc_rx.recv_sched_queue = ath_legacy_recv_sched_queue;
1540 }
1541