ieee80211_scan_sta.c revision 283556
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 283556 2015-05-26 04:37:59Z adrian $");
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>
42257176Sglebius#include <net/if_var.h>
43170530Ssam#include <net/if_media.h>
44170530Ssam#include <net/ethernet.h>
45170530Ssam
46170530Ssam#include <net80211/ieee80211_var.h>
47178354Ssam#include <net80211/ieee80211_input.h>
48178354Ssam#include <net80211/ieee80211_regdomain.h>
49186904Ssam#ifdef IEEE80211_SUPPORT_TDMA
50186904Ssam#include <net80211/ieee80211_tdma.h>
51186904Ssam#endif
52195618Srpaulo#ifdef IEEE80211_SUPPORT_MESH
53195618Srpaulo#include <net80211/ieee80211_mesh.h>
54195618Srpaulo#endif
55245928Sadrian#include <net80211/ieee80211_ratectl.h>
56170530Ssam
57170530Ssam#include <net/bpf.h>
58170530Ssam
59170530Ssam/*
60170530Ssam * Parameters for managing cache entries:
61170530Ssam *
62170530Ssam * o a station with STA_FAILS_MAX failures is not considered
63170530Ssam *   when picking a candidate
64170530Ssam * o a station that hasn't had an update in STA_PURGE_SCANS
65170530Ssam *   (background) scans is discarded
66170530Ssam * o after STA_FAILS_AGE seconds we clear the failure count
67170530Ssam */
68170530Ssam#define	STA_FAILS_MAX	2		/* assoc failures before ignored */
69170530Ssam#define	STA_FAILS_AGE	(2*60)		/* time before clearing fails (secs) */
70170530Ssam#define	STA_PURGE_SCANS	2		/* age for purging entries (scans) */
71170530Ssam
72170530Ssam/* XXX tunable */
73170530Ssam#define	STA_RSSI_MIN	8		/* min acceptable rssi */
74170530Ssam#define	STA_RSSI_MAX	40		/* max rssi for comparison */
75170530Ssam
76170530Ssamstruct sta_entry {
77170530Ssam	struct ieee80211_scan_entry base;
78170530Ssam	TAILQ_ENTRY(sta_entry) se_list;
79170530Ssam	LIST_ENTRY(sta_entry) se_hash;
80170530Ssam	uint8_t		se_fails;		/* failure to associate count */
81170530Ssam	uint8_t		se_seen;		/* seen during current scan */
82170530Ssam	uint8_t		se_notseen;		/* not seen in previous scans */
83170530Ssam	uint8_t		se_flags;
84184302Ssam#define	STA_DEMOTE11B	0x01			/* match w/ demoted 11b chan */
85170530Ssam	uint32_t	se_avgrssi;		/* LPF rssi state */
86170530Ssam	unsigned long	se_lastupdate;		/* time of last update */
87170530Ssam	unsigned long	se_lastfail;		/* time of last failure */
88170530Ssam	unsigned long	se_lastassoc;		/* time of last association */
89170530Ssam	u_int		se_scangen;		/* iterator scan gen# */
90178354Ssam	u_int		se_countrygen;		/* gen# of last cc notify */
91170530Ssam};
92170530Ssam
93170530Ssam#define	STA_HASHSIZE	32
94170530Ssam/* simple hash is enough for variation of macaddr */
95170530Ssam#define	STA_HASH(addr)	\
96170530Ssam	(((const uint8_t *)(addr))[IEEE80211_ADDR_LEN - 1] % STA_HASHSIZE)
97170530Ssam
98186107Ssam#define	MAX_IEEE_CHAN	256			/* max acceptable IEEE chan # */
99186107SsamCTASSERT(MAX_IEEE_CHAN >= 256);
100186107Ssam
101170530Ssamstruct sta_table {
102206617Srpaulo	ieee80211_scan_table_lock_t st_lock;	/* on scan table */
103170530Ssam	TAILQ_HEAD(, sta_entry) st_entry;	/* all entries */
104170530Ssam	LIST_HEAD(, sta_entry) st_hash[STA_HASHSIZE];
105283556Sadrian	ieee80211_scan_iter_lock_t st_scanlock;		/* on st_scaniter */
106178354Ssam	u_int		st_scaniter;		/* gen# for iterator */
107178354Ssam	u_int		st_scangen;		/* scan generation # */
108170530Ssam	int		st_newscan;
109178354Ssam	/* ap-related state */
110186107Ssam	int		st_maxrssi[MAX_IEEE_CHAN];
111170530Ssam};
112170530Ssam
113170530Ssamstatic void sta_flush_table(struct sta_table *);
114171409Ssam/*
115171409Ssam * match_bss returns a bitmask describing if an entry is suitable
116171409Ssam * for use.  If non-zero the entry was deemed not suitable and it's
117171409Ssam * contents explains why.  The following flags are or'd to to this
118171409Ssam * mask and can be used to figure out why the entry was rejected.
119171409Ssam */
120195618Srpaulo#define	MATCH_CHANNEL		0x00001	/* channel mismatch */
121195618Srpaulo#define	MATCH_CAPINFO		0x00002	/* capabilities mismatch, e.g. no ess */
122195618Srpaulo#define	MATCH_PRIVACY		0x00004	/* privacy mismatch */
123195618Srpaulo#define	MATCH_RATE		0x00008	/* rate set mismatch */
124195618Srpaulo#define	MATCH_SSID		0x00010	/* ssid mismatch */
125195618Srpaulo#define	MATCH_BSSID		0x00020	/* bssid mismatch */
126195618Srpaulo#define	MATCH_FAILS		0x00040	/* too many failed auth attempts */
127195618Srpaulo#define	MATCH_NOTSEEN		0x00080	/* not seen in recent scans */
128195618Srpaulo#define	MATCH_RSSI		0x00100	/* rssi deemed too low to use */
129195618Srpaulo#define	MATCH_CC		0x00200	/* country code mismatch */
130195618Srpaulo#define	MATCH_TDMA_NOIE		0x00400	/* no TDMA ie */
131195618Srpaulo#define	MATCH_TDMA_NOTMASTER	0x00800	/* not TDMA master */
132195618Srpaulo#define	MATCH_TDMA_NOSLOT	0x01000	/* all TDMA slots occupied */
133195618Srpaulo#define	MATCH_TDMA_LOCAL	0x02000	/* local address */
134195618Srpaulo#define	MATCH_TDMA_VERSION	0x04000	/* protocol version mismatch */
135195618Srpaulo#define	MATCH_MESH_NOID		0x10000	/* no MESHID ie */
136195618Srpaulo#define	MATCH_MESHID		0x20000	/* meshid mismatch */
137178354Ssamstatic int match_bss(struct ieee80211vap *,
138170530Ssam	const struct ieee80211_scan_state *, struct sta_entry *, int);
139178354Ssamstatic void adhoc_age(struct ieee80211_scan_state *);
140170530Ssam
141178354Ssamstatic __inline int
142178354Ssamisocmp(const uint8_t cc1[], const uint8_t cc2[])
143178354Ssam{
144178354Ssam     return (cc1[0] == cc2[0] && cc1[1] == cc2[1]);
145178354Ssam}
146178354Ssam
147170530Ssam/* number of references from net80211 layer */
148170530Ssamstatic	int nrefs = 0;
149195618Srpaulo/*
150195618Srpaulo * Module glue.
151195618Srpaulo */
152195618SrpauloIEEE80211_SCANNER_MODULE(sta, 1);
153170530Ssam
154170530Ssam/*
155170530Ssam * Attach prior to any scanning work.
156170530Ssam */
157170530Ssamstatic int
158170530Ssamsta_attach(struct ieee80211_scan_state *ss)
159170530Ssam{
160170530Ssam	struct sta_table *st;
161170530Ssam
162283538Sadrian	st = (struct sta_table *) IEEE80211_MALLOC(sizeof(struct sta_table),
163283538Sadrian		M_80211_SCAN,
164283538Sadrian		IEEE80211_M_NOWAIT | IEEE80211_M_ZERO);
165170530Ssam	if (st == NULL)
166170530Ssam		return 0;
167206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK_INIT(st, "scantable");
168283556Sadrian	IEEE80211_SCAN_ITER_LOCK_INIT(st, "scangen");
169170530Ssam	TAILQ_INIT(&st->st_entry);
170170530Ssam	ss->ss_priv = st;
171170530Ssam	nrefs++;			/* NB: we assume caller locking */
172170530Ssam	return 1;
173170530Ssam}
174170530Ssam
175170530Ssam/*
176170530Ssam * Cleanup any private state.
177170530Ssam */
178170530Ssamstatic int
179170530Ssamsta_detach(struct ieee80211_scan_state *ss)
180170530Ssam{
181170530Ssam	struct sta_table *st = ss->ss_priv;
182170530Ssam
183170530Ssam	if (st != NULL) {
184170530Ssam		sta_flush_table(st);
185206617Srpaulo		IEEE80211_SCAN_TABLE_LOCK_DESTROY(st);
186283556Sadrian		IEEE80211_SCAN_ITER_LOCK_DESTROY(st);
187283538Sadrian		IEEE80211_FREE(st, M_80211_SCAN);
188170530Ssam		KASSERT(nrefs > 0, ("imbalanced attach/detach"));
189170530Ssam		nrefs--;		/* NB: we assume caller locking */
190170530Ssam	}
191170530Ssam	return 1;
192170530Ssam}
193170530Ssam
194170530Ssam/*
195170530Ssam * Flush all per-scan state.
196170530Ssam */
197170530Ssamstatic int
198170530Ssamsta_flush(struct ieee80211_scan_state *ss)
199170530Ssam{
200170530Ssam	struct sta_table *st = ss->ss_priv;
201170530Ssam
202206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
203170530Ssam	sta_flush_table(st);
204206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
205170530Ssam	ss->ss_last = 0;
206170530Ssam	return 0;
207170530Ssam}
208170530Ssam
209170530Ssam/*
210170530Ssam * Flush all entries in the scan cache.
211170530Ssam */
212170530Ssamstatic void
213170530Ssamsta_flush_table(struct sta_table *st)
214170530Ssam{
215170530Ssam	struct sta_entry *se, *next;
216170530Ssam
217170530Ssam	TAILQ_FOREACH_SAFE(se, &st->st_entry, se_list, next) {
218170530Ssam		TAILQ_REMOVE(&st->st_entry, se, se_list);
219170530Ssam		LIST_REMOVE(se, se_hash);
220178354Ssam		ieee80211_ies_cleanup(&se->base.se_ies);
221283538Sadrian		IEEE80211_FREE(se, M_80211_SCAN);
222170530Ssam	}
223178354Ssam	memset(st->st_maxrssi, 0, sizeof(st->st_maxrssi));
224170530Ssam}
225170530Ssam
226170530Ssam/*
227170530Ssam * Process a beacon or probe response frame; create an
228170530Ssam * entry in the scan cache or update any previous entry.
229170530Ssam */
230170530Ssamstatic int
231170530Ssamsta_add(struct ieee80211_scan_state *ss,
232282742Sadrian	struct ieee80211_channel *curchan,
233170530Ssam	const struct ieee80211_scanparams *sp,
234170530Ssam	const struct ieee80211_frame *wh,
235192468Ssam	int subtype, int rssi, int noise)
236170530Ssam{
237170530Ssam#define	ISPROBE(_st)	((_st) == IEEE80211_FC0_SUBTYPE_PROBE_RESP)
238170530Ssam#define	PICK1ST(_ss) \
239170530Ssam	((ss->ss_flags & (IEEE80211_SCAN_PICK1ST | IEEE80211_SCAN_GOTPICK)) == \
240170530Ssam	IEEE80211_SCAN_PICK1ST)
241170530Ssam	struct sta_table *st = ss->ss_priv;
242170530Ssam	const uint8_t *macaddr = wh->i_addr2;
243178354Ssam	struct ieee80211vap *vap = ss->ss_vap;
244178354Ssam	struct ieee80211com *ic = vap->iv_ic;
245224717Sbschmidt	struct ieee80211_channel *c;
246170530Ssam	struct sta_entry *se;
247170530Ssam	struct ieee80211_scan_entry *ise;
248178354Ssam	int hash;
249170530Ssam
250170530Ssam	hash = STA_HASH(macaddr);
251170530Ssam
252206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
253170530Ssam	LIST_FOREACH(se, &st->st_hash[hash], se_hash)
254170530Ssam		if (IEEE80211_ADDR_EQ(se->base.se_macaddr, macaddr))
255170530Ssam			goto found;
256283538Sadrian	se = (struct sta_entry *) IEEE80211_MALLOC(sizeof(struct sta_entry),
257283538Sadrian		M_80211_SCAN, IEEE80211_M_NOWAIT | IEEE80211_M_ZERO);
258170530Ssam	if (se == NULL) {
259206617Srpaulo		IEEE80211_SCAN_TABLE_UNLOCK(st);
260170530Ssam		return 0;
261170530Ssam	}
262178354Ssam	se->se_scangen = st->st_scaniter-1;
263178354Ssam	se->se_avgrssi = IEEE80211_RSSI_DUMMY_MARKER;
264170530Ssam	IEEE80211_ADDR_COPY(se->base.se_macaddr, macaddr);
265170530Ssam	TAILQ_INSERT_TAIL(&st->st_entry, se, se_list);
266170530Ssam	LIST_INSERT_HEAD(&st->st_hash[hash], se, se_hash);
267170530Ssamfound:
268170530Ssam	ise = &se->base;
269170530Ssam	/* XXX ap beaconing multiple ssid w/ same bssid */
270170530Ssam	if (sp->ssid[1] != 0 &&
271170530Ssam	    (ISPROBE(subtype) || ise->se_ssid[1] == 0))
272170530Ssam		memcpy(ise->se_ssid, sp->ssid, 2+sp->ssid[1]);
273170530Ssam	KASSERT(sp->rates[1] <= IEEE80211_RATE_MAXSIZE,
274170530Ssam		("rate set too large: %u", sp->rates[1]));
275170530Ssam	memcpy(ise->se_rates, sp->rates, 2+sp->rates[1]);
276170530Ssam	if (sp->xrates != NULL) {
277170530Ssam		/* XXX validate xrates[1] */
278178354Ssam		KASSERT(sp->xrates[1] <= IEEE80211_RATE_MAXSIZE,
279170530Ssam			("xrate set too large: %u", sp->xrates[1]));
280170530Ssam		memcpy(ise->se_xrates, sp->xrates, 2+sp->xrates[1]);
281170530Ssam	} else
282170530Ssam		ise->se_xrates[1] = 0;
283170530Ssam	IEEE80211_ADDR_COPY(ise->se_bssid, wh->i_addr3);
284178354Ssam	if ((sp->status & IEEE80211_BPARSE_OFFCHAN) == 0) {
285173368Ssam		/*
286173368Ssam		 * Record rssi data using extended precision LPF filter.
287173368Ssam		 *
288173368Ssam		 * NB: use only on-channel data to insure we get a good
289173368Ssam		 *     estimate of the signal we'll see when associated.
290173368Ssam		 */
291178354Ssam		IEEE80211_RSSI_LPF(se->se_avgrssi, rssi);
292178354Ssam		ise->se_rssi = IEEE80211_RSSI_GET(se->se_avgrssi);
293173368Ssam		ise->se_noise = noise;
294173368Ssam	}
295170530Ssam	memcpy(ise->se_tstamp.data, sp->tstamp, sizeof(ise->se_tstamp));
296170530Ssam	ise->se_intval = sp->bintval;
297170530Ssam	ise->se_capinfo = sp->capinfo;
298195618Srpaulo#ifdef IEEE80211_SUPPORT_MESH
299195618Srpaulo	if (sp->meshid != NULL && sp->meshid[1] != 0)
300195618Srpaulo		memcpy(ise->se_meshid, sp->meshid, 2+sp->meshid[1]);
301195618Srpaulo#endif
302173368Ssam	/*
303173368Ssam	 * Beware of overriding se_chan for frames seen
304173368Ssam	 * off-channel; this can cause us to attempt an
305178354Ssam	 * association on the wrong channel.
306173368Ssam	 */
307178354Ssam	if (sp->status & IEEE80211_BPARSE_OFFCHAN) {
308173368Ssam		/*
309173862Ssam		 * Off-channel, locate the home/bss channel for the sta
310178354Ssam		 * using the value broadcast in the DSPARMS ie.  We know
311178354Ssam		 * sp->chan has this value because it's used to calculate
312178354Ssam		 * IEEE80211_BPARSE_OFFCHAN.
313173368Ssam		 */
314178354Ssam		c = ieee80211_find_channel_byieee(ic, sp->chan,
315282742Sadrian		    curchan->ic_flags);
316173956Ssam		if (c != NULL) {
317173956Ssam			ise->se_chan = c;
318173956Ssam		} else if (ise->se_chan == NULL) {
319173862Ssam			/* should not happen, pick something */
320282742Sadrian			ise->se_chan = curchan;
321173862Ssam		}
322173862Ssam	} else
323282742Sadrian		ise->se_chan = curchan;
324224717Sbschmidt	if (IEEE80211_IS_CHAN_HT(ise->se_chan) && sp->htcap == NULL) {
325224717Sbschmidt		/* Demote legacy networks to a non-HT channel. */
326224717Sbschmidt		c = ieee80211_find_channel(ic, ise->se_chan->ic_freq,
327224717Sbschmidt		    ise->se_chan->ic_flags & ~IEEE80211_CHAN_HT);
328224717Sbschmidt		KASSERT(c != NULL,
329224717Sbschmidt		    ("no legacy channel %u", ise->se_chan->ic_ieee));
330224717Sbschmidt		ise->se_chan = c;
331224717Sbschmidt	}
332170530Ssam	ise->se_fhdwell = sp->fhdwell;
333170530Ssam	ise->se_fhindex = sp->fhindex;
334170530Ssam	ise->se_erp = sp->erp;
335170530Ssam	ise->se_timoff = sp->timoff;
336170530Ssam	if (sp->tim != NULL) {
337170530Ssam		const struct ieee80211_tim_ie *tim =
338170530Ssam		    (const struct ieee80211_tim_ie *) sp->tim;
339170530Ssam		ise->se_dtimperiod = tim->tim_period;
340170530Ssam	}
341178354Ssam	if (sp->country != NULL) {
342178354Ssam		const struct ieee80211_country_ie *cie =
343178354Ssam		    (const struct ieee80211_country_ie *) sp->country;
344178354Ssam		/*
345178354Ssam		 * If 11d is enabled and we're attempting to join a bss
346178354Ssam		 * that advertises it's country code then compare our
347178354Ssam		 * current settings to what we fetched from the country ie.
348178354Ssam		 * If our country code is unspecified or different then
349178354Ssam		 * dispatch an event to user space that identifies the
350178354Ssam		 * country code so our regdomain config can be changed.
351178354Ssam		 */
352178354Ssam		/* XXX only for STA mode? */
353178354Ssam		if ((IEEE80211_IS_CHAN_11D(ise->se_chan) ||
354178354Ssam		    (vap->iv_flags_ext & IEEE80211_FEXT_DOTD)) &&
355178354Ssam		    (ic->ic_regdomain.country == CTRY_DEFAULT ||
356178354Ssam		     !isocmp(cie->cc, ic->ic_regdomain.isocc))) {
357178354Ssam			/* only issue one notify event per scan */
358178354Ssam			if (se->se_countrygen != st->st_scangen) {
359178354Ssam				ieee80211_notify_country(vap, ise->se_bssid,
360178354Ssam				    cie->cc);
361178354Ssam				se->se_countrygen = st->st_scangen;
362178354Ssam			}
363178354Ssam		}
364178354Ssam		ise->se_cc[0] = cie->cc[0];
365178354Ssam		ise->se_cc[1] = cie->cc[1];
366178354Ssam	}
367178354Ssam	/* NB: no need to setup ie ptrs; they are not (currently) used */
368178354Ssam	(void) ieee80211_ies_init(&ise->se_ies, sp->ies, sp->ies_len);
369170530Ssam
370170530Ssam	/* clear failure count after STA_FAIL_AGE passes */
371170530Ssam	if (se->se_fails && (ticks - se->se_lastfail) > STA_FAILS_AGE*hz) {
372170530Ssam		se->se_fails = 0;
373178354Ssam		IEEE80211_NOTE_MAC(vap, IEEE80211_MSG_SCAN, macaddr,
374170530Ssam		    "%s: fails %u", __func__, se->se_fails);
375170530Ssam	}
376170530Ssam
377170530Ssam	se->se_lastupdate = ticks;		/* update time */
378170530Ssam	se->se_seen = 1;
379170530Ssam	se->se_notseen = 0;
380170530Ssam
381186107Ssam	KASSERT(sizeof(sp->bchan) == 1, ("bchan size"));
382178354Ssam	if (rssi > st->st_maxrssi[sp->bchan])
383178354Ssam		st->st_maxrssi[sp->bchan] = rssi;
384178354Ssam
385206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
386170530Ssam
387170530Ssam	/*
388170530Ssam	 * If looking for a quick choice and nothing's
389170530Ssam	 * been found check here.
390170530Ssam	 */
391178354Ssam	if (PICK1ST(ss) && match_bss(vap, ss, se, IEEE80211_MSG_SCAN) == 0)
392170530Ssam		ss->ss_flags |= IEEE80211_SCAN_GOTPICK;
393170530Ssam
394170530Ssam	return 1;
395170530Ssam#undef PICK1ST
396170530Ssam#undef ISPROBE
397170530Ssam}
398170530Ssam
399170530Ssam/*
400170530Ssam * Check if a channel is excluded by user request.
401170530Ssam */
402170530Ssamstatic int
403178354Ssamisexcluded(struct ieee80211vap *vap, const struct ieee80211_channel *c)
404170530Ssam{
405178354Ssam	return (isclr(vap->iv_ic->ic_chan_active, c->ic_ieee) ||
406178354Ssam	    (vap->iv_des_chan != IEEE80211_CHAN_ANYC &&
407178354Ssam	     c->ic_freq != vap->iv_des_chan->ic_freq));
408170530Ssam}
409170530Ssam
410170530Ssamstatic struct ieee80211_channel *
411170530Ssamfind11gchannel(struct ieee80211com *ic, int i, int freq)
412170530Ssam{
413170530Ssam	struct ieee80211_channel *c;
414170530Ssam	int j;
415170530Ssam
416170530Ssam	/*
417170530Ssam	 * The normal ordering in the channel list is b channel
418170530Ssam	 * immediately followed by g so optimize the search for
419170530Ssam	 * this.  We'll still do a full search just in case.
420170530Ssam	 */
421170530Ssam	for (j = i+1; j < ic->ic_nchans; j++) {
422170530Ssam		c = &ic->ic_channels[j];
423187991Ssam		if (c->ic_freq == freq && IEEE80211_IS_CHAN_G(c))
424170530Ssam			return c;
425170530Ssam	}
426170530Ssam	for (j = 0; j < i; j++) {
427170530Ssam		c = &ic->ic_channels[j];
428187991Ssam		if (c->ic_freq == freq && IEEE80211_IS_CHAN_G(c))
429170530Ssam			return c;
430170530Ssam	}
431170530Ssam	return NULL;
432170530Ssam}
433188777Ssam
434170530Ssamstatic const u_int chanflags[IEEE80211_MODE_MAX] = {
435188777Ssam	[IEEE80211_MODE_AUTO]	  = IEEE80211_CHAN_B,
436188777Ssam	[IEEE80211_MODE_11A]	  = IEEE80211_CHAN_A,
437188777Ssam	[IEEE80211_MODE_11B]	  = IEEE80211_CHAN_B,
438188777Ssam	[IEEE80211_MODE_11G]	  = IEEE80211_CHAN_G,
439188777Ssam	[IEEE80211_MODE_FH]	  = IEEE80211_CHAN_FHSS,
440188777Ssam	/* check base channel */
441188777Ssam	[IEEE80211_MODE_TURBO_A]  = IEEE80211_CHAN_A,
442188777Ssam	[IEEE80211_MODE_TURBO_G]  = IEEE80211_CHAN_G,
443188777Ssam	[IEEE80211_MODE_STURBO_A] = IEEE80211_CHAN_ST,
444188782Ssam	[IEEE80211_MODE_HALF]	  = IEEE80211_CHAN_HALF,
445188782Ssam	[IEEE80211_MODE_QUARTER]  = IEEE80211_CHAN_QUARTER,
446188777Ssam	/* check legacy */
447188777Ssam	[IEEE80211_MODE_11NA]	  = IEEE80211_CHAN_A,
448188777Ssam	[IEEE80211_MODE_11NG]	  = IEEE80211_CHAN_G,
449170530Ssam};
450170530Ssam
451170530Ssamstatic void
452178354Ssamadd_channels(struct ieee80211vap *vap,
453170530Ssam	struct ieee80211_scan_state *ss,
454170530Ssam	enum ieee80211_phymode mode, const uint16_t freq[], int nfreq)
455170530Ssam{
456178354Ssam	struct ieee80211com *ic = vap->iv_ic;
457170530Ssam	struct ieee80211_channel *c, *cg;
458170530Ssam	u_int modeflags;
459170530Ssam	int i;
460170530Ssam
461254315Srpaulo	KASSERT(mode < nitems(chanflags), ("Unexpected mode %u", mode));
462170530Ssam	modeflags = chanflags[mode];
463170530Ssam	for (i = 0; i < nfreq; i++) {
464170530Ssam		if (ss->ss_last >= IEEE80211_SCAN_MAX)
465170530Ssam			break;
466170530Ssam
467170530Ssam		c = ieee80211_find_channel(ic, freq[i], modeflags);
468178354Ssam		if (c == NULL || isexcluded(vap, c))
469170530Ssam			continue;
470170530Ssam		if (mode == IEEE80211_MODE_AUTO) {
471170530Ssam			/*
472170530Ssam			 * XXX special-case 11b/g channels so we select
473178354Ssam			 *     the g channel if both are present.
474170530Ssam			 */
475178354Ssam			if (IEEE80211_IS_CHAN_B(c) &&
476178354Ssam			    (cg = find11gchannel(ic, i, c->ic_freq)) != NULL)
477178354Ssam				c = cg;
478170530Ssam		}
479170530Ssam		ss->ss_chans[ss->ss_last++] = c;
480170530Ssam	}
481170530Ssam}
482170530Ssam
483170530Ssamstruct scanlist {
484170530Ssam	uint16_t	mode;
485170530Ssam	uint16_t	count;
486170530Ssam	const uint16_t	*list;
487170530Ssam};
488170530Ssam
489170530Ssamstatic int
490170530Ssamchecktable(const struct scanlist *scan, const struct ieee80211_channel *c)
491170530Ssam{
492170530Ssam	int i;
493170530Ssam
494170530Ssam	for (; scan->list != NULL; scan++) {
495170530Ssam		for (i = 0; i < scan->count; i++)
496170530Ssam			if (scan->list[i] == c->ic_freq)
497170530Ssam				return 1;
498170530Ssam	}
499170530Ssam	return 0;
500170530Ssam}
501170530Ssam
502189377Ssamstatic int
503189377Ssamonscanlist(const struct ieee80211_scan_state *ss,
504189377Ssam	const struct ieee80211_channel *c)
505189377Ssam{
506189377Ssam	int i;
507189377Ssam
508189377Ssam	for (i = 0; i < ss->ss_last; i++)
509189377Ssam		if (ss->ss_chans[i] == c)
510189377Ssam			return 1;
511189377Ssam	return 0;
512189377Ssam}
513189377Ssam
514176653Ssamstatic void
515178354Ssamsweepchannels(struct ieee80211_scan_state *ss, struct ieee80211vap *vap,
516176653Ssam	const struct scanlist table[])
517176653Ssam{
518178354Ssam	struct ieee80211com *ic = vap->iv_ic;
519176653Ssam	struct ieee80211_channel *c;
520176653Ssam	int i;
521176653Ssam
522176653Ssam	for (i = 0; i < ic->ic_nchans; i++) {
523176653Ssam		if (ss->ss_last >= IEEE80211_SCAN_MAX)
524176653Ssam			break;
525176653Ssam
526176653Ssam		c = &ic->ic_channels[i];
527176653Ssam		/*
528176653Ssam		 * Ignore dynamic turbo channels; we scan them
529176653Ssam		 * in normal mode (i.e. not boosted).  Likewise
530176653Ssam		 * for HT channels, they get scanned using
531176653Ssam		 * legacy rates.
532176653Ssam		 */
533176653Ssam		if (IEEE80211_IS_CHAN_DTURBO(c) || IEEE80211_IS_CHAN_HT(c))
534176653Ssam			continue;
535176653Ssam
536176653Ssam		/*
537176653Ssam		 * If a desired mode was specified, scan only
538176653Ssam		 * channels that satisfy that constraint.
539176653Ssam		 */
540178354Ssam		if (vap->iv_des_mode != IEEE80211_MODE_AUTO &&
541178354Ssam		    vap->iv_des_mode != ieee80211_chan2mode(c))
542176653Ssam			continue;
543176653Ssam
544176653Ssam		/*
545176653Ssam		 * Skip channels excluded by user request.
546176653Ssam		 */
547178354Ssam		if (isexcluded(vap, c))
548176653Ssam			continue;
549176653Ssam
550176653Ssam		/*
551176653Ssam		 * Add the channel unless it is listed in the
552176653Ssam		 * fixed scan order tables.  This insures we
553176653Ssam		 * don't sweep back in channels we filtered out
554176653Ssam		 * above.
555176653Ssam		 */
556176653Ssam		if (checktable(table, c))
557176653Ssam			continue;
558176653Ssam
559176653Ssam		/* Add channel to scanning list. */
560176653Ssam		ss->ss_chans[ss->ss_last++] = c;
561176653Ssam	}
562189377Ssam	/*
563189377Ssam	 * Explicitly add any desired channel if:
564189377Ssam	 * - not already on the scan list
565189377Ssam	 * - allowed by any desired mode constraint
566189377Ssam	 * - there is space in the scan list
567189377Ssam	 * This allows the channel to be used when the filtering
568189377Ssam	 * mechanisms would otherwise elide it (e.g HT, turbo).
569189377Ssam	 */
570189377Ssam	c = vap->iv_des_chan;
571189377Ssam	if (c != IEEE80211_CHAN_ANYC &&
572189377Ssam	    !onscanlist(ss, c) &&
573189377Ssam	    (vap->iv_des_mode == IEEE80211_MODE_AUTO ||
574189377Ssam	     vap->iv_des_mode == ieee80211_chan2mode(c)) &&
575189377Ssam	    ss->ss_last < IEEE80211_SCAN_MAX)
576189377Ssam		ss->ss_chans[ss->ss_last++] = c;
577176653Ssam}
578176653Ssam
579178354Ssamstatic void
580178354Ssammakescanlist(struct ieee80211_scan_state *ss, struct ieee80211vap *vap,
581178354Ssam	const struct scanlist table[])
582170530Ssam{
583170530Ssam	const struct scanlist *scan;
584170530Ssam	enum ieee80211_phymode mode;
585170530Ssam
586170530Ssam	ss->ss_last = 0;
587170530Ssam	/*
588170530Ssam	 * Use the table of ordered channels to construct the list
589170530Ssam	 * of channels for scanning.  Any channels in the ordered
590170530Ssam	 * list not in the master list will be discarded.
591170530Ssam	 */
592178354Ssam	for (scan = table; scan->list != NULL; scan++) {
593170530Ssam		mode = scan->mode;
594178354Ssam		if (vap->iv_des_mode != IEEE80211_MODE_AUTO) {
595170530Ssam			/*
596170530Ssam			 * If a desired mode was specified, scan only
597170530Ssam			 * channels that satisfy that constraint.
598170530Ssam			 */
599178354Ssam			if (vap->iv_des_mode != mode) {
600170530Ssam				/*
601170530Ssam				 * The scan table marks 2.4Ghz channels as b
602170530Ssam				 * so if the desired mode is 11g, then use
603170530Ssam				 * the 11b channel list but upgrade the mode.
604170530Ssam				 */
605275875Sadrian				if (vap->iv_des_mode == IEEE80211_MODE_11G) {
606275875Sadrian					if (mode == IEEE80211_MODE_11G) /* Skip the G check */
607275875Sadrian						continue;
608275875Sadrian					else if (mode == IEEE80211_MODE_11B)
609275875Sadrian						mode = IEEE80211_MODE_11G;	/* upgrade */
610275875Sadrian				}
611170530Ssam			}
612170530Ssam		} else {
613170530Ssam			/*
614170530Ssam			 * This lets add_channels upgrade an 11b channel
615170530Ssam			 * to 11g if available.
616170530Ssam			 */
617170530Ssam			if (mode == IEEE80211_MODE_11B)
618170530Ssam				mode = IEEE80211_MODE_AUTO;
619170530Ssam		}
620170530Ssam#ifdef IEEE80211_F_XR
621170530Ssam		/* XR does not operate on turbo channels */
622178354Ssam		if ((vap->iv_flags & IEEE80211_F_XR) &&
623170530Ssam		    (mode == IEEE80211_MODE_TURBO_A ||
624170530Ssam		     mode == IEEE80211_MODE_TURBO_G ||
625170530Ssam		     mode == IEEE80211_MODE_STURBO_A))
626170530Ssam			continue;
627170530Ssam#endif
628170530Ssam		/*
629170530Ssam		 * Add the list of the channels; any that are not
630170530Ssam		 * in the master channel list will be discarded.
631170530Ssam		 */
632178354Ssam		add_channels(vap, ss, mode, scan->list, scan->count);
633170530Ssam	}
634170530Ssam
635170530Ssam	/*
636178354Ssam	 * Add the channels from the ic that are not present
637178354Ssam	 * in the table.
638170530Ssam	 */
639178354Ssam	sweepchannels(ss, vap, table);
640178354Ssam}
641170530Ssam
642178354Ssamstatic const uint16_t rcl1[] =		/* 8 FCC channel: 52, 56, 60, 64, 36, 40, 44, 48 */
643178354Ssam{ 5260, 5280, 5300, 5320, 5180, 5200, 5220, 5240 };
644178354Ssamstatic const uint16_t rcl2[] =		/* 4 MKK channels: 34, 38, 42, 46 */
645178354Ssam{ 5170, 5190, 5210, 5230 };
646178354Ssamstatic const uint16_t rcl3[] =		/* 2.4Ghz ch: 1,6,11,7,13 */
647178354Ssam{ 2412, 2437, 2462, 2442, 2472 };
648178354Ssamstatic const uint16_t rcl4[] =		/* 5 FCC channel: 149, 153, 161, 165 */
649178354Ssam{ 5745, 5765, 5785, 5805, 5825 };
650178354Ssamstatic const uint16_t rcl7[] =		/* 11 ETSI channel: 100,104,108,112,116,120,124,128,132,136,140 */
651178354Ssam{ 5500, 5520, 5540, 5560, 5580, 5600, 5620, 5640, 5660, 5680, 5700 };
652178354Ssamstatic const uint16_t rcl8[] =		/* 2.4Ghz ch: 2,3,4,5,8,9,10,12 */
653178354Ssam{ 2417, 2422, 2427, 2432, 2447, 2452, 2457, 2467 };
654178354Ssamstatic const uint16_t rcl9[] =		/* 2.4Ghz ch: 14 */
655178354Ssam{ 2484 };
656178354Ssamstatic const uint16_t rcl10[] =	/* Added Korean channels 2312-2372 */
657178354Ssam{ 2312, 2317, 2322, 2327, 2332, 2337, 2342, 2347, 2352, 2357, 2362, 2367, 2372 };
658178354Ssamstatic const uint16_t rcl11[] =	/* Added Japan channels in 4.9/5.0 spectrum */
659178354Ssam{ 5040, 5060, 5080, 4920, 4940, 4960, 4980 };
660178354Ssam#ifdef ATH_TURBO_SCAN
661178354Ssamstatic const uint16_t rcl5[] =		/* 3 static turbo channels */
662178354Ssam{ 5210, 5250, 5290 };
663178354Ssamstatic const uint16_t rcl6[] =		/* 2 static turbo channels */
664178354Ssam{ 5760, 5800 };
665178354Ssamstatic const uint16_t rcl6x[] =	/* 4 FCC3 turbo channels */
666178354Ssam{ 5540, 5580, 5620, 5660 };
667178354Ssamstatic const uint16_t rcl12[] =	/* 2.4Ghz Turbo channel 6 */
668178354Ssam{ 2437 };
669178354Ssamstatic const uint16_t rcl13[] =	/* dynamic Turbo channels */
670178354Ssam{ 5200, 5240, 5280, 5765, 5805 };
671178354Ssam#endif /* ATH_TURBO_SCAN */
672170530Ssam
673178354Ssam#define	X(a)	.count = sizeof(a)/sizeof(a[0]), .list = a
674170530Ssam
675178354Ssamstatic const struct scanlist staScanTable[] = {
676178354Ssam	{ IEEE80211_MODE_11B,   	X(rcl3) },
677178354Ssam	{ IEEE80211_MODE_11A,   	X(rcl1) },
678178354Ssam	{ IEEE80211_MODE_11A,   	X(rcl2) },
679178354Ssam	{ IEEE80211_MODE_11B,   	X(rcl8) },
680178354Ssam	{ IEEE80211_MODE_11B,   	X(rcl9) },
681178354Ssam	{ IEEE80211_MODE_11A,   	X(rcl4) },
682178354Ssam#ifdef ATH_TURBO_SCAN
683178354Ssam	{ IEEE80211_MODE_STURBO_A,	X(rcl5) },
684178354Ssam	{ IEEE80211_MODE_STURBO_A,	X(rcl6) },
685178354Ssam	{ IEEE80211_MODE_TURBO_A,	X(rcl6x) },
686178354Ssam	{ IEEE80211_MODE_TURBO_A,	X(rcl13) },
687178354Ssam#endif /* ATH_TURBO_SCAN */
688178354Ssam	{ IEEE80211_MODE_11A,		X(rcl7) },
689178354Ssam	{ IEEE80211_MODE_11B,		X(rcl10) },
690178354Ssam	{ IEEE80211_MODE_11A,		X(rcl11) },
691178354Ssam#ifdef ATH_TURBO_SCAN
692178354Ssam	{ IEEE80211_MODE_TURBO_G,	X(rcl12) },
693178354Ssam#endif /* ATH_TURBO_SCAN */
694178354Ssam	{ .list = NULL }
695178354Ssam};
696178354Ssam
697178354Ssam/*
698178354Ssam * Start a station-mode scan by populating the channel list.
699178354Ssam */
700178354Ssamstatic int
701178354Ssamsta_start(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
702178354Ssam{
703178354Ssam	struct sta_table *st = ss->ss_priv;
704178354Ssam
705178354Ssam	makescanlist(ss, vap, staScanTable);
706178354Ssam
707178354Ssam	if (ss->ss_mindwell == 0)
708178354Ssam		ss->ss_mindwell = msecs_to_ticks(20);	/* 20ms */
709178354Ssam	if (ss->ss_maxdwell == 0)
710178354Ssam		ss->ss_maxdwell = msecs_to_ticks(200);	/* 200ms */
711178354Ssam
712178354Ssam	st->st_scangen++;
713170530Ssam	st->st_newscan = 1;
714170530Ssam
715170530Ssam	return 0;
716170530Ssam}
717170530Ssam
718170530Ssam/*
719178354Ssam * Restart a scan, typically a bg scan but can
720178354Ssam * also be a fg scan that came up empty.
721170530Ssam */
722170530Ssamstatic int
723178354Ssamsta_restart(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
724170530Ssam{
725170530Ssam	struct sta_table *st = ss->ss_priv;
726170530Ssam
727170530Ssam	st->st_newscan = 1;
728170530Ssam	return 0;
729170530Ssam}
730170530Ssam
731170530Ssam/*
732170530Ssam * Cancel an ongoing scan.
733170530Ssam */
734170530Ssamstatic int
735178354Ssamsta_cancel(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
736170530Ssam{
737170530Ssam	return 0;
738170530Ssam}
739170530Ssam
740258736Srpaulo/* unaligned little endian access */
741178354Ssam#define LE_READ_2(p)					\
742178354Ssam	((uint16_t)					\
743178354Ssam	 ((((const uint8_t *)(p))[0]      ) |		\
744178354Ssam	  (((const uint8_t *)(p))[1] <<  8)))
745184302Ssam
746184302Ssam/*
747184302Ssam * Demote any supplied 11g channel to 11b.  There should
748184302Ssam * always be an 11b channel but we check anyway...
749184302Ssam */
750184302Ssamstatic struct ieee80211_channel *
751184302Ssamdemote11b(struct ieee80211vap *vap, struct ieee80211_channel *chan)
752184302Ssam{
753184302Ssam	struct ieee80211_channel *c;
754178354Ssam
755184302Ssam	if (IEEE80211_IS_CHAN_ANYG(chan) &&
756184302Ssam	    vap->iv_des_mode == IEEE80211_MODE_AUTO) {
757184302Ssam		c = ieee80211_find_channel(vap->iv_ic, chan->ic_freq,
758184302Ssam		    (chan->ic_flags &~ (IEEE80211_CHAN_PUREG | IEEE80211_CHAN_G)) |
759184302Ssam		    IEEE80211_CHAN_B);
760184302Ssam		if (c != NULL)
761184302Ssam			chan = c;
762184302Ssam	}
763184302Ssam	return chan;
764184302Ssam}
765184302Ssam
766178354Ssamstatic int
767170530Ssammaxrate(const struct ieee80211_scan_entry *se)
768170530Ssam{
769178354Ssam	const struct ieee80211_ie_htcap *htcap =
770178354Ssam	    (const struct ieee80211_ie_htcap *) se->se_ies.htcap_ie;
771219601Sbschmidt	int rmax, r, i, txstream;
772178354Ssam	uint16_t caps;
773219601Sbschmidt	uint8_t txparams;
774170530Ssam
775170530Ssam	rmax = 0;
776178354Ssam	if (htcap != NULL) {
777178354Ssam		/*
778178354Ssam		 * HT station; inspect supported MCS and then adjust
779219601Sbschmidt		 * rate by channel width.
780178354Ssam		 */
781219601Sbschmidt		txparams = htcap->hc_mcsset[12];
782219601Sbschmidt		if (txparams & 0x3) {
783219601Sbschmidt			/*
784219601Sbschmidt			 * TX MCS parameters defined and not equal to RX,
785219601Sbschmidt			 * extract the number of spartial streams and
786219601Sbschmidt			 * map it to the highest MCS rate.
787219601Sbschmidt			 */
788219601Sbschmidt			txstream = ((txparams & 0xc) >> 2) + 1;
789219601Sbschmidt			i = txstream * 8 - 1;
790219601Sbschmidt		} else
791219601Sbschmidt			for (i = 31; i >= 0 && isclr(htcap->hc_mcsset, i); i--);
792178354Ssam		if (i >= 0) {
793178354Ssam			caps = LE_READ_2(&htcap->hc_cap);
794219601Sbschmidt			if ((caps & IEEE80211_HTCAP_CHWIDTH40) &&
795219601Sbschmidt			    (caps & IEEE80211_HTCAP_SHORTGI40))
796178354Ssam				rmax = ieee80211_htrates[i].ht40_rate_400ns;
797219601Sbschmidt			else if (caps & IEEE80211_HTCAP_CHWIDTH40)
798219601Sbschmidt				rmax = ieee80211_htrates[i].ht40_rate_800ns;
799219601Sbschmidt			else if (caps & IEEE80211_HTCAP_SHORTGI20)
800219601Sbschmidt				rmax = ieee80211_htrates[i].ht20_rate_400ns;
801178354Ssam			else
802219601Sbschmidt				rmax = ieee80211_htrates[i].ht20_rate_800ns;
803178354Ssam		}
804178354Ssam	}
805170530Ssam	for (i = 0; i < se->se_rates[1]; i++) {
806170530Ssam		r = se->se_rates[2+i] & IEEE80211_RATE_VAL;
807170530Ssam		if (r > rmax)
808170530Ssam			rmax = r;
809170530Ssam	}
810170530Ssam	for (i = 0; i < se->se_xrates[1]; i++) {
811170530Ssam		r = se->se_xrates[2+i] & IEEE80211_RATE_VAL;
812170530Ssam		if (r > rmax)
813170530Ssam			rmax = r;
814170530Ssam	}
815170530Ssam	return rmax;
816170530Ssam}
817170530Ssam
818170530Ssam/*
819170530Ssam * Compare the capabilities of two entries and decide which is
820170530Ssam * more desirable (return >0 if a is considered better).  Note
821170530Ssam * that we assume compatibility/usability has already been checked
822170530Ssam * so we don't need to (e.g. validate whether privacy is supported).
823170530Ssam * Used to select the best scan candidate for association in a BSS.
824170530Ssam */
825170530Ssamstatic int
826170530Ssamsta_compare(const struct sta_entry *a, const struct sta_entry *b)
827170530Ssam{
828170530Ssam#define	PREFER(_a,_b,_what) do {			\
829170530Ssam	if (((_a) ^ (_b)) & (_what))			\
830170530Ssam		return ((_a) & (_what)) ? 1 : -1;	\
831170530Ssam} while (0)
832178354Ssam	int maxa, maxb;
833170530Ssam	int8_t rssia, rssib;
834170530Ssam	int weight;
835170530Ssam
836170530Ssam	/* privacy support */
837170530Ssam	PREFER(a->base.se_capinfo, b->base.se_capinfo,
838170530Ssam		IEEE80211_CAPINFO_PRIVACY);
839170530Ssam
840170530Ssam	/* compare count of previous failures */
841170530Ssam	weight = b->se_fails - a->se_fails;
842170530Ssam	if (abs(weight) > 1)
843170530Ssam		return weight;
844170530Ssam
845170530Ssam	/*
846170530Ssam	 * Compare rssi.  If the two are considered equivalent
847170530Ssam	 * then fallback to other criteria.  We threshold the
848170530Ssam	 * comparisons to avoid selecting an ap purely by rssi
849170530Ssam	 * when both values may be good but one ap is otherwise
850170530Ssam	 * more desirable (e.g. an 11b-only ap with stronger
851170530Ssam	 * signal than an 11g ap).
852170530Ssam	 */
853170530Ssam	rssia = MIN(a->base.se_rssi, STA_RSSI_MAX);
854170530Ssam	rssib = MIN(b->base.se_rssi, STA_RSSI_MAX);
855170530Ssam	if (abs(rssib - rssia) < 5) {
856170530Ssam		/* best/max rate preferred if signal level close enough XXX */
857170530Ssam		maxa = maxrate(&a->base);
858170530Ssam		maxb = maxrate(&b->base);
859170530Ssam		if (maxa != maxb)
860170530Ssam			return maxa - maxb;
861170530Ssam		/* XXX use freq for channel preference */
862170530Ssam		/* for now just prefer 5Ghz band to all other bands */
863178354Ssam		PREFER(IEEE80211_IS_CHAN_5GHZ(a->base.se_chan),
864178354Ssam		       IEEE80211_IS_CHAN_5GHZ(b->base.se_chan), 1);
865170530Ssam	}
866170530Ssam	/* all things being equal, use signal level */
867170530Ssam	return a->base.se_rssi - b->base.se_rssi;
868170530Ssam#undef PREFER
869170530Ssam}
870170530Ssam
871170530Ssam/*
872170530Ssam * Check rate set suitability and return the best supported rate.
873178354Ssam * XXX inspect MCS for HT
874170530Ssam */
875170530Ssamstatic int
876184302Ssamcheck_rate(struct ieee80211vap *vap, const struct ieee80211_channel *chan,
877184302Ssam    const struct ieee80211_scan_entry *se)
878170530Ssam{
879170530Ssam#define	RV(v)	((v) & IEEE80211_RATE_VAL)
880170530Ssam	const struct ieee80211_rateset *srs;
881178354Ssam	int i, j, nrs, r, okrate, badrate, fixedrate, ucastrate;
882170530Ssam	const uint8_t *rs;
883170530Ssam
884178354Ssam	okrate = badrate = 0;
885170530Ssam
886184302Ssam	srs = ieee80211_get_suprates(vap->iv_ic, chan);
887170530Ssam	nrs = se->se_rates[1];
888170530Ssam	rs = se->se_rates+2;
889178354Ssam	/* XXX MCS */
890184302Ssam	ucastrate = vap->iv_txparms[ieee80211_chan2mode(chan)].ucastrate;
891170530Ssam	fixedrate = IEEE80211_FIXED_RATE_NONE;
892170530Ssamagain:
893170530Ssam	for (i = 0; i < nrs; i++) {
894170530Ssam		r = RV(rs[i]);
895170530Ssam		badrate = r;
896170530Ssam		/*
897170530Ssam		 * Check any fixed rate is included.
898170530Ssam		 */
899178354Ssam		if (r == ucastrate)
900170530Ssam			fixedrate = r;
901170530Ssam		/*
902170530Ssam		 * Check against our supported rates.
903170530Ssam		 */
904170530Ssam		for (j = 0; j < srs->rs_nrates; j++)
905170530Ssam			if (r == RV(srs->rs_rates[j])) {
906170530Ssam				if (r > okrate)		/* NB: track max */
907170530Ssam					okrate = r;
908170530Ssam				break;
909170530Ssam			}
910170530Ssam
911170530Ssam		if (j == srs->rs_nrates && (rs[i] & IEEE80211_RATE_BASIC)) {
912170530Ssam			/*
913170530Ssam			 * Don't try joining a BSS, if we don't support
914170530Ssam			 * one of its basic rates.
915170530Ssam			 */
916170530Ssam			okrate = 0;
917170530Ssam			goto back;
918170530Ssam		}
919170530Ssam	}
920170530Ssam	if (rs == se->se_rates+2) {
921170530Ssam		/* scan xrates too; sort of an algol68-style for loop */
922170530Ssam		nrs = se->se_xrates[1];
923170530Ssam		rs = se->se_xrates+2;
924170530Ssam		goto again;
925170530Ssam	}
926170530Ssam
927170530Ssamback:
928178354Ssam	if (okrate == 0 || ucastrate != fixedrate)
929170530Ssam		return badrate | IEEE80211_RATE_BASIC;
930170530Ssam	else
931170530Ssam		return RV(okrate);
932170530Ssam#undef RV
933170530Ssam}
934170530Ssam
935195618Srpaulostatic __inline int
936195618Srpaulomatch_id(const uint8_t *ie, const uint8_t *val, int len)
937195618Srpaulo{
938195618Srpaulo	return (ie[1] == len && memcmp(ie+2, val, len) == 0);
939195618Srpaulo}
940195618Srpaulo
941170530Ssamstatic int
942170530Ssammatch_ssid(const uint8_t *ie,
943170530Ssam	int nssid, const struct ieee80211_scan_ssid ssids[])
944170530Ssam{
945170530Ssam	int i;
946170530Ssam
947170530Ssam	for (i = 0; i < nssid; i++) {
948195618Srpaulo		if (match_id(ie, ssids[i].ssid, ssids[i].len))
949170530Ssam			return 1;
950170530Ssam	}
951170530Ssam	return 0;
952170530Ssam}
953170530Ssam
954186904Ssam#ifdef IEEE80211_SUPPORT_TDMA
955186904Ssamstatic int
956186904Ssamtdma_isfull(const struct ieee80211_tdma_param *tdma)
957186904Ssam{
958186904Ssam	int slot, slotcnt;
959186904Ssam
960186904Ssam	slotcnt = tdma->tdma_slotcnt;
961186904Ssam	for (slot = slotcnt-1; slot >= 0; slot--)
962186904Ssam		if (isclr(tdma->tdma_inuse, slot))
963186904Ssam			return 0;
964186904Ssam	return 1;
965186904Ssam}
966186904Ssam#endif /* IEEE80211_SUPPORT_TDMA */
967186904Ssam
968170530Ssam/*
969170530Ssam * Test a scan candidate for suitability/compatibility.
970170530Ssam */
971170530Ssamstatic int
972178354Ssammatch_bss(struct ieee80211vap *vap,
973170530Ssam	const struct ieee80211_scan_state *ss, struct sta_entry *se0,
974170530Ssam	int debug)
975170530Ssam{
976178354Ssam	struct ieee80211com *ic = vap->iv_ic;
977170530Ssam	struct ieee80211_scan_entry *se = &se0->base;
978178354Ssam        uint8_t rate;
979178354Ssam        int fail;
980170530Ssam
981170530Ssam	fail = 0;
982170530Ssam	if (isclr(ic->ic_chan_active, ieee80211_chan2ieee(ic, se->se_chan)))
983171409Ssam		fail |= MATCH_CHANNEL;
984170530Ssam	/*
985170530Ssam	 * NB: normally the desired mode is used to construct
986170530Ssam	 * the channel list, but it's possible for the scan
987170530Ssam	 * cache to include entries for stations outside this
988170530Ssam	 * list so we check the desired mode here to weed them
989170530Ssam	 * out.
990170530Ssam	 */
991178354Ssam	if (vap->iv_des_mode != IEEE80211_MODE_AUTO &&
992170530Ssam	    (se->se_chan->ic_flags & IEEE80211_CHAN_ALLTURBO) !=
993178354Ssam	    chanflags[vap->iv_des_mode])
994171409Ssam		fail |= MATCH_CHANNEL;
995178354Ssam	if (vap->iv_opmode == IEEE80211_M_IBSS) {
996170530Ssam		if ((se->se_capinfo & IEEE80211_CAPINFO_IBSS) == 0)
997171409Ssam			fail |= MATCH_CAPINFO;
998186904Ssam#ifdef IEEE80211_SUPPORT_TDMA
999186904Ssam	} else if (vap->iv_opmode == IEEE80211_M_AHDEMO) {
1000186904Ssam		/*
1001186904Ssam		 * Adhoc demo network setup shouldn't really be scanning
1002186904Ssam		 * but just in case skip stations operating in IBSS or
1003186904Ssam		 * BSS mode.
1004186904Ssam		 */
1005186904Ssam		if (se->se_capinfo & (IEEE80211_CAPINFO_IBSS|IEEE80211_CAPINFO_ESS))
1006186904Ssam			fail |= MATCH_CAPINFO;
1007186904Ssam		/*
1008186904Ssam		 * TDMA operation cannot coexist with a normal 802.11 network;
1009186904Ssam		 * skip if IBSS or ESS capabilities are marked and require
1010186904Ssam		 * the beacon have a TDMA ie present.
1011186904Ssam		 */
1012186904Ssam		if (vap->iv_caps & IEEE80211_C_TDMA) {
1013186904Ssam			const struct ieee80211_tdma_param *tdma =
1014186904Ssam			    (const struct ieee80211_tdma_param *)se->se_ies.tdma_ie;
1015189980Ssam			const struct ieee80211_tdma_state *ts = vap->iv_tdma;
1016186904Ssam
1017186904Ssam			if (tdma == NULL)
1018186904Ssam				fail |= MATCH_TDMA_NOIE;
1019189980Ssam			else if (tdma->tdma_version != ts->tdma_version)
1020189980Ssam				fail |= MATCH_TDMA_VERSION;
1021186904Ssam			else if (tdma->tdma_slot != 0)
1022186904Ssam				fail |= MATCH_TDMA_NOTMASTER;
1023186904Ssam			else if (tdma_isfull(tdma))
1024186904Ssam				fail |= MATCH_TDMA_NOSLOT;
1025186904Ssam#if 0
1026186904Ssam			else if (ieee80211_local_address(se->se_macaddr))
1027186904Ssam				fail |= MATCH_TDMA_LOCAL;
1028186904Ssam#endif
1029186904Ssam		}
1030186904Ssam#endif /* IEEE80211_SUPPORT_TDMA */
1031195618Srpaulo#ifdef IEEE80211_SUPPORT_MESH
1032195618Srpaulo	} else if (vap->iv_opmode == IEEE80211_M_MBSS) {
1033195618Srpaulo		const struct ieee80211_mesh_state *ms = vap->iv_mesh;
1034195618Srpaulo		/*
1035195618Srpaulo		 * Mesh nodes have IBSS & ESS bits in capinfo turned off
1036195618Srpaulo		 * and two special ie's that must be present.
1037195618Srpaulo		 */
1038195618Srpaulo		if (se->se_capinfo & (IEEE80211_CAPINFO_IBSS|IEEE80211_CAPINFO_ESS))
1039195618Srpaulo			fail |= MATCH_CAPINFO;
1040215699Sbschmidt		else if (se->se_meshid[0] != IEEE80211_ELEMID_MESHID)
1041195618Srpaulo			fail |= MATCH_MESH_NOID;
1042195618Srpaulo		else if (ms->ms_idlen != 0 &&
1043195618Srpaulo		    match_id(se->se_meshid, ms->ms_id, ms->ms_idlen))
1044195618Srpaulo			fail |= MATCH_MESHID;
1045196005Ssam#endif
1046170530Ssam	} else {
1047170530Ssam		if ((se->se_capinfo & IEEE80211_CAPINFO_ESS) == 0)
1048171409Ssam			fail |= MATCH_CAPINFO;
1049178354Ssam		/*
1050178354Ssam		 * If 11d is enabled and we're attempting to join a bss
1051178354Ssam		 * that advertises it's country code then compare our
1052178354Ssam		 * current settings to what we fetched from the country ie.
1053178354Ssam		 * If our country code is unspecified or different then do
1054178354Ssam		 * not attempt to join the bss.  We should have already
1055178354Ssam		 * dispatched an event to user space that identifies the
1056178354Ssam		 * new country code so our regdomain config should match.
1057178354Ssam		 */
1058178354Ssam		if ((IEEE80211_IS_CHAN_11D(se->se_chan) ||
1059178354Ssam		    (vap->iv_flags_ext & IEEE80211_FEXT_DOTD)) &&
1060178354Ssam		    se->se_cc[0] != 0 &&
1061178354Ssam		    (ic->ic_regdomain.country == CTRY_DEFAULT ||
1062178354Ssam		     !isocmp(se->se_cc, ic->ic_regdomain.isocc)))
1063178354Ssam			fail |= MATCH_CC;
1064170530Ssam	}
1065178354Ssam	if (vap->iv_flags & IEEE80211_F_PRIVACY) {
1066170530Ssam		if ((se->se_capinfo & IEEE80211_CAPINFO_PRIVACY) == 0)
1067171409Ssam			fail |= MATCH_PRIVACY;
1068170530Ssam	} else {
1069170530Ssam		/* XXX does this mean privacy is supported or required? */
1070170530Ssam		if (se->se_capinfo & IEEE80211_CAPINFO_PRIVACY)
1071171409Ssam			fail |= MATCH_PRIVACY;
1072170530Ssam	}
1073184302Ssam	se0->se_flags &= ~STA_DEMOTE11B;
1074184302Ssam	rate = check_rate(vap, se->se_chan, se);
1075184302Ssam	if (rate & IEEE80211_RATE_BASIC) {
1076171409Ssam		fail |= MATCH_RATE;
1077184302Ssam		/*
1078184302Ssam		 * An 11b-only ap will give a rate mismatch if there is an
1079184302Ssam		 * OFDM fixed tx rate for 11g.  Try downgrading the channel
1080184302Ssam		 * in the scan list to 11b and retry the rate check.
1081184302Ssam		 */
1082184302Ssam		if (IEEE80211_IS_CHAN_ANYG(se->se_chan)) {
1083184302Ssam			rate = check_rate(vap, demote11b(vap, se->se_chan), se);
1084184302Ssam			if ((rate & IEEE80211_RATE_BASIC) == 0) {
1085184302Ssam				fail &= ~MATCH_RATE;
1086184302Ssam				se0->se_flags |= STA_DEMOTE11B;
1087184302Ssam			}
1088184302Ssam		}
1089184302Ssam	} else if (rate < 2*24) {
1090184302Ssam		/*
1091184302Ssam		 * This is an 11b-only ap.  Check the desired mode in
1092184302Ssam		 * case that needs to be honored (mode 11g filters out
1093184302Ssam		 * 11b-only ap's).  Otherwise force any 11g channel used
1094184302Ssam		 * in scanning to be demoted.
1095184302Ssam		 *
1096184302Ssam		 * NB: we cheat a bit here by looking at the max rate;
1097184302Ssam		 *     we could/should check the rates.
1098184302Ssam		 */
1099184302Ssam		if (!(vap->iv_des_mode == IEEE80211_MODE_AUTO ||
1100184302Ssam		      vap->iv_des_mode == IEEE80211_MODE_11B))
1101184302Ssam			fail |= MATCH_RATE;
1102184302Ssam		else
1103184302Ssam			se0->se_flags |= STA_DEMOTE11B;
1104184302Ssam	}
1105170530Ssam	if (ss->ss_nssid != 0 &&
1106171409Ssam	    !match_ssid(se->se_ssid, ss->ss_nssid, ss->ss_ssid))
1107171409Ssam		fail |= MATCH_SSID;
1108178354Ssam	if ((vap->iv_flags & IEEE80211_F_DESBSSID) &&
1109178354Ssam	    !IEEE80211_ADDR_EQ(vap->iv_des_bssid, se->se_bssid))
1110178354Ssam		fail |= MATCH_BSSID;
1111170530Ssam	if (se0->se_fails >= STA_FAILS_MAX)
1112171409Ssam		fail |= MATCH_FAILS;
1113170530Ssam	if (se0->se_notseen >= STA_PURGE_SCANS)
1114171409Ssam		fail |= MATCH_NOTSEEN;
1115170530Ssam	if (se->se_rssi < STA_RSSI_MIN)
1116171409Ssam		fail |= MATCH_RSSI;
1117170530Ssam#ifdef IEEE80211_DEBUG
1118178354Ssam	if (ieee80211_msg(vap, debug)) {
1119170530Ssam		printf(" %c %s",
1120171409Ssam		    fail & MATCH_FAILS ? '=' :
1121171409Ssam		    fail & MATCH_NOTSEEN ? '^' :
1122178354Ssam		    fail & MATCH_CC ? '$' :
1123186904Ssam#ifdef IEEE80211_SUPPORT_TDMA
1124186904Ssam		    fail & MATCH_TDMA_NOIE ? '&' :
1125189980Ssam		    fail & MATCH_TDMA_VERSION ? 'v' :
1126189980Ssam		    fail & MATCH_TDMA_NOTMASTER ? 's' :
1127189980Ssam		    fail & MATCH_TDMA_NOSLOT ? 'f' :
1128189980Ssam		    fail & MATCH_TDMA_LOCAL ? 'l' :
1129186904Ssam#endif
1130195618Srpaulo		    fail & MATCH_MESH_NOID ? 'm' :
1131171409Ssam		    fail ? '-' : '+', ether_sprintf(se->se_macaddr));
1132170530Ssam		printf(" %s%c", ether_sprintf(se->se_bssid),
1133171409Ssam		    fail & MATCH_BSSID ? '!' : ' ');
1134170530Ssam		printf(" %3d%c", ieee80211_chan2ieee(ic, se->se_chan),
1135171409Ssam			fail & MATCH_CHANNEL ? '!' : ' ');
1136171409Ssam		printf(" %+4d%c", se->se_rssi, fail & MATCH_RSSI ? '!' : ' ');
1137170530Ssam		printf(" %2dM%c", (rate & IEEE80211_RATE_VAL) / 2,
1138171409Ssam		    fail & MATCH_RATE ? '!' : ' ');
1139170530Ssam		printf(" %4s%c",
1140170530Ssam		    (se->se_capinfo & IEEE80211_CAPINFO_ESS) ? "ess" :
1141189980Ssam		    (se->se_capinfo & IEEE80211_CAPINFO_IBSS) ? "ibss" : "",
1142171409Ssam		    fail & MATCH_CAPINFO ? '!' : ' ');
1143170530Ssam		printf(" %3s%c ",
1144170530Ssam		    (se->se_capinfo & IEEE80211_CAPINFO_PRIVACY) ?
1145170530Ssam		    "wep" : "no",
1146171409Ssam		    fail & MATCH_PRIVACY ? '!' : ' ');
1147170530Ssam		ieee80211_print_essid(se->se_ssid+2, se->se_ssid[1]);
1148195618Srpaulo		printf("%s\n", fail & (MATCH_SSID | MATCH_MESHID) ? "!" : "");
1149170530Ssam	}
1150170530Ssam#endif
1151170530Ssam	return fail;
1152170530Ssam}
1153170530Ssam
1154170530Ssamstatic void
1155170530Ssamsta_update_notseen(struct sta_table *st)
1156170530Ssam{
1157170530Ssam	struct sta_entry *se;
1158170530Ssam
1159206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1160170530Ssam	TAILQ_FOREACH(se, &st->st_entry, se_list) {
1161170530Ssam		/*
1162170530Ssam		 * If seen the reset and don't bump the count;
1163170530Ssam		 * otherwise bump the ``not seen'' count.  Note
1164170530Ssam		 * that this insures that stations for which we
1165170530Ssam		 * see frames while not scanning but not during
1166170530Ssam		 * this scan will not be penalized.
1167170530Ssam		 */
1168170530Ssam		if (se->se_seen)
1169170530Ssam			se->se_seen = 0;
1170170530Ssam		else
1171170530Ssam			se->se_notseen++;
1172170530Ssam	}
1173206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1174170530Ssam}
1175170530Ssam
1176170530Ssamstatic void
1177170530Ssamsta_dec_fails(struct sta_table *st)
1178170530Ssam{
1179170530Ssam	struct sta_entry *se;
1180170530Ssam
1181206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1182170530Ssam	TAILQ_FOREACH(se, &st->st_entry, se_list)
1183170530Ssam		if (se->se_fails)
1184170530Ssam			se->se_fails--;
1185206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1186170530Ssam}
1187170530Ssam
1188170530Ssamstatic struct sta_entry *
1189178354Ssamselect_bss(struct ieee80211_scan_state *ss, struct ieee80211vap *vap, int debug)
1190170530Ssam{
1191170530Ssam	struct sta_table *st = ss->ss_priv;
1192170530Ssam	struct sta_entry *se, *selbs = NULL;
1193170530Ssam
1194178354Ssam	IEEE80211_DPRINTF(vap, debug, " %s\n",
1195170530Ssam	    "macaddr          bssid         chan  rssi  rate flag  wep  essid");
1196206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1197170530Ssam	TAILQ_FOREACH(se, &st->st_entry, se_list) {
1198184275Ssam		ieee80211_ies_expand(&se->base.se_ies);
1199178354Ssam		if (match_bss(vap, ss, se, debug) == 0) {
1200170530Ssam			if (selbs == NULL)
1201170530Ssam				selbs = se;
1202170530Ssam			else if (sta_compare(se, selbs) > 0)
1203170530Ssam				selbs = se;
1204170530Ssam		}
1205170530Ssam	}
1206206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1207170530Ssam
1208170530Ssam	return selbs;
1209170530Ssam}
1210170530Ssam
1211170530Ssam/*
1212170530Ssam * Pick an ap or ibss network to join or find a channel
1213170530Ssam * to use to start an ibss network.
1214170530Ssam */
1215170530Ssamstatic int
1216178354Ssamsta_pick_bss(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1217170530Ssam{
1218170530Ssam	struct sta_table *st = ss->ss_priv;
1219170530Ssam	struct sta_entry *selbs;
1220184274Ssam	struct ieee80211_channel *chan;
1221170530Ssam
1222178354Ssam	KASSERT(vap->iv_opmode == IEEE80211_M_STA,
1223178354Ssam		("wrong mode %u", vap->iv_opmode));
1224170530Ssam
1225170530Ssam	if (st->st_newscan) {
1226170530Ssam		sta_update_notseen(st);
1227170530Ssam		st->st_newscan = 0;
1228170530Ssam	}
1229170530Ssam	if (ss->ss_flags & IEEE80211_SCAN_NOPICK) {
1230170530Ssam		/*
1231170530Ssam		 * Manual/background scan, don't select+join the
1232170530Ssam		 * bss, just return.  The scanning framework will
1233170530Ssam		 * handle notification that this has completed.
1234170530Ssam		 */
1235170530Ssam		ss->ss_flags &= ~IEEE80211_SCAN_NOPICK;
1236170530Ssam		return 1;
1237170530Ssam	}
1238170530Ssam	/*
1239170530Ssam	 * Automatic sequencing; look for a candidate and
1240170530Ssam	 * if found join the network.
1241170530Ssam	 */
1242170530Ssam	/* NB: unlocked read should be ok */
1243170530Ssam	if (TAILQ_FIRST(&st->st_entry) == NULL) {
1244178354Ssam		IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN,
1245170530Ssam			"%s: no scan candidate\n", __func__);
1246178354Ssam		if (ss->ss_flags & IEEE80211_SCAN_NOJOIN)
1247178354Ssam			return 0;
1248170530Ssamnotfound:
1249170530Ssam		/*
1250170530Ssam		 * If nothing suitable was found decrement
1251170530Ssam		 * the failure counts so entries will be
1252170530Ssam		 * reconsidered the next time around.  We
1253170530Ssam		 * really want to do this only for sta's
1254170530Ssam		 * where we've previously had some success.
1255170530Ssam		 */
1256170530Ssam		sta_dec_fails(st);
1257170530Ssam		st->st_newscan = 1;
1258170530Ssam		return 0;			/* restart scan */
1259170530Ssam	}
1260178354Ssam	selbs = select_bss(ss, vap, IEEE80211_MSG_SCAN);
1261178354Ssam	if (ss->ss_flags & IEEE80211_SCAN_NOJOIN)
1262178354Ssam		return (selbs != NULL);
1263184274Ssam	if (selbs == NULL)
1264170530Ssam		goto notfound;
1265184274Ssam	chan = selbs->base.se_chan;
1266184302Ssam	if (selbs->se_flags & STA_DEMOTE11B)
1267184302Ssam		chan = demote11b(vap, chan);
1268184274Ssam	if (!ieee80211_sta_join(vap, chan, &selbs->base))
1269184274Ssam		goto notfound;
1270170530Ssam	return 1;				/* terminate scan */
1271170530Ssam}
1272170530Ssam
1273170530Ssam/*
1274170530Ssam * Lookup an entry in the scan cache.  We assume we're
1275170530Ssam * called from the bottom half or such that we don't need
1276170530Ssam * to block the bottom half so that it's safe to return
1277170530Ssam * a reference to an entry w/o holding the lock on the table.
1278170530Ssam */
1279170530Ssamstatic struct sta_entry *
1280170530Ssamsta_lookup(struct sta_table *st, const uint8_t macaddr[IEEE80211_ADDR_LEN])
1281170530Ssam{
1282170530Ssam	struct sta_entry *se;
1283170530Ssam	int hash = STA_HASH(macaddr);
1284170530Ssam
1285206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1286170530Ssam	LIST_FOREACH(se, &st->st_hash[hash], se_hash)
1287170530Ssam		if (IEEE80211_ADDR_EQ(se->base.se_macaddr, macaddr))
1288170530Ssam			break;
1289206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1290170530Ssam
1291170530Ssam	return se;		/* NB: unlocked */
1292170530Ssam}
1293170530Ssam
1294170530Ssamstatic void
1295178354Ssamsta_roam_check(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1296170530Ssam{
1297178354Ssam	struct ieee80211com *ic = vap->iv_ic;
1298178354Ssam	struct ieee80211_node *ni = vap->iv_bss;
1299170530Ssam	struct sta_table *st = ss->ss_priv;
1300178354Ssam	enum ieee80211_phymode mode;
1301170530Ssam	struct sta_entry *se, *selbs;
1302178354Ssam	uint8_t roamRate, curRate, ucastRate;
1303170530Ssam	int8_t roamRssi, curRssi;
1304170530Ssam
1305170530Ssam	se = sta_lookup(st, ni->ni_macaddr);
1306170530Ssam	if (se == NULL) {
1307170530Ssam		/* XXX something is wrong */
1308170530Ssam		return;
1309170530Ssam	}
1310170530Ssam
1311178354Ssam	mode = ieee80211_chan2mode(ic->ic_bsschan);
1312178354Ssam	roamRate = vap->iv_roamparms[mode].rate;
1313178354Ssam	roamRssi = vap->iv_roamparms[mode].rssi;
1314178354Ssam	ucastRate = vap->iv_txparms[mode].ucastrate;
1315170530Ssam	/* NB: the most up to date rssi is in the node, not the scan cache */
1316170530Ssam	curRssi = ic->ic_node_getrssi(ni);
1317178354Ssam	if (ucastRate == IEEE80211_FIXED_RATE_NONE) {
1318178354Ssam		curRate = ni->ni_txrate;
1319178354Ssam		roamRate &= IEEE80211_RATE_VAL;
1320178354Ssam		IEEE80211_DPRINTF(vap, IEEE80211_MSG_ROAM,
1321170530Ssam		    "%s: currssi %d currate %u roamrssi %d roamrate %u\n",
1322170530Ssam		    __func__, curRssi, curRate, roamRssi, roamRate);
1323170530Ssam	} else {
1324170530Ssam		curRate = roamRate;	/* NB: insure compare below fails */
1325178354Ssam		IEEE80211_DPRINTF(vap, IEEE80211_MSG_ROAM,
1326170530Ssam		    "%s: currssi %d roamrssi %d\n", __func__, curRssi, roamRssi);
1327170530Ssam	}
1328170530Ssam	/*
1329170530Ssam	 * Check if a new ap should be used and switch.
1330170530Ssam	 * XXX deauth current ap
1331170530Ssam	 */
1332170530Ssam	if (curRate < roamRate || curRssi < roamRssi) {
1333178354Ssam		if (time_after(ticks, ic->ic_lastscan + vap->iv_scanvalid)) {
1334170530Ssam			/*
1335170530Ssam			 * Scan cache contents are too old; force a scan now
1336170530Ssam			 * if possible so we have current state to make a
1337170530Ssam			 * decision with.  We don't kick off a bg scan if
1338170530Ssam			 * we're using dynamic turbo and boosted or if the
1339170530Ssam			 * channel is busy.
1340170530Ssam			 * XXX force immediate switch on scan complete
1341170530Ssam			 */
1342170530Ssam			if (!IEEE80211_IS_CHAN_DTURBO(ic->ic_curchan) &&
1343178354Ssam			    time_after(ticks, ic->ic_lastdata + vap->iv_bgscanidle))
1344178354Ssam				ieee80211_bg_scan(vap, 0);
1345170530Ssam			return;
1346170530Ssam		}
1347170530Ssam		se->base.se_rssi = curRssi;
1348178354Ssam		selbs = select_bss(ss, vap, IEEE80211_MSG_ROAM);
1349170530Ssam		if (selbs != NULL && selbs != se) {
1350184274Ssam			struct ieee80211_channel *chan;
1351184274Ssam
1352178354Ssam			IEEE80211_DPRINTF(vap,
1353170530Ssam			    IEEE80211_MSG_ROAM | IEEE80211_MSG_DEBUG,
1354170530Ssam			    "%s: ROAM: curRate %u, roamRate %u, "
1355170530Ssam			    "curRssi %d, roamRssi %d\n", __func__,
1356170530Ssam			    curRate, roamRate, curRssi, roamRssi);
1357184274Ssam
1358184274Ssam			chan = selbs->base.se_chan;
1359184302Ssam			if (selbs->se_flags & STA_DEMOTE11B)
1360184302Ssam				chan = demote11b(vap, chan);
1361184274Ssam			(void) ieee80211_sta_join(vap, chan, &selbs->base);
1362170530Ssam		}
1363170530Ssam	}
1364170530Ssam}
1365170530Ssam
1366170530Ssam/*
1367170530Ssam * Age entries in the scan cache.
1368170530Ssam * XXX also do roaming since it's convenient
1369170530Ssam */
1370170530Ssamstatic void
1371170530Ssamsta_age(struct ieee80211_scan_state *ss)
1372170530Ssam{
1373178354Ssam	struct ieee80211vap *vap = ss->ss_vap;
1374170530Ssam
1375178354Ssam	adhoc_age(ss);
1376170530Ssam	/*
1377170530Ssam	 * If rate control is enabled check periodically to see if
1378170530Ssam	 * we should roam from our current connection to one that
1379170530Ssam	 * might be better.  This only applies when we're operating
1380170530Ssam	 * in sta mode and automatic roaming is set.
1381170530Ssam	 * XXX defer if busy
1382170530Ssam	 * XXX repeater station
1383170530Ssam	 * XXX do when !bgscan?
1384170530Ssam	 */
1385178354Ssam	KASSERT(vap->iv_opmode == IEEE80211_M_STA,
1386178354Ssam		("wrong mode %u", vap->iv_opmode));
1387178354Ssam	if (vap->iv_roaming == IEEE80211_ROAMING_AUTO &&
1388213321Sadrian	    (vap->iv_flags & IEEE80211_F_BGSCAN) &&
1389178354Ssam	    vap->iv_state >= IEEE80211_S_RUN)
1390170530Ssam		/* XXX vap is implicit */
1391178354Ssam		sta_roam_check(ss, vap);
1392170530Ssam}
1393170530Ssam
1394170530Ssam/*
1395170530Ssam * Iterate over the entries in the scan cache, invoking
1396170530Ssam * the callback function on each one.
1397170530Ssam */
1398170530Ssamstatic void
1399170530Ssamsta_iterate(struct ieee80211_scan_state *ss,
1400170530Ssam	ieee80211_scan_iter_func *f, void *arg)
1401170530Ssam{
1402170530Ssam	struct sta_table *st = ss->ss_priv;
1403170530Ssam	struct sta_entry *se;
1404170530Ssam	u_int gen;
1405170530Ssam
1406283556Sadrian	IEEE80211_SCAN_ITER_LOCK(st);
1407178354Ssam	gen = st->st_scaniter++;
1408170530Ssamrestart:
1409206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1410170530Ssam	TAILQ_FOREACH(se, &st->st_entry, se_list) {
1411170530Ssam		if (se->se_scangen != gen) {
1412170530Ssam			se->se_scangen = gen;
1413170530Ssam			/* update public state */
1414170530Ssam			se->base.se_age = ticks - se->se_lastupdate;
1415206617Srpaulo			IEEE80211_SCAN_TABLE_UNLOCK(st);
1416170530Ssam			(*f)(arg, &se->base);
1417170530Ssam			goto restart;
1418170530Ssam		}
1419170530Ssam	}
1420206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1421170530Ssam
1422283556Sadrian	IEEE80211_SCAN_ITER_UNLOCK(st);
1423170530Ssam}
1424170530Ssam
1425170530Ssamstatic void
1426170530Ssamsta_assoc_fail(struct ieee80211_scan_state *ss,
1427170530Ssam	const uint8_t macaddr[IEEE80211_ADDR_LEN], int reason)
1428170530Ssam{
1429170530Ssam	struct sta_table *st = ss->ss_priv;
1430170530Ssam	struct sta_entry *se;
1431170530Ssam
1432170530Ssam	se = sta_lookup(st, macaddr);
1433170530Ssam	if (se != NULL) {
1434170530Ssam		se->se_fails++;
1435170530Ssam		se->se_lastfail = ticks;
1436178354Ssam		IEEE80211_NOTE_MAC(ss->ss_vap, IEEE80211_MSG_SCAN,
1437170530Ssam		    macaddr, "%s: reason %u fails %u",
1438170530Ssam		    __func__, reason, se->se_fails);
1439170530Ssam	}
1440170530Ssam}
1441170530Ssam
1442170530Ssamstatic void
1443170530Ssamsta_assoc_success(struct ieee80211_scan_state *ss,
1444170530Ssam	const uint8_t macaddr[IEEE80211_ADDR_LEN])
1445170530Ssam{
1446170530Ssam	struct sta_table *st = ss->ss_priv;
1447170530Ssam	struct sta_entry *se;
1448170530Ssam
1449170530Ssam	se = sta_lookup(st, macaddr);
1450170530Ssam	if (se != NULL) {
1451170530Ssam#if 0
1452170530Ssam		se->se_fails = 0;
1453178354Ssam		IEEE80211_NOTE_MAC(ss->ss_vap, IEEE80211_MSG_SCAN,
1454170530Ssam		    macaddr, "%s: fails %u",
1455170530Ssam		    __func__, se->se_fails);
1456170530Ssam#endif
1457170530Ssam		se->se_lastassoc = ticks;
1458170530Ssam	}
1459170530Ssam}
1460170530Ssam
1461170530Ssamstatic const struct ieee80211_scanner sta_default = {
1462170530Ssam	.scan_name		= "default",
1463170530Ssam	.scan_attach		= sta_attach,
1464170530Ssam	.scan_detach		= sta_detach,
1465170530Ssam	.scan_start		= sta_start,
1466170530Ssam	.scan_restart		= sta_restart,
1467170530Ssam	.scan_cancel		= sta_cancel,
1468170530Ssam	.scan_end		= sta_pick_bss,
1469170530Ssam	.scan_flush		= sta_flush,
1470170530Ssam	.scan_add		= sta_add,
1471170530Ssam	.scan_age		= sta_age,
1472170530Ssam	.scan_iterate		= sta_iterate,
1473170530Ssam	.scan_assoc_fail	= sta_assoc_fail,
1474170530Ssam	.scan_assoc_success	= sta_assoc_success,
1475170530Ssam};
1476195618SrpauloIEEE80211_SCANNER_ALG(sta, IEEE80211_M_STA, sta_default);
1477170530Ssam
1478170530Ssam/*
1479170530Ssam * Adhoc mode-specific support.
1480170530Ssam */
1481170530Ssam
1482170530Ssamstatic const uint16_t adhocWorld[] =		/* 36, 40, 44, 48 */
1483170530Ssam{ 5180, 5200, 5220, 5240 };
1484170530Ssamstatic const uint16_t adhocFcc3[] =		/* 36, 40, 44, 48 145, 149, 153, 157, 161, 165 */
1485170530Ssam{ 5180, 5200, 5220, 5240, 5725, 5745, 5765, 5785, 5805, 5825 };
1486170530Ssamstatic const uint16_t adhocMkk[] =		/* 34, 38, 42, 46 */
1487170530Ssam{ 5170, 5190, 5210, 5230 };
1488170530Ssamstatic const uint16_t adhoc11b[] =		/* 10, 11 */
1489170530Ssam{ 2457, 2462 };
1490170530Ssam
1491170530Ssamstatic const struct scanlist adhocScanTable[] = {
1492170530Ssam	{ IEEE80211_MODE_11B,   	X(adhoc11b) },
1493170530Ssam	{ IEEE80211_MODE_11A,   	X(adhocWorld) },
1494170530Ssam	{ IEEE80211_MODE_11A,   	X(adhocFcc3) },
1495170530Ssam	{ IEEE80211_MODE_11B,   	X(adhocMkk) },
1496170530Ssam	{ .list = NULL }
1497170530Ssam};
1498170530Ssam#undef X
1499170530Ssam
1500170530Ssam/*
1501170530Ssam * Start an adhoc-mode scan by populating the channel list.
1502170530Ssam */
1503170530Ssamstatic int
1504178354Ssamadhoc_start(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1505170530Ssam{
1506170530Ssam	struct sta_table *st = ss->ss_priv;
1507170530Ssam
1508178354Ssam	makescanlist(ss, vap, adhocScanTable);
1509176653Ssam
1510178354Ssam	if (ss->ss_mindwell == 0)
1511178354Ssam		ss->ss_mindwell = msecs_to_ticks(200);	/* 200ms */
1512178354Ssam	if (ss->ss_maxdwell == 0)
1513178354Ssam		ss->ss_maxdwell = msecs_to_ticks(200);	/* 200ms */
1514176653Ssam
1515178354Ssam	st->st_scangen++;
1516170530Ssam	st->st_newscan = 1;
1517170530Ssam
1518170530Ssam	return 0;
1519170530Ssam}
1520170530Ssam
1521170530Ssam/*
1522170530Ssam * Select a channel to start an adhoc network on.
1523170530Ssam * The channel list was populated with appropriate
1524170530Ssam * channels so select one that looks least occupied.
1525170530Ssam */
1526170530Ssamstatic struct ieee80211_channel *
1527178354Ssamadhoc_pick_channel(struct ieee80211_scan_state *ss, int flags)
1528170530Ssam{
1529170530Ssam	struct sta_table *st = ss->ss_priv;
1530170530Ssam	struct sta_entry *se;
1531170530Ssam	struct ieee80211_channel *c, *bestchan;
1532170530Ssam	int i, bestrssi, maxrssi;
1533170530Ssam
1534170530Ssam	bestchan = NULL;
1535170530Ssam	bestrssi = -1;
1536170530Ssam
1537206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1538170530Ssam	for (i = 0; i < ss->ss_last; i++) {
1539170530Ssam		c = ss->ss_chans[i];
1540178354Ssam		/* never consider a channel with radar */
1541178354Ssam		if (IEEE80211_IS_CHAN_RADAR(c))
1542176653Ssam			continue;
1543178354Ssam		/* skip channels disallowed by regulatory settings */
1544178354Ssam		if (IEEE80211_IS_CHAN_NOADHOC(c))
1545178354Ssam			continue;
1546178354Ssam		/* check channel attributes for band compatibility */
1547178354Ssam		if (flags != 0 && (c->ic_flags & flags) != flags)
1548178354Ssam			continue;
1549170530Ssam		maxrssi = 0;
1550170530Ssam		TAILQ_FOREACH(se, &st->st_entry, se_list) {
1551170530Ssam			if (se->base.se_chan != c)
1552170530Ssam				continue;
1553170530Ssam			if (se->base.se_rssi > maxrssi)
1554170530Ssam				maxrssi = se->base.se_rssi;
1555170530Ssam		}
1556170530Ssam		if (bestchan == NULL || maxrssi < bestrssi)
1557170530Ssam			bestchan = c;
1558170530Ssam	}
1559206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1560170530Ssam
1561170530Ssam	return bestchan;
1562170530Ssam}
1563170530Ssam
1564170530Ssam/*
1565170530Ssam * Pick an ibss network to join or find a channel
1566170530Ssam * to use to start an ibss network.
1567170530Ssam */
1568170530Ssamstatic int
1569178354Ssamadhoc_pick_bss(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1570170530Ssam{
1571170530Ssam	struct sta_table *st = ss->ss_priv;
1572170530Ssam	struct sta_entry *selbs;
1573170530Ssam	struct ieee80211_channel *chan;
1574245928Sadrian	struct ieee80211com *ic = vap->iv_ic;
1575170530Ssam
1576178354Ssam	KASSERT(vap->iv_opmode == IEEE80211_M_IBSS ||
1577195618Srpaulo		vap->iv_opmode == IEEE80211_M_AHDEMO ||
1578195618Srpaulo		vap->iv_opmode == IEEE80211_M_MBSS,
1579178354Ssam		("wrong opmode %u", vap->iv_opmode));
1580170530Ssam
1581170530Ssam	if (st->st_newscan) {
1582170530Ssam		sta_update_notseen(st);
1583170530Ssam		st->st_newscan = 0;
1584170530Ssam	}
1585170530Ssam	if (ss->ss_flags & IEEE80211_SCAN_NOPICK) {
1586170530Ssam		/*
1587170530Ssam		 * Manual/background scan, don't select+join the
1588170530Ssam		 * bss, just return.  The scanning framework will
1589170530Ssam		 * handle notification that this has completed.
1590170530Ssam		 */
1591170530Ssam		ss->ss_flags &= ~IEEE80211_SCAN_NOPICK;
1592170530Ssam		return 1;
1593170530Ssam	}
1594170530Ssam	/*
1595170530Ssam	 * Automatic sequencing; look for a candidate and
1596170530Ssam	 * if found join the network.
1597170530Ssam	 */
1598170530Ssam	/* NB: unlocked read should be ok */
1599170530Ssam	if (TAILQ_FIRST(&st->st_entry) == NULL) {
1600178354Ssam		IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN,
1601170530Ssam			"%s: no scan candidate\n", __func__);
1602178354Ssam		if (ss->ss_flags & IEEE80211_SCAN_NOJOIN)
1603178354Ssam			return 0;
1604170530Ssamnotfound:
1605186904Ssam		/* NB: never auto-start a tdma network for slot !0 */
1606186904Ssam#ifdef IEEE80211_SUPPORT_TDMA
1607186904Ssam		if (vap->iv_des_nssid &&
1608186904Ssam		    ((vap->iv_caps & IEEE80211_C_TDMA) == 0 ||
1609186904Ssam		     ieee80211_tdma_getslot(vap) == 0)) {
1610186904Ssam#else
1611178354Ssam		if (vap->iv_des_nssid) {
1612186904Ssam#endif
1613170530Ssam			/*
1614170530Ssam			 * No existing adhoc network to join and we have
1615170530Ssam			 * an ssid; start one up.  If no channel was
1616170530Ssam			 * specified, try to select a channel.
1617170530Ssam			 */
1618178354Ssam			if (vap->iv_des_chan == IEEE80211_CHAN_ANYC ||
1619178354Ssam			    IEEE80211_IS_CHAN_RADAR(vap->iv_des_chan)) {
1620183421Ssam				chan = adhoc_pick_channel(ss, 0);
1621178354Ssam			} else
1622178354Ssam				chan = vap->iv_des_chan;
1623170530Ssam			if (chan != NULL) {
1624245928Sadrian				struct ieee80211com *ic = vap->iv_ic;
1625245928Sadrian				/*
1626245928Sadrian				 * Create a HT capable IBSS; the per-node
1627245928Sadrian				 * probe request/response will result in
1628245928Sadrian				 * "correct" rate control capabilities being
1629245928Sadrian				 * negotiated.
1630245928Sadrian				 */
1631245928Sadrian				chan = ieee80211_ht_adjust_channel(ic,
1632245928Sadrian				    chan, vap->iv_flags_ht);
1633178354Ssam				ieee80211_create_ibss(vap, chan);
1634170530Ssam				return 1;
1635170530Ssam			}
1636170530Ssam		}
1637170530Ssam		/*
1638170530Ssam		 * If nothing suitable was found decrement
1639170530Ssam		 * the failure counts so entries will be
1640170530Ssam		 * reconsidered the next time around.  We
1641170530Ssam		 * really want to do this only for sta's
1642170530Ssam		 * where we've previously had some success.
1643170530Ssam		 */
1644170530Ssam		sta_dec_fails(st);
1645170530Ssam		st->st_newscan = 1;
1646170530Ssam		return 0;			/* restart scan */
1647170530Ssam	}
1648178354Ssam	selbs = select_bss(ss, vap, IEEE80211_MSG_SCAN);
1649178354Ssam	if (ss->ss_flags & IEEE80211_SCAN_NOJOIN)
1650178354Ssam		return (selbs != NULL);
1651184274Ssam	if (selbs == NULL)
1652170530Ssam		goto notfound;
1653184274Ssam	chan = selbs->base.se_chan;
1654184302Ssam	if (selbs->se_flags & STA_DEMOTE11B)
1655184302Ssam		chan = demote11b(vap, chan);
1656245928Sadrian	/*
1657245928Sadrian	 * If HT is available, make it a possibility here.
1658245928Sadrian	 * The intent is to enable HT20/HT40 when joining a non-HT
1659245928Sadrian	 * IBSS node; we can then advertise HT IEs and speak HT
1660245928Sadrian	 * to any subsequent nodes that support it.
1661245928Sadrian	 */
1662245928Sadrian	chan = ieee80211_ht_adjust_channel(ic,
1663245928Sadrian	    chan, vap->iv_flags_ht);
1664184274Ssam	if (!ieee80211_sta_join(vap, chan, &selbs->base))
1665184274Ssam		goto notfound;
1666170530Ssam	return 1;				/* terminate scan */
1667170530Ssam}
1668170530Ssam
1669170530Ssam/*
1670170530Ssam * Age entries in the scan cache.
1671170530Ssam */
1672170530Ssamstatic void
1673170530Ssamadhoc_age(struct ieee80211_scan_state *ss)
1674170530Ssam{
1675170530Ssam	struct sta_table *st = ss->ss_priv;
1676170530Ssam	struct sta_entry *se, *next;
1677170530Ssam
1678206617Srpaulo	IEEE80211_SCAN_TABLE_LOCK(st);
1679170530Ssam	TAILQ_FOREACH_SAFE(se, &st->st_entry, se_list, next) {
1680170530Ssam		if (se->se_notseen > STA_PURGE_SCANS) {
1681170530Ssam			TAILQ_REMOVE(&st->st_entry, se, se_list);
1682170530Ssam			LIST_REMOVE(se, se_hash);
1683178354Ssam			ieee80211_ies_cleanup(&se->base.se_ies);
1684283538Sadrian			IEEE80211_FREE(se, M_80211_SCAN);
1685170530Ssam		}
1686170530Ssam	}
1687206617Srpaulo	IEEE80211_SCAN_TABLE_UNLOCK(st);
1688170530Ssam}
1689170530Ssam
1690170530Ssamstatic const struct ieee80211_scanner adhoc_default = {
1691170530Ssam	.scan_name		= "default",
1692170530Ssam	.scan_attach		= sta_attach,
1693170530Ssam	.scan_detach		= sta_detach,
1694170530Ssam	.scan_start		= adhoc_start,
1695170530Ssam	.scan_restart		= sta_restart,
1696170530Ssam	.scan_cancel		= sta_cancel,
1697170530Ssam	.scan_end		= adhoc_pick_bss,
1698170530Ssam	.scan_flush		= sta_flush,
1699178354Ssam	.scan_pickchan		= adhoc_pick_channel,
1700170530Ssam	.scan_add		= sta_add,
1701170530Ssam	.scan_age		= adhoc_age,
1702170530Ssam	.scan_iterate		= sta_iterate,
1703170530Ssam	.scan_assoc_fail	= sta_assoc_fail,
1704170530Ssam	.scan_assoc_success	= sta_assoc_success,
1705170530Ssam};
1706195618SrpauloIEEE80211_SCANNER_ALG(ibss, IEEE80211_M_IBSS, adhoc_default);
1707195618SrpauloIEEE80211_SCANNER_ALG(ahdemo, IEEE80211_M_AHDEMO, adhoc_default);
1708170530Ssam
1709178354Ssamstatic void
1710178354Ssamap_force_promisc(struct ieee80211com *ic)
1711178354Ssam{
1712178354Ssam	struct ifnet *ifp = ic->ic_ifp;
1713178354Ssam
1714178354Ssam	IEEE80211_LOCK(ic);
1715178354Ssam	/* set interface into promiscuous mode */
1716178354Ssam	ifp->if_flags |= IFF_PROMISC;
1717191746Sthompsa	ieee80211_runtask(ic, &ic->ic_promisc_task);
1718178354Ssam	IEEE80211_UNLOCK(ic);
1719178354Ssam}
1720178354Ssam
1721178354Ssamstatic void
1722178354Ssamap_reset_promisc(struct ieee80211com *ic)
1723178354Ssam{
1724178354Ssam	IEEE80211_LOCK(ic);
1725178354Ssam	ieee80211_syncifflag_locked(ic, IFF_PROMISC);
1726178354Ssam	IEEE80211_UNLOCK(ic);
1727178354Ssam}
1728178354Ssam
1729178354Ssamstatic int
1730178354Ssamap_start(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1731178354Ssam{
1732178354Ssam	struct sta_table *st = ss->ss_priv;
1733178354Ssam
1734178354Ssam	makescanlist(ss, vap, staScanTable);
1735178354Ssam
1736178354Ssam	if (ss->ss_mindwell == 0)
1737178354Ssam		ss->ss_mindwell = msecs_to_ticks(200);	/* 200ms */
1738178354Ssam	if (ss->ss_maxdwell == 0)
1739178354Ssam		ss->ss_maxdwell = msecs_to_ticks(200);	/* 200ms */
1740178354Ssam
1741178354Ssam	st->st_scangen++;
1742178354Ssam	st->st_newscan = 1;
1743178354Ssam
1744178354Ssam	ap_force_promisc(vap->iv_ic);
1745178354Ssam	return 0;
1746178354Ssam}
1747178354Ssam
1748170530Ssam/*
1749178354Ssam * Cancel an ongoing scan.
1750170530Ssam */
1751170530Ssamstatic int
1752178354Ssamap_cancel(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1753170530Ssam{
1754178354Ssam	ap_reset_promisc(vap->iv_ic);
1755178354Ssam	return 0;
1756178354Ssam}
1757178354Ssam
1758178354Ssam/*
1759178354Ssam * Pick a quiet channel to use for ap operation.
1760178354Ssam */
1761178354Ssamstatic struct ieee80211_channel *
1762178354Ssamap_pick_channel(struct ieee80211_scan_state *ss, int flags)
1763178354Ssam{
1764178354Ssam	struct sta_table *st = ss->ss_priv;
1765178354Ssam	struct ieee80211_channel *bestchan = NULL;
1766178354Ssam	int i;
1767178354Ssam
1768178354Ssam	/* XXX select channel more intelligently, e.g. channel spread, power */
1769178354Ssam	/* NB: use scan list order to preserve channel preference */
1770178354Ssam	for (i = 0; i < ss->ss_last; i++) {
1771178354Ssam		struct ieee80211_channel *chan = ss->ss_chans[i];
1772178354Ssam		/*
1773178354Ssam		 * If the channel is unoccupied the max rssi
1774178354Ssam		 * should be zero; just take it.  Otherwise
1775178354Ssam		 * track the channel with the lowest rssi and
1776178354Ssam		 * use that when all channels appear occupied.
1777178354Ssam		 */
1778178354Ssam		if (IEEE80211_IS_CHAN_RADAR(chan))
1779178354Ssam			continue;
1780178354Ssam		if (IEEE80211_IS_CHAN_NOHOSTAP(chan))
1781178354Ssam			continue;
1782178354Ssam		/* check channel attributes for band compatibility */
1783178354Ssam		if (flags != 0 && (chan->ic_flags & flags) != flags)
1784178354Ssam			continue;
1785186107Ssam		KASSERT(sizeof(chan->ic_ieee) == 1, ("ic_chan size"));
1786178354Ssam		/* XXX channel have interference */
1787178354Ssam		if (st->st_maxrssi[chan->ic_ieee] == 0) {
1788178354Ssam			/* XXX use other considerations */
1789178354Ssam			return chan;
1790170530Ssam		}
1791178354Ssam		if (bestchan == NULL ||
1792178354Ssam		    st->st_maxrssi[chan->ic_ieee] < st->st_maxrssi[bestchan->ic_ieee])
1793178354Ssam			bestchan = chan;
1794178354Ssam	}
1795178354Ssam	return bestchan;
1796178354Ssam}
1797178354Ssam
1798178354Ssam/*
1799178354Ssam * Pick a quiet channel to use for ap operation.
1800178354Ssam */
1801178354Ssamstatic int
1802178354Ssamap_end(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1803178354Ssam{
1804178354Ssam	struct ieee80211com *ic = vap->iv_ic;
1805178354Ssam	struct ieee80211_channel *bestchan;
1806178354Ssam
1807178354Ssam	KASSERT(vap->iv_opmode == IEEE80211_M_HOSTAP,
1808178354Ssam		("wrong opmode %u", vap->iv_opmode));
1809178354Ssam	bestchan = ap_pick_channel(ss, 0);
1810178354Ssam	if (bestchan == NULL) {
1811178354Ssam		/* no suitable channel, should not happen */
1812178354Ssam		IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN,
1813178354Ssam		    "%s: no suitable channel! (should not happen)\n", __func__);
1814178354Ssam		/* XXX print something? */
1815178354Ssam		return 0;			/* restart scan */
1816178354Ssam	}
1817178354Ssam	/*
1818178354Ssam	 * If this is a dynamic turbo channel, start with the unboosted one.
1819178354Ssam	 */
1820178354Ssam	if (IEEE80211_IS_CHAN_TURBO(bestchan)) {
1821178354Ssam		bestchan = ieee80211_find_channel(ic, bestchan->ic_freq,
1822178354Ssam			bestchan->ic_flags & ~IEEE80211_CHAN_TURBO);
1823178354Ssam		if (bestchan == NULL) {
1824178354Ssam			/* should never happen ?? */
1825178354Ssam			return 0;
1826170530Ssam		}
1827170530Ssam	}
1828178354Ssam	ap_reset_promisc(ic);
1829178354Ssam	if (ss->ss_flags & (IEEE80211_SCAN_NOPICK | IEEE80211_SCAN_NOJOIN)) {
1830178354Ssam		/*
1831178354Ssam		 * Manual/background scan, don't select+join the
1832178354Ssam		 * bss, just return.  The scanning framework will
1833178354Ssam		 * handle notification that this has completed.
1834178354Ssam		 */
1835178354Ssam		ss->ss_flags &= ~IEEE80211_SCAN_NOPICK;
1836178354Ssam		return 1;
1837178354Ssam	}
1838178354Ssam	ieee80211_create_ibss(vap,
1839193655Ssam	    ieee80211_ht_adjust_channel(ic, bestchan, vap->iv_flags_ht));
1840178354Ssam	return 1;
1841170530Ssam}
1842170530Ssam
1843178354Ssamstatic const struct ieee80211_scanner ap_default = {
1844178354Ssam	.scan_name		= "default",
1845178354Ssam	.scan_attach		= sta_attach,
1846178354Ssam	.scan_detach		= sta_detach,
1847178354Ssam	.scan_start		= ap_start,
1848178354Ssam	.scan_restart		= sta_restart,
1849178354Ssam	.scan_cancel		= ap_cancel,
1850178354Ssam	.scan_end		= ap_end,
1851178354Ssam	.scan_flush		= sta_flush,
1852178354Ssam	.scan_pickchan		= ap_pick_channel,
1853178354Ssam	.scan_add		= sta_add,
1854178354Ssam	.scan_age		= adhoc_age,
1855178354Ssam	.scan_iterate		= sta_iterate,
1856178354Ssam	.scan_assoc_success	= sta_assoc_success,
1857178354Ssam	.scan_assoc_fail	= sta_assoc_fail,
1858170530Ssam};
1859195618SrpauloIEEE80211_SCANNER_ALG(ap, IEEE80211_M_HOSTAP, ap_default);
1860178354Ssam
1861195618Srpaulo#ifdef IEEE80211_SUPPORT_MESH
1862178354Ssam/*
1863195618Srpaulo * Pick an mbss network to join or find a channel
1864195618Srpaulo * to use to start an mbss network.
1865178354Ssam */
1866195618Srpaulostatic int
1867195618Srpaulomesh_pick_bss(struct ieee80211_scan_state *ss, struct ieee80211vap *vap)
1868195618Srpaulo{
1869195618Srpaulo	struct sta_table *st = ss->ss_priv;
1870195618Srpaulo	struct ieee80211_mesh_state *ms = vap->iv_mesh;
1871195618Srpaulo	struct sta_entry *selbs;
1872195618Srpaulo	struct ieee80211_channel *chan;
1873195618Srpaulo
1874195618Srpaulo	KASSERT(vap->iv_opmode == IEEE80211_M_MBSS,
1875195618Srpaulo		("wrong opmode %u", vap->iv_opmode));
1876195618Srpaulo
1877195618Srpaulo	if (st->st_newscan) {
1878195618Srpaulo		sta_update_notseen(st);
1879195618Srpaulo		st->st_newscan = 0;
1880195618Srpaulo	}
1881195618Srpaulo	if (ss->ss_flags & IEEE80211_SCAN_NOPICK) {
1882195618Srpaulo		/*
1883195618Srpaulo		 * Manual/background scan, don't select+join the
1884195618Srpaulo		 * bss, just return.  The scanning framework will
1885195618Srpaulo		 * handle notification that this has completed.
1886195618Srpaulo		 */
1887195618Srpaulo		ss->ss_flags &= ~IEEE80211_SCAN_NOPICK;
1888195618Srpaulo		return 1;
1889195618Srpaulo	}
1890195618Srpaulo	/*
1891195618Srpaulo	 * Automatic sequencing; look for a candidate and
1892195618Srpaulo	 * if found join the network.
1893195618Srpaulo	 */
1894195618Srpaulo	/* NB: unlocked read should be ok */
1895195618Srpaulo	if (TAILQ_FIRST(&st->st_entry) == NULL) {
1896195618Srpaulo		IEEE80211_DPRINTF(vap, IEEE80211_MSG_SCAN,
1897195618Srpaulo			"%s: no scan candidate\n", __func__);
1898195618Srpaulo		if (ss->ss_flags & IEEE80211_SCAN_NOJOIN)
1899195618Srpaulo			return 0;
1900195618Srpaulonotfound:
1901195618Srpaulo		if (ms->ms_idlen != 0) {
1902195618Srpaulo			/*
1903195618Srpaulo			 * No existing mbss network to join and we have
1904195618Srpaulo			 * a meshid; start one up.  If no channel was
1905195618Srpaulo			 * specified, try to select a channel.
1906195618Srpaulo			 */
1907195618Srpaulo			if (vap->iv_des_chan == IEEE80211_CHAN_ANYC ||
1908195618Srpaulo			    IEEE80211_IS_CHAN_RADAR(vap->iv_des_chan)) {
1909195618Srpaulo				struct ieee80211com *ic = vap->iv_ic;
1910195618Srpaulo
1911195618Srpaulo				chan = adhoc_pick_channel(ss, 0);
1912195618Srpaulo				if (chan != NULL)
1913195618Srpaulo					chan = ieee80211_ht_adjust_channel(ic,
1914195618Srpaulo					    chan, vap->iv_flags_ht);
1915195618Srpaulo			} else
1916195618Srpaulo				chan = vap->iv_des_chan;
1917195618Srpaulo			if (chan != NULL) {
1918195618Srpaulo				ieee80211_create_ibss(vap, chan);
1919195618Srpaulo				return 1;
1920195618Srpaulo			}
1921195618Srpaulo		}
1922195618Srpaulo		/*
1923195618Srpaulo		 * If nothing suitable was found decrement
1924195618Srpaulo		 * the failure counts so entries will be
1925195618Srpaulo		 * reconsidered the next time around.  We
1926195618Srpaulo		 * really want to do this only for sta's
1927195618Srpaulo		 * where we've previously had some success.
1928195618Srpaulo		 */
1929195618Srpaulo		sta_dec_fails(st);
1930195618Srpaulo		st->st_newscan = 1;
1931195618Srpaulo		return 0;			/* restart scan */
1932195618Srpaulo	}
1933195618Srpaulo	selbs = select_bss(ss, vap, IEEE80211_MSG_SCAN);
1934195618Srpaulo	if (ss->ss_flags & IEEE80211_SCAN_NOJOIN)
1935195618Srpaulo		return (selbs != NULL);
1936195618Srpaulo	if (selbs == NULL)
1937195618Srpaulo		goto notfound;
1938195618Srpaulo	chan = selbs->base.se_chan;
1939195618Srpaulo	if (selbs->se_flags & STA_DEMOTE11B)
1940195618Srpaulo		chan = demote11b(vap, chan);
1941195618Srpaulo	if (!ieee80211_sta_join(vap, chan, &selbs->base))
1942195618Srpaulo		goto notfound;
1943195618Srpaulo	return 1;				/* terminate scan */
1944195618Srpaulo}
1945195618Srpaulo
1946195618Srpaulostatic const struct ieee80211_scanner mesh_default = {
1947195618Srpaulo	.scan_name		= "default",
1948195618Srpaulo	.scan_attach		= sta_attach,
1949195618Srpaulo	.scan_detach		= sta_detach,
1950195618Srpaulo	.scan_start		= adhoc_start,
1951195618Srpaulo	.scan_restart		= sta_restart,
1952195618Srpaulo	.scan_cancel		= sta_cancel,
1953195618Srpaulo	.scan_end		= mesh_pick_bss,
1954195618Srpaulo	.scan_flush		= sta_flush,
1955195618Srpaulo	.scan_pickchan		= adhoc_pick_channel,
1956195618Srpaulo	.scan_add		= sta_add,
1957195618Srpaulo	.scan_age		= adhoc_age,
1958195618Srpaulo	.scan_iterate		= sta_iterate,
1959195618Srpaulo	.scan_assoc_fail	= sta_assoc_fail,
1960195618Srpaulo	.scan_assoc_success	= sta_assoc_success,
1961195618Srpaulo};
1962195618SrpauloIEEE80211_SCANNER_ALG(mesh, IEEE80211_M_MBSS, mesh_default);
1963195618Srpaulo#endif /* IEEE80211_SUPPORT_MESH */
1964