sys/netproto/802_11/wlan/ieee80211_regdomain.c

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