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/random.h>
52 #include <linux/ctype.h>
53 #include <linux/nl80211.h>
54 #include <linux/platform_device.h>
55 #include <linux/moduleparam.h>
56 #include <net/cfg80211.h>
62 #ifdef CONFIG_CFG80211_REG_DEBUG
63 #define REG_DBG_PRINT(format, args...) \
64 printk(KERN_DEBUG pr_fmt(format), ##args)
66 #define REG_DBG_PRINT(args...)
69 static struct regulatory_request core_request_world = {
70 .initiator = NL80211_REGDOM_SET_BY_CORE,
75 .country_ie_env = ENVIRON_ANY,
78 /* Receipt of information from last regulatory request */
79 static struct regulatory_request *last_request = &core_request_world;
81 /* To trigger userspace events */
82 static struct platform_device *reg_pdev;
84 static struct device_type reg_device_type = {
85 .uevent = reg_device_uevent,
89 * Central wireless core regulatory domains, we only need two,
90 * the current one and a world regulatory domain in case we have no
91 * information to give us an alpha2
93 const struct ieee80211_regdomain *cfg80211_regdomain;
96 * Protects static reg.c components:
97 * - cfg80211_world_regdom
100 * - reg_num_devs_support_basehint
102 static DEFINE_MUTEX(reg_mutex);
105 * Number of devices that registered to the core
106 * that support cellular base station regulatory hints
108 static int reg_num_devs_support_basehint;
110 static inline void assert_reg_lock(void)
112 lockdep_assert_held(®_mutex);
115 /* Used to queue up regulatory hints */
116 static LIST_HEAD(reg_requests_list);
117 static spinlock_t reg_requests_lock;
119 /* Used to queue up beacon hints for review */
120 static LIST_HEAD(reg_pending_beacons);
121 static spinlock_t reg_pending_beacons_lock;
123 /* Used to keep track of processed beacon hints */
124 static LIST_HEAD(reg_beacon_list);
127 struct list_head list;
128 struct ieee80211_channel chan;
131 static void reg_todo(struct work_struct *work);
132 static DECLARE_WORK(reg_work, reg_todo);
134 static void reg_timeout_work(struct work_struct *work);
135 static DECLARE_DELAYED_WORK(reg_timeout, reg_timeout_work);
137 /* We keep a static world regulatory domain in case of the absence of CRDA */
138 static const struct ieee80211_regdomain world_regdom = {
142 /* IEEE 802.11b/g, channels 1..11 */
143 REG_RULE(2412-10, 2462+10, 40, 6, 20, 0),
144 /* IEEE 802.11b/g, channels 12..13. */
145 REG_RULE(2467-10, 2472+10, 40, 6, 20,
146 NL80211_RRF_PASSIVE_SCAN |
147 NL80211_RRF_NO_IBSS),
148 /* IEEE 802.11 channel 14 - Only JP enables
149 * this and for 802.11b only */
150 REG_RULE(2484-10, 2484+10, 20, 6, 20,
151 NL80211_RRF_PASSIVE_SCAN |
152 NL80211_RRF_NO_IBSS |
153 NL80211_RRF_NO_OFDM),
154 /* IEEE 802.11a, channel 36..48 */
155 REG_RULE(5180-10, 5240+10, 40, 6, 20,
156 NL80211_RRF_PASSIVE_SCAN |
157 NL80211_RRF_NO_IBSS),
159 /* NB: 5260 MHz - 5700 MHz requies DFS */
161 /* IEEE 802.11a, channel 149..165 */
162 REG_RULE(5745-10, 5825+10, 40, 6, 20,
163 NL80211_RRF_PASSIVE_SCAN |
164 NL80211_RRF_NO_IBSS),
166 /* IEEE 802.11ad (60gHz), channels 1..3 */
167 REG_RULE(56160+2160*1-1080, 56160+2160*3+1080, 2160, 0, 0, 0),
171 static const struct ieee80211_regdomain *cfg80211_world_regdom =
174 static char *ieee80211_regdom = "00";
175 static char user_alpha2[2];
177 module_param(ieee80211_regdom, charp, 0444);
178 MODULE_PARM_DESC(ieee80211_regdom, "IEEE 802.11 regulatory domain code");
180 static void reset_regdomains(bool full_reset)
182 /* avoid freeing static information or freeing something twice */
183 if (cfg80211_regdomain == cfg80211_world_regdom)
184 cfg80211_regdomain = NULL;
185 if (cfg80211_world_regdom == &world_regdom)
186 cfg80211_world_regdom = NULL;
187 if (cfg80211_regdomain == &world_regdom)
188 cfg80211_regdomain = NULL;
190 kfree(cfg80211_regdomain);
191 kfree(cfg80211_world_regdom);
193 cfg80211_world_regdom = &world_regdom;
194 cfg80211_regdomain = NULL;
199 if (last_request != &core_request_world)
201 last_request = &core_request_world;
205 * Dynamic world regulatory domain requested by the wireless
206 * core upon initialization
208 static void update_world_regdomain(const struct ieee80211_regdomain *rd)
210 BUG_ON(!last_request);
212 reset_regdomains(false);
214 cfg80211_world_regdom = rd;
215 cfg80211_regdomain = rd;
218 bool is_world_regdom(const char *alpha2)
222 if (alpha2[0] == '0' && alpha2[1] == '0')
227 static bool is_alpha2_set(const char *alpha2)
231 if (alpha2[0] != 0 && alpha2[1] != 0)
236 static bool is_unknown_alpha2(const char *alpha2)
241 * Special case where regulatory domain was built by driver
242 * but a specific alpha2 cannot be determined
244 if (alpha2[0] == '9' && alpha2[1] == '9')
249 static bool is_intersected_alpha2(const char *alpha2)
254 * Special case where regulatory domain is the
255 * result of an intersection between two regulatory domain
258 if (alpha2[0] == '9' && alpha2[1] == '8')
263 static bool is_an_alpha2(const char *alpha2)
267 if (isalpha(alpha2[0]) && isalpha(alpha2[1]))
272 static bool alpha2_equal(const char *alpha2_x, const char *alpha2_y)
274 if (!alpha2_x || !alpha2_y)
276 if (alpha2_x[0] == alpha2_y[0] &&
277 alpha2_x[1] == alpha2_y[1])
282 static bool regdom_changes(const char *alpha2)
284 assert_cfg80211_lock();
286 if (!cfg80211_regdomain)
288 if (alpha2_equal(cfg80211_regdomain->alpha2, alpha2))
294 * The NL80211_REGDOM_SET_BY_USER regdom alpha2 is cached, this lets
295 * you know if a valid regulatory hint with NL80211_REGDOM_SET_BY_USER
296 * has ever been issued.
298 static bool is_user_regdom_saved(void)
300 if (user_alpha2[0] == '9' && user_alpha2[1] == '7')
303 /* This would indicate a mistake on the design */
304 if (WARN((!is_world_regdom(user_alpha2) &&
305 !is_an_alpha2(user_alpha2)),
306 "Unexpected user alpha2: %c%c\n",
314 static const struct ieee80211_regdomain *
315 reg_copy_regd(const struct ieee80211_regdomain *src_regd)
317 struct ieee80211_regdomain *regd;
322 sizeof(struct ieee80211_regdomain) +
323 src_regd->n_reg_rules * sizeof(struct ieee80211_reg_rule);
325 regd = kzalloc(size_of_regd, GFP_KERNEL);
327 return ERR_PTR(-ENOMEM);
329 memcpy(regd, src_regd, sizeof(struct ieee80211_regdomain));
331 for (i = 0; i < src_regd->n_reg_rules; i++)
332 memcpy(®d->reg_rules[i], &src_regd->reg_rules[i],
333 sizeof(struct ieee80211_reg_rule));
338 #ifdef CONFIG_CFG80211_INTERNAL_REGDB
339 struct reg_regdb_search_request {
341 struct list_head list;
344 static LIST_HEAD(reg_regdb_search_list);
345 static DEFINE_MUTEX(reg_regdb_search_mutex);
347 static void reg_regdb_search(struct work_struct *work)
349 struct reg_regdb_search_request *request;
350 const struct ieee80211_regdomain *curdom, *regdom = NULL;
353 mutex_lock(&cfg80211_mutex);
355 mutex_lock(®_regdb_search_mutex);
356 while (!list_empty(®_regdb_search_list)) {
357 request = list_first_entry(®_regdb_search_list,
358 struct reg_regdb_search_request,
360 list_del(&request->list);
362 for (i=0; i<reg_regdb_size; i++) {
363 curdom = reg_regdb[i];
365 if (!memcmp(request->alpha2, curdom->alpha2, 2)) {
366 regdom = reg_copy_regd(curdom);
373 mutex_unlock(®_regdb_search_mutex);
375 if (!IS_ERR_OR_NULL(regdom))
378 mutex_unlock(&cfg80211_mutex);
381 static DECLARE_WORK(reg_regdb_work, reg_regdb_search);
383 static void reg_regdb_query(const char *alpha2)
385 struct reg_regdb_search_request *request;
390 request = kzalloc(sizeof(struct reg_regdb_search_request), GFP_KERNEL);
394 memcpy(request->alpha2, alpha2, 2);
396 mutex_lock(®_regdb_search_mutex);
397 list_add_tail(&request->list, ®_regdb_search_list);
398 mutex_unlock(®_regdb_search_mutex);
400 schedule_work(®_regdb_work);
403 /* Feel free to add any other sanity checks here */
404 static void reg_regdb_size_check(void)
406 /* We should ideally BUILD_BUG_ON() but then random builds would fail */
407 WARN_ONCE(!reg_regdb_size, "db.txt is empty, you should update it...");
410 static inline void reg_regdb_size_check(void) {}
411 static inline void reg_regdb_query(const char *alpha2) {}
412 #endif /* CONFIG_CFG80211_INTERNAL_REGDB */
415 * This lets us keep regulatory code which is updated on a regulatory
416 * basis in userspace. Country information is filled in by
419 static int call_crda(const char *alpha2)
421 if (!is_world_regdom((char *) alpha2))
422 pr_info("Calling CRDA for country: %c%c\n",
423 alpha2[0], alpha2[1]);
425 pr_info("Calling CRDA to update world regulatory domain\n");
427 /* query internal regulatory database (if it exists) */
428 reg_regdb_query(alpha2);
430 return kobject_uevent(®_pdev->dev.kobj, KOBJ_CHANGE);
433 /* Used by nl80211 before kmalloc'ing our regulatory domain */
434 bool reg_is_valid_request(const char *alpha2)
436 assert_cfg80211_lock();
441 return alpha2_equal(last_request->alpha2, alpha2);
444 /* Sanity check on a regulatory rule */
445 static bool is_valid_reg_rule(const struct ieee80211_reg_rule *rule)
447 const struct ieee80211_freq_range *freq_range = &rule->freq_range;
450 if (freq_range->start_freq_khz <= 0 || freq_range->end_freq_khz <= 0)
453 if (freq_range->start_freq_khz > freq_range->end_freq_khz)
456 freq_diff = freq_range->end_freq_khz - freq_range->start_freq_khz;
458 if (freq_range->end_freq_khz <= freq_range->start_freq_khz ||
459 freq_range->max_bandwidth_khz > freq_diff)
465 static bool is_valid_rd(const struct ieee80211_regdomain *rd)
467 const struct ieee80211_reg_rule *reg_rule = NULL;
470 if (!rd->n_reg_rules)
473 if (WARN_ON(rd->n_reg_rules > NL80211_MAX_SUPP_REG_RULES))
476 for (i = 0; i < rd->n_reg_rules; i++) {
477 reg_rule = &rd->reg_rules[i];
478 if (!is_valid_reg_rule(reg_rule))
485 static bool reg_does_bw_fit(const struct ieee80211_freq_range *freq_range,
489 u32 start_freq_khz, end_freq_khz;
491 start_freq_khz = center_freq_khz - (bw_khz/2);
492 end_freq_khz = center_freq_khz + (bw_khz/2);
494 if (start_freq_khz >= freq_range->start_freq_khz &&
495 end_freq_khz <= freq_range->end_freq_khz)
502 * freq_in_rule_band - tells us if a frequency is in a frequency band
503 * @freq_range: frequency rule we want to query
504 * @freq_khz: frequency we are inquiring about
506 * This lets us know if a specific frequency rule is or is not relevant to
507 * a specific frequency's band. Bands are device specific and artificial
508 * definitions (the "2.4 GHz band", the "5 GHz band" and the "60GHz band"),
509 * however it is safe for now to assume that a frequency rule should not be
510 * part of a frequency's band if the start freq or end freq are off by more
511 * than 2 GHz for the 2.4 and 5 GHz bands, and by more than 10 GHz for the
513 * This resolution can be lowered and should be considered as we add
514 * regulatory rule support for other "bands".
516 static bool freq_in_rule_band(const struct ieee80211_freq_range *freq_range,
519 #define ONE_GHZ_IN_KHZ 1000000
521 * From 802.11ad: directional multi-gigabit (DMG):
522 * Pertaining to operation in a frequency band containing a channel
523 * with the Channel starting frequency above 45 GHz.
525 u32 limit = freq_khz > 45 * ONE_GHZ_IN_KHZ ?
526 10 * ONE_GHZ_IN_KHZ : 2 * ONE_GHZ_IN_KHZ;
527 if (abs(freq_khz - freq_range->start_freq_khz) <= limit)
529 if (abs(freq_khz - freq_range->end_freq_khz) <= limit)
532 #undef ONE_GHZ_IN_KHZ
536 * Helper for regdom_intersect(), this does the real
537 * mathematical intersection fun
539 static int reg_rules_intersect(
540 const struct ieee80211_reg_rule *rule1,
541 const struct ieee80211_reg_rule *rule2,
542 struct ieee80211_reg_rule *intersected_rule)
544 const struct ieee80211_freq_range *freq_range1, *freq_range2;
545 struct ieee80211_freq_range *freq_range;
546 const struct ieee80211_power_rule *power_rule1, *power_rule2;
547 struct ieee80211_power_rule *power_rule;
550 freq_range1 = &rule1->freq_range;
551 freq_range2 = &rule2->freq_range;
552 freq_range = &intersected_rule->freq_range;
554 power_rule1 = &rule1->power_rule;
555 power_rule2 = &rule2->power_rule;
556 power_rule = &intersected_rule->power_rule;
558 freq_range->start_freq_khz = max(freq_range1->start_freq_khz,
559 freq_range2->start_freq_khz);
560 freq_range->end_freq_khz = min(freq_range1->end_freq_khz,
561 freq_range2->end_freq_khz);
562 freq_range->max_bandwidth_khz = min(freq_range1->max_bandwidth_khz,
563 freq_range2->max_bandwidth_khz);
565 freq_diff = freq_range->end_freq_khz - freq_range->start_freq_khz;
566 if (freq_range->max_bandwidth_khz > freq_diff)
567 freq_range->max_bandwidth_khz = freq_diff;
569 power_rule->max_eirp = min(power_rule1->max_eirp,
570 power_rule2->max_eirp);
571 power_rule->max_antenna_gain = min(power_rule1->max_antenna_gain,
572 power_rule2->max_antenna_gain);
574 intersected_rule->flags = (rule1->flags | rule2->flags);
576 if (!is_valid_reg_rule(intersected_rule))
583 * regdom_intersect - do the intersection between two regulatory domains
584 * @rd1: first regulatory domain
585 * @rd2: second regulatory domain
587 * Use this function to get the intersection between two regulatory domains.
588 * Once completed we will mark the alpha2 for the rd as intersected, "98",
589 * as no one single alpha2 can represent this regulatory domain.
591 * Returns a pointer to the regulatory domain structure which will hold the
592 * resulting intersection of rules between rd1 and rd2. We will
593 * kzalloc() this structure for you.
595 static struct ieee80211_regdomain *regdom_intersect(
596 const struct ieee80211_regdomain *rd1,
597 const struct ieee80211_regdomain *rd2)
601 unsigned int num_rules = 0, rule_idx = 0;
602 const struct ieee80211_reg_rule *rule1, *rule2;
603 struct ieee80211_reg_rule *intersected_rule;
604 struct ieee80211_regdomain *rd;
605 /* This is just a dummy holder to help us count */
606 struct ieee80211_reg_rule dummy_rule;
612 * First we get a count of the rules we'll need, then we actually
613 * build them. This is to so we can malloc() and free() a
614 * regdomain once. The reason we use reg_rules_intersect() here
615 * is it will return -EINVAL if the rule computed makes no sense.
616 * All rules that do check out OK are valid.
619 for (x = 0; x < rd1->n_reg_rules; x++) {
620 rule1 = &rd1->reg_rules[x];
621 for (y = 0; y < rd2->n_reg_rules; y++) {
622 rule2 = &rd2->reg_rules[y];
623 if (!reg_rules_intersect(rule1, rule2, &dummy_rule))
631 size_of_regd = sizeof(struct ieee80211_regdomain) +
632 num_rules * sizeof(struct ieee80211_reg_rule);
634 rd = kzalloc(size_of_regd, GFP_KERNEL);
638 for (x = 0; x < rd1->n_reg_rules && rule_idx < num_rules; x++) {
639 rule1 = &rd1->reg_rules[x];
640 for (y = 0; y < rd2->n_reg_rules && rule_idx < num_rules; y++) {
641 rule2 = &rd2->reg_rules[y];
643 * This time around instead of using the stack lets
644 * write to the target rule directly saving ourselves
647 intersected_rule = &rd->reg_rules[rule_idx];
648 r = reg_rules_intersect(rule1, rule2,
651 * No need to memset here the intersected rule here as
652 * we're not using the stack anymore
660 if (rule_idx != num_rules) {
665 rd->n_reg_rules = num_rules;
673 * XXX: add support for the rest of enum nl80211_reg_rule_flags, we may
674 * want to just have the channel structure use these
676 static u32 map_regdom_flags(u32 rd_flags)
678 u32 channel_flags = 0;
679 if (rd_flags & NL80211_RRF_PASSIVE_SCAN)
680 channel_flags |= IEEE80211_CHAN_PASSIVE_SCAN;
681 if (rd_flags & NL80211_RRF_NO_IBSS)
682 channel_flags |= IEEE80211_CHAN_NO_IBSS;
683 if (rd_flags & NL80211_RRF_DFS)
684 channel_flags |= IEEE80211_CHAN_RADAR;
685 if (rd_flags & NL80211_RRF_NO_OFDM)
686 channel_flags |= IEEE80211_CHAN_NO_OFDM;
687 return channel_flags;
690 static int freq_reg_info_regd(struct wiphy *wiphy,
693 const struct ieee80211_reg_rule **reg_rule,
694 const struct ieee80211_regdomain *custom_regd)
697 bool band_rule_found = false;
698 const struct ieee80211_regdomain *regd;
699 bool bw_fits = false;
702 desired_bw_khz = MHZ_TO_KHZ(20);
704 regd = custom_regd ? custom_regd : cfg80211_regdomain;
707 * Follow the driver's regulatory domain, if present, unless a country
708 * IE has been processed or a user wants to help complaince further
711 last_request->initiator != NL80211_REGDOM_SET_BY_COUNTRY_IE &&
712 last_request->initiator != NL80211_REGDOM_SET_BY_USER &&
719 for (i = 0; i < regd->n_reg_rules; i++) {
720 const struct ieee80211_reg_rule *rr;
721 const struct ieee80211_freq_range *fr = NULL;
723 rr = ®d->reg_rules[i];
724 fr = &rr->freq_range;
727 * We only need to know if one frequency rule was
728 * was in center_freq's band, that's enough, so lets
729 * not overwrite it once found
731 if (!band_rule_found)
732 band_rule_found = freq_in_rule_band(fr, center_freq);
734 bw_fits = reg_does_bw_fit(fr,
738 if (band_rule_found && bw_fits) {
744 if (!band_rule_found)
750 int freq_reg_info(struct wiphy *wiphy,
753 const struct ieee80211_reg_rule **reg_rule)
755 assert_cfg80211_lock();
756 return freq_reg_info_regd(wiphy,
762 EXPORT_SYMBOL(freq_reg_info);
764 #ifdef CONFIG_CFG80211_REG_DEBUG
765 static const char *reg_initiator_name(enum nl80211_reg_initiator initiator)
768 case NL80211_REGDOM_SET_BY_CORE:
769 return "Set by core";
770 case NL80211_REGDOM_SET_BY_USER:
771 return "Set by user";
772 case NL80211_REGDOM_SET_BY_DRIVER:
773 return "Set by driver";
774 case NL80211_REGDOM_SET_BY_COUNTRY_IE:
775 return "Set by country IE";
782 static void chan_reg_rule_print_dbg(struct ieee80211_channel *chan,
784 const struct ieee80211_reg_rule *reg_rule)
786 const struct ieee80211_power_rule *power_rule;
787 const struct ieee80211_freq_range *freq_range;
788 char max_antenna_gain[32];
790 power_rule = ®_rule->power_rule;
791 freq_range = ®_rule->freq_range;
793 if (!power_rule->max_antenna_gain)
794 snprintf(max_antenna_gain, 32, "N/A");
796 snprintf(max_antenna_gain, 32, "%d", power_rule->max_antenna_gain);
798 REG_DBG_PRINT("Updating information on frequency %d MHz "
799 "for a %d MHz width channel with regulatory rule:\n",
801 KHZ_TO_MHZ(desired_bw_khz));
803 REG_DBG_PRINT("%d KHz - %d KHz @ %d KHz), (%s mBi, %d mBm)\n",
804 freq_range->start_freq_khz,
805 freq_range->end_freq_khz,
806 freq_range->max_bandwidth_khz,
808 power_rule->max_eirp);
811 static void chan_reg_rule_print_dbg(struct ieee80211_channel *chan,
813 const struct ieee80211_reg_rule *reg_rule)
820 * Note that right now we assume the desired channel bandwidth
821 * is always 20 MHz for each individual channel (HT40 uses 20 MHz
822 * per channel, the primary and the extension channel). To support
823 * smaller custom bandwidths such as 5 MHz or 10 MHz we'll need a
824 * new ieee80211_channel.target_bw and re run the regulatory check
825 * on the wiphy with the target_bw specified. Then we can simply use
826 * that below for the desired_bw_khz below.
828 static void handle_channel(struct wiphy *wiphy,
829 enum nl80211_reg_initiator initiator,
830 enum ieee80211_band band,
831 unsigned int chan_idx)
834 u32 flags, bw_flags = 0;
835 u32 desired_bw_khz = MHZ_TO_KHZ(20);
836 const struct ieee80211_reg_rule *reg_rule = NULL;
837 const struct ieee80211_power_rule *power_rule = NULL;
838 const struct ieee80211_freq_range *freq_range = NULL;
839 struct ieee80211_supported_band *sband;
840 struct ieee80211_channel *chan;
841 struct wiphy *request_wiphy = NULL;
843 assert_cfg80211_lock();
845 request_wiphy = wiphy_idx_to_wiphy(last_request->wiphy_idx);
847 sband = wiphy->bands[band];
848 BUG_ON(chan_idx >= sband->n_channels);
849 chan = &sband->channels[chan_idx];
851 flags = chan->orig_flags;
853 r = freq_reg_info(wiphy,
854 MHZ_TO_KHZ(chan->center_freq),
860 * We will disable all channels that do not match our
861 * received regulatory rule unless the hint is coming
862 * from a Country IE and the Country IE had no information
863 * about a band. The IEEE 802.11 spec allows for an AP
864 * to send only a subset of the regulatory rules allowed,
865 * so an AP in the US that only supports 2.4 GHz may only send
866 * a country IE with information for the 2.4 GHz band
867 * while 5 GHz is still supported.
869 if (initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE &&
873 REG_DBG_PRINT("Disabling freq %d MHz\n", chan->center_freq);
874 chan->flags = IEEE80211_CHAN_DISABLED;
878 chan_reg_rule_print_dbg(chan, desired_bw_khz, reg_rule);
880 power_rule = ®_rule->power_rule;
881 freq_range = ®_rule->freq_range;
883 if (freq_range->max_bandwidth_khz < MHZ_TO_KHZ(40))
884 bw_flags = IEEE80211_CHAN_NO_HT40;
886 if (last_request->initiator == NL80211_REGDOM_SET_BY_DRIVER &&
887 request_wiphy && request_wiphy == wiphy &&
888 request_wiphy->flags & WIPHY_FLAG_STRICT_REGULATORY) {
890 * This guarantees the driver's requested regulatory domain
891 * will always be used as a base for further regulatory
894 chan->flags = chan->orig_flags =
895 map_regdom_flags(reg_rule->flags) | bw_flags;
896 chan->max_antenna_gain = chan->orig_mag =
897 (int) MBI_TO_DBI(power_rule->max_antenna_gain);
898 chan->max_reg_power = chan->max_power = chan->orig_mpwr =
899 (int) MBM_TO_DBM(power_rule->max_eirp);
903 chan->beacon_found = false;
904 chan->flags = flags | bw_flags | map_regdom_flags(reg_rule->flags);
905 chan->max_antenna_gain = min(chan->orig_mag,
906 (int) MBI_TO_DBI(power_rule->max_antenna_gain));
907 chan->max_reg_power = (int) MBM_TO_DBM(power_rule->max_eirp);
908 if (chan->orig_mpwr) {
910 * Devices that have their own custom regulatory domain
911 * but also use WIPHY_FLAG_STRICT_REGULATORY will follow the
912 * passed country IE power settings.
914 if (initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE &&
915 wiphy->flags & WIPHY_FLAG_CUSTOM_REGULATORY &&
916 wiphy->flags & WIPHY_FLAG_STRICT_REGULATORY)
917 chan->max_power = chan->max_reg_power;
919 chan->max_power = min(chan->orig_mpwr,
920 chan->max_reg_power);
922 chan->max_power = chan->max_reg_power;
925 static void handle_band(struct wiphy *wiphy,
926 enum ieee80211_band band,
927 enum nl80211_reg_initiator initiator)
930 struct ieee80211_supported_band *sband;
932 BUG_ON(!wiphy->bands[band]);
933 sband = wiphy->bands[band];
935 for (i = 0; i < sband->n_channels; i++)
936 handle_channel(wiphy, initiator, band, i);
939 static bool reg_request_cell_base(struct regulatory_request *request)
941 if (request->initiator != NL80211_REGDOM_SET_BY_USER)
943 if (request->user_reg_hint_type != NL80211_USER_REG_HINT_CELL_BASE)
948 bool reg_last_request_cell_base(void)
951 assert_cfg80211_lock();
953 mutex_lock(®_mutex);
954 val = reg_request_cell_base(last_request);
955 mutex_unlock(®_mutex);
959 #ifdef CONFIG_CFG80211_CERTIFICATION_ONUS
961 /* Core specific check */
962 static int reg_ignore_cell_hint(struct regulatory_request *pending_request)
964 if (!reg_num_devs_support_basehint)
967 if (reg_request_cell_base(last_request)) {
968 if (!regdom_changes(pending_request->alpha2))
975 /* Device specific check */
976 static bool reg_dev_ignore_cell_hint(struct wiphy *wiphy)
978 if (!(wiphy->features & NL80211_FEATURE_CELL_BASE_REG_HINTS))
983 static int reg_ignore_cell_hint(struct regulatory_request *pending_request)
987 static int reg_dev_ignore_cell_hint(struct wiphy *wiphy)
994 static bool ignore_reg_update(struct wiphy *wiphy,
995 enum nl80211_reg_initiator initiator)
998 REG_DBG_PRINT("Ignoring regulatory request %s since "
999 "last_request is not set\n",
1000 reg_initiator_name(initiator));
1004 if (initiator == NL80211_REGDOM_SET_BY_CORE &&
1005 wiphy->flags & WIPHY_FLAG_CUSTOM_REGULATORY) {
1006 REG_DBG_PRINT("Ignoring regulatory request %s "
1007 "since the driver uses its own custom "
1008 "regulatory domain\n",
1009 reg_initiator_name(initiator));
1014 * wiphy->regd will be set once the device has its own
1015 * desired regulatory domain set
1017 if (wiphy->flags & WIPHY_FLAG_STRICT_REGULATORY && !wiphy->regd &&
1018 initiator != NL80211_REGDOM_SET_BY_COUNTRY_IE &&
1019 !is_world_regdom(last_request->alpha2)) {
1020 REG_DBG_PRINT("Ignoring regulatory request %s "
1021 "since the driver requires its own regulatory "
1022 "domain to be set first\n",
1023 reg_initiator_name(initiator));
1027 if (reg_request_cell_base(last_request))
1028 return reg_dev_ignore_cell_hint(wiphy);
1033 static void handle_reg_beacon(struct wiphy *wiphy,
1034 unsigned int chan_idx,
1035 struct reg_beacon *reg_beacon)
1037 struct ieee80211_supported_band *sband;
1038 struct ieee80211_channel *chan;
1039 bool channel_changed = false;
1040 struct ieee80211_channel chan_before;
1042 assert_cfg80211_lock();
1044 sband = wiphy->bands[reg_beacon->chan.band];
1045 chan = &sband->channels[chan_idx];
1047 if (likely(chan->center_freq != reg_beacon->chan.center_freq))
1050 if (chan->beacon_found)
1053 chan->beacon_found = true;
1055 if (wiphy->flags & WIPHY_FLAG_DISABLE_BEACON_HINTS)
1058 chan_before.center_freq = chan->center_freq;
1059 chan_before.flags = chan->flags;
1061 if (chan->flags & IEEE80211_CHAN_PASSIVE_SCAN) {
1062 chan->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
1063 channel_changed = true;
1066 if (chan->flags & IEEE80211_CHAN_NO_IBSS) {
1067 chan->flags &= ~IEEE80211_CHAN_NO_IBSS;
1068 channel_changed = true;
1071 if (channel_changed)
1072 nl80211_send_beacon_hint_event(wiphy, &chan_before, chan);
1076 * Called when a scan on a wiphy finds a beacon on
1079 static void wiphy_update_new_beacon(struct wiphy *wiphy,
1080 struct reg_beacon *reg_beacon)
1083 struct ieee80211_supported_band *sband;
1085 assert_cfg80211_lock();
1087 if (!wiphy->bands[reg_beacon->chan.band])
1090 sband = wiphy->bands[reg_beacon->chan.band];
1092 for (i = 0; i < sband->n_channels; i++)
1093 handle_reg_beacon(wiphy, i, reg_beacon);
1097 * Called upon reg changes or a new wiphy is added
1099 static void wiphy_update_beacon_reg(struct wiphy *wiphy)
1102 struct ieee80211_supported_band *sband;
1103 struct reg_beacon *reg_beacon;
1105 assert_cfg80211_lock();
1107 list_for_each_entry(reg_beacon, ®_beacon_list, list) {
1108 if (!wiphy->bands[reg_beacon->chan.band])
1110 sband = wiphy->bands[reg_beacon->chan.band];
1111 for (i = 0; i < sband->n_channels; i++)
1112 handle_reg_beacon(wiphy, i, reg_beacon);
1116 static bool reg_is_world_roaming(struct wiphy *wiphy)
1118 if (is_world_regdom(cfg80211_regdomain->alpha2) ||
1119 (wiphy->regd && is_world_regdom(wiphy->regd->alpha2)))
1122 last_request->initiator != NL80211_REGDOM_SET_BY_COUNTRY_IE &&
1123 wiphy->flags & WIPHY_FLAG_CUSTOM_REGULATORY)
1128 /* Reap the advantages of previously found beacons */
1129 static void reg_process_beacons(struct wiphy *wiphy)
1132 * Means we are just firing up cfg80211, so no beacons would
1133 * have been processed yet.
1137 if (!reg_is_world_roaming(wiphy))
1139 wiphy_update_beacon_reg(wiphy);
1142 static bool is_ht40_not_allowed(struct ieee80211_channel *chan)
1146 if (chan->flags & IEEE80211_CHAN_DISABLED)
1148 /* This would happen when regulatory rules disallow HT40 completely */
1149 if (IEEE80211_CHAN_NO_HT40 == (chan->flags & (IEEE80211_CHAN_NO_HT40)))
1154 static void reg_process_ht_flags_channel(struct wiphy *wiphy,
1155 enum ieee80211_band band,
1156 unsigned int chan_idx)
1158 struct ieee80211_supported_band *sband;
1159 struct ieee80211_channel *channel;
1160 struct ieee80211_channel *channel_before = NULL, *channel_after = NULL;
1163 assert_cfg80211_lock();
1165 sband = wiphy->bands[band];
1166 BUG_ON(chan_idx >= sband->n_channels);
1167 channel = &sband->channels[chan_idx];
1169 if (is_ht40_not_allowed(channel)) {
1170 channel->flags |= IEEE80211_CHAN_NO_HT40;
1175 * We need to ensure the extension channels exist to
1176 * be able to use HT40- or HT40+, this finds them (or not)
1178 for (i = 0; i < sband->n_channels; i++) {
1179 struct ieee80211_channel *c = &sband->channels[i];
1180 if (c->center_freq == (channel->center_freq - 20))
1182 if (c->center_freq == (channel->center_freq + 20))
1187 * Please note that this assumes target bandwidth is 20 MHz,
1188 * if that ever changes we also need to change the below logic
1189 * to include that as well.
1191 if (is_ht40_not_allowed(channel_before))
1192 channel->flags |= IEEE80211_CHAN_NO_HT40MINUS;
1194 channel->flags &= ~IEEE80211_CHAN_NO_HT40MINUS;
1196 if (is_ht40_not_allowed(channel_after))
1197 channel->flags |= IEEE80211_CHAN_NO_HT40PLUS;
1199 channel->flags &= ~IEEE80211_CHAN_NO_HT40PLUS;
1202 static void reg_process_ht_flags_band(struct wiphy *wiphy,
1203 enum ieee80211_band band)
1206 struct ieee80211_supported_band *sband;
1208 BUG_ON(!wiphy->bands[band]);
1209 sband = wiphy->bands[band];
1211 for (i = 0; i < sband->n_channels; i++)
1212 reg_process_ht_flags_channel(wiphy, band, i);
1215 static void reg_process_ht_flags(struct wiphy *wiphy)
1217 enum ieee80211_band band;
1222 for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
1223 if (wiphy->bands[band])
1224 reg_process_ht_flags_band(wiphy, band);
1229 static void wiphy_update_regulatory(struct wiphy *wiphy,
1230 enum nl80211_reg_initiator initiator)
1232 enum ieee80211_band band;
1236 if (ignore_reg_update(wiphy, initiator))
1239 last_request->dfs_region = cfg80211_regdomain->dfs_region;
1241 for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
1242 if (wiphy->bands[band])
1243 handle_band(wiphy, band, initiator);
1246 reg_process_beacons(wiphy);
1247 reg_process_ht_flags(wiphy);
1248 if (wiphy->reg_notifier)
1249 wiphy->reg_notifier(wiphy, last_request);
1252 static void update_all_wiphy_regulatory(enum nl80211_reg_initiator initiator)
1254 struct cfg80211_registered_device *rdev;
1255 struct wiphy *wiphy;
1257 list_for_each_entry(rdev, &cfg80211_rdev_list, list) {
1258 wiphy = &rdev->wiphy;
1259 wiphy_update_regulatory(wiphy, initiator);
1261 * Regulatory updates set by CORE are ignored for custom
1262 * regulatory cards. Let us notify the changes to the driver,
1263 * as some drivers used this to restore its orig_* reg domain.
1265 if (initiator == NL80211_REGDOM_SET_BY_CORE &&
1266 wiphy->flags & WIPHY_FLAG_CUSTOM_REGULATORY &&
1267 wiphy->reg_notifier)
1268 wiphy->reg_notifier(wiphy, last_request);
1272 static void handle_channel_custom(struct wiphy *wiphy,
1273 enum ieee80211_band band,
1274 unsigned int chan_idx,
1275 const struct ieee80211_regdomain *regd)
1278 u32 desired_bw_khz = MHZ_TO_KHZ(20);
1280 const struct ieee80211_reg_rule *reg_rule = NULL;
1281 const struct ieee80211_power_rule *power_rule = NULL;
1282 const struct ieee80211_freq_range *freq_range = NULL;
1283 struct ieee80211_supported_band *sband;
1284 struct ieee80211_channel *chan;
1288 sband = wiphy->bands[band];
1289 BUG_ON(chan_idx >= sband->n_channels);
1290 chan = &sband->channels[chan_idx];
1292 r = freq_reg_info_regd(wiphy,
1293 MHZ_TO_KHZ(chan->center_freq),
1299 REG_DBG_PRINT("Disabling freq %d MHz as custom "
1300 "regd has no rule that fits a %d MHz "
1303 KHZ_TO_MHZ(desired_bw_khz));
1304 chan->flags = IEEE80211_CHAN_DISABLED;
1308 chan_reg_rule_print_dbg(chan, desired_bw_khz, reg_rule);
1310 power_rule = ®_rule->power_rule;
1311 freq_range = ®_rule->freq_range;
1313 if (freq_range->max_bandwidth_khz < MHZ_TO_KHZ(40))
1314 bw_flags = IEEE80211_CHAN_NO_HT40;
1316 chan->flags |= map_regdom_flags(reg_rule->flags) | bw_flags;
1317 chan->max_antenna_gain = (int) MBI_TO_DBI(power_rule->max_antenna_gain);
1318 chan->max_reg_power = chan->max_power =
1319 (int) MBM_TO_DBM(power_rule->max_eirp);
1322 static void handle_band_custom(struct wiphy *wiphy, enum ieee80211_band band,
1323 const struct ieee80211_regdomain *regd)
1326 struct ieee80211_supported_band *sband;
1328 BUG_ON(!wiphy->bands[band]);
1329 sband = wiphy->bands[band];
1331 for (i = 0; i < sband->n_channels; i++)
1332 handle_channel_custom(wiphy, band, i, regd);
1335 /* Used by drivers prior to wiphy registration */
1336 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
1337 const struct ieee80211_regdomain *regd)
1339 enum ieee80211_band band;
1340 unsigned int bands_set = 0;
1342 mutex_lock(®_mutex);
1343 for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
1344 if (!wiphy->bands[band])
1346 handle_band_custom(wiphy, band, regd);
1349 mutex_unlock(®_mutex);
1352 * no point in calling this if it won't have any effect
1353 * on your device's supportd bands.
1355 WARN_ON(!bands_set);
1357 EXPORT_SYMBOL(wiphy_apply_custom_regulatory);
1360 * Return value which can be used by ignore_request() to indicate
1361 * it has been determined we should intersect two regulatory domains
1363 #define REG_INTERSECT 1
1365 /* This has the logic which determines when a new request
1366 * should be ignored. */
1367 static int ignore_request(struct wiphy *wiphy,
1368 struct regulatory_request *pending_request)
1370 struct wiphy *last_wiphy = NULL;
1372 assert_cfg80211_lock();
1374 /* All initial requests are respected */
1378 switch (pending_request->initiator) {
1379 case NL80211_REGDOM_SET_BY_CORE:
1381 case NL80211_REGDOM_SET_BY_COUNTRY_IE:
1383 if (reg_request_cell_base(last_request)) {
1384 /* Trust a Cell base station over the AP's country IE */
1385 if (regdom_changes(pending_request->alpha2))
1390 last_wiphy = wiphy_idx_to_wiphy(last_request->wiphy_idx);
1392 if (unlikely(!is_an_alpha2(pending_request->alpha2)))
1394 if (last_request->initiator ==
1395 NL80211_REGDOM_SET_BY_COUNTRY_IE) {
1396 if (last_wiphy != wiphy) {
1398 * Two cards with two APs claiming different
1399 * Country IE alpha2s. We could
1400 * intersect them, but that seems unlikely
1401 * to be correct. Reject second one for now.
1403 if (regdom_changes(pending_request->alpha2))
1408 * Two consecutive Country IE hints on the same wiphy.
1409 * This should be picked up early by the driver/stack
1411 if (WARN_ON(regdom_changes(pending_request->alpha2)))
1416 case NL80211_REGDOM_SET_BY_DRIVER:
1417 if (last_request->initiator == NL80211_REGDOM_SET_BY_CORE) {
1418 if (regdom_changes(pending_request->alpha2))
1424 * This would happen if you unplug and plug your card
1425 * back in or if you add a new device for which the previously
1426 * loaded card also agrees on the regulatory domain.
1428 if (last_request->initiator == NL80211_REGDOM_SET_BY_DRIVER &&
1429 !regdom_changes(pending_request->alpha2))
1432 return REG_INTERSECT;
1433 case NL80211_REGDOM_SET_BY_USER:
1434 if (reg_request_cell_base(pending_request))
1435 return reg_ignore_cell_hint(pending_request);
1437 if (reg_request_cell_base(last_request))
1440 if (last_request->initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE)
1441 return REG_INTERSECT;
1443 * If the user knows better the user should set the regdom
1444 * to their country before the IE is picked up
1446 if (last_request->initiator == NL80211_REGDOM_SET_BY_USER &&
1447 last_request->intersect)
1450 * Process user requests only after previous user/driver/core
1451 * requests have been processed
1453 if (last_request->initiator == NL80211_REGDOM_SET_BY_CORE ||
1454 last_request->initiator == NL80211_REGDOM_SET_BY_DRIVER ||
1455 last_request->initiator == NL80211_REGDOM_SET_BY_USER) {
1456 if (regdom_changes(last_request->alpha2))
1460 if (!regdom_changes(pending_request->alpha2))
1469 static void reg_set_request_processed(void)
1471 bool need_more_processing = false;
1473 last_request->processed = true;
1475 spin_lock(®_requests_lock);
1476 if (!list_empty(®_requests_list))
1477 need_more_processing = true;
1478 spin_unlock(®_requests_lock);
1480 if (last_request->initiator == NL80211_REGDOM_SET_BY_USER)
1481 cancel_delayed_work(®_timeout);
1483 if (need_more_processing)
1484 schedule_work(®_work);
1488 * __regulatory_hint - hint to the wireless core a regulatory domain
1489 * @wiphy: if the hint comes from country information from an AP, this
1490 * is required to be set to the wiphy that received the information
1491 * @pending_request: the regulatory request currently being processed
1493 * The Wireless subsystem can use this function to hint to the wireless core
1494 * what it believes should be the current regulatory domain.
1496 * Returns zero if all went fine, %-EALREADY if a regulatory domain had
1497 * already been set or other standard error codes.
1499 * Caller must hold &cfg80211_mutex and ®_mutex
1501 static int __regulatory_hint(struct wiphy *wiphy,
1502 struct regulatory_request *pending_request)
1504 const struct ieee80211_regdomain *regd;
1505 bool intersect = false;
1508 assert_cfg80211_lock();
1510 r = ignore_request(wiphy, pending_request);
1512 if (r == REG_INTERSECT) {
1513 if (pending_request->initiator ==
1514 NL80211_REGDOM_SET_BY_DRIVER) {
1515 regd = reg_copy_regd(cfg80211_regdomain);
1517 kfree(pending_request);
1518 return PTR_ERR(regd);
1525 * If the regulatory domain being requested by the
1526 * driver has already been set just copy it to the
1529 if (r == -EALREADY &&
1530 pending_request->initiator ==
1531 NL80211_REGDOM_SET_BY_DRIVER) {
1532 regd = reg_copy_regd(cfg80211_regdomain);
1534 kfree(pending_request);
1535 return PTR_ERR(regd);
1541 kfree(pending_request);
1546 if (last_request != &core_request_world)
1547 kfree(last_request);
1549 last_request = pending_request;
1550 last_request->intersect = intersect;
1552 pending_request = NULL;
1554 if (last_request->initiator == NL80211_REGDOM_SET_BY_USER) {
1555 user_alpha2[0] = last_request->alpha2[0];
1556 user_alpha2[1] = last_request->alpha2[1];
1559 /* When r == REG_INTERSECT we do need to call CRDA */
1562 * Since CRDA will not be called in this case as we already
1563 * have applied the requested regulatory domain before we just
1564 * inform userspace we have processed the request
1566 if (r == -EALREADY) {
1567 nl80211_send_reg_change_event(last_request);
1568 reg_set_request_processed();
1573 return call_crda(last_request->alpha2);
1576 /* This processes *all* regulatory hints */
1577 static void reg_process_hint(struct regulatory_request *reg_request,
1578 enum nl80211_reg_initiator reg_initiator)
1581 struct wiphy *wiphy = NULL;
1583 BUG_ON(!reg_request->alpha2);
1585 if (wiphy_idx_valid(reg_request->wiphy_idx))
1586 wiphy = wiphy_idx_to_wiphy(reg_request->wiphy_idx);
1588 if (reg_initiator == NL80211_REGDOM_SET_BY_DRIVER &&
1594 r = __regulatory_hint(wiphy, reg_request);
1595 /* This is required so that the orig_* parameters are saved */
1596 if (r == -EALREADY && wiphy &&
1597 wiphy->flags & WIPHY_FLAG_STRICT_REGULATORY) {
1598 wiphy_update_regulatory(wiphy, reg_initiator);
1603 * We only time out user hints, given that they should be the only
1604 * source of bogus requests.
1606 if (r != -EALREADY &&
1607 reg_initiator == NL80211_REGDOM_SET_BY_USER)
1608 schedule_delayed_work(®_timeout, msecs_to_jiffies(3142));
1612 * Processes regulatory hints, this is all the NL80211_REGDOM_SET_BY_*
1613 * Regulatory hints come on a first come first serve basis and we
1614 * must process each one atomically.
1616 static void reg_process_pending_hints(void)
1618 struct regulatory_request *reg_request;
1620 mutex_lock(&cfg80211_mutex);
1621 mutex_lock(®_mutex);
1623 /* When last_request->processed becomes true this will be rescheduled */
1624 if (last_request && !last_request->processed) {
1625 REG_DBG_PRINT("Pending regulatory request, waiting "
1626 "for it to be processed...\n");
1630 spin_lock(®_requests_lock);
1632 if (list_empty(®_requests_list)) {
1633 spin_unlock(®_requests_lock);
1637 reg_request = list_first_entry(®_requests_list,
1638 struct regulatory_request,
1640 list_del_init(®_request->list);
1642 spin_unlock(®_requests_lock);
1644 reg_process_hint(reg_request, reg_request->initiator);
1647 mutex_unlock(®_mutex);
1648 mutex_unlock(&cfg80211_mutex);
1651 /* Processes beacon hints -- this has nothing to do with country IEs */
1652 static void reg_process_pending_beacon_hints(void)
1654 struct cfg80211_registered_device *rdev;
1655 struct reg_beacon *pending_beacon, *tmp;
1658 * No need to hold the reg_mutex here as we just touch wiphys
1659 * and do not read or access regulatory variables.
1661 mutex_lock(&cfg80211_mutex);
1663 /* This goes through the _pending_ beacon list */
1664 spin_lock_bh(®_pending_beacons_lock);
1666 list_for_each_entry_safe(pending_beacon, tmp,
1667 ®_pending_beacons, list) {
1669 list_del_init(&pending_beacon->list);
1671 /* Applies the beacon hint to current wiphys */
1672 list_for_each_entry(rdev, &cfg80211_rdev_list, list)
1673 wiphy_update_new_beacon(&rdev->wiphy, pending_beacon);
1675 /* Remembers the beacon hint for new wiphys or reg changes */
1676 list_add_tail(&pending_beacon->list, ®_beacon_list);
1679 spin_unlock_bh(®_pending_beacons_lock);
1680 mutex_unlock(&cfg80211_mutex);
1683 static void reg_todo(struct work_struct *work)
1685 reg_process_pending_hints();
1686 reg_process_pending_beacon_hints();
1689 static void queue_regulatory_request(struct regulatory_request *request)
1691 if (isalpha(request->alpha2[0]))
1692 request->alpha2[0] = toupper(request->alpha2[0]);
1693 if (isalpha(request->alpha2[1]))
1694 request->alpha2[1] = toupper(request->alpha2[1]);
1696 spin_lock(®_requests_lock);
1697 list_add_tail(&request->list, ®_requests_list);
1698 spin_unlock(®_requests_lock);
1700 schedule_work(®_work);
1704 * Core regulatory hint -- happens during cfg80211_init()
1705 * and when we restore regulatory settings.
1707 static int regulatory_hint_core(const char *alpha2)
1709 struct regulatory_request *request;
1711 request = kzalloc(sizeof(struct regulatory_request),
1716 request->alpha2[0] = alpha2[0];
1717 request->alpha2[1] = alpha2[1];
1718 request->initiator = NL80211_REGDOM_SET_BY_CORE;
1720 queue_regulatory_request(request);
1726 int regulatory_hint_user(const char *alpha2,
1727 enum nl80211_user_reg_hint_type user_reg_hint_type)
1729 struct regulatory_request *request;
1733 request = kzalloc(sizeof(struct regulatory_request), GFP_KERNEL);
1737 request->wiphy_idx = WIPHY_IDX_STALE;
1738 request->alpha2[0] = alpha2[0];
1739 request->alpha2[1] = alpha2[1];
1740 request->initiator = NL80211_REGDOM_SET_BY_USER;
1741 request->user_reg_hint_type = user_reg_hint_type;
1743 queue_regulatory_request(request);
1749 int regulatory_hint(struct wiphy *wiphy, const char *alpha2)
1751 struct regulatory_request *request;
1756 request = kzalloc(sizeof(struct regulatory_request), GFP_KERNEL);
1760 request->wiphy_idx = get_wiphy_idx(wiphy);
1762 /* Must have registered wiphy first */
1763 BUG_ON(!wiphy_idx_valid(request->wiphy_idx));
1765 request->alpha2[0] = alpha2[0];
1766 request->alpha2[1] = alpha2[1];
1767 request->initiator = NL80211_REGDOM_SET_BY_DRIVER;
1769 queue_regulatory_request(request);
1773 EXPORT_SYMBOL(regulatory_hint);
1776 * We hold wdev_lock() here so we cannot hold cfg80211_mutex() and
1777 * therefore cannot iterate over the rdev list here.
1779 void regulatory_hint_11d(struct wiphy *wiphy,
1780 enum ieee80211_band band,
1781 const u8 *country_ie,
1785 enum environment_cap env = ENVIRON_ANY;
1786 struct regulatory_request *request;
1788 mutex_lock(®_mutex);
1790 if (unlikely(!last_request))
1793 /* IE len must be evenly divisible by 2 */
1794 if (country_ie_len & 0x01)
1797 if (country_ie_len < IEEE80211_COUNTRY_IE_MIN_LEN)
1800 alpha2[0] = country_ie[0];
1801 alpha2[1] = country_ie[1];
1803 if (country_ie[2] == 'I')
1804 env = ENVIRON_INDOOR;
1805 else if (country_ie[2] == 'O')
1806 env = ENVIRON_OUTDOOR;
1809 * We will run this only upon a successful connection on cfg80211.
1810 * We leave conflict resolution to the workqueue, where can hold
1813 if (likely(last_request->initiator ==
1814 NL80211_REGDOM_SET_BY_COUNTRY_IE &&
1815 wiphy_idx_valid(last_request->wiphy_idx)))
1818 request = kzalloc(sizeof(struct regulatory_request), GFP_KERNEL);
1822 request->wiphy_idx = get_wiphy_idx(wiphy);
1823 request->alpha2[0] = alpha2[0];
1824 request->alpha2[1] = alpha2[1];
1825 request->initiator = NL80211_REGDOM_SET_BY_COUNTRY_IE;
1826 request->country_ie_env = env;
1828 queue_regulatory_request(request);
1830 mutex_unlock(®_mutex);
1833 static void restore_alpha2(char *alpha2, bool reset_user)
1835 /* indicates there is no alpha2 to consider for restoration */
1839 /* The user setting has precedence over the module parameter */
1840 if (is_user_regdom_saved()) {
1841 /* Unless we're asked to ignore it and reset it */
1843 REG_DBG_PRINT("Restoring regulatory settings "
1844 "including user preference\n");
1845 user_alpha2[0] = '9';
1846 user_alpha2[1] = '7';
1849 * If we're ignoring user settings, we still need to
1850 * check the module parameter to ensure we put things
1851 * back as they were for a full restore.
1853 if (!is_world_regdom(ieee80211_regdom)) {
1854 REG_DBG_PRINT("Keeping preference on "
1855 "module parameter ieee80211_regdom: %c%c\n",
1856 ieee80211_regdom[0],
1857 ieee80211_regdom[1]);
1858 alpha2[0] = ieee80211_regdom[0];
1859 alpha2[1] = ieee80211_regdom[1];
1862 REG_DBG_PRINT("Restoring regulatory settings "
1863 "while preserving user preference for: %c%c\n",
1866 alpha2[0] = user_alpha2[0];
1867 alpha2[1] = user_alpha2[1];
1869 } else if (!is_world_regdom(ieee80211_regdom)) {
1870 REG_DBG_PRINT("Keeping preference on "
1871 "module parameter ieee80211_regdom: %c%c\n",
1872 ieee80211_regdom[0],
1873 ieee80211_regdom[1]);
1874 alpha2[0] = ieee80211_regdom[0];
1875 alpha2[1] = ieee80211_regdom[1];
1877 REG_DBG_PRINT("Restoring regulatory settings\n");
1880 static void restore_custom_reg_settings(struct wiphy *wiphy)
1882 struct ieee80211_supported_band *sband;
1883 enum ieee80211_band band;
1884 struct ieee80211_channel *chan;
1887 for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
1888 sband = wiphy->bands[band];
1891 for (i = 0; i < sband->n_channels; i++) {
1892 chan = &sband->channels[i];
1893 chan->flags = chan->orig_flags;
1894 chan->max_antenna_gain = chan->orig_mag;
1895 chan->max_power = chan->orig_mpwr;
1896 chan->beacon_found = false;
1902 * Restoring regulatory settings involves ingoring any
1903 * possibly stale country IE information and user regulatory
1904 * settings if so desired, this includes any beacon hints
1905 * learned as we could have traveled outside to another country
1906 * after disconnection. To restore regulatory settings we do
1907 * exactly what we did at bootup:
1909 * - send a core regulatory hint
1910 * - send a user regulatory hint if applicable
1912 * Device drivers that send a regulatory hint for a specific country
1913 * keep their own regulatory domain on wiphy->regd so that does does
1914 * not need to be remembered.
1916 static void restore_regulatory_settings(bool reset_user)
1919 char world_alpha2[2];
1920 struct reg_beacon *reg_beacon, *btmp;
1921 struct regulatory_request *reg_request, *tmp;
1922 LIST_HEAD(tmp_reg_req_list);
1923 struct cfg80211_registered_device *rdev;
1925 mutex_lock(&cfg80211_mutex);
1926 mutex_lock(®_mutex);
1928 reset_regdomains(true);
1929 restore_alpha2(alpha2, reset_user);
1932 * If there's any pending requests we simply
1933 * stash them to a temporary pending queue and
1934 * add then after we've restored regulatory
1937 spin_lock(®_requests_lock);
1938 list_for_each_entry_safe(reg_request, tmp, ®_requests_list, list) {
1939 if (reg_request->initiator != NL80211_REGDOM_SET_BY_USER)
1941 list_move_tail(®_request->list, &tmp_reg_req_list);
1943 spin_unlock(®_requests_lock);
1945 /* Clear beacon hints */
1946 spin_lock_bh(®_pending_beacons_lock);
1947 list_for_each_entry_safe(reg_beacon, btmp, ®_pending_beacons, list) {
1948 list_del(®_beacon->list);
1951 spin_unlock_bh(®_pending_beacons_lock);
1953 list_for_each_entry_safe(reg_beacon, btmp, ®_beacon_list, list) {
1954 list_del(®_beacon->list);
1958 /* First restore to the basic regulatory settings */
1959 cfg80211_regdomain = cfg80211_world_regdom;
1960 world_alpha2[0] = cfg80211_regdomain->alpha2[0];
1961 world_alpha2[1] = cfg80211_regdomain->alpha2[1];
1963 list_for_each_entry(rdev, &cfg80211_rdev_list, list) {
1964 if (rdev->wiphy.flags & WIPHY_FLAG_CUSTOM_REGULATORY)
1965 restore_custom_reg_settings(&rdev->wiphy);
1968 mutex_unlock(®_mutex);
1969 mutex_unlock(&cfg80211_mutex);
1971 regulatory_hint_core(world_alpha2);
1974 * This restores the ieee80211_regdom module parameter
1975 * preference or the last user requested regulatory
1976 * settings, user regulatory settings takes precedence.
1978 if (is_an_alpha2(alpha2))
1979 regulatory_hint_user(user_alpha2, NL80211_USER_REG_HINT_USER);
1981 if (list_empty(&tmp_reg_req_list))
1984 mutex_lock(&cfg80211_mutex);
1985 mutex_lock(®_mutex);
1987 spin_lock(®_requests_lock);
1988 list_for_each_entry_safe(reg_request, tmp, &tmp_reg_req_list, list) {
1989 REG_DBG_PRINT("Adding request for country %c%c back "
1991 reg_request->alpha2[0],
1992 reg_request->alpha2[1]);
1993 list_move_tail(®_request->list, ®_requests_list);
1995 spin_unlock(®_requests_lock);
1997 mutex_unlock(®_mutex);
1998 mutex_unlock(&cfg80211_mutex);
2000 REG_DBG_PRINT("Kicking the queue\n");
2002 schedule_work(®_work);
2005 void regulatory_hint_disconnect(void)
2007 REG_DBG_PRINT("All devices are disconnected, going to "
2008 "restore regulatory settings\n");
2009 restore_regulatory_settings(false);
2012 static bool freq_is_chan_12_13_14(u16 freq)
2014 if (freq == ieee80211_channel_to_frequency(12, IEEE80211_BAND_2GHZ) ||
2015 freq == ieee80211_channel_to_frequency(13, IEEE80211_BAND_2GHZ) ||
2016 freq == ieee80211_channel_to_frequency(14, IEEE80211_BAND_2GHZ))
2021 int regulatory_hint_found_beacon(struct wiphy *wiphy,
2022 struct ieee80211_channel *beacon_chan,
2025 struct reg_beacon *reg_beacon;
2027 if (likely((beacon_chan->beacon_found ||
2028 (beacon_chan->flags & IEEE80211_CHAN_RADAR) ||
2029 (beacon_chan->band == IEEE80211_BAND_2GHZ &&
2030 !freq_is_chan_12_13_14(beacon_chan->center_freq)))))
2033 reg_beacon = kzalloc(sizeof(struct reg_beacon), gfp);
2037 REG_DBG_PRINT("Found new beacon on "
2038 "frequency: %d MHz (Ch %d) on %s\n",
2039 beacon_chan->center_freq,
2040 ieee80211_frequency_to_channel(beacon_chan->center_freq),
2043 memcpy(®_beacon->chan, beacon_chan,
2044 sizeof(struct ieee80211_channel));
2048 * Since we can be called from BH or and non-BH context
2049 * we must use spin_lock_bh()
2051 spin_lock_bh(®_pending_beacons_lock);
2052 list_add_tail(®_beacon->list, ®_pending_beacons);
2053 spin_unlock_bh(®_pending_beacons_lock);
2055 schedule_work(®_work);
2060 static void print_rd_rules(const struct ieee80211_regdomain *rd)
2063 const struct ieee80211_reg_rule *reg_rule = NULL;
2064 const struct ieee80211_freq_range *freq_range = NULL;
2065 const struct ieee80211_power_rule *power_rule = NULL;
2067 pr_info(" (start_freq - end_freq @ bandwidth), (max_antenna_gain, max_eirp)\n");
2069 for (i = 0; i < rd->n_reg_rules; i++) {
2070 reg_rule = &rd->reg_rules[i];
2071 freq_range = ®_rule->freq_range;
2072 power_rule = ®_rule->power_rule;
2075 * There may not be documentation for max antenna gain
2076 * in certain regions
2078 if (power_rule->max_antenna_gain)
2079 pr_info(" (%d KHz - %d KHz @ %d KHz), (%d mBi, %d mBm)\n",
2080 freq_range->start_freq_khz,
2081 freq_range->end_freq_khz,
2082 freq_range->max_bandwidth_khz,
2083 power_rule->max_antenna_gain,
2084 power_rule->max_eirp);
2086 pr_info(" (%d KHz - %d KHz @ %d KHz), (N/A, %d mBm)\n",
2087 freq_range->start_freq_khz,
2088 freq_range->end_freq_khz,
2089 freq_range->max_bandwidth_khz,
2090 power_rule->max_eirp);
2094 bool reg_supported_dfs_region(u8 dfs_region)
2096 switch (dfs_region) {
2097 case NL80211_DFS_UNSET:
2098 case NL80211_DFS_FCC:
2099 case NL80211_DFS_ETSI:
2100 case NL80211_DFS_JP:
2103 REG_DBG_PRINT("Ignoring uknown DFS master region: %d\n",
2109 static void print_dfs_region(u8 dfs_region)
2114 switch (dfs_region) {
2115 case NL80211_DFS_FCC:
2116 pr_info(" DFS Master region FCC");
2118 case NL80211_DFS_ETSI:
2119 pr_info(" DFS Master region ETSI");
2121 case NL80211_DFS_JP:
2122 pr_info(" DFS Master region JP");
2125 pr_info(" DFS Master region Uknown");
2130 static void print_regdomain(const struct ieee80211_regdomain *rd)
2133 if (is_intersected_alpha2(rd->alpha2)) {
2135 if (last_request->initiator ==
2136 NL80211_REGDOM_SET_BY_COUNTRY_IE) {
2137 struct cfg80211_registered_device *rdev;
2138 rdev = cfg80211_rdev_by_wiphy_idx(
2139 last_request->wiphy_idx);
2141 pr_info("Current regulatory domain updated by AP to: %c%c\n",
2142 rdev->country_ie_alpha2[0],
2143 rdev->country_ie_alpha2[1]);
2145 pr_info("Current regulatory domain intersected:\n");
2147 pr_info("Current regulatory domain intersected:\n");
2148 } else if (is_world_regdom(rd->alpha2))
2149 pr_info("World regulatory domain updated:\n");
2151 if (is_unknown_alpha2(rd->alpha2))
2152 pr_info("Regulatory domain changed to driver built-in settings (unknown country)\n");
2154 if (reg_request_cell_base(last_request))
2155 pr_info("Regulatory domain changed "
2156 "to country: %c%c by Cell Station\n",
2157 rd->alpha2[0], rd->alpha2[1]);
2159 pr_info("Regulatory domain changed "
2160 "to country: %c%c\n",
2161 rd->alpha2[0], rd->alpha2[1]);
2164 print_dfs_region(rd->dfs_region);
2168 static void print_regdomain_info(const struct ieee80211_regdomain *rd)
2170 pr_info("Regulatory domain: %c%c\n", rd->alpha2[0], rd->alpha2[1]);
2174 /* Takes ownership of rd only if it doesn't fail */
2175 static int __set_regdom(const struct ieee80211_regdomain *rd)
2177 const struct ieee80211_regdomain *regd;
2178 const struct ieee80211_regdomain *intersected_rd = NULL;
2179 struct wiphy *request_wiphy;
2180 /* Some basic sanity checks first */
2182 if (is_world_regdom(rd->alpha2)) {
2183 if (WARN_ON(!reg_is_valid_request(rd->alpha2)))
2185 update_world_regdomain(rd);
2189 if (!is_alpha2_set(rd->alpha2) && !is_an_alpha2(rd->alpha2) &&
2190 !is_unknown_alpha2(rd->alpha2))
2197 * Lets only bother proceeding on the same alpha2 if the current
2198 * rd is non static (it means CRDA was present and was used last)
2199 * and the pending request came in from a country IE
2201 if (last_request->initiator != NL80211_REGDOM_SET_BY_COUNTRY_IE) {
2203 * If someone else asked us to change the rd lets only bother
2204 * checking if the alpha2 changes if CRDA was already called
2206 if (!regdom_changes(rd->alpha2))
2211 * Now lets set the regulatory domain, update all driver channels
2212 * and finally inform them of what we have done, in case they want
2213 * to review or adjust their own settings based on their own
2214 * internal EEPROM data
2217 if (WARN_ON(!reg_is_valid_request(rd->alpha2)))
2220 if (!is_valid_rd(rd)) {
2221 pr_err("Invalid regulatory domain detected:\n");
2222 print_regdomain_info(rd);
2226 request_wiphy = wiphy_idx_to_wiphy(last_request->wiphy_idx);
2227 if (!request_wiphy &&
2228 (last_request->initiator == NL80211_REGDOM_SET_BY_DRIVER ||
2229 last_request->initiator == NL80211_REGDOM_SET_BY_COUNTRY_IE)) {
2230 schedule_delayed_work(®_timeout, 0);
2234 if (!last_request->intersect) {
2235 if (last_request->initiator != NL80211_REGDOM_SET_BY_DRIVER) {
2236 reset_regdomains(false);
2237 cfg80211_regdomain = rd;
2242 * For a driver hint, lets copy the regulatory domain the
2243 * driver wanted to the wiphy to deal with conflicts
2247 * Userspace could have sent two replies with only
2248 * one kernel request.
2250 if (request_wiphy->regd)
2253 regd = reg_copy_regd(rd);
2255 return PTR_ERR(regd);
2257 request_wiphy->regd = regd;
2258 reset_regdomains(false);
2259 cfg80211_regdomain = rd;
2263 /* Intersection requires a bit more work */
2265 if (last_request->initiator != NL80211_REGDOM_SET_BY_COUNTRY_IE) {
2267 intersected_rd = regdom_intersect(rd, cfg80211_regdomain);
2268 if (!intersected_rd)
2272 * We can trash what CRDA provided now.
2273 * However if a driver requested this specific regulatory
2274 * domain we keep it for its private use
2276 if (last_request->initiator == NL80211_REGDOM_SET_BY_DRIVER)
2277 request_wiphy->regd = rd;
2283 reset_regdomains(false);
2284 cfg80211_regdomain = intersected_rd;
2294 * Use this call to set the current regulatory domain. Conflicts with
2295 * multiple drivers can be ironed out later. Caller must've already
2296 * kmalloc'd the rd structure. Caller must hold cfg80211_mutex
2298 int set_regdom(const struct ieee80211_regdomain *rd)
2302 assert_cfg80211_lock();
2304 mutex_lock(®_mutex);
2306 /* Note that this doesn't update the wiphys, this is done below */
2307 r = __set_regdom(rd);
2310 reg_set_request_processed();
2313 mutex_unlock(®_mutex);
2317 /* This would make this whole thing pointless */
2318 if (!last_request->intersect)
2319 BUG_ON(rd != cfg80211_regdomain);
2321 /* update all wiphys now with the new established regulatory domain */
2322 update_all_wiphy_regulatory(last_request->initiator);
2324 print_regdomain(cfg80211_regdomain);
2326 nl80211_send_reg_change_event(last_request);
2328 reg_set_request_processed();
2330 mutex_unlock(®_mutex);
2335 #ifdef CONFIG_HOTPLUG
2336 int reg_device_uevent(struct device *dev, struct kobj_uevent_env *env)
2338 if (last_request && !last_request->processed) {
2339 if (add_uevent_var(env, "COUNTRY=%c%c",
2340 last_request->alpha2[0],
2341 last_request->alpha2[1]))
2348 int reg_device_uevent(struct device *dev, struct kobj_uevent_env *env)
2352 #endif /* CONFIG_HOTPLUG */
2354 void wiphy_regulatory_register(struct wiphy *wiphy)
2356 assert_cfg80211_lock();
2358 mutex_lock(®_mutex);
2360 if (!reg_dev_ignore_cell_hint(wiphy))
2361 reg_num_devs_support_basehint++;
2363 wiphy_update_regulatory(wiphy, NL80211_REGDOM_SET_BY_CORE);
2365 mutex_unlock(®_mutex);
2368 /* Caller must hold cfg80211_mutex */
2369 void wiphy_regulatory_deregister(struct wiphy *wiphy)
2371 struct wiphy *request_wiphy = NULL;
2373 assert_cfg80211_lock();
2375 mutex_lock(®_mutex);
2377 if (!reg_dev_ignore_cell_hint(wiphy))
2378 reg_num_devs_support_basehint--;
2383 request_wiphy = wiphy_idx_to_wiphy(last_request->wiphy_idx);
2385 if (!request_wiphy || request_wiphy != wiphy)
2388 last_request->wiphy_idx = WIPHY_IDX_STALE;
2389 last_request->country_ie_env = ENVIRON_ANY;
2391 mutex_unlock(®_mutex);
2394 static void reg_timeout_work(struct work_struct *work)
2396 REG_DBG_PRINT("Timeout while waiting for CRDA to reply, "
2397 "restoring regulatory settings\n");
2398 restore_regulatory_settings(true);
2401 int __init regulatory_init(void)
2405 reg_pdev = platform_device_register_simple("regulatory", 0, NULL, 0);
2406 if (IS_ERR(reg_pdev))
2407 return PTR_ERR(reg_pdev);
2409 reg_pdev->dev.type = ®_device_type;
2411 spin_lock_init(®_requests_lock);
2412 spin_lock_init(®_pending_beacons_lock);
2414 reg_regdb_size_check();
2416 cfg80211_regdomain = cfg80211_world_regdom;
2418 user_alpha2[0] = '9';
2419 user_alpha2[1] = '7';
2421 /* We always try to get an update for the static regdomain */
2422 err = regulatory_hint_core(cfg80211_regdomain->alpha2);
2427 * N.B. kobject_uevent_env() can fail mainly for when we're out
2428 * memory which is handled and propagated appropriately above
2429 * but it can also fail during a netlink_broadcast() or during
2430 * early boot for call_usermodehelper(). For now treat these
2431 * errors as non-fatal.
2433 pr_err("kobject_uevent_env() was unable to call CRDA during init\n");
2434 #ifdef CONFIG_CFG80211_REG_DEBUG
2435 /* We want to find out exactly why when debugging */
2441 * Finally, if the user set the module parameter treat it
2444 if (!is_world_regdom(ieee80211_regdom))
2445 regulatory_hint_user(ieee80211_regdom,
2446 NL80211_USER_REG_HINT_USER);
2451 void /* __init_or_exit */ regulatory_exit(void)
2453 struct regulatory_request *reg_request, *tmp;
2454 struct reg_beacon *reg_beacon, *btmp;
2456 cancel_work_sync(®_work);
2457 cancel_delayed_work_sync(®_timeout);
2459 mutex_lock(&cfg80211_mutex);
2460 mutex_lock(®_mutex);
2462 reset_regdomains(true);
2464 dev_set_uevent_suppress(®_pdev->dev, true);
2466 platform_device_unregister(reg_pdev);
2468 spin_lock_bh(®_pending_beacons_lock);
2469 list_for_each_entry_safe(reg_beacon, btmp, ®_pending_beacons, list) {
2470 list_del(®_beacon->list);
2473 spin_unlock_bh(®_pending_beacons_lock);
2475 list_for_each_entry_safe(reg_beacon, btmp, ®_beacon_list, list) {
2476 list_del(®_beacon->list);
2480 spin_lock(®_requests_lock);
2481 list_for_each_entry_safe(reg_request, tmp, ®_requests_list, list) {
2482 list_del(®_request->list);
2485 spin_unlock(®_requests_lock);
2487 mutex_unlock(®_mutex);
2488 mutex_unlock(&cfg80211_mutex);