Commit | Line | Data |
---|---|---|
949d6b40 | 1 | |
d3236553 JB |
2 | #ifndef __NET_REGULATORY_H |
3 | #define __NET_REGULATORY_H | |
4 | /* | |
5 | * regulatory support structures | |
6 | * | |
dde88b73 | 7 | * Copyright 2008-2009 Luis R. Rodriguez <mcgrof@qca.qualcomm.com> |
230ebaa1 | 8 | * Copyright (C) 2018 Intel Corporation |
d3236553 | 9 | * |
dde88b73 LR |
10 | * Permission to use, copy, modify, and/or distribute this software for any |
11 | * purpose with or without fee is hereby granted, provided that the above | |
12 | * copyright notice and this permission notice appear in all copies. | |
13 | * | |
14 | * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | |
15 | * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
16 | * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | |
17 | * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
18 | * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
19 | * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | |
20 | * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
d3236553 JB |
21 | */ |
22 | ||
949d6b40 JK |
23 | #include <linux/ieee80211.h> |
24 | #include <linux/nl80211.h> | |
458f4f9e | 25 | #include <linux/rcupdate.h> |
d3236553 JB |
26 | |
27 | /** | |
28 | * enum environment_cap - Environment parsed from country IE | |
29 | * @ENVIRON_ANY: indicates country IE applies to both indoor and | |
30 | * outdoor operation. | |
31 | * @ENVIRON_INDOOR: indicates country IE applies only to indoor operation | |
32 | * @ENVIRON_OUTDOOR: indicates country IE applies only to outdoor operation | |
33 | */ | |
34 | enum environment_cap { | |
35 | ENVIRON_ANY, | |
36 | ENVIRON_INDOOR, | |
37 | ENVIRON_OUTDOOR, | |
38 | }; | |
39 | ||
40 | /** | |
41 | * struct regulatory_request - used to keep track of regulatory requests | |
42 | * | |
c492db37 | 43 | * @rcu_head: RCU head struct used to free the request |
d3236553 | 44 | * @wiphy_idx: this is set if this request's initiator is |
a2f73b6c LR |
45 | * %REGDOM_SET_BY_COUNTRY_IE or %REGDOM_SET_BY_DRIVER. This |
46 | * can be used by the wireless core to deal with conflicts | |
47 | * and potentially inform users of which devices specifically | |
48 | * cased the conflicts. | |
d3236553 | 49 | * @initiator: indicates who sent this request, could be any of |
dec4ca93 | 50 | * those set in nl80211_reg_initiator (%NL80211_REGDOM_SET_BY_*) |
d3236553 | 51 | * @alpha2: the ISO / IEC 3166 alpha2 country code of the requested |
a2f73b6c LR |
52 | * regulatory domain. We have a few special codes: |
53 | * 00 - World regulatory domain | |
54 | * 99 - built by driver but a specific alpha2 cannot be determined | |
55 | * 98 - result of an intersection between two regulatory domains | |
09d989d1 | 56 | * 97 - regulatory domain has not yet been configured |
b68e6b3b LR |
57 | * @dfs_region: If CRDA responded with a regulatory domain that requires |
58 | * DFS master operation on a known DFS region (NL80211_DFS_*), | |
59 | * dfs_region represents that region. Drivers can use this and the | |
60 | * @alpha2 to adjust their device's DFS parameters as required. | |
57b5ce07 LR |
61 | * @user_reg_hint_type: if the @initiator was of type |
62 | * %NL80211_REGDOM_SET_BY_USER, this classifies the type | |
63 | * of hint passed. This could be any of the %NL80211_USER_REG_HINT_* | |
64 | * types. | |
d3236553 | 65 | * @intersect: indicates whether the wireless core should intersect |
a2f73b6c LR |
66 | * the requested regulatory domain with the presently set regulatory |
67 | * domain. | |
b2e253cf LR |
68 | * @processed: indicates whether or not this requests has already been |
69 | * processed. When the last request is processed it means that the | |
70 | * currently regulatory domain set on cfg80211 is updated from | |
71 | * CRDA and can be used by other regulatory requests. When a | |
72 | * the last request is not yet processed we must yield until it | |
73 | * is processed before processing any new requests. | |
d3236553 | 74 | * @country_ie_checksum: checksum of the last processed and accepted |
a2f73b6c | 75 | * country IE |
d3236553 | 76 | * @country_ie_env: lets us know if the AP is telling us we are outdoor, |
a2f73b6c | 77 | * indoor, or if it doesn't matter |
d3236553 JB |
78 | * @list: used to insert into the reg_requests_list linked list |
79 | */ | |
80 | struct regulatory_request { | |
c492db37 | 81 | struct rcu_head rcu_head; |
d3236553 JB |
82 | int wiphy_idx; |
83 | enum nl80211_reg_initiator initiator; | |
57b5ce07 | 84 | enum nl80211_user_reg_hint_type user_reg_hint_type; |
657308f7 | 85 | char alpha2[3]; |
4c7d3982 | 86 | enum nl80211_dfs_regions dfs_region; |
d3236553 | 87 | bool intersect; |
b2e253cf | 88 | bool processed; |
d3236553 JB |
89 | enum environment_cap country_ie_env; |
90 | struct list_head list; | |
91 | }; | |
92 | ||
a2f73b6c LR |
93 | /** |
94 | * enum ieee80211_regulatory_flags - device regulatory flags | |
95 | * | |
96 | * @REGULATORY_CUSTOM_REG: tells us the driver for this device | |
97 | * has its own custom regulatory domain and cannot identify the | |
98 | * ISO / IEC 3166 alpha2 it belongs to. When this is enabled | |
99 | * we will disregard the first regulatory hint (when the | |
100 | * initiator is %REGDOM_SET_BY_CORE). Drivers that use | |
101 | * wiphy_apply_custom_regulatory() should have this flag set | |
102 | * or the regulatory core will set it for the wiphy. | |
4f7b9140 LR |
103 | * If you use regulatory_hint() *after* using |
104 | * wiphy_apply_custom_regulatory() the wireless core will | |
105 | * clear the REGULATORY_CUSTOM_REG for your wiphy as it would be | |
106 | * implied that the device somehow gained knowledge of its region. | |
a09a85a0 LR |
107 | * @REGULATORY_STRICT_REG: tells us that the wiphy for this device |
108 | * has regulatory domain that it wishes to be considered as the | |
109 | * superset for regulatory rules. After this device gets its regulatory | |
110 | * domain programmed further regulatory hints shall only be considered | |
111 | * for this device to enhance regulatory compliance, forcing the | |
112 | * device to only possibly use subsets of the original regulatory | |
113 | * rules. For example if channel 13 and 14 are disabled by this | |
114 | * device's regulatory domain no user specified regulatory hint which | |
115 | * has these channels enabled would enable them for this wiphy, | |
116 | * the device's original regulatory domain will be trusted as the | |
117 | * base. You can program the superset of regulatory rules for this | |
118 | * wiphy with regulatory_hint() for cards programmed with an | |
119 | * ISO3166-alpha2 country code. wiphys that use regulatory_hint() | |
120 | * will have their wiphy->regd programmed once the regulatory | |
121 | * domain is set, and all other regulatory hints will be ignored | |
122 | * until their own regulatory domain gets programmed. | |
a2f73b6c LR |
123 | * @REGULATORY_DISABLE_BEACON_HINTS: enable this if your driver needs to |
124 | * ensure that passive scan flags and beaconing flags may not be lifted by | |
125 | * cfg80211 due to regulatory beacon hints. For more information on beacon | |
126 | * hints read the documenation for regulatory_hint_found_beacon() | |
a09a85a0 LR |
127 | * @REGULATORY_COUNTRY_IE_FOLLOW_POWER: for devices that have a preference |
128 | * that even though they may have programmed their own custom power | |
129 | * setting prior to wiphy registration, they want to ensure their channel | |
130 | * power settings are updated for this connection with the power settings | |
131 | * derived from the regulatory domain. The regulatory domain used will be | |
132 | * based on the ISO3166-alpha2 from country IE provided through | |
133 | * regulatory_hint_country_ie() | |
2a901468 LR |
134 | * @REGULATORY_COUNTRY_IE_IGNORE: for devices that have a preference to ignore |
135 | * all country IE information processed by the regulatory core. This will | |
136 | * override %REGULATORY_COUNTRY_IE_FOLLOW_POWER as all country IEs will | |
137 | * be ignored. | |
174e0cd2 IP |
138 | * @REGULATORY_ENABLE_RELAX_NO_IR: for devices that wish to allow the |
139 | * NO_IR relaxation, which enables transmissions on channels on which | |
140 | * otherwise initiating radiation is not allowed. This will enable the | |
141 | * relaxations enabled under the CFG80211_REG_RELAX_NO_IR configuration | |
142 | * option | |
b0d7aa59 JD |
143 | * @REGULATORY_WIPHY_SELF_MANAGED: for devices that employ wiphy-specific |
144 | * regdom management. These devices will ignore all regdom changes not | |
145 | * originating from their own wiphy. | |
146 | * A self-managed wiphys only employs regulatory information obtained from | |
147 | * the FW and driver and does not use other cfg80211 sources like | |
148 | * beacon-hints, country-code IEs and hints from other devices on the same | |
149 | * system. Conversely, a self-managed wiphy does not share its regulatory | |
150 | * hints with other devices in the system. If a system contains several | |
151 | * devices, one or more of which are self-managed, there might be | |
152 | * contradictory regulatory settings between them. Usage of flag is | |
153 | * generally discouraged. Only use it if the FW/driver is incompatible | |
154 | * with non-locally originated hints. | |
155 | * This flag is incompatible with the flags: %REGULATORY_CUSTOM_REG, | |
156 | * %REGULATORY_STRICT_REG, %REGULATORY_COUNTRY_IE_FOLLOW_POWER, | |
157 | * %REGULATORY_COUNTRY_IE_IGNORE and %REGULATORY_DISABLE_BEACON_HINTS. | |
158 | * Mixing any of the above flags with this flag will result in a failure | |
159 | * to register the wiphy. This flag implies | |
160 | * %REGULATORY_DISABLE_BEACON_HINTS and %REGULATORY_COUNTRY_IE_IGNORE. | |
a2f73b6c LR |
161 | */ |
162 | enum ieee80211_regulatory_flags { | |
163 | REGULATORY_CUSTOM_REG = BIT(0), | |
164 | REGULATORY_STRICT_REG = BIT(1), | |
165 | REGULATORY_DISABLE_BEACON_HINTS = BIT(2), | |
a09a85a0 | 166 | REGULATORY_COUNTRY_IE_FOLLOW_POWER = BIT(3), |
2a901468 | 167 | REGULATORY_COUNTRY_IE_IGNORE = BIT(4), |
174e0cd2 | 168 | REGULATORY_ENABLE_RELAX_NO_IR = BIT(5), |
e8c2af66 | 169 | /* reuse bit 6 next time */ |
b0d7aa59 | 170 | REGULATORY_WIPHY_SELF_MANAGED = BIT(7), |
a2f73b6c LR |
171 | }; |
172 | ||
d3236553 JB |
173 | struct ieee80211_freq_range { |
174 | u32 start_freq_khz; | |
175 | u32 end_freq_khz; | |
176 | u32 max_bandwidth_khz; | |
177 | }; | |
178 | ||
179 | struct ieee80211_power_rule { | |
180 | u32 max_antenna_gain; | |
181 | u32 max_eirp; | |
182 | }; | |
183 | ||
230ebaa1 HD |
184 | /** |
185 | * struct ieee80211_wmm_ac - used to store per ac wmm regulatory limitation | |
186 | * | |
187 | * The information provided in this structure is required for QoS | |
188 | * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29. | |
189 | * | |
190 | * @cw_min: minimum contention window [a value of the form | |
191 | * 2^n-1 in the range 1..32767] | |
192 | * @cw_max: maximum contention window [like @cw_min] | |
193 | * @cot: maximum burst time in units of 32 usecs, 0 meaning disabled | |
194 | * @aifsn: arbitration interframe space [0..255] | |
195 | * | |
196 | */ | |
197 | struct ieee80211_wmm_ac { | |
198 | u16 cw_min; | |
199 | u16 cw_max; | |
200 | u16 cot; | |
201 | u8 aifsn; | |
202 | }; | |
203 | ||
204 | struct ieee80211_wmm_rule { | |
205 | struct ieee80211_wmm_ac client[IEEE80211_NUM_ACS]; | |
206 | struct ieee80211_wmm_ac ap[IEEE80211_NUM_ACS]; | |
207 | }; | |
208 | ||
d3236553 JB |
209 | struct ieee80211_reg_rule { |
210 | struct ieee80211_freq_range freq_range; | |
211 | struct ieee80211_power_rule power_rule; | |
38cb87ee | 212 | struct ieee80211_wmm_rule wmm_rule; |
d3236553 | 213 | u32 flags; |
089027e5 | 214 | u32 dfs_cac_ms; |
38cb87ee | 215 | bool has_wmm; |
ddd7f45c | 216 | s8 psd; |
d3236553 JB |
217 | }; |
218 | ||
219 | struct ieee80211_regdomain { | |
458f4f9e | 220 | struct rcu_head rcu_head; |
d3236553 | 221 | u32 n_reg_rules; |
a5fe8e76 | 222 | char alpha2[3]; |
4c7d3982 | 223 | enum nl80211_dfs_regions dfs_region; |
d3236553 JB |
224 | struct ieee80211_reg_rule reg_rules[]; |
225 | }; | |
226 | ||
089027e5 JD |
227 | #define REG_RULE_EXT(start, end, bw, gain, eirp, dfs_cac, reg_flags) \ |
228 | { \ | |
229 | .freq_range.start_freq_khz = MHZ_TO_KHZ(start), \ | |
230 | .freq_range.end_freq_khz = MHZ_TO_KHZ(end), \ | |
231 | .freq_range.max_bandwidth_khz = MHZ_TO_KHZ(bw), \ | |
232 | .power_rule.max_antenna_gain = DBI_TO_MBI(gain), \ | |
233 | .power_rule.max_eirp = DBM_TO_MBM(eirp), \ | |
234 | .flags = reg_flags, \ | |
235 | .dfs_cac_ms = dfs_cac, \ | |
d3236553 JB |
236 | } |
237 | ||
089027e5 JD |
238 | #define REG_RULE(start, end, bw, gain, eirp, reg_flags) \ |
239 | REG_RULE_EXT(start, end, bw, gain, eirp, 0, reg_flags) | |
240 | ||
d3236553 | 241 | #endif |