drivers/net/wireless/rtlwifi/regd.c

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2009-2012  Realtek Corporation.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of version 2 of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
  17  *
  18  * The full GNU General Public License is included in this distribution in the
  19  * file called LICENSE.
  20  *
  21  * Contact Information:
  22  * wlanfae <wlanfae@realtek.com>
  23  * Realtek Corporation, No. 2, Innovation Road II, Hsinchu Science Park,
  24  * Hsinchu 300, Taiwan.
  25  *
  26  * Larry Finger <Larry.Finger@lwfinger.net>
  27  *
  28  *****************************************************************************/
  29
  30 #include "wifi.h"
  31 #include "regd.h"
  32
  33 static struct country_code_to_enum_rd allCountries[] = {
  34         {COUNTRY_CODE_FCC, "US"},
  35         {COUNTRY_CODE_IC, "US"},
  36         {COUNTRY_CODE_ETSI, "EC"},
  37         {COUNTRY_CODE_SPAIN, "EC"},
  38         {COUNTRY_CODE_FRANCE, "EC"},
  39         {COUNTRY_CODE_MKK, "JP"},
  40         {COUNTRY_CODE_MKK1, "JP"},
  41         {COUNTRY_CODE_ISRAEL, "EC"},
  42         {COUNTRY_CODE_TELEC, "JP"},
  43         {COUNTRY_CODE_MIC, "JP"},
  44         {COUNTRY_CODE_GLOBAL_DOMAIN, "JP"},
  45         {COUNTRY_CODE_WORLD_WIDE_13, "EC"},
  46         {COUNTRY_CODE_TELEC_NETGEAR, "EC"},
  47 };
  48
  49 /*
  50  *Only these channels all allow active
  51  *scan on all world regulatory domains
  52  */
  53 #define RTL819x_2GHZ_CH01_11    \
  54         REG_RULE(2412-10, 2462+10, 40, 0, 20, 0)
  55
  56 /*
  57  *We enable active scan on these a case
  58  *by case basis by regulatory domain
  59  */
  60 #define RTL819x_2GHZ_CH12_13    \
  61         REG_RULE(2467-10, 2472+10, 40, 0, 20,\
  62                  NL80211_RRF_NO_IR)
  63
  64 #define RTL819x_2GHZ_CH14       \
  65         REG_RULE(2484-10, 2484+10, 40, 0, 20, \
  66                  NL80211_RRF_NO_IR | NL80211_RRF_NO_OFDM)
  67
  68 /* 5G chan 36 - chan 64*/
  69 #define RTL819x_5GHZ_5150_5350  \
  70         REG_RULE(5150-10, 5350+10, 40, 0, 30, \
  71                  NL80211_RRF_NO_IR)
  72
  73 /* 5G chan 100 - chan 165*/
  74 #define RTL819x_5GHZ_5470_5850  \
  75         REG_RULE(5470-10, 5850+10, 40, 0, 30, \
  76                  NL80211_RRF_NO_IR)
  77
  78 /* 5G chan 149 - chan 165*/
  79 #define RTL819x_5GHZ_5725_5850  \
  80         REG_RULE(5725-10, 5850+10, 40, 0, 30, \
  81                  NL80211_RRF_NO_IR)
  82
  83 #define RTL819x_5GHZ_ALL        \
  84         (RTL819x_5GHZ_5150_5350, RTL819x_5GHZ_5470_5850)
  85
  86 static const struct ieee80211_regdomain rtl_regdom_11 = {
  87         .n_reg_rules = 1,
  88         .alpha2 = "99",
  89         .reg_rules = {
  90                       RTL819x_2GHZ_CH01_11,
  91                       }
  92 };
  93
  94 static const struct ieee80211_regdomain rtl_regdom_12_13 = {
  95         .n_reg_rules = 2,
  96         .alpha2 = "99",
  97         .reg_rules = {
  98                       RTL819x_2GHZ_CH01_11,
  99                           RTL819x_2GHZ_CH12_13,
 100                       }
 101 };
 102
 103 static const struct ieee80211_regdomain rtl_regdom_no_midband = {
 104         .n_reg_rules = 3,
 105         .alpha2 = "99",
 106         .reg_rules = {
 107                       RTL819x_2GHZ_CH01_11,
 108                           RTL819x_5GHZ_5150_5350,
 109                           RTL819x_5GHZ_5725_5850,
 110                       }
 111 };
 112
 113 static const struct ieee80211_regdomain rtl_regdom_60_64 = {
 114         .n_reg_rules = 3,
 115         .alpha2 = "99",
 116         .reg_rules = {
 117                       RTL819x_2GHZ_CH01_11,
 118                           RTL819x_2GHZ_CH12_13,
 119                           RTL819x_5GHZ_5725_5850,
 120                       }
 121 };
 122
 123 static const struct ieee80211_regdomain rtl_regdom_14_60_64 = {
 124         .n_reg_rules = 4,
 125         .alpha2 = "99",
 126         .reg_rules = {
 127                       RTL819x_2GHZ_CH01_11,
 128                           RTL819x_2GHZ_CH12_13,
 129                           RTL819x_2GHZ_CH14,
 130                           RTL819x_5GHZ_5725_5850,
 131                       }
 132 };
 133
 134 static const struct ieee80211_regdomain rtl_regdom_14 = {
 135         .n_reg_rules = 3,
 136         .alpha2 = "99",
 137         .reg_rules = {
 138                       RTL819x_2GHZ_CH01_11,
 139                           RTL819x_2GHZ_CH12_13,
 140                           RTL819x_2GHZ_CH14,
 141                       }
 142 };
 143
 144 static bool _rtl_is_radar_freq(u16 center_freq)
 145 {
 146         return (center_freq >= 5260 && center_freq <= 5700);
 147 }
 148
 149 static void _rtl_reg_apply_beaconing_flags(struct wiphy *wiphy,
 150                                            enum nl80211_reg_initiator initiator)
 151 {
 152         enum ieee80211_band band;
 153         struct ieee80211_supported_band *sband;
 154         const struct ieee80211_reg_rule *reg_rule;
 155         struct ieee80211_channel *ch;
 156         unsigned int i;
 157
 158         for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
 159
 160                 if (!wiphy->bands[band])
 161                         continue;
 162
 163                 sband = wiphy->bands[band];
 164
 165                 for (i = 0; i < sband->n_channels; i++) {
 166                         ch = &sband->channels[i];
 167                         if (_rtl_is_radar_freq(ch->center_freq) ||
 168                             (ch->flags & IEEE80211_CHAN_RADAR))
 169                                 continue;
 170                         if (initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE) {
 171                                 reg_rule = freq_reg_info(wiphy,
 172                                                          MHZ_TO_KHZ(ch->center_freq));
 173                                 if (IS_ERR(reg_rule))
 174                                         continue;
 175
 176                                 /*
 177                                  *If 11d had a rule for this channel ensure
 178                                  *we enable adhoc/beaconing if it allows us to
 179                                  *use it. Note that we would have disabled it
 180                                  *by applying our static world regdomain by
 181                                  *default during init, prior to calling our
 182                                  *regulatory_hint().
 183                                  */
 184
 185                                 if (!(reg_rule->flags & NL80211_RRF_NO_IR))
 186                                         ch->flags &= ~IEEE80211_CHAN_NO_IR;
 187                         } else {
 188                                 if (ch->beacon_found)
 189                                         ch->flags &= ~IEEE80211_CHAN_NO_IR;
 190                         }
 191                 }
 192         }
 193 }
 194
 195 /* Allows active scan scan on Ch 12 and 13 */
 196 static void _rtl_reg_apply_active_scan_flags(struct wiphy *wiphy,
 197                                              enum nl80211_reg_initiator
 198                                              initiator)
 199 {
 200         struct ieee80211_supported_band *sband;
 201         struct ieee80211_channel *ch;
 202         const struct ieee80211_reg_rule *reg_rule;
 203
 204         if (!wiphy->bands[IEEE80211_BAND_2GHZ])
 205                 return;
 206         sband = wiphy->bands[IEEE80211_BAND_2GHZ];
 207
 208         /*
 209          *If no country IE has been received always enable active scan
 210          *on these channels. This is only done for specific regulatory SKUs
 211          */
 212         if (initiator != NL80211_REGDOM_SET_BY_COUNTRY_IE) {
 213                 ch = &sband->channels[11];      /* CH 12 */
 214                 if (ch->flags & IEEE80211_CHAN_NO_IR)
 215                         ch->flags &= ~IEEE80211_CHAN_NO_IR;
 216                 ch = &sband->channels[12];      /* CH 13 */
 217                 if (ch->flags & IEEE80211_CHAN_NO_IR)
 218                         ch->flags &= ~IEEE80211_CHAN_NO_IR;
 219                 return;
 220         }
 221
 222         /*
 223          *If a country IE has been received check its rule for this
 224          *channel first before enabling active scan. The passive scan
 225          *would have been enforced by the initial processing of our
 226          *custom regulatory domain.
 227          */
 228
 229         ch = &sband->channels[11];      /* CH 12 */
 230         reg_rule = freq_reg_info(wiphy, MHZ_TO_KHZ(ch->center_freq));
 231         if (!IS_ERR(reg_rule)) {
 232                 if (!(reg_rule->flags & NL80211_RRF_NO_IR))
 233                         if (ch->flags & IEEE80211_CHAN_NO_IR)
 234                                 ch->flags &= ~IEEE80211_CHAN_NO_IR;
 235         }
 236
 237         ch = &sband->channels[12];      /* CH 13 */
 238         reg_rule = freq_reg_info(wiphy, MHZ_TO_KHZ(ch->center_freq));
 239         if (!IS_ERR(reg_rule)) {
 240                 if (!(reg_rule->flags & NL80211_RRF_NO_IR))
 241                         if (ch->flags & IEEE80211_CHAN_NO_IR)
 242                                 ch->flags &= ~IEEE80211_CHAN_NO_IR;
 243         }
 244 }
 245
 246 /*
 247  *Always apply Radar/DFS rules on
 248  *freq range 5260 MHz - 5700 MHz
 249  */
 250 static void _rtl_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 (!_rtl_is_radar_freq(ch->center_freq))
 264                         continue;
 265
 266                 /*
 267                  *We always enable radar detection/DFS on this
 268                  *frequency range. Additionally we also apply on
 269                  *this frequency range:
 270                  *- If STA mode does not yet have DFS supports disable
 271                  * active scanning
 272                  *- If adhoc mode does not support DFS yet then disable
 273                  * adhoc in the frequency.
 274                  *- If AP mode does not yet support radar detection/DFS
 275                  *do not allow AP mode
 276                  */
 277                 if (!(ch->flags & IEEE80211_CHAN_DISABLED))
 278                         ch->flags |= IEEE80211_CHAN_RADAR |
 279                                      IEEE80211_CHAN_NO_IR;
 280         }
 281 }
 282
 283 static void _rtl_reg_apply_world_flags(struct wiphy *wiphy,
 284                                        enum nl80211_reg_initiator initiator,
 285                                        struct rtl_regulatory *reg)
 286 {
 287         _rtl_reg_apply_beaconing_flags(wiphy, initiator);
 288         _rtl_reg_apply_active_scan_flags(wiphy, initiator);
 289         return;
 290 }
 291
 292 static void _rtl_reg_notifier_apply(struct wiphy *wiphy,
 293                                     struct regulatory_request *request,
 294                                     struct rtl_regulatory *reg)
 295 {
 296         /* We always apply this */
 297         _rtl_reg_apply_radar_flags(wiphy);
 298
 299         switch (request->initiator) {
 300         case NL80211_REGDOM_SET_BY_DRIVER:
 301         case NL80211_REGDOM_SET_BY_CORE:
 302         case NL80211_REGDOM_SET_BY_USER:
 303                 break;
 304         case NL80211_REGDOM_SET_BY_COUNTRY_IE:
 305                 _rtl_reg_apply_world_flags(wiphy, request->initiator, reg);
 306                 break;
 307         }
 308 }
 309
 310 static const struct ieee80211_regdomain *_rtl_regdomain_select(
 311                                                struct rtl_regulatory *reg)
 312 {
 313         switch (reg->country_code) {
 314         case COUNTRY_CODE_FCC:
 315                 return &rtl_regdom_no_midband;
 316         case COUNTRY_CODE_IC:
 317                 return &rtl_regdom_11;
 318         case COUNTRY_CODE_ETSI:
 319         case COUNTRY_CODE_TELEC_NETGEAR:
 320                 return &rtl_regdom_60_64;
 321         case COUNTRY_CODE_SPAIN:
 322         case COUNTRY_CODE_FRANCE:
 323         case COUNTRY_CODE_ISRAEL:
 324         case COUNTRY_CODE_WORLD_WIDE_13:
 325                 return &rtl_regdom_12_13;
 326         case COUNTRY_CODE_MKK:
 327         case COUNTRY_CODE_MKK1:
 328         case COUNTRY_CODE_TELEC:
 329         case COUNTRY_CODE_MIC:
 330                 return &rtl_regdom_14_60_64;
 331         case COUNTRY_CODE_GLOBAL_DOMAIN:
 332                 return &rtl_regdom_14;
 333         default:
 334                 return &rtl_regdom_no_midband;
 335         }
 336 }
 337
 338 static int _rtl_regd_init_wiphy(struct rtl_regulatory *reg,
 339                                 struct wiphy *wiphy,
 340                                 void (*reg_notifier) (struct wiphy *wiphy,
 341                                                       struct regulatory_request *
 342                                                       request))
 343 {
 344         const struct ieee80211_regdomain *regd;
 345
 346         wiphy->reg_notifier = reg_notifier;
 347
 348         wiphy->regulatory_flags |= REGULATORY_CUSTOM_REG;
 349         wiphy->regulatory_flags &= ~REGULATORY_STRICT_REG;
 350         wiphy->regulatory_flags &= ~REGULATORY_DISABLE_BEACON_HINTS;
 351
 352         regd = _rtl_regdomain_select(reg);
 353         wiphy_apply_custom_regulatory(wiphy, regd);
 354         _rtl_reg_apply_radar_flags(wiphy);
 355         _rtl_reg_apply_world_flags(wiphy, NL80211_REGDOM_SET_BY_DRIVER, reg);
 356         return 0;
 357 }
 358
 359 static struct country_code_to_enum_rd *_rtl_regd_find_country(u16 countrycode)
 360 {
 361         int i;
 362
 363         for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
 364                 if (allCountries[i].countrycode == countrycode)
 365                         return &allCountries[i];
 366         }
 367         return NULL;
 368 }
 369
 370 int rtl_regd_init(struct ieee80211_hw *hw,
 371                   void (*reg_notifier) (struct wiphy *wiphy,
 372                                        struct regulatory_request *request))
 373 {
 374         struct rtl_priv *rtlpriv = rtl_priv(hw);
 375         struct wiphy *wiphy = hw->wiphy;
 376         struct country_code_to_enum_rd *country = NULL;
 377
 378         if (wiphy == NULL || &rtlpriv->regd == NULL)
 379                 return -EINVAL;
 380
 381         /* init country_code from efuse channel plan */
 382         rtlpriv->regd.country_code = rtlpriv->efuse.channel_plan;
 383
 384         RT_TRACE(rtlpriv, COMP_REGD, DBG_TRACE,
 385                  "rtl: EEPROM regdomain: 0x%0x\n", rtlpriv->regd.country_code);
 386
 387         if (rtlpriv->regd.country_code >= COUNTRY_CODE_MAX) {
 388                 RT_TRACE(rtlpriv, COMP_REGD, DBG_DMESG,
 389                          "rtl: EEPROM indicates invalid contry code, world wide 13 should be used\n");
 390
 391                 rtlpriv->regd.country_code = COUNTRY_CODE_WORLD_WIDE_13;
 392         }
 393
 394         country = _rtl_regd_find_country(rtlpriv->regd.country_code);
 395
 396         if (country) {
 397                 rtlpriv->regd.alpha2[0] = country->iso_name[0];
 398                 rtlpriv->regd.alpha2[1] = country->iso_name[1];
 399         } else {
 400                 rtlpriv->regd.alpha2[0] = '0';
 401                 rtlpriv->regd.alpha2[1] = '0';
 402         }
 403
 404         RT_TRACE(rtlpriv, COMP_REGD, DBG_TRACE,
 405                  "rtl: Country alpha2 being used: %c%c\n",
 406                  rtlpriv->regd.alpha2[0], rtlpriv->regd.alpha2[1]);
 407
 408         _rtl_regd_init_wiphy(&rtlpriv->regd, wiphy, reg_notifier);
 409
 410         return 0;
 411 }
 412
 413 void rtl_reg_notifier(struct wiphy *wiphy, struct regulatory_request *request)
 414 {
 415         struct ieee80211_hw *hw = wiphy_to_ieee80211_hw(wiphy);
 416         struct rtl_priv *rtlpriv = rtl_priv(hw);
 417
 418         RT_TRACE(rtlpriv, COMP_REGD, DBG_LOUD, "\n");
 419
 420         _rtl_reg_notifier_apply(wiphy, request, &rtlpriv->regd);
 421 }