2 * Copyright 2002-2005, Instant802 Networks, Inc.
3 * Copyright 2005-2006, Devicescape Software, Inc.
4 * Copyright 2007 Johannes Berg <johannes@sipsolutions.net>
5 * Copyright 2008-2011 Luis R. Rodriguez <mcgrof@qca.qualcomm.com>
7 * Permission to use, copy, modify, and/or distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22 * DOC: Wireless regulatory infrastructure
24 * The usual implementation is for a driver to read a device EEPROM to
25 * determine which regulatory domain it should be operating under, then
26 * looking up the allowable channels in a driver-local table and finally
27 * registering those channels in the wiphy structure.
29 * Another set of compliance enforcement is for drivers to use their
30 * own compliance limits which can be stored on the EEPROM. The host
31 * driver or firmware may ensure these are used.
33 * In addition to all this we provide an extra layer of regulatory
34 * conformance. For drivers which do not have any regulatory
35 * information CRDA provides the complete regulatory solution.
36 * For others it provides a community effort on further restrictions
37 * to enhance compliance.
39 * Note: When number of rules --> infinity we will not be able to
40 * index on alpha2 any more, instead we'll probably have to
41 * rely on some SHA1 checksum of the regdomain for example.
45 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
47 #include <linux/kernel.h>
48 #include <linux/export.h>
49 #include <linux/slab.h>
50 #include <linux/list.h>
51 #include <linux/ctype.h>
52 #include <linux/nl80211.h>
53 #include <linux/platform_device.h>
54 #include <linux/moduleparam.h>
55 #include <net/cfg80211.h>
61 #ifdef CONFIG_CFG80211_REG_DEBUG
62 #define REG_DBG_PRINT(format, args...) \
63 printk(KERN_DEBUG pr_fmt(format), ##args)
65 #define REG_DBG_PRINT(args...)
68 enum reg_request_treatment {
75 static struct regulatory_request core_request_world = {
76 .initiator = NL80211_REGDOM_SET_BY_CORE,
81 .country_ie_env = ENVIRON_ANY,
84 /* Receipt of information from last regulatory request */
85 static struct regulatory_request *last_request = &core_request_world;
87 /* To trigger userspace events */
88 static struct platform_device *reg_pdev;
90 static struct device_type reg_device_type = {
91 .uevent = reg_device_uevent,
95 * Central wireless core regulatory domains, we only need two,
96 * the current one and a world regulatory domain in case we have no
97 * information to give us an alpha2.
98 * Protected by the cfg80211_mutex.
100 const struct ieee80211_regdomain *cfg80211_regdomain;
103 * Protects static reg.c components:
104 * - cfg80211_world_regdom
106 * - reg_num_devs_support_basehint
108 static DEFINE_MUTEX(reg_mutex);
111 * Number of devices that registered to the core
112 * that support cellular base station regulatory hints
114 static int reg_num_devs_support_basehint;
116 static inline void assert_reg_lock(void)
118 lockdep_assert_held(®_mutex);
121 /* Used to queue up regulatory hints */
122 static LIST_HEAD(reg_requests_list);
123 static spinlock_t reg_requests_lock;
125 /* Used to queue up beacon hints for review */
126 static LIST_HEAD(reg_pending_beacons);
127 static spinlock_t reg_pending_beacons_lock;
129 /* Used to keep track of processed beacon hints */
130 static LIST_HEAD(reg_beacon_list);
133 struct list_head list;
134 struct ieee80211_channel chan;
137 static void reg_todo(struct work_struct *work);
138 static DECLARE_WORK(reg_work, reg_todo);
140 static void reg_timeout_work(struct work_struct *work);
141 static DECLARE_DELAYED_WORK(reg_timeout, reg_timeout_work);
143 /* We keep a static world regulatory domain in case of the absence of CRDA */
144 static const struct ieee80211_regdomain world_regdom = {
148 /* IEEE 802.11b/g, channels 1..11 */
149 REG_RULE(2412-10, 2462+10, 40, 6, 20, 0),
150 /* IEEE 802.11b/g, channels 12..13. */
151 REG_RULE(2467-10, 2472+10, 40, 6, 20,
152 NL80211_RRF_PASSIVE_SCAN |
153 NL80211_RRF_NO_IBSS),
154 /* IEEE 802.11 channel 14 - Only JP enables
155 * this and for 802.11b only */
156 REG_RULE(2484-10, 2484+10, 20, 6, 20,
157 NL80211_RRF_PASSIVE_SCAN |
158 NL80211_RRF_NO_IBSS |
159 NL80211_RRF_NO_OFDM),
160 /* IEEE 802.11a, channel 36..48 */
161 REG_RULE(5180-10, 5240+10, 40, 6, 20,
162 NL80211_RRF_PASSIVE_SCAN |
163 NL80211_RRF_NO_IBSS),
165 /* NB: 5260 MHz - 5700 MHz requies DFS */
167 /* IEEE 802.11a, channel 149..165 */
168 REG_RULE(5745-10, 5825+10, 40, 6, 20,
169 NL80211_RRF_PASSIVE_SCAN |
170 NL80211_RRF_NO_IBSS),
172 /* IEEE 802.11ad (60gHz), channels 1..3 */
173 REG_RULE(56160+2160*1-1080, 56160+2160*3+1080, 2160, 0, 0, 0),
177 static const struct ieee80211_regdomain *cfg80211_world_regdom =
180 static char *ieee80211_regdom = "00";
181 static char user_alpha2[2];
183 module_param(ieee80211_regdom, charp, 0444);
184 MODULE_PARM_DESC(ieee80211_regdom, "IEEE 802.11 regulatory domain code");
186 static void reset_regdomains(bool full_reset)
188 assert_cfg80211_lock();
191 /* avoid freeing static information or freeing something twice */
192 if (cfg80211_regdomain == cfg80211_world_regdom)
193 cfg80211_regdomain = NULL;
194 if (cfg80211_world_regdom == &world_regdom)
195 cfg80211_world_regdom = NULL;
196 if (cfg80211_regdomain == &world_regdom)
197 cfg80211_regdomain = NULL;
199 kfree(cfg80211_regdomain);
200 kfree(cfg80211_world_regdom);
202 cfg80211_world_regdom = &world_regdom;
203 cfg80211_regdomain = NULL;
208 if (last_request != &core_request_world)
210 last_request = &core_request_world;
214 * Dynamic world regulatory domain requested by the wireless
215 * core upon initialization
217 static void update_world_regdomain(const struct ieee80211_regdomain *rd)
219 WARN_ON(!last_request);
221 assert_cfg80211_lock();
224 reset_regdomains(false);
226 cfg80211_world_regdom = rd;
227 cfg80211_regdomain = rd;
230 bool is_world_regdom(const char *alpha2)
234 return alpha2[0] == '0' && alpha2[1] == '0';
237 static bool is_alpha2_set(const char *alpha2)
241 return alpha2[0] && alpha2[1];
244 static bool is_unknown_alpha2(const char *alpha2)
249 * Special case where regulatory domain was built by driver
250 * but a specific alpha2 cannot be determined
252 return alpha2[0] == '9' && alpha2[1] == '9';
255 static bool is_intersected_alpha2(const char *alpha2)
260 * Special case where regulatory domain is the
261 * result of an intersection between two regulatory domain
264 return alpha2[0] == '9' && alpha2[1] == '8';
267 static bool is_an_alpha2(const char *alpha2)
271 return isalpha(alpha2[0]) && isalpha(alpha2[1]);
274 static bool alpha2_equal(const char *alpha2_x, const char *alpha2_y)
276 if (!alpha2_x || !alpha2_y)
278 return alpha2_x[0] == alpha2_y[0] && alpha2_x[1] == alpha2_y[1];
281 static bool regdom_changes(const char *alpha2)
283 assert_cfg80211_lock();
285 if (!cfg80211_regdomain)
287 return !alpha2_equal(cfg80211_regdomain->alpha2, alpha2);
291 * The NL80211_REGDOM_SET_BY_USER regdom alpha2 is cached, this lets
292 * you know if a valid regulatory hint with NL80211_REGDOM_SET_BY_USER
293 * has ever been issued.
295 static bool is_user_regdom_saved(void)
297 if (user_alpha2[0] == '9' && user_alpha2[1] == '7')
300 /* This would indicate a mistake on the design */
301 if (WARN(!is_world_regdom(user_alpha2) && !is_an_alpha2(user_alpha2),
302 "Unexpected user alpha2: %c%c\n",
303 user_alpha2[0], user_alpha2[1]))
309 static const struct ieee80211_regdomain *
310 reg_copy_regd(const struct ieee80211_regdomain *src_regd)
312 struct ieee80211_regdomain *regd;
317 sizeof(struct ieee80211_regdomain) +
318 src_regd->n_reg_rules * sizeof(struct ieee80211_reg_rule);
320 regd = kzalloc(size_of_regd, GFP_KERNEL);
322 return ERR_PTR(-ENOMEM);
324 memcpy(regd, src_regd, sizeof(struct ieee80211_regdomain));
326 for (i = 0; i < src_regd->n_reg_rules; i++)
327 memcpy(®d->reg_rules[i], &src_regd->reg_rules[i],
328 sizeof(struct ieee80211_reg_rule));
333 #ifdef CONFIG_CFG80211_INTERNAL_REGDB
334 struct reg_regdb_search_request {
336 struct list_head list;
339 static LIST_HEAD(reg_regdb_search_list);
340 static DEFINE_MUTEX(reg_regdb_search_mutex);
342 static void reg_regdb_search(struct work_struct *work)
344 struct reg_regdb_search_request *request;
345 const struct ieee80211_regdomain *curdom, *regdom = NULL;
348 mutex_lock(&cfg80211_mutex);
350 mutex_lock(®_regdb_search_mutex);
351 while (!list_empty(®_regdb_search_list)) {
352 request = list_first_entry(®_regdb_search_list,
353 struct reg_regdb_search_request,
355 list_del(&request->list);
357 for (i = 0; i < reg_regdb_size; i++) {
358 curdom = reg_regdb[i];
360 if (alpha2_equal(request->alpha2, curdom->alpha2)) {
361 regdom = reg_copy_regd(curdom);
368 mutex_unlock(®_regdb_search_mutex);
370 if (!IS_ERR_OR_NULL(regdom))
373 mutex_unlock(&cfg80211_mutex);
376 static DECLARE_WORK(reg_regdb_work, reg_regdb_search);
378 static void reg_regdb_query(const char *alpha2)
380 struct reg_regdb_search_request *request;
385 request = kzalloc(sizeof(struct reg_regdb_search_request), GFP_KERNEL);
389 memcpy(request->alpha2, alpha2, 2);
391 mutex_lock(®_regdb_search_mutex);
392 list_add_tail(&request->list, ®_regdb_search_list);
393 mutex_unlock(®_regdb_search_mutex);
395 schedule_work(®_regdb_work);
398 /* Feel free to add any other sanity checks here */
399 static void reg_regdb_size_check(void)
401 /* We should ideally BUILD_BUG_ON() but then random builds would fail */
402 WARN_ONCE(!reg_regdb_size, "db.txt is empty, you should update it...");
405 static inline void reg_regdb_size_check(void) {}
406 static inline void reg_regdb_query(const char *alpha2) {}
407 #endif /* CONFIG_CFG80211_INTERNAL_REGDB */
410 * This lets us keep regulatory code which is updated on a regulatory
411 * basis in userspace. Country information is filled in by
414 static int call_crda(const char *alpha2)
416 if (!is_world_regdom((char *) alpha2))
417 pr_info("Calling CRDA for country: %c%c\n",
418 alpha2[0], alpha2[1]);
420 pr_info("Calling CRDA to update world regulatory domain\n");
422 /* query internal regulatory database (if it exists) */
423 reg_regdb_query(alpha2);
425 return kobject_uevent(®_pdev->dev.kobj, KOBJ_CHANGE);
428 static bool reg_is_valid_request(const char *alpha2)
435 if (last_request->processed)
438 return alpha2_equal(last_request->alpha2, alpha2);
441 /* Sanity check on a regulatory rule */
442 static bool is_valid_reg_rule(const struct ieee80211_reg_rule *rule)
444 const struct ieee80211_freq_range *freq_range = &rule->freq_range;
447 if (freq_range->start_freq_khz <= 0 || freq_range->end_freq_khz <= 0)
450 if (freq_range->start_freq_khz > freq_range->end_freq_khz)
453 freq_diff = freq_range->end_freq_khz - freq_range->start_freq_khz;
455 if (freq_range->end_freq_khz <= freq_range->start_freq_khz ||
456 freq_range->max_bandwidth_khz > freq_diff)
462 static bool is_valid_rd(const struct ieee80211_regdomain *rd)
464 const struct ieee80211_reg_rule *reg_rule = NULL;
467 if (!rd->n_reg_rules)
470 if (WARN_ON(rd->n_reg_rules > NL80211_MAX_SUPP_REG_RULES))
473 for (i = 0; i < rd->n_reg_rules; i++) {
474 reg_rule = &rd->reg_rules[i];
475 if (!is_valid_reg_rule(reg_rule))
482 static bool reg_does_bw_fit(const struct ieee80211_freq_range *freq_range,
483 u32 center_freq_khz, u32 bw_khz)
485 u32 start_freq_khz, end_freq_khz;
487 start_freq_khz = center_freq_khz - (bw_khz/2);
488 end_freq_khz = center_freq_khz + (bw_khz/2);
490 if (start_freq_khz >= freq_range->start_freq_khz &&
491 end_freq_khz <= freq_range->end_freq_khz)
498 * freq_in_rule_band - tells us if a frequency is in a frequency band
499 * @freq_range: frequency rule we want to query
500 * @freq_khz: frequency we are inquiring about
502 * This lets us know if a specific frequency rule is or is not relevant to
503 * a specific frequency's band. Bands are device specific and artificial
504 * definitions (the "2.4 GHz band", the "5 GHz band" and the "60GHz band"),
505 * however it is safe for now to assume that a frequency rule should not be
506 * part of a frequency's band if the start freq or end freq are off by more
507 * than 2 GHz for the 2.4 and 5 GHz bands, and by more than 10 GHz for the
509 * This resolution can be lowered and should be considered as we add
510 * regulatory rule support for other "bands".
512 static bool freq_in_rule_band(const struct ieee80211_freq_range *freq_range,
515 #define ONE_GHZ_IN_KHZ 1000000
517 * From 802.11ad: directional multi-gigabit (DMG):
518 * Pertaining to operation in a frequency band containing a channel
519 * with the Channel starting frequency above 45 GHz.
521 u32 limit = freq_khz > 45 * ONE_GHZ_IN_KHZ ?
522 10 * ONE_GHZ_IN_KHZ : 2 * ONE_GHZ_IN_KHZ;
523 if (abs(freq_khz - freq_range->start_freq_khz) <= limit)
525 if (abs(freq_khz - freq_range->end_freq_khz) <= limit)
528 #undef ONE_GHZ_IN_KHZ
532 * Helper for regdom_intersect(), this does the real
533 * mathematical intersection fun
535 static int reg_rules_intersect(const struct ieee80211_reg_rule *rule1,
536 const struct ieee80211_reg_rule *rule2,
537 struct ieee80211_reg_rule *intersected_rule)
539 const struct ieee80211_freq_range *freq_range1, *freq_range2;
540 struct ieee80211_freq_range *freq_range;
541 const struct ieee80211_power_rule *power_rule1, *power_rule2;
542 struct ieee80211_power_rule *power_rule;
545 freq_range1 = &rule1->freq_range;
546 freq_range2 = &rule2->freq_range;
547 freq_range = &intersected_rule->freq_range;
549 power_rule1 = &rule1->power_rule;
550 power_rule2 = &rule2->power_rule;
551 power_rule = &intersected_rule->power_rule;
553 freq_range->start_freq_khz = max(freq_range1->start_freq_khz,
554 freq_range2->start_freq_khz);
555 freq_range->end_freq_khz = min(freq_range1->end_freq_khz,
556 freq_range2->end_freq_khz);
557 freq_range->max_bandwidth_khz = min(freq_range1->max_bandwidth_khz,
558 freq_range2->max_bandwidth_khz);
560 freq_diff = freq_range->end_freq_khz - freq_range->start_freq_khz;
561 if (freq_range->max_bandwidth_khz > freq_diff)
562 freq_range->max_bandwidth_khz = freq_diff;
564 power_rule->max_eirp = min(power_rule1->max_eirp,
565 power_rule2->max_eirp);
566 power_rule->max_antenna_gain = min(power_rule1->max_antenna_gain,
567 power_rule2->max_antenna_gain);
569 intersected_rule->flags = rule1->flags | rule2->flags;
571 if (!is_valid_reg_rule(intersected_rule))
578 * regdom_intersect - do the intersection between two regulatory domains
579 * @rd1: first regulatory domain
580 * @rd2: second regulatory domain
582 * Use this function to get the intersection between two regulatory domains.
583 * Once completed we will mark the alpha2 for the rd as intersected, "98",
584 * as no one single alpha2 can represent this regulatory domain.
586 * Returns a pointer to the regulatory domain structure which will hold the
587 * resulting intersection of rules between rd1 and rd2. We will
588 * kzalloc() this structure for you.
590 static struct ieee80211_regdomain *
591 regdom_intersect(const struct ieee80211_regdomain *rd1,
592 const struct ieee80211_regdomain *rd2)
596 unsigned int num_rules = 0, rule_idx = 0;
597 const struct ieee80211_reg_rule *rule1, *rule2;
598 struct ieee80211_reg_rule *intersected_rule;
599 struct ieee80211_regdomain *rd;
600 /* This is just a dummy holder to help us count */
601 struct ieee80211_reg_rule dummy_rule;
607 * First we get a count of the rules we'll need, then we actually
608 * build them. This is to so we can malloc() and free() a
609 * regdomain once. The reason we use reg_rules_intersect() here
610 * is it will return -EINVAL if the rule computed makes no sense.
611 * All rules that do check out OK are valid.
614 for (x = 0; x < rd1->n_reg_rules; x++) {
615 rule1 = &rd1->reg_rules[x];
616 for (y = 0; y < rd2->n_reg_rules; y++) {
617 rule2 = &rd2->reg_rules[y];
618 if (!reg_rules_intersect(rule1, rule2, &dummy_rule))
626 size_of_regd = sizeof(struct ieee80211_regdomain) +
627 num_rules * sizeof(struct ieee80211_reg_rule);
629 rd = kzalloc(size_of_regd, GFP_KERNEL);
633 for (x = 0; x < rd1->n_reg_rules && rule_idx < num_rules; x++) {
634 rule1 = &rd1->reg_rules[x];
635 for (y = 0; y < rd2->n_reg_rules && rule_idx < num_rules; y++) {
636 rule2 = &rd2->reg_rules[y];
638 * This time around instead of using the stack lets
639 * write to the target rule directly saving ourselves
642 intersected_rule = &rd->reg_rules[rule_idx];
643 r = reg_rules_intersect(rule1, rule2, intersected_rule);
645 * No need to memset here the intersected rule here as
646 * we're not using the stack anymore
654 if (rule_idx != num_rules) {
659 rd->n_reg_rules = num_rules;
667 * XXX: add support for the rest of enum nl80211_reg_rule_flags, we may
668 * want to just have the channel structure use these
670 static u32 map_regdom_flags(u32 rd_flags)
672 u32 channel_flags = 0;
673 if (rd_flags & NL80211_RRF_PASSIVE_SCAN)
674 channel_flags |= IEEE80211_CHAN_PASSIVE_SCAN;
675 if (rd_flags & NL80211_RRF_NO_IBSS)
676 channel_flags |= IEEE80211_CHAN_NO_IBSS;
677 if (rd_flags & NL80211_RRF_DFS)
678 channel_flags |= IEEE80211_CHAN_RADAR;
679 if (rd_flags & NL80211_RRF_NO_OFDM)
680 channel_flags |= IEEE80211_CHAN_NO_OFDM;
681 return channel_flags;
684 static int freq_reg_info_regd(struct wiphy *wiphy, u32 center_freq,
685 const struct ieee80211_reg_rule **reg_rule,
686 const struct ieee80211_regdomain *regd)
689 bool band_rule_found = false;
690 bool bw_fits = false;
695 for (i = 0; i < regd->n_reg_rules; i++) {
696 const struct ieee80211_reg_rule *rr;
697 const struct ieee80211_freq_range *fr = NULL;
699 rr = ®d->reg_rules[i];
700 fr = &rr->freq_range;
703 * We only need to know if one frequency rule was
704 * was in center_freq's band, that's enough, so lets
705 * not overwrite it once found
707 if (!band_rule_found)
708 band_rule_found = freq_in_rule_band(fr, center_freq);
710 bw_fits = reg_does_bw_fit(fr, center_freq, MHZ_TO_KHZ(20));
712 if (band_rule_found && bw_fits) {
718 if (!band_rule_found)
724 int freq_reg_info(struct wiphy *wiphy, u32 center_freq,
725 const struct ieee80211_reg_rule **reg_rule)
727 const struct ieee80211_regdomain *regd;
730 assert_cfg80211_lock();
733 * Follow the driver's regulatory domain, if present, unless a country
734 * IE has been processed or a user wants to help complaince further
736 if (last_request->initiator != NL80211_REGDOM_SET_BY_COUNTRY_IE &&
737 last_request->initiator != NL80211_REGDOM_SET_BY_USER &&
741 regd = cfg80211_regdomain;
743 return freq_reg_info_regd(wiphy, center_freq, reg_rule, regd);
745 EXPORT_SYMBOL(freq_reg_info);
747 #ifdef CONFIG_CFG80211_REG_DEBUG
748 static const char *reg_initiator_name(enum nl80211_reg_initiator initiator)
751 case NL80211_REGDOM_SET_BY_CORE:
752 return "Set by core";
753 case NL80211_REGDOM_SET_BY_USER:
754 return "Set by user";
755 case NL80211_REGDOM_SET_BY_DRIVER:
756 return "Set by driver";
757 case NL80211_REGDOM_SET_BY_COUNTRY_IE:
758 return "Set by country IE";
765 static void chan_reg_rule_print_dbg(struct ieee80211_channel *chan,
766 const struct ieee80211_reg_rule *reg_rule)
768 const struct ieee80211_power_rule *power_rule;
769 const struct ieee80211_freq_range *freq_range;
770 char max_antenna_gain[32];
772 power_rule = ®_rule->power_rule;
773 freq_range = ®_rule->freq_range;
775 if (!power_rule->max_antenna_gain)
776 snprintf(max_antenna_gain, 32, "N/A");
778 snprintf(max_antenna_gain, 32, "%d", power_rule->max_antenna_gain);
780 REG_DBG_PRINT("Updating information on frequency %d MHz with regulatory rule:\n",
783 REG_DBG_PRINT("%d KHz - %d KHz @ %d KHz), (%s mBi, %d mBm)\n",
784 freq_range->start_freq_khz, freq_range->end_freq_khz,
785 freq_range->max_bandwidth_khz, max_antenna_gain,
786 power_rule->max_eirp);
789 static void chan_reg_rule_print_dbg(struct ieee80211_channel *chan,
790 const struct ieee80211_reg_rule *reg_rule)
797 * Note that right now we assume the desired channel bandwidth
798 * is always 20 MHz for each individual channel (HT40 uses 20 MHz
799 * per channel, the primary and the extension channel).
801 static void handle_channel(struct wiphy *wiphy,
802 enum nl80211_reg_initiator initiator,
803 struct ieee80211_channel *chan)
806 u32 flags, bw_flags = 0;
807 const struct ieee80211_reg_rule *reg_rule = NULL;
808 const struct ieee80211_power_rule *power_rule = NULL;
809 const struct ieee80211_freq_range *freq_range = NULL;
810 struct wiphy *request_wiphy = NULL;
812 assert_cfg80211_lock();
814 request_wiphy = wiphy_idx_to_wiphy(last_request->wiphy_idx);
816 flags = chan->orig_flags;
818 r = freq_reg_info(wiphy, MHZ_TO_KHZ(chan->center_freq), ®_rule);
821 * We will disable all channels that do not match our
822 * received regulatory rule unless the hint is coming
823 * from a Country IE and the Country IE had no information
824 * about a band. The IEEE 802.11 spec allows for an AP
825 * to send only a subset of the regulatory rules allowed,
826 * so an AP in the US that only supports 2.4 GHz may only send
827 * a country IE with information for the 2.4 GHz band
828 * while 5 GHz is still supported.
830 if (initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE &&
834 REG_DBG_PRINT("Disabling freq %d MHz\n", chan->center_freq);
835 chan->flags = IEEE80211_CHAN_DISABLED;
839 chan_reg_rule_print_dbg(chan, reg_rule);
841 power_rule = ®_rule->power_rule;
842 freq_range = ®_rule->freq_range;
844 if (freq_range->max_bandwidth_khz < MHZ_TO_KHZ(40))
845 bw_flags = IEEE80211_CHAN_NO_HT40;
847 if (last_request->initiator == NL80211_REGDOM_SET_BY_DRIVER &&
848 request_wiphy && request_wiphy == wiphy &&
849 request_wiphy->flags & WIPHY_FLAG_STRICT_REGULATORY) {
851 * This guarantees the driver's requested regulatory domain
852 * will always be used as a base for further regulatory
855 chan->flags = chan->orig_flags =
856 map_regdom_flags(reg_rule->flags) | bw_flags;
857 chan->max_antenna_gain = chan->orig_mag =
858 (int) MBI_TO_DBI(power_rule->max_antenna_gain);
859 chan->max_reg_power = chan->max_power = chan->orig_mpwr =
860 (int) MBM_TO_DBM(power_rule->max_eirp);
864 chan->beacon_found = false;
865 chan->flags = flags | bw_flags | map_regdom_flags(reg_rule->flags);
866 chan->max_antenna_gain =
867 min_t(int, chan->orig_mag,
868 MBI_TO_DBI(power_rule->max_antenna_gain));
869 chan->max_reg_power = (int) MBM_TO_DBM(power_rule->max_eirp);
870 if (chan->orig_mpwr) {
872 * Devices that have their own custom regulatory domain
873 * but also use WIPHY_FLAG_STRICT_REGULATORY will follow the
874 * passed country IE power settings.
876 if (initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE &&
877 wiphy->flags & WIPHY_FLAG_CUSTOM_REGULATORY &&
878 wiphy->flags & WIPHY_FLAG_STRICT_REGULATORY)
879 chan->max_power = chan->max_reg_power;
881 chan->max_power = min(chan->orig_mpwr,
882 chan->max_reg_power);
884 chan->max_power = chan->max_reg_power;
887 static void handle_band(struct wiphy *wiphy,
888 enum nl80211_reg_initiator initiator,
889 struct ieee80211_supported_band *sband)
896 for (i = 0; i < sband->n_channels; i++)
897 handle_channel(wiphy, initiator, &sband->channels[i]);
900 static bool reg_request_cell_base(struct regulatory_request *request)
902 if (request->initiator != NL80211_REGDOM_SET_BY_USER)
904 return request->user_reg_hint_type == NL80211_USER_REG_HINT_CELL_BASE;
907 bool reg_last_request_cell_base(void)
911 mutex_lock(®_mutex);
912 val = reg_request_cell_base(last_request);
913 mutex_unlock(®_mutex);
918 #ifdef CONFIG_CFG80211_CERTIFICATION_ONUS
919 /* Core specific check */
920 static enum reg_request_treatment
921 reg_ignore_cell_hint(struct regulatory_request *pending_request)
923 if (!reg_num_devs_support_basehint)
924 return REG_REQ_IGNORE;
926 if (reg_request_cell_base(last_request) &&
927 !regdom_changes(pending_request->alpha2))
928 return REG_REQ_ALREADY_SET;
933 /* Device specific check */
934 static bool reg_dev_ignore_cell_hint(struct wiphy *wiphy)
936 return !(wiphy->features & NL80211_FEATURE_CELL_BASE_REG_HINTS);
939 static int reg_ignore_cell_hint(struct regulatory_request *pending_request)
941 return REG_REQ_IGNORE;
944 static bool reg_dev_ignore_cell_hint(struct wiphy *wiphy)
951 static bool ignore_reg_update(struct wiphy *wiphy,
952 enum nl80211_reg_initiator initiator)
955 REG_DBG_PRINT("Ignoring regulatory request %s since last_request is not set\n",
956 reg_initiator_name(initiator));
960 if (initiator == NL80211_REGDOM_SET_BY_CORE &&
961 wiphy->flags & WIPHY_FLAG_CUSTOM_REGULATORY) {
962 REG_DBG_PRINT("Ignoring regulatory request %s since the driver uses its own custom regulatory domain\n",
963 reg_initiator_name(initiator));
968 * wiphy->regd will be set once the device has its own
969 * desired regulatory domain set
971 if (wiphy->flags & WIPHY_FLAG_STRICT_REGULATORY && !wiphy->regd &&
972 initiator != NL80211_REGDOM_SET_BY_COUNTRY_IE &&
973 !is_world_regdom(last_request->alpha2)) {
974 REG_DBG_PRINT("Ignoring regulatory request %s since the driver requires its own regulatory domain to be set first\n",
975 reg_initiator_name(initiator));
979 if (reg_request_cell_base(last_request))
980 return reg_dev_ignore_cell_hint(wiphy);
985 static void handle_reg_beacon(struct wiphy *wiphy, unsigned int chan_idx,
986 struct reg_beacon *reg_beacon)
988 struct ieee80211_supported_band *sband;
989 struct ieee80211_channel *chan;
990 bool channel_changed = false;
991 struct ieee80211_channel chan_before;
993 sband = wiphy->bands[reg_beacon->chan.band];
994 chan = &sband->channels[chan_idx];
996 if (likely(chan->center_freq != reg_beacon->chan.center_freq))
999 if (chan->beacon_found)
1002 chan->beacon_found = true;
1004 if (wiphy->flags & WIPHY_FLAG_DISABLE_BEACON_HINTS)
1007 chan_before.center_freq = chan->center_freq;
1008 chan_before.flags = chan->flags;
1010 if (chan->flags & IEEE80211_CHAN_PASSIVE_SCAN) {
1011 chan->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
1012 channel_changed = true;
1015 if (chan->flags & IEEE80211_CHAN_NO_IBSS) {
1016 chan->flags &= ~IEEE80211_CHAN_NO_IBSS;
1017 channel_changed = true;
1020 if (channel_changed)
1021 nl80211_send_beacon_hint_event(wiphy, &chan_before, chan);
1025 * Called when a scan on a wiphy finds a beacon on
1028 static void wiphy_update_new_beacon(struct wiphy *wiphy,
1029 struct reg_beacon *reg_beacon)
1032 struct ieee80211_supported_band *sband;
1034 if (!wiphy->bands[reg_beacon->chan.band])
1037 sband = wiphy->bands[reg_beacon->chan.band];
1039 for (i = 0; i < sband->n_channels; i++)
1040 handle_reg_beacon(wiphy, i, reg_beacon);
1044 * Called upon reg changes or a new wiphy is added
1046 static void wiphy_update_beacon_reg(struct wiphy *wiphy)
1049 struct ieee80211_supported_band *sband;
1050 struct reg_beacon *reg_beacon;
1052 list_for_each_entry(reg_beacon, ®_beacon_list, list) {
1053 if (!wiphy->bands[reg_beacon->chan.band])
1055 sband = wiphy->bands[reg_beacon->chan.band];
1056 for (i = 0; i < sband->n_channels; i++)
1057 handle_reg_beacon(wiphy, i, reg_beacon);
1061 static bool reg_is_world_roaming(struct wiphy *wiphy)
1063 assert_cfg80211_lock();
1065 if (is_world_regdom(cfg80211_regdomain->alpha2) ||
1066 (wiphy->regd && is_world_regdom(wiphy->regd->alpha2)))
1069 last_request->initiator != NL80211_REGDOM_SET_BY_COUNTRY_IE &&
1070 wiphy->flags & WIPHY_FLAG_CUSTOM_REGULATORY)
1075 /* Reap the advantages of previously found beacons */
1076 static void reg_process_beacons(struct wiphy *wiphy)
1079 * Means we are just firing up cfg80211, so no beacons would
1080 * have been processed yet.
1084 if (!reg_is_world_roaming(wiphy))
1086 wiphy_update_beacon_reg(wiphy);
1089 static bool is_ht40_allowed(struct ieee80211_channel *chan)
1093 if (chan->flags & IEEE80211_CHAN_DISABLED)
1095 /* This would happen when regulatory rules disallow HT40 completely */
1096 return !(chan->flags & IEEE80211_CHAN_NO_HT40);
1099 static void reg_process_ht_flags_channel(struct wiphy *wiphy,
1100 struct ieee80211_channel *channel)
1102 struct ieee80211_supported_band *sband = wiphy->bands[channel->band];
1103 struct ieee80211_channel *channel_before = NULL, *channel_after = NULL;
1106 if (!is_ht40_allowed(channel)) {
1107 channel->flags |= IEEE80211_CHAN_NO_HT40;
1112 * We need to ensure the extension channels exist to
1113 * be able to use HT40- or HT40+, this finds them (or not)
1115 for (i = 0; i < sband->n_channels; i++) {
1116 struct ieee80211_channel *c = &sband->channels[i];
1118 if (c->center_freq == (channel->center_freq - 20))
1120 if (c->center_freq == (channel->center_freq + 20))
1125 * Please note that this assumes target bandwidth is 20 MHz,
1126 * if that ever changes we also need to change the below logic
1127 * to include that as well.
1129 if (!is_ht40_allowed(channel_before))
1130 channel->flags |= IEEE80211_CHAN_NO_HT40MINUS;
1132 channel->flags &= ~IEEE80211_CHAN_NO_HT40MINUS;
1134 if (!is_ht40_allowed(channel_after))
1135 channel->flags |= IEEE80211_CHAN_NO_HT40PLUS;
1137 channel->flags &= ~IEEE80211_CHAN_NO_HT40PLUS;
1140 static void reg_process_ht_flags_band(struct wiphy *wiphy,
1141 struct ieee80211_supported_band *sband)
1148 for (i = 0; i < sband->n_channels; i++)
1149 reg_process_ht_flags_channel(wiphy, &sband->channels[i]);
1152 static void reg_process_ht_flags(struct wiphy *wiphy)
1154 enum ieee80211_band band;
1159 for (band = 0; band < IEEE80211_NUM_BANDS; band++)
1160 reg_process_ht_flags_band(wiphy, wiphy->bands[band]);
1163 static void wiphy_update_regulatory(struct wiphy *wiphy,
1164 enum nl80211_reg_initiator initiator)
1166 enum ieee80211_band band;
1168 assert_cfg80211_lock();
1171 if (ignore_reg_update(wiphy, initiator))
1174 last_request->dfs_region = cfg80211_regdomain->dfs_region;
1176 for (band = 0; band < IEEE80211_NUM_BANDS; band++)
1177 handle_band(wiphy, initiator, wiphy->bands[band]);
1179 reg_process_beacons(wiphy);
1180 reg_process_ht_flags(wiphy);
1182 if (wiphy->reg_notifier)
1183 wiphy->reg_notifier(wiphy, last_request);
1186 static void update_all_wiphy_regulatory(enum nl80211_reg_initiator initiator)
1188 struct cfg80211_registered_device *rdev;
1189 struct wiphy *wiphy;
1191 list_for_each_entry(rdev, &cfg80211_rdev_list, list) {
1192 wiphy = &rdev->wiphy;
1193 wiphy_update_regulatory(wiphy, initiator);
1195 * Regulatory updates set by CORE are ignored for custom
1196 * regulatory cards. Let us notify the changes to the driver,
1197 * as some drivers used this to restore its orig_* reg domain.
1199 if (initiator == NL80211_REGDOM_SET_BY_CORE &&
1200 wiphy->flags & WIPHY_FLAG_CUSTOM_REGULATORY &&
1201 wiphy->reg_notifier)
1202 wiphy->reg_notifier(wiphy, last_request);
1206 static void handle_channel_custom(struct wiphy *wiphy,
1207 struct ieee80211_channel *chan,
1208 const struct ieee80211_regdomain *regd)
1212 const struct ieee80211_reg_rule *reg_rule = NULL;
1213 const struct ieee80211_power_rule *power_rule = NULL;
1214 const struct ieee80211_freq_range *freq_range = NULL;
1216 r = freq_reg_info_regd(wiphy, MHZ_TO_KHZ(chan->center_freq),
1220 REG_DBG_PRINT("Disabling freq %d MHz as custom regd has no rule that fits it\n",
1222 chan->flags = IEEE80211_CHAN_DISABLED;
1226 chan_reg_rule_print_dbg(chan, reg_rule);
1228 power_rule = ®_rule->power_rule;
1229 freq_range = ®_rule->freq_range;
1231 if (freq_range->max_bandwidth_khz < MHZ_TO_KHZ(40))
1232 bw_flags = IEEE80211_CHAN_NO_HT40;
1234 chan->flags |= map_regdom_flags(reg_rule->flags) | bw_flags;
1235 chan->max_antenna_gain = (int) MBI_TO_DBI(power_rule->max_antenna_gain);
1236 chan->max_reg_power = chan->max_power =
1237 (int) MBM_TO_DBM(power_rule->max_eirp);
1240 static void handle_band_custom(struct wiphy *wiphy,
1241 struct ieee80211_supported_band *sband,
1242 const struct ieee80211_regdomain *regd)
1249 for (i = 0; i < sband->n_channels; i++)
1250 handle_channel_custom(wiphy, &sband->channels[i], regd);
1253 /* Used by drivers prior to wiphy registration */
1254 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
1255 const struct ieee80211_regdomain *regd)
1257 enum ieee80211_band band;
1258 unsigned int bands_set = 0;
1260 for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
1261 if (!wiphy->bands[band])
1263 handle_band_custom(wiphy, wiphy->bands[band], regd);
1268 * no point in calling this if it won't have any effect
1269 * on your device's supported bands.
1271 WARN_ON(!bands_set);
1273 EXPORT_SYMBOL(wiphy_apply_custom_regulatory);
1275 /* This has the logic which determines when a new request
1276 * should be ignored. */
1277 static enum reg_request_treatment
1278 get_reg_request_treatment(struct wiphy *wiphy,
1279 struct regulatory_request *pending_request)
1281 struct wiphy *last_wiphy = NULL;
1283 /* All initial requests are respected */
1287 switch (pending_request->initiator) {
1288 case NL80211_REGDOM_SET_BY_CORE:
1290 case NL80211_REGDOM_SET_BY_COUNTRY_IE:
1291 if (reg_request_cell_base(last_request)) {
1292 /* Trust a Cell base station over the AP's country IE */
1293 if (regdom_changes(pending_request->alpha2))
1294 return REG_REQ_IGNORE;
1295 return REG_REQ_ALREADY_SET;
1298 last_wiphy = wiphy_idx_to_wiphy(last_request->wiphy_idx);
1300 if (unlikely(!is_an_alpha2(pending_request->alpha2)))
1302 if (last_request->initiator ==
1303 NL80211_REGDOM_SET_BY_COUNTRY_IE) {
1304 if (last_wiphy != wiphy) {
1306 * Two cards with two APs claiming different
1307 * Country IE alpha2s. We could
1308 * intersect them, but that seems unlikely
1309 * to be correct. Reject second one for now.
1311 if (regdom_changes(pending_request->alpha2))
1312 return REG_REQ_IGNORE;
1313 return REG_REQ_ALREADY_SET;
1316 * Two consecutive Country IE hints on the same wiphy.
1317 * This should be picked up early by the driver/stack
1319 if (WARN_ON(regdom_changes(pending_request->alpha2)))
1321 return REG_REQ_ALREADY_SET;
1324 case NL80211_REGDOM_SET_BY_DRIVER:
1325 if (last_request->initiator == NL80211_REGDOM_SET_BY_CORE) {
1326 if (regdom_changes(pending_request->alpha2))
1328 return REG_REQ_ALREADY_SET;
1332 * This would happen if you unplug and plug your card
1333 * back in or if you add a new device for which the previously
1334 * loaded card also agrees on the regulatory domain.
1336 if (last_request->initiator == NL80211_REGDOM_SET_BY_DRIVER &&
1337 !regdom_changes(pending_request->alpha2))
1338 return REG_REQ_ALREADY_SET;
1340 return REG_REQ_INTERSECT;
1341 case NL80211_REGDOM_SET_BY_USER:
1342 if (reg_request_cell_base(pending_request))
1343 return reg_ignore_cell_hint(pending_request);
1345 if (reg_request_cell_base(last_request))
1346 return REG_REQ_IGNORE;
1348 if (last_request->initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE)
1349 return REG_REQ_INTERSECT;
1351 * If the user knows better the user should set the regdom
1352 * to their country before the IE is picked up
1354 if (last_request->initiator == NL80211_REGDOM_SET_BY_USER &&
1355 last_request->intersect)
1356 return REG_REQ_IGNORE;
1358 * Process user requests only after previous user/driver/core
1359 * requests have been processed
1361 if ((last_request->initiator == NL80211_REGDOM_SET_BY_CORE ||
1362 last_request->initiator == NL80211_REGDOM_SET_BY_DRIVER ||
1363 last_request->initiator == NL80211_REGDOM_SET_BY_USER) &&
1364 regdom_changes(last_request->alpha2))
1365 return REG_REQ_IGNORE;
1367 if (!regdom_changes(pending_request->alpha2))
1368 return REG_REQ_ALREADY_SET;
1373 return REG_REQ_IGNORE;
1376 static void reg_set_request_processed(void)
1378 bool need_more_processing = false;
1380 last_request->processed = true;
1382 spin_lock(®_requests_lock);
1383 if (!list_empty(®_requests_list))
1384 need_more_processing = true;
1385 spin_unlock(®_requests_lock);
1387 if (last_request->initiator == NL80211_REGDOM_SET_BY_USER)
1388 cancel_delayed_work(®_timeout);
1390 if (need_more_processing)
1391 schedule_work(®_work);
1395 * __regulatory_hint - hint to the wireless core a regulatory domain
1396 * @wiphy: if the hint comes from country information from an AP, this
1397 * is required to be set to the wiphy that received the information
1398 * @pending_request: the regulatory request currently being processed
1400 * The Wireless subsystem can use this function to hint to the wireless core
1401 * what it believes should be the current regulatory domain.
1403 * Returns one of the different reg request treatment values.
1405 * Caller must hold &cfg80211_mutex and ®_mutex
1407 static enum reg_request_treatment
1408 __regulatory_hint(struct wiphy *wiphy,
1409 struct regulatory_request *pending_request)
1411 const struct ieee80211_regdomain *regd;
1412 bool intersect = false;
1413 enum reg_request_treatment treatment;
1415 assert_cfg80211_lock();
1417 treatment = get_reg_request_treatment(wiphy, pending_request);
1419 switch (treatment) {
1420 case REG_REQ_INTERSECT:
1421 if (pending_request->initiator ==
1422 NL80211_REGDOM_SET_BY_DRIVER) {
1423 regd = reg_copy_regd(cfg80211_regdomain);
1425 kfree(pending_request);
1426 return PTR_ERR(regd);
1436 * If the regulatory domain being requested by the
1437 * driver has already been set just copy it to the
1440 if (treatment == REG_REQ_ALREADY_SET &&
1441 pending_request->initiator == NL80211_REGDOM_SET_BY_DRIVER) {
1442 regd = reg_copy_regd(cfg80211_regdomain);
1444 kfree(pending_request);
1445 return REG_REQ_IGNORE;
1447 treatment = REG_REQ_ALREADY_SET;
1451 kfree(pending_request);
1456 if (last_request != &core_request_world)
1457 kfree(last_request);
1459 last_request = pending_request;
1460 last_request->intersect = intersect;
1461 last_request->processed = false;
1463 pending_request = NULL;
1465 if (last_request->initiator == NL80211_REGDOM_SET_BY_USER) {
1466 user_alpha2[0] = last_request->alpha2[0];
1467 user_alpha2[1] = last_request->alpha2[1];
1470 /* When r == REG_REQ_INTERSECT we do need to call CRDA */
1471 if (treatment != REG_REQ_OK && treatment != REG_REQ_INTERSECT) {
1473 * Since CRDA will not be called in this case as we already
1474 * have applied the requested regulatory domain before we just
1475 * inform userspace we have processed the request
1477 if (treatment == REG_REQ_ALREADY_SET) {
1478 nl80211_send_reg_change_event(last_request);
1479 reg_set_request_processed();
1484 if (call_crda(last_request->alpha2))
1485 return REG_REQ_IGNORE;
1489 /* This processes *all* regulatory hints */
1490 static void reg_process_hint(struct regulatory_request *reg_request,
1491 enum nl80211_reg_initiator reg_initiator)
1493 struct wiphy *wiphy = NULL;
1495 if (WARN_ON(!reg_request->alpha2))
1498 if (reg_request->wiphy_idx != WIPHY_IDX_INVALID)
1499 wiphy = wiphy_idx_to_wiphy(reg_request->wiphy_idx);
1501 if (reg_initiator == NL80211_REGDOM_SET_BY_DRIVER && !wiphy) {
1506 switch (__regulatory_hint(wiphy, reg_request)) {
1507 case REG_REQ_ALREADY_SET:
1508 /* This is required so that the orig_* parameters are saved */
1509 if (wiphy && wiphy->flags & WIPHY_FLAG_STRICT_REGULATORY)
1510 wiphy_update_regulatory(wiphy, reg_initiator);
1513 if (reg_initiator == NL80211_REGDOM_SET_BY_USER)
1514 schedule_delayed_work(®_timeout,
1515 msecs_to_jiffies(3142));
1521 * Processes regulatory hints, this is all the NL80211_REGDOM_SET_BY_*
1522 * Regulatory hints come on a first come first serve basis and we
1523 * must process each one atomically.
1525 static void reg_process_pending_hints(void)
1527 struct regulatory_request *reg_request;
1529 mutex_lock(&cfg80211_mutex);
1530 mutex_lock(®_mutex);
1532 /* When last_request->processed becomes true this will be rescheduled */
1533 if (last_request && !last_request->processed) {
1534 REG_DBG_PRINT("Pending regulatory request, waiting for it to be processed...\n");
1538 spin_lock(®_requests_lock);
1540 if (list_empty(®_requests_list)) {
1541 spin_unlock(®_requests_lock);
1545 reg_request = list_first_entry(®_requests_list,
1546 struct regulatory_request,
1548 list_del_init(®_request->list);
1550 spin_unlock(®_requests_lock);
1552 reg_process_hint(reg_request, reg_request->initiator);
1555 mutex_unlock(®_mutex);
1556 mutex_unlock(&cfg80211_mutex);
1559 /* Processes beacon hints -- this has nothing to do with country IEs */
1560 static void reg_process_pending_beacon_hints(void)
1562 struct cfg80211_registered_device *rdev;
1563 struct reg_beacon *pending_beacon, *tmp;
1566 * No need to hold the reg_mutex here as we just touch wiphys
1567 * and do not read or access regulatory variables.
1569 mutex_lock(&cfg80211_mutex);
1571 /* This goes through the _pending_ beacon list */
1572 spin_lock_bh(®_pending_beacons_lock);
1574 list_for_each_entry_safe(pending_beacon, tmp,
1575 ®_pending_beacons, list) {
1576 list_del_init(&pending_beacon->list);
1578 /* Applies the beacon hint to current wiphys */
1579 list_for_each_entry(rdev, &cfg80211_rdev_list, list)
1580 wiphy_update_new_beacon(&rdev->wiphy, pending_beacon);
1582 /* Remembers the beacon hint for new wiphys or reg changes */
1583 list_add_tail(&pending_beacon->list, ®_beacon_list);
1586 spin_unlock_bh(®_pending_beacons_lock);
1587 mutex_unlock(&cfg80211_mutex);
1590 static void reg_todo(struct work_struct *work)
1592 reg_process_pending_hints();
1593 reg_process_pending_beacon_hints();
1596 static void queue_regulatory_request(struct regulatory_request *request)
1598 request->alpha2[0] = toupper(request->alpha2[0]);
1599 request->alpha2[1] = toupper(request->alpha2[1]);
1601 spin_lock(®_requests_lock);
1602 list_add_tail(&request->list, ®_requests_list);
1603 spin_unlock(®_requests_lock);
1605 schedule_work(®_work);
1609 * Core regulatory hint -- happens during cfg80211_init()
1610 * and when we restore regulatory settings.
1612 static int regulatory_hint_core(const char *alpha2)
1614 struct regulatory_request *request;
1616 request = kzalloc(sizeof(struct regulatory_request), GFP_KERNEL);
1620 request->alpha2[0] = alpha2[0];
1621 request->alpha2[1] = alpha2[1];
1622 request->initiator = NL80211_REGDOM_SET_BY_CORE;
1624 queue_regulatory_request(request);
1630 int regulatory_hint_user(const char *alpha2,
1631 enum nl80211_user_reg_hint_type user_reg_hint_type)
1633 struct regulatory_request *request;
1635 if (WARN_ON(!alpha2))
1638 request = kzalloc(sizeof(struct regulatory_request), GFP_KERNEL);
1642 request->wiphy_idx = WIPHY_IDX_INVALID;
1643 request->alpha2[0] = alpha2[0];
1644 request->alpha2[1] = alpha2[1];
1645 request->initiator = NL80211_REGDOM_SET_BY_USER;
1646 request->user_reg_hint_type = user_reg_hint_type;
1648 queue_regulatory_request(request);
1654 int regulatory_hint(struct wiphy *wiphy, const char *alpha2)
1656 struct regulatory_request *request;
1658 if (WARN_ON(!alpha2 || !wiphy))
1661 request = kzalloc(sizeof(struct regulatory_request), GFP_KERNEL);
1665 request->wiphy_idx = get_wiphy_idx(wiphy);
1667 request->alpha2[0] = alpha2[0];
1668 request->alpha2[1] = alpha2[1];
1669 request->initiator = NL80211_REGDOM_SET_BY_DRIVER;
1671 queue_regulatory_request(request);
1675 EXPORT_SYMBOL(regulatory_hint);
1678 * We hold wdev_lock() here so we cannot hold cfg80211_mutex() and
1679 * therefore cannot iterate over the rdev list here.
1681 void regulatory_hint_11d(struct wiphy *wiphy, enum ieee80211_band band,
1682 const u8 *country_ie, u8 country_ie_len)
1685 enum environment_cap env = ENVIRON_ANY;
1686 struct regulatory_request *request;
1688 mutex_lock(®_mutex);
1690 if (unlikely(!last_request))
1693 /* IE len must be evenly divisible by 2 */
1694 if (country_ie_len & 0x01)
1697 if (country_ie_len < IEEE80211_COUNTRY_IE_MIN_LEN)
1700 alpha2[0] = country_ie[0];
1701 alpha2[1] = country_ie[1];
1703 if (country_ie[2] == 'I')
1704 env = ENVIRON_INDOOR;
1705 else if (country_ie[2] == 'O')
1706 env = ENVIRON_OUTDOOR;
1709 * We will run this only upon a successful connection on cfg80211.
1710 * We leave conflict resolution to the workqueue, where can hold
1713 if (last_request->initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE &&
1714 last_request->wiphy_idx != WIPHY_IDX_INVALID)
1717 request = kzalloc(sizeof(struct regulatory_request), GFP_KERNEL);
1721 request->wiphy_idx = get_wiphy_idx(wiphy);
1722 request->alpha2[0] = alpha2[0];
1723 request->alpha2[1] = alpha2[1];
1724 request->initiator = NL80211_REGDOM_SET_BY_COUNTRY_IE;
1725 request->country_ie_env = env;
1727 queue_regulatory_request(request);
1729 mutex_unlock(®_mutex);
1732 static void restore_alpha2(char *alpha2, bool reset_user)
1734 /* indicates there is no alpha2 to consider for restoration */
1738 /* The user setting has precedence over the module parameter */
1739 if (is_user_regdom_saved()) {
1740 /* Unless we're asked to ignore it and reset it */
1742 REG_DBG_PRINT("Restoring regulatory settings including user preference\n");
1743 user_alpha2[0] = '9';
1744 user_alpha2[1] = '7';
1747 * If we're ignoring user settings, we still need to
1748 * check the module parameter to ensure we put things
1749 * back as they were for a full restore.
1751 if (!is_world_regdom(ieee80211_regdom)) {
1752 REG_DBG_PRINT("Keeping preference on module parameter ieee80211_regdom: %c%c\n",
1753 ieee80211_regdom[0], ieee80211_regdom[1]);
1754 alpha2[0] = ieee80211_regdom[0];
1755 alpha2[1] = ieee80211_regdom[1];
1758 REG_DBG_PRINT("Restoring regulatory settings while preserving user preference for: %c%c\n",
1759 user_alpha2[0], user_alpha2[1]);
1760 alpha2[0] = user_alpha2[0];
1761 alpha2[1] = user_alpha2[1];
1763 } else if (!is_world_regdom(ieee80211_regdom)) {
1764 REG_DBG_PRINT("Keeping preference on module parameter ieee80211_regdom: %c%c\n",
1765 ieee80211_regdom[0], ieee80211_regdom[1]);
1766 alpha2[0] = ieee80211_regdom[0];
1767 alpha2[1] = ieee80211_regdom[1];
1769 REG_DBG_PRINT("Restoring regulatory settings\n");
1772 static void restore_custom_reg_settings(struct wiphy *wiphy)
1774 struct ieee80211_supported_band *sband;
1775 enum ieee80211_band band;
1776 struct ieee80211_channel *chan;
1779 for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
1780 sband = wiphy->bands[band];
1783 for (i = 0; i < sband->n_channels; i++) {
1784 chan = &sband->channels[i];
1785 chan->flags = chan->orig_flags;
1786 chan->max_antenna_gain = chan->orig_mag;
1787 chan->max_power = chan->orig_mpwr;
1788 chan->beacon_found = false;
1794 * Restoring regulatory settings involves ingoring any
1795 * possibly stale country IE information and user regulatory
1796 * settings if so desired, this includes any beacon hints
1797 * learned as we could have traveled outside to another country
1798 * after disconnection. To restore regulatory settings we do
1799 * exactly what we did at bootup:
1801 * - send a core regulatory hint
1802 * - send a user regulatory hint if applicable
1804 * Device drivers that send a regulatory hint for a specific country
1805 * keep their own regulatory domain on wiphy->regd so that does does
1806 * not need to be remembered.
1808 static void restore_regulatory_settings(bool reset_user)
1811 char world_alpha2[2];
1812 struct reg_beacon *reg_beacon, *btmp;
1813 struct regulatory_request *reg_request, *tmp;
1814 LIST_HEAD(tmp_reg_req_list);
1815 struct cfg80211_registered_device *rdev;
1817 mutex_lock(&cfg80211_mutex);
1818 mutex_lock(®_mutex);
1820 reset_regdomains(true);
1821 restore_alpha2(alpha2, reset_user);
1824 * If there's any pending requests we simply
1825 * stash them to a temporary pending queue and
1826 * add then after we've restored regulatory
1829 spin_lock(®_requests_lock);
1830 list_for_each_entry_safe(reg_request, tmp, ®_requests_list, list) {
1831 if (reg_request->initiator != NL80211_REGDOM_SET_BY_USER)
1833 list_move_tail(®_request->list, &tmp_reg_req_list);
1835 spin_unlock(®_requests_lock);
1837 /* Clear beacon hints */
1838 spin_lock_bh(®_pending_beacons_lock);
1839 list_for_each_entry_safe(reg_beacon, btmp, ®_pending_beacons, list) {
1840 list_del(®_beacon->list);
1843 spin_unlock_bh(®_pending_beacons_lock);
1845 list_for_each_entry_safe(reg_beacon, btmp, ®_beacon_list, list) {
1846 list_del(®_beacon->list);
1850 /* First restore to the basic regulatory settings */
1851 cfg80211_regdomain = cfg80211_world_regdom;
1852 world_alpha2[0] = cfg80211_regdomain->alpha2[0];
1853 world_alpha2[1] = cfg80211_regdomain->alpha2[1];
1855 list_for_each_entry(rdev, &cfg80211_rdev_list, list) {
1856 if (rdev->wiphy.flags & WIPHY_FLAG_CUSTOM_REGULATORY)
1857 restore_custom_reg_settings(&rdev->wiphy);
1860 regulatory_hint_core(world_alpha2);
1863 * This restores the ieee80211_regdom module parameter
1864 * preference or the last user requested regulatory
1865 * settings, user regulatory settings takes precedence.
1867 if (is_an_alpha2(alpha2))
1868 regulatory_hint_user(user_alpha2, NL80211_USER_REG_HINT_USER);
1870 spin_lock(®_requests_lock);
1871 list_splice_tail_init(&tmp_reg_req_list, ®_requests_list);
1872 spin_unlock(®_requests_lock);
1874 mutex_unlock(®_mutex);
1875 mutex_unlock(&cfg80211_mutex);
1877 REG_DBG_PRINT("Kicking the queue\n");
1879 schedule_work(®_work);
1882 void regulatory_hint_disconnect(void)
1884 REG_DBG_PRINT("All devices are disconnected, going to restore regulatory settings\n");
1885 restore_regulatory_settings(false);
1888 static bool freq_is_chan_12_13_14(u16 freq)
1890 if (freq == ieee80211_channel_to_frequency(12, IEEE80211_BAND_2GHZ) ||
1891 freq == ieee80211_channel_to_frequency(13, IEEE80211_BAND_2GHZ) ||
1892 freq == ieee80211_channel_to_frequency(14, IEEE80211_BAND_2GHZ))
1897 int regulatory_hint_found_beacon(struct wiphy *wiphy,
1898 struct ieee80211_channel *beacon_chan,
1901 struct reg_beacon *reg_beacon;
1903 if (beacon_chan->beacon_found ||
1904 beacon_chan->flags & IEEE80211_CHAN_RADAR ||
1905 (beacon_chan->band == IEEE80211_BAND_2GHZ &&
1906 !freq_is_chan_12_13_14(beacon_chan->center_freq)))
1909 reg_beacon = kzalloc(sizeof(struct reg_beacon), gfp);
1913 REG_DBG_PRINT("Found new beacon on frequency: %d MHz (Ch %d) on %s\n",
1914 beacon_chan->center_freq,
1915 ieee80211_frequency_to_channel(beacon_chan->center_freq),
1918 memcpy(®_beacon->chan, beacon_chan,
1919 sizeof(struct ieee80211_channel));
1922 * Since we can be called from BH or and non-BH context
1923 * we must use spin_lock_bh()
1925 spin_lock_bh(®_pending_beacons_lock);
1926 list_add_tail(®_beacon->list, ®_pending_beacons);
1927 spin_unlock_bh(®_pending_beacons_lock);
1929 schedule_work(®_work);
1934 static void print_rd_rules(const struct ieee80211_regdomain *rd)
1937 const struct ieee80211_reg_rule *reg_rule = NULL;
1938 const struct ieee80211_freq_range *freq_range = NULL;
1939 const struct ieee80211_power_rule *power_rule = NULL;
1941 pr_info(" (start_freq - end_freq @ bandwidth), (max_antenna_gain, max_eirp)\n");
1943 for (i = 0; i < rd->n_reg_rules; i++) {
1944 reg_rule = &rd->reg_rules[i];
1945 freq_range = ®_rule->freq_range;
1946 power_rule = ®_rule->power_rule;
1949 * There may not be documentation for max antenna gain
1950 * in certain regions
1952 if (power_rule->max_antenna_gain)
1953 pr_info(" (%d KHz - %d KHz @ %d KHz), (%d mBi, %d mBm)\n",
1954 freq_range->start_freq_khz,
1955 freq_range->end_freq_khz,
1956 freq_range->max_bandwidth_khz,
1957 power_rule->max_antenna_gain,
1958 power_rule->max_eirp);
1960 pr_info(" (%d KHz - %d KHz @ %d KHz), (N/A, %d mBm)\n",
1961 freq_range->start_freq_khz,
1962 freq_range->end_freq_khz,
1963 freq_range->max_bandwidth_khz,
1964 power_rule->max_eirp);
1968 bool reg_supported_dfs_region(u8 dfs_region)
1970 switch (dfs_region) {
1971 case NL80211_DFS_UNSET:
1972 case NL80211_DFS_FCC:
1973 case NL80211_DFS_ETSI:
1974 case NL80211_DFS_JP:
1977 REG_DBG_PRINT("Ignoring uknown DFS master region: %d\n",
1983 static void print_dfs_region(u8 dfs_region)
1988 switch (dfs_region) {
1989 case NL80211_DFS_FCC:
1990 pr_info(" DFS Master region FCC");
1992 case NL80211_DFS_ETSI:
1993 pr_info(" DFS Master region ETSI");
1995 case NL80211_DFS_JP:
1996 pr_info(" DFS Master region JP");
1999 pr_info(" DFS Master region Unknown");
2004 static void print_regdomain(const struct ieee80211_regdomain *rd)
2007 if (is_intersected_alpha2(rd->alpha2)) {
2008 if (last_request->initiator ==
2009 NL80211_REGDOM_SET_BY_COUNTRY_IE) {
2010 struct cfg80211_registered_device *rdev;
2011 rdev = cfg80211_rdev_by_wiphy_idx(
2012 last_request->wiphy_idx);
2014 pr_info("Current regulatory domain updated by AP to: %c%c\n",
2015 rdev->country_ie_alpha2[0],
2016 rdev->country_ie_alpha2[1]);
2018 pr_info("Current regulatory domain intersected:\n");
2020 pr_info("Current regulatory domain intersected:\n");
2021 } else if (is_world_regdom(rd->alpha2)) {
2022 pr_info("World regulatory domain updated:\n");
2024 if (is_unknown_alpha2(rd->alpha2))
2025 pr_info("Regulatory domain changed to driver built-in settings (unknown country)\n");
2027 if (reg_request_cell_base(last_request))
2028 pr_info("Regulatory domain changed to country: %c%c by Cell Station\n",
2029 rd->alpha2[0], rd->alpha2[1]);
2031 pr_info("Regulatory domain changed to country: %c%c\n",
2032 rd->alpha2[0], rd->alpha2[1]);
2036 print_dfs_region(rd->dfs_region);
2040 static void print_regdomain_info(const struct ieee80211_regdomain *rd)
2042 pr_info("Regulatory domain: %c%c\n", rd->alpha2[0], rd->alpha2[1]);
2046 /* Takes ownership of rd only if it doesn't fail */
2047 static int __set_regdom(const struct ieee80211_regdomain *rd)
2049 const struct ieee80211_regdomain *regd;
2050 const struct ieee80211_regdomain *intersected_rd = NULL;
2051 struct wiphy *request_wiphy;
2053 /* Some basic sanity checks first */
2055 if (!reg_is_valid_request(rd->alpha2))
2058 if (is_world_regdom(rd->alpha2)) {
2059 update_world_regdomain(rd);
2063 if (!is_alpha2_set(rd->alpha2) && !is_an_alpha2(rd->alpha2) &&
2064 !is_unknown_alpha2(rd->alpha2))
2068 * Lets only bother proceeding on the same alpha2 if the current
2069 * rd is non static (it means CRDA was present and was used last)
2070 * and the pending request came in from a country IE
2072 if (last_request->initiator != NL80211_REGDOM_SET_BY_COUNTRY_IE) {
2074 * If someone else asked us to change the rd lets only bother
2075 * checking if the alpha2 changes if CRDA was already called
2077 if (!regdom_changes(rd->alpha2))
2082 * Now lets set the regulatory domain, update all driver channels
2083 * and finally inform them of what we have done, in case they want
2084 * to review or adjust their own settings based on their own
2085 * internal EEPROM data
2088 if (!is_valid_rd(rd)) {
2089 pr_err("Invalid regulatory domain detected:\n");
2090 print_regdomain_info(rd);
2094 request_wiphy = wiphy_idx_to_wiphy(last_request->wiphy_idx);
2095 if (!request_wiphy &&
2096 (last_request->initiator == NL80211_REGDOM_SET_BY_DRIVER ||
2097 last_request->initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE)) {
2098 schedule_delayed_work(®_timeout, 0);
2102 if (!last_request->intersect) {
2103 if (last_request->initiator != NL80211_REGDOM_SET_BY_DRIVER) {
2104 reset_regdomains(false);
2105 cfg80211_regdomain = rd;
2110 * For a driver hint, lets copy the regulatory domain the
2111 * driver wanted to the wiphy to deal with conflicts
2115 * Userspace could have sent two replies with only
2116 * one kernel request.
2118 if (request_wiphy->regd)
2121 regd = reg_copy_regd(rd);
2123 return PTR_ERR(regd);
2125 request_wiphy->regd = regd;
2126 reset_regdomains(false);
2127 cfg80211_regdomain = rd;
2131 /* Intersection requires a bit more work */
2133 if (last_request->initiator != NL80211_REGDOM_SET_BY_COUNTRY_IE) {
2134 intersected_rd = regdom_intersect(rd, cfg80211_regdomain);
2135 if (!intersected_rd)
2139 * We can trash what CRDA provided now.
2140 * However if a driver requested this specific regulatory
2141 * domain we keep it for its private use
2143 if (last_request->initiator == NL80211_REGDOM_SET_BY_DRIVER)
2144 request_wiphy->regd = rd;
2150 reset_regdomains(false);
2151 cfg80211_regdomain = intersected_rd;
2161 * Use this call to set the current regulatory domain. Conflicts with
2162 * multiple drivers can be ironed out later. Caller must've already
2163 * kmalloc'd the rd structure. Caller must hold cfg80211_mutex
2165 int set_regdom(const struct ieee80211_regdomain *rd)
2169 assert_cfg80211_lock();
2171 mutex_lock(®_mutex);
2173 /* Note that this doesn't update the wiphys, this is done below */
2174 r = __set_regdom(rd);
2177 reg_set_request_processed();
2183 /* This would make this whole thing pointless */
2184 if (WARN_ON(!last_request->intersect && rd != cfg80211_regdomain)) {
2189 /* update all wiphys now with the new established regulatory domain */
2190 update_all_wiphy_regulatory(last_request->initiator);
2192 print_regdomain(cfg80211_regdomain);
2194 nl80211_send_reg_change_event(last_request);
2196 reg_set_request_processed();
2199 mutex_unlock(®_mutex);
2204 #ifdef CONFIG_HOTPLUG
2205 int reg_device_uevent(struct device *dev, struct kobj_uevent_env *env)
2207 if (last_request && !last_request->processed) {
2208 if (add_uevent_var(env, "COUNTRY=%c%c",
2209 last_request->alpha2[0],
2210 last_request->alpha2[1]))
2217 int reg_device_uevent(struct device *dev, struct kobj_uevent_env *env)
2221 #endif /* CONFIG_HOTPLUG */
2223 void wiphy_regulatory_register(struct wiphy *wiphy)
2225 mutex_lock(®_mutex);
2227 if (!reg_dev_ignore_cell_hint(wiphy))
2228 reg_num_devs_support_basehint++;
2230 wiphy_update_regulatory(wiphy, NL80211_REGDOM_SET_BY_CORE);
2232 mutex_unlock(®_mutex);
2235 /* Caller must hold cfg80211_mutex */
2236 void wiphy_regulatory_deregister(struct wiphy *wiphy)
2238 struct wiphy *request_wiphy = NULL;
2240 mutex_lock(®_mutex);
2242 if (!reg_dev_ignore_cell_hint(wiphy))
2243 reg_num_devs_support_basehint--;
2248 request_wiphy = wiphy_idx_to_wiphy(last_request->wiphy_idx);
2250 if (!request_wiphy || request_wiphy != wiphy)
2253 last_request->wiphy_idx = WIPHY_IDX_INVALID;
2254 last_request->country_ie_env = ENVIRON_ANY;
2256 mutex_unlock(®_mutex);
2259 static void reg_timeout_work(struct work_struct *work)
2261 REG_DBG_PRINT("Timeout while waiting for CRDA to reply, restoring regulatory settings\n");
2262 restore_regulatory_settings(true);
2265 int __init regulatory_init(void)
2269 reg_pdev = platform_device_register_simple("regulatory", 0, NULL, 0);
2270 if (IS_ERR(reg_pdev))
2271 return PTR_ERR(reg_pdev);
2273 reg_pdev->dev.type = ®_device_type;
2275 spin_lock_init(®_requests_lock);
2276 spin_lock_init(®_pending_beacons_lock);
2278 reg_regdb_size_check();
2280 cfg80211_regdomain = cfg80211_world_regdom;
2282 user_alpha2[0] = '9';
2283 user_alpha2[1] = '7';
2285 /* We always try to get an update for the static regdomain */
2286 err = regulatory_hint_core(cfg80211_regdomain->alpha2);
2291 * N.B. kobject_uevent_env() can fail mainly for when we're out
2292 * memory which is handled and propagated appropriately above
2293 * but it can also fail during a netlink_broadcast() or during
2294 * early boot for call_usermodehelper(). For now treat these
2295 * errors as non-fatal.
2297 pr_err("kobject_uevent_env() was unable to call CRDA during init\n");
2301 * Finally, if the user set the module parameter treat it
2304 if (!is_world_regdom(ieee80211_regdom))
2305 regulatory_hint_user(ieee80211_regdom,
2306 NL80211_USER_REG_HINT_USER);
2311 void regulatory_exit(void)
2313 struct regulatory_request *reg_request, *tmp;
2314 struct reg_beacon *reg_beacon, *btmp;
2316 cancel_work_sync(®_work);
2317 cancel_delayed_work_sync(®_timeout);
2319 /* Lock to suppress warnings */
2320 mutex_lock(&cfg80211_mutex);
2321 mutex_lock(®_mutex);
2322 reset_regdomains(true);
2323 mutex_unlock(&cfg80211_mutex);
2324 mutex_unlock(®_mutex);
2326 dev_set_uevent_suppress(®_pdev->dev, true);
2328 platform_device_unregister(reg_pdev);
2330 list_for_each_entry_safe(reg_beacon, btmp, ®_pending_beacons, list) {
2331 list_del(®_beacon->list);
2335 list_for_each_entry_safe(reg_beacon, btmp, ®_beacon_list, list) {
2336 list_del(®_beacon->list);
2340 list_for_each_entry_safe(reg_request, tmp, ®_requests_list, list) {
2341 list_del(®_request->list);