2 * Copyright (c) 2008-2009 Atheros Communications Inc.
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.
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.
17 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19 #include <linux/kernel.h>
20 #include <linux/export.h>
21 #include <net/cfg80211.h>
22 #include <net/mac80211.h>
24 #include "regd_common.h"
26 static int __ath_regd_init(struct ath_regulatory *reg);
29 * This is a set of common rules used by our world regulatory domains.
30 * We have 12 world regulatory domains. To save space we consolidate
31 * the regulatory domains in 5 structures by frequency and change
32 * the flags on our reg_notifier() on a case by case basis.
35 /* Only these channels all allow active scan on all world regulatory domains */
36 #define ATH9K_2GHZ_CH01_11 REG_RULE(2412-10, 2462+10, 40, 0, 20, 0)
38 /* We enable active scan on these a case by case basis by regulatory domain */
39 #define ATH9K_2GHZ_CH12_13 REG_RULE(2467-10, 2472+10, 40, 0, 20,\
41 #define ATH9K_2GHZ_CH14 REG_RULE(2484-10, 2484+10, 40, 0, 20,\
45 /* We allow IBSS on these on a case by case basis by regulatory domain */
46 #define ATH9K_5GHZ_5150_5350 REG_RULE(5150-10, 5350+10, 80, 0, 30,\
48 #define ATH9K_5GHZ_5470_5850 REG_RULE(5470-10, 5850+10, 80, 0, 30,\
50 #define ATH9K_5GHZ_5725_5850 REG_RULE(5725-10, 5850+10, 80, 0, 30,\
53 #define ATH9K_2GHZ_ALL ATH9K_2GHZ_CH01_11, \
57 #define ATH9K_5GHZ_ALL ATH9K_5GHZ_5150_5350, \
60 /* This one skips what we call "mid band" */
61 #define ATH9K_5GHZ_NO_MIDBAND ATH9K_5GHZ_5150_5350, \
66 static const struct ieee80211_regdomain ath_world_regdom_60_61_62 = {
75 /* Can be used by 0x63 and 0x65 */
76 static const struct ieee80211_regdomain ath_world_regdom_63_65 = {
82 ATH9K_5GHZ_NO_MIDBAND,
86 /* Can be used by 0x64 only */
87 static const struct ieee80211_regdomain ath_world_regdom_64 = {
92 ATH9K_5GHZ_NO_MIDBAND,
96 /* Can be used by 0x66 and 0x69 */
97 static const struct ieee80211_regdomain ath_world_regdom_66_69 = {
106 /* Can be used by 0x67, 0x68, 0x6A and 0x6C */
107 static const struct ieee80211_regdomain ath_world_regdom_67_68_6A_6C = {
117 static bool dynamic_country_user_possible(struct ath_regulatory *reg)
119 if (IS_ENABLED(CONFIG_ATH_REG_DYNAMIC_USER_CERT_TESTING))
122 switch (reg->country_code) {
123 case CTRY_UNITED_STATES:
189 static bool ath_reg_dyn_country_user_allow(struct ath_regulatory *reg)
191 if (!IS_ENABLED(CONFIG_ATH_REG_DYNAMIC_USER_REG_HINTS))
193 if (!dynamic_country_user_possible(reg))
198 static inline bool is_wwr_sku(u16 regd)
200 return ((regd & COUNTRY_ERD_FLAG) != COUNTRY_ERD_FLAG) &&
201 (((regd & WORLD_SKU_MASK) == WORLD_SKU_PREFIX) ||
205 static u16 ath_regd_get_eepromRD(struct ath_regulatory *reg)
207 return reg->current_rd & ~WORLDWIDE_ROAMING_FLAG;
210 bool ath_is_world_regd(struct ath_regulatory *reg)
212 return is_wwr_sku(ath_regd_get_eepromRD(reg));
214 EXPORT_SYMBOL(ath_is_world_regd);
216 static const struct ieee80211_regdomain *ath_default_world_regdomain(void)
218 /* this is the most restrictive */
219 return &ath_world_regdom_64;
223 ieee80211_regdomain *ath_world_regdomain(struct ath_regulatory *reg)
225 switch (reg->regpair->reg_domain) {
229 return &ath_world_regdom_60_61_62;
232 return &ath_world_regdom_63_65;
234 return &ath_world_regdom_64;
237 return &ath_world_regdom_66_69;
242 return &ath_world_regdom_67_68_6A_6C;
245 return ath_default_world_regdomain();
249 bool ath_is_49ghz_allowed(u16 regdomain)
252 return regdomain == MKK9_MKKC;
254 EXPORT_SYMBOL(ath_is_49ghz_allowed);
256 /* Frequency is one where radar detection is required */
257 static bool ath_is_radar_freq(u16 center_freq,
258 struct ath_regulatory *reg)
261 if (reg->country_code == CTRY_INDIA)
262 return (center_freq >= 5500 && center_freq <= 5700);
263 return (center_freq >= 5260 && center_freq <= 5700);
266 static void ath_force_clear_no_ir_chan(struct wiphy *wiphy,
267 struct ieee80211_channel *ch)
269 const struct ieee80211_reg_rule *reg_rule;
271 reg_rule = freq_reg_info(wiphy, MHZ_TO_KHZ(ch->center_freq));
272 if (IS_ERR(reg_rule))
275 if (!(reg_rule->flags & NL80211_RRF_NO_IR))
276 if (ch->flags & IEEE80211_CHAN_NO_IR)
277 ch->flags &= ~IEEE80211_CHAN_NO_IR;
280 static void ath_force_clear_no_ir_freq(struct wiphy *wiphy, u16 center_freq)
282 struct ieee80211_channel *ch;
284 ch = ieee80211_get_channel(wiphy, center_freq);
288 ath_force_clear_no_ir_chan(wiphy, ch);
291 static void ath_force_no_ir_chan(struct ieee80211_channel *ch)
293 ch->flags |= IEEE80211_CHAN_NO_IR;
296 static void ath_force_no_ir_freq(struct wiphy *wiphy, u16 center_freq)
298 struct ieee80211_channel *ch;
300 ch = ieee80211_get_channel(wiphy, center_freq);
304 ath_force_no_ir_chan(ch);
308 __ath_reg_apply_beaconing_flags(struct wiphy *wiphy,
309 struct ath_regulatory *reg,
310 enum nl80211_reg_initiator initiator,
311 struct ieee80211_channel *ch)
313 if (ath_is_radar_freq(ch->center_freq, reg) ||
314 (ch->flags & IEEE80211_CHAN_RADAR))
318 case NL80211_REGDOM_SET_BY_COUNTRY_IE:
319 ath_force_clear_no_ir_chan(wiphy, ch);
321 case NL80211_REGDOM_SET_BY_USER:
322 if (ath_reg_dyn_country_user_allow(reg))
323 ath_force_clear_no_ir_chan(wiphy, ch);
326 if (ch->beacon_found)
327 ch->flags &= ~IEEE80211_CHAN_NO_IR;
332 * These exception rules do not apply radar frequencies.
334 * - We enable initiating radiation if the country IE says its fine:
335 * - If no country IE has been processed and a we determine we have
336 * received a beacon on a channel we can enable initiating radiation.
339 ath_reg_apply_beaconing_flags(struct wiphy *wiphy,
340 struct ath_regulatory *reg,
341 enum nl80211_reg_initiator initiator)
343 enum nl80211_band band;
344 struct ieee80211_supported_band *sband;
345 struct ieee80211_channel *ch;
348 for (band = 0; band < NUM_NL80211_BANDS; band++) {
349 if (!wiphy->bands[band])
351 sband = wiphy->bands[band];
352 for (i = 0; i < sband->n_channels; i++) {
353 ch = &sband->channels[i];
354 __ath_reg_apply_beaconing_flags(wiphy, reg,
361 * ath_reg_apply_ir_flags()
362 * @wiphy: the wiphy to use
363 * @initiator: the regulatory hint initiator
365 * If no country IE has been received always enable passive scan
366 * and no-ibss on these channels. This is only done for specific
369 * If a country IE has been received check its rule for this
370 * channel first before enabling active scan. The passive scan
371 * would have been enforced by the initial processing of our
372 * custom regulatory domain.
375 ath_reg_apply_ir_flags(struct wiphy *wiphy,
376 struct ath_regulatory *reg,
377 enum nl80211_reg_initiator initiator)
379 struct ieee80211_supported_band *sband;
381 sband = wiphy->bands[NL80211_BAND_2GHZ];
386 case NL80211_REGDOM_SET_BY_COUNTRY_IE:
387 ath_force_clear_no_ir_freq(wiphy, 2467);
388 ath_force_clear_no_ir_freq(wiphy, 2472);
390 case NL80211_REGDOM_SET_BY_USER:
391 if (!ath_reg_dyn_country_user_allow(reg))
393 ath_force_clear_no_ir_freq(wiphy, 2467);
394 ath_force_clear_no_ir_freq(wiphy, 2472);
397 ath_force_no_ir_freq(wiphy, 2467);
398 ath_force_no_ir_freq(wiphy, 2472);
402 /* Always apply Radar/DFS rules on freq range 5500 MHz - 5700 MHz */
403 static void ath_reg_apply_radar_flags(struct wiphy *wiphy,
404 struct ath_regulatory *reg)
406 struct ieee80211_supported_band *sband;
407 struct ieee80211_channel *ch;
410 if (!wiphy->bands[NL80211_BAND_5GHZ])
413 sband = wiphy->bands[NL80211_BAND_5GHZ];
415 for (i = 0; i < sband->n_channels; i++) {
416 ch = &sband->channels[i];
417 if (!ath_is_radar_freq(ch->center_freq, reg))
419 /* We always enable radar detection/DFS on this
420 * frequency range. Additionally we also apply on
421 * this frequency range:
422 * - If STA mode does not yet have DFS supports disable
424 * - If adhoc mode does not support DFS yet then
425 * disable adhoc in the frequency.
426 * - If AP mode does not yet support radar detection/DFS
427 * do not allow AP mode
429 if (!(ch->flags & IEEE80211_CHAN_DISABLED))
430 ch->flags |= IEEE80211_CHAN_RADAR |
431 IEEE80211_CHAN_NO_IR;
435 static void ath_reg_apply_world_flags(struct wiphy *wiphy,
436 enum nl80211_reg_initiator initiator,
437 struct ath_regulatory *reg)
439 switch (reg->regpair->reg_domain) {
445 ath_reg_apply_beaconing_flags(wiphy, reg, initiator);
448 ath_reg_apply_beaconing_flags(wiphy, reg, initiator);
449 ath_reg_apply_ir_flags(wiphy, reg, initiator);
452 if (ath_reg_dyn_country_user_allow(reg))
453 ath_reg_apply_beaconing_flags(wiphy, reg, initiator);
457 static u16 ath_regd_find_country_by_name(char *alpha2)
461 for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
462 if (!memcmp(allCountries[i].isoName, alpha2, 2))
463 return allCountries[i].countryCode;
469 static int __ath_reg_dyn_country(struct wiphy *wiphy,
470 struct ath_regulatory *reg,
471 struct regulatory_request *request)
475 if (request->initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE &&
476 !ath_is_world_regd(reg))
479 country_code = ath_regd_find_country_by_name(request->alpha2);
480 if (country_code == (u16) -1)
483 reg->current_rd = COUNTRY_ERD_FLAG;
484 reg->current_rd |= country_code;
486 __ath_regd_init(reg);
488 ath_reg_apply_world_flags(wiphy, request->initiator, reg);
493 static void ath_reg_dyn_country(struct wiphy *wiphy,
494 struct ath_regulatory *reg,
495 struct regulatory_request *request)
497 if (__ath_reg_dyn_country(wiphy, reg, request))
500 printk(KERN_DEBUG "ath: regdomain 0x%0x "
501 "dynamically updated by %s\n",
503 reg_initiator_name(request->initiator));
506 void ath_reg_notifier_apply(struct wiphy *wiphy,
507 struct regulatory_request *request,
508 struct ath_regulatory *reg)
510 struct ath_common *common = container_of(reg, struct ath_common,
512 /* We always apply this */
513 ath_reg_apply_radar_flags(wiphy, reg);
516 * This would happen when we have sent a custom regulatory request
517 * a world regulatory domain and the scheduler hasn't yet processed
518 * any pending requests in the queue.
523 reg->region = request->dfs_region;
524 switch (request->initiator) {
525 case NL80211_REGDOM_SET_BY_CORE:
527 * If common->reg_world_copy is world roaming it means we *were*
528 * world roaming... so we now have to restore that data.
530 if (!ath_is_world_regd(&common->reg_world_copy))
533 memcpy(reg, &common->reg_world_copy,
534 sizeof(struct ath_regulatory));
536 case NL80211_REGDOM_SET_BY_DRIVER:
538 case NL80211_REGDOM_SET_BY_USER:
539 if (ath_reg_dyn_country_user_allow(reg))
540 ath_reg_dyn_country(wiphy, reg, request);
542 case NL80211_REGDOM_SET_BY_COUNTRY_IE:
543 ath_reg_dyn_country(wiphy, reg, request);
547 EXPORT_SYMBOL(ath_reg_notifier_apply);
549 static bool ath_regd_is_eeprom_valid(struct ath_regulatory *reg)
551 u16 rd = ath_regd_get_eepromRD(reg);
554 if (rd & COUNTRY_ERD_FLAG) {
555 /* EEPROM value is a country code */
556 u16 cc = rd & ~COUNTRY_ERD_FLAG;
558 "ath: EEPROM indicates we should expect "
560 for (i = 0; i < ARRAY_SIZE(allCountries); i++)
561 if (allCountries[i].countryCode == cc)
564 /* EEPROM value is a regpair value */
565 if (rd != CTRY_DEFAULT)
566 printk(KERN_DEBUG "ath: EEPROM indicates we "
567 "should expect a direct regpair map\n");
568 for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++)
569 if (regDomainPairs[i].reg_domain == rd)
573 "ath: invalid regulatory domain/country code 0x%x\n", rd);
577 /* EEPROM country code to regpair mapping */
578 static struct country_code_to_enum_rd*
579 ath_regd_find_country(u16 countryCode)
583 for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
584 if (allCountries[i].countryCode == countryCode)
585 return &allCountries[i];
590 /* EEPROM rd code to regpair mapping */
591 static struct country_code_to_enum_rd*
592 ath_regd_find_country_by_rd(int regdmn)
596 for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
597 if (allCountries[i].regDmnEnum == regdmn)
598 return &allCountries[i];
603 /* Returns the map of the EEPROM set RD to a country code */
604 static u16 ath_regd_get_default_country(u16 rd)
606 if (rd & COUNTRY_ERD_FLAG) {
607 struct country_code_to_enum_rd *country = NULL;
608 u16 cc = rd & ~COUNTRY_ERD_FLAG;
610 country = ath_regd_find_country(cc);
618 static struct reg_dmn_pair_mapping*
619 ath_get_regpair(int regdmn)
623 if (regdmn == NO_ENUMRD)
625 for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++) {
626 if (regDomainPairs[i].reg_domain == regdmn)
627 return ®DomainPairs[i];
633 ath_regd_init_wiphy(struct ath_regulatory *reg,
635 void (*reg_notifier)(struct wiphy *wiphy,
636 struct regulatory_request *request))
638 const struct ieee80211_regdomain *regd;
640 wiphy->reg_notifier = reg_notifier;
641 wiphy->regulatory_flags |= REGULATORY_STRICT_REG |
642 REGULATORY_CUSTOM_REG;
644 if (ath_is_world_regd(reg)) {
646 * Anything applied here (prior to wiphy registration) gets
647 * saved on the wiphy orig_* parameters
649 regd = ath_world_regdomain(reg);
650 wiphy->regulatory_flags |= REGULATORY_COUNTRY_IE_FOLLOW_POWER;
653 * This gets applied in the case of the absence of CRDA,
654 * it's our own custom world regulatory domain, similar to
655 * cfg80211's but we enable passive scanning.
657 regd = ath_default_world_regdomain();
660 wiphy_apply_custom_regulatory(wiphy, regd);
661 ath_reg_apply_radar_flags(wiphy, reg);
662 ath_reg_apply_world_flags(wiphy, NL80211_REGDOM_SET_BY_DRIVER, reg);
667 * Some users have reported their EEPROM programmed with
668 * 0x8000 set, this is not a supported regulatory domain
669 * but since we have more than one user with it we need
670 * a solution for them. We default to 0x64, which is the
671 * default Atheros world regulatory domain.
673 static void ath_regd_sanitize(struct ath_regulatory *reg)
675 if (reg->current_rd != COUNTRY_ERD_FLAG)
677 printk(KERN_DEBUG "ath: EEPROM regdomain sanitized\n");
678 reg->current_rd = 0x64;
681 static int __ath_regd_init(struct ath_regulatory *reg)
683 struct country_code_to_enum_rd *country = NULL;
689 ath_regd_sanitize(reg);
691 printk(KERN_DEBUG "ath: EEPROM regdomain: 0x%0x\n", reg->current_rd);
693 if (!ath_regd_is_eeprom_valid(reg)) {
694 pr_err("Invalid EEPROM contents\n");
698 regdmn = ath_regd_get_eepromRD(reg);
699 reg->country_code = ath_regd_get_default_country(regdmn);
701 if (reg->country_code == CTRY_DEFAULT &&
702 regdmn == CTRY_DEFAULT) {
703 printk(KERN_DEBUG "ath: EEPROM indicates default "
704 "country code should be used\n");
705 reg->country_code = CTRY_UNITED_STATES;
708 if (reg->country_code == CTRY_DEFAULT) {
711 printk(KERN_DEBUG "ath: doing EEPROM country->regdmn "
713 country = ath_regd_find_country(reg->country_code);
714 if (country == NULL) {
716 "ath: no valid country maps found for "
717 "country code: 0x%0x\n",
721 regdmn = country->regDmnEnum;
722 printk(KERN_DEBUG "ath: country maps to "
723 "regdmn code: 0x%0x\n",
728 reg->regpair = ath_get_regpair(regdmn);
731 printk(KERN_DEBUG "ath: "
732 "No regulatory domain pair found, cannot continue\n");
737 country = ath_regd_find_country_by_rd(regdmn);
740 reg->alpha2[0] = country->isoName[0];
741 reg->alpha2[1] = country->isoName[1];
743 reg->alpha2[0] = '0';
744 reg->alpha2[1] = '0';
747 printk(KERN_DEBUG "ath: Country alpha2 being used: %c%c\n",
748 reg->alpha2[0], reg->alpha2[1]);
749 printk(KERN_DEBUG "ath: Regpair used: 0x%0x\n",
750 reg->regpair->reg_domain);
756 ath_regd_init(struct ath_regulatory *reg,
758 void (*reg_notifier)(struct wiphy *wiphy,
759 struct regulatory_request *request))
761 struct ath_common *common = container_of(reg, struct ath_common,
765 r = __ath_regd_init(reg);
769 if (ath_is_world_regd(reg))
770 memcpy(&common->reg_world_copy, reg,
771 sizeof(struct ath_regulatory));
773 ath_regd_init_wiphy(reg, wiphy, reg_notifier);
777 EXPORT_SYMBOL(ath_regd_init);
779 u32 ath_regd_get_band_ctl(struct ath_regulatory *reg,
780 enum nl80211_band band)
783 (reg->country_code == CTRY_DEFAULT &&
784 is_wwr_sku(ath_regd_get_eepromRD(reg)))) {
788 if (ath_regd_get_eepromRD(reg) == CTRY_DEFAULT) {
789 switch (reg->region) {
790 case NL80211_DFS_FCC:
792 case NL80211_DFS_ETSI:
802 case NL80211_BAND_2GHZ:
803 return reg->regpair->reg_2ghz_ctl;
804 case NL80211_BAND_5GHZ:
805 return reg->regpair->reg_5ghz_ctl;
810 EXPORT_SYMBOL(ath_regd_get_band_ctl);