xref: /freebsd/sys/dev/iwm/if_iwm_scan.c (revision 19d2e3de755b7c9ca2f5c90b5902fc8f214b2490)
1 /*	$OpenBSD: if_iwm.c,v 1.39 2015/03/23 00:35:19 jsg Exp $	*/
2 
3 /*
4  * Copyright (c) 2014 genua mbh <info@genua.de>
5  * Copyright (c) 2014 Fixup Software Ltd.
6  *
7  * Permission to use, copy, modify, and distribute this software for any
8  * purpose with or without fee is hereby granted, provided that the above
9  * copyright notice and this permission notice appear in all copies.
10  *
11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 /*-
21  * Based on BSD-licensed source modules in the Linux iwlwifi driver,
22  * which were used as the reference documentation for this implementation.
23  *
24  * Driver version we are currently based off of is
25  * Linux 3.14.3 (tag id a2df521e42b1d9a23f620ac79dbfe8655a8391dd)
26  *
27  ***********************************************************************
28  *
29  * This file is provided under a dual BSD/GPLv2 license.  When using or
30  * redistributing this file, you may do so under either license.
31  *
32  * GPL LICENSE SUMMARY
33  *
34  * Copyright(c) 2007 - 2013 Intel Corporation. All rights reserved.
35  *
36  * This program is free software; you can redistribute it and/or modify
37  * it under the terms of version 2 of the GNU General Public License as
38  * published by the Free Software Foundation.
39  *
40  * This program is distributed in the hope that it will be useful, but
41  * WITHOUT ANY WARRANTY; without even the implied warranty of
42  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
43  * General Public License for more details.
44  *
45  * You should have received a copy of the GNU General Public License
46  * along with this program; if not, write to the Free Software
47  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
48  * USA
49  *
50  * The full GNU General Public License is included in this distribution
51  * in the file called COPYING.
52  *
53  * Contact Information:
54  *  Intel Linux Wireless <ilw@linux.intel.com>
55  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
56  *
57  *
58  * BSD LICENSE
59  *
60  * Copyright(c) 2005 - 2013 Intel Corporation. All rights reserved.
61  * All rights reserved.
62  *
63  * Redistribution and use in source and binary forms, with or without
64  * modification, are permitted provided that the following conditions
65  * are met:
66  *
67  *  * Redistributions of source code must retain the above copyright
68  *    notice, this list of conditions and the following disclaimer.
69  *  * Redistributions in binary form must reproduce the above copyright
70  *    notice, this list of conditions and the following disclaimer in
71  *    the documentation and/or other materials provided with the
72  *    distribution.
73  *  * Neither the name Intel Corporation nor the names of its
74  *    contributors may be used to endorse or promote products derived
75  *    from this software without specific prior written permission.
76  *
77  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
78  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
79  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
80  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
81  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
82  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
83  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
84  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
85  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
86  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
87  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
88  */
89 
90 /*-
91  * Copyright (c) 2007-2010 Damien Bergamini <damien.bergamini@free.fr>
92  *
93  * Permission to use, copy, modify, and distribute this software for any
94  * purpose with or without fee is hereby granted, provided that the above
95  * copyright notice and this permission notice appear in all copies.
96  *
97  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
98  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
99  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
100  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
101  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
102  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
103  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
104  */
105 #include <sys/cdefs.h>
106 __FBSDID("$FreeBSD$");
107 
108 #include "opt_wlan.h"
109 
110 #include <sys/param.h>
111 #include <sys/bus.h>
112 #include <sys/conf.h>
113 #include <sys/endian.h>
114 #include <sys/firmware.h>
115 #include <sys/kernel.h>
116 #include <sys/malloc.h>
117 #include <sys/mbuf.h>
118 #include <sys/mutex.h>
119 #include <sys/module.h>
120 #include <sys/proc.h>
121 #include <sys/rman.h>
122 #include <sys/socket.h>
123 #include <sys/sockio.h>
124 #include <sys/sysctl.h>
125 #include <sys/linker.h>
126 
127 #include <machine/bus.h>
128 #include <machine/endian.h>
129 #include <machine/resource.h>
130 
131 #include <dev/pci/pcivar.h>
132 #include <dev/pci/pcireg.h>
133 
134 #include <net/bpf.h>
135 
136 #include <net/if.h>
137 #include <net/if_var.h>
138 #include <net/if_arp.h>
139 #include <net/if_dl.h>
140 #include <net/if_media.h>
141 #include <net/if_types.h>
142 
143 #include <netinet/in.h>
144 #include <netinet/in_systm.h>
145 #include <netinet/if_ether.h>
146 #include <netinet/ip.h>
147 
148 #include <net80211/ieee80211_var.h>
149 #include <net80211/ieee80211_regdomain.h>
150 #include <net80211/ieee80211_ratectl.h>
151 #include <net80211/ieee80211_radiotap.h>
152 
153 #include <dev/iwm/if_iwmreg.h>
154 #include <dev/iwm/if_iwmvar.h>
155 #include <dev/iwm/if_iwm_debug.h>
156 #include <dev/iwm/if_iwm_notif_wait.h>
157 #include <dev/iwm/if_iwm_util.h>
158 #include <dev/iwm/if_iwm_scan.h>
159 
160 /*
161  * BEGIN mvm/scan.c
162  */
163 
164 #define IWM_DENSE_EBS_SCAN_RATIO 5
165 #define IWM_SPARSE_EBS_SCAN_RATIO 1
166 
167 static uint16_t
168 iwm_mvm_scan_rx_chain(struct iwm_softc *sc)
169 {
170 	uint16_t rx_chain;
171 	uint8_t rx_ant;
172 
173 	rx_ant = iwm_mvm_get_valid_rx_ant(sc);
174 	rx_chain = rx_ant << IWM_PHY_RX_CHAIN_VALID_POS;
175 	rx_chain |= rx_ant << IWM_PHY_RX_CHAIN_FORCE_MIMO_SEL_POS;
176 	rx_chain |= rx_ant << IWM_PHY_RX_CHAIN_FORCE_SEL_POS;
177 	rx_chain |= 0x1 << IWM_PHY_RX_CHAIN_DRIVER_FORCE_POS;
178 	return htole16(rx_chain);
179 }
180 
181 static uint32_t
182 iwm_mvm_scan_rate_n_flags(struct iwm_softc *sc, int flags, int no_cck)
183 {
184 	uint32_t tx_ant;
185 	int i, ind;
186 
187 	for (i = 0, ind = sc->sc_scan_last_antenna;
188 	    i < IWM_RATE_MCS_ANT_NUM; i++) {
189 		ind = (ind + 1) % IWM_RATE_MCS_ANT_NUM;
190 		if (iwm_mvm_get_valid_tx_ant(sc) & (1 << ind)) {
191 			sc->sc_scan_last_antenna = ind;
192 			break;
193 		}
194 	}
195 	tx_ant = (1 << sc->sc_scan_last_antenna) << IWM_RATE_MCS_ANT_POS;
196 
197 	if ((flags & IEEE80211_CHAN_2GHZ) && !no_cck)
198 		return htole32(IWM_RATE_1M_PLCP | IWM_RATE_MCS_CCK_MSK |
199 				   tx_ant);
200 	else
201 		return htole32(IWM_RATE_6M_PLCP | tx_ant);
202 }
203 
204 static const char *
205 iwm_mvm_ebs_status_str(enum iwm_scan_ebs_status status)
206 {
207 	switch (status) {
208 	case IWM_SCAN_EBS_SUCCESS:
209 		return "successful";
210 	case IWM_SCAN_EBS_INACTIVE:
211 		return "inactive";
212 	case IWM_SCAN_EBS_FAILED:
213 	case IWM_SCAN_EBS_CHAN_NOT_FOUND:
214 	default:
215 		return "failed";
216 	}
217 }
218 
219 void
220 iwm_mvm_rx_lmac_scan_complete_notif(struct iwm_softc *sc,
221     struct iwm_rx_packet *pkt)
222 {
223 	struct iwm_periodic_scan_complete *scan_notif = (void *)pkt->data;
224 	boolean_t aborted = (scan_notif->status == IWM_SCAN_OFFLOAD_ABORTED);
225 
226 	/* If this happens, the firmware has mistakenly sent an LMAC
227 	 * notification during UMAC scans -- warn and ignore it.
228 	 */
229 	if (fw_has_capa(&sc->ucode_capa, IWM_UCODE_TLV_CAPA_UMAC_SCAN)) {
230 		device_printf(sc->sc_dev,
231 		    "%s: Mistakenly got LMAC notification during UMAC scan\n",
232 		    __func__);
233 		return;
234 	}
235 
236 	IWM_DPRINTF(sc, IWM_DEBUG_SCAN, "Regular scan %s, EBS status %s (FW)\n",
237 	    aborted ? "aborted" : "completed",
238 	    iwm_mvm_ebs_status_str(scan_notif->ebs_status));
239 
240 	sc->last_ebs_successful =
241 			scan_notif->ebs_status == IWM_SCAN_EBS_SUCCESS ||
242 			scan_notif->ebs_status == IWM_SCAN_EBS_INACTIVE;
243 
244 }
245 
246 void
247 iwm_mvm_rx_umac_scan_complete_notif(struct iwm_softc *sc,
248     struct iwm_rx_packet *pkt)
249 {
250 	struct iwm_umac_scan_complete *notif = (void *)pkt->data;
251 	uint32_t uid = le32toh(notif->uid);
252 	boolean_t aborted = (notif->status == IWM_SCAN_OFFLOAD_ABORTED);
253 
254 	IWM_DPRINTF(sc, IWM_DEBUG_SCAN,
255 	    "Scan completed, uid %u, status %s, EBS status %s\n",
256 	    uid,
257 	    aborted ? "aborted" : "completed",
258 	    iwm_mvm_ebs_status_str(notif->ebs_status));
259 
260 	if (notif->ebs_status != IWM_SCAN_EBS_SUCCESS &&
261 	    notif->ebs_status != IWM_SCAN_EBS_INACTIVE)
262 		sc->last_ebs_successful = FALSE;
263 }
264 
265 static int
266 iwm_mvm_scan_skip_channel(struct ieee80211_channel *c)
267 {
268 	if (IEEE80211_IS_CHAN_2GHZ(c) && IEEE80211_IS_CHAN_B(c))
269 		return 0;
270 	else if (IEEE80211_IS_CHAN_5GHZ(c) && IEEE80211_IS_CHAN_A(c))
271 		return 0;
272 	else
273 		return 1;
274 }
275 
276 static uint8_t
277 iwm_mvm_lmac_scan_fill_channels(struct iwm_softc *sc,
278     struct iwm_scan_channel_cfg_lmac *chan, int n_ssids)
279 {
280 	struct ieee80211com *ic = &sc->sc_ic;
281 	struct ieee80211_scan_state *ss = ic->ic_scan;
282 	struct ieee80211_channel *c;
283 	uint8_t nchan;
284 	int j;
285 
286 	for (nchan = j = 0;
287 	    j < ic->ic_nchans && nchan < sc->ucode_capa.n_scan_channels; j++) {
288 		c = &ic->ic_channels[j];
289 		/* For 2GHz, only populate 11b channels */
290 		/* For 5GHz, only populate 11a channels */
291 		/*
292 		 * Catch other channels, in case we have 900MHz channels or
293 		 * something in the chanlist.
294 		 */
295 		if (iwm_mvm_scan_skip_channel(c)) {
296 			IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_EEPROM,
297 			    "%s: skipping channel (freq=%d, ieee=%d, flags=0x%08x)\n",
298 			    __func__, c->ic_freq, c->ic_ieee, c->ic_flags);
299 			continue;
300 		}
301 
302 		IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_EEPROM,
303 		    "Adding channel %d (%d Mhz) to the list\n",
304 		    nchan, c->ic_freq);
305 		chan->channel_num = htole16(ieee80211_mhz2ieee(c->ic_freq, 0));
306 		chan->iter_count = htole16(1);
307 		chan->iter_interval = htole32(0);
308 		chan->flags = htole32(IWM_UNIFIED_SCAN_CHANNEL_PARTIAL);
309 		chan->flags |= htole32(IWM_SCAN_CHANNEL_NSSIDS(n_ssids));
310 		/* XXX IEEE80211_SCAN_NOBCAST flag is never set. */
311 		if (!IEEE80211_IS_CHAN_PASSIVE(c) &&
312 		    (!(ss->ss_flags & IEEE80211_SCAN_NOBCAST) || n_ssids != 0))
313 			chan->flags |= htole32(IWM_SCAN_CHANNEL_TYPE_ACTIVE);
314 		chan++;
315 		nchan++;
316 	}
317 
318 	return nchan;
319 }
320 
321 static uint8_t
322 iwm_mvm_umac_scan_fill_channels(struct iwm_softc *sc,
323     struct iwm_scan_channel_cfg_umac *chan, int n_ssids)
324 {
325 	struct ieee80211com *ic = &sc->sc_ic;
326 	struct ieee80211_channel *c;
327 	uint8_t nchan;
328 	int j;
329 
330 	for (nchan = j = 0;
331 	    j < ic->ic_nchans && nchan < sc->ucode_capa.n_scan_channels; j++) {
332 		c = &ic->ic_channels[j];
333 		/* For 2GHz, only populate 11b channels */
334 		/* For 5GHz, only populate 11a channels */
335 		/*
336 		 * Catch other channels, in case we have 900MHz channels or
337 		 * something in the chanlist.
338 		 */
339 		if (iwm_mvm_scan_skip_channel(c)) {
340 			IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_EEPROM,
341 			    "%s: skipping channel (freq=%d, ieee=%d, flags=0x%08x)\n",
342 			    __func__, c->ic_freq, c->ic_ieee, c->ic_flags);
343 			continue;
344 		}
345 
346 		IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_EEPROM,
347 		    "Adding channel %d (%d Mhz) to the list\n",
348 		    nchan, c->ic_freq);
349 		chan->channel_num = ieee80211_mhz2ieee(c->ic_freq, 0);
350 		chan->iter_count = 1;
351 		chan->iter_interval = htole16(0);
352 		chan->flags = htole32(IWM_SCAN_CHANNEL_UMAC_NSSIDS(n_ssids));
353 		chan++;
354 		nchan++;
355 	}
356 
357 	return nchan;
358 }
359 
360 static int
361 iwm_mvm_fill_probe_req(struct iwm_softc *sc, struct iwm_scan_probe_req *preq)
362 {
363 	struct ieee80211com *ic = &sc->sc_ic;
364 	struct ieee80211vap *vap = TAILQ_FIRST(&ic->ic_vaps);
365 	struct ieee80211_frame *wh = (struct ieee80211_frame *)preq->buf;
366 	struct ieee80211_rateset *rs;
367 	size_t remain = sizeof(preq->buf);
368 	uint8_t *frm, *pos;
369 
370 	memset(preq, 0, sizeof(*preq));
371 
372 	/* Ensure enough space for header and SSID IE. */
373 	if (remain < sizeof(*wh) + 2)
374 		return ENOBUFS;
375 
376 	/*
377 	 * Build a probe request frame.  Most of the following code is a
378 	 * copy & paste of what is done in net80211.
379 	 */
380 	wh->i_fc[0] = IEEE80211_FC0_VERSION_0 | IEEE80211_FC0_TYPE_MGT |
381 	    IEEE80211_FC0_SUBTYPE_PROBE_REQ;
382 	wh->i_fc[1] = IEEE80211_FC1_DIR_NODS;
383 	IEEE80211_ADDR_COPY(wh->i_addr1, ieee80211broadcastaddr);
384 	IEEE80211_ADDR_COPY(wh->i_addr2, vap ? vap->iv_myaddr : ic->ic_macaddr);
385 	IEEE80211_ADDR_COPY(wh->i_addr3, ieee80211broadcastaddr);
386 	*(uint16_t *)&wh->i_dur[0] = 0; /* filled by HW */
387 	*(uint16_t *)&wh->i_seq[0] = 0; /* filled by HW */
388 
389 	frm = (uint8_t *)(wh + 1);
390 	frm = ieee80211_add_ssid(frm, NULL, 0);
391 
392 	/* Tell the firmware where the MAC header is. */
393 	preq->mac_header.offset = 0;
394 	preq->mac_header.len = htole16(frm - (uint8_t *)wh);
395 	remain -= frm - (uint8_t *)wh;
396 
397 	/* Fill in 2GHz IEs and tell firmware where they are. */
398 	rs = &ic->ic_sup_rates[IEEE80211_MODE_11G];
399 	if (rs->rs_nrates > IEEE80211_RATE_SIZE) {
400 		if (remain < 4 + rs->rs_nrates)
401 			return ENOBUFS;
402 	} else if (remain < 2 + rs->rs_nrates) {
403 		return ENOBUFS;
404 	}
405 	preq->band_data[0].offset = htole16(frm - (uint8_t *)wh);
406 	pos = frm;
407 	frm = ieee80211_add_rates(frm, rs);
408 	if (rs->rs_nrates > IEEE80211_RATE_SIZE)
409 		frm = ieee80211_add_xrates(frm, rs);
410 	preq->band_data[0].len = htole16(frm - pos);
411 	remain -= frm - pos;
412 
413 	if (fw_has_capa(&sc->ucode_capa,
414 	    IWM_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT)) {
415 		if (remain < 3)
416 			return ENOBUFS;
417 		*frm++ = IEEE80211_ELEMID_DSPARMS;
418 		*frm++ = 1;
419 		*frm++ = 0;
420 		remain -= 3;
421 	}
422 
423 	if (sc->nvm_data->sku_cap_band_52GHz_enable) {
424 		/* Fill in 5GHz IEs. */
425 		rs = &ic->ic_sup_rates[IEEE80211_MODE_11A];
426 		if (rs->rs_nrates > IEEE80211_RATE_SIZE) {
427 			if (remain < 4 + rs->rs_nrates)
428 				return ENOBUFS;
429 		} else if (remain < 2 + rs->rs_nrates) {
430 			return ENOBUFS;
431 		}
432 		preq->band_data[1].offset = htole16(frm - (uint8_t *)wh);
433 		pos = frm;
434 		frm = ieee80211_add_rates(frm, rs);
435 		if (rs->rs_nrates > IEEE80211_RATE_SIZE)
436 			frm = ieee80211_add_xrates(frm, rs);
437 		preq->band_data[1].len = htole16(frm - pos);
438 		remain -= frm - pos;
439 	}
440 
441 	/* Send 11n IEs on both 2GHz and 5GHz bands. */
442 	preq->common_data.offset = htole16(frm - (uint8_t *)wh);
443 	pos = frm;
444 #if 0
445 	if (ic->ic_flags & IEEE80211_F_HTON) {
446 		if (remain < 28)
447 			return ENOBUFS;
448 		frm = ieee80211_add_htcaps(frm, ic);
449 		/* XXX add WME info? */
450 	}
451 #endif
452 	preq->common_data.len = htole16(frm - pos);
453 
454 	return 0;
455 }
456 
457 int
458 iwm_mvm_config_umac_scan(struct iwm_softc *sc)
459 {
460 	struct ieee80211com *ic = &sc->sc_ic;
461 	struct ieee80211vap *vap = TAILQ_FIRST(&ic->ic_vaps);
462 
463 	struct iwm_scan_config *scan_config;
464 	int ret, j, nchan;
465 	size_t cmd_size;
466 	struct ieee80211_channel *c;
467 	struct iwm_host_cmd hcmd = {
468 		.id = iwm_cmd_id(IWM_SCAN_CFG_CMD, IWM_ALWAYS_LONG_GROUP, 0),
469 		.flags = IWM_CMD_SYNC,
470 	};
471 	static const uint32_t rates = (IWM_SCAN_CONFIG_RATE_1M |
472 	    IWM_SCAN_CONFIG_RATE_2M | IWM_SCAN_CONFIG_RATE_5M |
473 	    IWM_SCAN_CONFIG_RATE_11M | IWM_SCAN_CONFIG_RATE_6M |
474 	    IWM_SCAN_CONFIG_RATE_9M | IWM_SCAN_CONFIG_RATE_12M |
475 	    IWM_SCAN_CONFIG_RATE_18M | IWM_SCAN_CONFIG_RATE_24M |
476 	    IWM_SCAN_CONFIG_RATE_36M | IWM_SCAN_CONFIG_RATE_48M |
477 	    IWM_SCAN_CONFIG_RATE_54M);
478 
479 	cmd_size = sizeof(*scan_config) + sc->ucode_capa.n_scan_channels;
480 
481 	scan_config = malloc(cmd_size, M_DEVBUF, M_NOWAIT | M_ZERO);
482 	if (scan_config == NULL)
483 		return ENOMEM;
484 
485 	scan_config->tx_chains = htole32(iwm_mvm_get_valid_tx_ant(sc));
486 	scan_config->rx_chains = htole32(iwm_mvm_get_valid_rx_ant(sc));
487 	scan_config->legacy_rates = htole32(rates |
488 	    IWM_SCAN_CONFIG_SUPPORTED_RATE(rates));
489 
490 	/* These timings correspond to iwlwifi's UNASSOC scan. */
491 	scan_config->dwell_active = 10;
492 	scan_config->dwell_passive = 110;
493 	scan_config->dwell_fragmented = 44;
494 	scan_config->dwell_extended = 90;
495 	scan_config->out_of_channel_time = htole32(0);
496 	scan_config->suspend_time = htole32(0);
497 
498 	IEEE80211_ADDR_COPY(scan_config->mac_addr,
499 	    vap ? vap->iv_myaddr : ic->ic_macaddr);
500 
501 	scan_config->bcast_sta_id = sc->sc_aux_sta.sta_id;
502 	scan_config->channel_flags = IWM_CHANNEL_FLAG_EBS |
503 	    IWM_CHANNEL_FLAG_ACCURATE_EBS | IWM_CHANNEL_FLAG_EBS_ADD |
504 	    IWM_CHANNEL_FLAG_PRE_SCAN_PASSIVE2ACTIVE;
505 
506 	for (nchan = j = 0;
507 	    j < ic->ic_nchans && nchan < sc->ucode_capa.n_scan_channels; j++) {
508 		c = &ic->ic_channels[j];
509 		/* For 2GHz, only populate 11b channels */
510 		/* For 5GHz, only populate 11a channels */
511 		/*
512 		 * Catch other channels, in case we have 900MHz channels or
513 		 * something in the chanlist.
514 		 */
515 		if (iwm_mvm_scan_skip_channel(c))
516 			continue;
517 		scan_config->channel_array[nchan++] =
518 		    ieee80211_mhz2ieee(c->ic_freq, 0);
519 	}
520 
521 	scan_config->flags = htole32(IWM_SCAN_CONFIG_FLAG_ACTIVATE |
522 	    IWM_SCAN_CONFIG_FLAG_ALLOW_CHUB_REQS |
523 	    IWM_SCAN_CONFIG_FLAG_SET_TX_CHAINS |
524 	    IWM_SCAN_CONFIG_FLAG_SET_RX_CHAINS |
525 	    IWM_SCAN_CONFIG_FLAG_SET_AUX_STA_ID |
526 	    IWM_SCAN_CONFIG_FLAG_SET_ALL_TIMES |
527 	    IWM_SCAN_CONFIG_FLAG_SET_LEGACY_RATES |
528 	    IWM_SCAN_CONFIG_FLAG_SET_MAC_ADDR |
529 	    IWM_SCAN_CONFIG_FLAG_SET_CHANNEL_FLAGS|
530 	    IWM_SCAN_CONFIG_N_CHANNELS(nchan) |
531 	    IWM_SCAN_CONFIG_FLAG_CLEAR_FRAGMENTED);
532 
533 	hcmd.data[0] = scan_config;
534 	hcmd.len[0] = cmd_size;
535 
536 	IWM_DPRINTF(sc, IWM_DEBUG_SCAN, "Sending UMAC scan config\n");
537 
538 	ret = iwm_send_cmd(sc, &hcmd);
539 	if (!ret)
540 		IWM_DPRINTF(sc, IWM_DEBUG_SCAN,
541 		    "UMAC scan config was sent successfully\n");
542 
543 	free(scan_config, M_DEVBUF);
544 	return ret;
545 }
546 
547 static boolean_t
548 iwm_mvm_scan_use_ebs(struct iwm_softc *sc)
549 {
550 	const struct iwm_ucode_capabilities *capa = &sc->ucode_capa;
551 
552 	/* We can only use EBS if:
553 	 *	1. the feature is supported;
554 	 *	2. the last EBS was successful;
555 	 *	3. if only single scan, the single scan EBS API is supported;
556 	 *	4. it's not a p2p find operation.
557 	 */
558 	return ((capa->flags & IWM_UCODE_TLV_FLAGS_EBS_SUPPORT) &&
559 		sc->last_ebs_successful);
560 }
561 
562 int
563 iwm_mvm_umac_scan(struct iwm_softc *sc)
564 {
565 	struct iwm_host_cmd hcmd = {
566 		.id = iwm_cmd_id(IWM_SCAN_REQ_UMAC, IWM_ALWAYS_LONG_GROUP, 0),
567 		.len = { 0, },
568 		.data = { NULL, },
569 		.flags = IWM_CMD_SYNC,
570 	};
571 	struct ieee80211_scan_state *ss = sc->sc_ic.ic_scan;
572 	struct iwm_scan_req_umac *req;
573 	struct iwm_scan_req_umac_tail *tail;
574 	size_t req_len;
575 	uint8_t i, nssid;
576 	int ret;
577 
578 	req_len = sizeof(struct iwm_scan_req_umac) +
579 	    (sizeof(struct iwm_scan_channel_cfg_umac) *
580 	    sc->ucode_capa.n_scan_channels) +
581 	    sizeof(struct iwm_scan_req_umac_tail);
582 	if (req_len > IWM_MAX_CMD_PAYLOAD_SIZE)
583 		return ENOMEM;
584 	req = malloc(req_len, M_DEVBUF, M_NOWAIT | M_ZERO);
585 	if (req == NULL)
586 		return ENOMEM;
587 
588 	hcmd.len[0] = (uint16_t)req_len;
589 	hcmd.data[0] = (void *)req;
590 
591 	IWM_DPRINTF(sc, IWM_DEBUG_SCAN, "Handling ieee80211 scan request\n");
592 
593 	/* These timings correspond to iwlwifi's UNASSOC scan. */
594 	req->active_dwell = 10;
595 	req->passive_dwell = 110;
596 	req->fragmented_dwell = 44;
597 	req->extended_dwell = 90;
598 	req->max_out_time = 0;
599 	req->suspend_time = 0;
600 
601 	req->scan_priority = htole32(IWM_SCAN_PRIORITY_HIGH);
602 	req->ooc_priority = htole32(IWM_SCAN_PRIORITY_HIGH);
603 
604 	nssid = MIN(ss->ss_nssid, IWM_PROBE_OPTION_MAX);
605 	req->n_channels = iwm_mvm_umac_scan_fill_channels(sc,
606 	    (struct iwm_scan_channel_cfg_umac *)req->data, nssid);
607 
608 	req->general_flags = htole32(IWM_UMAC_SCAN_GEN_FLAGS_PASS_ALL |
609 	    IWM_UMAC_SCAN_GEN_FLAGS_ITER_COMPLETE |
610 	    IWM_UMAC_SCAN_GEN_FLAGS_EXTENDED_DWELL);
611 
612 	tail = (void *)((char *)&req->data +
613 		sizeof(struct iwm_scan_channel_cfg_umac) *
614 			sc->ucode_capa.n_scan_channels);
615 
616 	/* Check if we're doing an active directed scan. */
617 	for (i = 0; i < nssid; i++) {
618 		tail->direct_scan[i].id = IEEE80211_ELEMID_SSID;
619 		tail->direct_scan[i].len = MIN(ss->ss_ssid[i].len,
620 		    IEEE80211_NWID_LEN);
621 		memcpy(tail->direct_scan[i].ssid, ss->ss_ssid[i].ssid,
622 		    tail->direct_scan[i].len);
623 		/* XXX debug */
624 	}
625 	if (nssid != 0) {
626 		req->general_flags |=
627 		    htole32(IWM_UMAC_SCAN_GEN_FLAGS_PRE_CONNECT);
628 	} else
629 		req->general_flags |= htole32(IWM_UMAC_SCAN_GEN_FLAGS_PASSIVE);
630 
631 	if (iwm_mvm_scan_use_ebs(sc))
632 		req->channel_flags = IWM_SCAN_CHANNEL_FLAG_EBS |
633 				     IWM_SCAN_CHANNEL_FLAG_EBS_ACCURATE |
634 				     IWM_SCAN_CHANNEL_FLAG_CACHE_ADD;
635 
636 	if (fw_has_capa(&sc->ucode_capa,
637 	    IWM_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT))
638 		req->general_flags |=
639 		    htole32(IWM_UMAC_SCAN_GEN_FLAGS_RRM_ENABLED);
640 
641 	ret = iwm_mvm_fill_probe_req(sc, &tail->preq);
642 	if (ret) {
643 		free(req, M_DEVBUF);
644 		return ret;
645 	}
646 
647 	/* Specify the scan plan: We'll do one iteration. */
648 	tail->schedule[0].interval = 0;
649 	tail->schedule[0].iter_count = 1;
650 
651 	ret = iwm_send_cmd(sc, &hcmd);
652 	if (!ret)
653 		IWM_DPRINTF(sc, IWM_DEBUG_SCAN,
654 		    "Scan request was sent successfully\n");
655 	free(req, M_DEVBUF);
656 	return ret;
657 }
658 
659 int
660 iwm_mvm_lmac_scan(struct iwm_softc *sc)
661 {
662 	struct iwm_host_cmd hcmd = {
663 		.id = IWM_SCAN_OFFLOAD_REQUEST_CMD,
664 		.len = { 0, },
665 		.data = { NULL, },
666 		.flags = IWM_CMD_SYNC,
667 	};
668 	struct ieee80211_scan_state *ss = sc->sc_ic.ic_scan;
669 	struct iwm_scan_req_lmac *req;
670 	size_t req_len;
671 	uint8_t i, nssid;
672 	int ret;
673 
674 	IWM_DPRINTF(sc, IWM_DEBUG_SCAN,
675 	    "Handling ieee80211 scan request\n");
676 
677 	req_len = sizeof(struct iwm_scan_req_lmac) +
678 	    (sizeof(struct iwm_scan_channel_cfg_lmac) *
679 	    sc->ucode_capa.n_scan_channels) + sizeof(struct iwm_scan_probe_req);
680 	if (req_len > IWM_MAX_CMD_PAYLOAD_SIZE)
681 		return ENOMEM;
682 	req = malloc(req_len, M_DEVBUF, M_NOWAIT | M_ZERO);
683 	if (req == NULL)
684 		return ENOMEM;
685 
686 	hcmd.len[0] = (uint16_t)req_len;
687 	hcmd.data[0] = (void *)req;
688 
689 	/* These timings correspond to iwlwifi's UNASSOC scan. */
690 	req->active_dwell = 10;
691 	req->passive_dwell = 110;
692 	req->fragmented_dwell = 44;
693 	req->extended_dwell = 90;
694 	req->max_out_time = 0;
695 	req->suspend_time = 0;
696 
697 	req->scan_prio = htole32(IWM_SCAN_PRIORITY_HIGH);
698 	req->rx_chain_select = iwm_mvm_scan_rx_chain(sc);
699 	req->iter_num = htole32(1);
700 	req->delay = 0;
701 
702 	req->scan_flags = htole32(IWM_MVM_LMAC_SCAN_FLAG_PASS_ALL |
703 	    IWM_MVM_LMAC_SCAN_FLAG_ITER_COMPLETE |
704 	    IWM_MVM_LMAC_SCAN_FLAG_EXTENDED_DWELL);
705 	if (fw_has_capa(&sc->ucode_capa,
706 	    IWM_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT))
707 		req->scan_flags |= htole32(IWM_MVM_LMAC_SCAN_FLAGS_RRM_ENABLED);
708 
709 	req->flags = htole32(IWM_PHY_BAND_24);
710 	if (sc->nvm_data->sku_cap_band_52GHz_enable)
711 		req->flags |= htole32(IWM_PHY_BAND_5);
712 	req->filter_flags =
713 	    htole32(IWM_MAC_FILTER_ACCEPT_GRP | IWM_MAC_FILTER_IN_BEACON);
714 
715 	/* Tx flags 2 GHz. */
716 	req->tx_cmd[0].tx_flags = htole32(IWM_TX_CMD_FLG_SEQ_CTL |
717 	    IWM_TX_CMD_FLG_BT_DIS);
718 	req->tx_cmd[0].rate_n_flags =
719 	    iwm_mvm_scan_rate_n_flags(sc, IEEE80211_CHAN_2GHZ, 1/*XXX*/);
720 	req->tx_cmd[0].sta_id = sc->sc_aux_sta.sta_id;
721 
722 	/* Tx flags 5 GHz. */
723 	req->tx_cmd[1].tx_flags = htole32(IWM_TX_CMD_FLG_SEQ_CTL |
724 	    IWM_TX_CMD_FLG_BT_DIS);
725 	req->tx_cmd[1].rate_n_flags =
726 	    iwm_mvm_scan_rate_n_flags(sc, IEEE80211_CHAN_5GHZ, 1/*XXX*/);
727 	req->tx_cmd[1].sta_id = sc->sc_aux_sta.sta_id;
728 
729 	/* Check if we're doing an active directed scan. */
730 	nssid = MIN(ss->ss_nssid, IWM_PROBE_OPTION_MAX);
731 	for (i = 0; i < nssid; i++) {
732 		req->direct_scan[i].id = IEEE80211_ELEMID_SSID;
733 		req->direct_scan[i].len = MIN(ss->ss_ssid[i].len,
734 		    IEEE80211_NWID_LEN);
735 		memcpy(req->direct_scan[i].ssid, ss->ss_ssid[i].ssid,
736 		    req->direct_scan[i].len);
737 		/* XXX debug */
738 	}
739 	if (nssid != 0) {
740 		req->scan_flags |=
741 		    htole32(IWM_MVM_LMAC_SCAN_FLAG_PRE_CONNECTION);
742 	} else
743 		req->scan_flags |= htole32(IWM_MVM_LMAC_SCAN_FLAG_PASSIVE);
744 
745 	req->n_channels = iwm_mvm_lmac_scan_fill_channels(sc,
746 	    (struct iwm_scan_channel_cfg_lmac *)req->data, nssid);
747 
748 	ret = iwm_mvm_fill_probe_req(sc,
749 			    (struct iwm_scan_probe_req *)(req->data +
750 			    (sizeof(struct iwm_scan_channel_cfg_lmac) *
751 			    sc->ucode_capa.n_scan_channels)));
752 	if (ret) {
753 		free(req, M_DEVBUF);
754 		return ret;
755 	}
756 
757 	/* Specify the scan plan: We'll do one iteration. */
758 	req->schedule[0].iterations = 1;
759 	req->schedule[0].full_scan_mul = 1;
760 
761 	if (iwm_mvm_scan_use_ebs(sc)) {
762 		req->channel_opt[0].flags =
763 			htole16(IWM_SCAN_CHANNEL_FLAG_EBS |
764 				IWM_SCAN_CHANNEL_FLAG_EBS_ACCURATE |
765 				IWM_SCAN_CHANNEL_FLAG_CACHE_ADD);
766 		req->channel_opt[0].non_ebs_ratio =
767 			htole16(IWM_DENSE_EBS_SCAN_RATIO);
768 		req->channel_opt[1].flags =
769 			htole16(IWM_SCAN_CHANNEL_FLAG_EBS |
770 				IWM_SCAN_CHANNEL_FLAG_EBS_ACCURATE |
771 				IWM_SCAN_CHANNEL_FLAG_CACHE_ADD);
772 		req->channel_opt[1].non_ebs_ratio =
773 			htole16(IWM_SPARSE_EBS_SCAN_RATIO);
774 	}
775 
776 	ret = iwm_send_cmd(sc, &hcmd);
777 	if (!ret) {
778 		IWM_DPRINTF(sc, IWM_DEBUG_SCAN,
779 		    "Scan request was sent successfully\n");
780 	}
781 	free(req, M_DEVBUF);
782 	return ret;
783 }
784 
785 static int
786 iwm_mvm_lmac_scan_abort(struct iwm_softc *sc)
787 {
788 	int ret;
789 	struct iwm_host_cmd hcmd = {
790 		.id = IWM_SCAN_OFFLOAD_ABORT_CMD,
791 		.len = { 0, },
792 		.data = { NULL, },
793 		.flags = IWM_CMD_SYNC,
794 	};
795 	uint32_t status;
796 
797 	ret = iwm_mvm_send_cmd_status(sc, &hcmd, &status);
798 	if (ret)
799 		return ret;
800 
801 	if (status != IWM_CAN_ABORT_STATUS) {
802 		/*
803 		 * The scan abort will return 1 for success or
804 		 * 2 for "failure".  A failure condition can be
805 		 * due to simply not being in an active scan which
806 		 * can occur if we send the scan abort before the
807 		 * microcode has notified us that a scan is completed.
808 		 */
809 		IWM_DPRINTF(sc, IWM_DEBUG_SCAN,
810 		    "SCAN OFFLOAD ABORT ret %d.\n", status);
811 		ret = ENOENT;
812 	}
813 
814 	return ret;
815 }
816 
817 static int
818 iwm_mvm_umac_scan_abort(struct iwm_softc *sc)
819 {
820 	struct iwm_umac_scan_abort cmd = {};
821 	int uid, ret;
822 
823 	uid = 0;
824 	cmd.uid = htole32(uid);
825 
826 	IWM_DPRINTF(sc, IWM_DEBUG_SCAN, "Sending scan abort, uid %u\n", uid);
827 
828 	ret = iwm_mvm_send_cmd_pdu(sc,
829 				   iwm_cmd_id(IWM_SCAN_ABORT_UMAC,
830 					      IWM_ALWAYS_LONG_GROUP, 0),
831 				   0, sizeof(cmd), &cmd);
832 
833 	return ret;
834 }
835 
836 int
837 iwm_mvm_scan_stop_wait(struct iwm_softc *sc)
838 {
839 	struct iwm_notification_wait wait_scan_done;
840 	static const uint16_t scan_done_notif[] = { IWM_SCAN_COMPLETE_UMAC,
841 						   IWM_SCAN_OFFLOAD_COMPLETE, };
842 	int ret;
843 
844 	iwm_init_notification_wait(sc->sc_notif_wait, &wait_scan_done,
845 				   scan_done_notif, nitems(scan_done_notif),
846 				   NULL, NULL);
847 
848 	IWM_DPRINTF(sc, IWM_DEBUG_SCAN, "Preparing to stop scan\n");
849 
850 	if (fw_has_capa(&sc->ucode_capa, IWM_UCODE_TLV_CAPA_UMAC_SCAN))
851 		ret = iwm_mvm_umac_scan_abort(sc);
852 	else
853 		ret = iwm_mvm_lmac_scan_abort(sc);
854 
855 	if (ret) {
856 		IWM_DPRINTF(sc, IWM_DEBUG_SCAN, "couldn't stop scan\n");
857 		iwm_remove_notification(sc->sc_notif_wait, &wait_scan_done);
858 		return ret;
859 	}
860 
861 	IWM_UNLOCK(sc);
862 	ret = iwm_wait_notification(sc->sc_notif_wait, &wait_scan_done, hz);
863 	IWM_LOCK(sc);
864 
865 	return ret;
866 }
867