1 /*
2 * Copyright (c) 2008-2009 Atheros Communications Inc.
3 *
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.
7 *
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.
15 */
16
17 #include <linux/kernel.h>
18 #include <net/cfg80211.h>
19 #include <net/mac80211.h>
20 #include "regd.h"
21 #include "regd_common.h"
22
23 /*
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.
28 */
29
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)
32
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)
38
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)
46
47 #define ATH9K_2GHZ_ALL ATH9K_2GHZ_CH01_11, \
48 ATH9K_2GHZ_CH12_13, \
49 ATH9K_2GHZ_CH14
50
51 #define ATH9K_5GHZ_ALL ATH9K_5GHZ_5150_5350, \
52 ATH9K_5GHZ_5470_5850
53
54 /* This one skips what we call "mid band" */
55 #define ATH9K_5GHZ_NO_MIDBAND ATH9K_5GHZ_5150_5350, \
56 ATH9K_5GHZ_5725_5850
57
58 /* Can be used for:
59 * 0x60, 0x61, 0x62 */
60 static const struct ieee80211_regdomain ath_world_regdom_60_61_62 = {
61 .n_reg_rules = 5,
62 .alpha2 = "99",
63 .reg_rules = {
64 ATH9K_2GHZ_ALL,
65 ATH9K_5GHZ_ALL,
66 }
67 };
68
69 /* Can be used by 0x63 and 0x65 */
70 static const struct ieee80211_regdomain ath_world_regdom_63_65 = {
71 .n_reg_rules = 4,
72 .alpha2 = "99",
73 .reg_rules = {
74 ATH9K_2GHZ_CH01_11,
75 ATH9K_2GHZ_CH12_13,
76 ATH9K_5GHZ_NO_MIDBAND,
77 }
78 };
79
80 /* Can be used by 0x64 only */
81 static const struct ieee80211_regdomain ath_world_regdom_64 = {
82 .n_reg_rules = 3,
83 .alpha2 = "99",
84 .reg_rules = {
85 ATH9K_2GHZ_CH01_11,
86 ATH9K_5GHZ_NO_MIDBAND,
87 }
88 };
89
90 /* Can be used by 0x66 and 0x69 */
91 static const struct ieee80211_regdomain ath_world_regdom_66_69 = {
92 .n_reg_rules = 3,
93 .alpha2 = "99",
94 .reg_rules = {
95 ATH9K_2GHZ_CH01_11,
96 ATH9K_5GHZ_ALL,
97 }
98 };
99
100 /* Can be used by 0x67, 0x6A and 0x68 */
101 static const struct ieee80211_regdomain ath_world_regdom_67_68_6A = {
102 .n_reg_rules = 4,
103 .alpha2 = "99",
104 .reg_rules = {
105 ATH9K_2GHZ_CH01_11,
106 ATH9K_2GHZ_CH12_13,
107 ATH9K_5GHZ_ALL,
108 }
109 };
110
is_wwr_sku(u16 regd)111 static inline bool is_wwr_sku(u16 regd)
112 {
113 return ((regd & COUNTRY_ERD_FLAG) != COUNTRY_ERD_FLAG) &&
114 (((regd & WORLD_SKU_MASK) == WORLD_SKU_PREFIX) ||
115 (regd == WORLD));
116 }
117
ath_regd_get_eepromRD(struct ath_regulatory * reg)118 static u16 ath_regd_get_eepromRD(struct ath_regulatory *reg)
119 {
120 return reg->current_rd & ~WORLDWIDE_ROAMING_FLAG;
121 }
122
ath_is_world_regd(struct ath_regulatory * reg)123 bool ath_is_world_regd(struct ath_regulatory *reg)
124 {
125 return is_wwr_sku(ath_regd_get_eepromRD(reg));
126 }
127 EXPORT_SYMBOL(ath_is_world_regd);
128
ath_default_world_regdomain(void)129 static const struct ieee80211_regdomain *ath_default_world_regdomain(void)
130 {
131 /* this is the most restrictive */
132 return &ath_world_regdom_64;
133 }
134
135 static const struct
ath_world_regdomain(struct ath_regulatory * reg)136 ieee80211_regdomain *ath_world_regdomain(struct ath_regulatory *reg)
137 {
138 switch (reg->regpair->regDmnEnum) {
139 case 0x60:
140 case 0x61:
141 case 0x62:
142 return &ath_world_regdom_60_61_62;
143 case 0x63:
144 case 0x65:
145 return &ath_world_regdom_63_65;
146 case 0x64:
147 return &ath_world_regdom_64;
148 case 0x66:
149 case 0x69:
150 return &ath_world_regdom_66_69;
151 case 0x67:
152 case 0x68:
153 case 0x6A:
154 return &ath_world_regdom_67_68_6A;
155 default:
156 WARN_ON(1);
157 return ath_default_world_regdomain();
158 }
159 }
160
ath_is_49ghz_allowed(u16 regdomain)161 bool ath_is_49ghz_allowed(u16 regdomain)
162 {
163 /* possibly more */
164 return regdomain == MKK9_MKKC;
165 }
166 EXPORT_SYMBOL(ath_is_49ghz_allowed);
167
168 /* Frequency is one where radar detection is required */
ath_is_radar_freq(u16 center_freq)169 static bool ath_is_radar_freq(u16 center_freq)
170 {
171 return (center_freq >= 5260 && center_freq <= 5700);
172 }
173
174 /*
175 * N.B: These exception rules do not apply radar freqs.
176 *
177 * - We enable adhoc (or beaconing) if allowed by 11d
178 * - We enable active scan if the channel is allowed by 11d
179 * - If no country IE has been processed and a we determine we have
180 * received a beacon on a channel we can enable active scan and
181 * adhoc (or beaconing).
182 */
183 static void
ath_reg_apply_beaconing_flags(struct wiphy * wiphy,enum nl80211_reg_initiator initiator)184 ath_reg_apply_beaconing_flags(struct wiphy *wiphy,
185 enum nl80211_reg_initiator initiator)
186 {
187 enum ieee80211_band band;
188 struct ieee80211_supported_band *sband;
189 const struct ieee80211_reg_rule *reg_rule;
190 struct ieee80211_channel *ch;
191 unsigned int i;
192 u32 bandwidth = 0;
193 int r;
194
195 for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
196
197 if (!wiphy->bands[band])
198 continue;
199
200 sband = wiphy->bands[band];
201
202 for (i = 0; i < sband->n_channels; i++) {
203
204 ch = &sband->channels[i];
205
206 if (ath_is_radar_freq(ch->center_freq) ||
207 (ch->flags & IEEE80211_CHAN_RADAR))
208 continue;
209
210 if (initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE) {
211 r = freq_reg_info(wiphy,
212 ch->center_freq,
213 bandwidth,
214 ®_rule);
215 if (r)
216 continue;
217 /*
218 * If 11d had a rule for this channel ensure
219 * we enable adhoc/beaconing if it allows us to
220 * use it. Note that we would have disabled it
221 * by applying our static world regdomain by
222 * default during init, prior to calling our
223 * regulatory_hint().
224 */
225 if (!(reg_rule->flags &
226 NL80211_RRF_NO_IBSS))
227 ch->flags &=
228 ~IEEE80211_CHAN_NO_IBSS;
229 if (!(reg_rule->flags &
230 NL80211_RRF_PASSIVE_SCAN))
231 ch->flags &=
232 ~IEEE80211_CHAN_PASSIVE_SCAN;
233 } else {
234 if (ch->beacon_found)
235 ch->flags &= ~(IEEE80211_CHAN_NO_IBSS |
236 IEEE80211_CHAN_PASSIVE_SCAN);
237 }
238 }
239 }
240
241 }
242
243 /* Allows active scan scan on Ch 12 and 13 */
244 static void
ath_reg_apply_active_scan_flags(struct wiphy * wiphy,enum nl80211_reg_initiator initiator)245 ath_reg_apply_active_scan_flags(struct wiphy *wiphy,
246 enum nl80211_reg_initiator initiator)
247 {
248 struct ieee80211_supported_band *sband;
249 struct ieee80211_channel *ch;
250 const struct ieee80211_reg_rule *reg_rule;
251 u32 bandwidth = 0;
252 int r;
253
254 sband = wiphy->bands[IEEE80211_BAND_2GHZ];
255
256 /*
257 * If no country IE has been received always enable active scan
258 * on these channels. This is only done for specific regulatory SKUs
259 */
260 if (initiator != NL80211_REGDOM_SET_BY_COUNTRY_IE) {
261 ch = &sband->channels[11]; /* CH 12 */
262 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
263 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
264 ch = &sband->channels[12]; /* CH 13 */
265 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
266 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
267 return;
268 }
269
270 /*
271 * If a country IE has been received check its rule for this
272 * channel first before enabling active scan. The passive scan
273 * would have been enforced by the initial processing of our
274 * custom regulatory domain.
275 */
276
277 ch = &sband->channels[11]; /* CH 12 */
278 r = freq_reg_info(wiphy, ch->center_freq, bandwidth, ®_rule);
279 if (!r) {
280 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
281 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
282 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
283 }
284
285 ch = &sband->channels[12]; /* CH 13 */
286 r = freq_reg_info(wiphy, ch->center_freq, bandwidth, ®_rule);
287 if (!r) {
288 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
289 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
290 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
291 }
292 }
293
294 /* Always apply Radar/DFS rules on freq range 5260 MHz - 5700 MHz */
ath_reg_apply_radar_flags(struct wiphy * wiphy)295 static void ath_reg_apply_radar_flags(struct wiphy *wiphy)
296 {
297 struct ieee80211_supported_band *sband;
298 struct ieee80211_channel *ch;
299 unsigned int i;
300
301 if (!wiphy->bands[IEEE80211_BAND_5GHZ])
302 return;
303
304 sband = wiphy->bands[IEEE80211_BAND_5GHZ];
305
306 for (i = 0; i < sband->n_channels; i++) {
307 ch = &sband->channels[i];
308 if (!ath_is_radar_freq(ch->center_freq))
309 continue;
310 /* We always enable radar detection/DFS on this
311 * frequency range. Additionally we also apply on
312 * this frequency range:
313 * - If STA mode does not yet have DFS supports disable
314 * active scanning
315 * - If adhoc mode does not support DFS yet then
316 * disable adhoc in the frequency.
317 * - If AP mode does not yet support radar detection/DFS
318 * do not allow AP mode
319 */
320 if (!(ch->flags & IEEE80211_CHAN_DISABLED))
321 ch->flags |= IEEE80211_CHAN_RADAR |
322 IEEE80211_CHAN_NO_IBSS |
323 IEEE80211_CHAN_PASSIVE_SCAN;
324 }
325 }
326
ath_reg_apply_world_flags(struct wiphy * wiphy,enum nl80211_reg_initiator initiator,struct ath_regulatory * reg)327 static void ath_reg_apply_world_flags(struct wiphy *wiphy,
328 enum nl80211_reg_initiator initiator,
329 struct ath_regulatory *reg)
330 {
331 switch (reg->regpair->regDmnEnum) {
332 case 0x60:
333 case 0x63:
334 case 0x66:
335 case 0x67:
336 ath_reg_apply_beaconing_flags(wiphy, initiator);
337 break;
338 case 0x68:
339 ath_reg_apply_beaconing_flags(wiphy, initiator);
340 ath_reg_apply_active_scan_flags(wiphy, initiator);
341 break;
342 }
343 }
344
ath_reg_notifier_apply(struct wiphy * wiphy,struct regulatory_request * request,struct ath_regulatory * reg)345 int ath_reg_notifier_apply(struct wiphy *wiphy,
346 struct regulatory_request *request,
347 struct ath_regulatory *reg)
348 {
349 /* We always apply this */
350 ath_reg_apply_radar_flags(wiphy);
351
352 /*
353 * This would happen when we have sent a custom regulatory request
354 * a world regulatory domain and the scheduler hasn't yet processed
355 * any pending requests in the queue.
356 */
357 if (!request)
358 return 0;
359
360 switch (request->initiator) {
361 case NL80211_REGDOM_SET_BY_DRIVER:
362 case NL80211_REGDOM_SET_BY_CORE:
363 case NL80211_REGDOM_SET_BY_USER:
364 break;
365 case NL80211_REGDOM_SET_BY_COUNTRY_IE:
366 if (ath_is_world_regd(reg))
367 ath_reg_apply_world_flags(wiphy, request->initiator,
368 reg);
369 break;
370 }
371
372 return 0;
373 }
374 EXPORT_SYMBOL(ath_reg_notifier_apply);
375
ath_regd_is_eeprom_valid(struct ath_regulatory * reg)376 static bool ath_regd_is_eeprom_valid(struct ath_regulatory *reg)
377 {
378 u16 rd = ath_regd_get_eepromRD(reg);
379 int i;
380
381 if (rd & COUNTRY_ERD_FLAG) {
382 /* EEPROM value is a country code */
383 u16 cc = rd & ~COUNTRY_ERD_FLAG;
384 printk(KERN_DEBUG
385 "ath: EEPROM indicates we should expect "
386 "a country code\n");
387 for (i = 0; i < ARRAY_SIZE(allCountries); i++)
388 if (allCountries[i].countryCode == cc)
389 return true;
390 } else {
391 /* EEPROM value is a regpair value */
392 if (rd != CTRY_DEFAULT)
393 printk(KERN_DEBUG "ath: EEPROM indicates we "
394 "should expect a direct regpair map\n");
395 for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++)
396 if (regDomainPairs[i].regDmnEnum == rd)
397 return true;
398 }
399 printk(KERN_DEBUG
400 "ath: invalid regulatory domain/country code 0x%x\n", rd);
401 return false;
402 }
403
404 /* EEPROM country code to regpair mapping */
405 static struct country_code_to_enum_rd*
ath_regd_find_country(u16 countryCode)406 ath_regd_find_country(u16 countryCode)
407 {
408 int i;
409
410 for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
411 if (allCountries[i].countryCode == countryCode)
412 return &allCountries[i];
413 }
414 return NULL;
415 }
416
417 /* EEPROM rd code to regpair mapping */
418 static struct country_code_to_enum_rd*
ath_regd_find_country_by_rd(int regdmn)419 ath_regd_find_country_by_rd(int regdmn)
420 {
421 int i;
422
423 for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
424 if (allCountries[i].regDmnEnum == regdmn)
425 return &allCountries[i];
426 }
427 return NULL;
428 }
429
430 /* Returns the map of the EEPROM set RD to a country code */
ath_regd_get_default_country(u16 rd)431 static u16 ath_regd_get_default_country(u16 rd)
432 {
433 if (rd & COUNTRY_ERD_FLAG) {
434 struct country_code_to_enum_rd *country = NULL;
435 u16 cc = rd & ~COUNTRY_ERD_FLAG;
436
437 country = ath_regd_find_country(cc);
438 if (country != NULL)
439 return cc;
440 }
441
442 return CTRY_DEFAULT;
443 }
444
445 static struct reg_dmn_pair_mapping*
ath_get_regpair(int regdmn)446 ath_get_regpair(int regdmn)
447 {
448 int i;
449
450 if (regdmn == NO_ENUMRD)
451 return NULL;
452 for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++) {
453 if (regDomainPairs[i].regDmnEnum == regdmn)
454 return ®DomainPairs[i];
455 }
456 return NULL;
457 }
458
459 static int
ath_regd_init_wiphy(struct ath_regulatory * reg,struct wiphy * wiphy,int (* reg_notifier)(struct wiphy * wiphy,struct regulatory_request * request))460 ath_regd_init_wiphy(struct ath_regulatory *reg,
461 struct wiphy *wiphy,
462 int (*reg_notifier)(struct wiphy *wiphy,
463 struct regulatory_request *request))
464 {
465 const struct ieee80211_regdomain *regd;
466
467 wiphy->reg_notifier = reg_notifier;
468 wiphy->flags |= WIPHY_FLAG_STRICT_REGULATORY;
469
470 if (ath_is_world_regd(reg)) {
471 /*
472 * Anything applied here (prior to wiphy registration) gets
473 * saved on the wiphy orig_* parameters
474 */
475 regd = ath_world_regdomain(reg);
476 wiphy->flags |= WIPHY_FLAG_CUSTOM_REGULATORY;
477 } else {
478 /*
479 * This gets applied in the case of the absence of CRDA,
480 * it's our own custom world regulatory domain, similar to
481 * cfg80211's but we enable passive scanning.
482 */
483 regd = ath_default_world_regdomain();
484 }
485 wiphy_apply_custom_regulatory(wiphy, regd);
486 ath_reg_apply_radar_flags(wiphy);
487 ath_reg_apply_world_flags(wiphy, NL80211_REGDOM_SET_BY_DRIVER, reg);
488 return 0;
489 }
490
491 /*
492 * Some users have reported their EEPROM programmed with
493 * 0x8000 set, this is not a supported regulatory domain
494 * but since we have more than one user with it we need
495 * a solution for them. We default to 0x64, which is the
496 * default Atheros world regulatory domain.
497 */
ath_regd_sanitize(struct ath_regulatory * reg)498 static void ath_regd_sanitize(struct ath_regulatory *reg)
499 {
500 if (reg->current_rd != COUNTRY_ERD_FLAG)
501 return;
502 printk(KERN_DEBUG "ath: EEPROM regdomain sanitized\n");
503 reg->current_rd = 0x64;
504 }
505
506 int
ath_regd_init(struct ath_regulatory * reg,struct wiphy * wiphy,int (* reg_notifier)(struct wiphy * wiphy,struct regulatory_request * request))507 ath_regd_init(struct ath_regulatory *reg,
508 struct wiphy *wiphy,
509 int (*reg_notifier)(struct wiphy *wiphy,
510 struct regulatory_request *request))
511 {
512 struct country_code_to_enum_rd *country = NULL;
513 u16 regdmn;
514
515 if (!reg)
516 return -EINVAL;
517
518 ath_regd_sanitize(reg);
519
520 printk(KERN_DEBUG "ath: EEPROM regdomain: 0x%0x\n", reg->current_rd);
521
522 if (!ath_regd_is_eeprom_valid(reg)) {
523 printk(KERN_ERR "ath: Invalid EEPROM contents\n");
524 return -EINVAL;
525 }
526
527 regdmn = ath_regd_get_eepromRD(reg);
528 reg->country_code = ath_regd_get_default_country(regdmn);
529
530 if (reg->country_code == CTRY_DEFAULT &&
531 regdmn == CTRY_DEFAULT) {
532 printk(KERN_DEBUG "ath: EEPROM indicates default "
533 "country code should be used\n");
534 reg->country_code = CTRY_UNITED_STATES;
535 }
536
537 if (reg->country_code == CTRY_DEFAULT) {
538 country = NULL;
539 } else {
540 printk(KERN_DEBUG "ath: doing EEPROM country->regdmn "
541 "map search\n");
542 country = ath_regd_find_country(reg->country_code);
543 if (country == NULL) {
544 printk(KERN_DEBUG
545 "ath: no valid country maps found for "
546 "country code: 0x%0x\n",
547 reg->country_code);
548 return -EINVAL;
549 } else {
550 regdmn = country->regDmnEnum;
551 printk(KERN_DEBUG "ath: country maps to "
552 "regdmn code: 0x%0x\n",
553 regdmn);
554 }
555 }
556
557 reg->regpair = ath_get_regpair(regdmn);
558
559 if (!reg->regpair) {
560 printk(KERN_DEBUG "ath: "
561 "No regulatory domain pair found, cannot continue\n");
562 return -EINVAL;
563 }
564
565 if (!country)
566 country = ath_regd_find_country_by_rd(regdmn);
567
568 if (country) {
569 reg->alpha2[0] = country->isoName[0];
570 reg->alpha2[1] = country->isoName[1];
571 } else {
572 reg->alpha2[0] = '0';
573 reg->alpha2[1] = '0';
574 }
575
576 printk(KERN_DEBUG "ath: Country alpha2 being used: %c%c\n",
577 reg->alpha2[0], reg->alpha2[1]);
578 printk(KERN_DEBUG "ath: Regpair used: 0x%0x\n",
579 reg->regpair->regDmnEnum);
580
581 ath_regd_init_wiphy(reg, wiphy, reg_notifier);
582 return 0;
583 }
584 EXPORT_SYMBOL(ath_regd_init);
585
ath_regd_get_band_ctl(struct ath_regulatory * reg,enum ieee80211_band band)586 u32 ath_regd_get_band_ctl(struct ath_regulatory *reg,
587 enum ieee80211_band band)
588 {
589 if (!reg->regpair ||
590 (reg->country_code == CTRY_DEFAULT &&
591 is_wwr_sku(ath_regd_get_eepromRD(reg)))) {
592 return SD_NO_CTL;
593 }
594
595 switch (band) {
596 case IEEE80211_BAND_2GHZ:
597 return reg->regpair->reg_2ghz_ctl;
598 case IEEE80211_BAND_5GHZ:
599 return reg->regpair->reg_5ghz_ctl;
600 default:
601 return NO_CTL;
602 }
603 }
604 EXPORT_SYMBOL(ath_regd_get_band_ctl);
605