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 #include <linux/kernel.h>
18 #include <linux/export.h>
19 #include <net/cfg80211.h>
20 #include <net/mac80211.h>
22 #include "regd_common.h"
25 * This is a set of common rules used by our world regulatory domains.
26 * We have 12 world regulatory domains. To save space we consolidate
27 * the regulatory domains in 5 structures by frequency and change
28 * the flags on our reg_notifier() on a case by case basis.
31 /* Only these channels all allow active scan on all world regulatory domains */
32 #define ATH9K_2GHZ_CH01_11 REG_RULE(2412-10, 2462+10, 40, 0, 20, 0)
34 /* We enable active scan on these a case by case basis by regulatory domain */
35 #define ATH9K_2GHZ_CH12_13 REG_RULE(2467-10, 2472+10, 40, 0, 20,\
36 NL80211_RRF_PASSIVE_SCAN)
37 #define ATH9K_2GHZ_CH14 REG_RULE(2484-10, 2484+10, 40, 0, 20,\
38 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_OFDM)
40 /* We allow IBSS on these on a case by case basis by regulatory domain */
41 #define ATH9K_5GHZ_5150_5350 REG_RULE(5150-10, 5350+10, 40, 0, 30,\
42 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_IBSS)
43 #define ATH9K_5GHZ_5470_5850 REG_RULE(5470-10, 5850+10, 40, 0, 30,\
44 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_IBSS)
45 #define ATH9K_5GHZ_5725_5850 REG_RULE(5725-10, 5850+10, 40, 0, 30,\
46 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_IBSS)
48 #define ATH9K_2GHZ_ALL ATH9K_2GHZ_CH01_11, \
52 #define ATH9K_5GHZ_ALL ATH9K_5GHZ_5150_5350, \
55 /* This one skips what we call "mid band" */
56 #define ATH9K_5GHZ_NO_MIDBAND ATH9K_5GHZ_5150_5350, \
61 static const struct ieee80211_regdomain ath_world_regdom_60_61_62 = {
70 /* Can be used by 0x63 and 0x65 */
71 static const struct ieee80211_regdomain ath_world_regdom_63_65 = {
77 ATH9K_5GHZ_NO_MIDBAND,
81 /* Can be used by 0x64 only */
82 static const struct ieee80211_regdomain ath_world_regdom_64 = {
87 ATH9K_5GHZ_NO_MIDBAND,
91 /* Can be used by 0x66 and 0x69 */
92 static const struct ieee80211_regdomain ath_world_regdom_66_69 = {
101 /* Can be used by 0x67, 0x68, 0x6A and 0x6C */
102 static const struct ieee80211_regdomain ath_world_regdom_67_68_6A_6C = {
112 static inline bool is_wwr_sku(u16 regd)
114 return ((regd & COUNTRY_ERD_FLAG) != COUNTRY_ERD_FLAG) &&
115 (((regd & WORLD_SKU_MASK) == WORLD_SKU_PREFIX) ||
119 static u16 ath_regd_get_eepromRD(struct ath_regulatory *reg)
121 return reg->current_rd & ~WORLDWIDE_ROAMING_FLAG;
124 bool ath_is_world_regd(struct ath_regulatory *reg)
126 return is_wwr_sku(ath_regd_get_eepromRD(reg));
128 EXPORT_SYMBOL(ath_is_world_regd);
130 static const struct ieee80211_regdomain *ath_default_world_regdomain(void)
132 /* this is the most restrictive */
133 return &ath_world_regdom_64;
137 ieee80211_regdomain *ath_world_regdomain(struct ath_regulatory *reg)
139 switch (reg->regpair->regDmnEnum) {
143 return &ath_world_regdom_60_61_62;
146 return &ath_world_regdom_63_65;
148 return &ath_world_regdom_64;
151 return &ath_world_regdom_66_69;
156 return &ath_world_regdom_67_68_6A_6C;
159 return ath_default_world_regdomain();
163 bool ath_is_49ghz_allowed(u16 regdomain)
166 return regdomain == MKK9_MKKC;
168 EXPORT_SYMBOL(ath_is_49ghz_allowed);
170 /* Frequency is one where radar detection is required */
171 static bool ath_is_radar_freq(u16 center_freq)
173 return (center_freq >= 5260 && center_freq <= 5700);
177 * N.B: These exception rules do not apply radar freqs.
179 * - We enable adhoc (or beaconing) if allowed by 11d
180 * - We enable active scan if the channel is allowed by 11d
181 * - If no country IE has been processed and a we determine we have
182 * received a beacon on a channel we can enable active scan and
183 * adhoc (or beaconing).
186 ath_reg_apply_beaconing_flags(struct wiphy *wiphy,
187 enum nl80211_reg_initiator initiator)
189 enum ieee80211_band band;
190 struct ieee80211_supported_band *sband;
191 const struct ieee80211_reg_rule *reg_rule;
192 struct ieee80211_channel *ch;
197 for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
199 if (!wiphy->bands[band])
202 sband = wiphy->bands[band];
204 for (i = 0; i < sband->n_channels; i++) {
206 ch = &sband->channels[i];
208 if (ath_is_radar_freq(ch->center_freq) ||
209 (ch->flags & IEEE80211_CHAN_RADAR))
212 if (initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE) {
213 r = freq_reg_info(wiphy,
220 * If 11d had a rule for this channel ensure
221 * we enable adhoc/beaconing if it allows us to
222 * use it. Note that we would have disabled it
223 * by applying our static world regdomain by
224 * default during init, prior to calling our
227 if (!(reg_rule->flags &
228 NL80211_RRF_NO_IBSS))
230 ~IEEE80211_CHAN_NO_IBSS;
231 if (!(reg_rule->flags &
232 NL80211_RRF_PASSIVE_SCAN))
234 ~IEEE80211_CHAN_PASSIVE_SCAN;
236 if (ch->beacon_found)
237 ch->flags &= ~(IEEE80211_CHAN_NO_IBSS |
238 IEEE80211_CHAN_PASSIVE_SCAN);
245 /* Allows active scan scan on Ch 12 and 13 */
247 ath_reg_apply_active_scan_flags(struct wiphy *wiphy,
248 enum nl80211_reg_initiator initiator)
250 struct ieee80211_supported_band *sband;
251 struct ieee80211_channel *ch;
252 const struct ieee80211_reg_rule *reg_rule;
256 sband = wiphy->bands[IEEE80211_BAND_2GHZ];
261 * If no country IE has been received always enable active scan
262 * on these channels. This is only done for specific regulatory SKUs
264 if (initiator != NL80211_REGDOM_SET_BY_COUNTRY_IE) {
265 ch = &sband->channels[11]; /* CH 12 */
266 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
267 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
268 ch = &sband->channels[12]; /* CH 13 */
269 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
270 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
275 * If a country IE has been received check its rule for this
276 * channel first before enabling active scan. The passive scan
277 * would have been enforced by the initial processing of our
278 * custom regulatory domain.
281 ch = &sband->channels[11]; /* CH 12 */
282 r = freq_reg_info(wiphy, ch->center_freq, bandwidth, ®_rule);
284 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
285 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
286 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
289 ch = &sband->channels[12]; /* CH 13 */
290 r = freq_reg_info(wiphy, ch->center_freq, bandwidth, ®_rule);
292 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
293 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
294 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
298 /* Always apply Radar/DFS rules on freq range 5260 MHz - 5700 MHz */
299 static void ath_reg_apply_radar_flags(struct wiphy *wiphy)
301 struct ieee80211_supported_band *sband;
302 struct ieee80211_channel *ch;
305 if (!wiphy->bands[IEEE80211_BAND_5GHZ])
308 sband = wiphy->bands[IEEE80211_BAND_5GHZ];
310 for (i = 0; i < sband->n_channels; i++) {
311 ch = &sband->channels[i];
312 if (!ath_is_radar_freq(ch->center_freq))
314 /* We always enable radar detection/DFS on this
315 * frequency range. Additionally we also apply on
316 * this frequency range:
317 * - If STA mode does not yet have DFS supports disable
319 * - If adhoc mode does not support DFS yet then
320 * disable adhoc in the frequency.
321 * - If AP mode does not yet support radar detection/DFS
322 * do not allow AP mode
324 if (!(ch->flags & IEEE80211_CHAN_DISABLED))
325 ch->flags |= IEEE80211_CHAN_RADAR |
326 IEEE80211_CHAN_NO_IBSS |
327 IEEE80211_CHAN_PASSIVE_SCAN;
331 static void ath_reg_apply_world_flags(struct wiphy *wiphy,
332 enum nl80211_reg_initiator initiator,
333 struct ath_regulatory *reg)
335 switch (reg->regpair->regDmnEnum) {
341 ath_reg_apply_beaconing_flags(wiphy, initiator);
344 ath_reg_apply_beaconing_flags(wiphy, initiator);
345 ath_reg_apply_active_scan_flags(wiphy, initiator);
350 int ath_reg_notifier_apply(struct wiphy *wiphy,
351 struct regulatory_request *request,
352 struct ath_regulatory *reg)
354 /* We always apply this */
355 ath_reg_apply_radar_flags(wiphy);
358 * This would happen when we have sent a custom regulatory request
359 * a world regulatory domain and the scheduler hasn't yet processed
360 * any pending requests in the queue.
365 switch (request->initiator) {
366 case NL80211_REGDOM_SET_BY_DRIVER:
367 case NL80211_REGDOM_SET_BY_CORE:
368 case NL80211_REGDOM_SET_BY_USER:
370 case NL80211_REGDOM_SET_BY_COUNTRY_IE:
371 if (ath_is_world_regd(reg))
372 ath_reg_apply_world_flags(wiphy, request->initiator,
379 EXPORT_SYMBOL(ath_reg_notifier_apply);
381 static bool ath_regd_is_eeprom_valid(struct ath_regulatory *reg)
383 u16 rd = ath_regd_get_eepromRD(reg);
386 if (rd & COUNTRY_ERD_FLAG) {
387 /* EEPROM value is a country code */
388 u16 cc = rd & ~COUNTRY_ERD_FLAG;
390 "ath: EEPROM indicates we should expect "
392 for (i = 0; i < ARRAY_SIZE(allCountries); i++)
393 if (allCountries[i].countryCode == cc)
396 /* EEPROM value is a regpair value */
397 if (rd != CTRY_DEFAULT)
398 printk(KERN_DEBUG "ath: EEPROM indicates we "
399 "should expect a direct regpair map\n");
400 for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++)
401 if (regDomainPairs[i].regDmnEnum == rd)
405 "ath: invalid regulatory domain/country code 0x%x\n", rd);
409 /* EEPROM country code to regpair mapping */
410 static struct country_code_to_enum_rd*
411 ath_regd_find_country(u16 countryCode)
415 for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
416 if (allCountries[i].countryCode == countryCode)
417 return &allCountries[i];
422 /* EEPROM rd code to regpair mapping */
423 static struct country_code_to_enum_rd*
424 ath_regd_find_country_by_rd(int regdmn)
428 for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
429 if (allCountries[i].regDmnEnum == regdmn)
430 return &allCountries[i];
435 /* Returns the map of the EEPROM set RD to a country code */
436 static u16 ath_regd_get_default_country(u16 rd)
438 if (rd & COUNTRY_ERD_FLAG) {
439 struct country_code_to_enum_rd *country = NULL;
440 u16 cc = rd & ~COUNTRY_ERD_FLAG;
442 country = ath_regd_find_country(cc);
450 static struct reg_dmn_pair_mapping*
451 ath_get_regpair(int regdmn)
455 if (regdmn == NO_ENUMRD)
457 for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++) {
458 if (regDomainPairs[i].regDmnEnum == regdmn)
459 return ®DomainPairs[i];
465 ath_regd_init_wiphy(struct ath_regulatory *reg,
467 int (*reg_notifier)(struct wiphy *wiphy,
468 struct regulatory_request *request))
470 const struct ieee80211_regdomain *regd;
472 wiphy->reg_notifier = reg_notifier;
473 wiphy->flags |= WIPHY_FLAG_STRICT_REGULATORY;
475 if (ath_is_world_regd(reg)) {
477 * Anything applied here (prior to wiphy registration) gets
478 * saved on the wiphy orig_* parameters
480 regd = ath_world_regdomain(reg);
481 wiphy->flags |= WIPHY_FLAG_CUSTOM_REGULATORY;
484 * This gets applied in the case of the absence of CRDA,
485 * it's our own custom world regulatory domain, similar to
486 * cfg80211's but we enable passive scanning.
488 regd = ath_default_world_regdomain();
490 wiphy_apply_custom_regulatory(wiphy, regd);
491 ath_reg_apply_radar_flags(wiphy);
492 ath_reg_apply_world_flags(wiphy, NL80211_REGDOM_SET_BY_DRIVER, reg);
497 * Some users have reported their EEPROM programmed with
498 * 0x8000 set, this is not a supported regulatory domain
499 * but since we have more than one user with it we need
500 * a solution for them. We default to 0x64, which is the
501 * default Atheros world regulatory domain.
503 static void ath_regd_sanitize(struct ath_regulatory *reg)
505 if (reg->current_rd != COUNTRY_ERD_FLAG)
507 printk(KERN_DEBUG "ath: EEPROM regdomain sanitized\n");
508 reg->current_rd = 0x64;
512 ath_regd_init(struct ath_regulatory *reg,
514 int (*reg_notifier)(struct wiphy *wiphy,
515 struct regulatory_request *request))
517 struct country_code_to_enum_rd *country = NULL;
523 ath_regd_sanitize(reg);
525 printk(KERN_DEBUG "ath: EEPROM regdomain: 0x%0x\n", reg->current_rd);
527 if (!ath_regd_is_eeprom_valid(reg)) {
528 printk(KERN_ERR "ath: Invalid EEPROM contents\n");
532 regdmn = ath_regd_get_eepromRD(reg);
533 reg->country_code = ath_regd_get_default_country(regdmn);
535 if (reg->country_code == CTRY_DEFAULT &&
536 regdmn == CTRY_DEFAULT) {
537 printk(KERN_DEBUG "ath: EEPROM indicates default "
538 "country code should be used\n");
539 reg->country_code = CTRY_UNITED_STATES;
542 if (reg->country_code == CTRY_DEFAULT) {
545 printk(KERN_DEBUG "ath: doing EEPROM country->regdmn "
547 country = ath_regd_find_country(reg->country_code);
548 if (country == NULL) {
550 "ath: no valid country maps found for "
551 "country code: 0x%0x\n",
555 regdmn = country->regDmnEnum;
556 printk(KERN_DEBUG "ath: country maps to "
557 "regdmn code: 0x%0x\n",
562 reg->regpair = ath_get_regpair(regdmn);
565 printk(KERN_DEBUG "ath: "
566 "No regulatory domain pair found, cannot continue\n");
571 country = ath_regd_find_country_by_rd(regdmn);
574 reg->alpha2[0] = country->isoName[0];
575 reg->alpha2[1] = country->isoName[1];
577 reg->alpha2[0] = '0';
578 reg->alpha2[1] = '0';
581 printk(KERN_DEBUG "ath: Country alpha2 being used: %c%c\n",
582 reg->alpha2[0], reg->alpha2[1]);
583 printk(KERN_DEBUG "ath: Regpair used: 0x%0x\n",
584 reg->regpair->regDmnEnum);
586 ath_regd_init_wiphy(reg, wiphy, reg_notifier);
589 EXPORT_SYMBOL(ath_regd_init);
591 u32 ath_regd_get_band_ctl(struct ath_regulatory *reg,
592 enum ieee80211_band band)
595 (reg->country_code == CTRY_DEFAULT &&
596 is_wwr_sku(ath_regd_get_eepromRD(reg)))) {
601 case IEEE80211_BAND_2GHZ:
602 return reg->regpair->reg_2ghz_ctl;
603 case IEEE80211_BAND_5GHZ:
604 return reg->regpair->reg_5ghz_ctl;
609 EXPORT_SYMBOL(ath_regd_get_band_ctl);