xref: /openbmc/linux/drivers/net/wireless/ath/regd.c (revision 8fc68580)
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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
18 
19 #include <linux/kernel.h>
20 #include <linux/export.h>
21 #include <net/cfg80211.h>
22 #include <net/mac80211.h>
23 #include "regd.h"
24 #include "regd_common.h"
25 
26 static int __ath_regd_init(struct ath_regulatory *reg);
27 
28 /*
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.
33  */
34 
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)
37 
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,\
40 					 NL80211_RRF_NO_IR)
41 #define ATH9K_2GHZ_CH14		REG_RULE(2484-10, 2484+10, 40, 0, 20,\
42 					 NL80211_RRF_NO_IR | \
43 					 NL80211_RRF_NO_OFDM)
44 
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,\
47 					 NL80211_RRF_NO_IR)
48 #define ATH9K_5GHZ_5470_5850	REG_RULE(5470-10, 5850+10, 80, 0, 30,\
49 					 NL80211_RRF_NO_IR)
50 #define ATH9K_5GHZ_5725_5850	REG_RULE(5725-10, 5850+10, 80, 0, 30,\
51 					 NL80211_RRF_NO_IR)
52 
53 #define ATH9K_2GHZ_ALL		ATH9K_2GHZ_CH01_11, \
54 				ATH9K_2GHZ_CH12_13, \
55 				ATH9K_2GHZ_CH14
56 
57 #define ATH9K_5GHZ_ALL		ATH9K_5GHZ_5150_5350, \
58 				ATH9K_5GHZ_5470_5850
59 
60 /* This one skips what we call "mid band" */
61 #define ATH9K_5GHZ_NO_MIDBAND	ATH9K_5GHZ_5150_5350, \
62 				ATH9K_5GHZ_5725_5850
63 
64 /* Can be used for:
65  * 0x60, 0x61, 0x62 */
66 static const struct ieee80211_regdomain ath_world_regdom_60_61_62 = {
67 	.n_reg_rules = 5,
68 	.alpha2 =  "99",
69 	.reg_rules = {
70 		ATH9K_2GHZ_ALL,
71 		ATH9K_5GHZ_ALL,
72 	}
73 };
74 
75 /* Can be used by 0x63 and 0x65 */
76 static const struct ieee80211_regdomain ath_world_regdom_63_65 = {
77 	.n_reg_rules = 4,
78 	.alpha2 =  "99",
79 	.reg_rules = {
80 		ATH9K_2GHZ_CH01_11,
81 		ATH9K_2GHZ_CH12_13,
82 		ATH9K_5GHZ_NO_MIDBAND,
83 	}
84 };
85 
86 /* Can be used by 0x64 only */
87 static const struct ieee80211_regdomain ath_world_regdom_64 = {
88 	.n_reg_rules = 3,
89 	.alpha2 =  "99",
90 	.reg_rules = {
91 		ATH9K_2GHZ_CH01_11,
92 		ATH9K_5GHZ_NO_MIDBAND,
93 	}
94 };
95 
96 /* Can be used by 0x66 and 0x69 */
97 static const struct ieee80211_regdomain ath_world_regdom_66_69 = {
98 	.n_reg_rules = 3,
99 	.alpha2 =  "99",
100 	.reg_rules = {
101 		ATH9K_2GHZ_CH01_11,
102 		ATH9K_5GHZ_ALL,
103 	}
104 };
105 
106 /* Can be used by 0x67, 0x68, 0x6A and 0x6C */
107 static const struct ieee80211_regdomain ath_world_regdom_67_68_6A_6C = {
108 	.n_reg_rules = 4,
109 	.alpha2 =  "99",
110 	.reg_rules = {
111 		ATH9K_2GHZ_CH01_11,
112 		ATH9K_2GHZ_CH12_13,
113 		ATH9K_5GHZ_ALL,
114 	}
115 };
116 
117 static bool dynamic_country_user_possible(struct ath_regulatory *reg)
118 {
119 	if (config_enabled(CONFIG_ATH_REG_DYNAMIC_USER_CERT_TESTING))
120 		return true;
121 
122 	switch (reg->country_code) {
123 	case CTRY_UNITED_STATES:
124 	case CTRY_JAPAN1:
125 	case CTRY_JAPAN2:
126 	case CTRY_JAPAN3:
127 	case CTRY_JAPAN4:
128 	case CTRY_JAPAN5:
129 	case CTRY_JAPAN6:
130 	case CTRY_JAPAN7:
131 	case CTRY_JAPAN8:
132 	case CTRY_JAPAN9:
133 	case CTRY_JAPAN10:
134 	case CTRY_JAPAN11:
135 	case CTRY_JAPAN12:
136 	case CTRY_JAPAN13:
137 	case CTRY_JAPAN14:
138 	case CTRY_JAPAN15:
139 	case CTRY_JAPAN16:
140 	case CTRY_JAPAN17:
141 	case CTRY_JAPAN18:
142 	case CTRY_JAPAN19:
143 	case CTRY_JAPAN20:
144 	case CTRY_JAPAN21:
145 	case CTRY_JAPAN22:
146 	case CTRY_JAPAN23:
147 	case CTRY_JAPAN24:
148 	case CTRY_JAPAN25:
149 	case CTRY_JAPAN26:
150 	case CTRY_JAPAN27:
151 	case CTRY_JAPAN28:
152 	case CTRY_JAPAN29:
153 	case CTRY_JAPAN30:
154 	case CTRY_JAPAN31:
155 	case CTRY_JAPAN32:
156 	case CTRY_JAPAN33:
157 	case CTRY_JAPAN34:
158 	case CTRY_JAPAN35:
159 	case CTRY_JAPAN36:
160 	case CTRY_JAPAN37:
161 	case CTRY_JAPAN38:
162 	case CTRY_JAPAN39:
163 	case CTRY_JAPAN40:
164 	case CTRY_JAPAN41:
165 	case CTRY_JAPAN42:
166 	case CTRY_JAPAN43:
167 	case CTRY_JAPAN44:
168 	case CTRY_JAPAN45:
169 	case CTRY_JAPAN46:
170 	case CTRY_JAPAN47:
171 	case CTRY_JAPAN48:
172 	case CTRY_JAPAN49:
173 	case CTRY_JAPAN50:
174 	case CTRY_JAPAN51:
175 	case CTRY_JAPAN52:
176 	case CTRY_JAPAN53:
177 	case CTRY_JAPAN54:
178 	case CTRY_JAPAN55:
179 	case CTRY_JAPAN56:
180 	case CTRY_JAPAN57:
181 	case CTRY_JAPAN58:
182 	case CTRY_JAPAN59:
183 		return false;
184 	}
185 
186 	return true;
187 }
188 
189 static bool ath_reg_dyn_country_user_allow(struct ath_regulatory *reg)
190 {
191 	if (!config_enabled(CONFIG_ATH_REG_DYNAMIC_USER_REG_HINTS))
192 		return false;
193 	if (!dynamic_country_user_possible(reg))
194 		return false;
195 	return true;
196 }
197 
198 static inline bool is_wwr_sku(u16 regd)
199 {
200 	return ((regd & COUNTRY_ERD_FLAG) != COUNTRY_ERD_FLAG) &&
201 		(((regd & WORLD_SKU_MASK) == WORLD_SKU_PREFIX) ||
202 		(regd == WORLD));
203 }
204 
205 static u16 ath_regd_get_eepromRD(struct ath_regulatory *reg)
206 {
207 	return reg->current_rd & ~WORLDWIDE_ROAMING_FLAG;
208 }
209 
210 bool ath_is_world_regd(struct ath_regulatory *reg)
211 {
212 	return is_wwr_sku(ath_regd_get_eepromRD(reg));
213 }
214 EXPORT_SYMBOL(ath_is_world_regd);
215 
216 static const struct ieee80211_regdomain *ath_default_world_regdomain(void)
217 {
218 	/* this is the most restrictive */
219 	return &ath_world_regdom_64;
220 }
221 
222 static const struct
223 ieee80211_regdomain *ath_world_regdomain(struct ath_regulatory *reg)
224 {
225 	switch (reg->regpair->regDmnEnum) {
226 	case 0x60:
227 	case 0x61:
228 	case 0x62:
229 		return &ath_world_regdom_60_61_62;
230 	case 0x63:
231 	case 0x65:
232 		return &ath_world_regdom_63_65;
233 	case 0x64:
234 		return &ath_world_regdom_64;
235 	case 0x66:
236 	case 0x69:
237 		return &ath_world_regdom_66_69;
238 	case 0x67:
239 	case 0x68:
240 	case 0x6A:
241 	case 0x6C:
242 		return &ath_world_regdom_67_68_6A_6C;
243 	default:
244 		WARN_ON(1);
245 		return ath_default_world_regdomain();
246 	}
247 }
248 
249 bool ath_is_49ghz_allowed(u16 regdomain)
250 {
251 	/* possibly more */
252 	return regdomain == MKK9_MKKC;
253 }
254 EXPORT_SYMBOL(ath_is_49ghz_allowed);
255 
256 /* Frequency is one where radar detection is required */
257 static bool ath_is_radar_freq(u16 center_freq)
258 {
259 	return (center_freq >= 5260 && center_freq <= 5700);
260 }
261 
262 static void ath_force_clear_no_ir_chan(struct wiphy *wiphy,
263 				       struct ieee80211_channel *ch)
264 {
265 	const struct ieee80211_reg_rule *reg_rule;
266 
267 	reg_rule = freq_reg_info(wiphy, MHZ_TO_KHZ(ch->center_freq));
268 	if (IS_ERR(reg_rule))
269 		return;
270 
271 	if (!(reg_rule->flags & NL80211_RRF_NO_IR))
272 		if (ch->flags & IEEE80211_CHAN_NO_IR)
273 			ch->flags &= ~IEEE80211_CHAN_NO_IR;
274 }
275 
276 static void ath_force_clear_no_ir_freq(struct wiphy *wiphy, u16 center_freq)
277 {
278 	struct ieee80211_channel *ch;
279 
280 	ch = ieee80211_get_channel(wiphy, center_freq);
281 	if (!ch)
282 		return;
283 
284 	ath_force_clear_no_ir_chan(wiphy, ch);
285 }
286 
287 static void ath_force_no_ir_chan(struct ieee80211_channel *ch)
288 {
289 	ch->flags |= IEEE80211_CHAN_NO_IR;
290 }
291 
292 static void ath_force_no_ir_freq(struct wiphy *wiphy, u16 center_freq)
293 {
294 	struct ieee80211_channel *ch;
295 
296 	ch = ieee80211_get_channel(wiphy, center_freq);
297 	if (!ch)
298 		return;
299 
300 	ath_force_no_ir_chan(ch);
301 }
302 
303 static void
304 __ath_reg_apply_beaconing_flags(struct wiphy *wiphy,
305 				struct ath_regulatory *reg,
306 				enum nl80211_reg_initiator initiator,
307 				struct ieee80211_channel *ch)
308 {
309 	if (ath_is_radar_freq(ch->center_freq) ||
310 	    (ch->flags & IEEE80211_CHAN_RADAR))
311 		return;
312 
313 	switch (initiator) {
314 	case NL80211_REGDOM_SET_BY_COUNTRY_IE:
315 		ath_force_clear_no_ir_chan(wiphy, ch);
316 		break;
317 	case NL80211_REGDOM_SET_BY_USER:
318 		if (ath_reg_dyn_country_user_allow(reg))
319 			ath_force_clear_no_ir_chan(wiphy, ch);
320 		break;
321 	default:
322 		if (ch->beacon_found)
323 			ch->flags &= ~IEEE80211_CHAN_NO_IR;
324 	}
325 }
326 
327 /*
328  * These exception rules do not apply radar frequencies.
329  *
330  * - We enable initiating radiation if the country IE says its fine:
331  * - If no country IE has been processed and a we determine we have
332  *   received a beacon on a channel we can enable initiating radiation.
333  */
334 static void
335 ath_reg_apply_beaconing_flags(struct wiphy *wiphy,
336 			      struct ath_regulatory *reg,
337 			      enum nl80211_reg_initiator initiator)
338 {
339 	enum ieee80211_band band;
340 	struct ieee80211_supported_band *sband;
341 	struct ieee80211_channel *ch;
342 	unsigned int i;
343 
344 	for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
345 		if (!wiphy->bands[band])
346 			continue;
347 		sband = wiphy->bands[band];
348 		for (i = 0; i < sband->n_channels; i++) {
349 			ch = &sband->channels[i];
350 			__ath_reg_apply_beaconing_flags(wiphy, reg,
351 							initiator, ch);
352 		}
353 	}
354 }
355 
356 /**
357  * ath_reg_apply_ir_flags()
358  * @wiphy: the wiphy to use
359  * @initiator: the regulatory hint initiator
360  *
361  * If no country IE has been received always enable passive scan
362  * and no-ibss on these channels. This is only done for specific
363  * regulatory SKUs.
364  *
365  * If a country IE has been received check its rule for this
366  * channel first before enabling active scan. The passive scan
367  * would have been enforced by the initial processing of our
368  * custom regulatory domain.
369  */
370 static void
371 ath_reg_apply_ir_flags(struct wiphy *wiphy,
372 		       struct ath_regulatory *reg,
373 		       enum nl80211_reg_initiator initiator)
374 {
375 	struct ieee80211_supported_band *sband;
376 
377 	sband = wiphy->bands[IEEE80211_BAND_2GHZ];
378 	if (!sband)
379 		return;
380 
381 	switch(initiator) {
382 	case NL80211_REGDOM_SET_BY_COUNTRY_IE:
383 		ath_force_clear_no_ir_freq(wiphy, 2467);
384 		ath_force_clear_no_ir_freq(wiphy, 2472);
385 		break;
386 	case NL80211_REGDOM_SET_BY_USER:
387 		if (!ath_reg_dyn_country_user_allow(reg))
388 			break;
389 		ath_force_clear_no_ir_freq(wiphy, 2467);
390 		ath_force_clear_no_ir_freq(wiphy, 2472);
391 		break;
392 	default:
393 		ath_force_no_ir_freq(wiphy, 2467);
394 		ath_force_no_ir_freq(wiphy, 2472);
395 	}
396 }
397 
398 /* Always apply Radar/DFS rules on freq range 5260 MHz - 5700 MHz */
399 static void ath_reg_apply_radar_flags(struct wiphy *wiphy)
400 {
401 	struct ieee80211_supported_band *sband;
402 	struct ieee80211_channel *ch;
403 	unsigned int i;
404 
405 	if (!wiphy->bands[IEEE80211_BAND_5GHZ])
406 		return;
407 
408 	sband = wiphy->bands[IEEE80211_BAND_5GHZ];
409 
410 	for (i = 0; i < sband->n_channels; i++) {
411 		ch = &sband->channels[i];
412 		if (!ath_is_radar_freq(ch->center_freq))
413 			continue;
414 		/* We always enable radar detection/DFS on this
415 		 * frequency range. Additionally we also apply on
416 		 * this frequency range:
417 		 * - If STA mode does not yet have DFS supports disable
418 		 *   active scanning
419 		 * - If adhoc mode does not support DFS yet then
420 		 *   disable adhoc in the frequency.
421 		 * - If AP mode does not yet support radar detection/DFS
422 		 *   do not allow AP mode
423 		 */
424 		if (!(ch->flags & IEEE80211_CHAN_DISABLED))
425 			ch->flags |= IEEE80211_CHAN_RADAR |
426 				     IEEE80211_CHAN_NO_IR;
427 	}
428 }
429 
430 static void ath_reg_apply_world_flags(struct wiphy *wiphy,
431 				      enum nl80211_reg_initiator initiator,
432 				      struct ath_regulatory *reg)
433 {
434 	switch (reg->regpair->regDmnEnum) {
435 	case 0x60:
436 	case 0x63:
437 	case 0x66:
438 	case 0x67:
439 	case 0x6C:
440 		ath_reg_apply_beaconing_flags(wiphy, reg, initiator);
441 		break;
442 	case 0x68:
443 		ath_reg_apply_beaconing_flags(wiphy, reg, initiator);
444 		ath_reg_apply_ir_flags(wiphy, reg, initiator);
445 		break;
446 	default:
447 		if (ath_reg_dyn_country_user_allow(reg))
448 			ath_reg_apply_beaconing_flags(wiphy, reg, initiator);
449 	}
450 }
451 
452 static u16 ath_regd_find_country_by_name(char *alpha2)
453 {
454 	unsigned int i;
455 
456 	for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
457 		if (!memcmp(allCountries[i].isoName, alpha2, 2))
458 			return allCountries[i].countryCode;
459 	}
460 
461 	return -1;
462 }
463 
464 static int __ath_reg_dyn_country(struct wiphy *wiphy,
465 				 struct ath_regulatory *reg,
466 				 struct regulatory_request *request)
467 {
468 	u16 country_code;
469 
470 	if (request->initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE &&
471 	    !ath_is_world_regd(reg))
472 		return -EINVAL;
473 
474 	country_code = ath_regd_find_country_by_name(request->alpha2);
475 	if (country_code == (u16) -1)
476 		return -EINVAL;
477 
478 	reg->current_rd = COUNTRY_ERD_FLAG;
479 	reg->current_rd |= country_code;
480 
481 	__ath_regd_init(reg);
482 
483 	ath_reg_apply_world_flags(wiphy, request->initiator, reg);
484 
485 	return 0;
486 }
487 
488 static void ath_reg_dyn_country(struct wiphy *wiphy,
489 				struct ath_regulatory *reg,
490 				struct regulatory_request *request)
491 {
492 	if (__ath_reg_dyn_country(wiphy, reg, request))
493 		return;
494 
495 	printk(KERN_DEBUG "ath: regdomain 0x%0x "
496 			  "dynamically updated by %s\n",
497 	       reg->current_rd,
498 	       reg_initiator_name(request->initiator));
499 }
500 
501 void ath_reg_notifier_apply(struct wiphy *wiphy,
502 			    struct regulatory_request *request,
503 			    struct ath_regulatory *reg)
504 {
505 	struct ath_common *common = container_of(reg, struct ath_common,
506 						 regulatory);
507 	/* We always apply this */
508 	ath_reg_apply_radar_flags(wiphy);
509 
510 	/*
511 	 * This would happen when we have sent a custom regulatory request
512 	 * a world regulatory domain and the scheduler hasn't yet processed
513 	 * any pending requests in the queue.
514 	 */
515 	if (!request)
516 		return;
517 
518 	switch (request->initiator) {
519 	case NL80211_REGDOM_SET_BY_CORE:
520 		/*
521 		 * If common->reg_world_copy is world roaming it means we *were*
522 		 * world roaming... so we now have to restore that data.
523 		 */
524 		if (!ath_is_world_regd(&common->reg_world_copy))
525 			break;
526 
527 		memcpy(reg, &common->reg_world_copy,
528 		       sizeof(struct ath_regulatory));
529 		break;
530 	case NL80211_REGDOM_SET_BY_DRIVER:
531 		break;
532 	case NL80211_REGDOM_SET_BY_USER:
533 		if (ath_reg_dyn_country_user_allow(reg))
534 			ath_reg_dyn_country(wiphy, reg, request);
535 		break;
536 	case NL80211_REGDOM_SET_BY_COUNTRY_IE:
537 		ath_reg_dyn_country(wiphy, reg, request);
538 		break;
539 	}
540 }
541 EXPORT_SYMBOL(ath_reg_notifier_apply);
542 
543 static bool ath_regd_is_eeprom_valid(struct ath_regulatory *reg)
544 {
545 	u16 rd = ath_regd_get_eepromRD(reg);
546 	int i;
547 
548 	if (rd & COUNTRY_ERD_FLAG) {
549 		/* EEPROM value is a country code */
550 		u16 cc = rd & ~COUNTRY_ERD_FLAG;
551 		printk(KERN_DEBUG
552 		       "ath: EEPROM indicates we should expect "
553 			"a country code\n");
554 		for (i = 0; i < ARRAY_SIZE(allCountries); i++)
555 			if (allCountries[i].countryCode == cc)
556 				return true;
557 	} else {
558 		/* EEPROM value is a regpair value */
559 		if (rd != CTRY_DEFAULT)
560 			printk(KERN_DEBUG "ath: EEPROM indicates we "
561 			       "should expect a direct regpair map\n");
562 		for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++)
563 			if (regDomainPairs[i].regDmnEnum == rd)
564 				return true;
565 	}
566 	printk(KERN_DEBUG
567 		 "ath: invalid regulatory domain/country code 0x%x\n", rd);
568 	return false;
569 }
570 
571 /* EEPROM country code to regpair mapping */
572 static struct country_code_to_enum_rd*
573 ath_regd_find_country(u16 countryCode)
574 {
575 	int i;
576 
577 	for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
578 		if (allCountries[i].countryCode == countryCode)
579 			return &allCountries[i];
580 	}
581 	return NULL;
582 }
583 
584 /* EEPROM rd code to regpair mapping */
585 static struct country_code_to_enum_rd*
586 ath_regd_find_country_by_rd(int regdmn)
587 {
588 	int i;
589 
590 	for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
591 		if (allCountries[i].regDmnEnum == regdmn)
592 			return &allCountries[i];
593 	}
594 	return NULL;
595 }
596 
597 /* Returns the map of the EEPROM set RD to a country code */
598 static u16 ath_regd_get_default_country(u16 rd)
599 {
600 	if (rd & COUNTRY_ERD_FLAG) {
601 		struct country_code_to_enum_rd *country = NULL;
602 		u16 cc = rd & ~COUNTRY_ERD_FLAG;
603 
604 		country = ath_regd_find_country(cc);
605 		if (country != NULL)
606 			return cc;
607 	}
608 
609 	return CTRY_DEFAULT;
610 }
611 
612 static struct reg_dmn_pair_mapping*
613 ath_get_regpair(int regdmn)
614 {
615 	int i;
616 
617 	if (regdmn == NO_ENUMRD)
618 		return NULL;
619 	for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++) {
620 		if (regDomainPairs[i].regDmnEnum == regdmn)
621 			return &regDomainPairs[i];
622 	}
623 	return NULL;
624 }
625 
626 static int
627 ath_regd_init_wiphy(struct ath_regulatory *reg,
628 		    struct wiphy *wiphy,
629 		    void (*reg_notifier)(struct wiphy *wiphy,
630 					 struct regulatory_request *request))
631 {
632 	const struct ieee80211_regdomain *regd;
633 
634 	wiphy->reg_notifier = reg_notifier;
635 	wiphy->regulatory_flags |= REGULATORY_STRICT_REG |
636 				   REGULATORY_CUSTOM_REG;
637 
638 	if (ath_is_world_regd(reg)) {
639 		/*
640 		 * Anything applied here (prior to wiphy registration) gets
641 		 * saved on the wiphy orig_* parameters
642 		 */
643 		regd = ath_world_regdomain(reg);
644 		wiphy->regulatory_flags |= REGULATORY_COUNTRY_IE_FOLLOW_POWER;
645 	} else {
646 		/*
647 		 * This gets applied in the case of the absence of CRDA,
648 		 * it's our own custom world regulatory domain, similar to
649 		 * cfg80211's but we enable passive scanning.
650 		 */
651 		regd = ath_default_world_regdomain();
652 	}
653 
654 	wiphy_apply_custom_regulatory(wiphy, regd);
655 	if (!ath_is_world_regd(reg))
656 		wiphy->regulatory_flags &= ~REGULATORY_CUSTOM_REG;
657 	ath_reg_apply_radar_flags(wiphy);
658 	ath_reg_apply_world_flags(wiphy, NL80211_REGDOM_SET_BY_DRIVER, reg);
659 	return 0;
660 }
661 
662 /*
663  * Some users have reported their EEPROM programmed with
664  * 0x8000 set, this is not a supported regulatory domain
665  * but since we have more than one user with it we need
666  * a solution for them. We default to 0x64, which is the
667  * default Atheros world regulatory domain.
668  */
669 static void ath_regd_sanitize(struct ath_regulatory *reg)
670 {
671 	if (reg->current_rd != COUNTRY_ERD_FLAG)
672 		return;
673 	printk(KERN_DEBUG "ath: EEPROM regdomain sanitized\n");
674 	reg->current_rd = 0x64;
675 }
676 
677 static int __ath_regd_init(struct ath_regulatory *reg)
678 {
679 	struct country_code_to_enum_rd *country = NULL;
680 	u16 regdmn;
681 
682 	if (!reg)
683 		return -EINVAL;
684 
685 	ath_regd_sanitize(reg);
686 
687 	printk(KERN_DEBUG "ath: EEPROM regdomain: 0x%0x\n", reg->current_rd);
688 
689 	if (!ath_regd_is_eeprom_valid(reg)) {
690 		pr_err("Invalid EEPROM contents\n");
691 		return -EINVAL;
692 	}
693 
694 	regdmn = ath_regd_get_eepromRD(reg);
695 	reg->country_code = ath_regd_get_default_country(regdmn);
696 
697 	if (reg->country_code == CTRY_DEFAULT &&
698 	    regdmn == CTRY_DEFAULT) {
699 		printk(KERN_DEBUG "ath: EEPROM indicates default "
700 		       "country code should be used\n");
701 		reg->country_code = CTRY_UNITED_STATES;
702 	}
703 
704 	if (reg->country_code == CTRY_DEFAULT) {
705 		country = NULL;
706 	} else {
707 		printk(KERN_DEBUG "ath: doing EEPROM country->regdmn "
708 		       "map search\n");
709 		country = ath_regd_find_country(reg->country_code);
710 		if (country == NULL) {
711 			printk(KERN_DEBUG
712 				"ath: no valid country maps found for "
713 				"country code: 0x%0x\n",
714 				reg->country_code);
715 			return -EINVAL;
716 		} else {
717 			regdmn = country->regDmnEnum;
718 			printk(KERN_DEBUG "ath: country maps to "
719 			       "regdmn code: 0x%0x\n",
720 			       regdmn);
721 		}
722 	}
723 
724 	reg->regpair = ath_get_regpair(regdmn);
725 
726 	if (!reg->regpair) {
727 		printk(KERN_DEBUG "ath: "
728 			"No regulatory domain pair found, cannot continue\n");
729 		return -EINVAL;
730 	}
731 
732 	if (!country)
733 		country = ath_regd_find_country_by_rd(regdmn);
734 
735 	if (country) {
736 		reg->alpha2[0] = country->isoName[0];
737 		reg->alpha2[1] = country->isoName[1];
738 	} else {
739 		reg->alpha2[0] = '0';
740 		reg->alpha2[1] = '0';
741 	}
742 
743 	printk(KERN_DEBUG "ath: Country alpha2 being used: %c%c\n",
744 		reg->alpha2[0], reg->alpha2[1]);
745 	printk(KERN_DEBUG "ath: Regpair used: 0x%0x\n",
746 		reg->regpair->regDmnEnum);
747 
748 	return 0;
749 }
750 
751 int
752 ath_regd_init(struct ath_regulatory *reg,
753 	      struct wiphy *wiphy,
754 	      void (*reg_notifier)(struct wiphy *wiphy,
755 				   struct regulatory_request *request))
756 {
757 	struct ath_common *common = container_of(reg, struct ath_common,
758 						 regulatory);
759 	int r;
760 
761 	r = __ath_regd_init(reg);
762 	if (r)
763 		return r;
764 
765 	if (ath_is_world_regd(reg))
766 		memcpy(&common->reg_world_copy, reg,
767 		       sizeof(struct ath_regulatory));
768 
769 	ath_regd_init_wiphy(reg, wiphy, reg_notifier);
770 
771 	return 0;
772 }
773 EXPORT_SYMBOL(ath_regd_init);
774 
775 u32 ath_regd_get_band_ctl(struct ath_regulatory *reg,
776 			  enum ieee80211_band band)
777 {
778 	if (!reg->regpair ||
779 	    (reg->country_code == CTRY_DEFAULT &&
780 	     is_wwr_sku(ath_regd_get_eepromRD(reg)))) {
781 		return SD_NO_CTL;
782 	}
783 
784 	switch (band) {
785 	case IEEE80211_BAND_2GHZ:
786 		return reg->regpair->reg_2ghz_ctl;
787 	case IEEE80211_BAND_5GHZ:
788 		return reg->regpair->reg_5ghz_ctl;
789 	default:
790 		return NO_CTL;
791 	}
792 }
793 EXPORT_SYMBOL(ath_regd_get_band_ctl);
794