ieee80211_scan_sta.c revision 224717
1170530Ssam/*-
2186904Ssam * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
3170530Ssam * All rights reserved.
4170530Ssam *
5170530Ssam * Redistribution and use in source and binary forms, with or without
6170530Ssam * modification, are permitted provided that the following conditions
7170530Ssam * are met:
8170530Ssam * 1. Redistributions of source code must retain the above copyright
9170530Ssam *    notice, this list of conditions and the following disclaimer.
10170530Ssam * 2. Redistributions in binary form must reproduce the above copyright
11170530Ssam *    notice, this list of conditions and the following disclaimer in the
12170530Ssam *    documentation and/or other materials provided with the distribution.
13170530Ssam *
14170530Ssam * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15170530Ssam * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16170530Ssam * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17170530Ssam * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18170530Ssam * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19170530Ssam * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20170530Ssam * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21170530Ssam * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22170530Ssam * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23170530Ssam * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24170530Ssam */
25170530Ssam
26170530Ssam#include <sys/cdefs.h>
27170530Ssam__FBSDID("$FreeBSD: head/sys/net80211/ieee80211_scan_sta.c 224717 2011-08-08 16:29:07Z bschmidt $");
28170530Ssam
29170530Ssam/*
30170530Ssam * IEEE 802.11 station scanning support.
31170530Ssam */
32178354Ssam#include "opt_wlan.h"
33178354Ssam
34170530Ssam#include <sys/param.h>
35191746Sthompsa#include <sys/systm.h>
36170530Ssam#include <sys/kernel.h>
37170530Ssam#include <sys/module.h>
38191746Sthompsa
39170530Ssam#include <sys/socket.h>
40170530Ssam
41170530Ssam#include <net/if.h>
42170530Ssam#include <net/if_media.h>
43170530Ssam#include <net/ethernet.h>
44170530Ssam
45170530Ssam#include <net80211/ieee80211_var.h>
46178354Ssam#include <net80211/ieee80211_input.h>
47178354Ssam#include <net80211/ieee80211_regdomain.h>
48186904Ssam#ifdef IEEE80211_SUPPORT_TDMA
49186904Ssam#include <net80211/ieee80211_tdma.h>
50186904Ssam#endif
51195618Srpaulo#ifdef IEEE80211_SUPPORT_MESH
52195618Srpaulo#include <net80211/ieee80211_mesh.h>
53195618Srpaulo#endif
54170530Ssam
55170530Ssam#include <net/bpf.h>
56170530Ssam
57170530Ssam/*
58170530Ssam * Parameters for managing cache entries:
59170530Ssam *
60170530Ssam * o a station with STA_FAILS_MAX failures is not considered
61170530Ssam *   when picking a candidate
62170530Ssam * o a station that hasn't had an update in STA_PURGE_SCANS
63170530Ssam *   (background) scans is discarded
64170530Ssam * o after STA_FAILS_AGE seconds we clear the failure count
65170530Ssam */
66170530Ssam#define	STA_FAILS_MAX	2		/* assoc failures before ignored */
67170530Ssam#define	STA_FAILS_AGE	(2*60)		/* time before clearing fails (secs) */
68170530Ssam#define	STA_PURGE_SCANS	2		/* age for purging entries (scans) */
69170530Ssam
70170530Ssam/* XXX tunable */
71170530Ssam#define	STA_RSSI_MIN	8		/* min acceptable rssi */
72170530Ssam#define	STA_RSSI_MAX	40		/* max rssi for comparison */
73170530Ssam
74170530Ssamstruct sta_entry {
75170530Ssam	struct ieee80211_scan_entry base;
76170530Ssam	TAILQ_ENTRY(sta_entry) se_list;
77170530Ssam	LIST_ENTRY(sta_entry) se_hash;
78170530Ssam	uint8_t		se_fails;		/* failure to associate count */
79170530Ssam	uint8_t		se_seen;		/* seen during current scan */
80170530Ssam	uint8_t		se_notseen;		/* not seen in previous scans */
81170530Ssam	uint8_t		se_flags;
82184302Ssam#define	STA_DEMOTE11B	0x01			/* match w/ demoted 11b chan */
83170530Ssam	uint32_t	se_avgrssi;		/* LPF rssi state */
84170530Ssam	unsigned long	se_lastupdate;		/* time of last update */
85170530Ssam	unsigned long	se_lastfail;		/* time of last failure */
86170530Ssam	unsigned long	se_lastassoc;		/* time of last association */
87170530Ssam	u_int		se_scangen;		/* iterator scan gen# */
88178354Ssam	u_int		se_countrygen;		/* gen# of last cc notify */
89170530Ssam};
90170530Ssam
91170530Ssam#define	STA_HASHSIZE	32
92170530Ssam/* simple hash is enough for variation of macaddr */
93170530Ssam#define	STA_HASH(addr)	\
94170530Ssam	(((const uint8_t *)(addr))[IEEE80211_ADDR_LEN - 1] % STA_HASHSIZE)
95170530Ssam
96186107Ssam#define	MAX_IEEE_CHAN	256			/* max acceptable IEEE chan # */
97186107SsamCTASSERT(MAX_IEEE_CHAN >= 256);
98186107Ssam
99170530Ssamstruct sta_table {
100206617Srpaulo	ieee80211_scan_table_lock_t st_lock;	/* on scan table */
101170530Ssam	TAILQ_HEAD(, sta_entry) st_entry;	/* all entries */
102170530Ssam	LIST_HEAD(, sta_entry) st_hash[STA_HASHSIZE];
103178354Ssam	struct mtx	st_scanlock;		/* on st_scaniter */
104178354Ssam	u_int		st_scaniter;		/* gen# for iterator */
105178354Ssam	u_int		st_scangen;		/* scan generation # */
106170530Ssam	int		st_newscan;
107178354Ssam	/* ap-related state */
108186107Ssam	int		st_maxrssi[MAX_IEEE_CHAN];
109170530Ssam};
110170530Ssam
111170530Ssamstatic void sta_flush_table(struct sta_table *);
112171409Ssam/*
113171409Ssam * match_bss returns a bitmask describing if an entry is suitable
114171409Ssam * for use.  If non-zero the entry was deemed not suitable and it's
115171409Ssam * contents explains why.  The following flags are or'd to to this
116171409Ssam * mask and can be used to figure out why the entry was rejected.
117171409Ssam */
118195618Srpaulo#define	MATCH_CHANNEL		0x00001	/* channel mismatch */
119195618Srpaulo#define	MATCH_CAPINFO		0x00002	/* capabilities mismatch, e.g. no ess */
120195618Srpaulo#define	MATCH_PRIVACY		0x00004	/* privacy mismatch */
121195618Srpaulo#define	MATCH_RATE		0x00008	/* rate set mismatch */
122195618Srpaulo#define	MATCH_SSID		0x00010	/* ssid mismatch */
123195618Srpaulo#define	MATCH_BSSID		0x00020	/* bssid mismatch */
124195618Srpaulo#define	MATCH_FAILS		0x00040	/* too many failed auth attempts */
125195618Srpaulo#define	MATCH_NOTSEEN		0x00080	/* not seen in recent scans */
126195618Srpaulo#define	MATCH_RSSI		0x00100	/* rssi deemed too low to use */
127195618Srpaulo#define	MATCH_CC		0x00200	/* country code mismatch */
128195618Srpaulo#define	MATCH_TDMA_NOIE		0x00400	/* no TDMA ie */
129195618Srpaulo#define	MATCH_TDMA_NOTMASTER	0x00800	/* not TDMA master */
130195618Srpaulo#define	MATCH_TDMA_NOSLOT	0x01000	/* all TDMA slots occupied */
131195618Srpaulo#define	MATCH_TDMA_LOCAL	0x02000	/* local address */
132195618Srpaulo#define	MATCH_TDMA_VERSION	0x04000	/* protocol version mismatch */
133195618Srpaulo#define	MATCH_MESH_NOID		0x10000	/* no MESHID ie */
134195618Srpaulo#define	MATCH_MESHID		0x20000	/* meshid mismatch */
135178354Ssamstatic int match_bss(struct ieee80211vap *,
136170530Ssam	const struct ieee80211_scan_state *, struct sta_entry *, int);
137178354Ssamstatic void adhoc_age(struct ieee80211_scan_state *);
138170530Ssam
139178354Ssamstatic __inline int
140178354Ssamisocmp(const uint8_t cc1[], const uint8_t cc2[])
141178354Ssam{
142178354Ssam     return (cc1[0] == cc2[0] && cc1[1] == cc2[1]);
143178354Ssam}
144178354Ssam
145170530Ssam/* number of references from net80211 layer */
146170530Ssamstatic	int nrefs = 0;
147195618Srpaulo/*
148195618Srpaulo * Module glue.
149195618Srpaulo */
150195618SrpauloIEEE80211_SCANNER_MODULE(sta, 1);
151170530Ssam
152170530Ssam/*
153170530Ssam * Attach prior to any scanning work.
154170530Ssam */
155170530Ssamstatic int
156170530Ssamsta_attach(struct ieee80211_scan_state *ss)
157170530Ssam{
158170530Ssam	struct sta_table *st;
159170530Ssam
160186302Ssam	st = (struct sta_table *) malloc(sizeof(struct sta_table),
161170530Ssam		M_80211_SCAN, M_NOWAIT | M_ZERO);
162170530Ssam	if (st == NULL)
163170530Ssam		return 0;
164206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK_INIT(st, "scantable");
165170530Ssam	mtx_init(&st->st_scanlock, "scangen", "802.11 scangen", MTX_DEF);
166170530Ssam	TAILQ_INIT(&st->st_entry);
167170530Ssam	ss->ss_priv = st;
168170530Ssam	nrefs++;			/* NB: we assume caller locking */
169170530Ssam	return 1;
170170530Ssam}
171170530Ssam
172170530Ssam/*
173170530Ssam * Cleanup any private state.
174170530Ssam */
175170530Ssamstatic int
176170530Ssamsta_detach(struct ieee80211_scan_state *ss)
177170530Ssam{
178170530Ssam	struct sta_table *st = ss->ss_priv;
179170530Ssam
180170530Ssam	if (st != NULL) {
181170530Ssam		sta_flush_table(st);
182206617Srpaulo		IEEE80211_SCAN_TABLE_LOCK_DESTROY(st);
183170530Ssam		mtx_destroy(&st->st_scanlock);
184186302Ssam		free(st, M_80211_SCAN);
185170530Ssam		KASSERT(nrefs > 0, ("imbalanced attach/detach"));
186170530Ssam		nrefs--;		/* NB: we assume caller locking */
187170530Ssam	}
188170530Ssam	return 1;
189170530Ssam}
190170530Ssam
191170530Ssam/*
192170530Ssam * Flush all per-scan state.
193170530Ssam */
194170530Ssamstatic int
195170530Ssamsta_flush(struct ieee80211_scan_state *ss)
196170530Ssam{
197170530Ssam	struct sta_table *st = ss->ss_priv;
198170530Ssam
199206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
200170530Ssam	sta_flush_table(st);
201206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
202170530Ssam	ss->ss_last = 0;
203170530Ssam	return 0;
204170530Ssam}
205170530Ssam
206170530Ssam/*
207170530Ssam * Flush all entries in the scan cache.
208170530Ssam */
209170530Ssamstatic void
210170530Ssamsta_flush_table(struct sta_table *st)
211170530Ssam{
212170530Ssam	struct sta_entry *se, *next;
213170530Ssam
214170530Ssam	TAILQ_FOREACH_SAFE(se, &st->st_entry, se_list, next) {
215170530Ssam		TAILQ_REMOVE(&st->st_entry, se, se_list);
216170530Ssam		LIST_REMOVE(se, se_hash);
217178354Ssam		ieee80211_ies_cleanup(&se->base.se_ies);
218186302Ssam		free(se, M_80211_SCAN);
219170530Ssam	}
220178354Ssam	memset(st->st_maxrssi, 0, sizeof(st->st_maxrssi));
221170530Ssam}
222170530Ssam
223170530Ssam/*
224170530Ssam * Process a beacon or probe response frame; create an
225170530Ssam * entry in the scan cache or update any previous entry.
226170530Ssam */
227170530Ssamstatic int
228170530Ssamsta_add(struct ieee80211_scan_state *ss,
229170530Ssam	const struct ieee80211_scanparams *sp,
230170530Ssam	const struct ieee80211_frame *wh,
231192468Ssam	int subtype, int rssi, int noise)
232170530Ssam{
233170530Ssam#define	ISPROBE(_st)	((_st) == IEEE80211_FC0_SUBTYPE_PROBE_RESP)
234170530Ssam#define	PICK1ST(_ss) \
235170530Ssam	((ss->ss_flags & (IEEE80211_SCAN_PICK1ST | IEEE80211_SCAN_GOTPICK)) == \
236170530Ssam	IEEE80211_SCAN_PICK1ST)
237170530Ssam	struct sta_table *st = ss->ss_priv;
238170530Ssam	const uint8_t *macaddr = wh->i_addr2;
239178354Ssam	struct ieee80211vap *vap = ss->ss_vap;
240178354Ssam	struct ieee80211com *ic = vap->iv_ic;
241224717Sbschmidt	struct ieee80211_channel *c;
242170530Ssam	struct sta_entry *se;
243170530Ssam	struct ieee80211_scan_entry *ise;
244178354Ssam	int hash;
245170530Ssam
246170530Ssam	hash = STA_HASH(macaddr);
247170530Ssam
248206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
249170530Ssam	LIST_FOREACH(se, &st->st_hash[hash], se_hash)
250170530Ssam		if (IEEE80211_ADDR_EQ(se->base.se_macaddr, macaddr))
251170530Ssam			goto found;
252186302Ssam	se = (struct sta_entry *) malloc(sizeof(struct sta_entry),
253170530Ssam		M_80211_SCAN, M_NOWAIT | M_ZERO);
254170530Ssam	if (se == NULL) {
255206617Srpaulo		IEEE80211_SCAN_TABLE_UNLOCK(st);
256170530Ssam		return 0;
257170530Ssam	}
258178354Ssam	se->se_scangen = st->st_scaniter-1;
259178354Ssam	se->se_avgrssi = IEEE80211_RSSI_DUMMY_MARKER;
260170530Ssam	IEEE80211_ADDR_COPY(se->base.se_macaddr, macaddr);
261170530Ssam	TAILQ_INSERT_TAIL(&st->st_entry, se, se_list);
262170530Ssam	LIST_INSERT_HEAD(&st->st_hash[hash], se, se_hash);
263170530Ssamfound:
264170530Ssam	ise = &se->base;
265170530Ssam	/* XXX ap beaconing multiple ssid w/ same bssid */
266170530Ssam	if (sp->ssid[1] != 0 &&
267170530Ssam	    (ISPROBE(subtype) || ise->se_ssid[1] == 0))
268170530Ssam		memcpy(ise->se_ssid, sp->ssid, 2+sp->ssid[1]);
269170530Ssam	KASSERT(sp->rates[1] <= IEEE80211_RATE_MAXSIZE,
270170530Ssam		("rate set too large: %u", sp->rates[1]));
271170530Ssam	memcpy(ise->se_rates, sp->rates, 2+sp->rates[1]);
272170530Ssam	if (sp->xrates != NULL) {
273170530Ssam		/* XXX validate xrates[1] */
274178354Ssam		KASSERT(sp->xrates[1] <= IEEE80211_RATE_MAXSIZE,
275170530Ssam			("xrate set too large: %u", sp->xrates[1]));
276170530Ssam		memcpy(ise->se_xrates, sp->xrates, 2+sp->xrates[1]);
277170530Ssam	} else
278170530Ssam		ise->se_xrates[1] = 0;
279170530Ssam	IEEE80211_ADDR_COPY(ise->se_bssid, wh->i_addr3);
280178354Ssam	if ((sp->status & IEEE80211_BPARSE_OFFCHAN) == 0) {
281173368Ssam		/*
282173368Ssam		 * Record rssi data using extended precision LPF filter.
283173368Ssam		 *
284173368Ssam		 * NB: use only on-channel data to insure we get a good
285173368Ssam		 *     estimate of the signal we'll see when associated.
286173368Ssam		 */
287178354Ssam		IEEE80211_RSSI_LPF(se->se_avgrssi, rssi);
288178354Ssam		ise->se_rssi = IEEE80211_RSSI_GET(se->se_avgrssi);
289173368Ssam		ise->se_noise = noise;
290173368Ssam	}
291170530Ssam	memcpy(ise->se_tstamp.data, sp->tstamp, sizeof(ise->se_tstamp));
292170530Ssam	ise->se_intval = sp->bintval;
293170530Ssam	ise->se_capinfo = sp->capinfo;
294195618Srpaulo#ifdef IEEE80211_SUPPORT_MESH
295195618Srpaulo	if (sp->meshid != NULL && sp->meshid[1] != 0)
296195618Srpaulo		memcpy(ise->se_meshid, sp->meshid, 2+sp->meshid[1]);
297195618Srpaulo#endif
298173368Ssam	/*
299173368Ssam	 * Beware of overriding se_chan for frames seen
300173368Ssam	 * off-channel; this can cause us to attempt an
301178354Ssam	 * association on the wrong channel.
302173368Ssam	 */
303178354Ssam	if (sp->status & IEEE80211_BPARSE_OFFCHAN) {
304173368Ssam		/*
305173862Ssam		 * Off-channel, locate the home/bss channel for the sta
306178354Ssam		 * using the value broadcast in the DSPARMS ie.  We know
307178354Ssam		 * sp->chan has this value because it's used to calculate
308178354Ssam		 * IEEE80211_BPARSE_OFFCHAN.
309173368Ssam		 */
310178354Ssam		c = ieee80211_find_channel_byieee(ic, sp->chan,
311178354Ssam		    ic->ic_curchan->ic_flags);
312173956Ssam		if (c != NULL) {
313173956Ssam			ise->se_chan = c;
314173956Ssam		} else if (ise->se_chan == NULL) {
315173862Ssam			/* should not happen, pick something */
316178354Ssam			ise->se_chan = ic->ic_curchan;
317173862Ssam		}
318173862Ssam	} else
319178354Ssam		ise->se_chan = ic->ic_curchan;
320224717Sbschmidt	if (IEEE80211_IS_CHAN_HT(ise->se_chan) && sp->htcap == NULL) {
321224717Sbschmidt		/* Demote legacy networks to a non-HT channel. */
322224717Sbschmidt		c = ieee80211_find_channel(ic, ise->se_chan->ic_freq,
323224717Sbschmidt		    ise->se_chan->ic_flags & ~IEEE80211_CHAN_HT);
324224717Sbschmidt		KASSERT(c != NULL,
325224717Sbschmidt		    ("no legacy channel %u", ise->se_chan->ic_ieee));
326224717Sbschmidt		ise->se_chan = c;
327224717Sbschmidt	}
328170530Ssam	ise->se_fhdwell = sp->fhdwell;
329170530Ssam	ise->se_fhindex = sp->fhindex;
330170530Ssam	ise->se_erp = sp->erp;
331170530Ssam	ise->se_timoff = sp->timoff;
332170530Ssam	if (sp->tim != NULL) {
333170530Ssam		const struct ieee80211_tim_ie *tim =
334170530Ssam		    (const struct ieee80211_tim_ie *) sp->tim;
335170530Ssam		ise->se_dtimperiod = tim->tim_period;
336170530Ssam	}
337178354Ssam	if (sp->country != NULL) {
338178354Ssam		const struct ieee80211_country_ie *cie =
339178354Ssam		    (const struct ieee80211_country_ie *) sp->country;
340178354Ssam		/*
341178354Ssam		 * If 11d is enabled and we're attempting to join a bss
342178354Ssam		 * that advertises it's country code then compare our
343178354Ssam		 * current settings to what we fetched from the country ie.
344178354Ssam		 * If our country code is unspecified or different then
345178354Ssam		 * dispatch an event to user space that identifies the
346178354Ssam		 * country code so our regdomain config can be changed.
347178354Ssam		 */
348178354Ssam		/* XXX only for STA mode? */
349178354Ssam		if ((IEEE80211_IS_CHAN_11D(ise->se_chan) ||
350178354Ssam		    (vap->iv_flags_ext & IEEE80211_FEXT_DOTD)) &&
351178354Ssam		    (ic->ic_regdomain.country == CTRY_DEFAULT ||
352178354Ssam		     !isocmp(cie->cc, ic->ic_regdomain.isocc))) {
353178354Ssam			/* only issue one notify event per scan */
354178354Ssam			if (se->se_countrygen != st->st_scangen) {
355178354Ssam				ieee80211_notify_country(vap, ise->se_bssid,
356178354Ssam				    cie->cc);
357178354Ssam				se->se_countrygen = st->st_scangen;
358178354Ssam			}
359178354Ssam		}
360178354Ssam		ise->se_cc[0] = cie->cc[0];
361178354Ssam		ise->se_cc[1] = cie->cc[1];
362178354Ssam	}
363178354Ssam	/* NB: no need to setup ie ptrs; they are not (currently) used */
364178354Ssam	(void) ieee80211_ies_init(&ise->se_ies, sp->ies, sp->ies_len);
365170530Ssam
366170530Ssam	/* clear failure count after STA_FAIL_AGE passes */
367170530Ssam	if (se->se_fails && (ticks - se->se_lastfail) > STA_FAILS_AGE*hz) {
368170530Ssam		se->se_fails = 0;
369178354Ssam		IEEE80211_NOTE_MAC(vap, IEEE80211_MSG_SCAN, macaddr,
370170530Ssam		    "%s: fails %u", __func__, se->se_fails);
371170530Ssam	}
372170530Ssam
373170530Ssam	se->se_lastupdate = ticks;		/* update time */
374170530Ssam	se->se_seen = 1;
375170530Ssam	se->se_notseen = 0;
376170530Ssam
377186107Ssam	KASSERT(sizeof(sp->bchan) == 1, ("bchan size"));
378178354Ssam	if (rssi > st->st_maxrssi[sp->bchan])
379178354Ssam		st->st_maxrssi[sp->bchan] = rssi;
380178354Ssam
381206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
382170530Ssam
383170530Ssam	/*
384170530Ssam	 * If looking for a quick choice and nothing's
385170530Ssam	 * been found check here.
386170530Ssam	 */
387178354Ssam	if (PICK1ST(ss) && match_bss(vap, ss, se, IEEE80211_MSG_SCAN) == 0)
388170530Ssam		ss->ss_flags |= IEEE80211_SCAN_GOTPICK;
389170530Ssam
390170530Ssam	return 1;
391170530Ssam#undef PICK1ST
392170530Ssam#undef ISPROBE
393170530Ssam}
394170530Ssam
395170530Ssam/*
396170530Ssam * Check if a channel is excluded by user request.
397170530Ssam */
398170530Ssamstatic int
399178354Ssamisexcluded(struct ieee80211vap *vap, const struct ieee80211_channel *c)
400170530Ssam{
401178354Ssam	return (isclr(vap->iv_ic->ic_chan_active, c->ic_ieee) ||
402178354Ssam	    (vap->iv_des_chan != IEEE80211_CHAN_ANYC &&
403178354Ssam	     c->ic_freq != vap->iv_des_chan->ic_freq));
404170530Ssam}
405170530Ssam
406170530Ssamstatic struct ieee80211_channel *
407170530Ssamfind11gchannel(struct ieee80211com *ic, int i, int freq)
408170530Ssam{
409170530Ssam	struct ieee80211_channel *c;
410170530Ssam	int j;
411170530Ssam
412170530Ssam	/*
413170530Ssam	 * The normal ordering in the channel list is b channel
414170530Ssam	 * immediately followed by g so optimize the search for
415170530Ssam	 * this.  We'll still do a full search just in case.
416170530Ssam	 */
417170530Ssam	for (j = i+1; j < ic->ic_nchans; j++) {
418170530Ssam		c = &ic->ic_channels[j];
419187991Ssam		if (c->ic_freq == freq && IEEE80211_IS_CHAN_G(c))
420170530Ssam			return c;
421170530Ssam	}
422170530Ssam	for (j = 0; j < i; j++) {
423170530Ssam		c = &ic->ic_channels[j];
424187991Ssam		if (c->ic_freq == freq && IEEE80211_IS_CHAN_G(c))
425170530Ssam			return c;
426170530Ssam	}
427170530Ssam	return NULL;
428170530Ssam}
429188777Ssam
430170530Ssamstatic const u_int chanflags[IEEE80211_MODE_MAX] = {
431188777Ssam	[IEEE80211_MODE_AUTO]	  = IEEE80211_CHAN_B,
432188777Ssam	[IEEE80211_MODE_11A]	  = IEEE80211_CHAN_A,
433188777Ssam	[IEEE80211_MODE_11B]	  = IEEE80211_CHAN_B,
434188777Ssam	[IEEE80211_MODE_11G]	  = IEEE80211_CHAN_G,
435188777Ssam	[IEEE80211_MODE_FH]	  = IEEE80211_CHAN_FHSS,
436188777Ssam	/* check base channel */
437188777Ssam	[IEEE80211_MODE_TURBO_A]  = IEEE80211_CHAN_A,
438188777Ssam	[IEEE80211_MODE_TURBO_G]  = IEEE80211_CHAN_G,
439188777Ssam	[IEEE80211_MODE_STURBO_A] = IEEE80211_CHAN_ST,
440188782Ssam	[IEEE80211_MODE_HALF]	  = IEEE80211_CHAN_HALF,
441188782Ssam	[IEEE80211_MODE_QUARTER]  = IEEE80211_CHAN_QUARTER,
442188777Ssam	/* check legacy */
443188777Ssam	[IEEE80211_MODE_11NA]	  = IEEE80211_CHAN_A,
444188777Ssam	[IEEE80211_MODE_11NG]	  = IEEE80211_CHAN_G,
445170530Ssam};
446170530Ssam
447170530Ssamstatic void
448178354Ssamadd_channels(struct ieee80211vap *vap,
449170530Ssam	struct ieee80211_scan_state *ss,
450170530Ssam	enum ieee80211_phymode mode, const uint16_t freq[], int nfreq)
451170530Ssam{
452170530Ssam#define	N(a)	(sizeof(a) / sizeof(a[0]))
453178354Ssam	struct ieee80211com *ic = vap->iv_ic;
454170530Ssam	struct ieee80211_channel *c, *cg;
455170530Ssam	u_int modeflags;
456170530Ssam	int i;
457170530Ssam
458170530Ssam	KASSERT(mode < N(chanflags), ("Unexpected mode %u", mode));
459170530Ssam	modeflags = chanflags[mode];
460170530Ssam	for (i = 0; i < nfreq; i++) {
461170530Ssam		if (ss->ss_last >= IEEE80211_SCAN_MAX)
462170530Ssam			break;
463170530Ssam
464170530Ssam		c = ieee80211_find_channel(ic, freq[i], modeflags);
465178354Ssam		if (c == NULL || isexcluded(vap, c))
466170530Ssam			continue;
467170530Ssam		if (mode == IEEE80211_MODE_AUTO) {
468170530Ssam			/*
469170530Ssam			 * XXX special-case 11b/g channels so we select
470178354Ssam			 *     the g channel if both are present.
471170530Ssam			 */
472178354Ssam			if (IEEE80211_IS_CHAN_B(c) &&
473178354Ssam			    (cg = find11gchannel(ic, i, c->ic_freq)) != NULL)
474178354Ssam				c = cg;
475170530Ssam		}
476170530Ssam		ss->ss_chans[ss->ss_last++] = c;
477170530Ssam	}
478170530Ssam#undef N
479170530Ssam}
480170530Ssam
481170530Ssamstruct scanlist {
482170530Ssam	uint16_t	mode;
483170530Ssam	uint16_t	count;
484170530Ssam	const uint16_t	*list;
485170530Ssam};
486170530Ssam
487170530Ssamstatic int
488170530Ssamchecktable(const struct scanlist *scan, const struct ieee80211_channel *c)
489170530Ssam{
490170530Ssam	int i;
491170530Ssam
492170530Ssam	for (; scan->list != NULL; scan++) {
493170530Ssam		for (i = 0; i < scan->count; i++)
494170530Ssam			if (scan->list[i] == c->ic_freq)
495170530Ssam				return 1;
496170530Ssam	}
497170530Ssam	return 0;
498170530Ssam}
499170530Ssam
500189377Ssamstatic int
501189377Ssamonscanlist(const struct ieee80211_scan_state *ss,
502189377Ssam	const struct ieee80211_channel *c)
503189377Ssam{
504189377Ssam	int i;
505189377Ssam
506189377Ssam	for (i = 0; i < ss->ss_last; i++)
507189377Ssam		if (ss->ss_chans[i] == c)
508189377Ssam			return 1;
509189377Ssam	return 0;
510189377Ssam}
511189377Ssam
512176653Ssamstatic void
513178354Ssamsweepchannels(struct ieee80211_scan_state *ss, struct ieee80211vap *vap,
514176653Ssam	const struct scanlist table[])
515176653Ssam{
516178354Ssam	struct ieee80211com *ic = vap->iv_ic;
517176653Ssam	struct ieee80211_channel *c;
518176653Ssam	int i;
519176653Ssam
520176653Ssam	for (i = 0; i < ic->ic_nchans; i++) {
521176653Ssam		if (ss->ss_last >= IEEE80211_SCAN_MAX)
522176653Ssam			break;
523176653Ssam
524176653Ssam		c = &ic->ic_channels[i];
525176653Ssam		/*
526176653Ssam		 * Ignore dynamic turbo channels; we scan them
527176653Ssam		 * in normal mode (i.e. not boosted).  Likewise
528176653Ssam		 * for HT channels, they get scanned using
529176653Ssam		 * legacy rates.
530176653Ssam		 */
531176653Ssam		if (IEEE80211_IS_CHAN_DTURBO(c) || IEEE80211_IS_CHAN_HT(c))
532176653Ssam			continue;
533176653Ssam
534176653Ssam		/*
535176653Ssam		 * If a desired mode was specified, scan only
536176653Ssam		 * channels that satisfy that constraint.
537176653Ssam		 */
538178354Ssam		if (vap->iv_des_mode != IEEE80211_MODE_AUTO &&
539178354Ssam		    vap->iv_des_mode != ieee80211_chan2mode(c))
540176653Ssam			continue;
541176653Ssam
542176653Ssam		/*
543176653Ssam		 * Skip channels excluded by user request.
544176653Ssam		 */
545178354Ssam		if (isexcluded(vap, c))
546176653Ssam			continue;
547176653Ssam
548176653Ssam		/*
549176653Ssam		 * Add the channel unless it is listed in the
550176653Ssam		 * fixed scan order tables.  This insures we
551176653Ssam		 * don't sweep back in channels we filtered out
552176653Ssam		 * above.
553176653Ssam		 */
554176653Ssam		if (checktable(table, c))
555176653Ssam			continue;
556176653Ssam
557176653Ssam		/* Add channel to scanning list. */
558176653Ssam		ss->ss_chans[ss->ss_last++] = c;
559176653Ssam	}
560189377Ssam	/*
561189377Ssam	 * Explicitly add any desired channel if:
562189377Ssam	 * - not already on the scan list
563189377Ssam	 * - allowed by any desired mode constraint
564189377Ssam	 * - there is space in the scan list
565189377Ssam	 * This allows the channel to be used when the filtering
566189377Ssam	 * mechanisms would otherwise elide it (e.g HT, turbo).
567189377Ssam	 */
568189377Ssam	c = vap->iv_des_chan;
569189377Ssam	if (c != IEEE80211_CHAN_ANYC &&
570189377Ssam	    !onscanlist(ss, c) &&
571189377Ssam	    (vap->iv_des_mode == IEEE80211_MODE_AUTO ||
572189377Ssam	     vap->iv_des_mode == ieee80211_chan2mode(c)) &&
573189377Ssam	    ss->ss_last < IEEE80211_SCAN_MAX)
574189377Ssam		ss->ss_chans[ss->ss_last++] = c;
575176653Ssam}
576176653Ssam
577178354Ssamstatic void
578178354Ssammakescanlist(struct ieee80211_scan_state *ss, struct ieee80211vap *vap,
579178354Ssam	const struct scanlist table[])
580170530Ssam{
581170530Ssam	const struct scanlist *scan;
582170530Ssam	enum ieee80211_phymode mode;
583170530Ssam
584170530Ssam	ss->ss_last = 0;
585170530Ssam	/*
586170530Ssam	 * Use the table of ordered channels to construct the list
587170530Ssam	 * of channels for scanning.  Any channels in the ordered
588170530Ssam	 * list not in the master list will be discarded.
589170530Ssam	 */
590178354Ssam	for (scan = table; scan->list != NULL; scan++) {
591170530Ssam		mode = scan->mode;
592178354Ssam		if (vap->iv_des_mode != IEEE80211_MODE_AUTO) {
593170530Ssam			/*
594170530Ssam			 * If a desired mode was specified, scan only
595170530Ssam			 * channels that satisfy that constraint.
596170530Ssam			 */
597178354Ssam			if (vap->iv_des_mode != mode) {
598170530Ssam				/*
599170530Ssam				 * The scan table marks 2.4Ghz channels as b
600170530Ssam				 * so if the desired mode is 11g, then use
601170530Ssam				 * the 11b channel list but upgrade the mode.
602170530Ssam				 */
603178354Ssam				if (vap->iv_des_mode != IEEE80211_MODE_11G ||
604170530Ssam				    mode != IEEE80211_MODE_11B)
605170530Ssam					continue;
606170530Ssam				mode = IEEE80211_MODE_11G;	/* upgrade */
607170530Ssam			}
608170530Ssam		} else {
609170530Ssam			/*
610170530Ssam			 * This lets add_channels upgrade an 11b channel
611170530Ssam			 * to 11g if available.
612170530Ssam			 */
613170530Ssam			if (mode == IEEE80211_MODE_11B)
614170530Ssam				mode = IEEE80211_MODE_AUTO;
615170530Ssam		}
616170530Ssam#ifdef IEEE80211_F_XR
617170530Ssam		/* XR does not operate on turbo channels */
618178354Ssam		if ((vap->iv_flags & IEEE80211_F_XR) &&
619170530Ssam		    (mode == IEEE80211_MODE_TURBO_A ||
620170530Ssam		     mode == IEEE80211_MODE_TURBO_G ||
621170530Ssam		     mode == IEEE80211_MODE_STURBO_A))
622170530Ssam			continue;
623170530Ssam#endif
624170530Ssam		/*
625170530Ssam		 * Add the list of the channels; any that are not
626170530Ssam		 * in the master channel list will be discarded.
627170530Ssam		 */
628178354Ssam		add_channels(vap, ss, mode, scan->list, scan->count);
629170530Ssam	}
630170530Ssam
631170530Ssam	/*
632178354Ssam	 * Add the channels from the ic that are not present
633178354Ssam	 * in the table.
634170530Ssam	 */
635178354Ssam	sweepchannels(ss, vap, table);
636178354Ssam}
637170530Ssam
638178354Ssamstatic const uint16_t rcl1[] =		/* 8 FCC channel: 52, 56, 60, 64, 36, 40, 44, 48 */
639178354Ssam{ 5260, 5280, 5300, 5320, 5180, 5200, 5220, 5240 };
640178354Ssamstatic const uint16_t rcl2[] =		/* 4 MKK channels: 34, 38, 42, 46 */
641178354Ssam{ 5170, 5190, 5210, 5230 };
642178354Ssamstatic const uint16_t rcl3[] =		/* 2.4Ghz ch: 1,6,11,7,13 */
643178354Ssam{ 2412, 2437, 2462, 2442, 2472 };
644178354Ssamstatic const uint16_t rcl4[] =		/* 5 FCC channel: 149, 153, 161, 165 */
645178354Ssam{ 5745, 5765, 5785, 5805, 5825 };
646178354Ssamstatic const uint16_t rcl7[] =		/* 11 ETSI channel: 100,104,108,112,116,120,124,128,132,136,140 */
647178354Ssam{ 5500, 5520, 5540, 5560, 5580, 5600, 5620, 5640, 5660, 5680, 5700 };
648178354Ssamstatic const uint16_t rcl8[] =		/* 2.4Ghz ch: 2,3,4,5,8,9,10,12 */
649178354Ssam{ 2417, 2422, 2427, 2432, 2447, 2452, 2457, 2467 };
650178354Ssamstatic const uint16_t rcl9[] =		/* 2.4Ghz ch: 14 */
651178354Ssam{ 2484 };
652178354Ssamstatic const uint16_t rcl10[] =	/* Added Korean channels 2312-2372 */
653178354Ssam{ 2312, 2317, 2322, 2327, 2332, 2337, 2342, 2347, 2352, 2357, 2362, 2367, 2372 };
654178354Ssamstatic const uint16_t rcl11[] =	/* Added Japan channels in 4.9/5.0 spectrum */
655178354Ssam{ 5040, 5060, 5080, 4920, 4940, 4960, 4980 };
656178354Ssam#ifdef ATH_TURBO_SCAN
657178354Ssamstatic const uint16_t rcl5[] =		/* 3 static turbo channels */
658178354Ssam{ 5210, 5250, 5290 };
659178354Ssamstatic const uint16_t rcl6[] =		/* 2 static turbo channels */
660178354Ssam{ 5760, 5800 };
661178354Ssamstatic const uint16_t rcl6x[] =	/* 4 FCC3 turbo channels */
662178354Ssam{ 5540, 5580, 5620, 5660 };
663178354Ssamstatic const uint16_t rcl12[] =	/* 2.4Ghz Turbo channel 6 */
664178354Ssam{ 2437 };
665178354Ssamstatic const uint16_t rcl13[] =	/* dynamic Turbo channels */
666178354Ssam{ 5200, 5240, 5280, 5765, 5805 };
667178354Ssam#endif /* ATH_TURBO_SCAN */
668170530Ssam
669178354Ssam#define	X(a)	.count = sizeof(a)/sizeof(a[0]), .list = a
670170530Ssam
671178354Ssamstatic const struct scanlist staScanTable[] = {
672178354Ssam	{ IEEE80211_MODE_11B,   	X(rcl3) },
673178354Ssam	{ IEEE80211_MODE_11A,   	X(rcl1) },
674178354Ssam	{ IEEE80211_MODE_11A,   	X(rcl2) },
675178354Ssam	{ IEEE80211_MODE_11B,   	X(rcl8) },
676178354Ssam	{ IEEE80211_MODE_11B,   	X(rcl9) },
677178354Ssam	{ IEEE80211_MODE_11A,   	X(rcl4) },
678178354Ssam#ifdef ATH_TURBO_SCAN
679178354Ssam	{ IEEE80211_MODE_STURBO_A,	X(rcl5) },
680178354Ssam	{ IEEE80211_MODE_STURBO_A,	X(rcl6) },
681178354Ssam	{ IEEE80211_MODE_TURBO_A,	X(rcl6x) },
682178354Ssam	{ IEEE80211_MODE_TURBO_A,	X(rcl13) },
683178354Ssam#endif /* ATH_TURBO_SCAN */
684178354Ssam	{ IEEE80211_MODE_11A,		X(rcl7) },
685178354Ssam	{ IEEE80211_MODE_11B,		X(rcl10) },
686178354Ssam	{ IEEE80211_MODE_11A,		X(rcl11) },
687178354Ssam#ifdef ATH_TURBO_SCAN
688178354Ssam	{ IEEE80211_MODE_TURBO_G,	X(rcl12) },
689178354Ssam#endif /* ATH_TURBO_SCAN */
690178354Ssam	{ .list = NULL }
691178354Ssam};
692178354Ssam
693178354Ssam/*
694178354Ssam * Start a station-mode scan by populating the channel list.
695178354Ssam */
696178354Ssamstatic int
697178354Ssamsta_start(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
698178354Ssam{
699178354Ssam	struct sta_table *st = ss->ss_priv;
700178354Ssam
701178354Ssam	makescanlist(ss, vap, staScanTable);
702178354Ssam
703178354Ssam	if (ss->ss_mindwell == 0)
704178354Ssam		ss->ss_mindwell = msecs_to_ticks(20);	/* 20ms */
705178354Ssam	if (ss->ss_maxdwell == 0)
706178354Ssam		ss->ss_maxdwell = msecs_to_ticks(200);	/* 200ms */
707178354Ssam
708178354Ssam	st->st_scangen++;
709170530Ssam	st->st_newscan = 1;
710170530Ssam
711170530Ssam	return 0;
712170530Ssam}
713170530Ssam
714170530Ssam/*
715178354Ssam * Restart a scan, typically a bg scan but can
716178354Ssam * also be a fg scan that came up empty.
717170530Ssam */
718170530Ssamstatic int
719178354Ssamsta_restart(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
720170530Ssam{
721170530Ssam	struct sta_table *st = ss->ss_priv;
722170530Ssam
723170530Ssam	st->st_newscan = 1;
724170530Ssam	return 0;
725170530Ssam}
726170530Ssam
727170530Ssam/*
728170530Ssam * Cancel an ongoing scan.
729170530Ssam */
730170530Ssamstatic int
731178354Ssamsta_cancel(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
732170530Ssam{
733170530Ssam	return 0;
734170530Ssam}
735170530Ssam
736178354Ssam/* unalligned little endian access */
737178354Ssam#define LE_READ_2(p)					\
738178354Ssam	((uint16_t)					\
739178354Ssam	 ((((const uint8_t *)(p))[0]      ) |		\
740178354Ssam	  (((const uint8_t *)(p))[1] <<  8)))
741184302Ssam
742184302Ssam/*
743184302Ssam * Demote any supplied 11g channel to 11b.  There should
744184302Ssam * always be an 11b channel but we check anyway...
745184302Ssam */
746184302Ssamstatic struct ieee80211_channel *
747184302Ssamdemote11b(struct ieee80211vap *vap, struct ieee80211_channel *chan)
748184302Ssam{
749184302Ssam	struct ieee80211_channel *c;
750178354Ssam
751184302Ssam	if (IEEE80211_IS_CHAN_ANYG(chan) &&
752184302Ssam	    vap->iv_des_mode == IEEE80211_MODE_AUTO) {
753184302Ssam		c = ieee80211_find_channel(vap->iv_ic, chan->ic_freq,
754184302Ssam		    (chan->ic_flags &~ (IEEE80211_CHAN_PUREG | IEEE80211_CHAN_G)) |
755184302Ssam		    IEEE80211_CHAN_B);
756184302Ssam		if (c != NULL)
757184302Ssam			chan = c;
758184302Ssam	}
759184302Ssam	return chan;
760184302Ssam}
761184302Ssam
762178354Ssamstatic int
763170530Ssammaxrate(const struct ieee80211_scan_entry *se)
764170530Ssam{
765178354Ssam	const struct ieee80211_ie_htcap *htcap =
766178354Ssam	    (const struct ieee80211_ie_htcap *) se->se_ies.htcap_ie;
767219601Sbschmidt	int rmax, r, i, txstream;
768178354Ssam	uint16_t caps;
769219601Sbschmidt	uint8_t txparams;
770170530Ssam
771170530Ssam	rmax = 0;
772178354Ssam	if (htcap != NULL) {
773178354Ssam		/*
774178354Ssam		 * HT station; inspect supported MCS and then adjust
775219601Sbschmidt		 * rate by channel width.
776178354Ssam		 */
777219601Sbschmidt		txparams = htcap->hc_mcsset[12];
778219601Sbschmidt		if (txparams & 0x3) {
779219601Sbschmidt			/*
780219601Sbschmidt			 * TX MCS parameters defined and not equal to RX,
781219601Sbschmidt			 * extract the number of spartial streams and
782219601Sbschmidt			 * map it to the highest MCS rate.
783219601Sbschmidt			 */
784219601Sbschmidt			txstream = ((txparams & 0xc) >> 2) + 1;
785219601Sbschmidt			i = txstream * 8 - 1;
786219601Sbschmidt		} else
787219601Sbschmidt			for (i = 31; i >= 0 && isclr(htcap->hc_mcsset, i); i--);
788178354Ssam		if (i >= 0) {
789178354Ssam			caps = LE_READ_2(&htcap->hc_cap);
790219601Sbschmidt			if ((caps & IEEE80211_HTCAP_CHWIDTH40) &&
791219601Sbschmidt			    (caps & IEEE80211_HTCAP_SHORTGI40))
792178354Ssam				rmax = ieee80211_htrates[i].ht40_rate_400ns;
793219601Sbschmidt			else if (caps & IEEE80211_HTCAP_CHWIDTH40)
794219601Sbschmidt				rmax = ieee80211_htrates[i].ht40_rate_800ns;
795219601Sbschmidt			else if (caps & IEEE80211_HTCAP_SHORTGI20)
796219601Sbschmidt				rmax = ieee80211_htrates[i].ht20_rate_400ns;
797178354Ssam			else
798219601Sbschmidt				rmax = ieee80211_htrates[i].ht20_rate_800ns;
799178354Ssam		}
800178354Ssam	}
801170530Ssam	for (i = 0; i < se->se_rates[1]; i++) {
802170530Ssam		r = se->se_rates[2+i] & IEEE80211_RATE_VAL;
803170530Ssam		if (r > rmax)
804170530Ssam			rmax = r;
805170530Ssam	}
806170530Ssam	for (i = 0; i < se->se_xrates[1]; i++) {
807170530Ssam		r = se->se_xrates[2+i] & IEEE80211_RATE_VAL;
808170530Ssam		if (r > rmax)
809170530Ssam			rmax = r;
810170530Ssam	}
811170530Ssam	return rmax;
812170530Ssam}
813170530Ssam
814170530Ssam/*
815170530Ssam * Compare the capabilities of two entries and decide which is
816170530Ssam * more desirable (return >0 if a is considered better).  Note
817170530Ssam * that we assume compatibility/usability has already been checked
818170530Ssam * so we don't need to (e.g. validate whether privacy is supported).
819170530Ssam * Used to select the best scan candidate for association in a BSS.
820170530Ssam */
821170530Ssamstatic int
822170530Ssamsta_compare(const struct sta_entry *a, const struct sta_entry *b)
823170530Ssam{
824170530Ssam#define	PREFER(_a,_b,_what) do {			\
825170530Ssam	if (((_a) ^ (_b)) & (_what))			\
826170530Ssam		return ((_a) & (_what)) ? 1 : -1;	\
827170530Ssam} while (0)
828178354Ssam	int maxa, maxb;
829170530Ssam	int8_t rssia, rssib;
830170530Ssam	int weight;
831170530Ssam
832170530Ssam	/* privacy support */
833170530Ssam	PREFER(a->base.se_capinfo, b->base.se_capinfo,
834170530Ssam		IEEE80211_CAPINFO_PRIVACY);
835170530Ssam
836170530Ssam	/* compare count of previous failures */
837170530Ssam	weight = b->se_fails - a->se_fails;
838170530Ssam	if (abs(weight) > 1)
839170530Ssam		return weight;
840170530Ssam
841170530Ssam	/*
842170530Ssam	 * Compare rssi.  If the two are considered equivalent
843170530Ssam	 * then fallback to other criteria.  We threshold the
844170530Ssam	 * comparisons to avoid selecting an ap purely by rssi
845170530Ssam	 * when both values may be good but one ap is otherwise
846170530Ssam	 * more desirable (e.g. an 11b-only ap with stronger
847170530Ssam	 * signal than an 11g ap).
848170530Ssam	 */
849170530Ssam	rssia = MIN(a->base.se_rssi, STA_RSSI_MAX);
850170530Ssam	rssib = MIN(b->base.se_rssi, STA_RSSI_MAX);
851170530Ssam	if (abs(rssib - rssia) < 5) {
852170530Ssam		/* best/max rate preferred if signal level close enough XXX */
853170530Ssam		maxa = maxrate(&a->base);
854170530Ssam		maxb = maxrate(&b->base);
855170530Ssam		if (maxa != maxb)
856170530Ssam			return maxa - maxb;
857170530Ssam		/* XXX use freq for channel preference */
858170530Ssam		/* for now just prefer 5Ghz band to all other bands */
859178354Ssam		PREFER(IEEE80211_IS_CHAN_5GHZ(a->base.se_chan),
860178354Ssam		       IEEE80211_IS_CHAN_5GHZ(b->base.se_chan), 1);
861170530Ssam	}
862170530Ssam	/* all things being equal, use signal level */
863170530Ssam	return a->base.se_rssi - b->base.se_rssi;
864170530Ssam#undef PREFER
865170530Ssam}
866170530Ssam
867170530Ssam/*
868170530Ssam * Check rate set suitability and return the best supported rate.
869178354Ssam * XXX inspect MCS for HT
870170530Ssam */
871170530Ssamstatic int
872184302Ssamcheck_rate(struct ieee80211vap *vap, const struct ieee80211_channel *chan,
873184302Ssam    const struct ieee80211_scan_entry *se)
874170530Ssam{
875170530Ssam#define	RV(v)	((v) & IEEE80211_RATE_VAL)
876170530Ssam	const struct ieee80211_rateset *srs;
877178354Ssam	int i, j, nrs, r, okrate, badrate, fixedrate, ucastrate;
878170530Ssam	const uint8_t *rs;
879170530Ssam
880178354Ssam	okrate = badrate = 0;
881170530Ssam
882184302Ssam	srs = ieee80211_get_suprates(vap->iv_ic, chan);
883170530Ssam	nrs = se->se_rates[1];
884170530Ssam	rs = se->se_rates+2;
885178354Ssam	/* XXX MCS */
886184302Ssam	ucastrate = vap->iv_txparms[ieee80211_chan2mode(chan)].ucastrate;
887170530Ssam	fixedrate = IEEE80211_FIXED_RATE_NONE;
888170530Ssamagain:
889170530Ssam	for (i = 0; i < nrs; i++) {
890170530Ssam		r = RV(rs[i]);
891170530Ssam		badrate = r;
892170530Ssam		/*
893170530Ssam		 * Check any fixed rate is included.
894170530Ssam		 */
895178354Ssam		if (r == ucastrate)
896170530Ssam			fixedrate = r;
897170530Ssam		/*
898170530Ssam		 * Check against our supported rates.
899170530Ssam		 */
900170530Ssam		for (j = 0; j < srs->rs_nrates; j++)
901170530Ssam			if (r == RV(srs->rs_rates[j])) {
902170530Ssam				if (r > okrate)		/* NB: track max */
903170530Ssam					okrate = r;
904170530Ssam				break;
905170530Ssam			}
906170530Ssam
907170530Ssam		if (j == srs->rs_nrates && (rs[i] & IEEE80211_RATE_BASIC)) {
908170530Ssam			/*
909170530Ssam			 * Don't try joining a BSS, if we don't support
910170530Ssam			 * one of its basic rates.
911170530Ssam			 */
912170530Ssam			okrate = 0;
913170530Ssam			goto back;
914170530Ssam		}
915170530Ssam	}
916170530Ssam	if (rs == se->se_rates+2) {
917170530Ssam		/* scan xrates too; sort of an algol68-style for loop */
918170530Ssam		nrs = se->se_xrates[1];
919170530Ssam		rs = se->se_xrates+2;
920170530Ssam		goto again;
921170530Ssam	}
922170530Ssam
923170530Ssamback:
924178354Ssam	if (okrate == 0 || ucastrate != fixedrate)
925170530Ssam		return badrate | IEEE80211_RATE_BASIC;
926170530Ssam	else
927170530Ssam		return RV(okrate);
928170530Ssam#undef RV
929170530Ssam}
930170530Ssam
931195618Srpaulostatic __inline int
932195618Srpaulomatch_id(const uint8_t *ie, const uint8_t *val, int len)
933195618Srpaulo{
934195618Srpaulo	return (ie[1] == len && memcmp(ie+2, val, len) == 0);
935195618Srpaulo}
936195618Srpaulo
937170530Ssamstatic int
938170530Ssammatch_ssid(const uint8_t *ie,
939170530Ssam	int nssid, const struct ieee80211_scan_ssid ssids[])
940170530Ssam{
941170530Ssam	int i;
942170530Ssam
943170530Ssam	for (i = 0; i < nssid; i++) {
944195618Srpaulo		if (match_id(ie, ssids[i].ssid, ssids[i].len))
945170530Ssam			return 1;
946170530Ssam	}
947170530Ssam	return 0;
948170530Ssam}
949170530Ssam
950186904Ssam#ifdef IEEE80211_SUPPORT_TDMA
951186904Ssamstatic int
952186904Ssamtdma_isfull(const struct ieee80211_tdma_param *tdma)
953186904Ssam{
954186904Ssam	int slot, slotcnt;
955186904Ssam
956186904Ssam	slotcnt = tdma->tdma_slotcnt;
957186904Ssam	for (slot = slotcnt-1; slot >= 0; slot--)
958186904Ssam		if (isclr(tdma->tdma_inuse, slot))
959186904Ssam			return 0;
960186904Ssam	return 1;
961186904Ssam}
962186904Ssam#endif /* IEEE80211_SUPPORT_TDMA */
963186904Ssam
964170530Ssam/*
965170530Ssam * Test a scan candidate for suitability/compatibility.
966170530Ssam */
967170530Ssamstatic int
968178354Ssammatch_bss(struct ieee80211vap *vap,
969170530Ssam	const struct ieee80211_scan_state *ss, struct sta_entry *se0,
970170530Ssam	int debug)
971170530Ssam{
972178354Ssam	struct ieee80211com *ic = vap->iv_ic;
973170530Ssam	struct ieee80211_scan_entry *se = &se0->base;
974178354Ssam        uint8_t rate;
975178354Ssam        int fail;
976170530Ssam
977170530Ssam	fail = 0;
978170530Ssam	if (isclr(ic->ic_chan_active, ieee80211_chan2ieee(ic, se->se_chan)))
979171409Ssam		fail |= MATCH_CHANNEL;
980170530Ssam	/*
981170530Ssam	 * NB: normally the desired mode is used to construct
982170530Ssam	 * the channel list, but it's possible for the scan
983170530Ssam	 * cache to include entries for stations outside this
984170530Ssam	 * list so we check the desired mode here to weed them
985170530Ssam	 * out.
986170530Ssam	 */
987178354Ssam	if (vap->iv_des_mode != IEEE80211_MODE_AUTO &&
988170530Ssam	    (se->se_chan->ic_flags & IEEE80211_CHAN_ALLTURBO) !=
989178354Ssam	    chanflags[vap->iv_des_mode])
990171409Ssam		fail |= MATCH_CHANNEL;
991178354Ssam	if (vap->iv_opmode == IEEE80211_M_IBSS) {
992170530Ssam		if ((se->se_capinfo & IEEE80211_CAPINFO_IBSS) == 0)
993171409Ssam			fail |= MATCH_CAPINFO;
994186904Ssam#ifdef IEEE80211_SUPPORT_TDMA
995186904Ssam	} else if (vap->iv_opmode == IEEE80211_M_AHDEMO) {
996186904Ssam		/*
997186904Ssam		 * Adhoc demo network setup shouldn't really be scanning
998186904Ssam		 * but just in case skip stations operating in IBSS or
999186904Ssam		 * BSS mode.
1000186904Ssam		 */
1001186904Ssam		if (se->se_capinfo & (IEEE80211_CAPINFO_IBSS|IEEE80211_CAPINFO_ESS))
1002186904Ssam			fail |= MATCH_CAPINFO;
1003186904Ssam		/*
1004186904Ssam		 * TDMA operation cannot coexist with a normal 802.11 network;
1005186904Ssam		 * skip if IBSS or ESS capabilities are marked and require
1006186904Ssam		 * the beacon have a TDMA ie present.
1007186904Ssam		 */
1008186904Ssam		if (vap->iv_caps & IEEE80211_C_TDMA) {
1009186904Ssam			const struct ieee80211_tdma_param *tdma =
1010186904Ssam			    (const struct ieee80211_tdma_param *)se->se_ies.tdma_ie;
1011189980Ssam			const struct ieee80211_tdma_state *ts = vap->iv_tdma;
1012186904Ssam
1013186904Ssam			if (tdma == NULL)
1014186904Ssam				fail |= MATCH_TDMA_NOIE;
1015189980Ssam			else if (tdma->tdma_version != ts->tdma_version)
1016189980Ssam				fail |= MATCH_TDMA_VERSION;
1017186904Ssam			else if (tdma->tdma_slot != 0)
1018186904Ssam				fail |= MATCH_TDMA_NOTMASTER;
1019186904Ssam			else if (tdma_isfull(tdma))
1020186904Ssam				fail |= MATCH_TDMA_NOSLOT;
1021186904Ssam#if 0
1022186904Ssam			else if (ieee80211_local_address(se->se_macaddr))
1023186904Ssam				fail |= MATCH_TDMA_LOCAL;
1024186904Ssam#endif
1025186904Ssam		}
1026186904Ssam#endif /* IEEE80211_SUPPORT_TDMA */
1027195618Srpaulo#ifdef IEEE80211_SUPPORT_MESH
1028195618Srpaulo	} else if (vap->iv_opmode == IEEE80211_M_MBSS) {
1029195618Srpaulo		const struct ieee80211_mesh_state *ms = vap->iv_mesh;
1030195618Srpaulo		/*
1031195618Srpaulo		 * Mesh nodes have IBSS & ESS bits in capinfo turned off
1032195618Srpaulo		 * and two special ie's that must be present.
1033195618Srpaulo		 */
1034195618Srpaulo		if (se->se_capinfo & (IEEE80211_CAPINFO_IBSS|IEEE80211_CAPINFO_ESS))
1035195618Srpaulo			fail |= MATCH_CAPINFO;
1036215699Sbschmidt		else if (se->se_meshid[0] != IEEE80211_ELEMID_MESHID)
1037195618Srpaulo			fail |= MATCH_MESH_NOID;
1038195618Srpaulo		else if (ms->ms_idlen != 0 &&
1039195618Srpaulo		    match_id(se->se_meshid, ms->ms_id, ms->ms_idlen))
1040195618Srpaulo			fail |= MATCH_MESHID;
1041196005Ssam#endif
1042170530Ssam	} else {
1043170530Ssam		if ((se->se_capinfo & IEEE80211_CAPINFO_ESS) == 0)
1044171409Ssam			fail |= MATCH_CAPINFO;
1045178354Ssam		/*
1046178354Ssam		 * If 11d is enabled and we're attempting to join a bss
1047178354Ssam		 * that advertises it's country code then compare our
1048178354Ssam		 * current settings to what we fetched from the country ie.
1049178354Ssam		 * If our country code is unspecified or different then do
1050178354Ssam		 * not attempt to join the bss.  We should have already
1051178354Ssam		 * dispatched an event to user space that identifies the
1052178354Ssam		 * new country code so our regdomain config should match.
1053178354Ssam		 */
1054178354Ssam		if ((IEEE80211_IS_CHAN_11D(se->se_chan) ||
1055178354Ssam		    (vap->iv_flags_ext & IEEE80211_FEXT_DOTD)) &&
1056178354Ssam		    se->se_cc[0] != 0 &&
1057178354Ssam		    (ic->ic_regdomain.country == CTRY_DEFAULT ||
1058178354Ssam		     !isocmp(se->se_cc, ic->ic_regdomain.isocc)))
1059178354Ssam			fail |= MATCH_CC;
1060170530Ssam	}
1061178354Ssam	if (vap->iv_flags & IEEE80211_F_PRIVACY) {
1062170530Ssam		if ((se->se_capinfo & IEEE80211_CAPINFO_PRIVACY) == 0)
1063171409Ssam			fail |= MATCH_PRIVACY;
1064170530Ssam	} else {
1065170530Ssam		/* XXX does this mean privacy is supported or required? */
1066170530Ssam		if (se->se_capinfo & IEEE80211_CAPINFO_PRIVACY)
1067171409Ssam			fail |= MATCH_PRIVACY;
1068170530Ssam	}
1069184302Ssam	se0->se_flags &= ~STA_DEMOTE11B;
1070184302Ssam	rate = check_rate(vap, se->se_chan, se);
1071184302Ssam	if (rate & IEEE80211_RATE_BASIC) {
1072171409Ssam		fail |= MATCH_RATE;
1073184302Ssam		/*
1074184302Ssam		 * An 11b-only ap will give a rate mismatch if there is an
1075184302Ssam		 * OFDM fixed tx rate for 11g.  Try downgrading the channel
1076184302Ssam		 * in the scan list to 11b and retry the rate check.
1077184302Ssam		 */
1078184302Ssam		if (IEEE80211_IS_CHAN_ANYG(se->se_chan)) {
1079184302Ssam			rate = check_rate(vap, demote11b(vap, se->se_chan), se);
1080184302Ssam			if ((rate & IEEE80211_RATE_BASIC) == 0) {
1081184302Ssam				fail &= ~MATCH_RATE;
1082184302Ssam				se0->se_flags |= STA_DEMOTE11B;
1083184302Ssam			}
1084184302Ssam		}
1085184302Ssam	} else if (rate < 2*24) {
1086184302Ssam		/*
1087184302Ssam		 * This is an 11b-only ap.  Check the desired mode in
1088184302Ssam		 * case that needs to be honored (mode 11g filters out
1089184302Ssam		 * 11b-only ap's).  Otherwise force any 11g channel used
1090184302Ssam		 * in scanning to be demoted.
1091184302Ssam		 *
1092184302Ssam		 * NB: we cheat a bit here by looking at the max rate;
1093184302Ssam		 *     we could/should check the rates.
1094184302Ssam		 */
1095184302Ssam		if (!(vap->iv_des_mode == IEEE80211_MODE_AUTO ||
1096184302Ssam		      vap->iv_des_mode == IEEE80211_MODE_11B))
1097184302Ssam			fail |= MATCH_RATE;
1098184302Ssam		else
1099184302Ssam			se0->se_flags |= STA_DEMOTE11B;
1100184302Ssam	}
1101170530Ssam	if (ss->ss_nssid != 0 &&
1102171409Ssam	    !match_ssid(se->se_ssid, ss->ss_nssid, ss->ss_ssid))
1103171409Ssam		fail |= MATCH_SSID;
1104178354Ssam	if ((vap->iv_flags & IEEE80211_F_DESBSSID) &&
1105178354Ssam	    !IEEE80211_ADDR_EQ(vap->iv_des_bssid, se->se_bssid))
1106178354Ssam		fail |= MATCH_BSSID;
1107170530Ssam	if (se0->se_fails >= STA_FAILS_MAX)
1108171409Ssam		fail |= MATCH_FAILS;
1109170530Ssam	if (se0->se_notseen >= STA_PURGE_SCANS)
1110171409Ssam		fail |= MATCH_NOTSEEN;
1111170530Ssam	if (se->se_rssi < STA_RSSI_MIN)
1112171409Ssam		fail |= MATCH_RSSI;
1113170530Ssam#ifdef IEEE80211_DEBUG
1114178354Ssam	if (ieee80211_msg(vap, debug)) {
1115170530Ssam		printf(" %c %s",
1116171409Ssam		    fail & MATCH_FAILS ? '=' :
1117171409Ssam		    fail & MATCH_NOTSEEN ? '^' :
1118178354Ssam		    fail & MATCH_CC ? '$' :
1119186904Ssam#ifdef IEEE80211_SUPPORT_TDMA
1120186904Ssam		    fail & MATCH_TDMA_NOIE ? '&' :
1121189980Ssam		    fail & MATCH_TDMA_VERSION ? 'v' :
1122189980Ssam		    fail & MATCH_TDMA_NOTMASTER ? 's' :
1123189980Ssam		    fail & MATCH_TDMA_NOSLOT ? 'f' :
1124189980Ssam		    fail & MATCH_TDMA_LOCAL ? 'l' :
1125186904Ssam#endif
1126195618Srpaulo		    fail & MATCH_MESH_NOID ? 'm' :
1127171409Ssam		    fail ? '-' : '+', ether_sprintf(se->se_macaddr));
1128170530Ssam		printf(" %s%c", ether_sprintf(se->se_bssid),
1129171409Ssam		    fail & MATCH_BSSID ? '!' : ' ');
1130170530Ssam		printf(" %3d%c", ieee80211_chan2ieee(ic, se->se_chan),
1131171409Ssam			fail & MATCH_CHANNEL ? '!' : ' ');
1132171409Ssam		printf(" %+4d%c", se->se_rssi, fail & MATCH_RSSI ? '!' : ' ');
1133170530Ssam		printf(" %2dM%c", (rate & IEEE80211_RATE_VAL) / 2,
1134171409Ssam		    fail & MATCH_RATE ? '!' : ' ');
1135170530Ssam		printf(" %4s%c",
1136170530Ssam		    (se->se_capinfo & IEEE80211_CAPINFO_ESS) ? "ess" :
1137189980Ssam		    (se->se_capinfo & IEEE80211_CAPINFO_IBSS) ? "ibss" : "",
1138171409Ssam		    fail & MATCH_CAPINFO ? '!' : ' ');
1139170530Ssam		printf(" %3s%c ",
1140170530Ssam		    (se->se_capinfo & IEEE80211_CAPINFO_PRIVACY) ?
1141170530Ssam		    "wep" : "no",
1142171409Ssam		    fail & MATCH_PRIVACY ? '!' : ' ');
1143170530Ssam		ieee80211_print_essid(se->se_ssid+2, se->se_ssid[1]);
1144195618Srpaulo		printf("%s\n", fail & (MATCH_SSID | MATCH_MESHID) ? "!" : "");
1145170530Ssam	}
1146170530Ssam#endif
1147170530Ssam	return fail;
1148170530Ssam}
1149170530Ssam
1150170530Ssamstatic void
1151170530Ssamsta_update_notseen(struct sta_table *st)
1152170530Ssam{
1153170530Ssam	struct sta_entry *se;
1154170530Ssam
1155206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1156170530Ssam	TAILQ_FOREACH(se, &st->st_entry, se_list) {
1157170530Ssam		/*
1158170530Ssam		 * If seen the reset and don't bump the count;
1159170530Ssam		 * otherwise bump the ``not seen'' count.  Note
1160170530Ssam		 * that this insures that stations for which we
1161170530Ssam		 * see frames while not scanning but not during
1162170530Ssam		 * this scan will not be penalized.
1163170530Ssam		 */
1164170530Ssam		if (se->se_seen)
1165170530Ssam			se->se_seen = 0;
1166170530Ssam		else
1167170530Ssam			se->se_notseen++;
1168170530Ssam	}
1169206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1170170530Ssam}
1171170530Ssam
1172170530Ssamstatic void
1173170530Ssamsta_dec_fails(struct sta_table *st)
1174170530Ssam{
1175170530Ssam	struct sta_entry *se;
1176170530Ssam
1177206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1178170530Ssam	TAILQ_FOREACH(se, &st->st_entry, se_list)
1179170530Ssam		if (se->se_fails)
1180170530Ssam			se->se_fails--;
1181206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1182170530Ssam}
1183170530Ssam
1184170530Ssamstatic struct sta_entry *
1185178354Ssamselect_bss(struct ieee80211_scan_state *ss, struct ieee80211vap *vap, int debug)
1186170530Ssam{
1187170530Ssam	struct sta_table *st = ss->ss_priv;
1188170530Ssam	struct sta_entry *se, *selbs = NULL;
1189170530Ssam
1190178354Ssam	IEEE80211_DPRINTF(vap, debug, " %s\n",
1191170530Ssam	    "macaddr          bssid         chan  rssi  rate flag  wep  essid");
1192206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1193170530Ssam	TAILQ_FOREACH(se, &st->st_entry, se_list) {
1194184275Ssam		ieee80211_ies_expand(&se->base.se_ies);
1195178354Ssam		if (match_bss(vap, ss, se, debug) == 0) {
1196170530Ssam			if (selbs == NULL)
1197170530Ssam				selbs = se;
1198170530Ssam			else if (sta_compare(se, selbs) > 0)
1199170530Ssam				selbs = se;
1200170530Ssam		}
1201170530Ssam	}
1202206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1203170530Ssam
1204170530Ssam	return selbs;
1205170530Ssam}
1206170530Ssam
1207170530Ssam/*
1208170530Ssam * Pick an ap or ibss network to join or find a channel
1209170530Ssam * to use to start an ibss network.
1210170530Ssam */
1211170530Ssamstatic int
1212178354Ssamsta_pick_bss(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1213170530Ssam{
1214170530Ssam	struct sta_table *st = ss->ss_priv;
1215170530Ssam	struct sta_entry *selbs;
1216184274Ssam	struct ieee80211_channel *chan;
1217170530Ssam
1218178354Ssam	KASSERT(vap->iv_opmode == IEEE80211_M_STA,
1219178354Ssam		("wrong mode %u", vap->iv_opmode));
1220170530Ssam
1221170530Ssam	if (st->st_newscan) {
1222170530Ssam		sta_update_notseen(st);
1223170530Ssam		st->st_newscan = 0;
1224170530Ssam	}
1225170530Ssam	if (ss->ss_flags & IEEE80211_SCAN_NOPICK) {
1226170530Ssam		/*
1227170530Ssam		 * Manual/background scan, don't select+join the
1228170530Ssam		 * bss, just return.  The scanning framework will
1229170530Ssam		 * handle notification that this has completed.
1230170530Ssam		 */
1231170530Ssam		ss->ss_flags &= ~IEEE80211_SCAN_NOPICK;
1232170530Ssam		return 1;
1233170530Ssam	}
1234170530Ssam	/*
1235170530Ssam	 * Automatic sequencing; look for a candidate and
1236170530Ssam	 * if found join the network.
1237170530Ssam	 */
1238170530Ssam	/* NB: unlocked read should be ok */
1239170530Ssam	if (TAILQ_FIRST(&st->st_entry) == NULL) {
1240178354Ssam		IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN,
1241170530Ssam			"%s: no scan candidate\n", __func__);
1242178354Ssam		if (ss->ss_flags & IEEE80211_SCAN_NOJOIN)
1243178354Ssam			return 0;
1244170530Ssamnotfound:
1245170530Ssam		/*
1246170530Ssam		 * If nothing suitable was found decrement
1247170530Ssam		 * the failure counts so entries will be
1248170530Ssam		 * reconsidered the next time around.  We
1249170530Ssam		 * really want to do this only for sta's
1250170530Ssam		 * where we've previously had some success.
1251170530Ssam		 */
1252170530Ssam		sta_dec_fails(st);
1253170530Ssam		st->st_newscan = 1;
1254170530Ssam		return 0;			/* restart scan */
1255170530Ssam	}
1256178354Ssam	selbs = select_bss(ss, vap, IEEE80211_MSG_SCAN);
1257178354Ssam	if (ss->ss_flags & IEEE80211_SCAN_NOJOIN)
1258178354Ssam		return (selbs != NULL);
1259184274Ssam	if (selbs == NULL)
1260170530Ssam		goto notfound;
1261184274Ssam	chan = selbs->base.se_chan;
1262184302Ssam	if (selbs->se_flags & STA_DEMOTE11B)
1263184302Ssam		chan = demote11b(vap, chan);
1264184274Ssam	if (!ieee80211_sta_join(vap, chan, &selbs->base))
1265184274Ssam		goto notfound;
1266170530Ssam	return 1;				/* terminate scan */
1267170530Ssam}
1268170530Ssam
1269170530Ssam/*
1270170530Ssam * Lookup an entry in the scan cache.  We assume we're
1271170530Ssam * called from the bottom half or such that we don't need
1272170530Ssam * to block the bottom half so that it's safe to return
1273170530Ssam * a reference to an entry w/o holding the lock on the table.
1274170530Ssam */
1275170530Ssamstatic struct sta_entry *
1276170530Ssamsta_lookup(struct sta_table *st, const uint8_t macaddr[IEEE80211_ADDR_LEN])
1277170530Ssam{
1278170530Ssam	struct sta_entry *se;
1279170530Ssam	int hash = STA_HASH(macaddr);
1280170530Ssam
1281206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1282170530Ssam	LIST_FOREACH(se, &st->st_hash[hash], se_hash)
1283170530Ssam		if (IEEE80211_ADDR_EQ(se->base.se_macaddr, macaddr))
1284170530Ssam			break;
1285206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1286170530Ssam
1287170530Ssam	return se;		/* NB: unlocked */
1288170530Ssam}
1289170530Ssam
1290170530Ssamstatic void
1291178354Ssamsta_roam_check(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1292170530Ssam{
1293178354Ssam	struct ieee80211com *ic = vap->iv_ic;
1294178354Ssam	struct ieee80211_node *ni = vap->iv_bss;
1295170530Ssam	struct sta_table *st = ss->ss_priv;
1296178354Ssam	enum ieee80211_phymode mode;
1297170530Ssam	struct sta_entry *se, *selbs;
1298178354Ssam	uint8_t roamRate, curRate, ucastRate;
1299170530Ssam	int8_t roamRssi, curRssi;
1300170530Ssam
1301170530Ssam	se = sta_lookup(st, ni->ni_macaddr);
1302170530Ssam	if (se == NULL) {
1303170530Ssam		/* XXX something is wrong */
1304170530Ssam		return;
1305170530Ssam	}
1306170530Ssam
1307178354Ssam	mode = ieee80211_chan2mode(ic->ic_bsschan);
1308178354Ssam	roamRate = vap->iv_roamparms[mode].rate;
1309178354Ssam	roamRssi = vap->iv_roamparms[mode].rssi;
1310178354Ssam	ucastRate = vap->iv_txparms[mode].ucastrate;
1311170530Ssam	/* NB: the most up to date rssi is in the node, not the scan cache */
1312170530Ssam	curRssi = ic->ic_node_getrssi(ni);
1313178354Ssam	if (ucastRate == IEEE80211_FIXED_RATE_NONE) {
1314178354Ssam		curRate = ni->ni_txrate;
1315178354Ssam		roamRate &= IEEE80211_RATE_VAL;
1316178354Ssam		IEEE80211_DPRINTF(vap, IEEE80211_MSG_ROAM,
1317170530Ssam		    "%s: currssi %d currate %u roamrssi %d roamrate %u\n",
1318170530Ssam		    __func__, curRssi, curRate, roamRssi, roamRate);
1319170530Ssam	} else {
1320170530Ssam		curRate = roamRate;	/* NB: insure compare below fails */
1321178354Ssam		IEEE80211_DPRINTF(vap, IEEE80211_MSG_ROAM,
1322170530Ssam		    "%s: currssi %d roamrssi %d\n", __func__, curRssi, roamRssi);
1323170530Ssam	}
1324170530Ssam	/*
1325170530Ssam	 * Check if a new ap should be used and switch.
1326170530Ssam	 * XXX deauth current ap
1327170530Ssam	 */
1328170530Ssam	if (curRate < roamRate || curRssi < roamRssi) {
1329178354Ssam		if (time_after(ticks, ic->ic_lastscan + vap->iv_scanvalid)) {
1330170530Ssam			/*
1331170530Ssam			 * Scan cache contents are too old; force a scan now
1332170530Ssam			 * if possible so we have current state to make a
1333170530Ssam			 * decision with.  We don't kick off a bg scan if
1334170530Ssam			 * we're using dynamic turbo and boosted or if the
1335170530Ssam			 * channel is busy.
1336170530Ssam			 * XXX force immediate switch on scan complete
1337170530Ssam			 */
1338170530Ssam			if (!IEEE80211_IS_CHAN_DTURBO(ic->ic_curchan) &&
1339178354Ssam			    time_after(ticks, ic->ic_lastdata + vap->iv_bgscanidle))
1340178354Ssam				ieee80211_bg_scan(vap, 0);
1341170530Ssam			return;
1342170530Ssam		}
1343170530Ssam		se->base.se_rssi = curRssi;
1344178354Ssam		selbs = select_bss(ss, vap, IEEE80211_MSG_ROAM);
1345170530Ssam		if (selbs != NULL && selbs != se) {
1346184274Ssam			struct ieee80211_channel *chan;
1347184274Ssam
1348178354Ssam			IEEE80211_DPRINTF(vap,
1349170530Ssam			    IEEE80211_MSG_ROAM | IEEE80211_MSG_DEBUG,
1350170530Ssam			    "%s: ROAM: curRate %u, roamRate %u, "
1351170530Ssam			    "curRssi %d, roamRssi %d\n", __func__,
1352170530Ssam			    curRate, roamRate, curRssi, roamRssi);
1353184274Ssam
1354184274Ssam			chan = selbs->base.se_chan;
1355184302Ssam			if (selbs->se_flags & STA_DEMOTE11B)
1356184302Ssam				chan = demote11b(vap, chan);
1357184274Ssam			(void) ieee80211_sta_join(vap, chan, &selbs->base);
1358170530Ssam		}
1359170530Ssam	}
1360170530Ssam}
1361170530Ssam
1362170530Ssam/*
1363170530Ssam * Age entries in the scan cache.
1364170530Ssam * XXX also do roaming since it's convenient
1365170530Ssam */
1366170530Ssamstatic void
1367170530Ssamsta_age(struct ieee80211_scan_state *ss)
1368170530Ssam{
1369178354Ssam	struct ieee80211vap *vap = ss->ss_vap;
1370170530Ssam
1371178354Ssam	adhoc_age(ss);
1372170530Ssam	/*
1373170530Ssam	 * If rate control is enabled check periodically to see if
1374170530Ssam	 * we should roam from our current connection to one that
1375170530Ssam	 * might be better.  This only applies when we're operating
1376170530Ssam	 * in sta mode and automatic roaming is set.
1377170530Ssam	 * XXX defer if busy
1378170530Ssam	 * XXX repeater station
1379170530Ssam	 * XXX do when !bgscan?
1380170530Ssam	 */
1381178354Ssam	KASSERT(vap->iv_opmode == IEEE80211_M_STA,
1382178354Ssam		("wrong mode %u", vap->iv_opmode));
1383178354Ssam	if (vap->iv_roaming == IEEE80211_ROAMING_AUTO &&
1384213321Sadrian	    (vap->iv_flags & IEEE80211_F_BGSCAN) &&
1385178354Ssam	    vap->iv_state >= IEEE80211_S_RUN)
1386170530Ssam		/* XXX vap is implicit */
1387178354Ssam		sta_roam_check(ss, vap);
1388170530Ssam}
1389170530Ssam
1390170530Ssam/*
1391170530Ssam * Iterate over the entries in the scan cache, invoking
1392170530Ssam * the callback function on each one.
1393170530Ssam */
1394170530Ssamstatic void
1395170530Ssamsta_iterate(struct ieee80211_scan_state *ss,
1396170530Ssam	ieee80211_scan_iter_func *f, void *arg)
1397170530Ssam{
1398170530Ssam	struct sta_table *st = ss->ss_priv;
1399170530Ssam	struct sta_entry *se;
1400170530Ssam	u_int gen;
1401170530Ssam
1402170530Ssam	mtx_lock(&st->st_scanlock);
1403178354Ssam	gen = st->st_scaniter++;
1404170530Ssamrestart:
1405206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1406170530Ssam	TAILQ_FOREACH(se, &st->st_entry, se_list) {
1407170530Ssam		if (se->se_scangen != gen) {
1408170530Ssam			se->se_scangen = gen;
1409170530Ssam			/* update public state */
1410170530Ssam			se->base.se_age = ticks - se->se_lastupdate;
1411206617Srpaulo			IEEE80211_SCAN_TABLE_UNLOCK(st);
1412170530Ssam			(*f)(arg, &se->base);
1413170530Ssam			goto restart;
1414170530Ssam		}
1415170530Ssam	}
1416206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1417170530Ssam
1418170530Ssam	mtx_unlock(&st->st_scanlock);
1419170530Ssam}
1420170530Ssam
1421170530Ssamstatic void
1422170530Ssamsta_assoc_fail(struct ieee80211_scan_state *ss,
1423170530Ssam	const uint8_t macaddr[IEEE80211_ADDR_LEN], int reason)
1424170530Ssam{
1425170530Ssam	struct sta_table *st = ss->ss_priv;
1426170530Ssam	struct sta_entry *se;
1427170530Ssam
1428170530Ssam	se = sta_lookup(st, macaddr);
1429170530Ssam	if (se != NULL) {
1430170530Ssam		se->se_fails++;
1431170530Ssam		se->se_lastfail = ticks;
1432178354Ssam		IEEE80211_NOTE_MAC(ss->ss_vap, IEEE80211_MSG_SCAN,
1433170530Ssam		    macaddr, "%s: reason %u fails %u",
1434170530Ssam		    __func__, reason, se->se_fails);
1435170530Ssam	}
1436170530Ssam}
1437170530Ssam
1438170530Ssamstatic void
1439170530Ssamsta_assoc_success(struct ieee80211_scan_state *ss,
1440170530Ssam	const uint8_t macaddr[IEEE80211_ADDR_LEN])
1441170530Ssam{
1442170530Ssam	struct sta_table *st = ss->ss_priv;
1443170530Ssam	struct sta_entry *se;
1444170530Ssam
1445170530Ssam	se = sta_lookup(st, macaddr);
1446170530Ssam	if (se != NULL) {
1447170530Ssam#if 0
1448170530Ssam		se->se_fails = 0;
1449178354Ssam		IEEE80211_NOTE_MAC(ss->ss_vap, IEEE80211_MSG_SCAN,
1450170530Ssam		    macaddr, "%s: fails %u",
1451170530Ssam		    __func__, se->se_fails);
1452170530Ssam#endif
1453170530Ssam		se->se_lastassoc = ticks;
1454170530Ssam	}
1455170530Ssam}
1456170530Ssam
1457170530Ssamstatic const struct ieee80211_scanner sta_default = {
1458170530Ssam	.scan_name		= "default",
1459170530Ssam	.scan_attach		= sta_attach,
1460170530Ssam	.scan_detach		= sta_detach,
1461170530Ssam	.scan_start		= sta_start,
1462170530Ssam	.scan_restart		= sta_restart,
1463170530Ssam	.scan_cancel		= sta_cancel,
1464170530Ssam	.scan_end		= sta_pick_bss,
1465170530Ssam	.scan_flush		= sta_flush,
1466170530Ssam	.scan_add		= sta_add,
1467170530Ssam	.scan_age		= sta_age,
1468170530Ssam	.scan_iterate		= sta_iterate,
1469170530Ssam	.scan_assoc_fail	= sta_assoc_fail,
1470170530Ssam	.scan_assoc_success	= sta_assoc_success,
1471170530Ssam};
1472195618SrpauloIEEE80211_SCANNER_ALG(sta, IEEE80211_M_STA, sta_default);
1473170530Ssam
1474170530Ssam/*
1475170530Ssam * Adhoc mode-specific support.
1476170530Ssam */
1477170530Ssam
1478170530Ssamstatic const uint16_t adhocWorld[] =		/* 36, 40, 44, 48 */
1479170530Ssam{ 5180, 5200, 5220, 5240 };
1480170530Ssamstatic const uint16_t adhocFcc3[] =		/* 36, 40, 44, 48 145, 149, 153, 157, 161, 165 */
1481170530Ssam{ 5180, 5200, 5220, 5240, 5725, 5745, 5765, 5785, 5805, 5825 };
1482170530Ssamstatic const uint16_t adhocMkk[] =		/* 34, 38, 42, 46 */
1483170530Ssam{ 5170, 5190, 5210, 5230 };
1484170530Ssamstatic const uint16_t adhoc11b[] =		/* 10, 11 */
1485170530Ssam{ 2457, 2462 };
1486170530Ssam
1487170530Ssamstatic const struct scanlist adhocScanTable[] = {
1488170530Ssam	{ IEEE80211_MODE_11B,   	X(adhoc11b) },
1489170530Ssam	{ IEEE80211_MODE_11A,   	X(adhocWorld) },
1490170530Ssam	{ IEEE80211_MODE_11A,   	X(adhocFcc3) },
1491170530Ssam	{ IEEE80211_MODE_11B,   	X(adhocMkk) },
1492170530Ssam	{ .list = NULL }
1493170530Ssam};
1494170530Ssam#undef X
1495170530Ssam
1496170530Ssam/*
1497170530Ssam * Start an adhoc-mode scan by populating the channel list.
1498170530Ssam */
1499170530Ssamstatic int
1500178354Ssamadhoc_start(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1501170530Ssam{
1502170530Ssam	struct sta_table *st = ss->ss_priv;
1503170530Ssam
1504178354Ssam	makescanlist(ss, vap, adhocScanTable);
1505176653Ssam
1506178354Ssam	if (ss->ss_mindwell == 0)
1507178354Ssam		ss->ss_mindwell = msecs_to_ticks(200);	/* 200ms */
1508178354Ssam	if (ss->ss_maxdwell == 0)
1509178354Ssam		ss->ss_maxdwell = msecs_to_ticks(200);	/* 200ms */
1510176653Ssam
1511178354Ssam	st->st_scangen++;
1512170530Ssam	st->st_newscan = 1;
1513170530Ssam
1514170530Ssam	return 0;
1515170530Ssam}
1516170530Ssam
1517170530Ssam/*
1518170530Ssam * Select a channel to start an adhoc network on.
1519170530Ssam * The channel list was populated with appropriate
1520170530Ssam * channels so select one that looks least occupied.
1521170530Ssam */
1522170530Ssamstatic struct ieee80211_channel *
1523178354Ssamadhoc_pick_channel(struct ieee80211_scan_state *ss, int flags)
1524170530Ssam{
1525170530Ssam	struct sta_table *st = ss->ss_priv;
1526170530Ssam	struct sta_entry *se;
1527170530Ssam	struct ieee80211_channel *c, *bestchan;
1528170530Ssam	int i, bestrssi, maxrssi;
1529170530Ssam
1530170530Ssam	bestchan = NULL;
1531170530Ssam	bestrssi = -1;
1532170530Ssam
1533206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1534170530Ssam	for (i = 0; i < ss->ss_last; i++) {
1535170530Ssam		c = ss->ss_chans[i];
1536178354Ssam		/* never consider a channel with radar */
1537178354Ssam		if (IEEE80211_IS_CHAN_RADAR(c))
1538176653Ssam			continue;
1539178354Ssam		/* skip channels disallowed by regulatory settings */
1540178354Ssam		if (IEEE80211_IS_CHAN_NOADHOC(c))
1541178354Ssam			continue;
1542178354Ssam		/* check channel attributes for band compatibility */
1543178354Ssam		if (flags != 0 && (c->ic_flags & flags) != flags)
1544178354Ssam			continue;
1545170530Ssam		maxrssi = 0;
1546170530Ssam		TAILQ_FOREACH(se, &st->st_entry, se_list) {
1547170530Ssam			if (se->base.se_chan != c)
1548170530Ssam				continue;
1549170530Ssam			if (se->base.se_rssi > maxrssi)
1550170530Ssam				maxrssi = se->base.se_rssi;
1551170530Ssam		}
1552170530Ssam		if (bestchan == NULL || maxrssi < bestrssi)
1553170530Ssam			bestchan = c;
1554170530Ssam	}
1555206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1556170530Ssam
1557170530Ssam	return bestchan;
1558170530Ssam}
1559170530Ssam
1560170530Ssam/*
1561170530Ssam * Pick an ibss network to join or find a channel
1562170530Ssam * to use to start an ibss network.
1563170530Ssam */
1564170530Ssamstatic int
1565178354Ssamadhoc_pick_bss(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1566170530Ssam{
1567170530Ssam	struct sta_table *st = ss->ss_priv;
1568170530Ssam	struct sta_entry *selbs;
1569170530Ssam	struct ieee80211_channel *chan;
1570170530Ssam
1571178354Ssam	KASSERT(vap->iv_opmode == IEEE80211_M_IBSS ||
1572195618Srpaulo		vap->iv_opmode == IEEE80211_M_AHDEMO ||
1573195618Srpaulo		vap->iv_opmode == IEEE80211_M_MBSS,
1574178354Ssam		("wrong opmode %u", vap->iv_opmode));
1575170530Ssam
1576170530Ssam	if (st->st_newscan) {
1577170530Ssam		sta_update_notseen(st);
1578170530Ssam		st->st_newscan = 0;
1579170530Ssam	}
1580170530Ssam	if (ss->ss_flags & IEEE80211_SCAN_NOPICK) {
1581170530Ssam		/*
1582170530Ssam		 * Manual/background scan, don't select+join the
1583170530Ssam		 * bss, just return.  The scanning framework will
1584170530Ssam		 * handle notification that this has completed.
1585170530Ssam		 */
1586170530Ssam		ss->ss_flags &= ~IEEE80211_SCAN_NOPICK;
1587170530Ssam		return 1;
1588170530Ssam	}
1589170530Ssam	/*
1590170530Ssam	 * Automatic sequencing; look for a candidate and
1591170530Ssam	 * if found join the network.
1592170530Ssam	 */
1593170530Ssam	/* NB: unlocked read should be ok */
1594170530Ssam	if (TAILQ_FIRST(&st->st_entry) == NULL) {
1595178354Ssam		IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN,
1596170530Ssam			"%s: no scan candidate\n", __func__);
1597178354Ssam		if (ss->ss_flags & IEEE80211_SCAN_NOJOIN)
1598178354Ssam			return 0;
1599170530Ssamnotfound:
1600186904Ssam		/* NB: never auto-start a tdma network for slot !0 */
1601186904Ssam#ifdef IEEE80211_SUPPORT_TDMA
1602186904Ssam		if (vap->iv_des_nssid &&
1603186904Ssam		    ((vap->iv_caps & IEEE80211_C_TDMA) == 0 ||
1604186904Ssam		     ieee80211_tdma_getslot(vap) == 0)) {
1605186904Ssam#else
1606178354Ssam		if (vap->iv_des_nssid) {
1607186904Ssam#endif
1608170530Ssam			/*
1609170530Ssam			 * No existing adhoc network to join and we have
1610170530Ssam			 * an ssid; start one up.  If no channel was
1611170530Ssam			 * specified, try to select a channel.
1612170530Ssam			 */
1613178354Ssam			if (vap->iv_des_chan == IEEE80211_CHAN_ANYC ||
1614178354Ssam			    IEEE80211_IS_CHAN_RADAR(vap->iv_des_chan)) {
1615183421Ssam				struct ieee80211com *ic = vap->iv_ic;
1616183421Ssam
1617183421Ssam				chan = adhoc_pick_channel(ss, 0);
1618183421Ssam				if (chan != NULL)
1619183421Ssam					chan = ieee80211_ht_adjust_channel(ic,
1620193655Ssam					    chan, vap->iv_flags_ht);
1621178354Ssam			} else
1622178354Ssam				chan = vap->iv_des_chan;
1623170530Ssam			if (chan != NULL) {
1624178354Ssam				ieee80211_create_ibss(vap, chan);
1625170530Ssam				return 1;
1626170530Ssam			}
1627170530Ssam		}
1628170530Ssam		/*
1629170530Ssam		 * If nothing suitable was found decrement
1630170530Ssam		 * the failure counts so entries will be
1631170530Ssam		 * reconsidered the next time around.  We
1632170530Ssam		 * really want to do this only for sta's
1633170530Ssam		 * where we've previously had some success.
1634170530Ssam		 */
1635170530Ssam		sta_dec_fails(st);
1636170530Ssam		st->st_newscan = 1;
1637170530Ssam		return 0;			/* restart scan */
1638170530Ssam	}
1639178354Ssam	selbs = select_bss(ss, vap, IEEE80211_MSG_SCAN);
1640178354Ssam	if (ss->ss_flags & IEEE80211_SCAN_NOJOIN)
1641178354Ssam		return (selbs != NULL);
1642184274Ssam	if (selbs == NULL)
1643170530Ssam		goto notfound;
1644184274Ssam	chan = selbs->base.se_chan;
1645184302Ssam	if (selbs->se_flags & STA_DEMOTE11B)
1646184302Ssam		chan = demote11b(vap, chan);
1647184274Ssam	if (!ieee80211_sta_join(vap, chan, &selbs->base))
1648184274Ssam		goto notfound;
1649170530Ssam	return 1;				/* terminate scan */
1650170530Ssam}
1651170530Ssam
1652170530Ssam/*
1653170530Ssam * Age entries in the scan cache.
1654170530Ssam */
1655170530Ssamstatic void
1656170530Ssamadhoc_age(struct ieee80211_scan_state *ss)
1657170530Ssam{
1658170530Ssam	struct sta_table *st = ss->ss_priv;
1659170530Ssam	struct sta_entry *se, *next;
1660170530Ssam
1661206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1662170530Ssam	TAILQ_FOREACH_SAFE(se, &st->st_entry, se_list, next) {
1663170530Ssam		if (se->se_notseen > STA_PURGE_SCANS) {
1664170530Ssam			TAILQ_REMOVE(&st->st_entry, se, se_list);
1665170530Ssam			LIST_REMOVE(se, se_hash);
1666178354Ssam			ieee80211_ies_cleanup(&se->base.se_ies);
1667186302Ssam			free(se, M_80211_SCAN);
1668170530Ssam		}
1669170530Ssam	}
1670206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1671170530Ssam}
1672170530Ssam
1673170530Ssamstatic const struct ieee80211_scanner adhoc_default = {
1674170530Ssam	.scan_name		= "default",
1675170530Ssam	.scan_attach		= sta_attach,
1676170530Ssam	.scan_detach		= sta_detach,
1677170530Ssam	.scan_start		= adhoc_start,
1678170530Ssam	.scan_restart		= sta_restart,
1679170530Ssam	.scan_cancel		= sta_cancel,
1680170530Ssam	.scan_end		= adhoc_pick_bss,
1681170530Ssam	.scan_flush		= sta_flush,
1682178354Ssam	.scan_pickchan		= adhoc_pick_channel,
1683170530Ssam	.scan_add		= sta_add,
1684170530Ssam	.scan_age		= adhoc_age,
1685170530Ssam	.scan_iterate		= sta_iterate,
1686170530Ssam	.scan_assoc_fail	= sta_assoc_fail,
1687170530Ssam	.scan_assoc_success	= sta_assoc_success,
1688170530Ssam};
1689195618SrpauloIEEE80211_SCANNER_ALG(ibss, IEEE80211_M_IBSS, adhoc_default);
1690195618SrpauloIEEE80211_SCANNER_ALG(ahdemo, IEEE80211_M_AHDEMO, adhoc_default);
1691170530Ssam
1692178354Ssamstatic void
1693178354Ssamap_force_promisc(struct ieee80211com *ic)
1694178354Ssam{
1695178354Ssam	struct ifnet *ifp = ic->ic_ifp;
1696178354Ssam
1697178354Ssam	IEEE80211_LOCK(ic);
1698178354Ssam	/* set interface into promiscuous mode */
1699178354Ssam	ifp->if_flags |= IFF_PROMISC;
1700191746Sthompsa	ieee80211_runtask(ic, &ic->ic_promisc_task);
1701178354Ssam	IEEE80211_UNLOCK(ic);
1702178354Ssam}
1703178354Ssam
1704178354Ssamstatic void
1705178354Ssamap_reset_promisc(struct ieee80211com *ic)
1706178354Ssam{
1707178354Ssam	IEEE80211_LOCK(ic);
1708178354Ssam	ieee80211_syncifflag_locked(ic, IFF_PROMISC);
1709178354Ssam	IEEE80211_UNLOCK(ic);
1710178354Ssam}
1711178354Ssam
1712178354Ssamstatic int
1713178354Ssamap_start(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1714178354Ssam{
1715178354Ssam	struct sta_table *st = ss->ss_priv;
1716178354Ssam
1717178354Ssam	makescanlist(ss, vap, staScanTable);
1718178354Ssam
1719178354Ssam	if (ss->ss_mindwell == 0)
1720178354Ssam		ss->ss_mindwell = msecs_to_ticks(200);	/* 200ms */
1721178354Ssam	if (ss->ss_maxdwell == 0)
1722178354Ssam		ss->ss_maxdwell = msecs_to_ticks(200);	/* 200ms */
1723178354Ssam
1724178354Ssam	st->st_scangen++;
1725178354Ssam	st->st_newscan = 1;
1726178354Ssam
1727178354Ssam	ap_force_promisc(vap->iv_ic);
1728178354Ssam	return 0;
1729178354Ssam}
1730178354Ssam
1731170530Ssam/*
1732178354Ssam * Cancel an ongoing scan.
1733170530Ssam */
1734170530Ssamstatic int
1735178354Ssamap_cancel(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1736170530Ssam{
1737178354Ssam	ap_reset_promisc(vap->iv_ic);
1738178354Ssam	return 0;
1739178354Ssam}
1740178354Ssam
1741178354Ssam/*
1742178354Ssam * Pick a quiet channel to use for ap operation.
1743178354Ssam */
1744178354Ssamstatic struct ieee80211_channel *
1745178354Ssamap_pick_channel(struct ieee80211_scan_state *ss, int flags)
1746178354Ssam{
1747178354Ssam	struct sta_table *st = ss->ss_priv;
1748178354Ssam	struct ieee80211_channel *bestchan = NULL;
1749178354Ssam	int i;
1750178354Ssam
1751178354Ssam	/* XXX select channel more intelligently, e.g. channel spread, power */
1752178354Ssam	/* NB: use scan list order to preserve channel preference */
1753178354Ssam	for (i = 0; i < ss->ss_last; i++) {
1754178354Ssam		struct ieee80211_channel *chan = ss->ss_chans[i];
1755178354Ssam		/*
1756178354Ssam		 * If the channel is unoccupied the max rssi
1757178354Ssam		 * should be zero; just take it.  Otherwise
1758178354Ssam		 * track the channel with the lowest rssi and
1759178354Ssam		 * use that when all channels appear occupied.
1760178354Ssam		 */
1761178354Ssam		if (IEEE80211_IS_CHAN_RADAR(chan))
1762178354Ssam			continue;
1763178354Ssam		if (IEEE80211_IS_CHAN_NOHOSTAP(chan))
1764178354Ssam			continue;
1765178354Ssam		/* check channel attributes for band compatibility */
1766178354Ssam		if (flags != 0 && (chan->ic_flags & flags) != flags)
1767178354Ssam			continue;
1768186107Ssam		KASSERT(sizeof(chan->ic_ieee) == 1, ("ic_chan size"));
1769178354Ssam		/* XXX channel have interference */
1770178354Ssam		if (st->st_maxrssi[chan->ic_ieee] == 0) {
1771178354Ssam			/* XXX use other considerations */
1772178354Ssam			return chan;
1773170530Ssam		}
1774178354Ssam		if (bestchan == NULL ||
1775178354Ssam		    st->st_maxrssi[chan->ic_ieee] < st->st_maxrssi[bestchan->ic_ieee])
1776178354Ssam			bestchan = chan;
1777178354Ssam	}
1778178354Ssam	return bestchan;
1779178354Ssam}
1780178354Ssam
1781178354Ssam/*
1782178354Ssam * Pick a quiet channel to use for ap operation.
1783178354Ssam */
1784178354Ssamstatic int
1785178354Ssamap_end(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1786178354Ssam{
1787178354Ssam	struct ieee80211com *ic = vap->iv_ic;
1788178354Ssam	struct ieee80211_channel *bestchan;
1789178354Ssam
1790178354Ssam	KASSERT(vap->iv_opmode == IEEE80211_M_HOSTAP,
1791178354Ssam		("wrong opmode %u", vap->iv_opmode));
1792178354Ssam	bestchan = ap_pick_channel(ss, 0);
1793178354Ssam	if (bestchan == NULL) {
1794178354Ssam		/* no suitable channel, should not happen */
1795178354Ssam		IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN,
1796178354Ssam		    "%s: no suitable channel! (should not happen)\n", __func__);
1797178354Ssam		/* XXX print something? */
1798178354Ssam		return 0;			/* restart scan */
1799178354Ssam	}
1800178354Ssam	/*
1801178354Ssam	 * If this is a dynamic turbo channel, start with the unboosted one.
1802178354Ssam	 */
1803178354Ssam	if (IEEE80211_IS_CHAN_TURBO(bestchan)) {
1804178354Ssam		bestchan = ieee80211_find_channel(ic, bestchan->ic_freq,
1805178354Ssam			bestchan->ic_flags & ~IEEE80211_CHAN_TURBO);
1806178354Ssam		if (bestchan == NULL) {
1807178354Ssam			/* should never happen ?? */
1808178354Ssam			return 0;
1809170530Ssam		}
1810170530Ssam	}
1811178354Ssam	ap_reset_promisc(ic);
1812178354Ssam	if (ss->ss_flags & (IEEE80211_SCAN_NOPICK | IEEE80211_SCAN_NOJOIN)) {
1813178354Ssam		/*
1814178354Ssam		 * Manual/background scan, don't select+join the
1815178354Ssam		 * bss, just return.  The scanning framework will
1816178354Ssam		 * handle notification that this has completed.
1817178354Ssam		 */
1818178354Ssam		ss->ss_flags &= ~IEEE80211_SCAN_NOPICK;
1819178354Ssam		return 1;
1820178354Ssam	}
1821178354Ssam	ieee80211_create_ibss(vap,
1822193655Ssam	    ieee80211_ht_adjust_channel(ic, bestchan, vap->iv_flags_ht));
1823178354Ssam	return 1;
1824170530Ssam}
1825170530Ssam
1826178354Ssamstatic const struct ieee80211_scanner ap_default = {
1827178354Ssam	.scan_name		= "default",
1828178354Ssam	.scan_attach		= sta_attach,
1829178354Ssam	.scan_detach		= sta_detach,
1830178354Ssam	.scan_start		= ap_start,
1831178354Ssam	.scan_restart		= sta_restart,
1832178354Ssam	.scan_cancel		= ap_cancel,
1833178354Ssam	.scan_end		= ap_end,
1834178354Ssam	.scan_flush		= sta_flush,
1835178354Ssam	.scan_pickchan		= ap_pick_channel,
1836178354Ssam	.scan_add		= sta_add,
1837178354Ssam	.scan_age		= adhoc_age,
1838178354Ssam	.scan_iterate		= sta_iterate,
1839178354Ssam	.scan_assoc_success	= sta_assoc_success,
1840178354Ssam	.scan_assoc_fail	= sta_assoc_fail,
1841170530Ssam};
1842195618SrpauloIEEE80211_SCANNER_ALG(ap, IEEE80211_M_HOSTAP, ap_default);
1843178354Ssam
1844195618Srpaulo#ifdef IEEE80211_SUPPORT_MESH
1845178354Ssam/*
1846195618Srpaulo * Pick an mbss network to join or find a channel
1847195618Srpaulo * to use to start an mbss network.
1848178354Ssam */
1849195618Srpaulostatic int
1850195618Srpaulomesh_pick_bss(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1851195618Srpaulo{
1852195618Srpaulo	struct sta_table *st = ss->ss_priv;
1853195618Srpaulo	struct ieee80211_mesh_state *ms = vap->iv_mesh;
1854195618Srpaulo	struct sta_entry *selbs;
1855195618Srpaulo	struct ieee80211_channel *chan;
1856195618Srpaulo
1857195618Srpaulo	KASSERT(vap->iv_opmode == IEEE80211_M_MBSS,
1858195618Srpaulo		("wrong opmode %u", vap->iv_opmode));
1859195618Srpaulo
1860195618Srpaulo	if (st->st_newscan) {
1861195618Srpaulo		sta_update_notseen(st);
1862195618Srpaulo		st->st_newscan = 0;
1863195618Srpaulo	}
1864195618Srpaulo	if (ss->ss_flags & IEEE80211_SCAN_NOPICK) {
1865195618Srpaulo		/*
1866195618Srpaulo		 * Manual/background scan, don't select+join the
1867195618Srpaulo		 * bss, just return.  The scanning framework will
1868195618Srpaulo		 * handle notification that this has completed.
1869195618Srpaulo		 */
1870195618Srpaulo		ss->ss_flags &= ~IEEE80211_SCAN_NOPICK;
1871195618Srpaulo		return 1;
1872195618Srpaulo	}
1873195618Srpaulo	/*
1874195618Srpaulo	 * Automatic sequencing; look for a candidate and
1875195618Srpaulo	 * if found join the network.
1876195618Srpaulo	 */
1877195618Srpaulo	/* NB: unlocked read should be ok */
1878195618Srpaulo	if (TAILQ_FIRST(&st->st_entry) == NULL) {
1879195618Srpaulo		IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN,
1880195618Srpaulo			"%s: no scan candidate\n", __func__);
1881195618Srpaulo		if (ss->ss_flags & IEEE80211_SCAN_NOJOIN)
1882195618Srpaulo			return 0;
1883195618Srpaulonotfound:
1884195618Srpaulo		if (ms->ms_idlen != 0) {
1885195618Srpaulo			/*
1886195618Srpaulo			 * No existing mbss network to join and we have
1887195618Srpaulo			 * a meshid; start one up.  If no channel was
1888195618Srpaulo			 * specified, try to select a channel.
1889195618Srpaulo			 */
1890195618Srpaulo			if (vap->iv_des_chan == IEEE80211_CHAN_ANYC ||
1891195618Srpaulo			    IEEE80211_IS_CHAN_RADAR(vap->iv_des_chan)) {
1892195618Srpaulo				struct ieee80211com *ic = vap->iv_ic;
1893195618Srpaulo
1894195618Srpaulo				chan = adhoc_pick_channel(ss, 0);
1895195618Srpaulo				if (chan != NULL)
1896195618Srpaulo					chan = ieee80211_ht_adjust_channel(ic,
1897195618Srpaulo					    chan, vap->iv_flags_ht);
1898195618Srpaulo			} else
1899195618Srpaulo				chan = vap->iv_des_chan;
1900195618Srpaulo			if (chan != NULL) {
1901195618Srpaulo				ieee80211_create_ibss(vap, chan);
1902195618Srpaulo				return 1;
1903195618Srpaulo			}
1904195618Srpaulo		}
1905195618Srpaulo		/*
1906195618Srpaulo		 * If nothing suitable was found decrement
1907195618Srpaulo		 * the failure counts so entries will be
1908195618Srpaulo		 * reconsidered the next time around.  We
1909195618Srpaulo		 * really want to do this only for sta's
1910195618Srpaulo		 * where we've previously had some success.
1911195618Srpaulo		 */
1912195618Srpaulo		sta_dec_fails(st);
1913195618Srpaulo		st->st_newscan = 1;
1914195618Srpaulo		return 0;			/* restart scan */
1915195618Srpaulo	}
1916195618Srpaulo	selbs = select_bss(ss, vap, IEEE80211_MSG_SCAN);
1917195618Srpaulo	if (ss->ss_flags & IEEE80211_SCAN_NOJOIN)
1918195618Srpaulo		return (selbs != NULL);
1919195618Srpaulo	if (selbs == NULL)
1920195618Srpaulo		goto notfound;
1921195618Srpaulo	chan = selbs->base.se_chan;
1922195618Srpaulo	if (selbs->se_flags & STA_DEMOTE11B)
1923195618Srpaulo		chan = demote11b(vap, chan);
1924195618Srpaulo	if (!ieee80211_sta_join(vap, chan, &selbs->base))
1925195618Srpaulo		goto notfound;
1926195618Srpaulo	return 1;				/* terminate scan */
1927195618Srpaulo}
1928195618Srpaulo
1929195618Srpaulostatic const struct ieee80211_scanner mesh_default = {
1930195618Srpaulo	.scan_name		= "default",
1931195618Srpaulo	.scan_attach		= sta_attach,
1932195618Srpaulo	.scan_detach		= sta_detach,
1933195618Srpaulo	.scan_start		= adhoc_start,
1934195618Srpaulo	.scan_restart		= sta_restart,
1935195618Srpaulo	.scan_cancel		= sta_cancel,
1936195618Srpaulo	.scan_end		= mesh_pick_bss,
1937195618Srpaulo	.scan_flush		= sta_flush,
1938195618Srpaulo	.scan_pickchan		= adhoc_pick_channel,
1939195618Srpaulo	.scan_add		= sta_add,
1940195618Srpaulo	.scan_age		= adhoc_age,
1941195618Srpaulo	.scan_iterate		= sta_iterate,
1942195618Srpaulo	.scan_assoc_fail	= sta_assoc_fail,
1943195618Srpaulo	.scan_assoc_success	= sta_assoc_success,
1944195618Srpaulo};
1945195618SrpauloIEEE80211_SCANNER_ALG(mesh, IEEE80211_M_MBSS, mesh_default);
1946195618Srpaulo#endif /* IEEE80211_SUPPORT_MESH */
1947