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 inline bool is_wwr_sku(u16 regd)
119 return ((regd & COUNTRY_ERD_FLAG) != COUNTRY_ERD_FLAG) &&
120 (((regd & WORLD_SKU_MASK) == WORLD_SKU_PREFIX) ||
124 static u16 ath_regd_get_eepromRD(struct ath_regulatory *reg)
126 return reg->current_rd & ~WORLDWIDE_ROAMING_FLAG;
129 bool ath_is_world_regd(struct ath_regulatory *reg)
131 return is_wwr_sku(ath_regd_get_eepromRD(reg));
133 EXPORT_SYMBOL(ath_is_world_regd);
135 static const struct ieee80211_regdomain *ath_default_world_regdomain(void)
137 /* this is the most restrictive */
138 return &ath_world_regdom_64;
142 ieee80211_regdomain *ath_world_regdomain(struct ath_regulatory *reg)
144 switch (reg->regpair->regDmnEnum) {
148 return &ath_world_regdom_60_61_62;
151 return &ath_world_regdom_63_65;
153 return &ath_world_regdom_64;
156 return &ath_world_regdom_66_69;
161 return &ath_world_regdom_67_68_6A_6C;
164 return ath_default_world_regdomain();
168 bool ath_is_49ghz_allowed(u16 regdomain)
171 return regdomain == MKK9_MKKC;
173 EXPORT_SYMBOL(ath_is_49ghz_allowed);
175 /* Frequency is one where radar detection is required */
176 static bool ath_is_radar_freq(u16 center_freq)
178 return (center_freq >= 5260 && center_freq <= 5700);
181 static void ath_force_clear_no_ir_chan(struct wiphy *wiphy,
182 struct ieee80211_channel *ch)
184 const struct ieee80211_reg_rule *reg_rule;
186 reg_rule = freq_reg_info(wiphy, ch->center_freq);
187 if (IS_ERR(reg_rule))
190 if (!(reg_rule->flags & NL80211_RRF_NO_IR))
191 if (ch->flags & IEEE80211_CHAN_NO_IR)
192 ch->flags &= ~IEEE80211_CHAN_NO_IR;
195 static void ath_force_clear_no_ir_freq(struct wiphy *wiphy, u16 center_freq)
197 struct ieee80211_channel *ch;
199 ch = ieee80211_get_channel(wiphy, center_freq);
203 ath_force_clear_no_ir_chan(wiphy, ch);
206 static void ath_force_no_ir_chan(struct ieee80211_channel *ch)
208 ch->flags |= IEEE80211_CHAN_NO_IR;
211 static void ath_force_no_ir_freq(struct wiphy *wiphy, u16 center_freq)
213 struct ieee80211_channel *ch;
215 ch = ieee80211_get_channel(wiphy, center_freq);
219 ath_force_no_ir_chan(ch);
223 * N.B: These exception rules do not apply radar freqs.
225 * - We enable adhoc (or beaconing) if allowed by 11d
226 * - We enable active scan if the channel is allowed by 11d
227 * - If no country IE has been processed and a we determine we have
228 * received a beacon on a channel we can enable active scan and
229 * adhoc (or beaconing).
232 ath_reg_apply_beaconing_flags(struct wiphy *wiphy,
233 enum nl80211_reg_initiator initiator)
235 enum ieee80211_band band;
236 struct ieee80211_supported_band *sband;
237 const struct ieee80211_reg_rule *reg_rule;
238 struct ieee80211_channel *ch;
241 for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
243 if (!wiphy->bands[band])
246 sband = wiphy->bands[band];
248 for (i = 0; i < sband->n_channels; i++) {
250 ch = &sband->channels[i];
252 if (ath_is_radar_freq(ch->center_freq) ||
253 (ch->flags & IEEE80211_CHAN_RADAR))
256 if (initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE) {
257 reg_rule = freq_reg_info(wiphy, ch->center_freq);
258 if (IS_ERR(reg_rule))
261 * If 11d had a rule for this channel ensure
262 * we enable adhoc/beaconing if it allows us to
263 * use it. Note that we would have disabled it
264 * by applying our static world regdomain by
265 * default during init, prior to calling our
268 if (!(reg_rule->flags & NL80211_RRF_NO_IR))
269 ch->flags &= ~IEEE80211_CHAN_NO_IR;
271 if (ch->beacon_found)
272 ch->flags &= ~IEEE80211_CHAN_NO_IR;
280 * ath_reg_apply_ir_flags()
281 * @wiphy: the wiphy to use
282 * @initiator: the regulatory hint initiator
284 * If no country IE has been received always enable passive scan
285 * and no-ibss on these channels. This is only done for specific
288 * If a country IE has been received check its rule for this
289 * channel first before enabling active scan. The passive scan
290 * would have been enforced by the initial processing of our
291 * custom regulatory domain.
294 ath_reg_apply_ir_flags(struct wiphy *wiphy,
295 enum nl80211_reg_initiator initiator)
297 struct ieee80211_supported_band *sband;
299 sband = wiphy->bands[IEEE80211_BAND_2GHZ];
304 case NL80211_REGDOM_SET_BY_COUNTRY_IE:
305 ath_force_clear_no_ir_freq(wiphy, 2467);
306 ath_force_clear_no_ir_freq(wiphy, 2472);
309 ath_force_no_ir_freq(wiphy, 2467);
310 ath_force_no_ir_freq(wiphy, 2472);
314 /* Always apply Radar/DFS rules on freq range 5260 MHz - 5700 MHz */
315 static void ath_reg_apply_radar_flags(struct wiphy *wiphy)
317 struct ieee80211_supported_band *sband;
318 struct ieee80211_channel *ch;
321 if (!wiphy->bands[IEEE80211_BAND_5GHZ])
324 sband = wiphy->bands[IEEE80211_BAND_5GHZ];
326 for (i = 0; i < sband->n_channels; i++) {
327 ch = &sband->channels[i];
328 if (!ath_is_radar_freq(ch->center_freq))
330 /* We always enable radar detection/DFS on this
331 * frequency range. Additionally we also apply on
332 * this frequency range:
333 * - If STA mode does not yet have DFS supports disable
335 * - If adhoc mode does not support DFS yet then
336 * disable adhoc in the frequency.
337 * - If AP mode does not yet support radar detection/DFS
338 * do not allow AP mode
340 if (!(ch->flags & IEEE80211_CHAN_DISABLED))
341 ch->flags |= IEEE80211_CHAN_RADAR |
342 IEEE80211_CHAN_NO_IR;
346 static void ath_reg_apply_world_flags(struct wiphy *wiphy,
347 enum nl80211_reg_initiator initiator,
348 struct ath_regulatory *reg)
350 switch (reg->regpair->regDmnEnum) {
356 ath_reg_apply_beaconing_flags(wiphy, initiator);
359 ath_reg_apply_beaconing_flags(wiphy, initiator);
360 ath_reg_apply_ir_flags(wiphy, initiator);
365 static u16 ath_regd_find_country_by_name(char *alpha2)
369 for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
370 if (!memcmp(allCountries[i].isoName, alpha2, 2))
371 return allCountries[i].countryCode;
377 static int __ath_reg_dyn_country(struct wiphy *wiphy,
378 struct ath_regulatory *reg,
379 struct regulatory_request *request)
383 if (request->initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE &&
384 !ath_is_world_regd(reg))
387 country_code = ath_regd_find_country_by_name(request->alpha2);
388 if (country_code == (u16) -1)
391 reg->current_rd = COUNTRY_ERD_FLAG;
392 reg->current_rd |= country_code;
394 __ath_regd_init(reg);
396 ath_reg_apply_world_flags(wiphy, request->initiator, reg);
401 static void ath_reg_dyn_country(struct wiphy *wiphy,
402 struct ath_regulatory *reg,
403 struct regulatory_request *request)
405 if (__ath_reg_dyn_country(wiphy, reg, request))
408 printk(KERN_DEBUG "ath: regdomain 0x%0x "
409 "dynamically updated by %s\n",
411 reg_initiator_name(request->initiator));
414 static bool dynamic_country_user_possible(struct ath_regulatory *reg)
416 if (config_enabled(CONFIG_ATH_REG_DYNAMIC_USER_CERT_TESTING))
419 switch (reg->country_code) {
420 case CTRY_UNITED_STATES:
486 static void ath_reg_dyn_country_user(struct wiphy *wiphy,
487 struct ath_regulatory *reg,
488 struct regulatory_request *request)
490 if (!config_enabled(CONFIG_ATH_REG_DYNAMIC_USER_REG_HINTS))
492 if (!dynamic_country_user_possible(reg))
494 ath_reg_dyn_country(wiphy, reg, request);
497 void ath_reg_notifier_apply(struct wiphy *wiphy,
498 struct regulatory_request *request,
499 struct ath_regulatory *reg)
501 struct ath_common *common = container_of(reg, struct ath_common,
503 /* We always apply this */
504 ath_reg_apply_radar_flags(wiphy);
507 * This would happen when we have sent a custom regulatory request
508 * a world regulatory domain and the scheduler hasn't yet processed
509 * any pending requests in the queue.
514 switch (request->initiator) {
515 case NL80211_REGDOM_SET_BY_CORE:
517 * If common->reg_world_copy is world roaming it means we *were*
518 * world roaming... so we now have to restore that data.
520 if (!ath_is_world_regd(&common->reg_world_copy))
523 memcpy(reg, &common->reg_world_copy,
524 sizeof(struct ath_regulatory));
526 case NL80211_REGDOM_SET_BY_DRIVER:
528 case NL80211_REGDOM_SET_BY_USER:
529 ath_reg_dyn_country_user(wiphy, reg, request);
531 case NL80211_REGDOM_SET_BY_COUNTRY_IE:
532 ath_reg_dyn_country(wiphy, reg, request);
536 EXPORT_SYMBOL(ath_reg_notifier_apply);
538 static bool ath_regd_is_eeprom_valid(struct ath_regulatory *reg)
540 u16 rd = ath_regd_get_eepromRD(reg);
543 if (rd & COUNTRY_ERD_FLAG) {
544 /* EEPROM value is a country code */
545 u16 cc = rd & ~COUNTRY_ERD_FLAG;
547 "ath: EEPROM indicates we should expect "
549 for (i = 0; i < ARRAY_SIZE(allCountries); i++)
550 if (allCountries[i].countryCode == cc)
553 /* EEPROM value is a regpair value */
554 if (rd != CTRY_DEFAULT)
555 printk(KERN_DEBUG "ath: EEPROM indicates we "
556 "should expect a direct regpair map\n");
557 for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++)
558 if (regDomainPairs[i].regDmnEnum == rd)
562 "ath: invalid regulatory domain/country code 0x%x\n", rd);
566 /* EEPROM country code to regpair mapping */
567 static struct country_code_to_enum_rd*
568 ath_regd_find_country(u16 countryCode)
572 for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
573 if (allCountries[i].countryCode == countryCode)
574 return &allCountries[i];
579 /* EEPROM rd code to regpair mapping */
580 static struct country_code_to_enum_rd*
581 ath_regd_find_country_by_rd(int regdmn)
585 for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
586 if (allCountries[i].regDmnEnum == regdmn)
587 return &allCountries[i];
592 /* Returns the map of the EEPROM set RD to a country code */
593 static u16 ath_regd_get_default_country(u16 rd)
595 if (rd & COUNTRY_ERD_FLAG) {
596 struct country_code_to_enum_rd *country = NULL;
597 u16 cc = rd & ~COUNTRY_ERD_FLAG;
599 country = ath_regd_find_country(cc);
607 static struct reg_dmn_pair_mapping*
608 ath_get_regpair(int regdmn)
612 if (regdmn == NO_ENUMRD)
614 for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++) {
615 if (regDomainPairs[i].regDmnEnum == regdmn)
616 return ®DomainPairs[i];
622 ath_regd_init_wiphy(struct ath_regulatory *reg,
624 void (*reg_notifier)(struct wiphy *wiphy,
625 struct regulatory_request *request))
627 const struct ieee80211_regdomain *regd;
629 wiphy->reg_notifier = reg_notifier;
630 wiphy->regulatory_flags |= REGULATORY_STRICT_REG;
632 if (ath_is_world_regd(reg)) {
634 * Anything applied here (prior to wiphy registration) gets
635 * saved on the wiphy orig_* parameters
637 regd = ath_world_regdomain(reg);
638 wiphy->regulatory_flags |= REGULATORY_CUSTOM_REG |
639 REGULATORY_COUNTRY_IE_FOLLOW_POWER;
642 * This gets applied in the case of the absence of CRDA,
643 * it's our own custom world regulatory domain, similar to
644 * cfg80211's but we enable passive scanning.
646 regd = ath_default_world_regdomain();
648 wiphy_apply_custom_regulatory(wiphy, regd);
649 ath_reg_apply_radar_flags(wiphy);
650 ath_reg_apply_world_flags(wiphy, NL80211_REGDOM_SET_BY_DRIVER, reg);
655 * Some users have reported their EEPROM programmed with
656 * 0x8000 set, this is not a supported regulatory domain
657 * but since we have more than one user with it we need
658 * a solution for them. We default to 0x64, which is the
659 * default Atheros world regulatory domain.
661 static void ath_regd_sanitize(struct ath_regulatory *reg)
663 if (reg->current_rd != COUNTRY_ERD_FLAG)
665 printk(KERN_DEBUG "ath: EEPROM regdomain sanitized\n");
666 reg->current_rd = 0x64;
669 static int __ath_regd_init(struct ath_regulatory *reg)
671 struct country_code_to_enum_rd *country = NULL;
677 ath_regd_sanitize(reg);
679 printk(KERN_DEBUG "ath: EEPROM regdomain: 0x%0x\n", reg->current_rd);
681 if (!ath_regd_is_eeprom_valid(reg)) {
682 pr_err("Invalid EEPROM contents\n");
686 regdmn = ath_regd_get_eepromRD(reg);
687 reg->country_code = ath_regd_get_default_country(regdmn);
689 if (reg->country_code == CTRY_DEFAULT &&
690 regdmn == CTRY_DEFAULT) {
691 printk(KERN_DEBUG "ath: EEPROM indicates default "
692 "country code should be used\n");
693 reg->country_code = CTRY_UNITED_STATES;
696 if (reg->country_code == CTRY_DEFAULT) {
699 printk(KERN_DEBUG "ath: doing EEPROM country->regdmn "
701 country = ath_regd_find_country(reg->country_code);
702 if (country == NULL) {
704 "ath: no valid country maps found for "
705 "country code: 0x%0x\n",
709 regdmn = country->regDmnEnum;
710 printk(KERN_DEBUG "ath: country maps to "
711 "regdmn code: 0x%0x\n",
716 reg->regpair = ath_get_regpair(regdmn);
719 printk(KERN_DEBUG "ath: "
720 "No regulatory domain pair found, cannot continue\n");
725 country = ath_regd_find_country_by_rd(regdmn);
728 reg->alpha2[0] = country->isoName[0];
729 reg->alpha2[1] = country->isoName[1];
731 reg->alpha2[0] = '0';
732 reg->alpha2[1] = '0';
735 printk(KERN_DEBUG "ath: Country alpha2 being used: %c%c\n",
736 reg->alpha2[0], reg->alpha2[1]);
737 printk(KERN_DEBUG "ath: Regpair used: 0x%0x\n",
738 reg->regpair->regDmnEnum);
744 ath_regd_init(struct ath_regulatory *reg,
746 void (*reg_notifier)(struct wiphy *wiphy,
747 struct regulatory_request *request))
749 struct ath_common *common = container_of(reg, struct ath_common,
753 r = __ath_regd_init(reg);
757 if (ath_is_world_regd(reg))
758 memcpy(&common->reg_world_copy, reg,
759 sizeof(struct ath_regulatory));
761 ath_regd_init_wiphy(reg, wiphy, reg_notifier);
765 EXPORT_SYMBOL(ath_regd_init);
767 u32 ath_regd_get_band_ctl(struct ath_regulatory *reg,
768 enum ieee80211_band band)
771 (reg->country_code == CTRY_DEFAULT &&
772 is_wwr_sku(ath_regd_get_eepromRD(reg)))) {
777 case IEEE80211_BAND_2GHZ:
778 return reg->regpair->reg_2ghz_ctl;
779 case IEEE80211_BAND_5GHZ:
780 return reg->regpair->reg_5ghz_ctl;
785 EXPORT_SYMBOL(ath_regd_get_band_ctl);