1 /*- 2 * Copyright (c) 2005-2008 Sam Leffler, Errno Consulting 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 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. 13 * 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. 24 */ 25 26 #include <sys/cdefs.h> 27 __FBSDID("$FreeBSD$"); 28 29 /* 30 * IEEE 802.11 regdomain support. 31 */ 32 #include "opt_wlan.h" 33 34 #include <sys/param.h> 35 #include <sys/systm.h> 36 #include <sys/kernel.h> 37 #include <sys/malloc.h> 38 #include <sys/socket.h> 39 40 #include <net/if.h> 41 #include <net/if_var.h> 42 #include <net/if_media.h> 43 #include <net/ethernet.h> 44 45 #include <net80211/ieee80211_var.h> 46 #include <net80211/ieee80211_regdomain.h> 47 48 static void 49 null_getradiocaps(struct ieee80211com *ic, int maxchan, 50 int *n, struct ieee80211_channel *c) 51 { 52 /* just feed back the current channel list */ 53 if (maxchan > ic->ic_nchans) 54 maxchan = ic->ic_nchans; 55 memcpy(c, ic->ic_channels, maxchan*sizeof(struct ieee80211_channel)); 56 *n = maxchan; 57 } 58 59 static int 60 null_setregdomain(struct ieee80211com *ic, 61 struct ieee80211_regdomain *rd, 62 int nchans, struct ieee80211_channel chans[]) 63 { 64 return 0; /* accept anything */ 65 } 66 67 void 68 ieee80211_regdomain_attach(struct ieee80211com *ic) 69 { 70 if (ic->ic_regdomain.regdomain == 0 && 71 ic->ic_regdomain.country == CTRY_DEFAULT) { 72 ic->ic_regdomain.country = CTRY_UNITED_STATES; /* XXX */ 73 ic->ic_regdomain.location = ' '; /* both */ 74 ic->ic_regdomain.isocc[0] = 'U'; /* XXX */ 75 ic->ic_regdomain.isocc[1] = 'S'; /* XXX */ 76 /* NB: driver calls ieee80211_init_channels or similar */ 77 } 78 ic->ic_getradiocaps = null_getradiocaps; 79 ic->ic_setregdomain = null_setregdomain; 80 } 81 82 void 83 ieee80211_regdomain_detach(struct ieee80211com *ic) 84 { 85 if (ic->ic_countryie != NULL) { 86 IEEE80211_FREE(ic->ic_countryie, M_80211_NODE_IE); 87 ic->ic_countryie = NULL; 88 } 89 } 90 91 void 92 ieee80211_regdomain_vattach(struct ieee80211vap *vap) 93 { 94 } 95 96 void 97 ieee80211_regdomain_vdetach(struct ieee80211vap *vap) 98 { 99 } 100 101 static const uint8_t def_chan_2ghz[] = 102 { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 }; 103 static const uint8_t def_chan_5ghz_band1[] = 104 { 36, 40, 44, 48, 52, 56, 60, 64 }; 105 static const uint8_t def_chan_5ghz_band2[] = 106 { 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140 }; 107 static const uint8_t def_chan_5ghz_band3[] = 108 { 149, 153, 157, 161 }; 109 110 /* 111 * Setup the channel list for the specified regulatory domain, 112 * country code, and operating modes. This interface is used 113 * when a driver does not obtain the channel list from another 114 * source (such as firmware). 115 */ 116 int 117 ieee80211_init_channels(struct ieee80211com *ic, 118 const struct ieee80211_regdomain *rd, const uint8_t bands[]) 119 { 120 struct ieee80211_channel *chans = ic->ic_channels; 121 int *nchans = &ic->ic_nchans; 122 int ht40; 123 124 /* XXX just do something for now */ 125 ht40 = !!(ic->ic_htcaps & IEEE80211_HTCAP_CHWIDTH40); 126 *nchans = 0; 127 if (isset(bands, IEEE80211_MODE_11B) || 128 isset(bands, IEEE80211_MODE_11G) || 129 isset(bands, IEEE80211_MODE_11NG)) { 130 int nchan = nitems(def_chan_2ghz); 131 if (!(rd != NULL && rd->ecm)) 132 nchan -= 3; 133 134 ieee80211_add_channel_list_2ghz(chans, IEEE80211_CHAN_MAX, 135 nchans, def_chan_2ghz, nchan, bands, ht40); 136 } 137 if (isset(bands, IEEE80211_MODE_11A) || 138 isset(bands, IEEE80211_MODE_11NA)) { 139 ieee80211_add_channel_list_5ghz(chans, IEEE80211_CHAN_MAX, 140 nchans, def_chan_5ghz_band1, nitems(def_chan_5ghz_band1), 141 bands, ht40); 142 ieee80211_add_channel_list_5ghz(chans, IEEE80211_CHAN_MAX, 143 nchans, def_chan_5ghz_band2, nitems(def_chan_5ghz_band2), 144 bands, ht40); 145 ieee80211_add_channel_list_5ghz(chans, IEEE80211_CHAN_MAX, 146 nchans, def_chan_5ghz_band3, nitems(def_chan_5ghz_band3), 147 bands, ht40); 148 } 149 if (rd != NULL) 150 ic->ic_regdomain = *rd; 151 152 return 0; 153 } 154 155 static __inline int 156 chancompar(const void *a, const void *b) 157 { 158 const struct ieee80211_channel *ca = a; 159 const struct ieee80211_channel *cb = b; 160 161 return (ca->ic_freq == cb->ic_freq) ? 162 (ca->ic_flags & IEEE80211_CHAN_ALL) - 163 (cb->ic_flags & IEEE80211_CHAN_ALL) : 164 ca->ic_freq - cb->ic_freq; 165 } 166 167 /* 168 * Insertion sort. 169 */ 170 #define swap(_a, _b, _size) { \ 171 uint8_t *s = _b; \ 172 int i = _size; \ 173 do { \ 174 uint8_t tmp = *_a; \ 175 *_a++ = *s; \ 176 *s++ = tmp; \ 177 } while (--i); \ 178 _a -= _size; \ 179 } 180 181 static void 182 sort_channels(void *a, size_t n, size_t size) 183 { 184 uint8_t *aa = a; 185 uint8_t *ai, *t; 186 187 KASSERT(n > 0, ("no channels")); 188 for (ai = aa+size; --n >= 1; ai += size) 189 for (t = ai; t > aa; t -= size) { 190 uint8_t *u = t - size; 191 if (chancompar(u, t) <= 0) 192 break; 193 swap(u, t, size); 194 } 195 } 196 #undef swap 197 198 /* 199 * Order channels w/ the same frequency so that 200 * b < g < htg and a < hta. This is used to optimize 201 * channel table lookups and some user applications 202 * may also depend on it (though they should not). 203 */ 204 void 205 ieee80211_sort_channels(struct ieee80211_channel chans[], int nchans) 206 { 207 if (nchans > 0) 208 sort_channels(chans, nchans, sizeof(struct ieee80211_channel)); 209 } 210 211 /* 212 * Allocate and construct a Country Information IE. 213 */ 214 struct ieee80211_appie * 215 ieee80211_alloc_countryie(struct ieee80211com *ic) 216 { 217 #define CHAN_UNINTERESTING \ 218 (IEEE80211_CHAN_TURBO | IEEE80211_CHAN_STURBO | \ 219 IEEE80211_CHAN_HALF | IEEE80211_CHAN_QUARTER) 220 /* XXX what about auto? */ 221 /* flag set of channels to be excluded (band added below) */ 222 static const int skipflags[IEEE80211_MODE_MAX] = { 223 [IEEE80211_MODE_AUTO] = CHAN_UNINTERESTING, 224 [IEEE80211_MODE_11A] = CHAN_UNINTERESTING, 225 [IEEE80211_MODE_11B] = CHAN_UNINTERESTING, 226 [IEEE80211_MODE_11G] = CHAN_UNINTERESTING, 227 [IEEE80211_MODE_FH] = CHAN_UNINTERESTING 228 | IEEE80211_CHAN_OFDM 229 | IEEE80211_CHAN_CCK 230 | IEEE80211_CHAN_DYN, 231 [IEEE80211_MODE_TURBO_A] = CHAN_UNINTERESTING, 232 [IEEE80211_MODE_TURBO_G] = CHAN_UNINTERESTING, 233 [IEEE80211_MODE_STURBO_A] = CHAN_UNINTERESTING, 234 [IEEE80211_MODE_HALF] = IEEE80211_CHAN_TURBO 235 | IEEE80211_CHAN_STURBO, 236 [IEEE80211_MODE_QUARTER] = IEEE80211_CHAN_TURBO 237 | IEEE80211_CHAN_STURBO, 238 [IEEE80211_MODE_11NA] = CHAN_UNINTERESTING, 239 [IEEE80211_MODE_11NG] = CHAN_UNINTERESTING, 240 }; 241 const struct ieee80211_regdomain *rd = &ic->ic_regdomain; 242 uint8_t nextchan, chans[IEEE80211_CHAN_BYTES], *frm; 243 struct ieee80211_appie *aie; 244 struct ieee80211_country_ie *ie; 245 int i, skip, nruns; 246 247 aie = IEEE80211_MALLOC(IEEE80211_COUNTRY_MAX_SIZE, M_80211_NODE_IE, 248 IEEE80211_M_NOWAIT | IEEE80211_M_ZERO); 249 if (aie == NULL) { 250 ic_printf(ic, "%s: unable to allocate memory for country ie\n", 251 __func__); 252 /* XXX stat */ 253 return NULL; 254 } 255 ie = (struct ieee80211_country_ie *) aie->ie_data; 256 ie->ie = IEEE80211_ELEMID_COUNTRY; 257 if (rd->isocc[0] == '\0') { 258 ic_printf(ic, "no ISO country string for cc %d; using blanks\n", 259 rd->country); 260 ie->cc[0] = ie->cc[1] = ' '; 261 } else { 262 ie->cc[0] = rd->isocc[0]; 263 ie->cc[1] = rd->isocc[1]; 264 } 265 /* 266 * Indoor/Outdoor portion of country string: 267 * 'I' indoor only 268 * 'O' outdoor only 269 * ' ' all environments 270 */ 271 ie->cc[2] = (rd->location == 'I' ? 'I' : 272 rd->location == 'O' ? 'O' : ' '); 273 /* 274 * Run-length encoded channel+max tx power info. 275 */ 276 frm = (uint8_t *)&ie->band[0]; 277 nextchan = 0; /* NB: impossible channel # */ 278 nruns = 0; 279 memset(chans, 0, sizeof(chans)); 280 skip = skipflags[ieee80211_chan2mode(ic->ic_bsschan)]; 281 if (IEEE80211_IS_CHAN_5GHZ(ic->ic_bsschan)) 282 skip |= IEEE80211_CHAN_2GHZ; 283 else if (IEEE80211_IS_CHAN_2GHZ(ic->ic_bsschan)) 284 skip |= IEEE80211_CHAN_5GHZ; 285 for (i = 0; i < ic->ic_nchans; i++) { 286 const struct ieee80211_channel *c = &ic->ic_channels[i]; 287 288 if (isset(chans, c->ic_ieee)) /* suppress dup's */ 289 continue; 290 if (c->ic_flags & skip) /* skip band, etc. */ 291 continue; 292 setbit(chans, c->ic_ieee); 293 if (c->ic_ieee != nextchan || 294 c->ic_maxregpower != frm[-1]) { /* new run */ 295 if (nruns == IEEE80211_COUNTRY_MAX_BANDS) { 296 ic_printf(ic, "%s: country ie too big, " 297 "runs > max %d, truncating\n", 298 __func__, IEEE80211_COUNTRY_MAX_BANDS); 299 /* XXX stat? fail? */ 300 break; 301 } 302 frm[0] = c->ic_ieee; /* starting channel # */ 303 frm[1] = 1; /* # channels in run */ 304 frm[2] = c->ic_maxregpower; /* tx power cap */ 305 frm += 3; 306 nextchan = c->ic_ieee + 1; /* overflow? */ 307 nruns++; 308 } else { /* extend run */ 309 frm[-2]++; 310 nextchan++; 311 } 312 } 313 ie->len = frm - ie->cc; 314 if (ie->len & 1) { /* Zero pad to multiple of 2 */ 315 ie->len++; 316 *frm++ = 0; 317 } 318 aie->ie_len = frm - aie->ie_data; 319 320 return aie; 321 #undef CHAN_UNINTERESTING 322 } 323 324 static int 325 allvapsdown(struct ieee80211com *ic) 326 { 327 struct ieee80211vap *vap; 328 329 IEEE80211_LOCK_ASSERT(ic); 330 TAILQ_FOREACH(vap, &ic->ic_vaps, iv_next) 331 if (vap->iv_state != IEEE80211_S_INIT) 332 return 0; 333 return 1; 334 } 335 336 int 337 ieee80211_setregdomain(struct ieee80211vap *vap, 338 struct ieee80211_regdomain_req *reg) 339 { 340 struct ieee80211com *ic = vap->iv_ic; 341 struct ieee80211_channel *c; 342 int desfreq = 0, desflags = 0; /* XXX silence gcc complaint */ 343 int error, i; 344 345 if (reg->rd.location != 'I' && reg->rd.location != 'O' && 346 reg->rd.location != ' ') { 347 IEEE80211_DPRINTF(vap, IEEE80211_MSG_IOCTL, 348 "%s: invalid location 0x%x\n", __func__, reg->rd.location); 349 return EINVAL; 350 } 351 if (reg->rd.isocc[0] == '\0' || reg->rd.isocc[1] == '\0') { 352 IEEE80211_DPRINTF(vap, IEEE80211_MSG_IOCTL, 353 "%s: invalid iso cc 0x%x:0x%x\n", __func__, 354 reg->rd.isocc[0], reg->rd.isocc[1]); 355 return EINVAL; 356 } 357 if (reg->chaninfo.ic_nchans > IEEE80211_CHAN_MAX) { 358 IEEE80211_DPRINTF(vap, IEEE80211_MSG_IOCTL, 359 "%s: too many channels %u, max %u\n", __func__, 360 reg->chaninfo.ic_nchans, IEEE80211_CHAN_MAX); 361 return EINVAL; 362 } 363 /* 364 * Calculate freq<->IEEE mapping and default max tx power 365 * for channels not setup. The driver can override these 366 * setting to reflect device properties/requirements. 367 */ 368 for (i = 0; i < reg->chaninfo.ic_nchans; i++) { 369 c = ®->chaninfo.ic_chans[i]; 370 if (c->ic_freq == 0 || c->ic_flags == 0) { 371 IEEE80211_DPRINTF(vap, IEEE80211_MSG_IOCTL, 372 "%s: invalid channel spec at [%u]\n", __func__, i); 373 return EINVAL; 374 } 375 if (c->ic_maxregpower == 0) { 376 IEEE80211_DPRINTF(vap, IEEE80211_MSG_IOCTL, 377 "%s: invalid channel spec, zero maxregpower, " 378 "freq %u flags 0x%x\n", __func__, 379 c->ic_freq, c->ic_flags); 380 return EINVAL; 381 } 382 if (c->ic_ieee == 0) 383 c->ic_ieee = ieee80211_mhz2ieee(c->ic_freq,c->ic_flags); 384 if (IEEE80211_IS_CHAN_HT40(c) && c->ic_extieee == 0) 385 c->ic_extieee = ieee80211_mhz2ieee(c->ic_freq + 386 (IEEE80211_IS_CHAN_HT40U(c) ? 20 : -20), 387 c->ic_flags); 388 if (c->ic_maxpower == 0) 389 c->ic_maxpower = 2*c->ic_maxregpower; 390 } 391 IEEE80211_LOCK(ic); 392 /* XXX bandaid; a running vap will likely crash */ 393 if (!allvapsdown(ic)) { 394 IEEE80211_UNLOCK(ic); 395 IEEE80211_DPRINTF(vap, IEEE80211_MSG_IOCTL, 396 "%s: reject: vaps are running\n", __func__); 397 return EBUSY; 398 } 399 error = ic->ic_setregdomain(ic, ®->rd, 400 reg->chaninfo.ic_nchans, reg->chaninfo.ic_chans); 401 if (error != 0) { 402 IEEE80211_UNLOCK(ic); 403 IEEE80211_DPRINTF(vap, IEEE80211_MSG_IOCTL, 404 "%s: driver rejected request, error %u\n", __func__, error); 405 return error; 406 } 407 /* 408 * Commit: copy in new channel table and reset media state. 409 * On return the state machines will be clocked so all vaps 410 * will reset their state. 411 * 412 * XXX ic_bsschan is marked undefined, must have vap's in 413 * INIT state or we blow up forcing stations off 414 */ 415 /* 416 * Save any desired channel for restore below. Note this 417 * needs to be done for all vaps but for now we only do 418 * the one where the ioctl is issued. 419 */ 420 if (vap->iv_des_chan != IEEE80211_CHAN_ANYC) { 421 desfreq = vap->iv_des_chan->ic_freq; 422 desflags = vap->iv_des_chan->ic_flags; 423 } 424 /* regdomain parameters */ 425 memcpy(&ic->ic_regdomain, ®->rd, sizeof(reg->rd)); 426 /* channel table */ 427 memcpy(ic->ic_channels, reg->chaninfo.ic_chans, 428 reg->chaninfo.ic_nchans * sizeof(struct ieee80211_channel)); 429 ic->ic_nchans = reg->chaninfo.ic_nchans; 430 memset(&ic->ic_channels[ic->ic_nchans], 0, 431 (IEEE80211_CHAN_MAX - ic->ic_nchans) * 432 sizeof(struct ieee80211_channel)); 433 ieee80211_chan_init(ic); 434 435 /* 436 * Invalidate channel-related state. 437 */ 438 if (ic->ic_countryie != NULL) { 439 IEEE80211_FREE(ic->ic_countryie, M_80211_NODE_IE); 440 ic->ic_countryie = NULL; 441 } 442 ieee80211_scan_flush(vap); 443 ieee80211_dfs_reset(ic); 444 if (vap->iv_des_chan != IEEE80211_CHAN_ANYC) { 445 c = ieee80211_find_channel(ic, desfreq, desflags); 446 /* NB: may be NULL if not present in new channel list */ 447 vap->iv_des_chan = (c != NULL) ? c : IEEE80211_CHAN_ANYC; 448 } 449 IEEE80211_UNLOCK(ic); 450 451 return 0; 452 } 453