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 "regd.h"
  22 #include "regd_common.h"
  23
  24 /*
  25  * This is a set of common rules used by our world regulatory domains.
  26  * We have 12 world regulatory domains. To save space we consolidate
  27  * the regulatory domains in 5 structures by frequency and change
  28  * the flags on our reg_notifier() on a case by case basis.
  29  */
  30
  31 /* Only these channels all allow active scan on all world regulatory domains */
  32 #define ATH9K_2GHZ_CH01_11      REG_RULE(2412-10, 2462+10, 40, 0, 20, 0)
  33
  34 /* We enable active scan on these a case by case basis by regulatory domain */
  35 #define ATH9K_2GHZ_CH12_13      REG_RULE(2467-10, 2472+10, 40, 0, 20,\
  36                                         NL80211_RRF_PASSIVE_SCAN)
  37 #define ATH9K_2GHZ_CH14         REG_RULE(2484-10, 2484+10, 40, 0, 20,\
  38                                 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_OFDM)
  39
  40 /* We allow IBSS on these on a case by case basis by regulatory domain */
  41 #define ATH9K_5GHZ_5150_5350    REG_RULE(5150-10, 5350+10, 40, 0, 30,\
  42                                 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_IBSS)
  43 #define ATH9K_5GHZ_5470_5850    REG_RULE(5470-10, 5850+10, 40, 0, 30,\
  44                                 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_IBSS)
  45 #define ATH9K_5GHZ_5725_5850    REG_RULE(5725-10, 5850+10, 40, 0, 30,\
  46                                 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_IBSS)
  47
  48 #define ATH9K_2GHZ_ALL          ATH9K_2GHZ_CH01_11, \
  49                                 ATH9K_2GHZ_CH12_13, \
  50                                 ATH9K_2GHZ_CH14
  51
  52 #define ATH9K_5GHZ_ALL          ATH9K_5GHZ_5150_5350, \
  53                                 ATH9K_5GHZ_5470_5850
  54 /* This one skips what we call "mid band" */
  55 #define ATH9K_5GHZ_NO_MIDBAND   ATH9K_5GHZ_5150_5350, \
  56                                 ATH9K_5GHZ_5725_5850
  57
  58 /* Can be used for:
  59  * 0x60, 0x61, 0x62 */
  60 static const struct ieee80211_regdomain ath_world_regdom_60_61_62 = {
  61         .n_reg_rules = 5,
  62         .alpha2 =  "99",
  63         .reg_rules = {
  64                 ATH9K_2GHZ_ALL,
  65                 ATH9K_5GHZ_ALL,
  66         }
  67 };
  68
  69 /* Can be used by 0x63 and 0x65 */
  70 static const struct ieee80211_regdomain ath_world_regdom_63_65 = {
  71         .n_reg_rules = 4,
  72         .alpha2 =  "99",
  73         .reg_rules = {
  74                 ATH9K_2GHZ_CH01_11,
  75                 ATH9K_2GHZ_CH12_13,
  76                 ATH9K_5GHZ_NO_MIDBAND,
  77         }
  78 };
  79
  80 /* Can be used by 0x64 only */
  81 static const struct ieee80211_regdomain ath_world_regdom_64 = {
  82         .n_reg_rules = 3,
  83         .alpha2 =  "99",
  84         .reg_rules = {
  85                 ATH9K_2GHZ_CH01_11,
  86                 ATH9K_5GHZ_NO_MIDBAND,
  87         }
  88 };
  89
  90 /* Can be used by 0x66 and 0x69 */
  91 static const struct ieee80211_regdomain ath_world_regdom_66_69 = {
  92         .n_reg_rules = 3,
  93         .alpha2 =  "99",
  94         .reg_rules = {
  95                 ATH9K_2GHZ_CH01_11,
  96                 ATH9K_5GHZ_ALL,
  97         }
  98 };
  99
 100 /* Can be used by 0x67, 0x6A and 0x68 */
 101 static const struct ieee80211_regdomain ath_world_regdom_67_68_6A = {
 102         .n_reg_rules = 4,
 103         .alpha2 =  "99",
 104         .reg_rules = {
 105                 ATH9K_2GHZ_CH01_11,
 106                 ATH9K_2GHZ_CH12_13,
 107                 ATH9K_5GHZ_ALL,
 108         }
 109 };
 110
 111 static inline bool is_wwr_sku(u16 regd)
 112 {
 113         return ((regd & COUNTRY_ERD_FLAG) != COUNTRY_ERD_FLAG) &&
 114                 (((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,
 205                                                   ch->center_freq,
 206                                                   bandwidth,
 207                                                   &reg_rule);
 208                                 if (r)
 209                                         continue;
 210                                 /*
 211                                  * If 11d had a rule for this channel ensure
 212                                  * we enable adhoc/beaconing if it allows us to
 213                                  * use it. Note that we would have disabled it
 214                                  * by applying our static world regdomain by
 215                                  * default during init, prior to calling our
 216                                  * regulatory_hint().
 217                                  */
 218                                 if (!(reg_rule->flags &
 219                                     NL80211_RRF_NO_IBSS))
 220                                         ch->flags &=
 221                                           ~IEEE80211_CHAN_NO_IBSS;
 222                                 if (!(reg_rule->flags &
 223                                     NL80211_RRF_PASSIVE_SCAN))
 224                                         ch->flags &=
 225                                           ~IEEE80211_CHAN_PASSIVE_SCAN;
 226                         } else {
 227                                 if (ch->beacon_found)
 228                                         ch->flags &= ~(IEEE80211_CHAN_NO_IBSS |
 229                                           IEEE80211_CHAN_PASSIVE_SCAN);
 230                         }
 231                 }
 232         }
 233
 234 }
 235
 236 /* Allows active scan scan on Ch 12 and 13 */
 237 static void
 238 ath_reg_apply_active_scan_flags(struct wiphy *wiphy,
 239                                 enum nl80211_reg_initiator initiator)
 240 {
 241         struct ieee80211_supported_band *sband;
 242         struct ieee80211_channel *ch;
 243         const struct ieee80211_reg_rule *reg_rule;
 244         u32 bandwidth = 0;
 245         int r;
 246
 247         sband = wiphy->bands[IEEE80211_BAND_2GHZ];
 248
 249         /*
 250          * If no country IE has been received always enable active scan
 251          * on these channels. This is only done for specific regulatory SKUs
 252          */
 253         if (initiator != NL80211_REGDOM_SET_BY_COUNTRY_IE) {
 254                 ch = &sband->channels[11]; /* CH 12 */
 255                 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 256                         ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 257                 ch = &sband->channels[12]; /* CH 13 */
 258                 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 259                         ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 260                 return;
 261         }
 262
 263         /*
 264          * If a country IE has been recieved check its rule for this
 265          * channel first before enabling active scan. The passive scan
 266          * would have been enforced by the initial processing of our
 267          * custom regulatory domain.
 268          */
 269
 270         ch = &sband->channels[11]; /* CH 12 */
 271         r = freq_reg_info(wiphy, ch->center_freq, bandwidth, &reg_rule);
 272         if (!r) {
 273                 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
 274                         if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 275                                 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 276         }
 277
 278         ch = &sband->channels[12]; /* CH 13 */
 279         r = freq_reg_info(wiphy, ch->center_freq, bandwidth, &reg_rule);
 280         if (!r) {
 281                 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
 282                         if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 283                                 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 284         }
 285 }
 286
 287 /* Always apply Radar/DFS rules on freq range 5260 MHz - 5700 MHz */
 288 static void ath_reg_apply_radar_flags(struct wiphy *wiphy)
 289 {
 290         struct ieee80211_supported_band *sband;
 291         struct ieee80211_channel *ch;
 292         unsigned int i;
 293
 294         if (!wiphy->bands[IEEE80211_BAND_5GHZ])
 295                 return;
 296
 297         sband = wiphy->bands[IEEE80211_BAND_5GHZ];
 298
 299         for (i = 0; i < sband->n_channels; i++) {
 300                 ch = &sband->channels[i];
 301                 if (!ath_is_radar_freq(ch->center_freq))
 302                         continue;
 303                 /* We always enable radar detection/DFS on this
 304                  * frequency range. Additionally we also apply on
 305                  * this frequency range:
 306                  * - If STA mode does not yet have DFS supports disable
 307                  *   active scanning
 308                  * - If adhoc mode does not support DFS yet then
 309                  *   disable adhoc in the frequency.
 310                  * - If AP mode does not yet support radar detection/DFS
 311                  *   do not allow AP mode
 312                  */
 313                 if (!(ch->flags & IEEE80211_CHAN_DISABLED))
 314                         ch->flags |= IEEE80211_CHAN_RADAR |
 315                                      IEEE80211_CHAN_NO_IBSS |
 316                                      IEEE80211_CHAN_PASSIVE_SCAN;
 317         }
 318 }
 319
 320 static void ath_reg_apply_world_flags(struct wiphy *wiphy,
 321                                       enum nl80211_reg_initiator initiator,
 322                                       struct ath_regulatory *reg)
 323 {
 324         switch (reg->regpair->regDmnEnum) {
 325         case 0x60:
 326         case 0x63:
 327         case 0x66:
 328         case 0x67:
 329                 ath_reg_apply_beaconing_flags(wiphy, initiator);
 330                 break;
 331         case 0x68:
 332                 ath_reg_apply_beaconing_flags(wiphy, initiator);
 333                 ath_reg_apply_active_scan_flags(wiphy, initiator);
 334                 break;
 335         }
 336         return;
 337 }
 338
 339 int ath_reg_notifier_apply(struct wiphy *wiphy,
 340                            struct regulatory_request *request,
 341                            struct ath_regulatory *reg)
 342 {
 343         /* We always apply this */
 344         ath_reg_apply_radar_flags(wiphy);
 345
 346         switch (request->initiator) {
 347         case NL80211_REGDOM_SET_BY_DRIVER:
 348         case NL80211_REGDOM_SET_BY_CORE:
 349         case NL80211_REGDOM_SET_BY_USER:
 350                 break;
 351         case NL80211_REGDOM_SET_BY_COUNTRY_IE:
 352                 if (ath_is_world_regd(reg))
 353                         ath_reg_apply_world_flags(wiphy, request->initiator,
 354                                                   reg);
 355                 break;
 356         }
 357
 358         return 0;
 359 }
 360 EXPORT_SYMBOL(ath_reg_notifier_apply);
 361
 362 static bool ath_regd_is_eeprom_valid(struct ath_regulatory *reg)
 363 {
 364          u16 rd = ath_regd_get_eepromRD(reg);
 365         int i;
 366
 367         if (rd & COUNTRY_ERD_FLAG) {
 368                 /* EEPROM value is a country code */
 369                 u16 cc = rd & ~COUNTRY_ERD_FLAG;
 370                 printk(KERN_DEBUG
 371                        "ath: EEPROM indicates we should expect "
 372                         "a country code\n");
 373                 for (i = 0; i < ARRAY_SIZE(allCountries); i++)
 374                         if (allCountries[i].countryCode == cc)
 375                                 return true;
 376         } else {
 377                 /* EEPROM value is a regpair value */
 378                 if (rd != CTRY_DEFAULT)
 379                         printk(KERN_DEBUG "ath: EEPROM indicates we "
 380                                "should expect a direct regpair map\n");
 381                 for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++)
 382                         if (regDomainPairs[i].regDmnEnum == rd)
 383                                 return true;
 384         }
 385         printk(KERN_DEBUG
 386                  "ath: invalid regulatory domain/country code 0x%x\n", rd);
 387         return false;
 388 }
 389
 390 /* EEPROM country code to regpair mapping */
 391 static struct country_code_to_enum_rd*
 392 ath_regd_find_country(u16 countryCode)
 393 {
 394         int i;
 395
 396         for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
 397                 if (allCountries[i].countryCode == countryCode)
 398                         return &allCountries[i];
 399         }
 400         return NULL;
 401 }
 402
 403 /* EEPROM rd code to regpair mapping */
 404 static struct country_code_to_enum_rd*
 405 ath_regd_find_country_by_rd(int regdmn)
 406 {
 407         int i;
 408
 409         for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
 410                 if (allCountries[i].regDmnEnum == regdmn)
 411                         return &allCountries[i];
 412         }
 413         return NULL;
 414 }
 415
 416 /* Returns the map of the EEPROM set RD to a country code */
 417 static u16 ath_regd_get_default_country(u16 rd)
 418 {
 419         if (rd & COUNTRY_ERD_FLAG) {
 420                 struct country_code_to_enum_rd *country = NULL;
 421                 u16 cc = rd & ~COUNTRY_ERD_FLAG;
 422
 423                 country = ath_regd_find_country(cc);
 424                 if (country != NULL)
 425                         return cc;
 426         }
 427
 428         return CTRY_DEFAULT;
 429 }
 430
 431 static struct reg_dmn_pair_mapping*
 432 ath_get_regpair(int regdmn)
 433 {
 434         int i;
 435
 436         if (regdmn == NO_ENUMRD)
 437                 return NULL;
 438         for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++) {
 439                 if (regDomainPairs[i].regDmnEnum == regdmn)
 440                         return &regDomainPairs[i];
 441         }
 442         return NULL;
 443 }
 444
 445 static int
 446 ath_regd_init_wiphy(struct ath_regulatory *reg,
 447                     struct wiphy *wiphy,
 448                     int (*reg_notifier)(struct wiphy *wiphy,
 449                                         struct regulatory_request *request))
 450 {
 451         const struct ieee80211_regdomain *regd;
 452
 453         wiphy->reg_notifier = reg_notifier;
 454         wiphy->flags |= WIPHY_FLAG_STRICT_REGULATORY;
 455
 456         if (ath_is_world_regd(reg)) {
 457                 /*
 458                  * Anything applied here (prior to wiphy registration) gets
 459                  * saved on the wiphy orig_* parameters
 460                  */
 461                 regd = ath_world_regdomain(reg);
 462                 wiphy->flags |= WIPHY_FLAG_CUSTOM_REGULATORY;
 463         } else {
 464                 /*
 465                  * This gets applied in the case of the absense of CRDA,
 466                  * it's our own custom world regulatory domain, similar to
 467                  * cfg80211's but we enable passive scanning.
 468                  */
 469                 regd = ath_default_world_regdomain();
 470         }
 471         wiphy_apply_custom_regulatory(wiphy, regd);
 472         ath_reg_apply_radar_flags(wiphy);
 473         ath_reg_apply_world_flags(wiphy, NL80211_REGDOM_SET_BY_DRIVER, reg);
 474         return 0;
 475 }
 476
 477 /*
 478  * Some users have reported their EEPROM programmed with
 479  * 0x8000 set, this is not a supported regulatory domain
 480  * but since we have more than one user with it we need
 481  * a solution for them. We default to 0x64, which is the
 482  * default Atheros world regulatory domain.
 483  */
 484 static void ath_regd_sanitize(struct ath_regulatory *reg)
 485 {
 486         if (reg->current_rd != COUNTRY_ERD_FLAG)
 487                 return;
 488         printk(KERN_DEBUG "ath: EEPROM regdomain sanitized\n");
 489         reg->current_rd = 0x64;
 490 }
 491
 492 int
 493 ath_regd_init(struct ath_regulatory *reg,
 494               struct wiphy *wiphy,
 495               int (*reg_notifier)(struct wiphy *wiphy,
 496                                   struct regulatory_request *request))
 497 {
 498         struct country_code_to_enum_rd *country = NULL;
 499         u16 regdmn;
 500
 501         if (!reg)
 502                 return -EINVAL;
 503
 504         ath_regd_sanitize(reg);
 505
 506         printk(KERN_DEBUG "ath: EEPROM regdomain: 0x%0x\n", reg->current_rd);
 507
 508         if (!ath_regd_is_eeprom_valid(reg)) {
 509                 printk(KERN_ERR "ath: Invalid EEPROM contents\n");
 510                 return -EINVAL;
 511         }
 512
 513         regdmn = ath_regd_get_eepromRD(reg);
 514         reg->country_code = ath_regd_get_default_country(regdmn);
 515
 516         if (reg->country_code == CTRY_DEFAULT &&
 517             regdmn == CTRY_DEFAULT) {
 518                 printk(KERN_DEBUG "ath: EEPROM indicates default "
 519                        "country code should be used\n");
 520                 reg->country_code = CTRY_UNITED_STATES;
 521         }
 522
 523         if (reg->country_code == CTRY_DEFAULT) {
 524                 country = NULL;
 525         } else {
 526                 printk(KERN_DEBUG "ath: doing EEPROM country->regdmn "
 527                        "map search\n");
 528                 country = ath_regd_find_country(reg->country_code);
 529                 if (country == NULL) {
 530                         printk(KERN_DEBUG
 531                                 "ath: no valid country maps found for "
 532                                 "country code: 0x%0x\n",
 533                                 reg->country_code);
 534                         return -EINVAL;
 535                 } else {
 536                         regdmn = country->regDmnEnum;
 537                         printk(KERN_DEBUG "ath: country maps to "
 538                                "regdmn code: 0x%0x\n",
 539                                regdmn);
 540                 }
 541         }
 542
 543         reg->regpair = ath_get_regpair(regdmn);
 544
 545         if (!reg->regpair) {
 546                 printk(KERN_DEBUG "ath: "
 547                         "No regulatory domain pair found, cannot continue\n");
 548                 return -EINVAL;
 549         }
 550
 551         if (!country)
 552                 country = ath_regd_find_country_by_rd(regdmn);
 553
 554         if (country) {
 555                 reg->alpha2[0] = country->isoName[0];
 556                 reg->alpha2[1] = country->isoName[1];
 557         } else {
 558                 reg->alpha2[0] = '0';
 559                 reg->alpha2[1] = '0';
 560         }
 561
 562         printk(KERN_DEBUG "ath: Country alpha2 being used: %c%c\n",
 563                 reg->alpha2[0], reg->alpha2[1]);
 564         printk(KERN_DEBUG "ath: Regpair used: 0x%0x\n",
 565                 reg->regpair->regDmnEnum);
 566
 567         ath_regd_init_wiphy(reg, wiphy, reg_notifier);
 568         return 0;
 569 }
 570 EXPORT_SYMBOL(ath_regd_init);
 571
 572 u32 ath_regd_get_band_ctl(struct ath_regulatory *reg,
 573                           enum ieee80211_band band)
 574 {
 575         if (!reg->regpair ||
 576             (reg->country_code == CTRY_DEFAULT &&
 577              is_wwr_sku(ath_regd_get_eepromRD(reg)))) {
 578                 return SD_NO_CTL;
 579         }
 580
 581         switch (band) {
 582         case IEEE80211_BAND_2GHZ:
 583                 return reg->regpair->reg_2ghz_ctl;
 584         case IEEE80211_BAND_5GHZ:
 585                 return reg->regpair->reg_5ghz_ctl;
 586         default:
 587                 return NO_CTL;
 588         }
 589 }
 590 EXPORT_SYMBOL(ath_regd_get_band_ctl);