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 <net/cfg80211.h>
19 #include <net/mac80211.h>
21 #include "regd_common.h"
24 * This is a set of common rules used by our world regulatory domains.
25 * We have 12 world regulatory domains. To save space we consolidate
26 * the regulatory domains in 5 structures by frequency and change
27 * the flags on our reg_notifier() on a case by case basis.
30 /* Only these channels all allow active scan on all world regulatory domains */
31 #define ATH9K_2GHZ_CH01_11 REG_RULE(2412-10, 2462+10, 40, 0, 20, 0)
33 /* We enable active scan on these a case by case basis by regulatory domain */
34 #define ATH9K_2GHZ_CH12_13 REG_RULE(2467-10, 2472+10, 40, 0, 20,\
35 NL80211_RRF_PASSIVE_SCAN)
36 #define ATH9K_2GHZ_CH14 REG_RULE(2484-10, 2484+10, 40, 0, 20,\
37 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_OFDM)
39 /* We allow IBSS on these on a case by case basis by regulatory domain */
40 #define ATH9K_5GHZ_5150_5350 REG_RULE(5150-10, 5350+10, 40, 0, 30,\
41 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_IBSS)
42 #define ATH9K_5GHZ_5470_5850 REG_RULE(5470-10, 5850+10, 40, 0, 30,\
43 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_IBSS)
44 #define ATH9K_5GHZ_5725_5850 REG_RULE(5725-10, 5850+10, 40, 0, 30,\
45 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_IBSS)
47 #define ATH9K_2GHZ_ALL ATH9K_2GHZ_CH01_11, \
51 #define ATH9K_5GHZ_ALL ATH9K_5GHZ_5150_5350, \
54 /* This one skips what we call "mid band" */
55 #define ATH9K_5GHZ_NO_MIDBAND ATH9K_5GHZ_5150_5350, \
60 static const struct ieee80211_regdomain ath_world_regdom_60_61_62 = {
69 /* Can be used by 0x63 and 0x65 */
70 static const struct ieee80211_regdomain ath_world_regdom_63_65 = {
76 ATH9K_5GHZ_NO_MIDBAND,
80 /* Can be used by 0x64 only */
81 static const struct ieee80211_regdomain ath_world_regdom_64 = {
86 ATH9K_5GHZ_NO_MIDBAND,
90 /* Can be used by 0x66 and 0x69 */
91 static const struct ieee80211_regdomain ath_world_regdom_66_69 = {
100 /* Can be used by 0x67, 0x68, 0x6A and 0x6C */
101 static const struct ieee80211_regdomain ath_world_regdom_67_68_6A_6C = {
111 static inline bool is_wwr_sku(u16 regd)
113 return ((regd & COUNTRY_ERD_FLAG) != COUNTRY_ERD_FLAG) &&
114 (((regd & WORLD_SKU_MASK) == WORLD_SKU_PREFIX) ||
118 static u16 ath_regd_get_eepromRD(struct ath_regulatory *reg)
120 return reg->current_rd & ~WORLDWIDE_ROAMING_FLAG;
123 bool ath_is_world_regd(struct ath_regulatory *reg)
125 return is_wwr_sku(ath_regd_get_eepromRD(reg));
127 EXPORT_SYMBOL(ath_is_world_regd);
129 static const struct ieee80211_regdomain *ath_default_world_regdomain(void)
131 /* this is the most restrictive */
132 return &ath_world_regdom_64;
136 ieee80211_regdomain *ath_world_regdomain(struct ath_regulatory *reg)
138 switch (reg->regpair->regDmnEnum) {
142 return &ath_world_regdom_60_61_62;
145 return &ath_world_regdom_63_65;
147 return &ath_world_regdom_64;
150 return &ath_world_regdom_66_69;
155 return &ath_world_regdom_67_68_6A_6C;
158 return ath_default_world_regdomain();
162 bool ath_is_49ghz_allowed(u16 regdomain)
165 return regdomain == MKK9_MKKC;
167 EXPORT_SYMBOL(ath_is_49ghz_allowed);
169 /* Frequency is one where radar detection is required */
170 static bool ath_is_radar_freq(u16 center_freq)
172 return (center_freq >= 5260 && center_freq <= 5700);
176 * N.B: These exception rules do not apply radar freqs.
178 * - We enable adhoc (or beaconing) if allowed by 11d
179 * - We enable active scan if the channel is allowed by 11d
180 * - If no country IE has been processed and a we determine we have
181 * received a beacon on a channel we can enable active scan and
182 * adhoc (or beaconing).
185 ath_reg_apply_beaconing_flags(struct wiphy *wiphy,
186 enum nl80211_reg_initiator initiator)
188 enum ieee80211_band band;
189 struct ieee80211_supported_band *sband;
190 const struct ieee80211_reg_rule *reg_rule;
191 struct ieee80211_channel *ch;
196 for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
198 if (!wiphy->bands[band])
201 sband = wiphy->bands[band];
203 for (i = 0; i < sband->n_channels; i++) {
205 ch = &sband->channels[i];
207 if (ath_is_radar_freq(ch->center_freq) ||
208 (ch->flags & IEEE80211_CHAN_RADAR))
211 if (initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE) {
212 r = freq_reg_info(wiphy,
219 * If 11d had a rule for this channel ensure
220 * we enable adhoc/beaconing if it allows us to
221 * use it. Note that we would have disabled it
222 * by applying our static world regdomain by
223 * default during init, prior to calling our
226 if (!(reg_rule->flags &
227 NL80211_RRF_NO_IBSS))
229 ~IEEE80211_CHAN_NO_IBSS;
230 if (!(reg_rule->flags &
231 NL80211_RRF_PASSIVE_SCAN))
233 ~IEEE80211_CHAN_PASSIVE_SCAN;
235 if (ch->beacon_found)
236 ch->flags &= ~(IEEE80211_CHAN_NO_IBSS |
237 IEEE80211_CHAN_PASSIVE_SCAN);
244 /* Allows active scan scan on Ch 12 and 13 */
246 ath_reg_apply_active_scan_flags(struct wiphy *wiphy,
247 enum nl80211_reg_initiator initiator)
249 struct ieee80211_supported_band *sband;
250 struct ieee80211_channel *ch;
251 const struct ieee80211_reg_rule *reg_rule;
255 sband = wiphy->bands[IEEE80211_BAND_2GHZ];
260 * If no country IE has been received always enable active scan
261 * on these channels. This is only done for specific regulatory SKUs
263 if (initiator != NL80211_REGDOM_SET_BY_COUNTRY_IE) {
264 ch = &sband->channels[11]; /* CH 12 */
265 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
266 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
267 ch = &sband->channels[12]; /* CH 13 */
268 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
269 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
274 * If a country IE has been received check its rule for this
275 * channel first before enabling active scan. The passive scan
276 * would have been enforced by the initial processing of our
277 * custom regulatory domain.
280 ch = &sband->channels[11]; /* CH 12 */
281 r = freq_reg_info(wiphy, ch->center_freq, bandwidth, ®_rule);
283 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
284 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
285 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
288 ch = &sband->channels[12]; /* CH 13 */
289 r = freq_reg_info(wiphy, ch->center_freq, bandwidth, ®_rule);
291 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
292 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
293 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
297 /* Always apply Radar/DFS rules on freq range 5260 MHz - 5700 MHz */
298 static void ath_reg_apply_radar_flags(struct wiphy *wiphy)
300 struct ieee80211_supported_band *sband;
301 struct ieee80211_channel *ch;
304 if (!wiphy->bands[IEEE80211_BAND_5GHZ])
307 sband = wiphy->bands[IEEE80211_BAND_5GHZ];
309 for (i = 0; i < sband->n_channels; i++) {
310 ch = &sband->channels[i];
311 if (!ath_is_radar_freq(ch->center_freq))
313 /* We always enable radar detection/DFS on this
314 * frequency range. Additionally we also apply on
315 * this frequency range:
316 * - If STA mode does not yet have DFS supports disable
318 * - If adhoc mode does not support DFS yet then
319 * disable adhoc in the frequency.
320 * - If AP mode does not yet support radar detection/DFS
321 * do not allow AP mode
323 if (!(ch->flags & IEEE80211_CHAN_DISABLED))
324 ch->flags |= IEEE80211_CHAN_RADAR |
325 IEEE80211_CHAN_NO_IBSS |
326 IEEE80211_CHAN_PASSIVE_SCAN;
330 static void ath_reg_apply_world_flags(struct wiphy *wiphy,
331 enum nl80211_reg_initiator initiator,
332 struct ath_regulatory *reg)
334 switch (reg->regpair->regDmnEnum) {
340 ath_reg_apply_beaconing_flags(wiphy, initiator);
343 ath_reg_apply_beaconing_flags(wiphy, initiator);
344 ath_reg_apply_active_scan_flags(wiphy, initiator);
349 int ath_reg_notifier_apply(struct wiphy *wiphy,
350 struct regulatory_request *request,
351 struct ath_regulatory *reg)
353 /* We always apply this */
354 ath_reg_apply_radar_flags(wiphy);
357 * This would happen when we have sent a custom regulatory request
358 * a world regulatory domain and the scheduler hasn't yet processed
359 * any pending requests in the queue.
364 switch (request->initiator) {
365 case NL80211_REGDOM_SET_BY_DRIVER:
366 case NL80211_REGDOM_SET_BY_CORE:
367 case NL80211_REGDOM_SET_BY_USER:
369 case NL80211_REGDOM_SET_BY_COUNTRY_IE:
370 if (ath_is_world_regd(reg))
371 ath_reg_apply_world_flags(wiphy, request->initiator,
378 EXPORT_SYMBOL(ath_reg_notifier_apply);
380 static bool ath_regd_is_eeprom_valid(struct ath_regulatory *reg)
382 u16 rd = ath_regd_get_eepromRD(reg);
385 if (rd & COUNTRY_ERD_FLAG) {
386 /* EEPROM value is a country code */
387 u16 cc = rd & ~COUNTRY_ERD_FLAG;
389 "ath: EEPROM indicates we should expect "
391 for (i = 0; i < ARRAY_SIZE(allCountries); i++)
392 if (allCountries[i].countryCode == cc)
395 /* EEPROM value is a regpair value */
396 if (rd != CTRY_DEFAULT)
397 printk(KERN_DEBUG "ath: EEPROM indicates we "
398 "should expect a direct regpair map\n");
399 for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++)
400 if (regDomainPairs[i].regDmnEnum == rd)
404 "ath: invalid regulatory domain/country code 0x%x\n", rd);
408 /* EEPROM country code to regpair mapping */
409 static struct country_code_to_enum_rd*
410 ath_regd_find_country(u16 countryCode)
414 for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
415 if (allCountries[i].countryCode == countryCode)
416 return &allCountries[i];
421 /* EEPROM rd code to regpair mapping */
422 static struct country_code_to_enum_rd*
423 ath_regd_find_country_by_rd(int regdmn)
427 for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
428 if (allCountries[i].regDmnEnum == regdmn)
429 return &allCountries[i];
434 /* Returns the map of the EEPROM set RD to a country code */
435 static u16 ath_regd_get_default_country(u16 rd)
437 if (rd & COUNTRY_ERD_FLAG) {
438 struct country_code_to_enum_rd *country = NULL;
439 u16 cc = rd & ~COUNTRY_ERD_FLAG;
441 country = ath_regd_find_country(cc);
449 static struct reg_dmn_pair_mapping*
450 ath_get_regpair(int regdmn)
454 if (regdmn == NO_ENUMRD)
456 for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++) {
457 if (regDomainPairs[i].regDmnEnum == regdmn)
458 return ®DomainPairs[i];
464 ath_regd_init_wiphy(struct ath_regulatory *reg,
466 int (*reg_notifier)(struct wiphy *wiphy,
467 struct regulatory_request *request))
469 const struct ieee80211_regdomain *regd;
471 wiphy->reg_notifier = reg_notifier;
472 wiphy->flags |= WIPHY_FLAG_STRICT_REGULATORY;
474 if (ath_is_world_regd(reg)) {
476 * Anything applied here (prior to wiphy registration) gets
477 * saved on the wiphy orig_* parameters
479 regd = ath_world_regdomain(reg);
480 wiphy->flags |= WIPHY_FLAG_CUSTOM_REGULATORY;
483 * This gets applied in the case of the absence of CRDA,
484 * it's our own custom world regulatory domain, similar to
485 * cfg80211's but we enable passive scanning.
487 regd = ath_default_world_regdomain();
489 wiphy_apply_custom_regulatory(wiphy, regd);
490 ath_reg_apply_radar_flags(wiphy);
491 ath_reg_apply_world_flags(wiphy, NL80211_REGDOM_SET_BY_DRIVER, reg);
496 * Some users have reported their EEPROM programmed with
497 * 0x8000 set, this is not a supported regulatory domain
498 * but since we have more than one user with it we need
499 * a solution for them. We default to 0x64, which is the
500 * default Atheros world regulatory domain.
502 static void ath_regd_sanitize(struct ath_regulatory *reg)
504 if (reg->current_rd != COUNTRY_ERD_FLAG)
506 printk(KERN_DEBUG "ath: EEPROM regdomain sanitized\n");
507 reg->current_rd = 0x64;
511 ath_regd_init(struct ath_regulatory *reg,
513 int (*reg_notifier)(struct wiphy *wiphy,
514 struct regulatory_request *request))
516 struct country_code_to_enum_rd *country = NULL;
522 ath_regd_sanitize(reg);
524 printk(KERN_DEBUG "ath: EEPROM regdomain: 0x%0x\n", reg->current_rd);
526 if (!ath_regd_is_eeprom_valid(reg)) {
527 printk(KERN_ERR "ath: Invalid EEPROM contents\n");
531 regdmn = ath_regd_get_eepromRD(reg);
532 reg->country_code = ath_regd_get_default_country(regdmn);
534 if (reg->country_code == CTRY_DEFAULT &&
535 regdmn == CTRY_DEFAULT) {
536 printk(KERN_DEBUG "ath: EEPROM indicates default "
537 "country code should be used\n");
538 reg->country_code = CTRY_UNITED_STATES;
541 if (reg->country_code == CTRY_DEFAULT) {
544 printk(KERN_DEBUG "ath: doing EEPROM country->regdmn "
546 country = ath_regd_find_country(reg->country_code);
547 if (country == NULL) {
549 "ath: no valid country maps found for "
550 "country code: 0x%0x\n",
554 regdmn = country->regDmnEnum;
555 printk(KERN_DEBUG "ath: country maps to "
556 "regdmn code: 0x%0x\n",
561 reg->regpair = ath_get_regpair(regdmn);
564 printk(KERN_DEBUG "ath: "
565 "No regulatory domain pair found, cannot continue\n");
570 country = ath_regd_find_country_by_rd(regdmn);
573 reg->alpha2[0] = country->isoName[0];
574 reg->alpha2[1] = country->isoName[1];
576 reg->alpha2[0] = '0';
577 reg->alpha2[1] = '0';
580 printk(KERN_DEBUG "ath: Country alpha2 being used: %c%c\n",
581 reg->alpha2[0], reg->alpha2[1]);
582 printk(KERN_DEBUG "ath: Regpair used: 0x%0x\n",
583 reg->regpair->regDmnEnum);
585 ath_regd_init_wiphy(reg, wiphy, reg_notifier);
588 EXPORT_SYMBOL(ath_regd_init);
590 u32 ath_regd_get_band_ctl(struct ath_regulatory *reg,
591 enum ieee80211_band band)
594 (reg->country_code == CTRY_DEFAULT &&
595 is_wwr_sku(ath_regd_get_eepromRD(reg)))) {
600 case IEEE80211_BAND_2GHZ:
601 return reg->regpair->reg_2ghz_ctl;
602 case IEEE80211_BAND_5GHZ:
603 return reg->regpair->reg_5ghz_ctl;
608 EXPORT_SYMBOL(ath_regd_get_band_ctl);