xref: /freebsd/sys/dev/rtwn/rtl8812a/r12a_rx.c (revision 22cf89c938886d14f5796fc49f9f020c23ea8eaf)
1 /*-
2  * Copyright (c) 2016 Andriy Voskoboinyk <avos@FreeBSD.org>
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  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 #include "opt_wlan.h"
29 
30 #include <sys/param.h>
31 #include <sys/lock.h>
32 #include <sys/mutex.h>
33 #include <sys/mbuf.h>
34 #include <sys/kernel.h>
35 #include <sys/socket.h>
36 #include <sys/systm.h>
37 #include <sys/malloc.h>
38 #include <sys/queue.h>
39 #include <sys/taskqueue.h>
40 #include <sys/bus.h>
41 #include <sys/endian.h>
42 #include <sys/linker.h>
43 
44 #include <net/if.h>
45 #include <net/ethernet.h>
46 #include <net/if_media.h>
47 
48 #include <net80211/ieee80211_var.h>
49 #include <net80211/ieee80211_radiotap.h>
50 #include <net80211/ieee80211_ratectl.h>
51 
52 #include <dev/rtwn/if_rtwnreg.h>
53 #include <dev/rtwn/if_rtwnvar.h>
54 
55 #include <dev/rtwn/if_rtwn_debug.h>
56 #include <dev/rtwn/if_rtwn_ridx.h>
57 
58 #include <dev/rtwn/rtl8812a/r12a.h>
59 #include <dev/rtwn/rtl8812a/r12a_var.h>
60 #include <dev/rtwn/rtl8812a/r12a_fw_cmd.h>
61 #include <dev/rtwn/rtl8812a/r12a_rx_desc.h>
62 
63 #ifndef RTWN_WITHOUT_UCODE
64 void
65 r12a_ratectl_tx_complete(struct rtwn_softc *sc, uint8_t *buf, int len)
66 {
67 	struct ieee80211_ratectl_tx_status txs;
68 	struct r12a_c2h_tx_rpt *rpt;
69 	struct ieee80211_node *ni;
70 	int ntries;
71 
72 	/* Skip Rx descriptor / report id / sequence fields. */
73 	buf += sizeof(struct r92c_rx_stat) + 2;
74 	len -= sizeof(struct r92c_rx_stat) + 2;
75 
76 	rpt = (struct r12a_c2h_tx_rpt *)buf;
77 	if (len != sizeof(*rpt)) {
78 		device_printf(sc->sc_dev,
79 		    "%s: wrong report size (%d, must be %zu)\n",
80 		    __func__, len, sizeof(*rpt));
81 		return;
82 	}
83 
84 	RTWN_DPRINTF(sc, RTWN_DEBUG_INTR,
85 	    "%s: ccx report dump: 0: %02X, id: %02X, 2: %02X, queue time: "
86 	    "low %02X, high %02X, final ridx: %02X, rsvd: %04X\n",
87 	    __func__, rpt->txrptb0, rpt->macid, rpt->txrptb2,
88 	    rpt->queue_time_low, rpt->queue_time_high, rpt->final_rate,
89 	    rpt->reserved);
90 
91 	if (rpt->macid > sc->macid_limit) {
92 		device_printf(sc->sc_dev,
93 		    "macid %u is too big; increase MACID_MAX limit\n",
94 		    rpt->macid);
95 		return;
96 	}
97 
98 	ntries = MS(rpt->txrptb2, R12A_TXRPTB2_RETRY_CNT);
99 
100 	ni = sc->node_list[rpt->macid];
101 	if (ni != NULL) {
102 		RTWN_DPRINTF(sc, RTWN_DEBUG_INTR, "%s: frame for macid %u was"
103 		    "%s sent (%d retries)\n", __func__, rpt->macid,
104 		    (rpt->txrptb0 & (R12A_TXRPTB0_RETRY_OVER |
105 		    R12A_TXRPTB0_LIFE_EXPIRE)) ? " not" : "", ntries);
106 
107 		txs.flags = IEEE80211_RATECTL_STATUS_LONG_RETRY |
108 			    IEEE80211_RATECTL_STATUS_FINAL_RATE;
109 		txs.long_retries = ntries;
110 		if (rpt->final_rate > RTWN_RIDX_OFDM54) {	/* MCS */
111 			txs.final_rate =
112 			    rpt->final_rate - RTWN_RIDX_HT_MCS_SHIFT;
113 			txs.final_rate |= IEEE80211_RATE_MCS;
114 		} else
115 			txs.final_rate = ridx2rate[rpt->final_rate];
116 		if (rpt->txrptb0 & R12A_TXRPTB0_RETRY_OVER)
117 			txs.status = IEEE80211_RATECTL_TX_FAIL_LONG;
118 		else if (rpt->txrptb0 & R12A_TXRPTB0_LIFE_EXPIRE)
119 			txs.status = IEEE80211_RATECTL_TX_FAIL_EXPIRED;
120 		else
121 			txs.status = IEEE80211_RATECTL_TX_SUCCESS;
122 		ieee80211_ratectl_tx_complete(ni, &txs);
123 	} else {
124 		RTWN_DPRINTF(sc, RTWN_DEBUG_INTR,
125 		    "%s: macid %u, ni is NULL\n", __func__, rpt->macid);
126 	}
127 }
128 
129 void
130 r12a_handle_c2h_report(struct rtwn_softc *sc, uint8_t *buf, int len)
131 {
132 	struct r12a_softc *rs = sc->sc_priv;
133 
134 	/* Skip Rx descriptor. */
135 	buf += sizeof(struct r92c_rx_stat);
136 	len -= sizeof(struct r92c_rx_stat);
137 
138 	if (len < 2) {
139 		device_printf(sc->sc_dev, "C2H report too short (len %d)\n",
140 		    len);
141 		return;
142 	}
143 	len -= 2;
144 
145 	switch (buf[0]) {	/* command id */
146 	case R12A_C2H_TX_REPORT:
147 		/* NOTREACHED */
148 		KASSERT(0, ("use handle_tx_report() instead of %s\n",
149 		    __func__));
150 		break;
151 	case R12A_C2H_IQK_FINISHED:
152 		RTWN_DPRINTF(sc, RTWN_DEBUG_CALIB,
153 		    "FW IQ calibration finished\n");
154 		rs->rs_flags &= ~R12A_IQK_RUNNING;
155 		break;
156 	default:
157 		device_printf(sc->sc_dev,
158 		    "%s: C2H report %u was not handled\n",
159 		    __func__, buf[0]);
160 	}
161 }
162 #else
163 void
164 r12a_ratectl_tx_complete(struct rtwn_softc *sc, uint8_t *buf, int len)
165 {
166 	/* Should not happen. */
167 	device_printf(sc->sc_dev, "%s: called\n", __func__);
168 }
169 
170 void
171 r12a_handle_c2h_report(struct rtwn_softc *sc, uint8_t *buf, int len)
172 {
173 	/* Should not happen. */
174 	device_printf(sc->sc_dev, "%s: called\n", __func__);
175 }
176 #endif
177 
178 int
179 r12a_check_frame_checksum(struct rtwn_softc *sc, struct mbuf *m)
180 {
181 	struct r12a_softc *rs = sc->sc_priv;
182 	struct r92c_rx_stat *stat;
183 	uint32_t rxdw1;
184 
185 	stat = mtod(m, struct r92c_rx_stat *);
186 	rxdw1 = le32toh(stat->rxdw1);
187 	if (rxdw1 & R12A_RXDW1_CKSUM) {
188 		RTWN_DPRINTF(sc, RTWN_DEBUG_RECV,
189 		    "%s: %s/%s checksum is %s\n", __func__,
190 		    (rxdw1 & R12A_RXDW1_UDP) ? "UDP" : "TCP",
191 		    (rxdw1 & R12A_RXDW1_IPV6) ? "IPv6" : "IP",
192 		    (rxdw1 & R12A_RXDW1_CKSUM_ERR) ? "invalid" : "valid");
193 
194 		if (rxdw1 & R12A_RXDW1_CKSUM_ERR)
195 			return (-1);
196 
197 		if ((rxdw1 & R12A_RXDW1_IPV6) ?
198 		    (rs->rs_flags & R12A_RXCKSUM6_EN) :
199 		    (rs->rs_flags & R12A_RXCKSUM_EN)) {
200 			m->m_pkthdr.csum_flags = CSUM_IP_CHECKED |
201 			    CSUM_IP_VALID | CSUM_DATA_VALID | CSUM_PSEUDO_HDR;
202 			m->m_pkthdr.csum_data = 0xffff;
203 		}
204 	}
205 
206 	return (0);
207 }
208 
209 uint8_t
210 r12a_rx_radiotap_flags(const void *buf)
211 {
212 	const struct r92c_rx_stat *stat = buf;
213 	uint8_t flags, rate;
214 
215 	if (!(stat->rxdw4 & htole32(R12A_RXDW4_SPLCP)))
216 		return (0);
217 	rate = MS(le32toh(stat->rxdw3), R12A_RXDW3_RATE);
218 	if (RTWN_RATE_IS_CCK(rate))
219 		flags = IEEE80211_RADIOTAP_F_SHORTPRE;
220 	else
221 		flags = IEEE80211_RADIOTAP_F_SHORTGI;
222 	return (flags);
223 }
224 
225 void
226 r12a_get_rx_stats(struct rtwn_softc *sc, struct ieee80211_rx_stats *rxs,
227     const void *desc, const void *physt_ptr)
228 {
229 	const struct r92c_rx_stat *stat = desc;
230 	const struct r12a_rx_phystat *physt = physt_ptr;
231 	uint32_t rxdw0, rxdw1, rxdw3, rxdw4;
232 	uint8_t rate;
233 
234 	rxdw0 = le32toh(stat->rxdw0);
235 	rxdw1 = le32toh(stat->rxdw1);
236 	rxdw3 = le32toh(stat->rxdw3);
237 	rxdw4 = le32toh(stat->rxdw4);
238 	rate = MS(rxdw3, R12A_RXDW3_RATE);
239 
240 	/* TODO: STBC */
241 	if (rxdw4 & R12A_RXDW4_LDPC)
242 		rxs->c_pktflags |= IEEE80211_RX_F_LDPC;
243 	if (rxdw1 & R12A_RXDW1_AMPDU) {
244 		if (rxdw0 & R92C_RXDW0_PHYST)
245 			rxs->c_pktflags |= IEEE80211_RX_F_AMPDU;
246 		else
247 			rxs->c_pktflags |= IEEE80211_RX_F_AMPDU_MORE;
248 	}
249 
250 	if ((rxdw4 & R12A_RXDW4_SPLCP) && rate >= RTWN_RIDX_HT_MCS(0))
251 		rxs->c_pktflags |= IEEE80211_RX_F_SHORTGI;
252 
253 	switch (MS(rxdw4, R12A_RXDW4_BW)) {
254 	case R12A_RXDW4_BW20:
255 		rxs->c_width = IEEE80211_RX_FW_20MHZ;
256 		break;
257 	case R12A_RXDW4_BW40:
258 		rxs->c_width = IEEE80211_RX_FW_40MHZ;
259 		break;
260 	case R12A_RXDW4_BW80:
261 		rxs->c_width = IEEE80211_RX_FW_80MHZ;
262 		break;
263 	default:
264 		break;
265 	}
266 
267 	if (RTWN_RATE_IS_CCK(rate))
268 		rxs->c_phytype = IEEE80211_RX_FP_11B;
269 	else {
270 		int is5ghz;
271 
272 		/* XXX magic */
273 		/* XXX check with RTL8812AU */
274 		is5ghz = (physt->cfosho[2] != 0x01);
275 
276 		if (rate < RTWN_RIDX_HT_MCS(0)) {
277 			if (is5ghz)
278 				rxs->c_phytype = IEEE80211_RX_FP_11A;
279 			else
280 				rxs->c_phytype = IEEE80211_RX_FP_11G;
281 		} else {
282 			if (is5ghz)
283 				rxs->c_phytype = IEEE80211_RX_FP_11NA;
284 			else
285 				rxs->c_phytype = IEEE80211_RX_FP_11NG;
286 		}
287 	}
288 
289 	/* Map HW rate index to 802.11 rate. */
290 	if (rate < RTWN_RIDX_HT_MCS(0)) {
291 		rxs->c_rate = ridx2rate[rate];
292 		if (RTWN_RATE_IS_CCK(rate))
293 			rxs->c_pktflags |= IEEE80211_RX_F_CCK;
294 		else
295 			rxs->c_pktflags |= IEEE80211_RX_F_OFDM;
296 	} else {	/* MCS0~15. */
297 		/* TODO: VHT rates */
298 		rxs->c_rate =
299 		    IEEE80211_RATE_MCS | (rate - RTWN_RIDX_HT_MCS_SHIFT);
300 		rxs->c_pktflags |= IEEE80211_RX_F_HT;
301 	}
302 
303 	/*
304 	 * XXX always zero for RTL8821AU
305 	 * (vendor driver does not check this field)
306 	 */
307 #if 0
308 	rxs->r_flags |= IEEE80211_R_IEEE | IEEE80211_R_FREQ;
309 	rxs->r_flags |= IEEE80211_R_BAND;
310 	rxs->c_ieee = MS(le16toh(physt->phyw1), R12A_PHYW1_CHAN);
311 	rxs->c_freq = ieee80211_ieee2mhz(rxs->c_ieee,
312 	    (rxs->c_ieee < 36) ? IEEE80211_CHAN_2GHZ : IEEE80211_CHAN_5GHZ);
313 	rxs->c_band = (rxs->c_ieee < 36) ? IEEE80211_CHAN_2GHZ : IEEE80211_CHAN_5GHZ;
314 #endif
315 }
316