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: stable/11/sys/net80211/ieee80211_scan_sta.c 344223 2019-02-17 03:12:27Z avos $");
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>
37298359Savos#include <sys/endian.h>
38295126Sglebius#include <sys/malloc.h>
39170530Ssam#include <sys/module.h>
40191746Sthompsa
41170530Ssam#include <sys/socket.h>
42170530Ssam
43170530Ssam#include <net/if.h>
44257176Sglebius#include <net/if_var.h>
45170530Ssam#include <net/if_media.h>
46170530Ssam#include <net/ethernet.h>
47170530Ssam
48170530Ssam#include <net80211/ieee80211_var.h>
49178354Ssam#include <net80211/ieee80211_input.h>
50178354Ssam#include <net80211/ieee80211_regdomain.h>
51186904Ssam#ifdef IEEE80211_SUPPORT_TDMA
52186904Ssam#include <net80211/ieee80211_tdma.h>
53186904Ssam#endif
54195618Srpaulo#ifdef IEEE80211_SUPPORT_MESH
55195618Srpaulo#include <net80211/ieee80211_mesh.h>
56195618Srpaulo#endif
57245928Sadrian#include <net80211/ieee80211_ratectl.h>
58170530Ssam
59170530Ssam#include <net/bpf.h>
60170530Ssam
61170530Ssam/*
62170530Ssam * Parameters for managing cache entries:
63170530Ssam *
64170530Ssam * o a station with STA_FAILS_MAX failures is not considered
65170530Ssam *   when picking a candidate
66170530Ssam * o a station that hasn't had an update in STA_PURGE_SCANS
67170530Ssam *   (background) scans is discarded
68170530Ssam * o after STA_FAILS_AGE seconds we clear the failure count
69170530Ssam */
70170530Ssam#define	STA_FAILS_MAX	2		/* assoc failures before ignored */
71170530Ssam#define	STA_FAILS_AGE	(2*60)		/* time before clearing fails (secs) */
72170530Ssam#define	STA_PURGE_SCANS	2		/* age for purging entries (scans) */
73170530Ssam
74170530Ssam/* XXX tunable */
75170530Ssam#define	STA_RSSI_MIN	8		/* min acceptable rssi */
76170530Ssam#define	STA_RSSI_MAX	40		/* max rssi for comparison */
77170530Ssam
78170530Ssamstruct sta_entry {
79170530Ssam	struct ieee80211_scan_entry base;
80170530Ssam	TAILQ_ENTRY(sta_entry) se_list;
81170530Ssam	LIST_ENTRY(sta_entry) se_hash;
82170530Ssam	uint8_t		se_fails;		/* failure to associate count */
83170530Ssam	uint8_t		se_seen;		/* seen during current scan */
84170530Ssam	uint8_t		se_notseen;		/* not seen in previous scans */
85170530Ssam	uint8_t		se_flags;
86184302Ssam#define	STA_DEMOTE11B	0x01			/* match w/ demoted 11b chan */
87170530Ssam	uint32_t	se_avgrssi;		/* LPF rssi state */
88170530Ssam	unsigned long	se_lastupdate;		/* time of last update */
89170530Ssam	unsigned long	se_lastfail;		/* time of last failure */
90170530Ssam	unsigned long	se_lastassoc;		/* time of last association */
91170530Ssam	u_int		se_scangen;		/* iterator scan gen# */
92178354Ssam	u_int		se_countrygen;		/* gen# of last cc notify */
93170530Ssam};
94170530Ssam
95170530Ssam#define	STA_HASHSIZE	32
96170530Ssam/* simple hash is enough for variation of macaddr */
97170530Ssam#define	STA_HASH(addr)	\
98170530Ssam	(((const uint8_t *)(addr))[IEEE80211_ADDR_LEN - 1] % STA_HASHSIZE)
99170530Ssam
100186107Ssam#define	MAX_IEEE_CHAN	256			/* max acceptable IEEE chan # */
101186107SsamCTASSERT(MAX_IEEE_CHAN >= 256);
102186107Ssam
103170530Ssamstruct sta_table {
104206617Srpaulo	ieee80211_scan_table_lock_t st_lock;	/* on scan table */
105170530Ssam	TAILQ_HEAD(, sta_entry) st_entry;	/* all entries */
106170530Ssam	LIST_HEAD(, sta_entry) st_hash[STA_HASHSIZE];
107283556Sadrian	ieee80211_scan_iter_lock_t st_scanlock;		/* on st_scaniter */
108178354Ssam	u_int		st_scaniter;		/* gen# for iterator */
109178354Ssam	u_int		st_scangen;		/* scan generation # */
110170530Ssam	int		st_newscan;
111178354Ssam	/* ap-related state */
112186107Ssam	int		st_maxrssi[MAX_IEEE_CHAN];
113170530Ssam};
114170530Ssam
115170530Ssamstatic void sta_flush_table(struct sta_table *);
116171409Ssam/*
117171409Ssam * match_bss returns a bitmask describing if an entry is suitable
118171409Ssam * for use.  If non-zero the entry was deemed not suitable and it's
119330446Seadler * contents explains why.  The following flags are or'd to this
120171409Ssam * mask and can be used to figure out why the entry was rejected.
121171409Ssam */
122195618Srpaulo#define	MATCH_CHANNEL		0x00001	/* channel mismatch */
123195618Srpaulo#define	MATCH_CAPINFO		0x00002	/* capabilities mismatch, e.g. no ess */
124195618Srpaulo#define	MATCH_PRIVACY		0x00004	/* privacy mismatch */
125195618Srpaulo#define	MATCH_RATE		0x00008	/* rate set mismatch */
126195618Srpaulo#define	MATCH_SSID		0x00010	/* ssid mismatch */
127195618Srpaulo#define	MATCH_BSSID		0x00020	/* bssid mismatch */
128195618Srpaulo#define	MATCH_FAILS		0x00040	/* too many failed auth attempts */
129195618Srpaulo#define	MATCH_NOTSEEN		0x00080	/* not seen in recent scans */
130195618Srpaulo#define	MATCH_RSSI		0x00100	/* rssi deemed too low to use */
131195618Srpaulo#define	MATCH_CC		0x00200	/* country code mismatch */
132300232Savos#ifdef IEEE80211_SUPPORT_TDMA
133195618Srpaulo#define	MATCH_TDMA_NOIE		0x00400	/* no TDMA ie */
134195618Srpaulo#define	MATCH_TDMA_NOTMASTER	0x00800	/* not TDMA master */
135195618Srpaulo#define	MATCH_TDMA_NOSLOT	0x01000	/* all TDMA slots occupied */
136195618Srpaulo#define	MATCH_TDMA_LOCAL	0x02000	/* local address */
137195618Srpaulo#define	MATCH_TDMA_VERSION	0x04000	/* protocol version mismatch */
138300232Savos#endif
139195618Srpaulo#define	MATCH_MESH_NOID		0x10000	/* no MESHID ie */
140195618Srpaulo#define	MATCH_MESHID		0x20000	/* meshid mismatch */
141178354Ssamstatic int match_bss(struct ieee80211vap *,
142170530Ssam	const struct ieee80211_scan_state *, struct sta_entry *, int);
143178354Ssamstatic void adhoc_age(struct ieee80211_scan_state *);
144170530Ssam
145178354Ssamstatic __inline int
146178354Ssamisocmp(const uint8_t cc1[], const uint8_t cc2[])
147178354Ssam{
148178354Ssam     return (cc1[0] == cc2[0] && cc1[1] == cc2[1]);
149178354Ssam}
150178354Ssam
151170530Ssam/* number of references from net80211 layer */
152170530Ssamstatic	int nrefs = 0;
153195618Srpaulo/*
154195618Srpaulo * Module glue.
155195618Srpaulo */
156195618SrpauloIEEE80211_SCANNER_MODULE(sta, 1);
157170530Ssam
158170530Ssam/*
159170530Ssam * Attach prior to any scanning work.
160170530Ssam */
161170530Ssamstatic int
162170530Ssamsta_attach(struct ieee80211_scan_state *ss)
163170530Ssam{
164170530Ssam	struct sta_table *st;
165170530Ssam
166283538Sadrian	st = (struct sta_table *) IEEE80211_MALLOC(sizeof(struct sta_table),
167283538Sadrian		M_80211_SCAN,
168283538Sadrian		IEEE80211_M_NOWAIT | IEEE80211_M_ZERO);
169170530Ssam	if (st == NULL)
170170530Ssam		return 0;
171206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK_INIT(st, "scantable");
172283556Sadrian	IEEE80211_SCAN_ITER_LOCK_INIT(st, "scangen");
173170530Ssam	TAILQ_INIT(&st->st_entry);
174170530Ssam	ss->ss_priv = st;
175170530Ssam	nrefs++;			/* NB: we assume caller locking */
176170530Ssam	return 1;
177170530Ssam}
178170530Ssam
179170530Ssam/*
180170530Ssam * Cleanup any private state.
181170530Ssam */
182170530Ssamstatic int
183170530Ssamsta_detach(struct ieee80211_scan_state *ss)
184170530Ssam{
185170530Ssam	struct sta_table *st = ss->ss_priv;
186170530Ssam
187170530Ssam	if (st != NULL) {
188170530Ssam		sta_flush_table(st);
189206617Srpaulo		IEEE80211_SCAN_TABLE_LOCK_DESTROY(st);
190283556Sadrian		IEEE80211_SCAN_ITER_LOCK_DESTROY(st);
191283538Sadrian		IEEE80211_FREE(st, M_80211_SCAN);
192170530Ssam		KASSERT(nrefs > 0, ("imbalanced attach/detach"));
193170530Ssam		nrefs--;		/* NB: we assume caller locking */
194170530Ssam	}
195170530Ssam	return 1;
196170530Ssam}
197170530Ssam
198170530Ssam/*
199170530Ssam * Flush all per-scan state.
200170530Ssam */
201170530Ssamstatic int
202170530Ssamsta_flush(struct ieee80211_scan_state *ss)
203170530Ssam{
204170530Ssam	struct sta_table *st = ss->ss_priv;
205170530Ssam
206206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
207170530Ssam	sta_flush_table(st);
208206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
209170530Ssam	ss->ss_last = 0;
210170530Ssam	return 0;
211170530Ssam}
212170530Ssam
213170530Ssam/*
214170530Ssam * Flush all entries in the scan cache.
215170530Ssam */
216170530Ssamstatic void
217170530Ssamsta_flush_table(struct sta_table *st)
218170530Ssam{
219170530Ssam	struct sta_entry *se, *next;
220170530Ssam
221170530Ssam	TAILQ_FOREACH_SAFE(se, &st->st_entry, se_list, next) {
222170530Ssam		TAILQ_REMOVE(&st->st_entry, se, se_list);
223170530Ssam		LIST_REMOVE(se, se_hash);
224178354Ssam		ieee80211_ies_cleanup(&se->base.se_ies);
225283538Sadrian		IEEE80211_FREE(se, M_80211_SCAN);
226170530Ssam	}
227178354Ssam	memset(st->st_maxrssi, 0, sizeof(st->st_maxrssi));
228170530Ssam}
229170530Ssam
230170530Ssam/*
231170530Ssam * Process a beacon or probe response frame; create an
232170530Ssam * entry in the scan cache or update any previous entry.
233170530Ssam */
234170530Ssamstatic int
235170530Ssamsta_add(struct ieee80211_scan_state *ss,
236282742Sadrian	struct ieee80211_channel *curchan,
237170530Ssam	const struct ieee80211_scanparams *sp,
238170530Ssam	const struct ieee80211_frame *wh,
239192468Ssam	int subtype, int rssi, int noise)
240170530Ssam{
241170530Ssam#define	ISPROBE(_st)	((_st) == IEEE80211_FC0_SUBTYPE_PROBE_RESP)
242170530Ssam#define	PICK1ST(_ss) \
243170530Ssam	((ss->ss_flags & (IEEE80211_SCAN_PICK1ST | IEEE80211_SCAN_GOTPICK)) == \
244170530Ssam	IEEE80211_SCAN_PICK1ST)
245170530Ssam	struct sta_table *st = ss->ss_priv;
246170530Ssam	const uint8_t *macaddr = wh->i_addr2;
247178354Ssam	struct ieee80211vap *vap = ss->ss_vap;
248178354Ssam	struct ieee80211com *ic = vap->iv_ic;
249224717Sbschmidt	struct ieee80211_channel *c;
250170530Ssam	struct sta_entry *se;
251170530Ssam	struct ieee80211_scan_entry *ise;
252178354Ssam	int hash;
253170530Ssam
254170530Ssam	hash = STA_HASH(macaddr);
255170530Ssam
256206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
257170530Ssam	LIST_FOREACH(se, &st->st_hash[hash], se_hash)
258170530Ssam		if (IEEE80211_ADDR_EQ(se->base.se_macaddr, macaddr))
259170530Ssam			goto found;
260283538Sadrian	se = (struct sta_entry *) IEEE80211_MALLOC(sizeof(struct sta_entry),
261283538Sadrian		M_80211_SCAN, IEEE80211_M_NOWAIT | IEEE80211_M_ZERO);
262170530Ssam	if (se == NULL) {
263206617Srpaulo		IEEE80211_SCAN_TABLE_UNLOCK(st);
264170530Ssam		return 0;
265170530Ssam	}
266178354Ssam	se->se_scangen = st->st_scaniter-1;
267178354Ssam	se->se_avgrssi = IEEE80211_RSSI_DUMMY_MARKER;
268170530Ssam	IEEE80211_ADDR_COPY(se->base.se_macaddr, macaddr);
269170530Ssam	TAILQ_INSERT_TAIL(&st->st_entry, se, se_list);
270170530Ssam	LIST_INSERT_HEAD(&st->st_hash[hash], se, se_hash);
271170530Ssamfound:
272170530Ssam	ise = &se->base;
273170530Ssam	/* XXX ap beaconing multiple ssid w/ same bssid */
274170530Ssam	if (sp->ssid[1] != 0 &&
275170530Ssam	    (ISPROBE(subtype) || ise->se_ssid[1] == 0))
276170530Ssam		memcpy(ise->se_ssid, sp->ssid, 2+sp->ssid[1]);
277170530Ssam	KASSERT(sp->rates[1] <= IEEE80211_RATE_MAXSIZE,
278170530Ssam		("rate set too large: %u", sp->rates[1]));
279170530Ssam	memcpy(ise->se_rates, sp->rates, 2+sp->rates[1]);
280170530Ssam	if (sp->xrates != NULL) {
281170530Ssam		/* XXX validate xrates[1] */
282178354Ssam		KASSERT(sp->xrates[1] <= IEEE80211_RATE_MAXSIZE,
283170530Ssam			("xrate set too large: %u", sp->xrates[1]));
284170530Ssam		memcpy(ise->se_xrates, sp->xrates, 2+sp->xrates[1]);
285170530Ssam	} else
286170530Ssam		ise->se_xrates[1] = 0;
287170530Ssam	IEEE80211_ADDR_COPY(ise->se_bssid, wh->i_addr3);
288178354Ssam	if ((sp->status & IEEE80211_BPARSE_OFFCHAN) == 0) {
289173368Ssam		/*
290173368Ssam		 * Record rssi data using extended precision LPF filter.
291173368Ssam		 *
292173368Ssam		 * NB: use only on-channel data to insure we get a good
293173368Ssam		 *     estimate of the signal we'll see when associated.
294173368Ssam		 */
295178354Ssam		IEEE80211_RSSI_LPF(se->se_avgrssi, rssi);
296178354Ssam		ise->se_rssi = IEEE80211_RSSI_GET(se->se_avgrssi);
297173368Ssam		ise->se_noise = noise;
298173368Ssam	}
299170530Ssam	memcpy(ise->se_tstamp.data, sp->tstamp, sizeof(ise->se_tstamp));
300170530Ssam	ise->se_intval = sp->bintval;
301170530Ssam	ise->se_capinfo = sp->capinfo;
302195618Srpaulo#ifdef IEEE80211_SUPPORT_MESH
303195618Srpaulo	if (sp->meshid != NULL && sp->meshid[1] != 0)
304195618Srpaulo		memcpy(ise->se_meshid, sp->meshid, 2+sp->meshid[1]);
305195618Srpaulo#endif
306173368Ssam	/*
307173368Ssam	 * Beware of overriding se_chan for frames seen
308173368Ssam	 * off-channel; this can cause us to attempt an
309178354Ssam	 * association on the wrong channel.
310173368Ssam	 */
311178354Ssam	if (sp->status & IEEE80211_BPARSE_OFFCHAN) {
312173368Ssam		/*
313173862Ssam		 * Off-channel, locate the home/bss channel for the sta
314178354Ssam		 * using the value broadcast in the DSPARMS ie.  We know
315178354Ssam		 * sp->chan has this value because it's used to calculate
316178354Ssam		 * IEEE80211_BPARSE_OFFCHAN.
317173368Ssam		 */
318178354Ssam		c = ieee80211_find_channel_byieee(ic, sp->chan,
319282742Sadrian		    curchan->ic_flags);
320173956Ssam		if (c != NULL) {
321173956Ssam			ise->se_chan = c;
322173956Ssam		} else if (ise->se_chan == NULL) {
323173862Ssam			/* should not happen, pick something */
324282742Sadrian			ise->se_chan = curchan;
325173862Ssam		}
326173862Ssam	} else
327282742Sadrian		ise->se_chan = curchan;
328224717Sbschmidt	if (IEEE80211_IS_CHAN_HT(ise->se_chan) && sp->htcap == NULL) {
329224717Sbschmidt		/* Demote legacy networks to a non-HT channel. */
330224717Sbschmidt		c = ieee80211_find_channel(ic, ise->se_chan->ic_freq,
331224717Sbschmidt		    ise->se_chan->ic_flags & ~IEEE80211_CHAN_HT);
332224717Sbschmidt		KASSERT(c != NULL,
333224717Sbschmidt		    ("no legacy channel %u", ise->se_chan->ic_ieee));
334224717Sbschmidt		ise->se_chan = c;
335224717Sbschmidt	}
336170530Ssam	ise->se_fhdwell = sp->fhdwell;
337170530Ssam	ise->se_fhindex = sp->fhindex;
338170530Ssam	ise->se_erp = sp->erp;
339170530Ssam	ise->se_timoff = sp->timoff;
340170530Ssam	if (sp->tim != NULL) {
341170530Ssam		const struct ieee80211_tim_ie *tim =
342170530Ssam		    (const struct ieee80211_tim_ie *) sp->tim;
343170530Ssam		ise->se_dtimperiod = tim->tim_period;
344170530Ssam	}
345178354Ssam	if (sp->country != NULL) {
346178354Ssam		const struct ieee80211_country_ie *cie =
347178354Ssam		    (const struct ieee80211_country_ie *) sp->country;
348178354Ssam		/*
349178354Ssam		 * If 11d is enabled and we're attempting to join a bss
350178354Ssam		 * that advertises it's country code then compare our
351178354Ssam		 * current settings to what we fetched from the country ie.
352178354Ssam		 * If our country code is unspecified or different then
353178354Ssam		 * dispatch an event to user space that identifies the
354178354Ssam		 * country code so our regdomain config can be changed.
355178354Ssam		 */
356178354Ssam		/* XXX only for STA mode? */
357178354Ssam		if ((IEEE80211_IS_CHAN_11D(ise->se_chan) ||
358178354Ssam		    (vap->iv_flags_ext & IEEE80211_FEXT_DOTD)) &&
359178354Ssam		    (ic->ic_regdomain.country == CTRY_DEFAULT ||
360178354Ssam		     !isocmp(cie->cc, ic->ic_regdomain.isocc))) {
361178354Ssam			/* only issue one notify event per scan */
362178354Ssam			if (se->se_countrygen != st->st_scangen) {
363178354Ssam				ieee80211_notify_country(vap, ise->se_bssid,
364178354Ssam				    cie->cc);
365178354Ssam				se->se_countrygen = st->st_scangen;
366178354Ssam			}
367178354Ssam		}
368178354Ssam		ise->se_cc[0] = cie->cc[0];
369178354Ssam		ise->se_cc[1] = cie->cc[1];
370178354Ssam	}
371178354Ssam	/* NB: no need to setup ie ptrs; they are not (currently) used */
372178354Ssam	(void) ieee80211_ies_init(&ise->se_ies, sp->ies, sp->ies_len);
373170530Ssam
374170530Ssam	/* clear failure count after STA_FAIL_AGE passes */
375170530Ssam	if (se->se_fails && (ticks - se->se_lastfail) > STA_FAILS_AGE*hz) {
376170530Ssam		se->se_fails = 0;
377178354Ssam		IEEE80211_NOTE_MAC(vap, IEEE80211_MSG_SCAN, macaddr,
378170530Ssam		    "%s: fails %u", __func__, se->se_fails);
379170530Ssam	}
380170530Ssam
381170530Ssam	se->se_lastupdate = ticks;		/* update time */
382170530Ssam	se->se_seen = 1;
383170530Ssam	se->se_notseen = 0;
384170530Ssam
385186107Ssam	KASSERT(sizeof(sp->bchan) == 1, ("bchan size"));
386178354Ssam	if (rssi > st->st_maxrssi[sp->bchan])
387178354Ssam		st->st_maxrssi[sp->bchan] = rssi;
388178354Ssam
389206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
390170530Ssam
391170530Ssam	/*
392170530Ssam	 * If looking for a quick choice and nothing's
393170530Ssam	 * been found check here.
394170530Ssam	 */
395178354Ssam	if (PICK1ST(ss) && match_bss(vap, ss, se, IEEE80211_MSG_SCAN) == 0)
396170530Ssam		ss->ss_flags |= IEEE80211_SCAN_GOTPICK;
397170530Ssam
398170530Ssam	return 1;
399170530Ssam#undef PICK1ST
400170530Ssam#undef ISPROBE
401170530Ssam}
402170530Ssam
403170530Ssam/*
404170530Ssam * Check if a channel is excluded by user request.
405170530Ssam */
406170530Ssamstatic int
407178354Ssamisexcluded(struct ieee80211vap *vap, const struct ieee80211_channel *c)
408170530Ssam{
409178354Ssam	return (isclr(vap->iv_ic->ic_chan_active, c->ic_ieee) ||
410178354Ssam	    (vap->iv_des_chan != IEEE80211_CHAN_ANYC &&
411178354Ssam	     c->ic_freq != vap->iv_des_chan->ic_freq));
412170530Ssam}
413170530Ssam
414170530Ssamstatic struct ieee80211_channel *
415170530Ssamfind11gchannel(struct ieee80211com *ic, int i, int freq)
416170530Ssam{
417170530Ssam	struct ieee80211_channel *c;
418170530Ssam	int j;
419170530Ssam
420170530Ssam	/*
421170530Ssam	 * The normal ordering in the channel list is b channel
422170530Ssam	 * immediately followed by g so optimize the search for
423170530Ssam	 * this.  We'll still do a full search just in case.
424170530Ssam	 */
425170530Ssam	for (j = i+1; j < ic->ic_nchans; j++) {
426170530Ssam		c = &ic->ic_channels[j];
427187991Ssam		if (c->ic_freq == freq && IEEE80211_IS_CHAN_G(c))
428170530Ssam			return c;
429170530Ssam	}
430170530Ssam	for (j = 0; j < i; j++) {
431170530Ssam		c = &ic->ic_channels[j];
432187991Ssam		if (c->ic_freq == freq && IEEE80211_IS_CHAN_G(c))
433170530Ssam			return c;
434170530Ssam	}
435170530Ssam	return NULL;
436170530Ssam}
437188777Ssam
438170530Ssamstatic const u_int chanflags[IEEE80211_MODE_MAX] = {
439188777Ssam	[IEEE80211_MODE_AUTO]	  = IEEE80211_CHAN_B,
440188777Ssam	[IEEE80211_MODE_11A]	  = IEEE80211_CHAN_A,
441188777Ssam	[IEEE80211_MODE_11B]	  = IEEE80211_CHAN_B,
442188777Ssam	[IEEE80211_MODE_11G]	  = IEEE80211_CHAN_G,
443188777Ssam	[IEEE80211_MODE_FH]	  = IEEE80211_CHAN_FHSS,
444188777Ssam	/* check base channel */
445188777Ssam	[IEEE80211_MODE_TURBO_A]  = IEEE80211_CHAN_A,
446188777Ssam	[IEEE80211_MODE_TURBO_G]  = IEEE80211_CHAN_G,
447188777Ssam	[IEEE80211_MODE_STURBO_A] = IEEE80211_CHAN_ST,
448188782Ssam	[IEEE80211_MODE_HALF]	  = IEEE80211_CHAN_HALF,
449188782Ssam	[IEEE80211_MODE_QUARTER]  = IEEE80211_CHAN_QUARTER,
450188777Ssam	/* check legacy */
451188777Ssam	[IEEE80211_MODE_11NA]	  = IEEE80211_CHAN_A,
452188777Ssam	[IEEE80211_MODE_11NG]	  = IEEE80211_CHAN_G,
453170530Ssam};
454170530Ssam
455170530Ssamstatic void
456178354Ssamadd_channels(struct ieee80211vap *vap,
457170530Ssam	struct ieee80211_scan_state *ss,
458170530Ssam	enum ieee80211_phymode mode, const uint16_t freq[], int nfreq)
459170530Ssam{
460178354Ssam	struct ieee80211com *ic = vap->iv_ic;
461170530Ssam	struct ieee80211_channel *c, *cg;
462170530Ssam	u_int modeflags;
463170530Ssam	int i;
464170530Ssam
465254315Srpaulo	KASSERT(mode < nitems(chanflags), ("Unexpected mode %u", mode));
466170530Ssam	modeflags = chanflags[mode];
467170530Ssam	for (i = 0; i < nfreq; i++) {
468170530Ssam		if (ss->ss_last >= IEEE80211_SCAN_MAX)
469170530Ssam			break;
470170530Ssam
471170530Ssam		c = ieee80211_find_channel(ic, freq[i], modeflags);
472178354Ssam		if (c == NULL || isexcluded(vap, c))
473170530Ssam			continue;
474170530Ssam		if (mode == IEEE80211_MODE_AUTO) {
475343510Savos			KASSERT(IEEE80211_IS_CHAN_B(c),
476343510Savos			    ("%s: wrong channel for 'auto' mode %u / %u\n",
477343510Savos			    __func__, c->ic_freq, c->ic_flags));
478343510Savos
479170530Ssam			/*
480170530Ssam			 * XXX special-case 11b/g channels so we select
481178354Ssam			 *     the g channel if both are present.
482170530Ssam			 */
483343510Savos			if ((cg = find11gchannel(ic, i, c->ic_freq)) != NULL)
484178354Ssam				c = cg;
485170530Ssam		}
486170530Ssam		ss->ss_chans[ss->ss_last++] = c;
487170530Ssam	}
488170530Ssam}
489170530Ssam
490170530Ssamstruct scanlist {
491170530Ssam	uint16_t	mode;
492170530Ssam	uint16_t	count;
493170530Ssam	const uint16_t	*list;
494170530Ssam};
495170530Ssam
496170530Ssamstatic int
497170530Ssamchecktable(const struct scanlist *scan, const struct ieee80211_channel *c)
498170530Ssam{
499170530Ssam	int i;
500170530Ssam
501170530Ssam	for (; scan->list != NULL; scan++) {
502170530Ssam		for (i = 0; i < scan->count; i++)
503170530Ssam			if (scan->list[i] == c->ic_freq)
504170530Ssam				return 1;
505170530Ssam	}
506170530Ssam	return 0;
507170530Ssam}
508170530Ssam
509189377Ssamstatic int
510189377Ssamonscanlist(const struct ieee80211_scan_state *ss,
511189377Ssam	const struct ieee80211_channel *c)
512189377Ssam{
513189377Ssam	int i;
514189377Ssam
515189377Ssam	for (i = 0; i < ss->ss_last; i++)
516189377Ssam		if (ss->ss_chans[i] == c)
517189377Ssam			return 1;
518189377Ssam	return 0;
519189377Ssam}
520189377Ssam
521176653Ssamstatic void
522178354Ssamsweepchannels(struct ieee80211_scan_state *ss, struct ieee80211vap *vap,
523176653Ssam	const struct scanlist table[])
524176653Ssam{
525178354Ssam	struct ieee80211com *ic = vap->iv_ic;
526176653Ssam	struct ieee80211_channel *c;
527176653Ssam	int i;
528176653Ssam
529176653Ssam	for (i = 0; i < ic->ic_nchans; i++) {
530176653Ssam		if (ss->ss_last >= IEEE80211_SCAN_MAX)
531176653Ssam			break;
532176653Ssam
533176653Ssam		c = &ic->ic_channels[i];
534176653Ssam		/*
535176653Ssam		 * Ignore dynamic turbo channels; we scan them
536176653Ssam		 * in normal mode (i.e. not boosted).  Likewise
537176653Ssam		 * for HT channels, they get scanned using
538176653Ssam		 * legacy rates.
539176653Ssam		 */
540176653Ssam		if (IEEE80211_IS_CHAN_DTURBO(c) || IEEE80211_IS_CHAN_HT(c))
541176653Ssam			continue;
542176653Ssam
543176653Ssam		/*
544176653Ssam		 * If a desired mode was specified, scan only
545176653Ssam		 * channels that satisfy that constraint.
546176653Ssam		 */
547178354Ssam		if (vap->iv_des_mode != IEEE80211_MODE_AUTO &&
548178354Ssam		    vap->iv_des_mode != ieee80211_chan2mode(c))
549176653Ssam			continue;
550176653Ssam
551176653Ssam		/*
552176653Ssam		 * Skip channels excluded by user request.
553176653Ssam		 */
554178354Ssam		if (isexcluded(vap, c))
555176653Ssam			continue;
556176653Ssam
557176653Ssam		/*
558176653Ssam		 * Add the channel unless it is listed in the
559176653Ssam		 * fixed scan order tables.  This insures we
560176653Ssam		 * don't sweep back in channels we filtered out
561176653Ssam		 * above.
562176653Ssam		 */
563176653Ssam		if (checktable(table, c))
564176653Ssam			continue;
565176653Ssam
566176653Ssam		/* Add channel to scanning list. */
567176653Ssam		ss->ss_chans[ss->ss_last++] = c;
568176653Ssam	}
569189377Ssam	/*
570189377Ssam	 * Explicitly add any desired channel if:
571189377Ssam	 * - not already on the scan list
572189377Ssam	 * - allowed by any desired mode constraint
573189377Ssam	 * - there is space in the scan list
574189377Ssam	 * This allows the channel to be used when the filtering
575189377Ssam	 * mechanisms would otherwise elide it (e.g HT, turbo).
576189377Ssam	 */
577189377Ssam	c = vap->iv_des_chan;
578189377Ssam	if (c != IEEE80211_CHAN_ANYC &&
579189377Ssam	    !onscanlist(ss, c) &&
580189377Ssam	    (vap->iv_des_mode == IEEE80211_MODE_AUTO ||
581189377Ssam	     vap->iv_des_mode == ieee80211_chan2mode(c)) &&
582189377Ssam	    ss->ss_last < IEEE80211_SCAN_MAX)
583189377Ssam		ss->ss_chans[ss->ss_last++] = c;
584176653Ssam}
585176653Ssam
586178354Ssamstatic void
587178354Ssammakescanlist(struct ieee80211_scan_state *ss, struct ieee80211vap *vap,
588178354Ssam	const struct scanlist table[])
589170530Ssam{
590170530Ssam	const struct scanlist *scan;
591170530Ssam	enum ieee80211_phymode mode;
592170530Ssam
593170530Ssam	ss->ss_last = 0;
594170530Ssam	/*
595170530Ssam	 * Use the table of ordered channels to construct the list
596170530Ssam	 * of channels for scanning.  Any channels in the ordered
597170530Ssam	 * list not in the master list will be discarded.
598170530Ssam	 */
599178354Ssam	for (scan = table; scan->list != NULL; scan++) {
600170530Ssam		mode = scan->mode;
601343509Savos
602343509Savos		switch (mode) {
603343509Savos		case IEEE80211_MODE_11B:
604343509Savos			if (vap->iv_des_mode == IEEE80211_MODE_11B)
605343509Savos				break;
606343509Savos
607170530Ssam			/*
608343509Savos			 * The scan table marks 2.4Ghz channels as b
609343509Savos			 * so if the desired mode is 11g / 11ng,
610343509Savos			 * then use the 11b channel list but upgrade the mode.
611343509Savos			 *
612343509Savos			 * NB: 11b -> AUTO lets add_channels upgrade an
613343509Savos			 * 11b channel to 11g if available.
614170530Ssam			 */
615343509Savos			if (vap->iv_des_mode == IEEE80211_MODE_AUTO ||
616343509Savos			    vap->iv_des_mode == IEEE80211_MODE_11G ||
617343509Savos			    vap->iv_des_mode == IEEE80211_MODE_11NG) {
618343509Savos				mode = vap->iv_des_mode;
619343509Savos				break;
620170530Ssam			}
621343509Savos
622343509Savos			continue;
623343509Savos		case IEEE80211_MODE_11A:
624343509Savos			/* Use 11a channel list for 11na mode */
625343509Savos			if (vap->iv_des_mode == IEEE80211_MODE_11NA) {
626343509Savos				mode = vap->iv_des_mode;
627343509Savos				break;
628343509Savos			}
629343509Savos
630343509Savos			/* FALLTHROUGH */
631343509Savos		default:
632170530Ssam			/*
633343509Savos			 * If a desired mode was specified, scan only
634343509Savos			 * channels that satisfy that constraint.
635170530Ssam			 */
636343509Savos			if (vap->iv_des_mode != IEEE80211_MODE_AUTO &&
637343509Savos			    vap->iv_des_mode != mode)
638343509Savos				continue;
639170530Ssam		}
640343509Savos
641170530Ssam#ifdef IEEE80211_F_XR
642170530Ssam		/* XR does not operate on turbo channels */
643178354Ssam		if ((vap->iv_flags & IEEE80211_F_XR) &&
644170530Ssam		    (mode == IEEE80211_MODE_TURBO_A ||
645170530Ssam		     mode == IEEE80211_MODE_TURBO_G ||
646170530Ssam		     mode == IEEE80211_MODE_STURBO_A))
647170530Ssam			continue;
648170530Ssam#endif
649170530Ssam		/*
650170530Ssam		 * Add the list of the channels; any that are not
651170530Ssam		 * in the master channel list will be discarded.
652170530Ssam		 */
653178354Ssam		add_channels(vap, ss, mode, scan->list, scan->count);
654170530Ssam	}
655170530Ssam
656170530Ssam	/*
657178354Ssam	 * Add the channels from the ic that are not present
658178354Ssam	 * in the table.
659170530Ssam	 */
660178354Ssam	sweepchannels(ss, vap, table);
661178354Ssam}
662170530Ssam
663178354Ssamstatic const uint16_t rcl1[] =		/* 8 FCC channel: 52, 56, 60, 64, 36, 40, 44, 48 */
664178354Ssam{ 5260, 5280, 5300, 5320, 5180, 5200, 5220, 5240 };
665178354Ssamstatic const uint16_t rcl2[] =		/* 4 MKK channels: 34, 38, 42, 46 */
666178354Ssam{ 5170, 5190, 5210, 5230 };
667178354Ssamstatic const uint16_t rcl3[] =		/* 2.4Ghz ch: 1,6,11,7,13 */
668178354Ssam{ 2412, 2437, 2462, 2442, 2472 };
669178354Ssamstatic const uint16_t rcl4[] =		/* 5 FCC channel: 149, 153, 161, 165 */
670178354Ssam{ 5745, 5765, 5785, 5805, 5825 };
671178354Ssamstatic const uint16_t rcl7[] =		/* 11 ETSI channel: 100,104,108,112,116,120,124,128,132,136,140 */
672178354Ssam{ 5500, 5520, 5540, 5560, 5580, 5600, 5620, 5640, 5660, 5680, 5700 };
673178354Ssamstatic const uint16_t rcl8[] =		/* 2.4Ghz ch: 2,3,4,5,8,9,10,12 */
674178354Ssam{ 2417, 2422, 2427, 2432, 2447, 2452, 2457, 2467 };
675178354Ssamstatic const uint16_t rcl9[] =		/* 2.4Ghz ch: 14 */
676178354Ssam{ 2484 };
677178354Ssamstatic const uint16_t rcl10[] =	/* Added Korean channels 2312-2372 */
678178354Ssam{ 2312, 2317, 2322, 2327, 2332, 2337, 2342, 2347, 2352, 2357, 2362, 2367, 2372 };
679178354Ssamstatic const uint16_t rcl11[] =	/* Added Japan channels in 4.9/5.0 spectrum */
680178354Ssam{ 5040, 5060, 5080, 4920, 4940, 4960, 4980 };
681178354Ssam#ifdef ATH_TURBO_SCAN
682178354Ssamstatic const uint16_t rcl5[] =		/* 3 static turbo channels */
683178354Ssam{ 5210, 5250, 5290 };
684178354Ssamstatic const uint16_t rcl6[] =		/* 2 static turbo channels */
685178354Ssam{ 5760, 5800 };
686178354Ssamstatic const uint16_t rcl6x[] =	/* 4 FCC3 turbo channels */
687178354Ssam{ 5540, 5580, 5620, 5660 };
688178354Ssamstatic const uint16_t rcl12[] =	/* 2.4Ghz Turbo channel 6 */
689178354Ssam{ 2437 };
690178354Ssamstatic const uint16_t rcl13[] =	/* dynamic Turbo channels */
691178354Ssam{ 5200, 5240, 5280, 5765, 5805 };
692178354Ssam#endif /* ATH_TURBO_SCAN */
693170530Ssam
694178354Ssam#define	X(a)	.count = sizeof(a)/sizeof(a[0]), .list = a
695170530Ssam
696178354Ssamstatic const struct scanlist staScanTable[] = {
697178354Ssam	{ IEEE80211_MODE_11B,   	X(rcl3) },
698178354Ssam	{ IEEE80211_MODE_11A,   	X(rcl1) },
699178354Ssam	{ IEEE80211_MODE_11A,   	X(rcl2) },
700178354Ssam	{ IEEE80211_MODE_11B,   	X(rcl8) },
701178354Ssam	{ IEEE80211_MODE_11B,   	X(rcl9) },
702178354Ssam	{ IEEE80211_MODE_11A,   	X(rcl4) },
703178354Ssam#ifdef ATH_TURBO_SCAN
704178354Ssam	{ IEEE80211_MODE_STURBO_A,	X(rcl5) },
705178354Ssam	{ IEEE80211_MODE_STURBO_A,	X(rcl6) },
706178354Ssam	{ IEEE80211_MODE_TURBO_A,	X(rcl6x) },
707178354Ssam	{ IEEE80211_MODE_TURBO_A,	X(rcl13) },
708178354Ssam#endif /* ATH_TURBO_SCAN */
709178354Ssam	{ IEEE80211_MODE_11A,		X(rcl7) },
710178354Ssam	{ IEEE80211_MODE_11B,		X(rcl10) },
711178354Ssam	{ IEEE80211_MODE_11A,		X(rcl11) },
712178354Ssam#ifdef ATH_TURBO_SCAN
713178354Ssam	{ IEEE80211_MODE_TURBO_G,	X(rcl12) },
714178354Ssam#endif /* ATH_TURBO_SCAN */
715178354Ssam	{ .list = NULL }
716178354Ssam};
717178354Ssam
718178354Ssam/*
719178354Ssam * Start a station-mode scan by populating the channel list.
720178354Ssam */
721178354Ssamstatic int
722178354Ssamsta_start(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
723178354Ssam{
724178354Ssam	struct sta_table *st = ss->ss_priv;
725178354Ssam
726178354Ssam	makescanlist(ss, vap, staScanTable);
727178354Ssam
728178354Ssam	if (ss->ss_mindwell == 0)
729178354Ssam		ss->ss_mindwell = msecs_to_ticks(20);	/* 20ms */
730178354Ssam	if (ss->ss_maxdwell == 0)
731178354Ssam		ss->ss_maxdwell = msecs_to_ticks(200);	/* 200ms */
732178354Ssam
733178354Ssam	st->st_scangen++;
734170530Ssam	st->st_newscan = 1;
735170530Ssam
736170530Ssam	return 0;
737170530Ssam}
738170530Ssam
739170530Ssam/*
740178354Ssam * Restart a scan, typically a bg scan but can
741178354Ssam * also be a fg scan that came up empty.
742170530Ssam */
743170530Ssamstatic int
744178354Ssamsta_restart(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
745170530Ssam{
746170530Ssam	struct sta_table *st = ss->ss_priv;
747170530Ssam
748170530Ssam	st->st_newscan = 1;
749170530Ssam	return 0;
750170530Ssam}
751170530Ssam
752170530Ssam/*
753170530Ssam * Cancel an ongoing scan.
754170530Ssam */
755170530Ssamstatic int
756178354Ssamsta_cancel(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
757170530Ssam{
758170530Ssam	return 0;
759170530Ssam}
760170530Ssam
761184302Ssam/*
762184302Ssam * Demote any supplied 11g channel to 11b.  There should
763184302Ssam * always be an 11b channel but we check anyway...
764184302Ssam */
765184302Ssamstatic struct ieee80211_channel *
766184302Ssamdemote11b(struct ieee80211vap *vap, struct ieee80211_channel *chan)
767184302Ssam{
768184302Ssam	struct ieee80211_channel *c;
769178354Ssam
770184302Ssam	if (IEEE80211_IS_CHAN_ANYG(chan) &&
771184302Ssam	    vap->iv_des_mode == IEEE80211_MODE_AUTO) {
772184302Ssam		c = ieee80211_find_channel(vap->iv_ic, chan->ic_freq,
773184302Ssam		    (chan->ic_flags &~ (IEEE80211_CHAN_PUREG | IEEE80211_CHAN_G)) |
774184302Ssam		    IEEE80211_CHAN_B);
775184302Ssam		if (c != NULL)
776184302Ssam			chan = c;
777184302Ssam	}
778184302Ssam	return chan;
779184302Ssam}
780184302Ssam
781178354Ssamstatic int
782170530Ssammaxrate(const struct ieee80211_scan_entry *se)
783170530Ssam{
784178354Ssam	const struct ieee80211_ie_htcap *htcap =
785178354Ssam	    (const struct ieee80211_ie_htcap *) se->se_ies.htcap_ie;
786219601Sbschmidt	int rmax, r, i, txstream;
787178354Ssam	uint16_t caps;
788219601Sbschmidt	uint8_t txparams;
789170530Ssam
790170530Ssam	rmax = 0;
791178354Ssam	if (htcap != NULL) {
792178354Ssam		/*
793178354Ssam		 * HT station; inspect supported MCS and then adjust
794219601Sbschmidt		 * rate by channel width.
795178354Ssam		 */
796219601Sbschmidt		txparams = htcap->hc_mcsset[12];
797219601Sbschmidt		if (txparams & 0x3) {
798219601Sbschmidt			/*
799219601Sbschmidt			 * TX MCS parameters defined and not equal to RX,
800219601Sbschmidt			 * extract the number of spartial streams and
801219601Sbschmidt			 * map it to the highest MCS rate.
802219601Sbschmidt			 */
803219601Sbschmidt			txstream = ((txparams & 0xc) >> 2) + 1;
804219601Sbschmidt			i = txstream * 8 - 1;
805219601Sbschmidt		} else
806219601Sbschmidt			for (i = 31; i >= 0 && isclr(htcap->hc_mcsset, i); i--);
807178354Ssam		if (i >= 0) {
808298359Savos			caps = le16dec(&htcap->hc_cap);
809219601Sbschmidt			if ((caps & IEEE80211_HTCAP_CHWIDTH40) &&
810219601Sbschmidt			    (caps & IEEE80211_HTCAP_SHORTGI40))
811178354Ssam				rmax = ieee80211_htrates[i].ht40_rate_400ns;
812219601Sbschmidt			else if (caps & IEEE80211_HTCAP_CHWIDTH40)
813219601Sbschmidt				rmax = ieee80211_htrates[i].ht40_rate_800ns;
814219601Sbschmidt			else if (caps & IEEE80211_HTCAP_SHORTGI20)
815219601Sbschmidt				rmax = ieee80211_htrates[i].ht20_rate_400ns;
816178354Ssam			else
817219601Sbschmidt				rmax = ieee80211_htrates[i].ht20_rate_800ns;
818178354Ssam		}
819178354Ssam	}
820170530Ssam	for (i = 0; i < se->se_rates[1]; i++) {
821170530Ssam		r = se->se_rates[2+i] & IEEE80211_RATE_VAL;
822170530Ssam		if (r > rmax)
823170530Ssam			rmax = r;
824170530Ssam	}
825170530Ssam	for (i = 0; i < se->se_xrates[1]; i++) {
826170530Ssam		r = se->se_xrates[2+i] & IEEE80211_RATE_VAL;
827170530Ssam		if (r > rmax)
828170530Ssam			rmax = r;
829170530Ssam	}
830170530Ssam	return rmax;
831170530Ssam}
832170530Ssam
833170530Ssam/*
834170530Ssam * Compare the capabilities of two entries and decide which is
835170530Ssam * more desirable (return >0 if a is considered better).  Note
836170530Ssam * that we assume compatibility/usability has already been checked
837170530Ssam * so we don't need to (e.g. validate whether privacy is supported).
838170530Ssam * Used to select the best scan candidate for association in a BSS.
839170530Ssam */
840170530Ssamstatic int
841170530Ssamsta_compare(const struct sta_entry *a, const struct sta_entry *b)
842170530Ssam{
843170530Ssam#define	PREFER(_a,_b,_what) do {			\
844170530Ssam	if (((_a) ^ (_b)) & (_what))			\
845170530Ssam		return ((_a) & (_what)) ? 1 : -1;	\
846170530Ssam} while (0)
847178354Ssam	int maxa, maxb;
848170530Ssam	int8_t rssia, rssib;
849170530Ssam	int weight;
850170530Ssam
851170530Ssam	/* privacy support */
852170530Ssam	PREFER(a->base.se_capinfo, b->base.se_capinfo,
853170530Ssam		IEEE80211_CAPINFO_PRIVACY);
854170530Ssam
855170530Ssam	/* compare count of previous failures */
856170530Ssam	weight = b->se_fails - a->se_fails;
857170530Ssam	if (abs(weight) > 1)
858170530Ssam		return weight;
859170530Ssam
860170530Ssam	/*
861170530Ssam	 * Compare rssi.  If the two are considered equivalent
862170530Ssam	 * then fallback to other criteria.  We threshold the
863170530Ssam	 * comparisons to avoid selecting an ap purely by rssi
864170530Ssam	 * when both values may be good but one ap is otherwise
865170530Ssam	 * more desirable (e.g. an 11b-only ap with stronger
866170530Ssam	 * signal than an 11g ap).
867170530Ssam	 */
868170530Ssam	rssia = MIN(a->base.se_rssi, STA_RSSI_MAX);
869170530Ssam	rssib = MIN(b->base.se_rssi, STA_RSSI_MAX);
870170530Ssam	if (abs(rssib - rssia) < 5) {
871170530Ssam		/* best/max rate preferred if signal level close enough XXX */
872170530Ssam		maxa = maxrate(&a->base);
873170530Ssam		maxb = maxrate(&b->base);
874170530Ssam		if (maxa != maxb)
875170530Ssam			return maxa - maxb;
876170530Ssam		/* XXX use freq for channel preference */
877170530Ssam		/* for now just prefer 5Ghz band to all other bands */
878178354Ssam		PREFER(IEEE80211_IS_CHAN_5GHZ(a->base.se_chan),
879178354Ssam		       IEEE80211_IS_CHAN_5GHZ(b->base.se_chan), 1);
880170530Ssam	}
881170530Ssam	/* all things being equal, use signal level */
882170530Ssam	return a->base.se_rssi - b->base.se_rssi;
883170530Ssam#undef PREFER
884170530Ssam}
885170530Ssam
886170530Ssam/*
887170530Ssam * Check rate set suitability and return the best supported rate.
888178354Ssam * XXX inspect MCS for HT
889170530Ssam */
890170530Ssamstatic int
891184302Ssamcheck_rate(struct ieee80211vap *vap, const struct ieee80211_channel *chan,
892184302Ssam    const struct ieee80211_scan_entry *se)
893170530Ssam{
894170530Ssam	const struct ieee80211_rateset *srs;
895178354Ssam	int i, j, nrs, r, okrate, badrate, fixedrate, ucastrate;
896170530Ssam	const uint8_t *rs;
897170530Ssam
898178354Ssam	okrate = badrate = 0;
899170530Ssam
900184302Ssam	srs = ieee80211_get_suprates(vap->iv_ic, chan);
901170530Ssam	nrs = se->se_rates[1];
902170530Ssam	rs = se->se_rates+2;
903178354Ssam	/* XXX MCS */
904184302Ssam	ucastrate = vap->iv_txparms[ieee80211_chan2mode(chan)].ucastrate;
905170530Ssam	fixedrate = IEEE80211_FIXED_RATE_NONE;
906170530Ssamagain:
907170530Ssam	for (i = 0; i < nrs; i++) {
908288086Sadrian		r = IEEE80211_RV(rs[i]);
909170530Ssam		badrate = r;
910170530Ssam		/*
911170530Ssam		 * Check any fixed rate is included.
912170530Ssam		 */
913178354Ssam		if (r == ucastrate)
914170530Ssam			fixedrate = r;
915170530Ssam		/*
916170530Ssam		 * Check against our supported rates.
917170530Ssam		 */
918170530Ssam		for (j = 0; j < srs->rs_nrates; j++)
919288086Sadrian			if (r == IEEE80211_RV(srs->rs_rates[j])) {
920170530Ssam				if (r > okrate)		/* NB: track max */
921170530Ssam					okrate = r;
922170530Ssam				break;
923170530Ssam			}
924170530Ssam
925170530Ssam		if (j == srs->rs_nrates && (rs[i] & IEEE80211_RATE_BASIC)) {
926170530Ssam			/*
927170530Ssam			 * Don't try joining a BSS, if we don't support
928170530Ssam			 * one of its basic rates.
929170530Ssam			 */
930170530Ssam			okrate = 0;
931170530Ssam			goto back;
932170530Ssam		}
933170530Ssam	}
934170530Ssam	if (rs == se->se_rates+2) {
935170530Ssam		/* scan xrates too; sort of an algol68-style for loop */
936170530Ssam		nrs = se->se_xrates[1];
937170530Ssam		rs = se->se_xrates+2;
938170530Ssam		goto again;
939170530Ssam	}
940170530Ssam
941170530Ssamback:
942178354Ssam	if (okrate == 0 || ucastrate != fixedrate)
943170530Ssam		return badrate | IEEE80211_RATE_BASIC;
944170530Ssam	else
945288086Sadrian		return IEEE80211_RV(okrate);
946170530Ssam}
947170530Ssam
948195618Srpaulostatic __inline int
949195618Srpaulomatch_id(const uint8_t *ie, const uint8_t *val, int len)
950195618Srpaulo{
951195618Srpaulo	return (ie[1] == len && memcmp(ie+2, val, len) == 0);
952195618Srpaulo}
953195618Srpaulo
954170530Ssamstatic int
955170530Ssammatch_ssid(const uint8_t *ie,
956170530Ssam	int nssid, const struct ieee80211_scan_ssid ssids[])
957170530Ssam{
958170530Ssam	int i;
959170530Ssam
960170530Ssam	for (i = 0; i < nssid; i++) {
961195618Srpaulo		if (match_id(ie, ssids[i].ssid, ssids[i].len))
962170530Ssam			return 1;
963170530Ssam	}
964170530Ssam	return 0;
965170530Ssam}
966170530Ssam
967186904Ssam#ifdef IEEE80211_SUPPORT_TDMA
968186904Ssamstatic int
969186904Ssamtdma_isfull(const struct ieee80211_tdma_param *tdma)
970186904Ssam{
971186904Ssam	int slot, slotcnt;
972186904Ssam
973186904Ssam	slotcnt = tdma->tdma_slotcnt;
974186904Ssam	for (slot = slotcnt-1; slot >= 0; slot--)
975186904Ssam		if (isclr(tdma->tdma_inuse, slot))
976186904Ssam			return 0;
977186904Ssam	return 1;
978186904Ssam}
979186904Ssam#endif /* IEEE80211_SUPPORT_TDMA */
980186904Ssam
981170530Ssam/*
982170530Ssam * Test a scan candidate for suitability/compatibility.
983170530Ssam */
984170530Ssamstatic int
985178354Ssammatch_bss(struct ieee80211vap *vap,
986170530Ssam	const struct ieee80211_scan_state *ss, struct sta_entry *se0,
987170530Ssam	int debug)
988170530Ssam{
989178354Ssam	struct ieee80211com *ic = vap->iv_ic;
990170530Ssam	struct ieee80211_scan_entry *se = &se0->base;
991178354Ssam        uint8_t rate;
992178354Ssam        int fail;
993170530Ssam
994170530Ssam	fail = 0;
995170530Ssam	if (isclr(ic->ic_chan_active, ieee80211_chan2ieee(ic, se->se_chan)))
996171409Ssam		fail |= MATCH_CHANNEL;
997170530Ssam	/*
998170530Ssam	 * NB: normally the desired mode is used to construct
999170530Ssam	 * the channel list, but it's possible for the scan
1000170530Ssam	 * cache to include entries for stations outside this
1001170530Ssam	 * list so we check the desired mode here to weed them
1002170530Ssam	 * out.
1003170530Ssam	 */
1004178354Ssam	if (vap->iv_des_mode != IEEE80211_MODE_AUTO &&
1005170530Ssam	    (se->se_chan->ic_flags & IEEE80211_CHAN_ALLTURBO) !=
1006178354Ssam	    chanflags[vap->iv_des_mode])
1007171409Ssam		fail |= MATCH_CHANNEL;
1008178354Ssam	if (vap->iv_opmode == IEEE80211_M_IBSS) {
1009170530Ssam		if ((se->se_capinfo & IEEE80211_CAPINFO_IBSS) == 0)
1010171409Ssam			fail |= MATCH_CAPINFO;
1011186904Ssam#ifdef IEEE80211_SUPPORT_TDMA
1012186904Ssam	} else if (vap->iv_opmode == IEEE80211_M_AHDEMO) {
1013186904Ssam		/*
1014186904Ssam		 * Adhoc demo network setup shouldn't really be scanning
1015186904Ssam		 * but just in case skip stations operating in IBSS or
1016186904Ssam		 * BSS mode.
1017186904Ssam		 */
1018186904Ssam		if (se->se_capinfo & (IEEE80211_CAPINFO_IBSS|IEEE80211_CAPINFO_ESS))
1019186904Ssam			fail |= MATCH_CAPINFO;
1020186904Ssam		/*
1021186904Ssam		 * TDMA operation cannot coexist with a normal 802.11 network;
1022186904Ssam		 * skip if IBSS or ESS capabilities are marked and require
1023186904Ssam		 * the beacon have a TDMA ie present.
1024186904Ssam		 */
1025186904Ssam		if (vap->iv_caps & IEEE80211_C_TDMA) {
1026186904Ssam			const struct ieee80211_tdma_param *tdma =
1027186904Ssam			    (const struct ieee80211_tdma_param *)se->se_ies.tdma_ie;
1028189980Ssam			const struct ieee80211_tdma_state *ts = vap->iv_tdma;
1029186904Ssam
1030186904Ssam			if (tdma == NULL)
1031186904Ssam				fail |= MATCH_TDMA_NOIE;
1032189980Ssam			else if (tdma->tdma_version != ts->tdma_version)
1033189980Ssam				fail |= MATCH_TDMA_VERSION;
1034186904Ssam			else if (tdma->tdma_slot != 0)
1035186904Ssam				fail |= MATCH_TDMA_NOTMASTER;
1036186904Ssam			else if (tdma_isfull(tdma))
1037186904Ssam				fail |= MATCH_TDMA_NOSLOT;
1038186904Ssam#if 0
1039186904Ssam			else if (ieee80211_local_address(se->se_macaddr))
1040186904Ssam				fail |= MATCH_TDMA_LOCAL;
1041186904Ssam#endif
1042186904Ssam		}
1043186904Ssam#endif /* IEEE80211_SUPPORT_TDMA */
1044195618Srpaulo#ifdef IEEE80211_SUPPORT_MESH
1045195618Srpaulo	} else if (vap->iv_opmode == IEEE80211_M_MBSS) {
1046195618Srpaulo		const struct ieee80211_mesh_state *ms = vap->iv_mesh;
1047195618Srpaulo		/*
1048195618Srpaulo		 * Mesh nodes have IBSS & ESS bits in capinfo turned off
1049195618Srpaulo		 * and two special ie's that must be present.
1050195618Srpaulo		 */
1051195618Srpaulo		if (se->se_capinfo & (IEEE80211_CAPINFO_IBSS|IEEE80211_CAPINFO_ESS))
1052195618Srpaulo			fail |= MATCH_CAPINFO;
1053215699Sbschmidt		else if (se->se_meshid[0] != IEEE80211_ELEMID_MESHID)
1054195618Srpaulo			fail |= MATCH_MESH_NOID;
1055195618Srpaulo		else if (ms->ms_idlen != 0 &&
1056195618Srpaulo		    match_id(se->se_meshid, ms->ms_id, ms->ms_idlen))
1057195618Srpaulo			fail |= MATCH_MESHID;
1058196005Ssam#endif
1059170530Ssam	} else {
1060170530Ssam		if ((se->se_capinfo & IEEE80211_CAPINFO_ESS) == 0)
1061171409Ssam			fail |= MATCH_CAPINFO;
1062178354Ssam		/*
1063178354Ssam		 * If 11d is enabled and we're attempting to join a bss
1064178354Ssam		 * that advertises it's country code then compare our
1065178354Ssam		 * current settings to what we fetched from the country ie.
1066178354Ssam		 * If our country code is unspecified or different then do
1067178354Ssam		 * not attempt to join the bss.  We should have already
1068178354Ssam		 * dispatched an event to user space that identifies the
1069178354Ssam		 * new country code so our regdomain config should match.
1070178354Ssam		 */
1071178354Ssam		if ((IEEE80211_IS_CHAN_11D(se->se_chan) ||
1072178354Ssam		    (vap->iv_flags_ext & IEEE80211_FEXT_DOTD)) &&
1073178354Ssam		    se->se_cc[0] != 0 &&
1074178354Ssam		    (ic->ic_regdomain.country == CTRY_DEFAULT ||
1075178354Ssam		     !isocmp(se->se_cc, ic->ic_regdomain.isocc)))
1076178354Ssam			fail |= MATCH_CC;
1077170530Ssam	}
1078178354Ssam	if (vap->iv_flags & IEEE80211_F_PRIVACY) {
1079170530Ssam		if ((se->se_capinfo & IEEE80211_CAPINFO_PRIVACY) == 0)
1080171409Ssam			fail |= MATCH_PRIVACY;
1081170530Ssam	} else {
1082170530Ssam		/* XXX does this mean privacy is supported or required? */
1083170530Ssam		if (se->se_capinfo & IEEE80211_CAPINFO_PRIVACY)
1084171409Ssam			fail |= MATCH_PRIVACY;
1085170530Ssam	}
1086184302Ssam	se0->se_flags &= ~STA_DEMOTE11B;
1087184302Ssam	rate = check_rate(vap, se->se_chan, se);
1088184302Ssam	if (rate & IEEE80211_RATE_BASIC) {
1089171409Ssam		fail |= MATCH_RATE;
1090184302Ssam		/*
1091184302Ssam		 * An 11b-only ap will give a rate mismatch if there is an
1092184302Ssam		 * OFDM fixed tx rate for 11g.  Try downgrading the channel
1093184302Ssam		 * in the scan list to 11b and retry the rate check.
1094184302Ssam		 */
1095184302Ssam		if (IEEE80211_IS_CHAN_ANYG(se->se_chan)) {
1096184302Ssam			rate = check_rate(vap, demote11b(vap, se->se_chan), se);
1097184302Ssam			if ((rate & IEEE80211_RATE_BASIC) == 0) {
1098184302Ssam				fail &= ~MATCH_RATE;
1099184302Ssam				se0->se_flags |= STA_DEMOTE11B;
1100184302Ssam			}
1101184302Ssam		}
1102184302Ssam	} else if (rate < 2*24) {
1103184302Ssam		/*
1104184302Ssam		 * This is an 11b-only ap.  Check the desired mode in
1105184302Ssam		 * case that needs to be honored (mode 11g filters out
1106184302Ssam		 * 11b-only ap's).  Otherwise force any 11g channel used
1107184302Ssam		 * in scanning to be demoted.
1108184302Ssam		 *
1109184302Ssam		 * NB: we cheat a bit here by looking at the max rate;
1110184302Ssam		 *     we could/should check the rates.
1111184302Ssam		 */
1112184302Ssam		if (!(vap->iv_des_mode == IEEE80211_MODE_AUTO ||
1113184302Ssam		      vap->iv_des_mode == IEEE80211_MODE_11B))
1114184302Ssam			fail |= MATCH_RATE;
1115184302Ssam		else
1116184302Ssam			se0->se_flags |= STA_DEMOTE11B;
1117184302Ssam	}
1118170530Ssam	if (ss->ss_nssid != 0 &&
1119171409Ssam	    !match_ssid(se->se_ssid, ss->ss_nssid, ss->ss_ssid))
1120171409Ssam		fail |= MATCH_SSID;
1121178354Ssam	if ((vap->iv_flags & IEEE80211_F_DESBSSID) &&
1122178354Ssam	    !IEEE80211_ADDR_EQ(vap->iv_des_bssid, se->se_bssid))
1123178354Ssam		fail |= MATCH_BSSID;
1124170530Ssam	if (se0->se_fails >= STA_FAILS_MAX)
1125171409Ssam		fail |= MATCH_FAILS;
1126170530Ssam	if (se0->se_notseen >= STA_PURGE_SCANS)
1127171409Ssam		fail |= MATCH_NOTSEEN;
1128170530Ssam	if (se->se_rssi < STA_RSSI_MIN)
1129171409Ssam		fail |= MATCH_RSSI;
1130170530Ssam#ifdef IEEE80211_DEBUG
1131178354Ssam	if (ieee80211_msg(vap, debug)) {
1132170530Ssam		printf(" %c %s",
1133171409Ssam		    fail & MATCH_FAILS ? '=' :
1134171409Ssam		    fail & MATCH_NOTSEEN ? '^' :
1135178354Ssam		    fail & MATCH_CC ? '$' :
1136186904Ssam#ifdef IEEE80211_SUPPORT_TDMA
1137186904Ssam		    fail & MATCH_TDMA_NOIE ? '&' :
1138189980Ssam		    fail & MATCH_TDMA_VERSION ? 'v' :
1139189980Ssam		    fail & MATCH_TDMA_NOTMASTER ? 's' :
1140189980Ssam		    fail & MATCH_TDMA_NOSLOT ? 'f' :
1141189980Ssam		    fail & MATCH_TDMA_LOCAL ? 'l' :
1142186904Ssam#endif
1143195618Srpaulo		    fail & MATCH_MESH_NOID ? 'm' :
1144171409Ssam		    fail ? '-' : '+', ether_sprintf(se->se_macaddr));
1145170530Ssam		printf(" %s%c", ether_sprintf(se->se_bssid),
1146171409Ssam		    fail & MATCH_BSSID ? '!' : ' ');
1147170530Ssam		printf(" %3d%c", ieee80211_chan2ieee(ic, se->se_chan),
1148171409Ssam			fail & MATCH_CHANNEL ? '!' : ' ');
1149171409Ssam		printf(" %+4d%c", se->se_rssi, fail & MATCH_RSSI ? '!' : ' ');
1150170530Ssam		printf(" %2dM%c", (rate & IEEE80211_RATE_VAL) / 2,
1151171409Ssam		    fail & MATCH_RATE ? '!' : ' ');
1152170530Ssam		printf(" %4s%c",
1153170530Ssam		    (se->se_capinfo & IEEE80211_CAPINFO_ESS) ? "ess" :
1154189980Ssam		    (se->se_capinfo & IEEE80211_CAPINFO_IBSS) ? "ibss" : "",
1155171409Ssam		    fail & MATCH_CAPINFO ? '!' : ' ');
1156170530Ssam		printf(" %3s%c ",
1157170530Ssam		    (se->se_capinfo & IEEE80211_CAPINFO_PRIVACY) ?
1158170530Ssam		    "wep" : "no",
1159171409Ssam		    fail & MATCH_PRIVACY ? '!' : ' ');
1160170530Ssam		ieee80211_print_essid(se->se_ssid+2, se->se_ssid[1]);
1161195618Srpaulo		printf("%s\n", fail & (MATCH_SSID | MATCH_MESHID) ? "!" : "");
1162170530Ssam	}
1163170530Ssam#endif
1164170530Ssam	return fail;
1165170530Ssam}
1166170530Ssam
1167170530Ssamstatic void
1168170530Ssamsta_update_notseen(struct sta_table *st)
1169170530Ssam{
1170170530Ssam	struct sta_entry *se;
1171170530Ssam
1172206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1173170530Ssam	TAILQ_FOREACH(se, &st->st_entry, se_list) {
1174170530Ssam		/*
1175170530Ssam		 * If seen the reset and don't bump the count;
1176170530Ssam		 * otherwise bump the ``not seen'' count.  Note
1177170530Ssam		 * that this insures that stations for which we
1178170530Ssam		 * see frames while not scanning but not during
1179170530Ssam		 * this scan will not be penalized.
1180170530Ssam		 */
1181170530Ssam		if (se->se_seen)
1182170530Ssam			se->se_seen = 0;
1183170530Ssam		else
1184170530Ssam			se->se_notseen++;
1185170530Ssam	}
1186206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1187170530Ssam}
1188170530Ssam
1189170530Ssamstatic void
1190170530Ssamsta_dec_fails(struct sta_table *st)
1191170530Ssam{
1192170530Ssam	struct sta_entry *se;
1193170530Ssam
1194206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1195170530Ssam	TAILQ_FOREACH(se, &st->st_entry, se_list)
1196170530Ssam		if (se->se_fails)
1197170530Ssam			se->se_fails--;
1198206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1199170530Ssam}
1200170530Ssam
1201170530Ssamstatic struct sta_entry *
1202178354Ssamselect_bss(struct ieee80211_scan_state *ss, struct ieee80211vap *vap, int debug)
1203170530Ssam{
1204170530Ssam	struct sta_table *st = ss->ss_priv;
1205170530Ssam	struct sta_entry *se, *selbs = NULL;
1206170530Ssam
1207178354Ssam	IEEE80211_DPRINTF(vap, debug, " %s\n",
1208170530Ssam	    "macaddr          bssid         chan  rssi  rate flag  wep  essid");
1209206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1210170530Ssam	TAILQ_FOREACH(se, &st->st_entry, se_list) {
1211184275Ssam		ieee80211_ies_expand(&se->base.se_ies);
1212178354Ssam		if (match_bss(vap, ss, se, debug) == 0) {
1213170530Ssam			if (selbs == NULL)
1214170530Ssam				selbs = se;
1215170530Ssam			else if (sta_compare(se, selbs) > 0)
1216170530Ssam				selbs = se;
1217170530Ssam		}
1218170530Ssam	}
1219206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1220170530Ssam
1221170530Ssam	return selbs;
1222170530Ssam}
1223170530Ssam
1224170530Ssam/*
1225170530Ssam * Pick an ap or ibss network to join or find a channel
1226170530Ssam * to use to start an ibss network.
1227170530Ssam */
1228170530Ssamstatic int
1229178354Ssamsta_pick_bss(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1230170530Ssam{
1231170530Ssam	struct sta_table *st = ss->ss_priv;
1232170530Ssam	struct sta_entry *selbs;
1233184274Ssam	struct ieee80211_channel *chan;
1234170530Ssam
1235178354Ssam	KASSERT(vap->iv_opmode == IEEE80211_M_STA,
1236178354Ssam		("wrong mode %u", vap->iv_opmode));
1237170530Ssam
1238170530Ssam	if (st->st_newscan) {
1239170530Ssam		sta_update_notseen(st);
1240170530Ssam		st->st_newscan = 0;
1241170530Ssam	}
1242170530Ssam	if (ss->ss_flags & IEEE80211_SCAN_NOPICK) {
1243170530Ssam		/*
1244170530Ssam		 * Manual/background scan, don't select+join the
1245170530Ssam		 * bss, just return.  The scanning framework will
1246170530Ssam		 * handle notification that this has completed.
1247170530Ssam		 */
1248170530Ssam		ss->ss_flags &= ~IEEE80211_SCAN_NOPICK;
1249170530Ssam		return 1;
1250170530Ssam	}
1251170530Ssam	/*
1252170530Ssam	 * Automatic sequencing; look for a candidate and
1253170530Ssam	 * if found join the network.
1254170530Ssam	 */
1255170530Ssam	/* NB: unlocked read should be ok */
1256170530Ssam	if (TAILQ_FIRST(&st->st_entry) == NULL) {
1257178354Ssam		IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN,
1258170530Ssam			"%s: no scan candidate\n", __func__);
1259178354Ssam		if (ss->ss_flags & IEEE80211_SCAN_NOJOIN)
1260178354Ssam			return 0;
1261170530Ssamnotfound:
1262170530Ssam		/*
1263170530Ssam		 * If nothing suitable was found decrement
1264170530Ssam		 * the failure counts so entries will be
1265170530Ssam		 * reconsidered the next time around.  We
1266170530Ssam		 * really want to do this only for sta's
1267170530Ssam		 * where we've previously had some success.
1268170530Ssam		 */
1269170530Ssam		sta_dec_fails(st);
1270170530Ssam		st->st_newscan = 1;
1271170530Ssam		return 0;			/* restart scan */
1272170530Ssam	}
1273178354Ssam	selbs = select_bss(ss, vap, IEEE80211_MSG_SCAN);
1274178354Ssam	if (ss->ss_flags & IEEE80211_SCAN_NOJOIN)
1275178354Ssam		return (selbs != NULL);
1276184274Ssam	if (selbs == NULL)
1277170530Ssam		goto notfound;
1278184274Ssam	chan = selbs->base.se_chan;
1279184302Ssam	if (selbs->se_flags & STA_DEMOTE11B)
1280184302Ssam		chan = demote11b(vap, chan);
1281184274Ssam	if (!ieee80211_sta_join(vap, chan, &selbs->base))
1282184274Ssam		goto notfound;
1283170530Ssam	return 1;				/* terminate scan */
1284170530Ssam}
1285170530Ssam
1286170530Ssam/*
1287170530Ssam * Lookup an entry in the scan cache.  We assume we're
1288170530Ssam * called from the bottom half or such that we don't need
1289170530Ssam * to block the bottom half so that it's safe to return
1290170530Ssam * a reference to an entry w/o holding the lock on the table.
1291170530Ssam */
1292170530Ssamstatic struct sta_entry *
1293170530Ssamsta_lookup(struct sta_table *st, const uint8_t macaddr[IEEE80211_ADDR_LEN])
1294170530Ssam{
1295170530Ssam	struct sta_entry *se;
1296170530Ssam	int hash = STA_HASH(macaddr);
1297170530Ssam
1298206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1299170530Ssam	LIST_FOREACH(se, &st->st_hash[hash], se_hash)
1300170530Ssam		if (IEEE80211_ADDR_EQ(se->base.se_macaddr, macaddr))
1301170530Ssam			break;
1302206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1303170530Ssam
1304170530Ssam	return se;		/* NB: unlocked */
1305170530Ssam}
1306170530Ssam
1307170530Ssamstatic void
1308178354Ssamsta_roam_check(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1309170530Ssam{
1310178354Ssam	struct ieee80211com *ic = vap->iv_ic;
1311178354Ssam	struct ieee80211_node *ni = vap->iv_bss;
1312170530Ssam	struct sta_table *st = ss->ss_priv;
1313178354Ssam	enum ieee80211_phymode mode;
1314170530Ssam	struct sta_entry *se, *selbs;
1315178354Ssam	uint8_t roamRate, curRate, ucastRate;
1316170530Ssam	int8_t roamRssi, curRssi;
1317170530Ssam
1318170530Ssam	se = sta_lookup(st, ni->ni_macaddr);
1319170530Ssam	if (se == NULL) {
1320170530Ssam		/* XXX something is wrong */
1321170530Ssam		return;
1322170530Ssam	}
1323170530Ssam
1324178354Ssam	mode = ieee80211_chan2mode(ic->ic_bsschan);
1325178354Ssam	roamRate = vap->iv_roamparms[mode].rate;
1326178354Ssam	roamRssi = vap->iv_roamparms[mode].rssi;
1327344223Savos	KASSERT(roamRate != 0 && roamRssi != 0, ("iv_roamparms are not"
1328344223Savos	    "initialized for %s mode!", ieee80211_phymode_name[mode]));
1329344223Savos
1330178354Ssam	ucastRate = vap->iv_txparms[mode].ucastrate;
1331170530Ssam	/* NB: the most up to date rssi is in the node, not the scan cache */
1332170530Ssam	curRssi = ic->ic_node_getrssi(ni);
1333178354Ssam	if (ucastRate == IEEE80211_FIXED_RATE_NONE) {
1334178354Ssam		curRate = ni->ni_txrate;
1335178354Ssam		IEEE80211_DPRINTF(vap, IEEE80211_MSG_ROAM,
1336170530Ssam		    "%s: currssi %d currate %u roamrssi %d roamrate %u\n",
1337170530Ssam		    __func__, curRssi, curRate, roamRssi, roamRate);
1338170530Ssam	} else {
1339170530Ssam		curRate = roamRate;	/* NB: insure compare below fails */
1340178354Ssam		IEEE80211_DPRINTF(vap, IEEE80211_MSG_ROAM,
1341170530Ssam		    "%s: currssi %d roamrssi %d\n", __func__, curRssi, roamRssi);
1342170530Ssam	}
1343170530Ssam	/*
1344170530Ssam	 * Check if a new ap should be used and switch.
1345170530Ssam	 * XXX deauth current ap
1346170530Ssam	 */
1347170530Ssam	if (curRate < roamRate || curRssi < roamRssi) {
1348297405Sadrian		if (ieee80211_time_after(ticks, ic->ic_lastscan + vap->iv_scanvalid)) {
1349170530Ssam			/*
1350170530Ssam			 * Scan cache contents are too old; force a scan now
1351170530Ssam			 * if possible so we have current state to make a
1352170530Ssam			 * decision with.  We don't kick off a bg scan if
1353170530Ssam			 * we're using dynamic turbo and boosted or if the
1354170530Ssam			 * channel is busy.
1355170530Ssam			 * XXX force immediate switch on scan complete
1356170530Ssam			 */
1357170530Ssam			if (!IEEE80211_IS_CHAN_DTURBO(ic->ic_curchan) &&
1358297405Sadrian			    ieee80211_time_after(ticks, ic->ic_lastdata + vap->iv_bgscanidle))
1359178354Ssam				ieee80211_bg_scan(vap, 0);
1360170530Ssam			return;
1361170530Ssam		}
1362170530Ssam		se->base.se_rssi = curRssi;
1363178354Ssam		selbs = select_bss(ss, vap, IEEE80211_MSG_ROAM);
1364170530Ssam		if (selbs != NULL && selbs != se) {
1365184274Ssam			struct ieee80211_channel *chan;
1366184274Ssam
1367178354Ssam			IEEE80211_DPRINTF(vap,
1368170530Ssam			    IEEE80211_MSG_ROAM | IEEE80211_MSG_DEBUG,
1369170530Ssam			    "%s: ROAM: curRate %u, roamRate %u, "
1370170530Ssam			    "curRssi %d, roamRssi %d\n", __func__,
1371170530Ssam			    curRate, roamRate, curRssi, roamRssi);
1372184274Ssam
1373184274Ssam			chan = selbs->base.se_chan;
1374184302Ssam			if (selbs->se_flags & STA_DEMOTE11B)
1375184302Ssam				chan = demote11b(vap, chan);
1376184274Ssam			(void) ieee80211_sta_join(vap, chan, &selbs->base);
1377170530Ssam		}
1378170530Ssam	}
1379170530Ssam}
1380170530Ssam
1381170530Ssam/*
1382170530Ssam * Age entries in the scan cache.
1383170530Ssam * XXX also do roaming since it's convenient
1384170530Ssam */
1385170530Ssamstatic void
1386170530Ssamsta_age(struct ieee80211_scan_state *ss)
1387170530Ssam{
1388178354Ssam	struct ieee80211vap *vap = ss->ss_vap;
1389170530Ssam
1390178354Ssam	adhoc_age(ss);
1391170530Ssam	/*
1392170530Ssam	 * If rate control is enabled check periodically to see if
1393170530Ssam	 * we should roam from our current connection to one that
1394170530Ssam	 * might be better.  This only applies when we're operating
1395170530Ssam	 * in sta mode and automatic roaming is set.
1396170530Ssam	 * XXX defer if busy
1397170530Ssam	 * XXX repeater station
1398170530Ssam	 * XXX do when !bgscan?
1399170530Ssam	 */
1400178354Ssam	KASSERT(vap->iv_opmode == IEEE80211_M_STA,
1401178354Ssam		("wrong mode %u", vap->iv_opmode));
1402178354Ssam	if (vap->iv_roaming == IEEE80211_ROAMING_AUTO &&
1403213321Sadrian	    (vap->iv_flags & IEEE80211_F_BGSCAN) &&
1404178354Ssam	    vap->iv_state >= IEEE80211_S_RUN)
1405170530Ssam		/* XXX vap is implicit */
1406178354Ssam		sta_roam_check(ss, vap);
1407170530Ssam}
1408170530Ssam
1409170530Ssam/*
1410170530Ssam * Iterate over the entries in the scan cache, invoking
1411170530Ssam * the callback function on each one.
1412170530Ssam */
1413170530Ssamstatic void
1414170530Ssamsta_iterate(struct ieee80211_scan_state *ss,
1415170530Ssam	ieee80211_scan_iter_func *f, void *arg)
1416170530Ssam{
1417170530Ssam	struct sta_table *st = ss->ss_priv;
1418170530Ssam	struct sta_entry *se;
1419170530Ssam	u_int gen;
1420170530Ssam
1421283556Sadrian	IEEE80211_SCAN_ITER_LOCK(st);
1422178354Ssam	gen = st->st_scaniter++;
1423170530Ssamrestart:
1424206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1425170530Ssam	TAILQ_FOREACH(se, &st->st_entry, se_list) {
1426170530Ssam		if (se->se_scangen != gen) {
1427170530Ssam			se->se_scangen = gen;
1428170530Ssam			/* update public state */
1429170530Ssam			se->base.se_age = ticks - se->se_lastupdate;
1430206617Srpaulo			IEEE80211_SCAN_TABLE_UNLOCK(st);
1431170530Ssam			(*f)(arg, &se->base);
1432170530Ssam			goto restart;
1433170530Ssam		}
1434170530Ssam	}
1435206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1436170530Ssam
1437283556Sadrian	IEEE80211_SCAN_ITER_UNLOCK(st);
1438170530Ssam}
1439170530Ssam
1440170530Ssamstatic void
1441170530Ssamsta_assoc_fail(struct ieee80211_scan_state *ss,
1442170530Ssam	const uint8_t macaddr[IEEE80211_ADDR_LEN], int reason)
1443170530Ssam{
1444170530Ssam	struct sta_table *st = ss->ss_priv;
1445170530Ssam	struct sta_entry *se;
1446170530Ssam
1447170530Ssam	se = sta_lookup(st, macaddr);
1448170530Ssam	if (se != NULL) {
1449170530Ssam		se->se_fails++;
1450170530Ssam		se->se_lastfail = ticks;
1451178354Ssam		IEEE80211_NOTE_MAC(ss->ss_vap, IEEE80211_MSG_SCAN,
1452170530Ssam		    macaddr, "%s: reason %u fails %u",
1453170530Ssam		    __func__, reason, se->se_fails);
1454170530Ssam	}
1455170530Ssam}
1456170530Ssam
1457170530Ssamstatic void
1458170530Ssamsta_assoc_success(struct ieee80211_scan_state *ss,
1459170530Ssam	const uint8_t macaddr[IEEE80211_ADDR_LEN])
1460170530Ssam{
1461170530Ssam	struct sta_table *st = ss->ss_priv;
1462170530Ssam	struct sta_entry *se;
1463170530Ssam
1464170530Ssam	se = sta_lookup(st, macaddr);
1465170530Ssam	if (se != NULL) {
1466170530Ssam#if 0
1467170530Ssam		se->se_fails = 0;
1468178354Ssam		IEEE80211_NOTE_MAC(ss->ss_vap, IEEE80211_MSG_SCAN,
1469170530Ssam		    macaddr, "%s: fails %u",
1470170530Ssam		    __func__, se->se_fails);
1471170530Ssam#endif
1472170530Ssam		se->se_lastassoc = ticks;
1473170530Ssam	}
1474170530Ssam}
1475170530Ssam
1476170530Ssamstatic const struct ieee80211_scanner sta_default = {
1477170530Ssam	.scan_name		= "default",
1478170530Ssam	.scan_attach		= sta_attach,
1479170530Ssam	.scan_detach		= sta_detach,
1480170530Ssam	.scan_start		= sta_start,
1481170530Ssam	.scan_restart		= sta_restart,
1482170530Ssam	.scan_cancel		= sta_cancel,
1483170530Ssam	.scan_end		= sta_pick_bss,
1484170530Ssam	.scan_flush		= sta_flush,
1485170530Ssam	.scan_add		= sta_add,
1486170530Ssam	.scan_age		= sta_age,
1487170530Ssam	.scan_iterate		= sta_iterate,
1488170530Ssam	.scan_assoc_fail	= sta_assoc_fail,
1489170530Ssam	.scan_assoc_success	= sta_assoc_success,
1490170530Ssam};
1491195618SrpauloIEEE80211_SCANNER_ALG(sta, IEEE80211_M_STA, sta_default);
1492170530Ssam
1493170530Ssam/*
1494170530Ssam * Adhoc mode-specific support.
1495170530Ssam */
1496170530Ssam
1497170530Ssamstatic const uint16_t adhocWorld[] =		/* 36, 40, 44, 48 */
1498170530Ssam{ 5180, 5200, 5220, 5240 };
1499170530Ssamstatic const uint16_t adhocFcc3[] =		/* 36, 40, 44, 48 145, 149, 153, 157, 161, 165 */
1500170530Ssam{ 5180, 5200, 5220, 5240, 5725, 5745, 5765, 5785, 5805, 5825 };
1501170530Ssamstatic const uint16_t adhocMkk[] =		/* 34, 38, 42, 46 */
1502170530Ssam{ 5170, 5190, 5210, 5230 };
1503170530Ssamstatic const uint16_t adhoc11b[] =		/* 10, 11 */
1504170530Ssam{ 2457, 2462 };
1505170530Ssam
1506170530Ssamstatic const struct scanlist adhocScanTable[] = {
1507170530Ssam	{ IEEE80211_MODE_11B,   	X(adhoc11b) },
1508170530Ssam	{ IEEE80211_MODE_11A,   	X(adhocWorld) },
1509170530Ssam	{ IEEE80211_MODE_11A,   	X(adhocFcc3) },
1510170530Ssam	{ IEEE80211_MODE_11B,   	X(adhocMkk) },
1511170530Ssam	{ .list = NULL }
1512170530Ssam};
1513170530Ssam#undef X
1514170530Ssam
1515170530Ssam/*
1516170530Ssam * Start an adhoc-mode scan by populating the channel list.
1517170530Ssam */
1518170530Ssamstatic int
1519178354Ssamadhoc_start(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1520170530Ssam{
1521170530Ssam	struct sta_table *st = ss->ss_priv;
1522170530Ssam
1523178354Ssam	makescanlist(ss, vap, adhocScanTable);
1524176653Ssam
1525178354Ssam	if (ss->ss_mindwell == 0)
1526178354Ssam		ss->ss_mindwell = msecs_to_ticks(200);	/* 200ms */
1527178354Ssam	if (ss->ss_maxdwell == 0)
1528178354Ssam		ss->ss_maxdwell = msecs_to_ticks(200);	/* 200ms */
1529176653Ssam
1530178354Ssam	st->st_scangen++;
1531170530Ssam	st->st_newscan = 1;
1532170530Ssam
1533170530Ssam	return 0;
1534170530Ssam}
1535170530Ssam
1536170530Ssam/*
1537170530Ssam * Select a channel to start an adhoc network on.
1538170530Ssam * The channel list was populated with appropriate
1539170530Ssam * channels so select one that looks least occupied.
1540170530Ssam */
1541170530Ssamstatic struct ieee80211_channel *
1542178354Ssamadhoc_pick_channel(struct ieee80211_scan_state *ss, int flags)
1543170530Ssam{
1544170530Ssam	struct sta_table *st = ss->ss_priv;
1545170530Ssam	struct sta_entry *se;
1546170530Ssam	struct ieee80211_channel *c, *bestchan;
1547170530Ssam	int i, bestrssi, maxrssi;
1548170530Ssam
1549170530Ssam	bestchan = NULL;
1550170530Ssam	bestrssi = -1;
1551170530Ssam
1552206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1553170530Ssam	for (i = 0; i < ss->ss_last; i++) {
1554170530Ssam		c = ss->ss_chans[i];
1555178354Ssam		/* never consider a channel with radar */
1556178354Ssam		if (IEEE80211_IS_CHAN_RADAR(c))
1557176653Ssam			continue;
1558178354Ssam		/* skip channels disallowed by regulatory settings */
1559178354Ssam		if (IEEE80211_IS_CHAN_NOADHOC(c))
1560178354Ssam			continue;
1561178354Ssam		/* check channel attributes for band compatibility */
1562178354Ssam		if (flags != 0 && (c->ic_flags & flags) != flags)
1563178354Ssam			continue;
1564170530Ssam		maxrssi = 0;
1565170530Ssam		TAILQ_FOREACH(se, &st->st_entry, se_list) {
1566170530Ssam			if (se->base.se_chan != c)
1567170530Ssam				continue;
1568170530Ssam			if (se->base.se_rssi > maxrssi)
1569170530Ssam				maxrssi = se->base.se_rssi;
1570170530Ssam		}
1571170530Ssam		if (bestchan == NULL || maxrssi < bestrssi)
1572170530Ssam			bestchan = c;
1573170530Ssam	}
1574206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1575170530Ssam
1576170530Ssam	return bestchan;
1577170530Ssam}
1578170530Ssam
1579170530Ssam/*
1580170530Ssam * Pick an ibss network to join or find a channel
1581170530Ssam * to use to start an ibss network.
1582170530Ssam */
1583170530Ssamstatic int
1584178354Ssamadhoc_pick_bss(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1585170530Ssam{
1586170530Ssam	struct sta_table *st = ss->ss_priv;
1587170530Ssam	struct sta_entry *selbs;
1588170530Ssam	struct ieee80211_channel *chan;
1589245928Sadrian	struct ieee80211com *ic = vap->iv_ic;
1590170530Ssam
1591178354Ssam	KASSERT(vap->iv_opmode == IEEE80211_M_IBSS ||
1592195618Srpaulo		vap->iv_opmode == IEEE80211_M_AHDEMO ||
1593195618Srpaulo		vap->iv_opmode == IEEE80211_M_MBSS,
1594178354Ssam		("wrong opmode %u", vap->iv_opmode));
1595170530Ssam
1596170530Ssam	if (st->st_newscan) {
1597170530Ssam		sta_update_notseen(st);
1598170530Ssam		st->st_newscan = 0;
1599170530Ssam	}
1600170530Ssam	if (ss->ss_flags & IEEE80211_SCAN_NOPICK) {
1601170530Ssam		/*
1602170530Ssam		 * Manual/background scan, don't select+join the
1603170530Ssam		 * bss, just return.  The scanning framework will
1604170530Ssam		 * handle notification that this has completed.
1605170530Ssam		 */
1606170530Ssam		ss->ss_flags &= ~IEEE80211_SCAN_NOPICK;
1607170530Ssam		return 1;
1608170530Ssam	}
1609170530Ssam	/*
1610170530Ssam	 * Automatic sequencing; look for a candidate and
1611170530Ssam	 * if found join the network.
1612170530Ssam	 */
1613170530Ssam	/* NB: unlocked read should be ok */
1614170530Ssam	if (TAILQ_FIRST(&st->st_entry) == NULL) {
1615178354Ssam		IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN,
1616170530Ssam			"%s: no scan candidate\n", __func__);
1617178354Ssam		if (ss->ss_flags & IEEE80211_SCAN_NOJOIN)
1618178354Ssam			return 0;
1619170530Ssamnotfound:
1620186904Ssam		/* NB: never auto-start a tdma network for slot !0 */
1621186904Ssam#ifdef IEEE80211_SUPPORT_TDMA
1622186904Ssam		if (vap->iv_des_nssid &&
1623186904Ssam		    ((vap->iv_caps & IEEE80211_C_TDMA) == 0 ||
1624186904Ssam		     ieee80211_tdma_getslot(vap) == 0)) {
1625186904Ssam#else
1626178354Ssam		if (vap->iv_des_nssid) {
1627186904Ssam#endif
1628170530Ssam			/*
1629170530Ssam			 * No existing adhoc network to join and we have
1630170530Ssam			 * an ssid; start one up.  If no channel was
1631170530Ssam			 * specified, try to select a channel.
1632170530Ssam			 */
1633178354Ssam			if (vap->iv_des_chan == IEEE80211_CHAN_ANYC ||
1634178354Ssam			    IEEE80211_IS_CHAN_RADAR(vap->iv_des_chan)) {
1635183421Ssam				chan = adhoc_pick_channel(ss, 0);
1636178354Ssam			} else
1637178354Ssam				chan = vap->iv_des_chan;
1638170530Ssam			if (chan != NULL) {
1639245928Sadrian				/*
1640245928Sadrian				 * Create a HT capable IBSS; the per-node
1641245928Sadrian				 * probe request/response will result in
1642245928Sadrian				 * "correct" rate control capabilities being
1643245928Sadrian				 * negotiated.
1644245928Sadrian				 */
1645245928Sadrian				chan = ieee80211_ht_adjust_channel(ic,
1646245928Sadrian				    chan, vap->iv_flags_ht);
1647178354Ssam				ieee80211_create_ibss(vap, chan);
1648170530Ssam				return 1;
1649170530Ssam			}
1650170530Ssam		}
1651170530Ssam		/*
1652170530Ssam		 * If nothing suitable was found decrement
1653170530Ssam		 * the failure counts so entries will be
1654170530Ssam		 * reconsidered the next time around.  We
1655170530Ssam		 * really want to do this only for sta's
1656170530Ssam		 * where we've previously had some success.
1657170530Ssam		 */
1658170530Ssam		sta_dec_fails(st);
1659170530Ssam		st->st_newscan = 1;
1660170530Ssam		return 0;			/* restart scan */
1661170530Ssam	}
1662178354Ssam	selbs = select_bss(ss, vap, IEEE80211_MSG_SCAN);
1663178354Ssam	if (ss->ss_flags & IEEE80211_SCAN_NOJOIN)
1664178354Ssam		return (selbs != NULL);
1665184274Ssam	if (selbs == NULL)
1666170530Ssam		goto notfound;
1667184274Ssam	chan = selbs->base.se_chan;
1668184302Ssam	if (selbs->se_flags & STA_DEMOTE11B)
1669184302Ssam		chan = demote11b(vap, chan);
1670245928Sadrian	/*
1671245928Sadrian	 * If HT is available, make it a possibility here.
1672245928Sadrian	 * The intent is to enable HT20/HT40 when joining a non-HT
1673245928Sadrian	 * IBSS node; we can then advertise HT IEs and speak HT
1674245928Sadrian	 * to any subsequent nodes that support it.
1675245928Sadrian	 */
1676245928Sadrian	chan = ieee80211_ht_adjust_channel(ic,
1677245928Sadrian	    chan, vap->iv_flags_ht);
1678184274Ssam	if (!ieee80211_sta_join(vap, chan, &selbs->base))
1679184274Ssam		goto notfound;
1680170530Ssam	return 1;				/* terminate scan */
1681170530Ssam}
1682170530Ssam
1683170530Ssam/*
1684170530Ssam * Age entries in the scan cache.
1685170530Ssam */
1686170530Ssamstatic void
1687170530Ssamadhoc_age(struct ieee80211_scan_state *ss)
1688170530Ssam{
1689170530Ssam	struct sta_table *st = ss->ss_priv;
1690170530Ssam	struct sta_entry *se, *next;
1691170530Ssam
1692206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1693170530Ssam	TAILQ_FOREACH_SAFE(se, &st->st_entry, se_list, next) {
1694170530Ssam		if (se->se_notseen > STA_PURGE_SCANS) {
1695170530Ssam			TAILQ_REMOVE(&st->st_entry, se, se_list);
1696170530Ssam			LIST_REMOVE(se, se_hash);
1697178354Ssam			ieee80211_ies_cleanup(&se->base.se_ies);
1698283538Sadrian			IEEE80211_FREE(se, M_80211_SCAN);
1699170530Ssam		}
1700170530Ssam	}
1701206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1702170530Ssam}
1703170530Ssam
1704170530Ssamstatic const struct ieee80211_scanner adhoc_default = {
1705170530Ssam	.scan_name		= "default",
1706170530Ssam	.scan_attach		= sta_attach,
1707170530Ssam	.scan_detach		= sta_detach,
1708170530Ssam	.scan_start		= adhoc_start,
1709170530Ssam	.scan_restart		= sta_restart,
1710170530Ssam	.scan_cancel		= sta_cancel,
1711170530Ssam	.scan_end		= adhoc_pick_bss,
1712170530Ssam	.scan_flush		= sta_flush,
1713178354Ssam	.scan_pickchan		= adhoc_pick_channel,
1714170530Ssam	.scan_add		= sta_add,
1715170530Ssam	.scan_age		= adhoc_age,
1716170530Ssam	.scan_iterate		= sta_iterate,
1717170530Ssam	.scan_assoc_fail	= sta_assoc_fail,
1718170530Ssam	.scan_assoc_success	= sta_assoc_success,
1719170530Ssam};
1720195618SrpauloIEEE80211_SCANNER_ALG(ibss, IEEE80211_M_IBSS, adhoc_default);
1721195618SrpauloIEEE80211_SCANNER_ALG(ahdemo, IEEE80211_M_AHDEMO, adhoc_default);
1722170530Ssam
1723178354Ssamstatic int
1724178354Ssamap_start(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1725178354Ssam{
1726178354Ssam	struct sta_table *st = ss->ss_priv;
1727178354Ssam
1728178354Ssam	makescanlist(ss, vap, staScanTable);
1729178354Ssam
1730178354Ssam	if (ss->ss_mindwell == 0)
1731178354Ssam		ss->ss_mindwell = msecs_to_ticks(200);	/* 200ms */
1732178354Ssam	if (ss->ss_maxdwell == 0)
1733178354Ssam		ss->ss_maxdwell = msecs_to_ticks(200);	/* 200ms */
1734178354Ssam
1735178354Ssam	st->st_scangen++;
1736178354Ssam	st->st_newscan = 1;
1737178354Ssam
1738178354Ssam	return 0;
1739178354Ssam}
1740178354Ssam
1741170530Ssam/*
1742178354Ssam * Cancel an ongoing scan.
1743170530Ssam */
1744170530Ssamstatic int
1745178354Ssamap_cancel(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1746170530Ssam{
1747178354Ssam	return 0;
1748178354Ssam}
1749178354Ssam
1750178354Ssam/*
1751178354Ssam * Pick a quiet channel to use for ap operation.
1752178354Ssam */
1753178354Ssamstatic struct ieee80211_channel *
1754178354Ssamap_pick_channel(struct ieee80211_scan_state *ss, int flags)
1755178354Ssam{
1756178354Ssam	struct sta_table *st = ss->ss_priv;
1757178354Ssam	struct ieee80211_channel *bestchan = NULL;
1758178354Ssam	int i;
1759178354Ssam
1760178354Ssam	/* XXX select channel more intelligently, e.g. channel spread, power */
1761178354Ssam	/* NB: use scan list order to preserve channel preference */
1762178354Ssam	for (i = 0; i < ss->ss_last; i++) {
1763178354Ssam		struct ieee80211_channel *chan = ss->ss_chans[i];
1764178354Ssam		/*
1765178354Ssam		 * If the channel is unoccupied the max rssi
1766178354Ssam		 * should be zero; just take it.  Otherwise
1767178354Ssam		 * track the channel with the lowest rssi and
1768178354Ssam		 * use that when all channels appear occupied.
1769178354Ssam		 */
1770178354Ssam		if (IEEE80211_IS_CHAN_RADAR(chan))
1771178354Ssam			continue;
1772178354Ssam		if (IEEE80211_IS_CHAN_NOHOSTAP(chan))
1773178354Ssam			continue;
1774178354Ssam		/* check channel attributes for band compatibility */
1775178354Ssam		if (flags != 0 && (chan->ic_flags & flags) != flags)
1776178354Ssam			continue;
1777186107Ssam		KASSERT(sizeof(chan->ic_ieee) == 1, ("ic_chan size"));
1778178354Ssam		/* XXX channel have interference */
1779178354Ssam		if (st->st_maxrssi[chan->ic_ieee] == 0) {
1780178354Ssam			/* XXX use other considerations */
1781178354Ssam			return chan;
1782170530Ssam		}
1783178354Ssam		if (bestchan == NULL ||
1784178354Ssam		    st->st_maxrssi[chan->ic_ieee] < st->st_maxrssi[bestchan->ic_ieee])
1785178354Ssam			bestchan = chan;
1786178354Ssam	}
1787178354Ssam	return bestchan;
1788178354Ssam}
1789178354Ssam
1790178354Ssam/*
1791178354Ssam * Pick a quiet channel to use for ap operation.
1792178354Ssam */
1793178354Ssamstatic int
1794178354Ssamap_end(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1795178354Ssam{
1796178354Ssam	struct ieee80211com *ic = vap->iv_ic;
1797178354Ssam	struct ieee80211_channel *bestchan;
1798178354Ssam
1799178354Ssam	KASSERT(vap->iv_opmode == IEEE80211_M_HOSTAP,
1800178354Ssam		("wrong opmode %u", vap->iv_opmode));
1801178354Ssam	bestchan = ap_pick_channel(ss, 0);
1802178354Ssam	if (bestchan == NULL) {
1803178354Ssam		/* no suitable channel, should not happen */
1804178354Ssam		IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN,
1805178354Ssam		    "%s: no suitable channel! (should not happen)\n", __func__);
1806178354Ssam		/* XXX print something? */
1807178354Ssam		return 0;			/* restart scan */
1808178354Ssam	}
1809178354Ssam	/*
1810178354Ssam	 * If this is a dynamic turbo channel, start with the unboosted one.
1811178354Ssam	 */
1812178354Ssam	if (IEEE80211_IS_CHAN_TURBO(bestchan)) {
1813178354Ssam		bestchan = ieee80211_find_channel(ic, bestchan->ic_freq,
1814178354Ssam			bestchan->ic_flags & ~IEEE80211_CHAN_TURBO);
1815178354Ssam		if (bestchan == NULL) {
1816178354Ssam			/* should never happen ?? */
1817178354Ssam			return 0;
1818170530Ssam		}
1819170530Ssam	}
1820178354Ssam	if (ss->ss_flags & (IEEE80211_SCAN_NOPICK | IEEE80211_SCAN_NOJOIN)) {
1821178354Ssam		/*
1822178354Ssam		 * Manual/background scan, don't select+join the
1823178354Ssam		 * bss, just return.  The scanning framework will
1824178354Ssam		 * handle notification that this has completed.
1825178354Ssam		 */
1826178354Ssam		ss->ss_flags &= ~IEEE80211_SCAN_NOPICK;
1827178354Ssam		return 1;
1828178354Ssam	}
1829178354Ssam	ieee80211_create_ibss(vap,
1830193655Ssam	    ieee80211_ht_adjust_channel(ic, bestchan, vap->iv_flags_ht));
1831178354Ssam	return 1;
1832170530Ssam}
1833170530Ssam
1834178354Ssamstatic const struct ieee80211_scanner ap_default = {
1835178354Ssam	.scan_name		= "default",
1836178354Ssam	.scan_attach		= sta_attach,
1837178354Ssam	.scan_detach		= sta_detach,
1838178354Ssam	.scan_start		= ap_start,
1839178354Ssam	.scan_restart		= sta_restart,
1840178354Ssam	.scan_cancel		= ap_cancel,
1841178354Ssam	.scan_end		= ap_end,
1842178354Ssam	.scan_flush		= sta_flush,
1843178354Ssam	.scan_pickchan		= ap_pick_channel,
1844178354Ssam	.scan_add		= sta_add,
1845178354Ssam	.scan_age		= adhoc_age,
1846178354Ssam	.scan_iterate		= sta_iterate,
1847178354Ssam	.scan_assoc_success	= sta_assoc_success,
1848178354Ssam	.scan_assoc_fail	= sta_assoc_fail,
1849170530Ssam};
1850195618SrpauloIEEE80211_SCANNER_ALG(ap, IEEE80211_M_HOSTAP, ap_default);
1851178354Ssam
1852195618Srpaulo#ifdef IEEE80211_SUPPORT_MESH
1853178354Ssam/*
1854195618Srpaulo * Pick an mbss network to join or find a channel
1855195618Srpaulo * to use to start an mbss network.
1856178354Ssam */
1857195618Srpaulostatic int
1858195618Srpaulomesh_pick_bss(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1859195618Srpaulo{
1860195618Srpaulo	struct sta_table *st = ss->ss_priv;
1861195618Srpaulo	struct ieee80211_mesh_state *ms = vap->iv_mesh;
1862195618Srpaulo	struct sta_entry *selbs;
1863195618Srpaulo	struct ieee80211_channel *chan;
1864195618Srpaulo
1865195618Srpaulo	KASSERT(vap->iv_opmode == IEEE80211_M_MBSS,
1866195618Srpaulo		("wrong opmode %u", vap->iv_opmode));
1867195618Srpaulo
1868195618Srpaulo	if (st->st_newscan) {
1869195618Srpaulo		sta_update_notseen(st);
1870195618Srpaulo		st->st_newscan = 0;
1871195618Srpaulo	}
1872195618Srpaulo	if (ss->ss_flags & IEEE80211_SCAN_NOPICK) {
1873195618Srpaulo		/*
1874195618Srpaulo		 * Manual/background scan, don't select+join the
1875195618Srpaulo		 * bss, just return.  The scanning framework will
1876195618Srpaulo		 * handle notification that this has completed.
1877195618Srpaulo		 */
1878195618Srpaulo		ss->ss_flags &= ~IEEE80211_SCAN_NOPICK;
1879195618Srpaulo		return 1;
1880195618Srpaulo	}
1881195618Srpaulo	/*
1882195618Srpaulo	 * Automatic sequencing; look for a candidate and
1883195618Srpaulo	 * if found join the network.
1884195618Srpaulo	 */
1885195618Srpaulo	/* NB: unlocked read should be ok */
1886195618Srpaulo	if (TAILQ_FIRST(&st->st_entry) == NULL) {
1887195618Srpaulo		IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN,
1888195618Srpaulo			"%s: no scan candidate\n", __func__);
1889195618Srpaulo		if (ss->ss_flags & IEEE80211_SCAN_NOJOIN)
1890195618Srpaulo			return 0;
1891195618Srpaulonotfound:
1892195618Srpaulo		if (ms->ms_idlen != 0) {
1893195618Srpaulo			/*
1894195618Srpaulo			 * No existing mbss network to join and we have
1895195618Srpaulo			 * a meshid; start one up.  If no channel was
1896195618Srpaulo			 * specified, try to select a channel.
1897195618Srpaulo			 */
1898195618Srpaulo			if (vap->iv_des_chan == IEEE80211_CHAN_ANYC ||
1899195618Srpaulo			    IEEE80211_IS_CHAN_RADAR(vap->iv_des_chan)) {
1900195618Srpaulo				struct ieee80211com *ic = vap->iv_ic;
1901195618Srpaulo
1902195618Srpaulo				chan = adhoc_pick_channel(ss, 0);
1903195618Srpaulo				if (chan != NULL)
1904195618Srpaulo					chan = ieee80211_ht_adjust_channel(ic,
1905195618Srpaulo					    chan, vap->iv_flags_ht);
1906195618Srpaulo			} else
1907195618Srpaulo				chan = vap->iv_des_chan;
1908195618Srpaulo			if (chan != NULL) {
1909195618Srpaulo				ieee80211_create_ibss(vap, chan);
1910195618Srpaulo				return 1;
1911195618Srpaulo			}
1912195618Srpaulo		}
1913195618Srpaulo		/*
1914195618Srpaulo		 * If nothing suitable was found decrement
1915195618Srpaulo		 * the failure counts so entries will be
1916195618Srpaulo		 * reconsidered the next time around.  We
1917195618Srpaulo		 * really want to do this only for sta's
1918195618Srpaulo		 * where we've previously had some success.
1919195618Srpaulo		 */
1920195618Srpaulo		sta_dec_fails(st);
1921195618Srpaulo		st->st_newscan = 1;
1922195618Srpaulo		return 0;			/* restart scan */
1923195618Srpaulo	}
1924195618Srpaulo	selbs = select_bss(ss, vap, IEEE80211_MSG_SCAN);
1925195618Srpaulo	if (ss->ss_flags & IEEE80211_SCAN_NOJOIN)
1926195618Srpaulo		return (selbs != NULL);
1927195618Srpaulo	if (selbs == NULL)
1928195618Srpaulo		goto notfound;
1929195618Srpaulo	chan = selbs->base.se_chan;
1930195618Srpaulo	if (selbs->se_flags & STA_DEMOTE11B)
1931195618Srpaulo		chan = demote11b(vap, chan);
1932195618Srpaulo	if (!ieee80211_sta_join(vap, chan, &selbs->base))
1933195618Srpaulo		goto notfound;
1934195618Srpaulo	return 1;				/* terminate scan */
1935195618Srpaulo}
1936195618Srpaulo
1937195618Srpaulostatic const struct ieee80211_scanner mesh_default = {
1938195618Srpaulo	.scan_name		= "default",
1939195618Srpaulo	.scan_attach		= sta_attach,
1940195618Srpaulo	.scan_detach		= sta_detach,
1941195618Srpaulo	.scan_start		= adhoc_start,
1942195618Srpaulo	.scan_restart		= sta_restart,
1943195618Srpaulo	.scan_cancel		= sta_cancel,
1944195618Srpaulo	.scan_end		= mesh_pick_bss,
1945195618Srpaulo	.scan_flush		= sta_flush,
1946195618Srpaulo	.scan_pickchan		= adhoc_pick_channel,
1947195618Srpaulo	.scan_add		= sta_add,
1948195618Srpaulo	.scan_age		= adhoc_age,
1949195618Srpaulo	.scan_iterate		= sta_iterate,
1950195618Srpaulo	.scan_assoc_fail	= sta_assoc_fail,
1951195618Srpaulo	.scan_assoc_success	= sta_assoc_success,
1952195618Srpaulo};
1953195618SrpauloIEEE80211_SCANNER_ALG(mesh, IEEE80211_M_MBSS, mesh_default);
1954195618Srpaulo#endif /* IEEE80211_SUPPORT_MESH */
1955