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/slab.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, \
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, 0x6A and 0x68 */
101 static const struct ieee80211_regdomain ath_world_regdom_67_68_6A = {
111 static inline bool is_wwr_sku(u16 regd)
113 return ((regd & WORLD_SKU_MASK) == WORLD_SKU_PREFIX) ||
117 static u16 ath_regd_get_eepromRD(struct ath_regulatory *reg)
119 return reg->current_rd & ~WORLDWIDE_ROAMING_FLAG;
122 bool ath_is_world_regd(struct ath_regulatory *reg)
124 return is_wwr_sku(ath_regd_get_eepromRD(reg));
126 EXPORT_SYMBOL(ath_is_world_regd);
128 static const struct ieee80211_regdomain *ath_default_world_regdomain(void)
130 /* this is the most restrictive */
131 return &ath_world_regdom_64;
135 ieee80211_regdomain *ath_world_regdomain(struct ath_regulatory *reg)
137 switch (reg->regpair->regDmnEnum) {
141 return &ath_world_regdom_60_61_62;
144 return &ath_world_regdom_63_65;
146 return &ath_world_regdom_64;
149 return &ath_world_regdom_66_69;
153 return &ath_world_regdom_67_68_6A;
156 return ath_default_world_regdomain();
160 /* Frequency is one where radar detection is required */
161 static bool ath_is_radar_freq(u16 center_freq)
163 return (center_freq >= 5260 && center_freq <= 5700);
167 * N.B: These exception rules do not apply radar freqs.
169 * - We enable adhoc (or beaconing) if allowed by 11d
170 * - We enable active scan if the channel is allowed by 11d
171 * - If no country IE has been processed and a we determine we have
172 * received a beacon on a channel we can enable active scan and
173 * adhoc (or beaconing).
176 ath_reg_apply_beaconing_flags(struct wiphy *wiphy,
177 enum nl80211_reg_initiator initiator)
179 enum ieee80211_band band;
180 struct ieee80211_supported_band *sband;
181 const struct ieee80211_reg_rule *reg_rule;
182 struct ieee80211_channel *ch;
187 for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
189 if (!wiphy->bands[band])
192 sband = wiphy->bands[band];
194 for (i = 0; i < sband->n_channels; i++) {
196 ch = &sband->channels[i];
198 if (ath_is_radar_freq(ch->center_freq) ||
199 (ch->flags & IEEE80211_CHAN_RADAR))
202 if (initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE) {
203 r = freq_reg_info(wiphy, ch->center_freq,
204 &bandwidth, ®_rule);
208 * If 11d had a rule for this channel ensure
209 * we enable adhoc/beaconing if it allows us to
210 * use it. Note that we would have disabled it
211 * by applying our static world regdomain by
212 * default during init, prior to calling our
215 if (!(reg_rule->flags &
216 NL80211_RRF_NO_IBSS))
218 ~IEEE80211_CHAN_NO_IBSS;
219 if (!(reg_rule->flags &
220 NL80211_RRF_PASSIVE_SCAN))
222 ~IEEE80211_CHAN_PASSIVE_SCAN;
224 if (ch->beacon_found)
225 ch->flags &= ~(IEEE80211_CHAN_NO_IBSS |
226 IEEE80211_CHAN_PASSIVE_SCAN);
233 /* Allows active scan scan on Ch 12 and 13 */
235 ath_reg_apply_active_scan_flags(struct wiphy *wiphy,
236 enum nl80211_reg_initiator initiator)
238 struct ieee80211_supported_band *sband;
239 struct ieee80211_channel *ch;
240 const struct ieee80211_reg_rule *reg_rule;
244 sband = wiphy->bands[IEEE80211_BAND_2GHZ];
247 * If no country IE has been received always enable active scan
248 * on these channels. This is only done for specific regulatory SKUs
250 if (initiator != NL80211_REGDOM_SET_BY_COUNTRY_IE) {
251 ch = &sband->channels[11]; /* CH 12 */
252 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
253 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
254 ch = &sband->channels[12]; /* CH 13 */
255 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
256 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
261 * If a country IE has been recieved check its rule for this
262 * channel first before enabling active scan. The passive scan
263 * would have been enforced by the initial processing of our
264 * custom regulatory domain.
267 ch = &sband->channels[11]; /* CH 12 */
268 r = freq_reg_info(wiphy, ch->center_freq, &bandwidth, ®_rule);
270 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
271 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
272 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
275 ch = &sband->channels[12]; /* CH 13 */
276 r = freq_reg_info(wiphy, ch->center_freq, &bandwidth, ®_rule);
278 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
279 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
280 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
284 /* Always apply Radar/DFS rules on freq range 5260 MHz - 5700 MHz */
285 static void ath_reg_apply_radar_flags(struct wiphy *wiphy)
287 struct ieee80211_supported_band *sband;
288 struct ieee80211_channel *ch;
291 if (!wiphy->bands[IEEE80211_BAND_5GHZ])
294 sband = wiphy->bands[IEEE80211_BAND_5GHZ];
296 for (i = 0; i < sband->n_channels; i++) {
297 ch = &sband->channels[i];
298 if (!ath_is_radar_freq(ch->center_freq))
300 /* We always enable radar detection/DFS on this
301 * frequency range. Additionally we also apply on
302 * this frequency range:
303 * - If STA mode does not yet have DFS supports disable
305 * - If adhoc mode does not support DFS yet then
306 * disable adhoc in the frequency.
307 * - If AP mode does not yet support radar detection/DFS
308 * do not allow AP mode
310 if (!(ch->flags & IEEE80211_CHAN_DISABLED))
311 ch->flags |= IEEE80211_CHAN_RADAR |
312 IEEE80211_CHAN_NO_IBSS |
313 IEEE80211_CHAN_PASSIVE_SCAN;
317 static void ath_reg_apply_world_flags(struct wiphy *wiphy,
318 enum nl80211_reg_initiator initiator,
319 struct ath_regulatory *reg)
321 switch (reg->regpair->regDmnEnum) {
326 ath_reg_apply_beaconing_flags(wiphy, initiator);
329 ath_reg_apply_beaconing_flags(wiphy, initiator);
330 ath_reg_apply_active_scan_flags(wiphy, initiator);
336 int ath_reg_notifier_apply(struct wiphy *wiphy,
337 struct regulatory_request *request,
338 struct ath_regulatory *reg)
340 /* We always apply this */
341 ath_reg_apply_radar_flags(wiphy);
343 switch (request->initiator) {
344 case NL80211_REGDOM_SET_BY_DRIVER:
345 case NL80211_REGDOM_SET_BY_CORE:
346 case NL80211_REGDOM_SET_BY_USER:
348 case NL80211_REGDOM_SET_BY_COUNTRY_IE:
349 if (ath_is_world_regd(reg))
350 ath_reg_apply_world_flags(wiphy, request->initiator,
357 EXPORT_SYMBOL(ath_reg_notifier_apply);
359 static bool ath_regd_is_eeprom_valid(struct ath_regulatory *reg)
361 u16 rd = ath_regd_get_eepromRD(reg);
364 if (rd & COUNTRY_ERD_FLAG) {
365 /* EEPROM value is a country code */
366 u16 cc = rd & ~COUNTRY_ERD_FLAG;
367 for (i = 0; i < ARRAY_SIZE(allCountries); i++)
368 if (allCountries[i].countryCode == cc)
371 /* EEPROM value is a regpair value */
372 for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++)
373 if (regDomainPairs[i].regDmnEnum == rd)
377 "ath: invalid regulatory domain/country code 0x%x\n", rd);
381 /* EEPROM country code to regpair mapping */
382 static struct country_code_to_enum_rd*
383 ath_regd_find_country(u16 countryCode)
387 for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
388 if (allCountries[i].countryCode == countryCode)
389 return &allCountries[i];
394 /* EEPROM rd code to regpair mapping */
395 static struct country_code_to_enum_rd*
396 ath_regd_find_country_by_rd(int regdmn)
400 for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
401 if (allCountries[i].regDmnEnum == regdmn)
402 return &allCountries[i];
407 /* Returns the map of the EEPROM set RD to a country code */
408 static u16 ath_regd_get_default_country(u16 rd)
410 if (rd & COUNTRY_ERD_FLAG) {
411 struct country_code_to_enum_rd *country = NULL;
412 u16 cc = rd & ~COUNTRY_ERD_FLAG;
414 country = ath_regd_find_country(cc);
422 static struct reg_dmn_pair_mapping*
423 ath_get_regpair(int regdmn)
427 if (regdmn == NO_ENUMRD)
429 for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++) {
430 if (regDomainPairs[i].regDmnEnum == regdmn)
431 return ®DomainPairs[i];
437 ath_regd_init_wiphy(struct ath_regulatory *reg,
439 int (*reg_notifier)(struct wiphy *wiphy,
440 struct regulatory_request *request))
442 const struct ieee80211_regdomain *regd;
444 wiphy->reg_notifier = reg_notifier;
445 wiphy->strict_regulatory = true;
447 if (ath_is_world_regd(reg)) {
449 * Anything applied here (prior to wiphy registration) gets
450 * saved on the wiphy orig_* parameters
452 regd = ath_world_regdomain(reg);
453 wiphy->custom_regulatory = true;
454 wiphy->strict_regulatory = false;
457 * This gets applied in the case of the absense of CRDA,
458 * it's our own custom world regulatory domain, similar to
459 * cfg80211's but we enable passive scanning.
461 regd = ath_default_world_regdomain();
463 wiphy_apply_custom_regulatory(wiphy, regd);
464 ath_reg_apply_radar_flags(wiphy);
465 ath_reg_apply_world_flags(wiphy, NL80211_REGDOM_SET_BY_DRIVER, reg);
470 ath_regd_init(struct ath_regulatory *reg,
472 int (*reg_notifier)(struct wiphy *wiphy,
473 struct regulatory_request *request))
475 struct country_code_to_enum_rd *country = NULL;
478 if (!ath_regd_is_eeprom_valid(reg)) {
479 printk(KERN_ERR "ath: Invalid EEPROM contents\n");
483 regdmn = ath_regd_get_eepromRD(reg);
484 reg->country_code = ath_regd_get_default_country(regdmn);
486 if (reg->country_code == CTRY_DEFAULT &&
487 regdmn == CTRY_DEFAULT)
488 reg->country_code = CTRY_UNITED_STATES;
490 if (reg->country_code == CTRY_DEFAULT) {
493 country = ath_regd_find_country(reg->country_code);
494 if (country == NULL) {
496 "ath: Country is NULL!!!!, cc= %d\n",
500 regdmn = country->regDmnEnum;
503 reg->regpair = ath_get_regpair(regdmn);
506 printk(KERN_DEBUG "ath: "
507 "No regulatory domain pair found, cannot continue\n");
512 country = ath_regd_find_country_by_rd(regdmn);
515 reg->alpha2[0] = country->isoName[0];
516 reg->alpha2[1] = country->isoName[1];
518 reg->alpha2[0] = '0';
519 reg->alpha2[1] = '0';
522 printk(KERN_DEBUG "ath: Country alpha2 being used: %c%c\n",
523 reg->alpha2[0], reg->alpha2[1]);
524 printk(KERN_DEBUG "ath: Regpair detected: 0x%0x\n",
525 reg->regpair->regDmnEnum);
527 ath_regd_init_wiphy(reg, wiphy, reg_notifier);
530 EXPORT_SYMBOL(ath_regd_init);
532 u32 ath_regd_get_band_ctl(struct ath_regulatory *reg,
533 enum ieee80211_band band)
536 (reg->country_code == CTRY_DEFAULT &&
537 is_wwr_sku(ath_regd_get_eepromRD(reg)))) {
542 case IEEE80211_BAND_2GHZ:
543 return reg->regpair->reg_2ghz_ctl;
544 case IEEE80211_BAND_5GHZ:
545 return reg->regpair->reg_5ghz_ctl;
552 EXPORT_SYMBOL(ath_regd_get_band_ctl);