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