xref: /freebsd/sys/dev/iwm/if_iwm_sta.c (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1 /*-
2  * Based on BSD-licensed source modules in the Linux iwlwifi driver,
3  * which were used as the reference documentation for this implementation.
4  *
5  * Driver version we are currently based off of is
6  * Linux 4.7.3 (tag id d7f6728f57e3ecbb7ef34eb7d9f564d514775d75)
7  *
8  ***********************************************************************
9  *
10  * This file is provided under a dual BSD/GPLv2 license.  When using or
11  * redistributing this file, you may do so under either license.
12  *
13  * GPL LICENSE SUMMARY
14  *
15  * Copyright(c) 2012 - 2015 Intel Corporation. All rights reserved.
16  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
17  * Copyright(c) 2016 Intel Deutschland GmbH
18  *
19  * This program is free software; you can redistribute it and/or modify
20  * it under the terms of version 2 of the GNU General Public License as
21  * published by the Free Software Foundation.
22  *
23  * This program is distributed in the hope that it will be useful, but
24  * WITHOUT ANY WARRANTY; without even the implied warranty of
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
26  * General Public License for more details.
27  *
28  * You should have received a copy of the GNU General Public License
29  * along with this program; if not, write to the Free Software
30  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
31  * USA
32  *
33  * The full GNU General Public License is included in this distribution
34  * in the file called COPYING.
35  *
36  * Contact Information:
37  *  Intel Linux Wireless <linuxwifi@intel.com>
38  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
39  *
40  * BSD LICENSE
41  *
42  * Copyright(c) 2012 - 2015 Intel Corporation. All rights reserved.
43  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
44  * Copyright(c) 2016 Intel Deutschland GmbH
45  * All rights reserved.
46  *
47  * Redistribution and use in source and binary forms, with or without
48  * modification, are permitted provided that the following conditions
49  * are met:
50  *
51  *  * Redistributions of source code must retain the above copyright
52  *    notice, this list of conditions and the following disclaimer.
53  *  * Redistributions in binary form must reproduce the above copyright
54  *    notice, this list of conditions and the following disclaimer in
55  *    the documentation and/or other materials provided with the
56  *    distribution.
57  *  * Neither the name Intel Corporation nor the names of its
58  *    contributors may be used to endorse or promote products derived
59  *    from this software without specific prior written permission.
60  *
61  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
62  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
63  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
64  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
65  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
66  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
67  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
68  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
69  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
70  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
71  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
72  *
73  *****************************************************************************/
74 
75 #include <sys/cdefs.h>
76 #include "opt_wlan.h"
77 #include "opt_iwm.h"
78 
79 #include <sys/param.h>
80 #include <sys/bus.h>
81 #include <sys/conf.h>
82 #include <sys/endian.h>
83 #include <sys/firmware.h>
84 #include <sys/kernel.h>
85 #include <sys/malloc.h>
86 #include <sys/mbuf.h>
87 #include <sys/mutex.h>
88 #include <sys/module.h>
89 #include <sys/proc.h>
90 #include <sys/rman.h>
91 #include <sys/socket.h>
92 #include <sys/sockio.h>
93 #include <sys/sysctl.h>
94 #include <sys/linker.h>
95 
96 #include <machine/bus.h>
97 #include <machine/endian.h>
98 #include <machine/resource.h>
99 
100 #include <dev/pci/pcivar.h>
101 #include <dev/pci/pcireg.h>
102 
103 #include <net/bpf.h>
104 
105 #include <net/if.h>
106 #include <net/if_var.h>
107 #include <net/if_arp.h>
108 #include <net/if_dl.h>
109 #include <net/if_media.h>
110 #include <net/if_types.h>
111 
112 #include <netinet/in.h>
113 #include <netinet/in_systm.h>
114 #include <netinet/if_ether.h>
115 #include <netinet/ip.h>
116 
117 #include <net80211/ieee80211_var.h>
118 #include <net80211/ieee80211_regdomain.h>
119 #include <net80211/ieee80211_ratectl.h>
120 #include <net80211/ieee80211_radiotap.h>
121 
122 #include <dev/iwm/if_iwmreg.h>
123 #include <dev/iwm/if_iwmvar.h>
124 #include <dev/iwm/if_iwm_config.h>
125 #include <dev/iwm/if_iwm_debug.h>
126 #include <dev/iwm/if_iwm_constants.h>
127 #include <dev/iwm/if_iwm_util.h>
128 #include <dev/iwm/if_iwm_mac_ctxt.h>
129 #include <dev/iwm/if_iwm_sta.h>
130 
131 /*
132  * New version of ADD_STA_sta command added new fields at the end of the
133  * structure, so sending the size of the relevant API's structure is enough to
134  * support both API versions.
135  */
136 static inline int
137 iwm_add_sta_cmd_size(struct iwm_softc *sc)
138 {
139 	return sc->cfg->mqrx_supported ? sizeof(struct iwm_add_sta_cmd) :
140 	    sizeof(struct iwm_add_sta_cmd_v7);
141 }
142 
143 /* send station add/update command to firmware */
144 int
145 iwm_sta_send_to_fw(struct iwm_softc *sc, struct iwm_node *in,
146 	boolean_t update)
147 {
148 	struct iwm_vap *ivp = IWM_VAP(in->in_ni.ni_vap);
149 	struct iwm_add_sta_cmd add_sta_cmd = {
150 		.sta_id = IWM_STATION_ID,
151 		.mac_id_n_color =
152 		    htole32(IWM_FW_CMD_ID_AND_COLOR(ivp->id, ivp->color)),
153 		.add_modify = update ? 1 : 0,
154 		.station_flags_msk = htole32(IWM_STA_FLG_FAT_EN_MSK |
155 					     IWM_STA_FLG_MIMO_EN_MSK),
156 		.tid_disable_tx = htole16(0xffff),
157 	};
158 	int ret;
159 	uint32_t status;
160 	uint32_t agg_size = 0, mpdu_dens = 0;
161 
162 	if (!update) {
163 		int ac;
164 		for (ac = 0; ac < WME_NUM_AC; ac++) {
165 			add_sta_cmd.tfd_queue_msk |=
166 			    htole32(1 << iwm_ac_to_tx_fifo[ac]);
167 		}
168 		IEEE80211_ADDR_COPY(&add_sta_cmd.addr, in->in_ni.ni_bssid);
169 	}
170 
171 	add_sta_cmd.station_flags |=
172 		htole32(agg_size << IWM_STA_FLG_MAX_AGG_SIZE_SHIFT);
173 	add_sta_cmd.station_flags |=
174 		htole32(mpdu_dens << IWM_STA_FLG_AGG_MPDU_DENS_SHIFT);
175 
176 	status = IWM_ADD_STA_SUCCESS;
177 	ret = iwm_send_cmd_pdu_status(sc, IWM_ADD_STA,
178 					  iwm_add_sta_cmd_size(sc),
179 					  &add_sta_cmd, &status);
180 	if (ret)
181 		return ret;
182 
183 	switch (status & IWM_ADD_STA_STATUS_MASK) {
184 	case IWM_ADD_STA_SUCCESS:
185 		IWM_DPRINTF(sc, IWM_DEBUG_NODE, "IWM_ADD_STA PASSED\n");
186 		break;
187 	default:
188 		ret = EIO;
189 		device_printf(sc->sc_dev, "IWM_ADD_STA failed\n");
190 		break;
191 	}
192 
193 	return ret;
194 }
195 
196 int
197 iwm_add_sta(struct iwm_softc *sc, struct iwm_node *in)
198 {
199 	return iwm_sta_send_to_fw(sc, in, FALSE);
200 }
201 
202 int
203 iwm_update_sta(struct iwm_softc *sc, struct iwm_node *in)
204 {
205 	return iwm_sta_send_to_fw(sc, in, TRUE);
206 }
207 
208 int
209 iwm_drain_sta(struct iwm_softc *sc, struct iwm_vap *ivp, boolean_t drain)
210 {
211 	struct iwm_add_sta_cmd cmd = {};
212 	int ret;
213 	uint32_t status;
214 
215 	cmd.mac_id_n_color =
216 	    htole32(IWM_FW_CMD_ID_AND_COLOR(ivp->id, ivp->color));
217 	cmd.sta_id = IWM_STATION_ID;
218 	cmd.add_modify = IWM_STA_MODE_MODIFY;
219 	cmd.station_flags = drain ? htole32(IWM_STA_FLG_DRAIN_FLOW) : 0;
220 	cmd.station_flags_msk = htole32(IWM_STA_FLG_DRAIN_FLOW);
221 
222 	status = IWM_ADD_STA_SUCCESS;
223 	ret = iwm_send_cmd_pdu_status(sc, IWM_ADD_STA,
224 					  iwm_add_sta_cmd_size(sc),
225 					  &cmd, &status);
226 	if (ret)
227 		return ret;
228 
229 	switch (status & IWM_ADD_STA_STATUS_MASK) {
230 	case IWM_ADD_STA_SUCCESS:
231 		IWM_DPRINTF(sc, IWM_DEBUG_NODE,
232 		    "Frames for staid %d will drained in fw\n", IWM_STATION_ID);
233 		break;
234 	default:
235 		ret = EIO;
236 		device_printf(sc->sc_dev,
237 		    "Couldn't drain frames for staid %d\n", IWM_STATION_ID);
238 		break;
239 	}
240 
241 	return ret;
242 }
243 
244 /*
245  * Remove a station from the FW table. Before sending the command to remove
246  * the station validate that the station is indeed known to the driver (sanity
247  * only).
248  */
249 static int
250 iwm_rm_sta_common(struct iwm_softc *sc)
251 {
252 	struct iwm_rm_sta_cmd rm_sta_cmd = {
253 		.sta_id = IWM_STATION_ID,
254 	};
255 	int ret;
256 
257 	ret = iwm_send_cmd_pdu(sc, IWM_REMOVE_STA, 0,
258 				   sizeof(rm_sta_cmd), &rm_sta_cmd);
259 	if (ret) {
260 		device_printf(sc->sc_dev,
261 		    "Failed to remove station. Id=%d\n", IWM_STATION_ID);
262 		return ret;
263 	}
264 
265 	return 0;
266 }
267 
268 int
269 iwm_rm_sta(struct iwm_softc *sc, struct ieee80211vap *vap,
270 	boolean_t is_assoc)
271 {
272 	uint32_t tfd_queue_msk = 0;
273 	int ret;
274 	int ac;
275 
276 	ret = iwm_drain_sta(sc, IWM_VAP(vap), TRUE);
277 	if (ret)
278 		return ret;
279 	for (ac = 0; ac < WME_NUM_AC; ac++) {
280 		tfd_queue_msk |= htole32(1 << iwm_ac_to_tx_fifo[ac]);
281 	}
282 	ret = iwm_flush_tx_path(sc, tfd_queue_msk, IWM_CMD_SYNC);
283 	if (ret)
284 		return ret;
285 #ifdef notyet /* function not yet implemented */
286 	ret = iwl_trans_wait_tx_queue_empty(mvm->trans,
287 					    mvm_sta->tfd_queue_msk);
288 	if (ret)
289 		return ret;
290 #endif
291 	ret = iwm_drain_sta(sc, IWM_VAP(vap), FALSE);
292 
293 	/* if we are associated - we can't remove the AP STA now */
294 	if (is_assoc)
295 		return ret;
296 
297 	/* XXX wait until STA is drained */
298 
299 	ret = iwm_rm_sta_common(sc);
300 
301 	return ret;
302 }
303 
304 int
305 iwm_rm_sta_id(struct iwm_softc *sc, struct ieee80211vap *vap)
306 {
307 	/* XXX wait until STA is drained */
308 
309 	return iwm_rm_sta_common(sc);
310 }
311 
312 static int
313 iwm_add_int_sta_common(struct iwm_softc *sc, struct iwm_int_sta *sta,
314     const uint8_t *addr, uint16_t mac_id, uint16_t color)
315 {
316 	struct iwm_add_sta_cmd cmd;
317 	int ret;
318 	uint32_t status;
319 
320 	memset(&cmd, 0, sizeof(cmd));
321 	cmd.sta_id = sta->sta_id;
322 	cmd.mac_id_n_color = htole32(IWM_FW_CMD_ID_AND_COLOR(mac_id, color));
323 	if (sta->sta_id == IWM_AUX_STA_ID && sc->cfg->mqrx_supported)
324 		cmd.station_type = IWM_STA_AUX_ACTIVITY;
325 
326 	cmd.tfd_queue_msk = htole32(sta->tfd_queue_msk);
327 	cmd.tid_disable_tx = htole16(0xffff);
328 
329 	if (addr)
330 		IEEE80211_ADDR_COPY(cmd.addr, addr);
331 
332 	ret = iwm_send_cmd_pdu_status(sc, IWM_ADD_STA,
333 					  iwm_add_sta_cmd_size(sc),
334 					  &cmd, &status);
335 	if (ret)
336 		return ret;
337 
338 	switch (status & IWM_ADD_STA_STATUS_MASK) {
339 	case IWM_ADD_STA_SUCCESS:
340 		IWM_DPRINTF(sc, IWM_DEBUG_NODE, "Internal station added.\n");
341 		return 0;
342 	default:
343 		ret = EIO;
344 		device_printf(sc->sc_dev,
345 		    "Add internal station failed, status=0x%x\n", status);
346 		break;
347 	}
348 	return ret;
349 }
350 
351 int
352 iwm_add_aux_sta(struct iwm_softc *sc)
353 {
354 	int ret;
355 
356 	sc->sc_aux_sta.sta_id = IWM_AUX_STA_ID;
357 	sc->sc_aux_sta.tfd_queue_msk = (1 << IWM_AUX_QUEUE);
358 
359 	/* Map Aux queue to fifo - needs to happen before adding Aux station */
360 	ret = iwm_enable_txq(sc, IWM_AUX_STA_ID, IWM_AUX_QUEUE,
361 	    IWM_TX_FIFO_MCAST);
362 	if (ret)
363 		return ret;
364 
365 	ret = iwm_add_int_sta_common(sc, &sc->sc_aux_sta, NULL,
366 					 IWM_MAC_INDEX_AUX, 0);
367 
368 	if (ret) {
369 		memset(&sc->sc_aux_sta, 0, sizeof(sc->sc_aux_sta));
370 		sc->sc_aux_sta.sta_id = IWM_STATION_COUNT;
371 	}
372 	return ret;
373 }
374 
375 void iwm_del_aux_sta(struct iwm_softc *sc)
376 {
377 	memset(&sc->sc_aux_sta, 0, sizeof(sc->sc_aux_sta));
378 	sc->sc_aux_sta.sta_id = IWM_STATION_COUNT;
379 }
380