]>
Commit | Line | Data |
---|---|---|
d3236553 JB |
1 | #ifndef __NET_REGULATORY_H |
2 | #define __NET_REGULATORY_H | |
3 | /* | |
4 | * regulatory support structures | |
5 | * | |
dde88b73 | 6 | * Copyright 2008-2009 Luis R. Rodriguez <mcgrof@qca.qualcomm.com> |
d3236553 | 7 | * |
dde88b73 LR |
8 | * 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. | |
d3236553 JB |
19 | */ |
20 | ||
458f4f9e | 21 | #include <linux/rcupdate.h> |
d3236553 JB |
22 | |
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 | */ | |
30 | enum 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 | * | |
c492db37 | 39 | * @rcu_head: RCU head struct used to free the request |
d3236553 | 40 | * @wiphy_idx: this is set if this request's initiator is |
a2f73b6c LR |
41 | * %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. | |
d3236553 | 45 | * @initiator: indicates who sent this request, could be any of |
a2f73b6c | 46 | * of those set in nl80211_reg_initiator (%NL80211_REGDOM_SET_BY_*) |
d3236553 | 47 | * @alpha2: the ISO / IEC 3166 alpha2 country code of the requested |
a2f73b6c LR |
48 | * 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 | |
09d989d1 | 52 | * 97 - regulatory domain has not yet been configured |
b68e6b3b LR |
53 | * @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. | |
57b5ce07 LR |
57 | * @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. | |
d3236553 | 61 | * @intersect: indicates whether the wireless core should intersect |
a2f73b6c LR |
62 | * the requested regulatory domain with the presently set regulatory |
63 | * domain. | |
b2e253cf LR |
64 | * @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. | |
d3236553 | 70 | * @country_ie_checksum: checksum of the last processed and accepted |
a2f73b6c | 71 | * country IE |
d3236553 | 72 | * @country_ie_env: lets us know if the AP is telling us we are outdoor, |
a2f73b6c | 73 | * indoor, or if it doesn't matter |
d3236553 JB |
74 | * @list: used to insert into the reg_requests_list linked list |
75 | */ | |
76 | struct regulatory_request { | |
c492db37 | 77 | struct rcu_head rcu_head; |
d3236553 JB |
78 | int wiphy_idx; |
79 | enum nl80211_reg_initiator initiator; | |
57b5ce07 | 80 | enum nl80211_user_reg_hint_type user_reg_hint_type; |
d3236553 | 81 | char alpha2[2]; |
4c7d3982 | 82 | enum nl80211_dfs_regions dfs_region; |
d3236553 | 83 | bool intersect; |
b2e253cf | 84 | bool processed; |
d3236553 JB |
85 | enum environment_cap country_ie_env; |
86 | struct list_head list; | |
87 | }; | |
88 | ||
a2f73b6c LR |
89 | /** |
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. | |
4f7b9140 LR |
99 | * 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. | |
a09a85a0 LR |
103 | * @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. | |
a2f73b6c LR |
119 | * @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() | |
a09a85a0 LR |
123 | * @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() | |
2a901468 LR |
130 | * @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. | |
174e0cd2 IP |
134 | * @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 | |
a2f73b6c LR |
139 | */ |
140 | enum ieee80211_regulatory_flags { | |
141 | REGULATORY_CUSTOM_REG = BIT(0), | |
142 | REGULATORY_STRICT_REG = BIT(1), | |
143 | REGULATORY_DISABLE_BEACON_HINTS = BIT(2), | |
a09a85a0 | 144 | REGULATORY_COUNTRY_IE_FOLLOW_POWER = BIT(3), |
2a901468 | 145 | REGULATORY_COUNTRY_IE_IGNORE = BIT(4), |
174e0cd2 | 146 | REGULATORY_ENABLE_RELAX_NO_IR = BIT(5), |
a2f73b6c LR |
147 | }; |
148 | ||
d3236553 JB |
149 | struct ieee80211_freq_range { |
150 | u32 start_freq_khz; | |
151 | u32 end_freq_khz; | |
152 | u32 max_bandwidth_khz; | |
153 | }; | |
154 | ||
155 | struct ieee80211_power_rule { | |
156 | u32 max_antenna_gain; | |
157 | u32 max_eirp; | |
158 | }; | |
159 | ||
160 | struct ieee80211_reg_rule { | |
161 | struct ieee80211_freq_range freq_range; | |
162 | struct ieee80211_power_rule power_rule; | |
163 | u32 flags; | |
089027e5 | 164 | u32 dfs_cac_ms; |
d3236553 JB |
165 | }; |
166 | ||
167 | struct ieee80211_regdomain { | |
458f4f9e | 168 | struct rcu_head rcu_head; |
d3236553 | 169 | u32 n_reg_rules; |
a5fe8e76 | 170 | char alpha2[3]; |
4c7d3982 | 171 | enum nl80211_dfs_regions dfs_region; |
d3236553 JB |
172 | struct ieee80211_reg_rule reg_rules[]; |
173 | }; | |
174 | ||
175 | #define MHZ_TO_KHZ(freq) ((freq) * 1000) | |
176 | #define KHZ_TO_MHZ(freq) ((freq) / 1000) | |
177 | #define DBI_TO_MBI(gain) ((gain) * 100) | |
178 | #define MBI_TO_DBI(gain) ((gain) / 100) | |
179 | #define DBM_TO_MBM(gain) ((gain) * 100) | |
180 | #define MBM_TO_DBM(gain) ((gain) / 100) | |
181 | ||
089027e5 JD |
182 | #define REG_RULE_EXT(start, end, bw, gain, eirp, dfs_cac, reg_flags) \ |
183 | { \ | |
184 | .freq_range.start_freq_khz = MHZ_TO_KHZ(start), \ | |
185 | .freq_range.end_freq_khz = MHZ_TO_KHZ(end), \ | |
186 | .freq_range.max_bandwidth_khz = MHZ_TO_KHZ(bw), \ | |
187 | .power_rule.max_antenna_gain = DBI_TO_MBI(gain), \ | |
188 | .power_rule.max_eirp = DBM_TO_MBM(eirp), \ | |
189 | .flags = reg_flags, \ | |
190 | .dfs_cac_ms = dfs_cac, \ | |
d3236553 JB |
191 | } |
192 | ||
089027e5 JD |
193 | #define REG_RULE(start, end, bw, gain, eirp, reg_flags) \ |
194 | REG_RULE_EXT(start, end, bw, gain, eirp, 0, reg_flags) | |
195 | ||
d3236553 | 196 | #endif |