xref: /freebsd/sys/net80211/ieee80211_scan.c (revision 9df9e9361cddc9586f64e2bfec552dd01284fac3)
168e8e04eSSam Leffler /*-
2fe267a55SPedro F. Giffuni  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3fe267a55SPedro F. Giffuni  *
4b032f27cSSam Leffler  * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
568e8e04eSSam Leffler  * All rights reserved.
668e8e04eSSam Leffler  *
768e8e04eSSam Leffler  * Redistribution and use in source and binary forms, with or without
868e8e04eSSam Leffler  * modification, are permitted provided that the following conditions
968e8e04eSSam Leffler  * are met:
1068e8e04eSSam Leffler  * 1. Redistributions of source code must retain the above copyright
1168e8e04eSSam Leffler  *    notice, this list of conditions and the following disclaimer.
1268e8e04eSSam Leffler  * 2. Redistributions in binary form must reproduce the above copyright
1368e8e04eSSam Leffler  *    notice, this list of conditions and the following disclaimer in the
1468e8e04eSSam Leffler  *    documentation and/or other materials provided with the distribution.
1568e8e04eSSam Leffler  *
1668e8e04eSSam Leffler  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
1768e8e04eSSam Leffler  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
1868e8e04eSSam Leffler  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1968e8e04eSSam Leffler  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
2068e8e04eSSam Leffler  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
2168e8e04eSSam Leffler  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2268e8e04eSSam Leffler  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2368e8e04eSSam Leffler  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2468e8e04eSSam Leffler  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
2568e8e04eSSam Leffler  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2668e8e04eSSam Leffler  */
2768e8e04eSSam Leffler 
2868e8e04eSSam Leffler #include <sys/cdefs.h>
2968e8e04eSSam Leffler __FBSDID("$FreeBSD$");
3068e8e04eSSam Leffler 
3168e8e04eSSam Leffler /*
3268e8e04eSSam Leffler  * IEEE 802.11 scanning support.
3368e8e04eSSam Leffler  */
34b032f27cSSam Leffler #include "opt_wlan.h"
35b032f27cSSam Leffler 
3668e8e04eSSam Leffler #include <sys/param.h>
3768e8e04eSSam Leffler #include <sys/systm.h>
385efea30fSAndrew Thompson #include <sys/proc.h>
3968e8e04eSSam Leffler #include <sys/kernel.h>
408ec07310SGleb Smirnoff #include <sys/malloc.h>
415efea30fSAndrew Thompson #include <sys/condvar.h>
4268e8e04eSSam Leffler 
4368e8e04eSSam Leffler #include <sys/socket.h>
4468e8e04eSSam Leffler 
4568e8e04eSSam Leffler #include <net/if.h>
4676039bc8SGleb Smirnoff #include <net/if_var.h>
4768e8e04eSSam Leffler #include <net/if_media.h>
4868e8e04eSSam Leffler #include <net/ethernet.h>
4968e8e04eSSam Leffler 
5068e8e04eSSam Leffler #include <net80211/ieee80211_var.h>
5168e8e04eSSam Leffler 
52cc6dd788SAdrian Chadd /* XXX until it's implemented as attach ops */
53cc6dd788SAdrian Chadd #include <net80211/ieee80211_scan_sw.h>
54cc6dd788SAdrian Chadd 
5568e8e04eSSam Leffler #include <net/bpf.h>
5668e8e04eSSam Leffler 
5768e8e04eSSam Leffler /*
5868e8e04eSSam Leffler  * Roaming-related defaults.  RSSI thresholds are as returned by the
5982c990a4SSam Leffler  * driver (.5dBm).  Transmit rate thresholds are IEEE rate codes (i.e
60b032f27cSSam Leffler  * .5M units) or MCS.
6168e8e04eSSam Leffler  */
6282c990a4SSam Leffler /* rssi thresholds */
6382c990a4SSam Leffler #define	ROAM_RSSI_11A_DEFAULT		14	/* 11a bss */
6482c990a4SSam Leffler #define	ROAM_RSSI_11B_DEFAULT		14	/* 11b bss */
6582c990a4SSam Leffler #define	ROAM_RSSI_11BONLY_DEFAULT	14	/* 11b-only bss */
6682c990a4SSam Leffler /* transmit rate thresholds */
6782c990a4SSam Leffler #define	ROAM_RATE_11A_DEFAULT		2*12	/* 11a bss */
6882c990a4SSam Leffler #define	ROAM_RATE_11B_DEFAULT		2*5	/* 11b bss */
6982c990a4SSam Leffler #define	ROAM_RATE_11BONLY_DEFAULT	2*1	/* 11b-only bss */
706a76ae21SSam Leffler #define	ROAM_RATE_HALF_DEFAULT		2*6	/* half-width 11a/g bss */
716a76ae21SSam Leffler #define	ROAM_RATE_QUARTER_DEFAULT	2*3	/* quarter-width 11a/g bss */
7282c990a4SSam Leffler #define	ROAM_MCS_11N_DEFAULT		(1 | IEEE80211_RATE_MCS) /* 11n bss */
73a1dce3c0SAdrian Chadd #define	ROAM_MCS_11AC_DEFAULT		(1 | IEEE80211_RATE_MCS) /* 11ac bss; XXX not used yet */
7468e8e04eSSam Leffler 
7568e8e04eSSam Leffler void
7668e8e04eSSam Leffler ieee80211_scan_attach(struct ieee80211com *ic)
7768e8e04eSSam Leffler {
78cc6dd788SAdrian Chadd 	/*
79f7f155faSAdrian Chadd 	 * If there's no scan method pointer, attach the
80f7f155faSAdrian Chadd 	 * swscan set as a default.
81cc6dd788SAdrian Chadd 	 */
82f7f155faSAdrian Chadd 	if (ic->ic_scan_methods == NULL)
83cc6dd788SAdrian Chadd 		ieee80211_swscan_attach(ic);
84f7f155faSAdrian Chadd 	else
85f7f155faSAdrian Chadd 		ic->ic_scan_methods->sc_attach(ic);
8668e8e04eSSam Leffler }
8768e8e04eSSam Leffler 
8868e8e04eSSam Leffler void
8968e8e04eSSam Leffler ieee80211_scan_detach(struct ieee80211com *ic)
9068e8e04eSSam Leffler {
9168e8e04eSSam Leffler 
92cc6dd788SAdrian Chadd 	/*
93cc6dd788SAdrian Chadd 	 * Ideally we'd do the ss_ops detach call here;
94f7f155faSAdrian Chadd 	 * but then sc_detach() would need to be split in two.
95cc6dd788SAdrian Chadd 	 *
96cc6dd788SAdrian Chadd 	 * I'll do that later.
97cc6dd788SAdrian Chadd 	 */
98f7f155faSAdrian Chadd 	ic->ic_scan_methods->sc_detach(ic);
9968e8e04eSSam Leffler }
10068e8e04eSSam Leffler 
10182c990a4SSam Leffler static const struct ieee80211_roamparam defroam[IEEE80211_MODE_MAX] = {
10282c990a4SSam Leffler 	[IEEE80211_MODE_11A]	= { .rssi = ROAM_RSSI_11A_DEFAULT,
10382c990a4SSam Leffler 				    .rate = ROAM_RATE_11A_DEFAULT },
10482c990a4SSam Leffler 	[IEEE80211_MODE_11G]	= { .rssi = ROAM_RSSI_11B_DEFAULT,
10582c990a4SSam Leffler 				    .rate = ROAM_RATE_11B_DEFAULT },
10682c990a4SSam Leffler 	[IEEE80211_MODE_11B]	= { .rssi = ROAM_RSSI_11BONLY_DEFAULT,
10782c990a4SSam Leffler 				    .rate = ROAM_RATE_11BONLY_DEFAULT },
10882c990a4SSam Leffler 	[IEEE80211_MODE_TURBO_A]= { .rssi = ROAM_RSSI_11A_DEFAULT,
10982c990a4SSam Leffler 				    .rate = ROAM_RATE_11A_DEFAULT },
11082c990a4SSam Leffler 	[IEEE80211_MODE_TURBO_G]= { .rssi = ROAM_RSSI_11A_DEFAULT,
11182c990a4SSam Leffler 				    .rate = ROAM_RATE_11A_DEFAULT },
11282c990a4SSam Leffler 	[IEEE80211_MODE_STURBO_A]={ .rssi = ROAM_RSSI_11A_DEFAULT,
11382c990a4SSam Leffler 				    .rate = ROAM_RATE_11A_DEFAULT },
1146a76ae21SSam Leffler 	[IEEE80211_MODE_HALF]	= { .rssi = ROAM_RSSI_11A_DEFAULT,
1156a76ae21SSam Leffler 				    .rate = ROAM_RATE_HALF_DEFAULT },
1166a76ae21SSam Leffler 	[IEEE80211_MODE_QUARTER]= { .rssi = ROAM_RSSI_11A_DEFAULT,
1176a76ae21SSam Leffler 				    .rate = ROAM_RATE_QUARTER_DEFAULT },
11882c990a4SSam Leffler 	[IEEE80211_MODE_11NA]	= { .rssi = ROAM_RSSI_11A_DEFAULT,
11982c990a4SSam Leffler 				    .rate = ROAM_MCS_11N_DEFAULT },
12082c990a4SSam Leffler 	[IEEE80211_MODE_11NG]	= { .rssi = ROAM_RSSI_11B_DEFAULT,
12182c990a4SSam Leffler 				    .rate = ROAM_MCS_11N_DEFAULT },
122a1dce3c0SAdrian Chadd 	[IEEE80211_MODE_VHT_2GHZ]	= { .rssi = ROAM_RSSI_11B_DEFAULT,
123a1dce3c0SAdrian Chadd 				    .rate = ROAM_MCS_11AC_DEFAULT },
124a1dce3c0SAdrian Chadd 	[IEEE80211_MODE_VHT_5GHZ]	= { .rssi = ROAM_RSSI_11A_DEFAULT,
125a1dce3c0SAdrian Chadd 				    .rate = ROAM_MCS_11AC_DEFAULT },
126a1dce3c0SAdrian Chadd 
12782c990a4SSam Leffler };
128b032f27cSSam Leffler 
129b032f27cSSam Leffler void
130b032f27cSSam Leffler ieee80211_scan_vattach(struct ieee80211vap *vap)
131b032f27cSSam Leffler {
132f7f155faSAdrian Chadd 	struct ieee80211com *ic = vap->iv_ic;
133f7f155faSAdrian Chadd 
134b032f27cSSam Leffler 	vap->iv_bgscanidle = (IEEE80211_BGSCAN_IDLE_DEFAULT*1000)/hz;
135b032f27cSSam Leffler 	vap->iv_bgscanintvl = IEEE80211_BGSCAN_INTVAL_DEFAULT*hz;
136b032f27cSSam Leffler 	vap->iv_scanvalid = IEEE80211_SCAN_VALID_DEFAULT*hz;
137b032f27cSSam Leffler 
138b032f27cSSam Leffler 	vap->iv_roaming = IEEE80211_ROAMING_AUTO;
13982c990a4SSam Leffler 	memcpy(vap->iv_roamparms, defroam, sizeof(defroam));
140cc6dd788SAdrian Chadd 
141f7f155faSAdrian Chadd 	ic->ic_scan_methods->sc_vattach(vap);
142b032f27cSSam Leffler }
143b032f27cSSam Leffler 
144b032f27cSSam Leffler void
145b032f27cSSam Leffler ieee80211_scan_vdetach(struct ieee80211vap *vap)
146b032f27cSSam Leffler {
147b032f27cSSam Leffler 	struct ieee80211com *ic = vap->iv_ic;
148b032f27cSSam Leffler 	struct ieee80211_scan_state *ss;
149b032f27cSSam Leffler 
150b032f27cSSam Leffler 	IEEE80211_LOCK(ic);
151b032f27cSSam Leffler 	ss = ic->ic_scan;
152cc6dd788SAdrian Chadd 
153f7f155faSAdrian Chadd 	ic->ic_scan_methods->sc_vdetach(vap);
154cc6dd788SAdrian Chadd 
155b032f27cSSam Leffler 	if (ss != NULL && ss->ss_vap == vap) {
156b032f27cSSam Leffler 		if (ss->ss_ops != NULL) {
157b032f27cSSam Leffler 			ss->ss_ops->scan_detach(ss);
158b032f27cSSam Leffler 			ss->ss_ops = NULL;
159b032f27cSSam Leffler 		}
160b032f27cSSam Leffler 		ss->ss_vap = NULL;
161b032f27cSSam Leffler 	}
162b032f27cSSam Leffler 	IEEE80211_UNLOCK(ic);
163b032f27cSSam Leffler }
164b032f27cSSam Leffler 
16568e8e04eSSam Leffler /*
16668e8e04eSSam Leffler  * Simple-minded scanner module support.
16768e8e04eSSam Leffler  */
168b032f27cSSam Leffler static const char *scan_modnames[IEEE80211_OPMODE_MAX] = {
16968e8e04eSSam Leffler 	"wlan_scan_sta",	/* IEEE80211_M_IBSS */
17068e8e04eSSam Leffler 	"wlan_scan_sta",	/* IEEE80211_M_STA */
17168e8e04eSSam Leffler 	"wlan_scan_wds",	/* IEEE80211_M_WDS */
17268e8e04eSSam Leffler 	"wlan_scan_sta",	/* IEEE80211_M_AHDEMO */
17368e8e04eSSam Leffler 	"wlan_scan_ap",		/* IEEE80211_M_HOSTAP */
17468e8e04eSSam Leffler 	"wlan_scan_monitor",	/* IEEE80211_M_MONITOR */
17559aa14a9SRui Paulo 	"wlan_scan_sta",	/* IEEE80211_M_MBSS */
17668e8e04eSSam Leffler };
177b032f27cSSam Leffler static const struct ieee80211_scanner *scanners[IEEE80211_OPMODE_MAX];
17868e8e04eSSam Leffler 
17968e8e04eSSam Leffler const struct ieee80211_scanner *
18068e8e04eSSam Leffler ieee80211_scanner_get(enum ieee80211_opmode mode)
18168e8e04eSSam Leffler {
182b032f27cSSam Leffler 	if (mode >= IEEE80211_OPMODE_MAX)
18368e8e04eSSam Leffler 		return NULL;
184b032f27cSSam Leffler 	if (scanners[mode] == NULL)
18568e8e04eSSam Leffler 		ieee80211_load_module(scan_modnames[mode]);
18668e8e04eSSam Leffler 	return scanners[mode];
18768e8e04eSSam Leffler }
18868e8e04eSSam Leffler 
18968e8e04eSSam Leffler void
19068e8e04eSSam Leffler ieee80211_scanner_register(enum ieee80211_opmode mode,
19168e8e04eSSam Leffler 	const struct ieee80211_scanner *scan)
19268e8e04eSSam Leffler {
193b032f27cSSam Leffler 	if (mode >= IEEE80211_OPMODE_MAX)
19468e8e04eSSam Leffler 		return;
19568e8e04eSSam Leffler 	scanners[mode] = scan;
19668e8e04eSSam Leffler }
19768e8e04eSSam Leffler 
19868e8e04eSSam Leffler void
19968e8e04eSSam Leffler ieee80211_scanner_unregister(enum ieee80211_opmode mode,
20068e8e04eSSam Leffler 	const struct ieee80211_scanner *scan)
20168e8e04eSSam Leffler {
202b032f27cSSam Leffler 	if (mode >= IEEE80211_OPMODE_MAX)
20368e8e04eSSam Leffler 		return;
20468e8e04eSSam Leffler 	if (scanners[mode] == scan)
20568e8e04eSSam Leffler 		scanners[mode] = NULL;
20668e8e04eSSam Leffler }
20768e8e04eSSam Leffler 
20868e8e04eSSam Leffler void
20968e8e04eSSam Leffler ieee80211_scanner_unregister_all(const struct ieee80211_scanner *scan)
21068e8e04eSSam Leffler {
21168e8e04eSSam Leffler 	int m;
21268e8e04eSSam Leffler 
213b032f27cSSam Leffler 	for (m = 0; m < IEEE80211_OPMODE_MAX; m++)
21468e8e04eSSam Leffler 		if (scanners[m] == scan)
21568e8e04eSSam Leffler 			scanners[m] = NULL;
21668e8e04eSSam Leffler }
21768e8e04eSSam Leffler 
21868e8e04eSSam Leffler /*
21968e8e04eSSam Leffler  * Update common scanner state to reflect the current
22068e8e04eSSam Leffler  * operating mode.  This is called when the state machine
22168e8e04eSSam Leffler  * is transitioned to RUN state w/o scanning--e.g. when
22268e8e04eSSam Leffler  * operating in monitor mode.  The purpose of this is to
22368e8e04eSSam Leffler  * ensure later callbacks find ss_ops set to properly
22468e8e04eSSam Leffler  * reflect current operating mode.
22568e8e04eSSam Leffler  */
226cc6dd788SAdrian Chadd void
227cc6dd788SAdrian Chadd ieee80211_scan_update_locked(struct ieee80211vap *vap,
228b032f27cSSam Leffler 	const struct ieee80211_scanner *scan)
22968e8e04eSSam Leffler {
230b032f27cSSam Leffler 	struct ieee80211com *ic = vap->iv_ic;
23168e8e04eSSam Leffler 	struct ieee80211_scan_state *ss = ic->ic_scan;
23268e8e04eSSam Leffler 
233b032f27cSSam Leffler 	IEEE80211_LOCK_ASSERT(ic);
234b032f27cSSam Leffler 
235b032f27cSSam Leffler #ifdef IEEE80211_DEBUG
236b032f27cSSam Leffler 	if (ss->ss_vap != vap || ss->ss_ops != scan) {
237b032f27cSSam Leffler 		IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN,
238b032f27cSSam Leffler 		    "%s: current scanner is <%s:%s>, switch to <%s:%s>\n",
239b032f27cSSam Leffler 		    __func__,
240b032f27cSSam Leffler 		    ss->ss_vap != NULL ?
241b032f27cSSam Leffler 			ss->ss_vap->iv_ifp->if_xname : "none",
242b032f27cSSam Leffler 		    ss->ss_vap != NULL ?
243b032f27cSSam Leffler 			ieee80211_opmode_name[ss->ss_vap->iv_opmode] : "none",
244b032f27cSSam Leffler 		    vap->iv_ifp->if_xname,
245b032f27cSSam Leffler 		    ieee80211_opmode_name[vap->iv_opmode]);
24668e8e04eSSam Leffler 	}
247b032f27cSSam Leffler #endif
248b032f27cSSam Leffler 	ss->ss_vap = vap;
24968e8e04eSSam Leffler 	if (ss->ss_ops != scan) {
250b032f27cSSam Leffler 		/*
251b032f27cSSam Leffler 		 * Switch scanners; detach old, attach new.  Special
252b032f27cSSam Leffler 		 * case where a single scan module implements multiple
253b032f27cSSam Leffler 		 * policies by using different scan ops but a common
254b032f27cSSam Leffler 		 * core.  We assume if the old and new attach methods
255b032f27cSSam Leffler 		 * are identical then it's ok to just change ss_ops
256b032f27cSSam Leffler 		 * and not flush the internal state of the module.
257b032f27cSSam Leffler 		 */
258b032f27cSSam Leffler 		if (scan == NULL || ss->ss_ops == NULL ||
259b032f27cSSam Leffler 		    ss->ss_ops->scan_attach != scan->scan_attach) {
26068e8e04eSSam Leffler 			if (ss->ss_ops != NULL)
26168e8e04eSSam Leffler 				ss->ss_ops->scan_detach(ss);
26268e8e04eSSam Leffler 			if (scan != NULL && !scan->scan_attach(ss)) {
26368e8e04eSSam Leffler 				/* XXX attach failure */
26468e8e04eSSam Leffler 				/* XXX stat+msg */
265b032f27cSSam Leffler 				scan = NULL;
266b032f27cSSam Leffler 			}
267b032f27cSSam Leffler 		}
26868e8e04eSSam Leffler 		ss->ss_ops = scan;
26968e8e04eSSam Leffler 	}
27068e8e04eSSam Leffler }
27168e8e04eSSam Leffler 
27268e8e04eSSam Leffler void
27368e8e04eSSam Leffler ieee80211_scan_dump_channels(const struct ieee80211_scan_state *ss)
27468e8e04eSSam Leffler {
2755efea30fSAndrew Thompson 	struct ieee80211com *ic = ss->ss_ic;
27668e8e04eSSam Leffler 	const char *sep;
27768e8e04eSSam Leffler 	int i;
27868e8e04eSSam Leffler 
27968e8e04eSSam Leffler 	sep = "";
28068e8e04eSSam Leffler 	for (i = ss->ss_next; i < ss->ss_last; i++) {
28168e8e04eSSam Leffler 		const struct ieee80211_channel *c = ss->ss_chans[i];
28268e8e04eSSam Leffler 
28368e8e04eSSam Leffler 		printf("%s%u%c", sep, ieee80211_chan2ieee(ic, c),
284a1cbd043SAdrian Chadd 		    ieee80211_channel_type_char(c));
28568e8e04eSSam Leffler 		sep = ", ";
28668e8e04eSSam Leffler 	}
28768e8e04eSSam Leffler }
28868e8e04eSSam Leffler 
289b032f27cSSam Leffler #ifdef IEEE80211_DEBUG
290cc6dd788SAdrian Chadd void
291cc6dd788SAdrian Chadd ieee80211_scan_dump(struct ieee80211_scan_state *ss)
292b032f27cSSam Leffler {
293b032f27cSSam Leffler 	struct ieee80211vap *vap = ss->ss_vap;
294b032f27cSSam Leffler 
295b032f27cSSam Leffler 	if_printf(vap->iv_ifp, "scan set ");
296b032f27cSSam Leffler 	ieee80211_scan_dump_channels(ss);
297*9df9e936SAndriy Voskoboinyk 	printf(" dwell min %ums max %ums\n",
298110a70e3SSam Leffler 	    ticks_to_msecs(ss->ss_mindwell), ticks_to_msecs(ss->ss_maxdwell));
299b032f27cSSam Leffler }
300b032f27cSSam Leffler #endif /* IEEE80211_DEBUG */
301b032f27cSSam Leffler 
302cc6dd788SAdrian Chadd void
303cc6dd788SAdrian Chadd ieee80211_scan_copy_ssid(struct ieee80211vap *vap, struct ieee80211_scan_state *ss,
30468e8e04eSSam Leffler 	int nssid, const struct ieee80211_scan_ssid ssids[])
30568e8e04eSSam Leffler {
30668e8e04eSSam Leffler 	if (nssid > IEEE80211_SCAN_MAX_SSID) {
30768e8e04eSSam Leffler 		/* XXX printf */
308b032f27cSSam Leffler 		IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN,
30968e8e04eSSam Leffler 		    "%s: too many ssid %d, ignoring all of them\n",
31068e8e04eSSam Leffler 		    __func__, nssid);
31168e8e04eSSam Leffler 		return;
31268e8e04eSSam Leffler 	}
31368e8e04eSSam Leffler 	memcpy(ss->ss_ssid, ssids, nssid * sizeof(ssids[0]));
31468e8e04eSSam Leffler 	ss->ss_nssid = nssid;
31568e8e04eSSam Leffler }
31668e8e04eSSam Leffler 
31768e8e04eSSam Leffler /*
31868e8e04eSSam Leffler  * Start a scan unless one is already going.
31968e8e04eSSam Leffler  */
320cc6dd788SAdrian Chadd int
321b032f27cSSam Leffler ieee80211_start_scan(struct ieee80211vap *vap, int flags,
322b032f27cSSam Leffler 	u_int duration, u_int mindwell, u_int maxdwell,
323b032f27cSSam Leffler 	u_int nssid, const struct ieee80211_scan_ssid ssids[])
324b032f27cSSam Leffler {
325b032f27cSSam Leffler 	const struct ieee80211_scanner *scan;
326f7f155faSAdrian Chadd 	struct ieee80211com *ic = vap->iv_ic;
327b032f27cSSam Leffler 
328b032f27cSSam Leffler 	scan = ieee80211_scanner_get(vap->iv_opmode);
329b032f27cSSam Leffler 	if (scan == NULL) {
330b032f27cSSam Leffler 		IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN,
331b032f27cSSam Leffler 		    "%s: no scanner support for %s mode\n",
332b032f27cSSam Leffler 		    __func__, ieee80211_opmode_name[vap->iv_opmode]);
333b032f27cSSam Leffler 		/* XXX stat */
334b032f27cSSam Leffler 		return 0;
335b032f27cSSam Leffler 	}
336b032f27cSSam Leffler 
337f7f155faSAdrian Chadd 	return ic->ic_scan_methods->sc_start_scan(scan, vap, flags, duration,
338b032f27cSSam Leffler 	    mindwell, maxdwell, nssid, ssids);
33968e8e04eSSam Leffler }
34068e8e04eSSam Leffler 
34168e8e04eSSam Leffler /*
34268e8e04eSSam Leffler  * Check the scan cache for an ap/channel to use; if that
34368e8e04eSSam Leffler  * fails then kick off a new scan.
34468e8e04eSSam Leffler  */
34568e8e04eSSam Leffler int
346b032f27cSSam Leffler ieee80211_check_scan(struct ieee80211vap *vap, int flags,
347b032f27cSSam Leffler 	u_int duration, u_int mindwell, u_int maxdwell,
34868e8e04eSSam Leffler 	u_int nssid, const struct ieee80211_scan_ssid ssids[])
34968e8e04eSSam Leffler {
350b032f27cSSam Leffler 	struct ieee80211com *ic = vap->iv_ic;
35168e8e04eSSam Leffler 	struct ieee80211_scan_state *ss = ic->ic_scan;
352b032f27cSSam Leffler 	const struct ieee80211_scanner *scan;
353aa0fbc73SSam Leffler 	int result;
354b032f27cSSam Leffler 
355b032f27cSSam Leffler 	scan = ieee80211_scanner_get(vap->iv_opmode);
356b032f27cSSam Leffler 	if (scan == NULL) {
357b032f27cSSam Leffler 		IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN,
358b032f27cSSam Leffler 		    "%s: no scanner support for %s mode\n",
359b032f27cSSam Leffler 		    __func__, vap->iv_opmode);
360b032f27cSSam Leffler 		/* XXX stat */
361b032f27cSSam Leffler 		return 0;
362b032f27cSSam Leffler 	}
36368e8e04eSSam Leffler 
36468e8e04eSSam Leffler 	/*
36568e8e04eSSam Leffler 	 * Check if there's a list of scan candidates already.
36668e8e04eSSam Leffler 	 * XXX want more than the ap we're currently associated with
36768e8e04eSSam Leffler 	 */
36868e8e04eSSam Leffler 
36968e8e04eSSam Leffler 	IEEE80211_LOCK(ic);
370b032f27cSSam Leffler 	IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN,
371b032f27cSSam Leffler 	    "%s: %s scan, %s%s%s%s%s\n"
37268e8e04eSSam Leffler 	    , __func__
37368e8e04eSSam Leffler 	    , flags & IEEE80211_SCAN_ACTIVE ? "active" : "passive"
37468e8e04eSSam Leffler 	    , flags & IEEE80211_SCAN_FLUSH ? "flush" : "append"
37568e8e04eSSam Leffler 	    , flags & IEEE80211_SCAN_NOPICK ? ", nopick" : ""
376b032f27cSSam Leffler 	    , flags & IEEE80211_SCAN_NOJOIN ? ", nojoin" : ""
37768e8e04eSSam Leffler 	    , flags & IEEE80211_SCAN_PICK1ST ? ", pick1st" : ""
37868e8e04eSSam Leffler 	    , flags & IEEE80211_SCAN_ONCE ? ", once" : ""
37968e8e04eSSam Leffler 	);
38068e8e04eSSam Leffler 
381b032f27cSSam Leffler 	if (ss->ss_ops != scan) {
382b032f27cSSam Leffler 		/* XXX re-use cache contents? e.g. adhoc<->sta */
383b032f27cSSam Leffler 		flags |= IEEE80211_SCAN_FLUSH;
384b032f27cSSam Leffler 	}
385aa0fbc73SSam Leffler 
386cc6dd788SAdrian Chadd 	/*
387cc6dd788SAdrian Chadd 	 * XXX TODO: separate things out a bit better.
388cc6dd788SAdrian Chadd 	 */
389cc6dd788SAdrian Chadd 	ieee80211_scan_update_locked(vap, scan);
390aa0fbc73SSam Leffler 
391f7f155faSAdrian Chadd 	result = ic->ic_scan_methods->sc_check_scan(scan, vap, flags, duration,
392b032f27cSSam Leffler 	    mindwell, maxdwell, nssid, ssids);
393cc6dd788SAdrian Chadd 
394b032f27cSSam Leffler 	IEEE80211_UNLOCK(ic);
395b032f27cSSam Leffler 
396cc6dd788SAdrian Chadd 	return (result);
397b032f27cSSam Leffler }
398b032f27cSSam Leffler 
399b032f27cSSam Leffler /*
400b032f27cSSam Leffler  * Check the scan cache for an ap/channel to use; if that fails
401b032f27cSSam Leffler  * then kick off a scan using the current settings.
402b032f27cSSam Leffler  */
403b032f27cSSam Leffler int
404b032f27cSSam Leffler ieee80211_check_scan_current(struct ieee80211vap *vap)
405b032f27cSSam Leffler {
406b032f27cSSam Leffler 	return ieee80211_check_scan(vap,
407b032f27cSSam Leffler 	    IEEE80211_SCAN_ACTIVE,
408b032f27cSSam Leffler 	    IEEE80211_SCAN_FOREVER, 0, 0,
409b032f27cSSam Leffler 	    vap->iv_des_nssid, vap->iv_des_ssid);
41068e8e04eSSam Leffler }
41168e8e04eSSam Leffler 
41268e8e04eSSam Leffler /*
41368e8e04eSSam Leffler  * Restart a previous scan.  If the previous scan completed
41468e8e04eSSam Leffler  * then we start again using the existing channel list.
41568e8e04eSSam Leffler  */
41668e8e04eSSam Leffler int
417b032f27cSSam Leffler ieee80211_bg_scan(struct ieee80211vap *vap, int flags)
41868e8e04eSSam Leffler {
419f7f155faSAdrian Chadd 	struct ieee80211com *ic = vap->iv_ic;
420b032f27cSSam Leffler 	const struct ieee80211_scanner *scan;
421b032f27cSSam Leffler 
422cc6dd788SAdrian Chadd 	// IEEE80211_UNLOCK_ASSERT(sc);
423cc6dd788SAdrian Chadd 
424b032f27cSSam Leffler 	scan = ieee80211_scanner_get(vap->iv_opmode);
425b032f27cSSam Leffler 	if (scan == NULL) {
426b032f27cSSam Leffler 		IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN,
427b032f27cSSam Leffler 		    "%s: no scanner support for %s mode\n",
428b032f27cSSam Leffler 		    __func__, vap->iv_opmode);
429b032f27cSSam Leffler 		/* XXX stat */
430b032f27cSSam Leffler 		return 0;
431b032f27cSSam Leffler 	}
43268e8e04eSSam Leffler 
43368e8e04eSSam Leffler 	/*
434cc6dd788SAdrian Chadd 	 * XXX TODO: pull apart the bgscan logic into whatever
435cc6dd788SAdrian Chadd 	 * belongs here and whatever belongs in the software
436cc6dd788SAdrian Chadd 	 * scanner.
43768e8e04eSSam Leffler 	 */
438f7f155faSAdrian Chadd 	return (ic->ic_scan_methods->sc_bg_scan(scan, vap, flags));
43968e8e04eSSam Leffler }
44068e8e04eSSam Leffler 
44168e8e04eSSam Leffler /*
442b032f27cSSam Leffler  * Cancel any scan currently going on for the specified vap.
443b032f27cSSam Leffler  */
444b032f27cSSam Leffler void
445b032f27cSSam Leffler ieee80211_cancel_scan(struct ieee80211vap *vap)
446b032f27cSSam Leffler {
447f7f155faSAdrian Chadd 	struct ieee80211com *ic = vap->iv_ic;
448b032f27cSSam Leffler 
449f7f155faSAdrian Chadd 	ic->ic_scan_methods->sc_cancel_scan(vap);
450b032f27cSSam Leffler }
451b032f27cSSam Leffler 
452b032f27cSSam Leffler /*
45368e8e04eSSam Leffler  * Cancel any scan currently going on.
454f6c2cdb1SAdrian Chadd  *
455f6c2cdb1SAdrian Chadd  * This is called during normal 802.11 data path to cancel
456f6c2cdb1SAdrian Chadd  * a scan so a newly arrived normal data packet can be sent.
45768e8e04eSSam Leffler  */
45868e8e04eSSam Leffler void
459b032f27cSSam Leffler ieee80211_cancel_anyscan(struct ieee80211vap *vap)
46068e8e04eSSam Leffler {
461f7f155faSAdrian Chadd 	struct ieee80211com *ic = vap->iv_ic;
46268e8e04eSSam Leffler 
463f7f155faSAdrian Chadd 	ic->ic_scan_methods->sc_cancel_anyscan(vap);
46468e8e04eSSam Leffler }
46568e8e04eSSam Leffler 
46668e8e04eSSam Leffler /*
4678a9508c0SAndriy Voskoboinyk  * Manually switch to the next channel in the channel list.
4688a9508c0SAndriy Voskoboinyk  * Provided for drivers that manage scanning themselves
4698a9508c0SAndriy Voskoboinyk  * (e.g. for firmware-based devices).
47068e8e04eSSam Leffler  */
47168e8e04eSSam Leffler void
472b032f27cSSam Leffler ieee80211_scan_next(struct ieee80211vap *vap)
47368e8e04eSSam Leffler {
474f7f155faSAdrian Chadd 	struct ieee80211com *ic = vap->iv_ic;
475b032f27cSSam Leffler 
476f7f155faSAdrian Chadd 	ic->ic_scan_methods->sc_scan_next(vap);
47768e8e04eSSam Leffler }
47868e8e04eSSam Leffler 
47968e8e04eSSam Leffler /*
4808a9508c0SAndriy Voskoboinyk  * Manually stop a scan that is currently running.
4818a9508c0SAndriy Voskoboinyk  * Provided for drivers that are not able to scan single channels
4828a9508c0SAndriy Voskoboinyk  * (e.g. for firmware-based devices).
483d81b3a55SAndrew Thompson  */
484d81b3a55SAndrew Thompson void
485b032f27cSSam Leffler ieee80211_scan_done(struct ieee80211vap *vap)
486d81b3a55SAndrew Thompson {
487b032f27cSSam Leffler 	struct ieee80211com *ic = vap->iv_ic;
488b032f27cSSam Leffler 	struct ieee80211_scan_state *ss;
489d81b3a55SAndrew Thompson 
4902c617940SAdrian Chadd 	IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN, "%s: called\n", __func__);
4912c617940SAdrian Chadd 
492b032f27cSSam Leffler 	IEEE80211_LOCK(ic);
493b032f27cSSam Leffler 	ss = ic->ic_scan;
494d81b3a55SAndrew Thompson 	ss->ss_next = ss->ss_last; /* all channels are complete */
495cc6dd788SAdrian Chadd 
496f7f155faSAdrian Chadd 	ic->ic_scan_methods->sc_scan_done(vap);
497cc6dd788SAdrian Chadd 
498b032f27cSSam Leffler 	IEEE80211_UNLOCK(ic);
499b032f27cSSam Leffler }
500b032f27cSSam Leffler 
501b032f27cSSam Leffler /*
5028a9508c0SAndriy Voskoboinyk  * Probe the current channel, if allowed, while scanning.
503b032f27cSSam Leffler  * If the channel is not marked passive-only then send
504b032f27cSSam Leffler  * a probe request immediately.  Otherwise mark state and
505b032f27cSSam Leffler  * listen for beacons on the channel; if we receive something
506b032f27cSSam Leffler  * then we'll transmit a probe request.
507b032f27cSSam Leffler  */
508b032f27cSSam Leffler void
509b032f27cSSam Leffler ieee80211_probe_curchan(struct ieee80211vap *vap, int force)
510b032f27cSSam Leffler {
511b032f27cSSam Leffler 	struct ieee80211com *ic = vap->iv_ic;
512b032f27cSSam Leffler 
513b032f27cSSam Leffler 	if ((ic->ic_curchan->ic_flags & IEEE80211_CHAN_PASSIVE) && !force) {
514b032f27cSSam Leffler 		ic->ic_flags_ext |= IEEE80211_FEXT_PROBECHAN;
515b032f27cSSam Leffler 		return;
516b032f27cSSam Leffler 	}
517d81b3a55SAndrew Thompson 
518f7f155faSAdrian Chadd 	ic->ic_scan_methods->sc_scan_probe_curchan(vap, force);
51968e8e04eSSam Leffler }
52068e8e04eSSam Leffler 
52168e8e04eSSam Leffler #ifdef IEEE80211_DEBUG
52268e8e04eSSam Leffler static void
523b032f27cSSam Leffler dump_country(const uint8_t *ie)
524b032f27cSSam Leffler {
525b032f27cSSam Leffler 	const struct ieee80211_country_ie *cie =
526b032f27cSSam Leffler 	   (const struct ieee80211_country_ie *) ie;
527b032f27cSSam Leffler 	int i, nbands, schan, nchan;
528b032f27cSSam Leffler 
529b032f27cSSam Leffler 	if (cie->len < 3) {
530b032f27cSSam Leffler 		printf(" <bogus country ie, len %d>", cie->len);
531b032f27cSSam Leffler 		return;
532b032f27cSSam Leffler 	}
533b032f27cSSam Leffler 	printf(" country [%c%c%c", cie->cc[0], cie->cc[1], cie->cc[2]);
534b032f27cSSam Leffler 	nbands = (cie->len - 3) / sizeof(cie->band[0]);
535b032f27cSSam Leffler 	for (i = 0; i < nbands; i++) {
536b032f27cSSam Leffler 		schan = cie->band[i].schan;
537b032f27cSSam Leffler 		nchan = cie->band[i].nchan;
538b032f27cSSam Leffler 		if (nchan != 1)
539b032f27cSSam Leffler 			printf(" %u-%u,%u", schan, schan + nchan-1,
540b032f27cSSam Leffler 			    cie->band[i].maxtxpwr);
541b032f27cSSam Leffler 		else
542b032f27cSSam Leffler 			printf(" %u,%u", schan, cie->band[i].maxtxpwr);
543b032f27cSSam Leffler 	}
544b032f27cSSam Leffler 	printf("]");
545b032f27cSSam Leffler }
546b032f27cSSam Leffler 
547cc6dd788SAdrian Chadd void
548cc6dd788SAdrian Chadd ieee80211_scan_dump_probe_beacon(uint8_t subtype, int isnew,
54968e8e04eSSam Leffler 	const uint8_t mac[IEEE80211_ADDR_LEN],
550b032f27cSSam Leffler 	const struct ieee80211_scanparams *sp, int rssi)
55168e8e04eSSam Leffler {
55268e8e04eSSam Leffler 
55368e8e04eSSam Leffler 	printf("[%s] %s%s on chan %u (bss chan %u) ",
55468e8e04eSSam Leffler 	    ether_sprintf(mac), isnew ? "new " : "",
5554357a5d1SAndriy Voskoboinyk 	    ieee80211_mgt_subtype_name(subtype), sp->chan, sp->bchan);
55668e8e04eSSam Leffler 	ieee80211_print_essid(sp->ssid + 2, sp->ssid[1]);
557b032f27cSSam Leffler 	printf(" rssi %d\n", rssi);
55868e8e04eSSam Leffler 
55968e8e04eSSam Leffler 	if (isnew) {
56068e8e04eSSam Leffler 		printf("[%s] caps 0x%x bintval %u erp 0x%x",
56168e8e04eSSam Leffler 			ether_sprintf(mac), sp->capinfo, sp->bintval, sp->erp);
562b032f27cSSam Leffler 		if (sp->country != NULL)
563b032f27cSSam Leffler 			dump_country(sp->country);
56468e8e04eSSam Leffler 		printf("\n");
56568e8e04eSSam Leffler 	}
56668e8e04eSSam Leffler }
56768e8e04eSSam Leffler #endif /* IEEE80211_DEBUG */
56868e8e04eSSam Leffler 
56968e8e04eSSam Leffler /*
57068e8e04eSSam Leffler  * Process a beacon or probe response frame.
57168e8e04eSSam Leffler  */
57268e8e04eSSam Leffler void
573b032f27cSSam Leffler ieee80211_add_scan(struct ieee80211vap *vap,
5742808a02bSAdrian Chadd 	struct ieee80211_channel *curchan,
57568e8e04eSSam Leffler 	const struct ieee80211_scanparams *sp,
57668e8e04eSSam Leffler 	const struct ieee80211_frame *wh,
5775463c4a4SSam Leffler 	int subtype, int rssi, int noise)
57868e8e04eSSam Leffler {
579f7f155faSAdrian Chadd 	struct ieee80211com *ic = vap->iv_ic;
58068e8e04eSSam Leffler 
581f7f155faSAdrian Chadd 	return (ic->ic_scan_methods->sc_add_scan(vap, curchan, sp, wh, subtype,
5822808a02bSAdrian Chadd 	    rssi, noise));
58368e8e04eSSam Leffler }
58468e8e04eSSam Leffler 
58568e8e04eSSam Leffler /*
58668e8e04eSSam Leffler  * Timeout/age scan cache entries; called from sta timeout
58768e8e04eSSam Leffler  * timer (XXX should be self-contained).
58868e8e04eSSam Leffler  */
58968e8e04eSSam Leffler void
59068e8e04eSSam Leffler ieee80211_scan_timeout(struct ieee80211com *ic)
59168e8e04eSSam Leffler {
59268e8e04eSSam Leffler 	struct ieee80211_scan_state *ss = ic->ic_scan;
59368e8e04eSSam Leffler 
59468e8e04eSSam Leffler 	if (ss->ss_ops != NULL)
59568e8e04eSSam Leffler 		ss->ss_ops->scan_age(ss);
59668e8e04eSSam Leffler }
59768e8e04eSSam Leffler 
59868e8e04eSSam Leffler /*
59968e8e04eSSam Leffler  * Mark a scan cache entry after a successful associate.
60068e8e04eSSam Leffler  */
60168e8e04eSSam Leffler void
602b032f27cSSam Leffler ieee80211_scan_assoc_success(struct ieee80211vap *vap, const uint8_t mac[])
60368e8e04eSSam Leffler {
604b032f27cSSam Leffler 	struct ieee80211_scan_state *ss = vap->iv_ic->ic_scan;
60568e8e04eSSam Leffler 
60668e8e04eSSam Leffler 	if (ss->ss_ops != NULL) {
607b032f27cSSam Leffler 		IEEE80211_NOTE_MAC(vap, IEEE80211_MSG_SCAN,
60868e8e04eSSam Leffler 			mac, "%s",  __func__);
60968e8e04eSSam Leffler 		ss->ss_ops->scan_assoc_success(ss, mac);
61068e8e04eSSam Leffler 	}
61168e8e04eSSam Leffler }
61268e8e04eSSam Leffler 
61368e8e04eSSam Leffler /*
61468e8e04eSSam Leffler  * Demerit a scan cache entry after failing to associate.
61568e8e04eSSam Leffler  */
61668e8e04eSSam Leffler void
617b032f27cSSam Leffler ieee80211_scan_assoc_fail(struct ieee80211vap *vap,
61868e8e04eSSam Leffler 	const uint8_t mac[], int reason)
61968e8e04eSSam Leffler {
620b032f27cSSam Leffler 	struct ieee80211_scan_state *ss = vap->iv_ic->ic_scan;
62168e8e04eSSam Leffler 
62268e8e04eSSam Leffler 	if (ss->ss_ops != NULL) {
623b032f27cSSam Leffler 		IEEE80211_NOTE_MAC(vap, IEEE80211_MSG_SCAN, mac,
62468e8e04eSSam Leffler 			"%s: reason %u", __func__, reason);
62568e8e04eSSam Leffler 		ss->ss_ops->scan_assoc_fail(ss, mac, reason);
62668e8e04eSSam Leffler 	}
62768e8e04eSSam Leffler }
62868e8e04eSSam Leffler 
62968e8e04eSSam Leffler /*
63068e8e04eSSam Leffler  * Iterate over the contents of the scan cache.
63168e8e04eSSam Leffler  */
63268e8e04eSSam Leffler void
633b032f27cSSam Leffler ieee80211_scan_iterate(struct ieee80211vap *vap,
63468e8e04eSSam Leffler 	ieee80211_scan_iter_func *f, void *arg)
63568e8e04eSSam Leffler {
636b032f27cSSam Leffler 	struct ieee80211_scan_state *ss = vap->iv_ic->ic_scan;
63768e8e04eSSam Leffler 
63868e8e04eSSam Leffler 	if (ss->ss_ops != NULL)
63968e8e04eSSam Leffler 		ss->ss_ops->scan_iterate(ss, f, arg);
64068e8e04eSSam Leffler }
64168e8e04eSSam Leffler 
64268e8e04eSSam Leffler /*
64368e8e04eSSam Leffler  * Flush the contents of the scan cache.
64468e8e04eSSam Leffler  */
64568e8e04eSSam Leffler void
646b032f27cSSam Leffler ieee80211_scan_flush(struct ieee80211vap *vap)
647b032f27cSSam Leffler {
648b032f27cSSam Leffler 	struct ieee80211_scan_state *ss = vap->iv_ic->ic_scan;
649b032f27cSSam Leffler 
650b032f27cSSam Leffler 	if (ss->ss_ops != NULL && ss->ss_vap == vap) {
651b032f27cSSam Leffler 		IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN, "%s\n",  __func__);
652b032f27cSSam Leffler 		ss->ss_ops->scan_flush(ss);
653b032f27cSSam Leffler 	}
654b032f27cSSam Leffler }
655b032f27cSSam Leffler 
656b032f27cSSam Leffler /*
657b032f27cSSam Leffler  * Check the scan cache for an ap/channel to use; if that
658b032f27cSSam Leffler  * fails then kick off a new scan.
659b032f27cSSam Leffler  */
660b032f27cSSam Leffler struct ieee80211_channel *
661b032f27cSSam Leffler ieee80211_scan_pickchannel(struct ieee80211com *ic, int flags)
66268e8e04eSSam Leffler {
66368e8e04eSSam Leffler 	struct ieee80211_scan_state *ss = ic->ic_scan;
66468e8e04eSSam Leffler 
665b032f27cSSam Leffler 	IEEE80211_LOCK_ASSERT(ic);
666b032f27cSSam Leffler 
667b032f27cSSam Leffler 	if (ss == NULL || ss->ss_ops == NULL || ss->ss_vap == NULL) {
668b032f27cSSam Leffler 		/* XXX printf? */
669b032f27cSSam Leffler 		return NULL;
67068e8e04eSSam Leffler 	}
671b032f27cSSam Leffler 	if (ss->ss_ops->scan_pickchan == NULL) {
672b032f27cSSam Leffler 		IEEE80211_DPRINTF(ss->ss_vap, IEEE80211_MSG_SCAN,
673b032f27cSSam Leffler 		    "%s: scan module does not support picking a channel, "
674b032f27cSSam Leffler 		    "opmode %s\n", __func__, ss->ss_vap->iv_opmode);
675b032f27cSSam Leffler 		return NULL;
676b032f27cSSam Leffler 	}
677b032f27cSSam Leffler 	return ss->ss_ops->scan_pickchan(ss, flags);
67868e8e04eSSam Leffler }
679