xref: /freebsd/sys/dev/rtwn/pci/rtwn_pci_rx.c (revision 71ceff9f0b4a3add236a6458da0ea3671fedd0a1)
1 /*	$OpenBSD: if_rtwn.c,v 1.6 2015/08/28 00:03:53 deraadt Exp $	*/
2 
3 /*-
4  * Copyright (c) 2010 Damien Bergamini <damien.bergamini@free.fr>
5  * Copyright (c) 2015 Stefan Sperling <stsp@openbsd.org>
6  * Copyright (c) 2016 Andriy Voskoboinyk <avos@FreeBSD.org>
7  *
8  * Permission to use, copy, modify, and distribute this software for any
9  * purpose with or without fee is hereby granted, provided that the above
10  * copyright notice and this permission notice appear in all copies.
11  *
12  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19  */
20 
21 #include <sys/cdefs.h>
22 __FBSDID("$FreeBSD$");
23 
24 #include "opt_wlan.h"
25 
26 #include <sys/param.h>
27 #include <sys/lock.h>
28 #include <sys/mutex.h>
29 #include <sys/mbuf.h>
30 #include <sys/kernel.h>
31 #include <sys/socket.h>
32 #include <sys/systm.h>
33 #include <sys/malloc.h>
34 #include <sys/queue.h>
35 #include <sys/taskqueue.h>
36 #include <sys/bus.h>
37 #include <sys/endian.h>
38 
39 #include <machine/bus.h>
40 #include <machine/resource.h>
41 #include <sys/rman.h>
42 
43 #include <net/if.h>
44 #include <net/ethernet.h>
45 #include <net/if_media.h>
46 
47 #include <net80211/ieee80211_var.h>
48 
49 #include <dev/rtwn/if_rtwnreg.h>
50 #include <dev/rtwn/if_rtwnvar.h>
51 #include <dev/rtwn/if_rtwn_debug.h>
52 #include <dev/rtwn/if_rtwn_rx.h>
53 #include <dev/rtwn/if_rtwn_task.h>
54 #include <dev/rtwn/if_rtwn_tx.h>
55 
56 #include <dev/rtwn/pci/rtwn_pci_var.h>
57 #include <dev/rtwn/pci/rtwn_pci_rx.h>
58 
59 
60 void
61 rtwn_pci_dma_map_addr(void *arg, bus_dma_segment_t *segs, int nsegs,
62     int error)
63 {
64 
65 	if (error != 0)
66 		return;
67 	KASSERT(nsegs == 1, ("too many DMA segments, %d should be 1", nsegs));
68 	*(bus_addr_t *)arg = segs[0].ds_addr;
69 }
70 
71 void
72 rtwn_pci_setup_rx_desc(struct rtwn_pci_softc *pc,
73     struct rtwn_rx_stat_pci *desc, bus_addr_t addr, size_t len, int idx)
74 {
75 
76 	memset(desc, 0, sizeof(*desc));
77 	desc->rxdw0 = htole32(SM(RTWN_RXDW0_PKTLEN, len) |
78 		((idx == RTWN_PCI_RX_LIST_COUNT - 1) ? RTWN_RXDW0_EOR : 0));
79 	desc->rxbufaddr = htole32(addr);
80 	bus_space_barrier(pc->pc_st, pc->pc_sh, 0, pc->pc_mapsize,
81 	    BUS_SPACE_BARRIER_WRITE);
82 	desc->rxdw0 |= htole32(RTWN_RXDW0_OWN);
83 }
84 
85 static void
86 rtwn_pci_rx_frame(struct rtwn_pci_softc *pc)
87 {
88 	struct rtwn_softc *sc = &pc->pc_sc;
89 	struct rtwn_rx_ring *ring = &pc->rx_ring;
90 	struct rtwn_rx_stat_pci *rx_desc = &ring->desc[ring->cur];
91 	struct rtwn_rx_data *rx_data = &ring->rx_data[ring->cur];
92 	struct ieee80211com *ic = &sc->sc_ic;
93 	struct ieee80211_node *ni;
94 	uint32_t rxdw0;
95 	struct mbuf *m, *m1;
96 	int infosz, pktlen, shift, error;
97 
98 	/* Dump Rx descriptor. */
99 	RTWN_DPRINTF(sc, RTWN_DEBUG_RECV_DESC,
100 	    "%s: dw: 0 %08X, 1 %08X, 2 %08X, 3 %08X, 4 %08X, tsfl %08X, "
101 	    "addr: %08X (64: %08X)\n",
102 	    __func__, le32toh(rx_desc->rxdw0), le32toh(rx_desc->rxdw1),
103 	    le32toh(rx_desc->rxdw2), le32toh(rx_desc->rxdw3),
104 	    le32toh(rx_desc->rxdw4), le32toh(rx_desc->tsf_low),
105 	    le32toh(rx_desc->rxbufaddr), le32toh(rx_desc->rxbufaddr64));
106 
107 	rxdw0 = le32toh(rx_desc->rxdw0);
108 	if (__predict_false(rxdw0 & (RTWN_RXDW0_CRCERR | RTWN_RXDW0_ICVERR))) {
109 		/*
110 		 * This should not happen since we setup our Rx filter
111 		 * to not receive these frames.
112 		 */
113 		RTWN_DPRINTF(sc, RTWN_DEBUG_RECV,
114 		    "%s: RX flags error (%s)\n", __func__,
115 		    rxdw0 & RTWN_RXDW0_CRCERR ? "CRC" : "ICV");
116 		goto fail;
117 	}
118 
119 	pktlen = MS(rxdw0, RTWN_RXDW0_PKTLEN);
120 	if (__predict_false(pktlen < sizeof(struct ieee80211_frame_ack) ||
121 	    pktlen > MJUMPAGESIZE)) {
122 		RTWN_DPRINTF(sc, RTWN_DEBUG_RECV,
123 		    "%s: frame is too short/long: %d\n", __func__, pktlen);
124 		goto fail;
125 	}
126 
127 	infosz = MS(rxdw0, RTWN_RXDW0_INFOSZ) * 8;
128 	shift = MS(rxdw0, RTWN_RXDW0_SHIFT);
129 
130 	m1 = m_getjcl(M_NOWAIT, MT_DATA, M_PKTHDR, MJUMPAGESIZE);
131 	if (__predict_false(m1 == NULL)) {
132 		device_printf(sc->sc_dev, "%s: could not allocate RX mbuf\n",
133 		    __func__);
134 		goto fail;
135 	}
136 	bus_dmamap_sync(ring->data_dmat, rx_data->map, BUS_DMASYNC_POSTREAD);
137 	bus_dmamap_unload(ring->data_dmat, rx_data->map);
138 
139 	error = bus_dmamap_load(ring->data_dmat, rx_data->map, mtod(m1, void *),
140 	    MJUMPAGESIZE, rtwn_pci_dma_map_addr, &rx_data->paddr, 0);
141 	if (error != 0) {
142 		m_freem(m1);
143 
144 		error = bus_dmamap_load(ring->data_dmat, rx_data->map,
145 		    mtod(rx_data->m, void *), MJUMPAGESIZE,
146 		    rtwn_pci_dma_map_addr, &rx_data->paddr, BUS_DMA_NOWAIT);
147 		if (error != 0)
148 			panic("%s: could not load old RX mbuf",
149 			    device_get_name(sc->sc_dev));
150 
151 		goto fail;
152 	}
153 
154 	/* Finalize mbuf. */
155 	m = rx_data->m;
156 	rx_data->m = m1;
157 	m->m_pkthdr.len = m->m_len = pktlen + infosz + shift;
158 
159 	ni = rtwn_rx_common(sc, m, rx_desc);
160 
161 	RTWN_DPRINTF(sc, RTWN_DEBUG_RECV,
162 	    "%s: Rx frame len %d, infosz %d, shift %d\n",
163 	    __func__, pktlen, infosz, shift);
164 
165 	/* Send the frame to the 802.11 layer. */
166 	RTWN_UNLOCK(sc);
167 	if (ni != NULL) {
168 		(void)ieee80211_input_mimo(ni, m);
169 		/* Node is no longer needed. */
170 		ieee80211_free_node(ni);
171 	} else
172 		(void)ieee80211_input_mimo_all(ic, m);
173 
174 	RTWN_LOCK(sc);
175 
176 	return;
177 
178 fail:
179 	counter_u64_add(ic->ic_ierrors, 1);
180 }
181 
182 static int
183 rtwn_pci_rx_buf_copy(struct rtwn_pci_softc *pc)
184 {
185 	struct rtwn_rx_ring *ring = &pc->rx_ring;
186 	struct rtwn_rx_stat_pci *rx_desc = &ring->desc[ring->cur];
187 	struct rtwn_rx_data *rx_data = &ring->rx_data[ring->cur];
188 	uint32_t rxdw0;
189 	int desc_size, pktlen;
190 
191 	/*
192 	 * NB: tx_report() / c2h_report() expects to see USB Rx
193 	 * descriptor - same as for PCIe, but without rxbufaddr* fields.
194 	 */
195 	desc_size = sizeof(struct rtwn_rx_stat_common);
196 	KASSERT(sizeof(pc->pc_rx_buf) >= desc_size,
197 	    ("adjust size for PCIe Rx buffer!"));
198 
199 	memcpy(pc->pc_rx_buf, rx_desc, desc_size);
200 
201 	rxdw0 = le32toh(rx_desc->rxdw0);
202 	pktlen = MS(rxdw0, RTWN_RXDW0_PKTLEN);
203 
204 	if (pktlen > sizeof(pc->pc_rx_buf) - desc_size)
205 	{
206 		/* Looks like an ordinary Rx frame. */
207 		return (desc_size);
208 	}
209 
210 	bus_dmamap_sync(ring->data_dmat, rx_data->map, BUS_DMASYNC_POSTREAD);
211 	memcpy(pc->pc_rx_buf + desc_size, mtod(rx_data->m, void *), pktlen);
212 
213 	return (desc_size + pktlen);
214 }
215 
216 static void
217 rtwn_pci_tx_report(struct rtwn_pci_softc *pc, int len)
218 {
219 	struct rtwn_softc *sc = &pc->pc_sc;
220 
221 	if (sc->sc_ratectl != RTWN_RATECTL_NET80211) {
222 		/* shouldn't happen */
223 		device_printf(sc->sc_dev,
224 		    "%s called while ratectl = %d!\n",
225 		     __func__, sc->sc_ratectl);
226 		return;
227 	}
228 
229 	RTWN_NT_LOCK(sc);
230 	rtwn_handle_tx_report(sc, pc->pc_rx_buf, len);
231 	RTWN_NT_UNLOCK(sc);
232 
233 #ifdef IEEE80211_SUPPORT_SUPERG
234 	/*
235 	 * NB: this will executed only when 'report' bit is set.
236 	 */
237 	if (sc->sc_tx_n_active > 0 && --sc->sc_tx_n_active <= 1)
238 		rtwn_cmd_sleepable(sc, NULL, 0, rtwn_ff_flush_all);
239 #endif
240 }
241 
242 static void
243 rtwn_pci_c2h_report(struct rtwn_pci_softc *pc, int len)
244 {
245 	rtwn_handle_c2h_report(&pc->pc_sc, pc->pc_rx_buf, len);
246 }
247 
248 static void
249 rtwn_pci_tx_done(struct rtwn_softc *sc, int qid)
250 {
251 	struct rtwn_pci_softc *pc = RTWN_PCI_SOFTC(sc);
252 	struct rtwn_tx_ring *ring = &pc->tx_ring[qid];
253 	struct rtwn_tx_desc_common *desc;
254 	struct rtwn_tx_data *data;
255 
256 	RTWN_DPRINTF(sc, RTWN_DEBUG_INTR, "%s: qid %d, last %d, cur %d\n",
257 	    __func__, qid, ring->last, ring->cur);
258 
259 	bus_dmamap_sync(ring->desc_dmat, ring->desc_map,
260 	    BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE);
261 
262 	while(ring->last != ring->cur) {
263 		data = &ring->tx_data[ring->last];
264 		desc = (struct rtwn_tx_desc_common *)
265 		    ((uint8_t *)ring->desc + sc->txdesc_len * ring->last);
266 
267 		KASSERT(data->m != NULL, ("no mbuf"));
268 
269 		if (desc->flags0 & RTWN_FLAGS0_OWN)
270 			break;
271 
272 		/* Unmap and free mbuf. */
273 		bus_dmamap_sync(ring->data_dmat, data->map,
274 		    BUS_DMASYNC_POSTWRITE);
275 		bus_dmamap_unload(ring->data_dmat, data->map);
276 
277 		if (data->ni != NULL) {	/* not a beacon frame */
278 			ieee80211_tx_complete(data->ni, data->m, 0);
279 
280 			data->ni = NULL;
281 			ring->queued--;
282 			KASSERT(ring->queued >= 0,
283 			    ("ring->queued (qid %d) underflow!\n", qid));
284 		} else
285 			m_freem(data->m);
286 
287 		data->m = NULL;
288 		ring->last = (ring->last + 1) % RTWN_PCI_TX_LIST_COUNT;
289 #ifndef D4054
290 		if (ring->queued > 0)
291 			sc->sc_tx_timer = 5;
292 		else
293 			sc->sc_tx_timer = 0;
294 #endif
295 	}
296 
297 	if ((sc->qfullmsk & (1 << qid)) != 0 &&
298 	    ring->queued < (RTWN_PCI_TX_LIST_COUNT - 1)) {
299 		sc->qfullmsk &= ~(1 << qid);
300 		rtwn_start(sc);
301 	}
302 
303 #ifdef  IEEE80211_SUPPORT_SUPERG
304 	/*
305 	 * If the TX active queue drops below a certain
306 	 * threshold, ensure we age fast-frames out so they're
307 	 * transmitted.
308 	 */
309 	if (sc->sc_ratectl != RTWN_RATECTL_NET80211 && ring->queued <= 1) {
310 		/*
311 		 * XXX TODO: just make this a callout timer schedule
312 		 * so we can flush the FF staging queue if we're
313 		 * approaching idle.
314 		 */
315 		rtwn_cmd_sleepable(sc, NULL, 0, rtwn_ff_flush_all);
316 	}
317 #endif
318 }
319 
320 static void
321 rtwn_pci_rx_done(struct rtwn_softc *sc)
322 {
323 	struct rtwn_pci_softc *pc = RTWN_PCI_SOFTC(sc);
324 	struct rtwn_rx_ring *ring = &pc->rx_ring;
325 	struct rtwn_rx_stat_pci *rx_desc;
326 	struct rtwn_rx_data *rx_data;
327 	int len;
328 
329 	bus_dmamap_sync(ring->desc_dmat, ring->desc_map, BUS_DMASYNC_POSTREAD);
330 
331 	for (;;) {
332 		rx_desc = &ring->desc[ring->cur];
333 		rx_data = &ring->rx_data[ring->cur];
334 
335 		if (le32toh(rx_desc->rxdw0) & RTWN_RXDW0_OWN)
336 			break;
337 
338 		len = rtwn_pci_rx_buf_copy(pc);
339 
340 		switch (rtwn_classify_intr(sc, pc->pc_rx_buf, len)) {
341 		case RTWN_RX_DATA:
342 			rtwn_pci_rx_frame(pc);
343 			break;
344 		case RTWN_RX_TX_REPORT:
345 			rtwn_pci_tx_report(pc, len);
346 			break;
347 		case RTWN_RX_OTHER:
348 			rtwn_pci_c2h_report(pc, len);
349 			break;
350 		default:
351 			/* NOTREACHED */
352 			KASSERT(0, ("unknown Rx classification code"));
353 			break;
354 		}
355 
356 		/* Update / reset RX descriptor (and set OWN bit). */
357 		rtwn_pci_setup_rx_desc(pc, rx_desc, rx_data->paddr,
358 		    MJUMPAGESIZE, ring->cur);
359 
360 		if (!(sc->sc_flags & RTWN_RUNNING))
361 			return;
362 
363 		/* NB: device can reuse current descriptor. */
364 		bus_dmamap_sync(ring->desc_dmat, ring->desc_map,
365 		    BUS_DMASYNC_POSTREAD);
366 
367 		if (le32toh(rx_desc->rxdw0) & RTWN_RXDW0_OWN)
368 			ring->cur = (ring->cur + 1) % RTWN_PCI_RX_LIST_COUNT;
369 	}
370 }
371 
372 void
373 rtwn_pci_intr(void *arg)
374 {
375 	struct rtwn_softc *sc = arg;
376 	struct rtwn_pci_softc *pc = RTWN_PCI_SOFTC(sc);
377 	int i, status, tx_rings;
378 
379 	RTWN_LOCK(sc);
380 	status = rtwn_pci_get_intr_status(pc, &tx_rings);
381 	RTWN_DPRINTF(sc, RTWN_DEBUG_INTR, "%s: status %08X, tx_rings %08X\n",
382 	    __func__, status, tx_rings);
383 	if (status == 0 && tx_rings == 0)
384 		goto unlock;
385 
386 	if (status & (RTWN_PCI_INTR_RX | RTWN_PCI_INTR_TX_REPORT)) {
387 		rtwn_pci_rx_done(sc);
388 		if (!(sc->sc_flags & RTWN_RUNNING))
389 			goto unlock;
390 	}
391 
392 	if (tx_rings != 0)
393 		for (i = 0; i < RTWN_PCI_NTXQUEUES; i++)
394 			if (tx_rings & (1 << i))
395 				rtwn_pci_tx_done(sc, i);
396 
397 	if (sc->sc_flags & RTWN_RUNNING)
398 		rtwn_pci_enable_intr(pc);
399 unlock:
400 	RTWN_UNLOCK(sc);
401 }
402