xref: /freebsd/sys/dev/iwm/if_iwm_scan.c (revision 8554754c7bbe3cda171378ad6305bbe8a1a94cb6)
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 #ifdef IWM_DEBUG
205 static const char *
206 iwm_mvm_ebs_status_str(enum iwm_scan_ebs_status status)
207 {
208 	switch (status) {
209 	case IWM_SCAN_EBS_SUCCESS:
210 		return "successful";
211 	case IWM_SCAN_EBS_INACTIVE:
212 		return "inactive";
213 	case IWM_SCAN_EBS_FAILED:
214 	case IWM_SCAN_EBS_CHAN_NOT_FOUND:
215 	default:
216 		return "failed";
217 	}
218 }
219 
220 static const char *
221 iwm_mvm_offload_status_str(enum iwm_scan_offload_complete_status status)
222 {
223 	return (status == IWM_SCAN_OFFLOAD_ABORTED) ? "aborted" : "completed";
224 }
225 #endif
226 
227 void
228 iwm_mvm_rx_lmac_scan_complete_notif(struct iwm_softc *sc,
229     struct iwm_rx_packet *pkt)
230 {
231 	struct iwm_periodic_scan_complete *scan_notif = (void *)pkt->data;
232 
233 	/* If this happens, the firmware has mistakenly sent an LMAC
234 	 * notification during UMAC scans -- warn and ignore it.
235 	 */
236 	if (fw_has_capa(&sc->ucode_capa, IWM_UCODE_TLV_CAPA_UMAC_SCAN)) {
237 		device_printf(sc->sc_dev,
238 		    "%s: Mistakenly got LMAC notification during UMAC scan\n",
239 		    __func__);
240 		return;
241 	}
242 
243 	IWM_DPRINTF(sc, IWM_DEBUG_SCAN, "Regular scan %s, EBS status %s (FW)\n",
244 	    iwm_mvm_offload_status_str(scan_notif->status),
245 	    iwm_mvm_ebs_status_str(scan_notif->ebs_status));
246 
247 	sc->last_ebs_successful =
248 			scan_notif->ebs_status == IWM_SCAN_EBS_SUCCESS ||
249 			scan_notif->ebs_status == IWM_SCAN_EBS_INACTIVE;
250 
251 }
252 
253 void
254 iwm_mvm_rx_umac_scan_complete_notif(struct iwm_softc *sc,
255     struct iwm_rx_packet *pkt)
256 {
257 	struct iwm_umac_scan_complete *notif = (void *)pkt->data;
258 
259 	IWM_DPRINTF(sc, IWM_DEBUG_SCAN,
260 	    "Scan completed, uid %u, status %s, EBS status %s\n",
261 	    le32toh(notif->uid),
262 	    iwm_mvm_offload_status_str(notif->status),
263 	    iwm_mvm_ebs_status_str(notif->ebs_status));
264 
265 	if (notif->ebs_status != IWM_SCAN_EBS_SUCCESS &&
266 	    notif->ebs_status != IWM_SCAN_EBS_INACTIVE)
267 		sc->last_ebs_successful = FALSE;
268 }
269 
270 static int
271 iwm_mvm_scan_skip_channel(struct ieee80211_channel *c)
272 {
273 	if (IEEE80211_IS_CHAN_2GHZ(c) && IEEE80211_IS_CHAN_B(c))
274 		return 0;
275 	else if (IEEE80211_IS_CHAN_5GHZ(c) && IEEE80211_IS_CHAN_A(c))
276 		return 0;
277 	else
278 		return 1;
279 }
280 
281 static uint8_t
282 iwm_mvm_lmac_scan_fill_channels(struct iwm_softc *sc,
283     struct iwm_scan_channel_cfg_lmac *chan, int n_ssids)
284 {
285 	struct ieee80211com *ic = &sc->sc_ic;
286 	struct ieee80211_scan_state *ss = ic->ic_scan;
287 	struct ieee80211_channel *c;
288 	uint8_t nchan;
289 	int j;
290 
291 	for (nchan = j = 0;
292 	    j < ic->ic_nchans && nchan < sc->ucode_capa.n_scan_channels; j++) {
293 		c = &ic->ic_channels[j];
294 		/* For 2GHz, only populate 11b channels */
295 		/* For 5GHz, only populate 11a channels */
296 		/*
297 		 * Catch other channels, in case we have 900MHz channels or
298 		 * something in the chanlist.
299 		 */
300 		if (iwm_mvm_scan_skip_channel(c)) {
301 			IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_EEPROM,
302 			    "%s: skipping channel (freq=%d, ieee=%d, flags=0x%08x)\n",
303 			    __func__, c->ic_freq, c->ic_ieee, c->ic_flags);
304 			continue;
305 		}
306 
307 		IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_EEPROM,
308 		    "Adding channel %d (%d Mhz) to the list\n",
309 		    nchan, c->ic_freq);
310 		chan->channel_num = htole16(ieee80211_mhz2ieee(c->ic_freq, 0));
311 		chan->iter_count = htole16(1);
312 		chan->iter_interval = htole32(0);
313 		chan->flags = htole32(IWM_UNIFIED_SCAN_CHANNEL_PARTIAL);
314 		chan->flags |= htole32(IWM_SCAN_CHANNEL_NSSIDS(n_ssids));
315 		/* XXX IEEE80211_SCAN_NOBCAST flag is never set. */
316 		if (!IEEE80211_IS_CHAN_PASSIVE(c) &&
317 		    (!(ss->ss_flags & IEEE80211_SCAN_NOBCAST) || n_ssids != 0))
318 			chan->flags |= htole32(IWM_SCAN_CHANNEL_TYPE_ACTIVE);
319 		chan++;
320 		nchan++;
321 	}
322 
323 	return nchan;
324 }
325 
326 static uint8_t
327 iwm_mvm_umac_scan_fill_channels(struct iwm_softc *sc,
328     struct iwm_scan_channel_cfg_umac *chan, int n_ssids)
329 {
330 	struct ieee80211com *ic = &sc->sc_ic;
331 	struct ieee80211_channel *c;
332 	uint8_t nchan;
333 	int j;
334 
335 	for (nchan = j = 0;
336 	    j < ic->ic_nchans && nchan < sc->ucode_capa.n_scan_channels; j++) {
337 		c = &ic->ic_channels[j];
338 		/* For 2GHz, only populate 11b channels */
339 		/* For 5GHz, only populate 11a channels */
340 		/*
341 		 * Catch other channels, in case we have 900MHz channels or
342 		 * something in the chanlist.
343 		 */
344 		if (iwm_mvm_scan_skip_channel(c)) {
345 			IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_EEPROM,
346 			    "%s: skipping channel (freq=%d, ieee=%d, flags=0x%08x)\n",
347 			    __func__, c->ic_freq, c->ic_ieee, c->ic_flags);
348 			continue;
349 		}
350 
351 		IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_EEPROM,
352 		    "Adding channel %d (%d Mhz) to the list\n",
353 		    nchan, c->ic_freq);
354 		chan->channel_num = ieee80211_mhz2ieee(c->ic_freq, 0);
355 		chan->iter_count = 1;
356 		chan->iter_interval = htole16(0);
357 		chan->flags = htole32(IWM_SCAN_CHANNEL_UMAC_NSSIDS(n_ssids));
358 		chan++;
359 		nchan++;
360 	}
361 
362 	return nchan;
363 }
364 
365 static int
366 iwm_mvm_fill_probe_req(struct iwm_softc *sc, struct iwm_scan_probe_req *preq)
367 {
368 	struct ieee80211com *ic = &sc->sc_ic;
369 	struct ieee80211vap *vap = TAILQ_FIRST(&ic->ic_vaps);
370 	struct ieee80211_frame *wh = (struct ieee80211_frame *)preq->buf;
371 	struct ieee80211_rateset *rs;
372 	size_t remain = sizeof(preq->buf);
373 	uint8_t *frm, *pos;
374 
375 	memset(preq, 0, sizeof(*preq));
376 
377 	/* Ensure enough space for header and SSID IE. */
378 	if (remain < sizeof(*wh) + 2)
379 		return ENOBUFS;
380 
381 	/*
382 	 * Build a probe request frame.  Most of the following code is a
383 	 * copy & paste of what is done in net80211.
384 	 */
385 	wh->i_fc[0] = IEEE80211_FC0_VERSION_0 | IEEE80211_FC0_TYPE_MGT |
386 	    IEEE80211_FC0_SUBTYPE_PROBE_REQ;
387 	wh->i_fc[1] = IEEE80211_FC1_DIR_NODS;
388 	IEEE80211_ADDR_COPY(wh->i_addr1, ieee80211broadcastaddr);
389 	IEEE80211_ADDR_COPY(wh->i_addr2, vap ? vap->iv_myaddr : ic->ic_macaddr);
390 	IEEE80211_ADDR_COPY(wh->i_addr3, ieee80211broadcastaddr);
391 	*(uint16_t *)&wh->i_dur[0] = 0; /* filled by HW */
392 	*(uint16_t *)&wh->i_seq[0] = 0; /* filled by HW */
393 
394 	frm = (uint8_t *)(wh + 1);
395 	frm = ieee80211_add_ssid(frm, NULL, 0);
396 
397 	/* Tell the firmware where the MAC header is. */
398 	preq->mac_header.offset = 0;
399 	preq->mac_header.len = htole16(frm - (uint8_t *)wh);
400 	remain -= frm - (uint8_t *)wh;
401 
402 	/* Fill in 2GHz IEs and tell firmware where they are. */
403 	rs = &ic->ic_sup_rates[IEEE80211_MODE_11G];
404 	if (rs->rs_nrates > IEEE80211_RATE_SIZE) {
405 		if (remain < 4 + rs->rs_nrates)
406 			return ENOBUFS;
407 	} else if (remain < 2 + rs->rs_nrates) {
408 		return ENOBUFS;
409 	}
410 	preq->band_data[0].offset = htole16(frm - (uint8_t *)wh);
411 	pos = frm;
412 	frm = ieee80211_add_rates(frm, rs);
413 	if (rs->rs_nrates > IEEE80211_RATE_SIZE)
414 		frm = ieee80211_add_xrates(frm, rs);
415 	preq->band_data[0].len = htole16(frm - pos);
416 	remain -= frm - pos;
417 
418 	if (fw_has_capa(&sc->ucode_capa,
419 	    IWM_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT)) {
420 		if (remain < 3)
421 			return ENOBUFS;
422 		*frm++ = IEEE80211_ELEMID_DSPARMS;
423 		*frm++ = 1;
424 		*frm++ = 0;
425 		remain -= 3;
426 	}
427 
428 	if (sc->nvm_data->sku_cap_band_52GHz_enable) {
429 		/* Fill in 5GHz IEs. */
430 		rs = &ic->ic_sup_rates[IEEE80211_MODE_11A];
431 		if (rs->rs_nrates > IEEE80211_RATE_SIZE) {
432 			if (remain < 4 + rs->rs_nrates)
433 				return ENOBUFS;
434 		} else if (remain < 2 + rs->rs_nrates) {
435 			return ENOBUFS;
436 		}
437 		preq->band_data[1].offset = htole16(frm - (uint8_t *)wh);
438 		pos = frm;
439 		frm = ieee80211_add_rates(frm, rs);
440 		if (rs->rs_nrates > IEEE80211_RATE_SIZE)
441 			frm = ieee80211_add_xrates(frm, rs);
442 		preq->band_data[1].len = htole16(frm - pos);
443 		remain -= frm - pos;
444 	}
445 
446 	/* Send 11n IEs on both 2GHz and 5GHz bands. */
447 	preq->common_data.offset = htole16(frm - (uint8_t *)wh);
448 	pos = frm;
449 #if 0
450 	if (ic->ic_flags & IEEE80211_F_HTON) {
451 		if (remain < 28)
452 			return ENOBUFS;
453 		frm = ieee80211_add_htcaps(frm, ic);
454 		/* XXX add WME info? */
455 	}
456 #endif
457 	preq->common_data.len = htole16(frm - pos);
458 
459 	return 0;
460 }
461 
462 int
463 iwm_mvm_config_umac_scan(struct iwm_softc *sc)
464 {
465 	struct ieee80211com *ic = &sc->sc_ic;
466 	struct ieee80211vap *vap = TAILQ_FIRST(&ic->ic_vaps);
467 
468 	struct iwm_scan_config *scan_config;
469 	int ret, j, nchan;
470 	size_t cmd_size;
471 	struct ieee80211_channel *c;
472 	struct iwm_host_cmd hcmd = {
473 		.id = iwm_cmd_id(IWM_SCAN_CFG_CMD, IWM_ALWAYS_LONG_GROUP, 0),
474 		.flags = IWM_CMD_SYNC,
475 	};
476 	static const uint32_t rates = (IWM_SCAN_CONFIG_RATE_1M |
477 	    IWM_SCAN_CONFIG_RATE_2M | IWM_SCAN_CONFIG_RATE_5M |
478 	    IWM_SCAN_CONFIG_RATE_11M | IWM_SCAN_CONFIG_RATE_6M |
479 	    IWM_SCAN_CONFIG_RATE_9M | IWM_SCAN_CONFIG_RATE_12M |
480 	    IWM_SCAN_CONFIG_RATE_18M | IWM_SCAN_CONFIG_RATE_24M |
481 	    IWM_SCAN_CONFIG_RATE_36M | IWM_SCAN_CONFIG_RATE_48M |
482 	    IWM_SCAN_CONFIG_RATE_54M);
483 
484 	cmd_size = sizeof(*scan_config) + sc->ucode_capa.n_scan_channels;
485 
486 	scan_config = malloc(cmd_size, M_DEVBUF, M_NOWAIT | M_ZERO);
487 	if (scan_config == NULL)
488 		return ENOMEM;
489 
490 	scan_config->tx_chains = htole32(iwm_mvm_get_valid_tx_ant(sc));
491 	scan_config->rx_chains = htole32(iwm_mvm_get_valid_rx_ant(sc));
492 	scan_config->legacy_rates = htole32(rates |
493 	    IWM_SCAN_CONFIG_SUPPORTED_RATE(rates));
494 
495 	/* These timings correspond to iwlwifi's UNASSOC scan. */
496 	scan_config->dwell_active = 10;
497 	scan_config->dwell_passive = 110;
498 	scan_config->dwell_fragmented = 44;
499 	scan_config->dwell_extended = 90;
500 	scan_config->out_of_channel_time = htole32(0);
501 	scan_config->suspend_time = htole32(0);
502 
503 	IEEE80211_ADDR_COPY(scan_config->mac_addr,
504 	    vap ? vap->iv_myaddr : ic->ic_macaddr);
505 
506 	scan_config->bcast_sta_id = sc->sc_aux_sta.sta_id;
507 	scan_config->channel_flags = IWM_CHANNEL_FLAG_EBS |
508 	    IWM_CHANNEL_FLAG_ACCURATE_EBS | IWM_CHANNEL_FLAG_EBS_ADD |
509 	    IWM_CHANNEL_FLAG_PRE_SCAN_PASSIVE2ACTIVE;
510 
511 	for (nchan = j = 0;
512 	    j < ic->ic_nchans && nchan < sc->ucode_capa.n_scan_channels; j++) {
513 		c = &ic->ic_channels[j];
514 		/* For 2GHz, only populate 11b channels */
515 		/* For 5GHz, only populate 11a channels */
516 		/*
517 		 * Catch other channels, in case we have 900MHz channels or
518 		 * something in the chanlist.
519 		 */
520 		if (iwm_mvm_scan_skip_channel(c))
521 			continue;
522 		scan_config->channel_array[nchan++] =
523 		    ieee80211_mhz2ieee(c->ic_freq, 0);
524 	}
525 
526 	scan_config->flags = htole32(IWM_SCAN_CONFIG_FLAG_ACTIVATE |
527 	    IWM_SCAN_CONFIG_FLAG_ALLOW_CHUB_REQS |
528 	    IWM_SCAN_CONFIG_FLAG_SET_TX_CHAINS |
529 	    IWM_SCAN_CONFIG_FLAG_SET_RX_CHAINS |
530 	    IWM_SCAN_CONFIG_FLAG_SET_AUX_STA_ID |
531 	    IWM_SCAN_CONFIG_FLAG_SET_ALL_TIMES |
532 	    IWM_SCAN_CONFIG_FLAG_SET_LEGACY_RATES |
533 	    IWM_SCAN_CONFIG_FLAG_SET_MAC_ADDR |
534 	    IWM_SCAN_CONFIG_FLAG_SET_CHANNEL_FLAGS|
535 	    IWM_SCAN_CONFIG_N_CHANNELS(nchan) |
536 	    IWM_SCAN_CONFIG_FLAG_CLEAR_FRAGMENTED);
537 
538 	hcmd.data[0] = scan_config;
539 	hcmd.len[0] = cmd_size;
540 
541 	IWM_DPRINTF(sc, IWM_DEBUG_SCAN, "Sending UMAC scan config\n");
542 
543 	ret = iwm_send_cmd(sc, &hcmd);
544 	if (!ret)
545 		IWM_DPRINTF(sc, IWM_DEBUG_SCAN,
546 		    "UMAC scan config was sent successfully\n");
547 
548 	free(scan_config, M_DEVBUF);
549 	return ret;
550 }
551 
552 static boolean_t
553 iwm_mvm_scan_use_ebs(struct iwm_softc *sc)
554 {
555 	const struct iwm_ucode_capabilities *capa = &sc->ucode_capa;
556 
557 	/* We can only use EBS if:
558 	 *	1. the feature is supported;
559 	 *	2. the last EBS was successful;
560 	 *	3. if only single scan, the single scan EBS API is supported;
561 	 *	4. it's not a p2p find operation.
562 	 */
563 	return ((capa->flags & IWM_UCODE_TLV_FLAGS_EBS_SUPPORT) &&
564 		sc->last_ebs_successful);
565 }
566 
567 int
568 iwm_mvm_umac_scan(struct iwm_softc *sc)
569 {
570 	struct iwm_host_cmd hcmd = {
571 		.id = iwm_cmd_id(IWM_SCAN_REQ_UMAC, IWM_ALWAYS_LONG_GROUP, 0),
572 		.len = { 0, },
573 		.data = { NULL, },
574 		.flags = IWM_CMD_SYNC,
575 	};
576 	struct ieee80211_scan_state *ss = sc->sc_ic.ic_scan;
577 	struct iwm_scan_req_umac *req;
578 	struct iwm_scan_req_umac_tail *tail;
579 	size_t req_len;
580 	uint8_t i, nssid;
581 	int ret;
582 
583 	req_len = sizeof(struct iwm_scan_req_umac) +
584 	    (sizeof(struct iwm_scan_channel_cfg_umac) *
585 	    sc->ucode_capa.n_scan_channels) +
586 	    sizeof(struct iwm_scan_req_umac_tail);
587 	if (req_len > IWM_MAX_CMD_PAYLOAD_SIZE)
588 		return ENOMEM;
589 	req = malloc(req_len, M_DEVBUF, M_NOWAIT | M_ZERO);
590 	if (req == NULL)
591 		return ENOMEM;
592 
593 	hcmd.len[0] = (uint16_t)req_len;
594 	hcmd.data[0] = (void *)req;
595 
596 	IWM_DPRINTF(sc, IWM_DEBUG_SCAN, "Handling ieee80211 scan request\n");
597 
598 	/* These timings correspond to iwlwifi's UNASSOC scan. */
599 	req->active_dwell = 10;
600 	req->passive_dwell = 110;
601 	req->fragmented_dwell = 44;
602 	req->extended_dwell = 90;
603 	req->max_out_time = 0;
604 	req->suspend_time = 0;
605 
606 	req->scan_priority = htole32(IWM_SCAN_PRIORITY_HIGH);
607 	req->ooc_priority = htole32(IWM_SCAN_PRIORITY_HIGH);
608 
609 	nssid = MIN(ss->ss_nssid, IWM_PROBE_OPTION_MAX);
610 	req->n_channels = iwm_mvm_umac_scan_fill_channels(sc,
611 	    (struct iwm_scan_channel_cfg_umac *)req->data, nssid);
612 
613 	req->general_flags = htole32(IWM_UMAC_SCAN_GEN_FLAGS_PASS_ALL |
614 	    IWM_UMAC_SCAN_GEN_FLAGS_ITER_COMPLETE |
615 	    IWM_UMAC_SCAN_GEN_FLAGS_EXTENDED_DWELL);
616 
617 	tail = (void *)((char *)&req->data +
618 		sizeof(struct iwm_scan_channel_cfg_umac) *
619 			sc->ucode_capa.n_scan_channels);
620 
621 	/* Check if we're doing an active directed scan. */
622 	for (i = 0; i < nssid; i++) {
623 		tail->direct_scan[i].id = IEEE80211_ELEMID_SSID;
624 		tail->direct_scan[i].len = MIN(ss->ss_ssid[i].len,
625 		    IEEE80211_NWID_LEN);
626 		memcpy(tail->direct_scan[i].ssid, ss->ss_ssid[i].ssid,
627 		    tail->direct_scan[i].len);
628 		/* XXX debug */
629 	}
630 	if (nssid != 0) {
631 		req->general_flags |=
632 		    htole32(IWM_UMAC_SCAN_GEN_FLAGS_PRE_CONNECT);
633 	} else
634 		req->general_flags |= htole32(IWM_UMAC_SCAN_GEN_FLAGS_PASSIVE);
635 
636 	if (iwm_mvm_scan_use_ebs(sc))
637 		req->channel_flags = IWM_SCAN_CHANNEL_FLAG_EBS |
638 				     IWM_SCAN_CHANNEL_FLAG_EBS_ACCURATE |
639 				     IWM_SCAN_CHANNEL_FLAG_CACHE_ADD;
640 
641 	if (fw_has_capa(&sc->ucode_capa,
642 	    IWM_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT))
643 		req->general_flags |=
644 		    htole32(IWM_UMAC_SCAN_GEN_FLAGS_RRM_ENABLED);
645 
646 	ret = iwm_mvm_fill_probe_req(sc, &tail->preq);
647 	if (ret) {
648 		free(req, M_DEVBUF);
649 		return ret;
650 	}
651 
652 	/* Specify the scan plan: We'll do one iteration. */
653 	tail->schedule[0].interval = 0;
654 	tail->schedule[0].iter_count = 1;
655 
656 	ret = iwm_send_cmd(sc, &hcmd);
657 	if (!ret)
658 		IWM_DPRINTF(sc, IWM_DEBUG_SCAN,
659 		    "Scan request was sent successfully\n");
660 	free(req, M_DEVBUF);
661 	return ret;
662 }
663 
664 int
665 iwm_mvm_lmac_scan(struct iwm_softc *sc)
666 {
667 	struct iwm_host_cmd hcmd = {
668 		.id = IWM_SCAN_OFFLOAD_REQUEST_CMD,
669 		.len = { 0, },
670 		.data = { NULL, },
671 		.flags = IWM_CMD_SYNC,
672 	};
673 	struct ieee80211_scan_state *ss = sc->sc_ic.ic_scan;
674 	struct iwm_scan_req_lmac *req;
675 	size_t req_len;
676 	uint8_t i, nssid;
677 	int ret;
678 
679 	IWM_DPRINTF(sc, IWM_DEBUG_SCAN,
680 	    "Handling ieee80211 scan request\n");
681 
682 	req_len = sizeof(struct iwm_scan_req_lmac) +
683 	    (sizeof(struct iwm_scan_channel_cfg_lmac) *
684 	    sc->ucode_capa.n_scan_channels) + sizeof(struct iwm_scan_probe_req);
685 	if (req_len > IWM_MAX_CMD_PAYLOAD_SIZE)
686 		return ENOMEM;
687 	req = malloc(req_len, M_DEVBUF, M_NOWAIT | M_ZERO);
688 	if (req == NULL)
689 		return ENOMEM;
690 
691 	hcmd.len[0] = (uint16_t)req_len;
692 	hcmd.data[0] = (void *)req;
693 
694 	/* These timings correspond to iwlwifi's UNASSOC scan. */
695 	req->active_dwell = 10;
696 	req->passive_dwell = 110;
697 	req->fragmented_dwell = 44;
698 	req->extended_dwell = 90;
699 	req->max_out_time = 0;
700 	req->suspend_time = 0;
701 
702 	req->scan_prio = htole32(IWM_SCAN_PRIORITY_HIGH);
703 	req->rx_chain_select = iwm_mvm_scan_rx_chain(sc);
704 	req->iter_num = htole32(1);
705 	req->delay = 0;
706 
707 	req->scan_flags = htole32(IWM_MVM_LMAC_SCAN_FLAG_PASS_ALL |
708 	    IWM_MVM_LMAC_SCAN_FLAG_ITER_COMPLETE |
709 	    IWM_MVM_LMAC_SCAN_FLAG_EXTENDED_DWELL);
710 	if (fw_has_capa(&sc->ucode_capa,
711 	    IWM_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT))
712 		req->scan_flags |= htole32(IWM_MVM_LMAC_SCAN_FLAGS_RRM_ENABLED);
713 
714 	req->flags = htole32(IWM_PHY_BAND_24);
715 	if (sc->nvm_data->sku_cap_band_52GHz_enable)
716 		req->flags |= htole32(IWM_PHY_BAND_5);
717 	req->filter_flags =
718 	    htole32(IWM_MAC_FILTER_ACCEPT_GRP | IWM_MAC_FILTER_IN_BEACON);
719 
720 	/* Tx flags 2 GHz. */
721 	req->tx_cmd[0].tx_flags = htole32(IWM_TX_CMD_FLG_SEQ_CTL |
722 	    IWM_TX_CMD_FLG_BT_DIS);
723 	req->tx_cmd[0].rate_n_flags =
724 	    iwm_mvm_scan_rate_n_flags(sc, IEEE80211_CHAN_2GHZ, 1/*XXX*/);
725 	req->tx_cmd[0].sta_id = sc->sc_aux_sta.sta_id;
726 
727 	/* Tx flags 5 GHz. */
728 	req->tx_cmd[1].tx_flags = htole32(IWM_TX_CMD_FLG_SEQ_CTL |
729 	    IWM_TX_CMD_FLG_BT_DIS);
730 	req->tx_cmd[1].rate_n_flags =
731 	    iwm_mvm_scan_rate_n_flags(sc, IEEE80211_CHAN_5GHZ, 1/*XXX*/);
732 	req->tx_cmd[1].sta_id = sc->sc_aux_sta.sta_id;
733 
734 	/* Check if we're doing an active directed scan. */
735 	nssid = MIN(ss->ss_nssid, IWM_PROBE_OPTION_MAX);
736 	for (i = 0; i < nssid; i++) {
737 		req->direct_scan[i].id = IEEE80211_ELEMID_SSID;
738 		req->direct_scan[i].len = MIN(ss->ss_ssid[i].len,
739 		    IEEE80211_NWID_LEN);
740 		memcpy(req->direct_scan[i].ssid, ss->ss_ssid[i].ssid,
741 		    req->direct_scan[i].len);
742 		/* XXX debug */
743 	}
744 	if (nssid != 0) {
745 		req->scan_flags |=
746 		    htole32(IWM_MVM_LMAC_SCAN_FLAG_PRE_CONNECTION);
747 	} else
748 		req->scan_flags |= htole32(IWM_MVM_LMAC_SCAN_FLAG_PASSIVE);
749 
750 	req->n_channels = iwm_mvm_lmac_scan_fill_channels(sc,
751 	    (struct iwm_scan_channel_cfg_lmac *)req->data, nssid);
752 
753 	ret = iwm_mvm_fill_probe_req(sc,
754 			    (struct iwm_scan_probe_req *)(req->data +
755 			    (sizeof(struct iwm_scan_channel_cfg_lmac) *
756 			    sc->ucode_capa.n_scan_channels)));
757 	if (ret) {
758 		free(req, M_DEVBUF);
759 		return ret;
760 	}
761 
762 	/* Specify the scan plan: We'll do one iteration. */
763 	req->schedule[0].iterations = 1;
764 	req->schedule[0].full_scan_mul = 1;
765 
766 	if (iwm_mvm_scan_use_ebs(sc)) {
767 		req->channel_opt[0].flags =
768 			htole16(IWM_SCAN_CHANNEL_FLAG_EBS |
769 				IWM_SCAN_CHANNEL_FLAG_EBS_ACCURATE |
770 				IWM_SCAN_CHANNEL_FLAG_CACHE_ADD);
771 		req->channel_opt[0].non_ebs_ratio =
772 			htole16(IWM_DENSE_EBS_SCAN_RATIO);
773 		req->channel_opt[1].flags =
774 			htole16(IWM_SCAN_CHANNEL_FLAG_EBS |
775 				IWM_SCAN_CHANNEL_FLAG_EBS_ACCURATE |
776 				IWM_SCAN_CHANNEL_FLAG_CACHE_ADD);
777 		req->channel_opt[1].non_ebs_ratio =
778 			htole16(IWM_SPARSE_EBS_SCAN_RATIO);
779 	}
780 
781 	ret = iwm_send_cmd(sc, &hcmd);
782 	if (!ret) {
783 		IWM_DPRINTF(sc, IWM_DEBUG_SCAN,
784 		    "Scan request was sent successfully\n");
785 	}
786 	free(req, M_DEVBUF);
787 	return ret;
788 }
789 
790 static int
791 iwm_mvm_lmac_scan_abort(struct iwm_softc *sc)
792 {
793 	int ret;
794 	struct iwm_host_cmd hcmd = {
795 		.id = IWM_SCAN_OFFLOAD_ABORT_CMD,
796 		.len = { 0, },
797 		.data = { NULL, },
798 		.flags = IWM_CMD_SYNC,
799 	};
800 	uint32_t status;
801 
802 	ret = iwm_mvm_send_cmd_status(sc, &hcmd, &status);
803 	if (ret)
804 		return ret;
805 
806 	if (status != IWM_CAN_ABORT_STATUS) {
807 		/*
808 		 * The scan abort will return 1 for success or
809 		 * 2 for "failure".  A failure condition can be
810 		 * due to simply not being in an active scan which
811 		 * can occur if we send the scan abort before the
812 		 * microcode has notified us that a scan is completed.
813 		 */
814 		IWM_DPRINTF(sc, IWM_DEBUG_SCAN,
815 		    "SCAN OFFLOAD ABORT ret %d.\n", status);
816 		ret = ENOENT;
817 	}
818 
819 	return ret;
820 }
821 
822 static int
823 iwm_mvm_umac_scan_abort(struct iwm_softc *sc)
824 {
825 	struct iwm_umac_scan_abort cmd = {};
826 	int uid, ret;
827 
828 	uid = 0;
829 	cmd.uid = htole32(uid);
830 
831 	IWM_DPRINTF(sc, IWM_DEBUG_SCAN, "Sending scan abort, uid %u\n", uid);
832 
833 	ret = iwm_mvm_send_cmd_pdu(sc,
834 				   iwm_cmd_id(IWM_SCAN_ABORT_UMAC,
835 					      IWM_ALWAYS_LONG_GROUP, 0),
836 				   0, sizeof(cmd), &cmd);
837 
838 	return ret;
839 }
840 
841 int
842 iwm_mvm_scan_stop_wait(struct iwm_softc *sc)
843 {
844 	struct iwm_notification_wait wait_scan_done;
845 	static const uint16_t scan_done_notif[] = { IWM_SCAN_COMPLETE_UMAC,
846 						   IWM_SCAN_OFFLOAD_COMPLETE, };
847 	int ret;
848 
849 	iwm_init_notification_wait(sc->sc_notif_wait, &wait_scan_done,
850 				   scan_done_notif, nitems(scan_done_notif),
851 				   NULL, NULL);
852 
853 	IWM_DPRINTF(sc, IWM_DEBUG_SCAN, "Preparing to stop scan\n");
854 
855 	if (fw_has_capa(&sc->ucode_capa, IWM_UCODE_TLV_CAPA_UMAC_SCAN))
856 		ret = iwm_mvm_umac_scan_abort(sc);
857 	else
858 		ret = iwm_mvm_lmac_scan_abort(sc);
859 
860 	if (ret) {
861 		IWM_DPRINTF(sc, IWM_DEBUG_SCAN, "couldn't stop scan\n");
862 		iwm_remove_notification(sc->sc_notif_wait, &wait_scan_done);
863 		return ret;
864 	}
865 
866 	IWM_UNLOCK(sc);
867 	ret = iwm_wait_notification(sc->sc_notif_wait, &wait_scan_done, hz);
868 	IWM_LOCK(sc);
869 
870 	return ret;
871 }
872