drivers/net/wireless/ath9k/regd.c

   1 /*
   2  * Copyright (c) 2008 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 "ath9k.h"
  20 #include "regd_common.h"
  21
  22 /*
  23  * This is a set of common rules used by our world regulatory domains.
  24  * We have 12 world regulatory domains. To save space we consolidate
  25  * the regulatory domains in 5 structures by frequency and change
  26  * the flags on our reg_notifier() on a case by case basis.
  27  */
  28
  29 /* Only these channels all allow active scan on all world regulatory domains */
  30 #define ATH9K_2GHZ_CH01_11      REG_RULE(2412-10, 2462+10, 40, 0, 20, 0)
  31
  32 /* We enable active scan on these a case by case basis by regulatory domain */
  33 #define ATH9K_2GHZ_CH12_13      REG_RULE(2467-10, 2472+10, 40, 0, 20,\
  34                                         NL80211_RRF_PASSIVE_SCAN)
  35 #define ATH9K_2GHZ_CH14         REG_RULE(2484-10, 2484+10, 40, 0, 20,\
  36                                 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_OFDM)
  37
  38 /* We allow IBSS on these on a case by case basis by regulatory domain */
  39 #define ATH9K_5GHZ_5150_5350    REG_RULE(5150-10, 5350+10, 40, 0, 30,\
  40                                 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_IBSS)
  41 #define ATH9K_5GHZ_5470_5850    REG_RULE(5470-10, 5850+10, 40, 0, 30,\
  42                                 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_IBSS)
  43 #define ATH9K_5GHZ_5725_5850    REG_RULE(5725-10, 5850+10, 40, 0, 30,\
  44                                 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_IBSS)
  45
  46 #define ATH9K_2GHZ_ALL          ATH9K_2GHZ_CH01_11, \
  47                                 ATH9K_2GHZ_CH12_13, \
  48                                 ATH9K_2GHZ_CH14
  49
  50 #define ATH9K_5GHZ_ALL          ATH9K_5GHZ_5150_5350, \
  51                                 ATH9K_5GHZ_5470_5850
  52 /* This one skips what we call "mid band" */
  53 #define ATH9K_5GHZ_NO_MIDBAND   ATH9K_5GHZ_5150_5350, \
  54                                 ATH9K_5GHZ_5725_5850
  55
  56 /* Can be used for:
  57  * 0x60, 0x61, 0x62 */
  58 static const struct ieee80211_regdomain ath9k_world_regdom_60_61_62 = {
  59         .n_reg_rules = 5,
  60         .alpha2 =  "99",
  61         .reg_rules = {
  62                 ATH9K_2GHZ_ALL,
  63                 ATH9K_5GHZ_ALL,
  64         }
  65 };
  66
  67 /* Can be used by 0x63 and 0x65 */
  68 static const struct ieee80211_regdomain ath9k_world_regdom_63_65 = {
  69         .n_reg_rules = 4,
  70         .alpha2 =  "99",
  71         .reg_rules = {
  72                 ATH9K_2GHZ_CH01_11,
  73                 ATH9K_2GHZ_CH12_13,
  74                 ATH9K_5GHZ_NO_MIDBAND,
  75         }
  76 };
  77
  78 /* Can be used by 0x64 only */
  79 static const struct ieee80211_regdomain ath9k_world_regdom_64 = {
  80         .n_reg_rules = 3,
  81         .alpha2 =  "99",
  82         .reg_rules = {
  83                 ATH9K_2GHZ_CH01_11,
  84                 ATH9K_5GHZ_NO_MIDBAND,
  85         }
  86 };
  87
  88 /* Can be used by 0x66 and 0x69 */
  89 static const struct ieee80211_regdomain ath9k_world_regdom_66_69 = {
  90         .n_reg_rules = 3,
  91         .alpha2 =  "99",
  92         .reg_rules = {
  93                 ATH9K_2GHZ_CH01_11,
  94                 ATH9K_5GHZ_ALL,
  95         }
  96 };
  97
  98 /* Can be used by 0x67, 0x6A and 0x68 */
  99 static const struct ieee80211_regdomain ath9k_world_regdom_67_68_6A = {
 100         .n_reg_rules = 4,
 101         .alpha2 =  "99",
 102         .reg_rules = {
 103                 ATH9K_2GHZ_CH01_11,
 104                 ATH9K_2GHZ_CH12_13,
 105                 ATH9K_5GHZ_ALL,
 106         }
 107 };
 108
 109 static inline bool is_wwr_sku(u16 regd)
 110 {
 111         return ((regd & WORLD_SKU_MASK) == WORLD_SKU_PREFIX) ||
 112                 (regd == WORLD);
 113 }
 114
 115 static u16 ath9k_regd_get_eepromRD(struct ath_hw *ah)
 116 {
 117         return ah->regulatory.current_rd & ~WORLDWIDE_ROAMING_FLAG;
 118 }
 119
 120 bool ath9k_is_world_regd(struct ath_hw *ah)
 121 {
 122         return is_wwr_sku(ath9k_regd_get_eepromRD(ah));
 123 }
 124
 125 const struct ieee80211_regdomain *ath9k_default_world_regdomain(void)
 126 {
 127         /* this is the most restrictive */
 128         return &ath9k_world_regdom_64;
 129 }
 130
 131 const struct ieee80211_regdomain *ath9k_world_regdomain(struct ath_hw *ah)
 132 {
 133         switch (ah->regulatory.regpair->regDmnEnum) {
 134         case 0x60:
 135         case 0x61:
 136         case 0x62:
 137                 return &ath9k_world_regdom_60_61_62;
 138         case 0x63:
 139         case 0x65:
 140                 return &ath9k_world_regdom_63_65;
 141         case 0x64:
 142                 return &ath9k_world_regdom_64;
 143         case 0x66:
 144         case 0x69:
 145                 return &ath9k_world_regdom_66_69;
 146         case 0x67:
 147         case 0x68:
 148         case 0x6A:
 149                 return &ath9k_world_regdom_67_68_6A;
 150         default:
 151                 WARN_ON(1);
 152                 return ath9k_default_world_regdomain();
 153         }
 154 }
 155
 156 /* Frequency is one where radar detection is required */
 157 static bool ath9k_is_radar_freq(u16 center_freq)
 158 {
 159         return (center_freq >= 5260 && center_freq <= 5700);
 160 }
 161
 162 /*
 163  * Enable adhoc on 5 GHz if allowed by 11d.
 164  * Remove passive scan if channel is allowed by 11d,
 165  * except when on radar frequencies.
 166  */
 167 static void ath9k_reg_apply_5ghz_beaconing_flags(struct wiphy *wiphy,
 168                                              enum reg_set_by setby)
 169 {
 170         struct ieee80211_supported_band *sband;
 171         const struct ieee80211_reg_rule *reg_rule;
 172         struct ieee80211_channel *ch;
 173         unsigned int i;
 174         u32 bandwidth = 0;
 175         int r;
 176
 177         if (setby != REGDOM_SET_BY_COUNTRY_IE)
 178                 return;
 179         if (!wiphy->bands[IEEE80211_BAND_5GHZ])
 180                 return;
 181
 182         sband = wiphy->bands[IEEE80211_BAND_5GHZ];
 183         for (i = 0; i < sband->n_channels; i++) {
 184                 ch = &sband->channels[i];
 185                 r = freq_reg_info(wiphy, ch->center_freq,
 186                         &bandwidth, &reg_rule);
 187                 if (r)
 188                         continue;
 189                 /* If 11d had a rule for this channel ensure we enable adhoc
 190                  * if it allows us to use it. Note that we would have disabled
 191                  * it by applying our static world regdomain by default during
 192                  * probe */
 193                 if (!(reg_rule->flags & NL80211_RRF_NO_IBSS))
 194                         ch->flags &= ~IEEE80211_CHAN_NO_IBSS;
 195                 if (!ath9k_is_radar_freq(ch->center_freq))
 196                         continue;
 197                 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
 198                         ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 199         }
 200 }
 201
 202 /* Allows active scan scan on Ch 12 and 13 */
 203 static void ath9k_reg_apply_active_scan_flags(struct wiphy *wiphy,
 204                                               enum reg_set_by setby)
 205 {
 206         struct ieee80211_supported_band *sband;
 207         struct ieee80211_channel *ch;
 208         const struct ieee80211_reg_rule *reg_rule;
 209         u32 bandwidth = 0;
 210         int r;
 211
 212         /* Force passive scan on Channels 12-13 */
 213         sband = wiphy->bands[IEEE80211_BAND_2GHZ];
 214
 215         /* If no country IE has been received always enable active scan
 216          * on these channels */
 217         if (setby != REGDOM_SET_BY_COUNTRY_IE) {
 218                 ch = &sband->channels[11]; /* CH 12 */
 219                 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 220                         ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 221                 ch = &sband->channels[12]; /* CH 13 */
 222                 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 223                         ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 224                 return;
 225         }
 226
 227         /* If a country IE has been recieved check its rule for this
 228          * channel first before enabling active scan. The passive scan
 229          * would have been enforced by the initial probe processing on
 230          * our custom regulatory domain. */
 231
 232         ch = &sband->channels[11]; /* CH 12 */
 233         r = freq_reg_info(wiphy, ch->center_freq, &bandwidth, &reg_rule);
 234         if (!r) {
 235                 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
 236                         if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 237                                 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 238         }
 239
 240         ch = &sband->channels[12]; /* CH 13 */
 241         r = freq_reg_info(wiphy, ch->center_freq, &bandwidth, &reg_rule);
 242         if (!r) {
 243                 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
 244                         if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 245                                 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 246         }
 247 }
 248
 249 /* Always apply Radar/DFS rules on freq range 5260 MHz - 5700 MHz */
 250 void ath9k_reg_apply_radar_flags(struct wiphy *wiphy)
 251 {
 252         struct ieee80211_supported_band *sband;
 253         struct ieee80211_channel *ch;
 254         unsigned int i;
 255
 256         if (!wiphy->bands[IEEE80211_BAND_5GHZ])
 257                 return;
 258
 259         sband = wiphy->bands[IEEE80211_BAND_5GHZ];
 260
 261         for (i = 0; i < sband->n_channels; i++) {
 262                 ch = &sband->channels[i];
 263                 if (!ath9k_is_radar_freq(ch->center_freq))
 264                         continue;
 265                 /* We always enable radar detection/DFS on this
 266                  * frequency range. Additionally we also apply on
 267                  * this frequency range:
 268                  * - If STA mode does not yet have DFS supports disable
 269                  *   active scanning
 270                  * - If adhoc mode does not support DFS yet then
 271                  *   disable adhoc in the frequency.
 272                  * - If AP mode does not yet support radar detection/DFS
 273                  *   do not allow AP mode
 274                  */
 275                 if (!(ch->flags & IEEE80211_CHAN_DISABLED))
 276                         ch->flags |= IEEE80211_CHAN_RADAR |
 277                                      IEEE80211_CHAN_NO_IBSS |
 278                                      IEEE80211_CHAN_PASSIVE_SCAN;
 279         }
 280 }
 281
 282 void ath9k_reg_apply_world_flags(struct wiphy *wiphy, enum reg_set_by setby)
 283 {
 284         struct ieee80211_hw *hw = wiphy_to_ieee80211_hw(wiphy);
 285         struct ath_softc *sc = hw->priv;
 286         struct ath_hw *ah = sc->sc_ah;
 287
 288         switch (ah->regulatory.regpair->regDmnEnum) {
 289         case 0x60:
 290         case 0x63:
 291         case 0x66:
 292         case 0x67:
 293                 ath9k_reg_apply_5ghz_beaconing_flags(wiphy, setby);
 294                 break;
 295         case 0x68:
 296                 ath9k_reg_apply_5ghz_beaconing_flags(wiphy, setby);
 297                 ath9k_reg_apply_active_scan_flags(wiphy, setby);
 298                 break;
 299         }
 300         return;
 301 }
 302
 303 int ath9k_reg_notifier(struct wiphy *wiphy, struct regulatory_request *request)
 304 {
 305         struct ieee80211_hw *hw = wiphy_to_ieee80211_hw(wiphy);
 306         struct ath_softc *sc = hw->priv;
 307
 308         /* We always apply this */
 309         ath9k_reg_apply_radar_flags(wiphy);
 310
 311         switch (request->initiator) {
 312         case REGDOM_SET_BY_DRIVER:
 313         case REGDOM_SET_BY_INIT:
 314         case REGDOM_SET_BY_CORE:
 315         case REGDOM_SET_BY_USER:
 316                 break;
 317         case REGDOM_SET_BY_COUNTRY_IE:
 318                 if (ath9k_is_world_regd(sc->sc_ah))
 319                         ath9k_reg_apply_world_flags(wiphy, request->initiator);
 320                 break;
 321         }
 322
 323         return 0;
 324 }
 325
 326 bool ath9k_regd_is_eeprom_valid(struct ath_hw *ah)
 327 {
 328         u16 rd = ath9k_regd_get_eepromRD(ah);
 329         int i;
 330
 331         if (rd & COUNTRY_ERD_FLAG) {
 332                 /* EEPROM value is a country code */
 333                 u16 cc = rd & ~COUNTRY_ERD_FLAG;
 334                 for (i = 0; i < ARRAY_SIZE(allCountries); i++)
 335                         if (allCountries[i].countryCode == cc)
 336                                 return true;
 337         } else {
 338                 /* EEPROM value is a regpair value */
 339                 for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++)
 340                         if (regDomainPairs[i].regDmnEnum == rd)
 341                                 return true;
 342         }
 343         DPRINTF(ah->ah_sc, ATH_DBG_REGULATORY,
 344                  "invalid regulatory domain/country code 0x%x\n", rd);
 345         return false;
 346 }
 347
 348 /* EEPROM country code to regpair mapping */
 349 static struct country_code_to_enum_rd*
 350 ath9k_regd_find_country(u16 countryCode)
 351 {
 352         int i;
 353
 354         for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
 355                 if (allCountries[i].countryCode == countryCode)
 356                         return &allCountries[i];
 357         }
 358         return NULL;
 359 }
 360
 361 /* EEPROM rd code to regpair mapping */
 362 static struct country_code_to_enum_rd*
 363 ath9k_regd_find_country_by_rd(int regdmn)
 364 {
 365         int i;
 366
 367         for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
 368                 if (allCountries[i].regDmnEnum == regdmn)
 369                         return &allCountries[i];
 370         }
 371         return NULL;
 372 }
 373
 374 /* Returns the map of the EEPROM set RD to a country code */
 375 static u16 ath9k_regd_get_default_country(u16 rd)
 376 {
 377         if (rd & COUNTRY_ERD_FLAG) {
 378                 struct country_code_to_enum_rd *country = NULL;
 379                 u16 cc = rd & ~COUNTRY_ERD_FLAG;
 380
 381                 country = ath9k_regd_find_country(cc);
 382                 if (country != NULL)
 383                         return cc;
 384         }
 385
 386         return CTRY_DEFAULT;
 387 }
 388
 389 static struct reg_dmn_pair_mapping*
 390 ath9k_get_regpair(int regdmn)
 391 {
 392         int i;
 393
 394         if (regdmn == NO_ENUMRD)
 395                 return NULL;
 396         for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++) {
 397                 if (regDomainPairs[i].regDmnEnum == regdmn)
 398                         return &regDomainPairs[i];
 399         }
 400         return NULL;
 401 }
 402
 403 int ath9k_regd_init(struct ath_hw *ah)
 404 {
 405         struct country_code_to_enum_rd *country = NULL;
 406         u16 regdmn;
 407
 408         if (!ath9k_regd_is_eeprom_valid(ah)) {
 409                 DPRINTF(ah->ah_sc, ATH_DBG_REGULATORY,
 410                         "Invalid EEPROM contents\n");
 411                 return -EINVAL;
 412         }
 413
 414         regdmn = ath9k_regd_get_eepromRD(ah);
 415         ah->regulatory.country_code = ath9k_regd_get_default_country(regdmn);
 416
 417         if (ah->regulatory.country_code == CTRY_DEFAULT &&
 418             regdmn == CTRY_DEFAULT)
 419                 ah->regulatory.country_code = CTRY_UNITED_STATES;
 420
 421         if (ah->regulatory.country_code == CTRY_DEFAULT) {
 422                 country = NULL;
 423         } else {
 424                 country = ath9k_regd_find_country(ah->regulatory.country_code);
 425                 if (country == NULL) {
 426                         DPRINTF(ah->ah_sc, ATH_DBG_REGULATORY,
 427                                 "Country is NULL!!!!, cc= %d\n",
 428                                 ah->regulatory.country_code);
 429                         return -EINVAL;
 430                 } else
 431                         regdmn = country->regDmnEnum;
 432         }
 433
 434         ah->regulatory.regpair = ath9k_get_regpair(regdmn);
 435
 436         if (!ah->regulatory.regpair) {
 437                 DPRINTF(ah->ah_sc, ATH_DBG_FATAL,
 438                         "No regulatory domain pair found, cannot continue\n");
 439                 return -EINVAL;
 440         }
 441
 442         if (!country)
 443                 country = ath9k_regd_find_country_by_rd(regdmn);
 444
 445         if (country) {
 446                 ah->regulatory.alpha2[0] = country->isoName[0];
 447                 ah->regulatory.alpha2[1] = country->isoName[1];
 448         } else {
 449                 ah->regulatory.alpha2[0] = '0';
 450                 ah->regulatory.alpha2[1] = '0';
 451         }
 452
 453         DPRINTF(ah->ah_sc, ATH_DBG_REGULATORY,
 454                 "Country alpha2 being used: %c%c\n"
 455                 "Regulatory.Regpair detected: 0x%0x\n",
 456                 ah->regulatory.alpha2[0], ah->regulatory.alpha2[1],
 457                 ah->regulatory.regpair->regDmnEnum);
 458
 459         return 0;
 460 }
 461
 462 u32 ath9k_regd_get_ctl(struct ath_hw *ah, struct ath9k_channel *chan)
 463 {
 464         u32 ctl = NO_CTL;
 465
 466         if (!ah->regulatory.regpair ||
 467             (ah->regulatory.country_code == CTRY_DEFAULT &&
 468              is_wwr_sku(ath9k_regd_get_eepromRD(ah)))) {
 469                 if (IS_CHAN_B(chan))
 470                         ctl = SD_NO_CTL | CTL_11B;
 471                 else if (IS_CHAN_G(chan))
 472                         ctl = SD_NO_CTL | CTL_11G;
 473                 else
 474                         ctl = SD_NO_CTL | CTL_11A;
 475                 return ctl;
 476         }
 477
 478         if (IS_CHAN_B(chan))
 479                 ctl = ah->regulatory.regpair->reg_2ghz_ctl | CTL_11B;
 480         else if (IS_CHAN_G(chan))
 481                 ctl = ah->regulatory.regpair->reg_5ghz_ctl | CTL_11G;
 482         else
 483                 ctl = ah->regulatory.regpair->reg_5ghz_ctl | CTL_11A;
 484
 485         return ctl;
 486 }