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 ATH_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 ATH_2GHZ_CH12_13 REG_RULE(2467-10, 2472+10, 40, 0, 20,\
41 #define ATH_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 ATH_5GHZ_5150_5350 REG_RULE(5150-10, 5350+10, 80, 0, 30,\
48 #define ATH_5GHZ_5470_5850 REG_RULE(5470-10, 5850+10, 80, 0, 30,\
50 #define ATH_5GHZ_5725_5850 REG_RULE(5725-10, 5850+10, 80, 0, 30,\
53 #define ATH_2GHZ_ALL ATH_2GHZ_CH01_11, \
57 #define ATH_5GHZ_ALL ATH_5GHZ_5150_5350, \
60 /* This one skips what we call "mid band" */
61 #define ATH_5GHZ_NO_MIDBAND ATH_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
= {
86 /* Can be used by 0x64 only */
87 static const struct ieee80211_regdomain ath_world_regdom_64
= {
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 * @reg: regulatory structure - used for country selection
364 * @initiator: the regulatory hint initiator
366 * If no country IE has been received always enable passive scan
367 * and no-ibss on these channels. This is only done for specific
370 * If a country IE has been received check its rule for this
371 * channel first before enabling active scan. The passive scan
372 * would have been enforced by the initial processing of our
373 * custom regulatory domain.
376 ath_reg_apply_ir_flags(struct wiphy
*wiphy
,
377 struct ath_regulatory
*reg
,
378 enum nl80211_reg_initiator initiator
)
380 struct ieee80211_supported_band
*sband
;
382 sband
= wiphy
->bands
[NL80211_BAND_2GHZ
];
387 case NL80211_REGDOM_SET_BY_COUNTRY_IE
:
388 ath_force_clear_no_ir_freq(wiphy
, 2467);
389 ath_force_clear_no_ir_freq(wiphy
, 2472);
391 case NL80211_REGDOM_SET_BY_USER
:
392 if (!ath_reg_dyn_country_user_allow(reg
))
394 ath_force_clear_no_ir_freq(wiphy
, 2467);
395 ath_force_clear_no_ir_freq(wiphy
, 2472);
398 ath_force_no_ir_freq(wiphy
, 2467);
399 ath_force_no_ir_freq(wiphy
, 2472);
403 /* Always apply Radar/DFS rules on freq range 5500 MHz - 5700 MHz */
404 static void ath_reg_apply_radar_flags(struct wiphy
*wiphy
,
405 struct ath_regulatory
*reg
)
407 struct ieee80211_supported_band
*sband
;
408 struct ieee80211_channel
*ch
;
411 if (!wiphy
->bands
[NL80211_BAND_5GHZ
])
414 sband
= wiphy
->bands
[NL80211_BAND_5GHZ
];
416 for (i
= 0; i
< sband
->n_channels
; i
++) {
417 ch
= &sband
->channels
[i
];
418 if (!ath_is_radar_freq(ch
->center_freq
, reg
))
420 /* We always enable radar detection/DFS on this
421 * frequency range. Additionally we also apply on
422 * this frequency range:
423 * - If STA mode does not yet have DFS supports disable
425 * - If adhoc mode does not support DFS yet then
426 * disable adhoc in the frequency.
427 * - If AP mode does not yet support radar detection/DFS
428 * do not allow AP mode
430 if (!(ch
->flags
& IEEE80211_CHAN_DISABLED
))
431 ch
->flags
|= IEEE80211_CHAN_RADAR
|
432 IEEE80211_CHAN_NO_IR
;
436 static void ath_reg_apply_world_flags(struct wiphy
*wiphy
,
437 enum nl80211_reg_initiator initiator
,
438 struct ath_regulatory
*reg
)
440 switch (reg
->regpair
->reg_domain
) {
446 ath_reg_apply_beaconing_flags(wiphy
, reg
, initiator
);
449 ath_reg_apply_beaconing_flags(wiphy
, reg
, initiator
);
450 ath_reg_apply_ir_flags(wiphy
, reg
, initiator
);
453 if (ath_reg_dyn_country_user_allow(reg
))
454 ath_reg_apply_beaconing_flags(wiphy
, reg
, initiator
);
458 u16
ath_regd_find_country_by_name(char *alpha2
)
462 for (i
= 0; i
< ARRAY_SIZE(allCountries
); i
++) {
463 if (!memcmp(allCountries
[i
].isoName
, alpha2
, 2))
464 return allCountries
[i
].countryCode
;
469 EXPORT_SYMBOL(ath_regd_find_country_by_name
);
471 static int __ath_reg_dyn_country(struct wiphy
*wiphy
,
472 struct ath_regulatory
*reg
,
473 struct regulatory_request
*request
)
477 if (request
->initiator
== NL80211_REGDOM_SET_BY_COUNTRY_IE
&&
478 !ath_is_world_regd(reg
))
481 country_code
= ath_regd_find_country_by_name(request
->alpha2
);
482 if (country_code
== (u16
) -1)
485 reg
->current_rd
= COUNTRY_ERD_FLAG
;
486 reg
->current_rd
|= country_code
;
488 __ath_regd_init(reg
);
490 ath_reg_apply_world_flags(wiphy
, request
->initiator
, reg
);
495 static void ath_reg_dyn_country(struct wiphy
*wiphy
,
496 struct ath_regulatory
*reg
,
497 struct regulatory_request
*request
)
499 if (__ath_reg_dyn_country(wiphy
, reg
, request
))
502 printk(KERN_DEBUG
"ath: regdomain 0x%0x "
503 "dynamically updated by %s\n",
505 reg_initiator_name(request
->initiator
));
508 void ath_reg_notifier_apply(struct wiphy
*wiphy
,
509 struct regulatory_request
*request
,
510 struct ath_regulatory
*reg
)
512 struct ath_common
*common
= container_of(reg
, struct ath_common
,
514 /* We always apply this */
515 ath_reg_apply_radar_flags(wiphy
, reg
);
518 * This would happen when we have sent a custom regulatory request
519 * a world regulatory domain and the scheduler hasn't yet processed
520 * any pending requests in the queue.
525 reg
->region
= request
->dfs_region
;
526 switch (request
->initiator
) {
527 case NL80211_REGDOM_SET_BY_CORE
:
529 * If common->reg_world_copy is world roaming it means we *were*
530 * world roaming... so we now have to restore that data.
532 if (!ath_is_world_regd(&common
->reg_world_copy
))
535 memcpy(reg
, &common
->reg_world_copy
,
536 sizeof(struct ath_regulatory
));
538 case NL80211_REGDOM_SET_BY_DRIVER
:
540 case NL80211_REGDOM_SET_BY_USER
:
541 if (ath_reg_dyn_country_user_allow(reg
))
542 ath_reg_dyn_country(wiphy
, reg
, request
);
544 case NL80211_REGDOM_SET_BY_COUNTRY_IE
:
545 ath_reg_dyn_country(wiphy
, reg
, request
);
549 EXPORT_SYMBOL(ath_reg_notifier_apply
);
551 static bool ath_regd_is_eeprom_valid(struct ath_regulatory
*reg
)
553 u16 rd
= ath_regd_get_eepromRD(reg
);
556 if (rd
& COUNTRY_ERD_FLAG
) {
557 /* EEPROM value is a country code */
558 u16 cc
= rd
& ~COUNTRY_ERD_FLAG
;
560 "ath: EEPROM indicates we should expect "
562 for (i
= 0; i
< ARRAY_SIZE(allCountries
); i
++)
563 if (allCountries
[i
].countryCode
== cc
)
566 /* EEPROM value is a regpair value */
567 if (rd
!= CTRY_DEFAULT
)
568 printk(KERN_DEBUG
"ath: EEPROM indicates we "
569 "should expect a direct regpair map\n");
570 for (i
= 0; i
< ARRAY_SIZE(regDomainPairs
); i
++)
571 if (regDomainPairs
[i
].reg_domain
== rd
)
575 "ath: invalid regulatory domain/country code 0x%x\n", rd
);
579 /* EEPROM country code to regpair mapping */
580 static struct country_code_to_enum_rd
*
581 ath_regd_find_country(u16 countryCode
)
585 for (i
= 0; i
< ARRAY_SIZE(allCountries
); i
++) {
586 if (allCountries
[i
].countryCode
== countryCode
)
587 return &allCountries
[i
];
592 /* EEPROM rd code to regpair mapping */
593 static struct country_code_to_enum_rd
*
594 ath_regd_find_country_by_rd(int regdmn
)
598 for (i
= 0; i
< ARRAY_SIZE(allCountries
); i
++) {
599 if (allCountries
[i
].regDmnEnum
== regdmn
)
600 return &allCountries
[i
];
605 /* Returns the map of the EEPROM set RD to a country code */
606 static u16
ath_regd_get_default_country(u16 rd
)
608 if (rd
& COUNTRY_ERD_FLAG
) {
609 struct country_code_to_enum_rd
*country
= NULL
;
610 u16 cc
= rd
& ~COUNTRY_ERD_FLAG
;
612 country
= ath_regd_find_country(cc
);
620 static struct reg_dmn_pair_mapping
*
621 ath_get_regpair(int regdmn
)
625 if (regdmn
== NO_ENUMRD
)
627 for (i
= 0; i
< ARRAY_SIZE(regDomainPairs
); i
++) {
628 if (regDomainPairs
[i
].reg_domain
== regdmn
)
629 return ®DomainPairs
[i
];
635 ath_regd_init_wiphy(struct ath_regulatory
*reg
,
637 void (*reg_notifier
)(struct wiphy
*wiphy
,
638 struct regulatory_request
*request
))
640 const struct ieee80211_regdomain
*regd
;
642 wiphy
->reg_notifier
= reg_notifier
;
643 wiphy
->regulatory_flags
|= REGULATORY_STRICT_REG
|
644 REGULATORY_CUSTOM_REG
;
646 if (ath_is_world_regd(reg
)) {
648 * Anything applied here (prior to wiphy registration) gets
649 * saved on the wiphy orig_* parameters
651 regd
= ath_world_regdomain(reg
);
652 wiphy
->regulatory_flags
|= REGULATORY_COUNTRY_IE_FOLLOW_POWER
;
655 * This gets applied in the case of the absence of CRDA,
656 * it's our own custom world regulatory domain, similar to
657 * cfg80211's but we enable passive scanning.
659 regd
= ath_default_world_regdomain();
662 wiphy_apply_custom_regulatory(wiphy
, regd
);
663 ath_reg_apply_radar_flags(wiphy
, reg
);
664 ath_reg_apply_world_flags(wiphy
, NL80211_REGDOM_SET_BY_DRIVER
, reg
);
669 * Some users have reported their EEPROM programmed with
670 * 0x8000 or 0x0 set, this is not a supported regulatory
671 * domain but since we have more than one user with it we
672 * need a solution for them. We default to 0x64, which is
673 * the default Atheros world regulatory domain.
675 static void ath_regd_sanitize(struct ath_regulatory
*reg
)
677 if (reg
->current_rd
!= COUNTRY_ERD_FLAG
&& reg
->current_rd
!= 0)
679 printk(KERN_DEBUG
"ath: EEPROM regdomain sanitized\n");
680 reg
->current_rd
= 0x64;
683 static int __ath_regd_init(struct ath_regulatory
*reg
)
685 struct country_code_to_enum_rd
*country
= NULL
;
691 ath_regd_sanitize(reg
);
693 printk(KERN_DEBUG
"ath: EEPROM regdomain: 0x%0x\n", reg
->current_rd
);
695 if (!ath_regd_is_eeprom_valid(reg
)) {
696 pr_err("Invalid EEPROM contents\n");
700 regdmn
= ath_regd_get_eepromRD(reg
);
701 reg
->country_code
= ath_regd_get_default_country(regdmn
);
703 if (reg
->country_code
== CTRY_DEFAULT
&&
704 regdmn
== CTRY_DEFAULT
) {
705 printk(KERN_DEBUG
"ath: EEPROM indicates default "
706 "country code should be used\n");
707 reg
->country_code
= CTRY_UNITED_STATES
;
710 if (reg
->country_code
== CTRY_DEFAULT
) {
713 printk(KERN_DEBUG
"ath: doing EEPROM country->regdmn "
715 country
= ath_regd_find_country(reg
->country_code
);
716 if (country
== NULL
) {
718 "ath: no valid country maps found for "
719 "country code: 0x%0x\n",
723 regdmn
= country
->regDmnEnum
;
724 printk(KERN_DEBUG
"ath: country maps to "
725 "regdmn code: 0x%0x\n",
730 reg
->regpair
= ath_get_regpair(regdmn
);
733 printk(KERN_DEBUG
"ath: "
734 "No regulatory domain pair found, cannot continue\n");
739 country
= ath_regd_find_country_by_rd(regdmn
);
742 reg
->alpha2
[0] = country
->isoName
[0];
743 reg
->alpha2
[1] = country
->isoName
[1];
745 reg
->alpha2
[0] = '0';
746 reg
->alpha2
[1] = '0';
749 printk(KERN_DEBUG
"ath: Country alpha2 being used: %c%c\n",
750 reg
->alpha2
[0], reg
->alpha2
[1]);
751 printk(KERN_DEBUG
"ath: Regpair used: 0x%0x\n",
752 reg
->regpair
->reg_domain
);
758 ath_regd_init(struct ath_regulatory
*reg
,
760 void (*reg_notifier
)(struct wiphy
*wiphy
,
761 struct regulatory_request
*request
))
763 struct ath_common
*common
= container_of(reg
, struct ath_common
,
767 r
= __ath_regd_init(reg
);
771 if (ath_is_world_regd(reg
))
772 memcpy(&common
->reg_world_copy
, reg
,
773 sizeof(struct ath_regulatory
));
775 ath_regd_init_wiphy(reg
, wiphy
, reg_notifier
);
779 EXPORT_SYMBOL(ath_regd_init
);
781 u32
ath_regd_get_band_ctl(struct ath_regulatory
*reg
,
782 enum nl80211_band band
)
785 (reg
->country_code
== CTRY_DEFAULT
&&
786 is_wwr_sku(ath_regd_get_eepromRD(reg
)))) {
790 if (ath_regd_get_eepromRD(reg
) == CTRY_DEFAULT
) {
791 switch (reg
->region
) {
792 case NL80211_DFS_FCC
:
794 case NL80211_DFS_ETSI
:
804 case NL80211_BAND_2GHZ
:
805 return reg
->regpair
->reg_2ghz_ctl
;
806 case NL80211_BAND_5GHZ
:
807 return reg
->regpair
->reg_5ghz_ctl
;
812 EXPORT_SYMBOL(ath_regd_get_band_ctl
);