sys/net80211/ieee80211_regdomain.c

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