drivers/net/wireless/ath/regd.c

   1 /*
   2  * Copyright (c) 2008-2009 Atheros Communications Inc.
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 #include <linux/kernel.h>
  18 #include <linux/slab.h>
  19 #include <net/cfg80211.h>
  20 #include <net/mac80211.h>
  21 #include <net/wireless.h>
  22 #include "regd.h"
  23 #include "regd_common.h"
  24
  25 /*
  26  * This is a set of common rules used by our world regulatory domains.
  27  * We have 12 world regulatory domains. To save space we consolidate
  28  * the regulatory domains in 5 structures by frequency and change
  29  * the flags on our reg_notifier() on a case by case basis.
  30  */
  31
  32 /* Only these channels all allow active scan on all world regulatory domains */
  33 #define ATH9K_2GHZ_CH01_11      REG_RULE(2412-10, 2462+10, 40, 0, 20, 0)
  34
  35 /* We enable active scan on these a case by case basis by regulatory domain */
  36 #define ATH9K_2GHZ_CH12_13      REG_RULE(2467-10, 2472+10, 40, 0, 20,\
  37                                         NL80211_RRF_PASSIVE_SCAN)
  38 #define ATH9K_2GHZ_CH14         REG_RULE(2484-10, 2484+10, 40, 0, 20,\
  39                                 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_OFDM)
  40
  41 /* We allow IBSS on these on a case by case basis by regulatory domain */
  42 #define ATH9K_5GHZ_5150_5350    REG_RULE(5150-10, 5350+10, 40, 0, 30,\
  43                                 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_IBSS)
  44 #define ATH9K_5GHZ_5470_5850    REG_RULE(5470-10, 5850+10, 40, 0, 30,\
  45                                 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_IBSS)
  46 #define ATH9K_5GHZ_5725_5850    REG_RULE(5725-10, 5850+10, 40, 0, 30,\
  47                                 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_IBSS)
  48
  49 #define ATH9K_2GHZ_ALL          ATH9K_2GHZ_CH01_11, \
  50                                 ATH9K_2GHZ_CH12_13, \
  51                                 ATH9K_2GHZ_CH14
  52
  53 #define ATH9K_5GHZ_ALL          ATH9K_5GHZ_5150_5350, \
  54                                 ATH9K_5GHZ_5470_5850
  55 /* This one skips what we call "mid band" */
  56 #define ATH9K_5GHZ_NO_MIDBAND   ATH9K_5GHZ_5150_5350, \
  57                                 ATH9K_5GHZ_5725_5850
  58
  59 /* Can be used for:
  60  * 0x60, 0x61, 0x62 */
  61 static const struct ieee80211_regdomain ath_world_regdom_60_61_62 = {
  62         .n_reg_rules = 5,
  63         .alpha2 =  "99",
  64         .reg_rules = {
  65                 ATH9K_2GHZ_ALL,
  66                 ATH9K_5GHZ_ALL,
  67         }
  68 };
  69
  70 /* Can be used by 0x63 and 0x65 */
  71 static const struct ieee80211_regdomain ath_world_regdom_63_65 = {
  72         .n_reg_rules = 4,
  73         .alpha2 =  "99",
  74         .reg_rules = {
  75                 ATH9K_2GHZ_CH01_11,
  76                 ATH9K_2GHZ_CH12_13,
  77                 ATH9K_5GHZ_NO_MIDBAND,
  78         }
  79 };
  80
  81 /* Can be used by 0x64 only */
  82 static const struct ieee80211_regdomain ath_world_regdom_64 = {
  83         .n_reg_rules = 3,
  84         .alpha2 =  "99",
  85         .reg_rules = {
  86                 ATH9K_2GHZ_CH01_11,
  87                 ATH9K_5GHZ_NO_MIDBAND,
  88         }
  89 };
  90
  91 /* Can be used by 0x66 and 0x69 */
  92 static const struct ieee80211_regdomain ath_world_regdom_66_69 = {
  93         .n_reg_rules = 3,
  94         .alpha2 =  "99",
  95         .reg_rules = {
  96                 ATH9K_2GHZ_CH01_11,
  97                 ATH9K_5GHZ_ALL,
  98         }
  99 };
 100
 101 /* Can be used by 0x67, 0x6A and 0x68 */
 102 static const struct ieee80211_regdomain ath_world_regdom_67_68_6A = {
 103         .n_reg_rules = 4,
 104         .alpha2 =  "99",
 105         .reg_rules = {
 106                 ATH9K_2GHZ_CH01_11,
 107                 ATH9K_2GHZ_CH12_13,
 108                 ATH9K_5GHZ_ALL,
 109         }
 110 };
 111
 112 static inline bool is_wwr_sku(u16 regd)
 113 {
 114         return ((regd & WORLD_SKU_MASK) == WORLD_SKU_PREFIX) ||
 115                 (regd == WORLD);
 116 }
 117
 118 static u16 ath_regd_get_eepromRD(struct ath_regulatory *reg)
 119 {
 120         return reg->current_rd & ~WORLDWIDE_ROAMING_FLAG;
 121 }
 122
 123 bool ath_is_world_regd(struct ath_regulatory *reg)
 124 {
 125         return is_wwr_sku(ath_regd_get_eepromRD(reg));
 126 }
 127 EXPORT_SYMBOL(ath_is_world_regd);
 128
 129 static const struct ieee80211_regdomain *ath_default_world_regdomain(void)
 130 {
 131         /* this is the most restrictive */
 132         return &ath_world_regdom_64;
 133 }
 134
 135 static const struct
 136 ieee80211_regdomain *ath_world_regdomain(struct ath_regulatory *reg)
 137 {
 138         switch (reg->regpair->regDmnEnum) {
 139         case 0x60:
 140         case 0x61:
 141         case 0x62:
 142                 return &ath_world_regdom_60_61_62;
 143         case 0x63:
 144         case 0x65:
 145                 return &ath_world_regdom_63_65;
 146         case 0x64:
 147                 return &ath_world_regdom_64;
 148         case 0x66:
 149         case 0x69:
 150                 return &ath_world_regdom_66_69;
 151         case 0x67:
 152         case 0x68:
 153         case 0x6A:
 154                 return &ath_world_regdom_67_68_6A;
 155         default:
 156                 WARN_ON(1);
 157                 return ath_default_world_regdomain();
 158         }
 159 }
 160
 161 /* Frequency is one where radar detection is required */
 162 static bool ath_is_radar_freq(u16 center_freq)
 163 {
 164         return (center_freq >= 5260 && center_freq <= 5700);
 165 }
 166
 167 /*
 168  * N.B: These exception rules do not apply radar freqs.
 169  *
 170  * - We enable adhoc (or beaconing) if allowed by 11d
 171  * - We enable active scan if the channel is allowed by 11d
 172  * - If no country IE has been processed and a we determine we have
 173  *   received a beacon on a channel we can enable active scan and
 174  *   adhoc (or beaconing).
 175  */
 176 static void
 177 ath_reg_apply_beaconing_flags(struct wiphy *wiphy,
 178                               enum nl80211_reg_initiator initiator)
 179 {
 180         enum ieee80211_band band;
 181         struct ieee80211_supported_band *sband;
 182         const struct ieee80211_reg_rule *reg_rule;
 183         struct ieee80211_channel *ch;
 184         unsigned int i;
 185         u32 bandwidth = 0;
 186         int r;
 187
 188         for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
 189
 190                 if (!wiphy->bands[band])
 191                         continue;
 192
 193                 sband = wiphy->bands[band];
 194
 195                 for (i = 0; i < sband->n_channels; i++) {
 196
 197                         ch = &sband->channels[i];
 198
 199                         if (ath_is_radar_freq(ch->center_freq) ||
 200                             (ch->flags & IEEE80211_CHAN_RADAR))
 201                                 continue;
 202
 203                         if (initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE) {
 204                                 r = freq_reg_info(wiphy, ch->center_freq,
 205                                         &bandwidth, &reg_rule);
 206                                 if (r)
 207                                         continue;
 208                                 /*
 209                                  * If 11d had a rule for this channel ensure
 210                                  * we enable adhoc/beaconing if it allows us to
 211                                  * use it. Note that we would have disabled it
 212                                  * by applying our static world regdomain by
 213                                  * default during init, prior to calling our
 214                                  * regulatory_hint().
 215                                  */
 216                                 if (!(reg_rule->flags &
 217                                     NL80211_RRF_NO_IBSS))
 218                                         ch->flags &=
 219                                           ~IEEE80211_CHAN_NO_IBSS;
 220                                 if (!(reg_rule->flags &
 221                                     NL80211_RRF_PASSIVE_SCAN))
 222                                         ch->flags &=
 223                                           ~IEEE80211_CHAN_PASSIVE_SCAN;
 224                         } else {
 225                                 if (ch->beacon_found)
 226                                         ch->flags &= ~(IEEE80211_CHAN_NO_IBSS |
 227                                           IEEE80211_CHAN_PASSIVE_SCAN);
 228                         }
 229                 }
 230         }
 231
 232 }
 233
 234 /* Allows active scan scan on Ch 12 and 13 */
 235 static void
 236 ath_reg_apply_active_scan_flags(struct wiphy *wiphy,
 237                                 enum nl80211_reg_initiator initiator)
 238 {
 239         struct ieee80211_supported_band *sband;
 240         struct ieee80211_channel *ch;
 241         const struct ieee80211_reg_rule *reg_rule;
 242         u32 bandwidth = 0;
 243         int r;
 244
 245         sband = wiphy->bands[IEEE80211_BAND_2GHZ];
 246
 247         /*
 248          * If no country IE has been received always enable active scan
 249          * on these channels. This is only done for specific regulatory SKUs
 250          */
 251         if (initiator != NL80211_REGDOM_SET_BY_COUNTRY_IE) {
 252                 ch = &sband->channels[11]; /* CH 12 */
 253                 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 254                         ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 255                 ch = &sband->channels[12]; /* CH 13 */
 256                 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 257                         ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 258                 return;
 259         }
 260
 261         /*
 262          * If a country IE has been recieved check its rule for this
 263          * channel first before enabling active scan. The passive scan
 264          * would have been enforced by the initial processing of our
 265          * custom regulatory domain.
 266          */
 267
 268         ch = &sband->channels[11]; /* CH 12 */
 269         r = freq_reg_info(wiphy, ch->center_freq, &bandwidth, &reg_rule);
 270         if (!r) {
 271                 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
 272                         if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 273                                 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 274         }
 275
 276         ch = &sband->channels[12]; /* CH 13 */
 277         r = freq_reg_info(wiphy, ch->center_freq, &bandwidth, &reg_rule);
 278         if (!r) {
 279                 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
 280                         if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 281                                 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 282         }
 283 }
 284
 285 /* Always apply Radar/DFS rules on freq range 5260 MHz - 5700 MHz */
 286 static void ath_reg_apply_radar_flags(struct wiphy *wiphy)
 287 {
 288         struct ieee80211_supported_band *sband;
 289         struct ieee80211_channel *ch;
 290         unsigned int i;
 291
 292         if (!wiphy->bands[IEEE80211_BAND_5GHZ])
 293                 return;
 294
 295         sband = wiphy->bands[IEEE80211_BAND_5GHZ];
 296
 297         for (i = 0; i < sband->n_channels; i++) {
 298                 ch = &sband->channels[i];
 299                 if (!ath_is_radar_freq(ch->center_freq))
 300                         continue;
 301                 /* We always enable radar detection/DFS on this
 302                  * frequency range. Additionally we also apply on
 303                  * this frequency range:
 304                  * - If STA mode does not yet have DFS supports disable
 305                  *   active scanning
 306                  * - If adhoc mode does not support DFS yet then
 307                  *   disable adhoc in the frequency.
 308                  * - If AP mode does not yet support radar detection/DFS
 309                  *   do not allow AP mode
 310                  */
 311                 if (!(ch->flags & IEEE80211_CHAN_DISABLED))
 312                         ch->flags |= IEEE80211_CHAN_RADAR |
 313                                      IEEE80211_CHAN_NO_IBSS |
 314                                      IEEE80211_CHAN_PASSIVE_SCAN;
 315         }
 316 }
 317
 318 static void ath_reg_apply_world_flags(struct wiphy *wiphy,
 319                                       enum nl80211_reg_initiator initiator,
 320                                       struct ath_regulatory *reg)
 321 {
 322         switch (reg->regpair->regDmnEnum) {
 323         case 0x60:
 324         case 0x63:
 325         case 0x66:
 326         case 0x67:
 327                 ath_reg_apply_beaconing_flags(wiphy, initiator);
 328                 break;
 329         case 0x68:
 330                 ath_reg_apply_beaconing_flags(wiphy, initiator);
 331                 ath_reg_apply_active_scan_flags(wiphy, initiator);
 332                 break;
 333         }
 334         return;
 335 }
 336
 337 int ath_reg_notifier_apply(struct wiphy *wiphy,
 338                            struct regulatory_request *request,
 339                            struct ath_regulatory *reg)
 340 {
 341         /* We always apply this */
 342         ath_reg_apply_radar_flags(wiphy);
 343
 344         switch (request->initiator) {
 345         case NL80211_REGDOM_SET_BY_DRIVER:
 346         case NL80211_REGDOM_SET_BY_CORE:
 347         case NL80211_REGDOM_SET_BY_USER:
 348                 break;
 349         case NL80211_REGDOM_SET_BY_COUNTRY_IE:
 350                 if (ath_is_world_regd(reg))
 351                         ath_reg_apply_world_flags(wiphy, request->initiator,
 352                                                   reg);
 353                 break;
 354         }
 355
 356         return 0;
 357 }
 358 EXPORT_SYMBOL(ath_reg_notifier_apply);
 359
 360 static bool ath_regd_is_eeprom_valid(struct ath_regulatory *reg)
 361 {
 362          u16 rd = ath_regd_get_eepromRD(reg);
 363         int i;
 364
 365         if (rd & COUNTRY_ERD_FLAG) {
 366                 /* EEPROM value is a country code */
 367                 u16 cc = rd & ~COUNTRY_ERD_FLAG;
 368                 for (i = 0; i < ARRAY_SIZE(allCountries); i++)
 369                         if (allCountries[i].countryCode == cc)
 370                                 return true;
 371         } else {
 372                 /* EEPROM value is a regpair value */
 373                 for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++)
 374                         if (regDomainPairs[i].regDmnEnum == rd)
 375                                 return true;
 376         }
 377         printk(KERN_DEBUG
 378                  "ath: invalid regulatory domain/country code 0x%x\n", rd);
 379         return false;
 380 }
 381
 382 /* EEPROM country code to regpair mapping */
 383 static struct country_code_to_enum_rd*
 384 ath_regd_find_country(u16 countryCode)
 385 {
 386         int i;
 387
 388         for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
 389                 if (allCountries[i].countryCode == countryCode)
 390                         return &allCountries[i];
 391         }
 392         return NULL;
 393 }
 394
 395 /* EEPROM rd code to regpair mapping */
 396 static struct country_code_to_enum_rd*
 397 ath_regd_find_country_by_rd(int regdmn)
 398 {
 399         int i;
 400
 401         for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
 402                 if (allCountries[i].regDmnEnum == regdmn)
 403                         return &allCountries[i];
 404         }
 405         return NULL;
 406 }
 407
 408 /* Returns the map of the EEPROM set RD to a country code */
 409 static u16 ath_regd_get_default_country(u16 rd)
 410 {
 411         if (rd & COUNTRY_ERD_FLAG) {
 412                 struct country_code_to_enum_rd *country = NULL;
 413                 u16 cc = rd & ~COUNTRY_ERD_FLAG;
 414
 415                 country = ath_regd_find_country(cc);
 416                 if (country != NULL)
 417                         return cc;
 418         }
 419
 420         return CTRY_DEFAULT;
 421 }
 422
 423 static struct reg_dmn_pair_mapping*
 424 ath_get_regpair(int regdmn)
 425 {
 426         int i;
 427
 428         if (regdmn == NO_ENUMRD)
 429                 return NULL;
 430         for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++) {
 431                 if (regDomainPairs[i].regDmnEnum == regdmn)
 432                         return &regDomainPairs[i];
 433         }
 434         return NULL;
 435 }
 436
 437 static int
 438 ath_regd_init_wiphy(struct ath_regulatory *reg,
 439                     struct wiphy *wiphy,
 440                     int (*reg_notifier)(struct wiphy *wiphy,
 441                                         struct regulatory_request *request))
 442 {
 443         const struct ieee80211_regdomain *regd;
 444
 445         wiphy->reg_notifier = reg_notifier;
 446         wiphy->strict_regulatory = true;
 447
 448         if (ath_is_world_regd(reg)) {
 449                 /*
 450                  * Anything applied here (prior to wiphy registration) gets
 451                  * saved on the wiphy orig_* parameters
 452                  */
 453                 regd = ath_world_regdomain(reg);
 454                 wiphy->custom_regulatory = true;
 455                 wiphy->strict_regulatory = false;
 456         } else {
 457                 /*
 458                  * This gets applied in the case of the absense of CRDA,
 459                  * it's our own custom world regulatory domain, similar to
 460                  * cfg80211's but we enable passive scanning.
 461                  */
 462                 regd = ath_default_world_regdomain();
 463         }
 464         wiphy_apply_custom_regulatory(wiphy, regd);
 465         ath_reg_apply_radar_flags(wiphy);
 466         ath_reg_apply_world_flags(wiphy, NL80211_REGDOM_SET_BY_DRIVER, reg);
 467         return 0;
 468 }
 469
 470 int
 471 ath_regd_init(struct ath_regulatory *reg,
 472               struct wiphy *wiphy,
 473               int (*reg_notifier)(struct wiphy *wiphy,
 474                                   struct regulatory_request *request))
 475 {
 476         struct country_code_to_enum_rd *country = NULL;
 477         u16 regdmn;
 478
 479         if (!ath_regd_is_eeprom_valid(reg)) {
 480                 printk(KERN_DEBUG "ath: Invalid EEPROM contents\n");
 481                 return -EINVAL;
 482         }
 483
 484         regdmn = ath_regd_get_eepromRD(reg);
 485         reg->country_code = ath_regd_get_default_country(regdmn);
 486
 487         if (reg->country_code == CTRY_DEFAULT &&
 488             regdmn == CTRY_DEFAULT)
 489                 reg->country_code = CTRY_UNITED_STATES;
 490
 491         if (reg->country_code == CTRY_DEFAULT) {
 492                 country = NULL;
 493         } else {
 494                 country = ath_regd_find_country(reg->country_code);
 495                 if (country == NULL) {
 496                         printk(KERN_DEBUG
 497                                 "ath: Country is NULL!!!!, cc= %d\n",
 498                                 reg->country_code);
 499                         return -EINVAL;
 500                 } else
 501                         regdmn = country->regDmnEnum;
 502         }
 503
 504         reg->regpair = ath_get_regpair(regdmn);
 505
 506         if (!reg->regpair) {
 507                 printk(KERN_DEBUG "ath: "
 508                         "No regulatory domain pair found, cannot continue\n");
 509                 return -EINVAL;
 510         }
 511
 512         if (!country)
 513                 country = ath_regd_find_country_by_rd(regdmn);
 514
 515         if (country) {
 516                 reg->alpha2[0] = country->isoName[0];
 517                 reg->alpha2[1] = country->isoName[1];
 518         } else {
 519                 reg->alpha2[0] = '0';
 520                 reg->alpha2[1] = '0';
 521         }
 522
 523         printk(KERN_DEBUG "ath: Country alpha2 being used: %c%c\n",
 524                 reg->alpha2[0], reg->alpha2[1]);
 525         printk(KERN_DEBUG "ath: Regpair detected: 0x%0x\n",
 526                 reg->regpair->regDmnEnum);
 527
 528         ath_regd_init_wiphy(reg, wiphy, reg_notifier);
 529         return 0;
 530 }
 531 EXPORT_SYMBOL(ath_regd_init);
 532
 533 u32 ath_regd_get_band_ctl(struct ath_regulatory *reg,
 534                           enum ieee80211_band band)
 535 {
 536         if (!reg->regpair ||
 537             (reg->country_code == CTRY_DEFAULT &&
 538              is_wwr_sku(ath_regd_get_eepromRD(reg)))) {
 539                 return SD_NO_CTL;
 540         }
 541
 542         switch (band) {
 543         case IEEE80211_BAND_2GHZ:
 544                 return reg->regpair->reg_2ghz_ctl;
 545         case IEEE80211_BAND_5GHZ:
 546                 return reg->regpair->reg_5ghz_ctl;
 547         default:
 548                 return NO_CTL;
 549         }
 550
 551         return NO_CTL;
 552 }
 553 EXPORT_SYMBOL(ath_regd_get_band_ctl);