2 * Copyright (c) 2005-2008 Sam Leffler, Errno Consulting
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 #include <sys/cdefs.h>
27 __FBSDID("$FreeBSD$");
30 * IEEE 802.11 regdomain support.
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 #include <sys/malloc.h>
39 #include <sys/socket.h>
42 #include <net/if_var.h>
43 #include <net/if_media.h>
44 #include <net/ethernet.h>
46 #include <net80211/ieee80211_var.h>
47 #include <net80211/ieee80211_regdomain.h>
50 null_getradiocaps(struct ieee80211com *ic, int maxchan,
51 int *n, struct ieee80211_channel *c)
53 /* just feed back the current channel list */
54 if (maxchan > ic->ic_nchans)
55 maxchan = ic->ic_nchans;
56 memcpy(c, ic->ic_channels, maxchan*sizeof(struct ieee80211_channel));
61 null_setregdomain(struct ieee80211com *ic,
62 struct ieee80211_regdomain *rd,
63 int nchans, struct ieee80211_channel chans[])
65 return 0; /* accept anything */
69 ieee80211_regdomain_attach(struct ieee80211com *ic)
71 if (ic->ic_regdomain.regdomain == 0 &&
72 ic->ic_regdomain.country == CTRY_DEFAULT) {
73 ic->ic_regdomain.country = CTRY_UNITED_STATES; /* XXX */
74 ic->ic_regdomain.location = ' '; /* both */
75 ic->ic_regdomain.isocc[0] = 'U'; /* XXX */
76 ic->ic_regdomain.isocc[1] = 'S'; /* XXX */
77 /* NB: driver calls ieee80211_init_channels or similar */
79 ic->ic_getradiocaps = null_getradiocaps;
80 ic->ic_setregdomain = null_setregdomain;
84 ieee80211_regdomain_detach(struct ieee80211com *ic)
86 if (ic->ic_countryie != NULL) {
87 free(ic->ic_countryie, M_80211_NODE_IE);
88 ic->ic_countryie = NULL;
93 ieee80211_regdomain_vattach(struct ieee80211vap *vap)
98 ieee80211_regdomain_vdetach(struct ieee80211vap *vap)
103 addchan(struct ieee80211com *ic, int ieee, int flags)
105 struct ieee80211_channel *c;
107 c = &ic->ic_channels[ic->ic_nchans++];
108 c->ic_freq = ieee80211_ieee2mhz(ieee, flags);
111 if (flags & IEEE80211_CHAN_HT40U)
112 c->ic_extieee = ieee + 4;
113 else if (flags & IEEE80211_CHAN_HT40D)
114 c->ic_extieee = ieee - 4;
120 * Setup the channel list for the specified regulatory domain,
121 * country code, and operating modes. This interface is used
122 * when a driver does not obtain the channel list from another
123 * source (such as firmware).
126 ieee80211_init_channels(struct ieee80211com *ic,
127 const struct ieee80211_regdomain *rd, const uint8_t bands[])
131 /* XXX just do something for now */
133 if (isset(bands, IEEE80211_MODE_11B) ||
134 isset(bands, IEEE80211_MODE_11G) ||
135 isset(bands, IEEE80211_MODE_11NG)) {
137 if (rd != NULL && rd->ecm)
139 for (i = 1; i <= maxchan; i++) {
140 if (isset(bands, IEEE80211_MODE_11B))
141 addchan(ic, i, IEEE80211_CHAN_B);
142 if (isset(bands, IEEE80211_MODE_11G))
143 addchan(ic, i, IEEE80211_CHAN_G);
144 if (isset(bands, IEEE80211_MODE_11NG)) {
146 IEEE80211_CHAN_G | IEEE80211_CHAN_HT20);
148 if ((ic->ic_htcaps & IEEE80211_HTCAP_CHWIDTH40) == 0)
152 IEEE80211_CHAN_G | IEEE80211_CHAN_HT40U);
154 IEEE80211_CHAN_G | IEEE80211_CHAN_HT40D);
158 if (isset(bands, IEEE80211_MODE_11A) ||
159 isset(bands, IEEE80211_MODE_11NA)) {
160 for (i = 36; i <= 64; i += 4) {
161 addchan(ic, i, IEEE80211_CHAN_A);
162 if (isset(bands, IEEE80211_MODE_11NA)) {
164 IEEE80211_CHAN_A | IEEE80211_CHAN_HT20);
166 if ((ic->ic_htcaps & IEEE80211_HTCAP_CHWIDTH40) == 0)
170 IEEE80211_CHAN_A | IEEE80211_CHAN_HT40U);
172 IEEE80211_CHAN_A | IEEE80211_CHAN_HT40D);
175 for (i = 100; i <= 140; i += 4) {
176 addchan(ic, i, IEEE80211_CHAN_A);
177 if (isset(bands, IEEE80211_MODE_11NA)) {
179 IEEE80211_CHAN_A | IEEE80211_CHAN_HT20);
181 if ((ic->ic_htcaps & IEEE80211_HTCAP_CHWIDTH40) == 0)
183 if ((i % 8) == 4 && i != 140) {
185 IEEE80211_CHAN_A | IEEE80211_CHAN_HT40U);
187 IEEE80211_CHAN_A | IEEE80211_CHAN_HT40D);
190 for (i = 149; i <= 161; i += 4) {
191 addchan(ic, i, IEEE80211_CHAN_A);
192 if (isset(bands, IEEE80211_MODE_11NA)) {
194 IEEE80211_CHAN_A | IEEE80211_CHAN_HT20);
196 if ((ic->ic_htcaps & IEEE80211_HTCAP_CHWIDTH40) == 0)
200 IEEE80211_CHAN_A | IEEE80211_CHAN_HT40U);
202 IEEE80211_CHAN_A | IEEE80211_CHAN_HT40D);
207 ic->ic_regdomain = *rd;
213 chancompar(const void *a, const void *b)
215 const struct ieee80211_channel *ca = a;
216 const struct ieee80211_channel *cb = b;
218 return (ca->ic_freq == cb->ic_freq) ?
219 (ca->ic_flags & IEEE80211_CHAN_ALL) -
220 (cb->ic_flags & IEEE80211_CHAN_ALL) :
221 ca->ic_freq - cb->ic_freq;
227 #define swap(_a, _b, _size) { \
239 sort_channels(void *a, size_t n, size_t size)
244 KASSERT(n > 0, ("no channels"));
245 for (ai = aa+size; --n >= 1; ai += size)
246 for (t = ai; t > aa; t -= size) {
247 uint8_t *u = t - size;
248 if (chancompar(u, t) <= 0)
256 * Order channels w/ the same frequency so that
257 * b < g < htg and a < hta. This is used to optimize
258 * channel table lookups and some user applications
259 * may also depend on it (though they should not).
262 ieee80211_sort_channels(struct ieee80211_channel chans[], int nchans)
265 sort_channels(chans, nchans, sizeof(struct ieee80211_channel));
269 * Allocate and construct a Country Information IE.
271 struct ieee80211_appie *
272 ieee80211_alloc_countryie(struct ieee80211com *ic)
274 #define CHAN_UNINTERESTING \
275 (IEEE80211_CHAN_TURBO | IEEE80211_CHAN_STURBO | \
276 IEEE80211_CHAN_HALF | IEEE80211_CHAN_QUARTER)
277 /* XXX what about auto? */
278 /* flag set of channels to be excluded (band added below) */
279 static const int skipflags[IEEE80211_MODE_MAX] = {
280 [IEEE80211_MODE_AUTO] = CHAN_UNINTERESTING,
281 [IEEE80211_MODE_11A] = CHAN_UNINTERESTING,
282 [IEEE80211_MODE_11B] = CHAN_UNINTERESTING,
283 [IEEE80211_MODE_11G] = CHAN_UNINTERESTING,
284 [IEEE80211_MODE_FH] = CHAN_UNINTERESTING
285 | IEEE80211_CHAN_OFDM
287 | IEEE80211_CHAN_DYN,
288 [IEEE80211_MODE_TURBO_A] = CHAN_UNINTERESTING,
289 [IEEE80211_MODE_TURBO_G] = CHAN_UNINTERESTING,
290 [IEEE80211_MODE_STURBO_A] = CHAN_UNINTERESTING,
291 [IEEE80211_MODE_HALF] = IEEE80211_CHAN_TURBO
292 | IEEE80211_CHAN_STURBO,
293 [IEEE80211_MODE_QUARTER] = IEEE80211_CHAN_TURBO
294 | IEEE80211_CHAN_STURBO,
295 [IEEE80211_MODE_11NA] = CHAN_UNINTERESTING,
296 [IEEE80211_MODE_11NG] = CHAN_UNINTERESTING,
298 const struct ieee80211_regdomain *rd = &ic->ic_regdomain;
299 uint8_t nextchan, chans[IEEE80211_CHAN_BYTES], *frm;
300 struct ieee80211_appie *aie;
301 struct ieee80211_country_ie *ie;
304 aie = malloc(IEEE80211_COUNTRY_MAX_SIZE, M_80211_NODE_IE,
307 if_printf(ic->ic_ifp,
308 "%s: unable to allocate memory for country ie\n", __func__);
312 ie = (struct ieee80211_country_ie *) aie->ie_data;
313 ie->ie = IEEE80211_ELEMID_COUNTRY;
314 if (rd->isocc[0] == '\0') {
315 if_printf(ic->ic_ifp, "no ISO country string for cc %d; "
316 "using blanks\n", rd->country);
317 ie->cc[0] = ie->cc[1] = ' ';
319 ie->cc[0] = rd->isocc[0];
320 ie->cc[1] = rd->isocc[1];
323 * Indoor/Outdoor portion of country string:
326 * ' ' all enviroments
328 ie->cc[2] = (rd->location == 'I' ? 'I' :
329 rd->location == 'O' ? 'O' : ' ');
331 * Run-length encoded channel+max tx power info.
333 frm = (uint8_t *)&ie->band[0];
334 nextchan = 0; /* NB: impossible channel # */
336 memset(chans, 0, sizeof(chans));
337 skip = skipflags[ieee80211_chan2mode(ic->ic_bsschan)];
338 if (IEEE80211_IS_CHAN_5GHZ(ic->ic_bsschan))
339 skip |= IEEE80211_CHAN_2GHZ;
340 else if (IEEE80211_IS_CHAN_2GHZ(ic->ic_bsschan))
341 skip |= IEEE80211_CHAN_5GHZ;
342 for (i = 0; i < ic->ic_nchans; i++) {
343 const struct ieee80211_channel *c = &ic->ic_channels[i];
345 if (isset(chans, c->ic_ieee)) /* suppress dup's */
347 if (c->ic_flags & skip) /* skip band, etc. */
349 setbit(chans, c->ic_ieee);
350 if (c->ic_ieee != nextchan ||
351 c->ic_maxregpower != frm[-1]) { /* new run */
352 if (nruns == IEEE80211_COUNTRY_MAX_BANDS) {
353 if_printf(ic->ic_ifp, "%s: country ie too big, "
354 "runs > max %d, truncating\n",
355 __func__, IEEE80211_COUNTRY_MAX_BANDS);
356 /* XXX stat? fail? */
359 frm[0] = c->ic_ieee; /* starting channel # */
360 frm[1] = 1; /* # channels in run */
361 frm[2] = c->ic_maxregpower; /* tx power cap */
363 nextchan = c->ic_ieee + 1; /* overflow? */
365 } else { /* extend run */
370 ie->len = frm - ie->cc;
371 if (ie->len & 1) { /* Zero pad to multiple of 2 */
375 aie->ie_len = frm - aie->ie_data;
378 #undef CHAN_UNINTERESTING
382 allvapsdown(struct ieee80211com *ic)
384 struct ieee80211vap *vap;
386 IEEE80211_LOCK_ASSERT(ic);
387 TAILQ_FOREACH(vap, &ic->ic_vaps, iv_next)
388 if (vap->iv_state != IEEE80211_S_INIT)
394 ieee80211_setregdomain(struct ieee80211vap *vap,
395 struct ieee80211_regdomain_req *reg)
397 struct ieee80211com *ic = vap->iv_ic;
398 struct ieee80211_channel *c;
399 int desfreq = 0, desflags = 0; /* XXX silence gcc complaint */
402 if (reg->rd.location != 'I' && reg->rd.location != 'O' &&
403 reg->rd.location != ' ') {
404 IEEE80211_DPRINTF(vap, IEEE80211_MSG_IOCTL,
405 "%s: invalid location 0x%x\n", __func__, reg->rd.location);
408 if (reg->rd.isocc[0] == '\0' || reg->rd.isocc[1] == '\0') {
409 IEEE80211_DPRINTF(vap, IEEE80211_MSG_IOCTL,
410 "%s: invalid iso cc 0x%x:0x%x\n", __func__,
411 reg->rd.isocc[0], reg->rd.isocc[1]);
414 if (reg->chaninfo.ic_nchans > IEEE80211_CHAN_MAX) {
415 IEEE80211_DPRINTF(vap, IEEE80211_MSG_IOCTL,
416 "%s: too many channels %u, max %u\n", __func__,
417 reg->chaninfo.ic_nchans, IEEE80211_CHAN_MAX);
421 * Calculate freq<->IEEE mapping and default max tx power
422 * for channels not setup. The driver can override these
423 * setting to reflect device properties/requirements.
425 for (i = 0; i < reg->chaninfo.ic_nchans; i++) {
426 c = ®->chaninfo.ic_chans[i];
427 if (c->ic_freq == 0 || c->ic_flags == 0) {
428 IEEE80211_DPRINTF(vap, IEEE80211_MSG_IOCTL,
429 "%s: invalid channel spec at [%u]\n", __func__, i);
432 if (c->ic_maxregpower == 0) {
433 IEEE80211_DPRINTF(vap, IEEE80211_MSG_IOCTL,
434 "%s: invalid channel spec, zero maxregpower, "
435 "freq %u flags 0x%x\n", __func__,
436 c->ic_freq, c->ic_flags);
440 c->ic_ieee = ieee80211_mhz2ieee(c->ic_freq,c->ic_flags);
441 if (IEEE80211_IS_CHAN_HT40(c) && c->ic_extieee == 0)
442 c->ic_extieee = ieee80211_mhz2ieee(c->ic_freq +
443 (IEEE80211_IS_CHAN_HT40U(c) ? 20 : -20),
445 if (c->ic_maxpower == 0)
446 c->ic_maxpower = 2*c->ic_maxregpower;
449 /* XXX bandaid; a running vap will likely crash */
450 if (!allvapsdown(ic)) {
451 IEEE80211_UNLOCK(ic);
452 IEEE80211_DPRINTF(vap, IEEE80211_MSG_IOCTL,
453 "%s: reject: vaps are running\n", __func__);
456 error = ic->ic_setregdomain(ic, ®->rd,
457 reg->chaninfo.ic_nchans, reg->chaninfo.ic_chans);
459 IEEE80211_UNLOCK(ic);
460 IEEE80211_DPRINTF(vap, IEEE80211_MSG_IOCTL,
461 "%s: driver rejected request, error %u\n", __func__, error);
465 * Commit: copy in new channel table and reset media state.
466 * On return the state machines will be clocked so all vaps
467 * will reset their state.
469 * XXX ic_bsschan is marked undefined, must have vap's in
470 * INIT state or we blow up forcing stations off
473 * Save any desired channel for restore below. Note this
474 * needs to be done for all vaps but for now we only do
475 * the one where the ioctl is issued.
477 if (vap->iv_des_chan != IEEE80211_CHAN_ANYC) {
478 desfreq = vap->iv_des_chan->ic_freq;
479 desflags = vap->iv_des_chan->ic_flags;
481 /* regdomain parameters */
482 memcpy(&ic->ic_regdomain, ®->rd, sizeof(reg->rd));
484 memcpy(ic->ic_channels, reg->chaninfo.ic_chans,
485 reg->chaninfo.ic_nchans * sizeof(struct ieee80211_channel));
486 ic->ic_nchans = reg->chaninfo.ic_nchans;
487 memset(&ic->ic_channels[ic->ic_nchans], 0,
488 (IEEE80211_CHAN_MAX - ic->ic_nchans) *
489 sizeof(struct ieee80211_channel));
490 ieee80211_media_init(ic);
493 * Invalidate channel-related state.
495 if (ic->ic_countryie != NULL) {
496 free(ic->ic_countryie, M_80211_NODE_IE);
497 ic->ic_countryie = NULL;
499 ieee80211_scan_flush(vap);
500 ieee80211_dfs_reset(ic);
501 if (vap->iv_des_chan != IEEE80211_CHAN_ANYC) {
502 c = ieee80211_find_channel(ic, desfreq, desflags);
503 /* NB: may be NULL if not present in new channel list */
504 vap->iv_des_chan = (c != NULL) ? c : IEEE80211_CHAN_ANYC;
506 IEEE80211_UNLOCK(ic);