drivers/staging/rtl8821ae/regd.c

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2009-2010  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_PASSIVE_SCAN)
  63
  64 #define RTL819x_2GHZ_CH14       \
  65         REG_RULE(2484-10, 2484+10, 40, 0, 20, \
  66         NL80211_RRF_PASSIVE_SCAN | \
  67         NL80211_RRF_NO_OFDM)
  68
  69 /* 5G chan 36 - chan 64*/
  70 #define RTL819x_5GHZ_5150_5350  \
  71         REG_RULE(5150-10, 5350+10, 40, 0, 30, \
  72         NL80211_RRF_PASSIVE_SCAN | \
  73         NL80211_RRF_NO_IBSS)
  74
  75 /* 5G chan 100 - chan 165*/
  76 #define RTL819x_5GHZ_5470_5850  \
  77         REG_RULE(5470-10, 5850+10, 40, 0, 30, \
  78         NL80211_RRF_PASSIVE_SCAN | \
  79         NL80211_RRF_NO_IBSS)
  80
  81 /* 5G chan 149 - chan 165*/
  82 #define RTL819x_5GHZ_5725_5850  \
  83         REG_RULE(5725-10, 5850+10, 40, 0, 30, \
  84         NL80211_RRF_PASSIVE_SCAN | \
  85         NL80211_RRF_NO_IBSS)
  86
  87 #define RTL819x_5GHZ_ALL        \
  88         RTL819x_5GHZ_5150_5350, RTL819x_5GHZ_5470_5850
  89
  90 static const struct ieee80211_regdomain rtl_regdom_11 = {
  91         .n_reg_rules = 1,
  92         .alpha2 = "99",
  93         .reg_rules = {
  94                       RTL819x_2GHZ_CH01_11,
  95                       }
  96 };
  97
  98 static const struct ieee80211_regdomain rtl_regdom_12_13 = {
  99         .n_reg_rules = 2,
 100         .alpha2 = "99",
 101         .reg_rules = {
 102                       RTL819x_2GHZ_CH01_11,
 103                           RTL819x_2GHZ_CH12_13,
 104                       }
 105 };
 106
 107 static const struct ieee80211_regdomain rtl_regdom_no_midband = {
 108         .n_reg_rules = 3,
 109         .alpha2 = "99",
 110         .reg_rules = {
 111                       RTL819x_2GHZ_CH01_11,
 112                           RTL819x_5GHZ_5150_5350,
 113                           RTL819x_5GHZ_5725_5850,
 114                       }
 115 };
 116
 117 static const struct ieee80211_regdomain rtl_regdom_60_64 = {
 118         .n_reg_rules = 3,
 119         .alpha2 = "99",
 120         .reg_rules = {
 121                       RTL819x_2GHZ_CH01_11,
 122                           RTL819x_2GHZ_CH12_13,
 123                           RTL819x_5GHZ_5725_5850,
 124                       }
 125 };
 126
 127 static const struct ieee80211_regdomain rtl_regdom_14_60_64 = {
 128         .n_reg_rules = 4,
 129         .alpha2 = "99",
 130         .reg_rules = {
 131                       RTL819x_2GHZ_CH01_11,
 132                           RTL819x_2GHZ_CH12_13,
 133                           RTL819x_2GHZ_CH14,
 134                           RTL819x_5GHZ_5725_5850,
 135                       }
 136 };
 137
 138 static const struct ieee80211_regdomain rtl_regdom_14 = {
 139         .n_reg_rules = 3,
 140         .alpha2 = "99",
 141         .reg_rules = {
 142                       RTL819x_2GHZ_CH01_11,
 143                           RTL819x_2GHZ_CH12_13,
 144                           RTL819x_2GHZ_CH14,
 145                       }
 146 };
 147
 148 static bool _rtl_is_radar_freq(u16 center_freq)
 149 {
 150         return (center_freq >= 5260 && center_freq <= 5700);
 151 }
 152
 153 static void _rtl_reg_apply_beaconing_flags(struct wiphy *wiphy,
 154                                            enum nl80211_reg_initiator initiator)
 155 {
 156         enum ieee80211_band band;
 157         struct ieee80211_supported_band *sband;
 158         const struct ieee80211_reg_rule *reg_rule;
 159         struct ieee80211_channel *ch;
 160         unsigned int i;
 161         for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
 162
 163                 if (!wiphy->bands[band])
 164                         continue;
 165
 166                 sband = wiphy->bands[band];
 167
 168                 for (i = 0; i < sband->n_channels; i++) {
 169                         ch = &sband->channels[i];
 170                         if (_rtl_is_radar_freq(ch->center_freq) ||
 171                             (ch->flags & IEEE80211_CHAN_RADAR))
 172                                 continue;
 173                         if (initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE) {
 174                                 reg_rule = freq_reg_info(wiphy, ch->center_freq);
 175                                 if (IS_ERR(reg_rule))
 176                                         continue;
 177
 178                                 /*
 179                                  *If 11d had a rule for this channel ensure
 180                                  *we enable adhoc/beaconing if it allows us to
 181                                  *use it. Note that we would have disabled it
 182                                  *by applying our static world regdomain by
 183                                  *default during init, prior to calling our
 184                                  *regulatory_hint().
 185                                  */
 186
 187                                 if (!(reg_rule->flags & NL80211_RRF_NO_IBSS))
 188                                         ch->flags &= ~IEEE80211_CHAN_NO_IBSS;
 189                                 if (!(reg_rule->flags &
 190                                       NL80211_RRF_PASSIVE_SCAN))
 191                                         ch->flags &=
 192                                             ~IEEE80211_CHAN_PASSIVE_SCAN;
 193                         } else {
 194                                 if (ch->beacon_found)
 195                                         ch->flags &= ~(IEEE80211_CHAN_NO_IBSS |
 196                                                    IEEE80211_CHAN_PASSIVE_SCAN);
 197                         }
 198                 }
 199         }
 200 }
 201
 202 /* Allows active scan scan on Ch 12 and 13 */
 203 static void _rtl_reg_apply_active_scan_flags(struct wiphy *wiphy,
 204                                              enum nl80211_reg_initiator
 205                                              initiator)
 206 {
 207         struct ieee80211_supported_band *sband;
 208         struct ieee80211_channel *ch;
 209         const struct ieee80211_reg_rule *reg_rule;
 210
 211         if (!wiphy->bands[IEEE80211_BAND_2GHZ])
 212                 return;
 213         sband = wiphy->bands[IEEE80211_BAND_2GHZ];
 214
 215         /*
 216          *If no country IE has been received always enable active scan
 217          *on these channels. This is only done for specific regulatory SKUs
 218          */
 219         if (initiator != NL80211_REGDOM_SET_BY_COUNTRY_IE) {
 220                 ch = &sband->channels[11];      /* CH 12 */
 221                 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 222                         ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 223                 ch = &sband->channels[12];      /* CH 13 */
 224                 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 225                         ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 226                 return;
 227         }
 228
 229         /*
 230          *If a country IE has been received check its rule for this
 231          *channel first before enabling active scan. The passive scan
 232          *would have been enforced by the initial processing of our
 233          *custom regulatory domain.
 234          */
 235
 236         ch = &sband->channels[11];      /* CH 12 */
 237         reg_rule = freq_reg_info(wiphy, ch->center_freq);
 238         if (!IS_ERR(reg_rule)) {
 239                 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
 240                         if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 241                                 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 242         }
 243
 244         ch = &sband->channels[12];      /* CH 13 */
 245         reg_rule = freq_reg_info(wiphy, ch->center_freq);
 246         if (!IS_ERR(reg_rule)) {
 247                 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
 248                         if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
 249                                 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
 250         }
 251 }
 252
 253 /*
 254  *Always apply Radar/DFS rules on
 255  *freq range 5260 MHz - 5700 MHz
 256  */
 257 static void _rtl_reg_apply_radar_flags(struct wiphy *wiphy)
 258 {
 259         struct ieee80211_supported_band *sband;
 260         struct ieee80211_channel *ch;
 261         unsigned int i;
 262
 263         if (!wiphy->bands[IEEE80211_BAND_5GHZ])
 264                 return;
 265
 266         sband = wiphy->bands[IEEE80211_BAND_5GHZ];
 267
 268         for (i = 0; i < sband->n_channels; i++) {
 269                 ch = &sband->channels[i];
 270                 if (!_rtl_is_radar_freq(ch->center_freq))
 271                         continue;
 272
 273                 /*
 274                  *We always enable radar detection/DFS on this
 275                  *frequency range. Additionally we also apply on
 276                  *this frequency range:
 277                  *- If STA mode does not yet have DFS supports disable
 278                  * active scanning
 279                  *- If adhoc mode does not support DFS yet then disable
 280                  * adhoc in the frequency.
 281                  *- If AP mode does not yet support radar detection/DFS
 282                  *do not allow AP mode
 283                  */
 284                 if (!(ch->flags & IEEE80211_CHAN_DISABLED))
 285                         ch->flags |= IEEE80211_CHAN_RADAR |
 286                             IEEE80211_CHAN_NO_IBSS |
 287                             IEEE80211_CHAN_PASSIVE_SCAN;
 288         }
 289 }
 290
 291 static void _rtl_reg_apply_world_flags(struct wiphy *wiphy,
 292                                        enum nl80211_reg_initiator initiator,
 293                                        struct rtl_regulatory *reg)
 294 {
 295         _rtl_reg_apply_beaconing_flags(wiphy, initiator);
 296         _rtl_reg_apply_active_scan_flags(wiphy, initiator);
 297         return;
 298 }
 299
 300 static void _rtl_dump_channel_map(struct wiphy *wiphy)
 301 {
 302         enum ieee80211_band band;
 303         struct ieee80211_supported_band *sband;
 304         struct ieee80211_channel *ch;
 305         unsigned int i;
 306
 307         for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
 308                 if (!wiphy->bands[band])
 309                         continue;
 310                 sband = wiphy->bands[band];
 311                 for (i = 0; i < sband->n_channels; i++)
 312                         ch = &sband->channels[i];
 313         }
 314 }
 315
 316 static int _rtl_reg_notifier_apply(struct wiphy *wiphy,
 317                                    struct regulatory_request *request,
 318                                    struct rtl_regulatory *reg)
 319 {
 320         /* We always apply this */
 321         _rtl_reg_apply_radar_flags(wiphy);
 322
 323         switch (request->initiator) {
 324         case NL80211_REGDOM_SET_BY_DRIVER:
 325         case NL80211_REGDOM_SET_BY_CORE:
 326         case NL80211_REGDOM_SET_BY_USER:
 327                 break;
 328         case NL80211_REGDOM_SET_BY_COUNTRY_IE:
 329                 _rtl_reg_apply_world_flags(wiphy, request->initiator, reg);
 330                 break;
 331         }
 332
 333         _rtl_dump_channel_map(wiphy);
 334
 335         return 0;
 336 }
 337
 338 static const struct ieee80211_regdomain *_rtl_regdomain_select(
 339                                                 struct rtl_regulatory *reg)
 340 {
 341         switch (reg->country_code) {
 342         case COUNTRY_CODE_FCC:
 343                 return &rtl_regdom_no_midband;
 344         case COUNTRY_CODE_IC:
 345                 return &rtl_regdom_11;
 346         case COUNTRY_CODE_ETSI:
 347         case COUNTRY_CODE_TELEC_NETGEAR:
 348                 return &rtl_regdom_60_64;
 349         case COUNTRY_CODE_SPAIN:
 350         case COUNTRY_CODE_FRANCE:
 351         case COUNTRY_CODE_ISRAEL:
 352         case COUNTRY_CODE_WORLD_WIDE_13:
 353                 return &rtl_regdom_12_13;
 354         case COUNTRY_CODE_MKK:
 355         case COUNTRY_CODE_MKK1:
 356         case COUNTRY_CODE_TELEC:
 357         case COUNTRY_CODE_MIC:
 358                 return &rtl_regdom_14_60_64;
 359         case COUNTRY_CODE_GLOBAL_DOMAIN:
 360                 return &rtl_regdom_14;
 361         default:
 362                 return &rtl_regdom_no_midband;
 363         }
 364 }
 365
 366 static int _rtl_regd_init_wiphy(struct rtl_regulatory *reg,
 367                                 struct wiphy *wiphy,
 368                                 void (*reg_notifier) (struct wiphy * wiphy,
 369                                                      struct regulatory_request *
 370                                                      request))
 371 {
 372         const struct ieee80211_regdomain *regd;
 373
 374         wiphy->reg_notifier = reg_notifier;
 375
 376         wiphy->flags |= WIPHY_FLAG_CUSTOM_REGULATORY;
 377         wiphy->flags &= ~WIPHY_FLAG_STRICT_REGULATORY;
 378         wiphy->flags &= ~WIPHY_FLAG_DISABLE_BEACON_HINTS;
 379
 380         regd = _rtl_regdomain_select(reg);
 381         wiphy_apply_custom_regulatory(wiphy, regd);
 382         _rtl_reg_apply_radar_flags(wiphy);
 383         _rtl_reg_apply_world_flags(wiphy, NL80211_REGDOM_SET_BY_DRIVER, reg);
 384         return 0;
 385 }
 386
 387 static struct country_code_to_enum_rd *_rtl_regd_find_country(u16 countrycode)
 388 {
 389         int i;
 390
 391         for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
 392                 if (allCountries[i].countrycode == countrycode)
 393                         return &allCountries[i];
 394         }
 395         return NULL;
 396 }
 397
 398 int rtl_regd_init(struct ieee80211_hw *hw,
 399                   void (*reg_notifier) (struct wiphy *wiphy,
 400                                         struct regulatory_request *request))
 401 {
 402         struct rtl_priv *rtlpriv = rtl_priv(hw);
 403         struct wiphy *wiphy = hw->wiphy;
 404         struct country_code_to_enum_rd *country = NULL;
 405
 406         if (wiphy == NULL || &rtlpriv->regd == NULL)
 407                 return -EINVAL;
 408
 409         /* init country_code from efuse channel plan */
 410         rtlpriv->regd.country_code = rtlpriv->efuse.channel_plan;
 411
 412         RT_TRACE(COMP_REGD, DBG_TRACE,
 413                  (KERN_DEBUG "rtl: EEPROM regdomain: 0x%0x\n",
 414                   rtlpriv->regd.country_code));
 415
 416         if (rtlpriv->regd.country_code >= COUNTRY_CODE_MAX) {
 417                 RT_TRACE(COMP_REGD, DBG_DMESG,
 418                          (KERN_DEBUG "rtl: EEPROM indicates invalid country code"
 419                           "world wide 13 should be used\n"));
 420
 421                 rtlpriv->regd.country_code = COUNTRY_CODE_WORLD_WIDE_13;
 422         }
 423
 424         country = _rtl_regd_find_country(rtlpriv->regd.country_code);
 425
 426         if (country) {
 427                 rtlpriv->regd.alpha2[0] = country->iso_name[0];
 428                 rtlpriv->regd.alpha2[1] = country->iso_name[1];
 429         } else {
 430                 rtlpriv->regd.alpha2[0] = '0';
 431                 rtlpriv->regd.alpha2[1] = '0';
 432         }
 433
 434         RT_TRACE(COMP_REGD, DBG_TRACE,
 435                  (KERN_DEBUG "rtl: Country alpha2 being used: %c%c\n",
 436                   rtlpriv->regd.alpha2[0], rtlpriv->regd.alpha2[1]));
 437
 438         _rtl_regd_init_wiphy(&rtlpriv->regd, wiphy, reg_notifier);
 439
 440         return 0;
 441 }
 442
 443 void rtl_reg_notifier(struct wiphy *wiphy, struct regulatory_request *request)
 444 {
 445         struct ieee80211_hw *hw = wiphy_to_ieee80211_hw(wiphy);
 446         struct rtl_priv *rtlpriv = rtl_priv(hw);
 447
 448         RT_TRACE(COMP_REGD, DBG_LOUD, ("\n"));
 449
 450         _rtl_reg_notifier_apply(wiphy, request, &rtlpriv->regd);
 451 }