SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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  * N.B: These exception rules do not apply radar freqs.
 164  *
 165  * - We enable adhoc (or beaconing) if allowed by 11d
 166  * - We enable active scan if the channel is allowed by 11d
 167  * - If no country IE has been processed and a we determine we have
 168  *   received a beacon on a channel we can enable active scan and
 169  *   adhoc (or beaconing).
 170  */
 171 static void ath9k_reg_apply_beaconing_flags(struct wiphy *wiphy,
 172                                              enum reg_set_by setby)
 173 {
 174         enum ieee80211_band band;
 175         struct ieee80211_supported_band *sband;
 176         const struct ieee80211_reg_rule *reg_rule;
 177         struct ieee80211_channel *ch;
 178         unsigned int i;
 179         u32 bandwidth = 0;
 180         int r;
 181
 182         for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
 183
 184                 if (!wiphy->bands[band])
 185                         continue;
 186
 187                 sband = wiphy->bands[band];
 188
 189                 for (i = 0; i < sband->n_channels; i++) {
 190
 191                         ch = &sband->channels[i];
 192
 193                         if (ath9k_is_radar_freq(ch->center_freq) ||
 194                             (ch->flags & IEEE80211_CHAN_RADAR))
 195                                 continue;
 196
 197                         if (setby == REGDOM_SET_BY_COUNTRY_IE) {
 198                                 r = freq_reg_info(wiphy, ch->center_freq,
 199                                         &bandwidth, &reg_rule);
 200                                 if (r)
 201                                         continue;
 202                                 /*
 203                                  * If 11d had a rule for this channel ensure
 204                                  * we enable adhoc/beaconing if it allows us to
 205                                  * use it. Note that we would have disabled it
 206                                  * by applying our static world regdomain by
 207                                  * default during init, prior to calling our
 208                                  * regulatory_hint().
 209                                  */
 210                                 if (!(reg_rule->flags &
 211                                     NL80211_RRF_NO_IBSS))
 212                                         ch->flags &=
 213                                           ~IEEE80211_CHAN_NO_IBSS;
 214                                 if (!(reg_rule->flags &
 215                                     NL80211_RRF_PASSIVE_SCAN))
 216                                         ch->flags &=
 217                                           ~IEEE80211_CHAN_PASSIVE_SCAN;
 218                         } else {
 219                                 if (ch->beacon_found)
 220                                         ch->flags &= ~(IEEE80211_CHAN_NO_IBSS |
 221                                           IEEE80211_CHAN_PASSIVE_SCAN);
 222                         }
 223                 }
 224         }
 225
 226 }
 227
 228 /* Allows active scan scan on Ch 12 and 13 */
 229 static void ath9k_reg_apply_active_scan_flags(struct wiphy *wiphy,
 230                                               enum reg_set_by setby)
 231 {
 232         struct ieee80211_supported_band *sband;
 233         struct ieee80211_channel *ch;
 234         const struct ieee80211_reg_rule *reg_rule;
 235         u32 bandwidth = 0;
 236         int r;
 237
 238         sband = wiphy->bands[IEEE80211_BAND_2GHZ];
 239
 240         /*
 241          * If no country IE has been received always enable active scan
 242          * on these channels. This is only done for specific regulatory SKUs
 243          */
 244         if (setby != REGDOM_SET_BY_COUNTRY_IE) {
 245                 ch = &sband->channels[11]; /* CH 12 */
 246                 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 247                         ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 248                 ch = &sband->channels[12]; /* CH 13 */
 249                 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 250                         ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 251                 return;
 252         }
 253
 254         /*
 255          * If a country IE has been recieved check its rule for this
 256          * channel first before enabling active scan. The passive scan
 257          * would have been enforced by the initial processing of our
 258          * custom regulatory domain.
 259          */
 260
 261         ch = &sband->channels[11]; /* CH 12 */
 262         r = freq_reg_info(wiphy, ch->center_freq, &bandwidth, &reg_rule);
 263         if (!r) {
 264                 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
 265                         if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 266                                 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 267         }
 268
 269         ch = &sband->channels[12]; /* CH 13 */
 270         r = freq_reg_info(wiphy, ch->center_freq, &bandwidth, &reg_rule);
 271         if (!r) {
 272                 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
 273                         if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 274                                 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 275         }
 276 }
 277
 278 /* Always apply Radar/DFS rules on freq range 5260 MHz - 5700 MHz */
 279 void ath9k_reg_apply_radar_flags(struct wiphy *wiphy)
 280 {
 281         struct ieee80211_supported_band *sband;
 282         struct ieee80211_channel *ch;
 283         unsigned int i;
 284
 285         if (!wiphy->bands[IEEE80211_BAND_5GHZ])
 286                 return;
 287
 288         sband = wiphy->bands[IEEE80211_BAND_5GHZ];
 289
 290         for (i = 0; i < sband->n_channels; i++) {
 291                 ch = &sband->channels[i];
 292                 if (!ath9k_is_radar_freq(ch->center_freq))
 293                         continue;
 294                 /* We always enable radar detection/DFS on this
 295                  * frequency range. Additionally we also apply on
 296                  * this frequency range:
 297                  * - If STA mode does not yet have DFS supports disable
 298                  *   active scanning
 299                  * - If adhoc mode does not support DFS yet then
 300                  *   disable adhoc in the frequency.
 301                  * - If AP mode does not yet support radar detection/DFS
 302                  *   do not allow AP mode
 303                  */
 304                 if (!(ch->flags & IEEE80211_CHAN_DISABLED))
 305                         ch->flags |= IEEE80211_CHAN_RADAR |
 306                                      IEEE80211_CHAN_NO_IBSS |
 307                                      IEEE80211_CHAN_PASSIVE_SCAN;
 308         }
 309 }
 310
 311 void ath9k_reg_apply_world_flags(struct wiphy *wiphy, enum reg_set_by setby)
 312 {
 313         struct ieee80211_hw *hw = wiphy_to_ieee80211_hw(wiphy);
 314         struct ath_softc *sc = hw->priv;
 315         struct ath_hw *ah = sc->sc_ah;
 316
 317         switch (ah->regulatory.regpair->regDmnEnum) {
 318         case 0x60:
 319         case 0x63:
 320         case 0x66:
 321         case 0x67:
 322                 ath9k_reg_apply_beaconing_flags(wiphy, setby);
 323                 break;
 324         case 0x68:
 325                 ath9k_reg_apply_beaconing_flags(wiphy, setby);
 326                 ath9k_reg_apply_active_scan_flags(wiphy, setby);
 327                 break;
 328         }
 329         return;
 330 }
 331
 332 int ath9k_reg_notifier(struct wiphy *wiphy, struct regulatory_request *request)
 333 {
 334         struct ieee80211_hw *hw = wiphy_to_ieee80211_hw(wiphy);
 335         struct ath_softc *sc = hw->priv;
 336
 337         /* We always apply this */
 338         ath9k_reg_apply_radar_flags(wiphy);
 339
 340         switch (request->initiator) {
 341         case REGDOM_SET_BY_DRIVER:
 342         case REGDOM_SET_BY_INIT:
 343         case REGDOM_SET_BY_CORE:
 344         case REGDOM_SET_BY_USER:
 345                 break;
 346         case REGDOM_SET_BY_COUNTRY_IE:
 347                 if (ath9k_is_world_regd(sc->sc_ah))
 348                         ath9k_reg_apply_world_flags(wiphy, request->initiator);
 349                 break;
 350         }
 351
 352         return 0;
 353 }
 354
 355 bool ath9k_regd_is_eeprom_valid(struct ath_hw *ah)
 356 {
 357         u16 rd = ath9k_regd_get_eepromRD(ah);
 358         int i;
 359
 360         if (rd & COUNTRY_ERD_FLAG) {
 361                 /* EEPROM value is a country code */
 362                 u16 cc = rd & ~COUNTRY_ERD_FLAG;
 363                 for (i = 0; i < ARRAY_SIZE(allCountries); i++)
 364                         if (allCountries[i].countryCode == cc)
 365                                 return true;
 366         } else {
 367                 /* EEPROM value is a regpair value */
 368                 for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++)
 369                         if (regDomainPairs[i].regDmnEnum == rd)
 370                                 return true;
 371         }
 372         DPRINTF(ah->ah_sc, ATH_DBG_REGULATORY,
 373                  "invalid regulatory domain/country code 0x%x\n", rd);
 374         return false;
 375 }
 376
 377 /* EEPROM country code to regpair mapping */
 378 static struct country_code_to_enum_rd*
 379 ath9k_regd_find_country(u16 countryCode)
 380 {
 381         int i;
 382
 383         for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
 384                 if (allCountries[i].countryCode == countryCode)
 385                         return &allCountries[i];
 386         }
 387         return NULL;
 388 }
 389
 390 /* EEPROM rd code to regpair mapping */
 391 static struct country_code_to_enum_rd*
 392 ath9k_regd_find_country_by_rd(int regdmn)
 393 {
 394         int i;
 395
 396         for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
 397                 if (allCountries[i].regDmnEnum == regdmn)
 398                         return &allCountries[i];
 399         }
 400         return NULL;
 401 }
 402
 403 /* Returns the map of the EEPROM set RD to a country code */
 404 static u16 ath9k_regd_get_default_country(u16 rd)
 405 {
 406         if (rd & COUNTRY_ERD_FLAG) {
 407                 struct country_code_to_enum_rd *country = NULL;
 408                 u16 cc = rd & ~COUNTRY_ERD_FLAG;
 409
 410                 country = ath9k_regd_find_country(cc);
 411                 if (country != NULL)
 412                         return cc;
 413         }
 414
 415         return CTRY_DEFAULT;
 416 }
 417
 418 static struct reg_dmn_pair_mapping*
 419 ath9k_get_regpair(int regdmn)
 420 {
 421         int i;
 422
 423         if (regdmn == NO_ENUMRD)
 424                 return NULL;
 425         for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++) {
 426                 if (regDomainPairs[i].regDmnEnum == regdmn)
 427                         return &regDomainPairs[i];
 428         }
 429         return NULL;
 430 }
 431
 432 int ath9k_regd_init(struct ath_hw *ah)
 433 {
 434         struct country_code_to_enum_rd *country = NULL;
 435         u16 regdmn;
 436
 437         if (!ath9k_regd_is_eeprom_valid(ah)) {
 438                 DPRINTF(ah->ah_sc, ATH_DBG_REGULATORY,
 439                         "Invalid EEPROM contents\n");
 440                 return -EINVAL;
 441         }
 442
 443         regdmn = ath9k_regd_get_eepromRD(ah);
 444         ah->regulatory.country_code = ath9k_regd_get_default_country(regdmn);
 445
 446         if (ah->regulatory.country_code == CTRY_DEFAULT &&
 447             regdmn == CTRY_DEFAULT)
 448                 ah->regulatory.country_code = CTRY_UNITED_STATES;
 449
 450         if (ah->regulatory.country_code == CTRY_DEFAULT) {
 451                 country = NULL;
 452         } else {
 453                 country = ath9k_regd_find_country(ah->regulatory.country_code);
 454                 if (country == NULL) {
 455                         DPRINTF(ah->ah_sc, ATH_DBG_REGULATORY,
 456                                 "Country is NULL!!!!, cc= %d\n",
 457                                 ah->regulatory.country_code);
 458                         return -EINVAL;
 459                 } else
 460                         regdmn = country->regDmnEnum;
 461         }
 462
 463         ah->regulatory.regpair = ath9k_get_regpair(regdmn);
 464
 465         if (!ah->regulatory.regpair) {
 466                 DPRINTF(ah->ah_sc, ATH_DBG_FATAL,
 467                         "No regulatory domain pair found, cannot continue\n");
 468                 return -EINVAL;
 469         }
 470
 471         if (!country)
 472                 country = ath9k_regd_find_country_by_rd(regdmn);
 473
 474         if (country) {
 475                 ah->regulatory.alpha2[0] = country->isoName[0];
 476                 ah->regulatory.alpha2[1] = country->isoName[1];
 477         } else {
 478                 ah->regulatory.alpha2[0] = '0';
 479                 ah->regulatory.alpha2[1] = '0';
 480         }
 481
 482         DPRINTF(ah->ah_sc, ATH_DBG_REGULATORY,
 483                 "Country alpha2 being used: %c%c\n"
 484                 "Regulatory.Regpair detected: 0x%0x\n",
 485                 ah->regulatory.alpha2[0], ah->regulatory.alpha2[1],
 486                 ah->regulatory.regpair->regDmnEnum);
 487
 488         return 0;
 489 }
 490
 491 u32 ath9k_regd_get_ctl(struct ath_hw *ah, struct ath9k_channel *chan)
 492 {
 493         u32 ctl = NO_CTL;
 494
 495         if (!ah->regulatory.regpair ||
 496             (ah->regulatory.country_code == CTRY_DEFAULT &&
 497              is_wwr_sku(ath9k_regd_get_eepromRD(ah)))) {
 498                 if (IS_CHAN_B(chan))
 499                         ctl = SD_NO_CTL | CTL_11B;
 500                 else if (IS_CHAN_G(chan))
 501                         ctl = SD_NO_CTL | CTL_11G;
 502                 else
 503                         ctl = SD_NO_CTL | CTL_11A;
 504                 return ctl;
 505         }
 506
 507         if (IS_CHAN_B(chan))
 508                 ctl = ah->regulatory.regpair->reg_2ghz_ctl | CTL_11B;
 509         else if (IS_CHAN_G(chan))
 510                 ctl = ah->regulatory.regpair->reg_2ghz_ctl | CTL_11G;
 511         else
 512                 ctl = ah->regulatory.regpair->reg_5ghz_ctl | CTL_11A;
 513
 514         return ctl;
 515 }