blob: b776d72d84be8f03fde9650c4b90d1b17940d543 [file] [log] [blame]
Johannes Bergd3236552009-04-20 14:31:42 +02001#ifndef __NET_REGULATORY_H
2#define __NET_REGULATORY_H
3/*
4 * regulatory support structures
5 *
Luis R. Rodriguezdde88b72011-08-23 15:03:34 -07006 * Copyright 2008-2009 Luis R. Rodriguez <mcgrof@qca.qualcomm.com>
Johannes Bergd3236552009-04-20 14:31:42 +02007 *
Luis R. Rodriguezdde88b72011-08-23 15:03:34 -07008 * Permission to use, copy, modify, and/or distribute this software for any
9 * purpose with or without fee is hereby granted, provided that the above
10 * copyright notice and this permission notice appear in all copies.
11 *
12 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Johannes Bergd3236552009-04-20 14:31:42 +020019 */
20
Johannes Berg458f4f92012-12-06 15:47:38 +010021#include <linux/rcupdate.h>
Johannes Bergd3236552009-04-20 14:31:42 +020022
23/**
24 * enum environment_cap - Environment parsed from country IE
25 * @ENVIRON_ANY: indicates country IE applies to both indoor and
26 * outdoor operation.
27 * @ENVIRON_INDOOR: indicates country IE applies only to indoor operation
28 * @ENVIRON_OUTDOOR: indicates country IE applies only to outdoor operation
29 */
30enum environment_cap {
31 ENVIRON_ANY,
32 ENVIRON_INDOOR,
33 ENVIRON_OUTDOOR,
34};
35
36/**
37 * struct regulatory_request - used to keep track of regulatory requests
38 *
Johannes Bergc492db32012-12-06 16:29:25 +010039 * @rcu_head: RCU head struct used to free the request
Johannes Bergd3236552009-04-20 14:31:42 +020040 * @wiphy_idx: this is set if this request's initiator is
Luis R. Rodrigueza2f73b62013-11-11 22:15:29 +010041 * %REGDOM_SET_BY_COUNTRY_IE or %REGDOM_SET_BY_DRIVER. This
42 * can be used by the wireless core to deal with conflicts
43 * and potentially inform users of which devices specifically
44 * cased the conflicts.
Johannes Bergd3236552009-04-20 14:31:42 +020045 * @initiator: indicates who sent this request, could be any of
Luis R. Rodrigueza2f73b62013-11-11 22:15:29 +010046 * of those set in nl80211_reg_initiator (%NL80211_REGDOM_SET_BY_*)
Johannes Bergd3236552009-04-20 14:31:42 +020047 * @alpha2: the ISO / IEC 3166 alpha2 country code of the requested
Luis R. Rodrigueza2f73b62013-11-11 22:15:29 +010048 * regulatory domain. We have a few special codes:
49 * 00 - World regulatory domain
50 * 99 - built by driver but a specific alpha2 cannot be determined
51 * 98 - result of an intersection between two regulatory domains
Luis R. Rodriguez09d989d2010-01-29 19:58:57 -050052 * 97 - regulatory domain has not yet been configured
Luis R. Rodriguezb68e6b32011-10-11 10:59:03 -070053 * @dfs_region: If CRDA responded with a regulatory domain that requires
54 * DFS master operation on a known DFS region (NL80211_DFS_*),
55 * dfs_region represents that region. Drivers can use this and the
56 * @alpha2 to adjust their device's DFS parameters as required.
Luis R. Rodriguez57b5ce02012-07-12 11:49:18 -070057 * @user_reg_hint_type: if the @initiator was of type
58 * %NL80211_REGDOM_SET_BY_USER, this classifies the type
59 * of hint passed. This could be any of the %NL80211_USER_REG_HINT_*
60 * types.
Johannes Bergd3236552009-04-20 14:31:42 +020061 * @intersect: indicates whether the wireless core should intersect
Luis R. Rodrigueza2f73b62013-11-11 22:15:29 +010062 * the requested regulatory domain with the presently set regulatory
63 * domain.
Luis R. Rodriguezb2e253c2010-11-17 21:46:09 -080064 * @processed: indicates whether or not this requests has already been
65 * processed. When the last request is processed it means that the
66 * currently regulatory domain set on cfg80211 is updated from
67 * CRDA and can be used by other regulatory requests. When a
68 * the last request is not yet processed we must yield until it
69 * is processed before processing any new requests.
Johannes Bergd3236552009-04-20 14:31:42 +020070 * @country_ie_checksum: checksum of the last processed and accepted
Luis R. Rodrigueza2f73b62013-11-11 22:15:29 +010071 * country IE
Johannes Bergd3236552009-04-20 14:31:42 +020072 * @country_ie_env: lets us know if the AP is telling us we are outdoor,
Luis R. Rodrigueza2f73b62013-11-11 22:15:29 +010073 * indoor, or if it doesn't matter
Johannes Bergd3236552009-04-20 14:31:42 +020074 * @list: used to insert into the reg_requests_list linked list
75 */
76struct regulatory_request {
Johannes Bergc492db32012-12-06 16:29:25 +010077 struct rcu_head rcu_head;
Johannes Bergd3236552009-04-20 14:31:42 +020078 int wiphy_idx;
79 enum nl80211_reg_initiator initiator;
Luis R. Rodriguez57b5ce02012-07-12 11:49:18 -070080 enum nl80211_user_reg_hint_type user_reg_hint_type;
Johannes Bergd3236552009-04-20 14:31:42 +020081 char alpha2[2];
Luis R. Rodriguez4c7d3982013-11-13 18:54:02 +010082 enum nl80211_dfs_regions dfs_region;
Johannes Bergd3236552009-04-20 14:31:42 +020083 bool intersect;
Luis R. Rodriguezb2e253c2010-11-17 21:46:09 -080084 bool processed;
Johannes Bergd3236552009-04-20 14:31:42 +020085 enum environment_cap country_ie_env;
86 struct list_head list;
87};
88
Luis R. Rodrigueza2f73b62013-11-11 22:15:29 +010089/**
90 * enum ieee80211_regulatory_flags - device regulatory flags
91 *
92 * @REGULATORY_CUSTOM_REG: tells us the driver for this device
93 * has its own custom regulatory domain and cannot identify the
94 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
95 * we will disregard the first regulatory hint (when the
96 * initiator is %REGDOM_SET_BY_CORE). Drivers that use
97 * wiphy_apply_custom_regulatory() should have this flag set
98 * or the regulatory core will set it for the wiphy.
Luis R. Rodriguez4f7b9142013-12-14 20:09:06 +010099 * If you use regulatory_hint() *after* using
100 * wiphy_apply_custom_regulatory() the wireless core will
101 * clear the REGULATORY_CUSTOM_REG for your wiphy as it would be
102 * implied that the device somehow gained knowledge of its region.
Luis R. Rodrigueza09a85a2013-11-11 22:15:30 +0100103 * @REGULATORY_STRICT_REG: tells us that the wiphy for this device
104 * has regulatory domain that it wishes to be considered as the
105 * superset for regulatory rules. After this device gets its regulatory
106 * domain programmed further regulatory hints shall only be considered
107 * for this device to enhance regulatory compliance, forcing the
108 * device to only possibly use subsets of the original regulatory
109 * rules. For example if channel 13 and 14 are disabled by this
110 * device's regulatory domain no user specified regulatory hint which
111 * has these channels enabled would enable them for this wiphy,
112 * the device's original regulatory domain will be trusted as the
113 * base. You can program the superset of regulatory rules for this
114 * wiphy with regulatory_hint() for cards programmed with an
115 * ISO3166-alpha2 country code. wiphys that use regulatory_hint()
116 * will have their wiphy->regd programmed once the regulatory
117 * domain is set, and all other regulatory hints will be ignored
118 * until their own regulatory domain gets programmed.
Luis R. Rodrigueza2f73b62013-11-11 22:15:29 +0100119 * @REGULATORY_DISABLE_BEACON_HINTS: enable this if your driver needs to
120 * ensure that passive scan flags and beaconing flags may not be lifted by
121 * cfg80211 due to regulatory beacon hints. For more information on beacon
122 * hints read the documenation for regulatory_hint_found_beacon()
Luis R. Rodrigueza09a85a2013-11-11 22:15:30 +0100123 * @REGULATORY_COUNTRY_IE_FOLLOW_POWER: for devices that have a preference
124 * that even though they may have programmed their own custom power
125 * setting prior to wiphy registration, they want to ensure their channel
126 * power settings are updated for this connection with the power settings
127 * derived from the regulatory domain. The regulatory domain used will be
128 * based on the ISO3166-alpha2 from country IE provided through
129 * regulatory_hint_country_ie()
Luis R. Rodriguez2a901462013-11-11 22:15:31 +0100130 * @REGULATORY_COUNTRY_IE_IGNORE: for devices that have a preference to ignore
131 * all country IE information processed by the regulatory core. This will
132 * override %REGULATORY_COUNTRY_IE_FOLLOW_POWER as all country IEs will
133 * be ignored.
Ilan Peer174e0cd2014-02-23 09:13:01 +0200134 * @REGULATORY_ENABLE_RELAX_NO_IR: for devices that wish to allow the
135 * NO_IR relaxation, which enables transmissions on channels on which
136 * otherwise initiating radiation is not allowed. This will enable the
137 * relaxations enabled under the CFG80211_REG_RELAX_NO_IR configuration
138 * option
Arik Nemtsovad932f02014-11-27 09:44:55 +0200139 * @REGULATORY_IGNORE_STALE_KICKOFF: the regulatory core will _not_ make sure
140 * all interfaces on this wiphy reside on allowed channels. If this flag
141 * is not set, upon a regdomain change, the interfaces are given a grace
142 * period (currently 60 seconds) to disconnect or move to an allowed
143 * channel. Interfaces on forbidden channels are forcibly disconnected.
144 * Currently these types of interfaces are supported for enforcement:
145 * NL80211_IFTYPE_ADHOC, NL80211_IFTYPE_STATION, NL80211_IFTYPE_AP,
146 * NL80211_IFTYPE_AP_VLAN, NL80211_IFTYPE_MONITOR,
147 * NL80211_IFTYPE_P2P_CLIENT, NL80211_IFTYPE_P2P_GO,
148 * NL80211_IFTYPE_P2P_DEVICE. The flag will be set by default if a device
149 * includes any modes unsupported for enforcement checking.
Luis R. Rodrigueza2f73b62013-11-11 22:15:29 +0100150 */
151enum ieee80211_regulatory_flags {
152 REGULATORY_CUSTOM_REG = BIT(0),
153 REGULATORY_STRICT_REG = BIT(1),
154 REGULATORY_DISABLE_BEACON_HINTS = BIT(2),
Luis R. Rodrigueza09a85a2013-11-11 22:15:30 +0100155 REGULATORY_COUNTRY_IE_FOLLOW_POWER = BIT(3),
Luis R. Rodriguez2a901462013-11-11 22:15:31 +0100156 REGULATORY_COUNTRY_IE_IGNORE = BIT(4),
Ilan Peer174e0cd2014-02-23 09:13:01 +0200157 REGULATORY_ENABLE_RELAX_NO_IR = BIT(5),
Arik Nemtsovad932f02014-11-27 09:44:55 +0200158 REGULATORY_IGNORE_STALE_KICKOFF = BIT(6),
Luis R. Rodrigueza2f73b62013-11-11 22:15:29 +0100159};
160
Johannes Bergd3236552009-04-20 14:31:42 +0200161struct ieee80211_freq_range {
162 u32 start_freq_khz;
163 u32 end_freq_khz;
164 u32 max_bandwidth_khz;
165};
166
167struct ieee80211_power_rule {
168 u32 max_antenna_gain;
169 u32 max_eirp;
170};
171
172struct ieee80211_reg_rule {
173 struct ieee80211_freq_range freq_range;
174 struct ieee80211_power_rule power_rule;
175 u32 flags;
Janusz Dziedzic089027e2014-02-21 19:46:12 +0100176 u32 dfs_cac_ms;
Johannes Bergd3236552009-04-20 14:31:42 +0200177};
178
179struct ieee80211_regdomain {
Johannes Berg458f4f92012-12-06 15:47:38 +0100180 struct rcu_head rcu_head;
Johannes Bergd3236552009-04-20 14:31:42 +0200181 u32 n_reg_rules;
Eliad Pellera5fe8e72014-06-11 10:23:35 +0300182 char alpha2[3];
Luis R. Rodriguez4c7d3982013-11-13 18:54:02 +0100183 enum nl80211_dfs_regions dfs_region;
Johannes Bergd3236552009-04-20 14:31:42 +0200184 struct ieee80211_reg_rule reg_rules[];
185};
186
187#define MHZ_TO_KHZ(freq) ((freq) * 1000)
188#define KHZ_TO_MHZ(freq) ((freq) / 1000)
189#define DBI_TO_MBI(gain) ((gain) * 100)
190#define MBI_TO_DBI(gain) ((gain) / 100)
191#define DBM_TO_MBM(gain) ((gain) * 100)
192#define MBM_TO_DBM(gain) ((gain) / 100)
193
Janusz Dziedzic089027e2014-02-21 19:46:12 +0100194#define REG_RULE_EXT(start, end, bw, gain, eirp, dfs_cac, reg_flags) \
195{ \
196 .freq_range.start_freq_khz = MHZ_TO_KHZ(start), \
197 .freq_range.end_freq_khz = MHZ_TO_KHZ(end), \
198 .freq_range.max_bandwidth_khz = MHZ_TO_KHZ(bw), \
199 .power_rule.max_antenna_gain = DBI_TO_MBI(gain), \
200 .power_rule.max_eirp = DBM_TO_MBM(eirp), \
201 .flags = reg_flags, \
202 .dfs_cac_ms = dfs_cac, \
Johannes Bergd3236552009-04-20 14:31:42 +0200203}
204
Janusz Dziedzic089027e2014-02-21 19:46:12 +0100205#define REG_RULE(start, end, bw, gain, eirp, reg_flags) \
206 REG_RULE_EXT(start, end, bw, gain, eirp, 0, reg_flags)
207
Johannes Bergd3236552009-04-20 14:31:42 +0200208#endif