xref: /freebsd/sys/compat/linuxkpi/common/include/linux/nl80211.h (revision e47161e5f1f01ef300c6e7efdb9c92e3a6c497ff)
1 /*-
2  * Copyright (c) 2020-2024 The FreeBSD Foundation
3  *
4  * This software was developed by Björn Zeeb under sponsorship from
5  * the FreeBSD Foundation.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef	_LINUXKPI_LINUX_NL80211_H
30 #define	_LINUXKPI_LINUX_NL80211_H
31 
32 #include <linux/bitops.h>
33 
34 enum nl80211_feature_flags {
35 	NL80211_FEATURE_AP_MODE_CHAN_WIDTH_CHANGE	= BIT(0),
36 	NL80211_FEATURE_DS_PARAM_SET_IE_IN_PROBES	= BIT(1),
37 	NL80211_FEATURE_HT_IBSS				= BIT(2),
38 	NL80211_FEATURE_LOW_PRIORITY_SCAN		= BIT(3),
39 	NL80211_FEATURE_ND_RANDOM_MAC_ADDR		= BIT(4),
40 	NL80211_FEATURE_P2P_GO_CTWIN			= BIT(5),
41 	NL80211_FEATURE_P2P_GO_OPPPS			= BIT(6),
42 	NL80211_FEATURE_QUIET				= BIT(7),
43 	NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR		= BIT(8),
44 	NL80211_FEATURE_SCHED_SCAN_RANDOM_MAC_ADDR	= BIT(9),
45 	NL80211_FEATURE_DYNAMIC_SMPS			= BIT(10),
46 	NL80211_FEATURE_STATIC_SMPS			= BIT(11),
47 	NL80211_FEATURE_SUPPORTS_WMM_ADMISSION		= BIT(12),
48 	NL80211_FEATURE_TDLS_CHANNEL_SWITCH		= BIT(13),
49 	NL80211_FEATURE_TX_POWER_INSERTION		= BIT(14),
50 	NL80211_FEATURE_WFA_TPC_IE_IN_PROBES		= BIT(15),
51 	NL80211_FEATURE_AP_SCAN				= BIT(16),
52 	NL80211_FEATURE_ACTIVE_MONITOR			= BIT(17),
53 };
54 
55 enum nl80211_pmsr_ftm_failure_flags {
56 	NL80211_PMSR_FTM_FAILURE_NO_RESPONSE		= BIT(0),
57 	NL80211_PMSR_FTM_FAILURE_PEER_BUSY		= BIT(1),
58 	NL80211_PMSR_FTM_FAILURE_UNSPECIFIED		= BIT(2),
59 };
60 
61 enum nl80211_pmsr_status_flags {
62 	NL80211_PMSR_STATUS_FAILURE			= BIT(0),
63 	NL80211_PMSR_STATUS_SUCCESS			= BIT(1),
64 	NL80211_PMSR_STATUS_TIMEOUT			= BIT(2),
65 };
66 
67 #define	NL80211_PMSR_TYPE_FTM				1
68 
69 enum nl80211_reg_rule_flags {
70 	NL80211_RRF_AUTO_BW				= BIT(0),
71 	NL80211_RRF_DFS					= BIT(1),
72 	NL80211_RRF_GO_CONCURRENT			= BIT(2),
73 	NL80211_RRF_NO_IR				= BIT(3),
74 	NL80211_RRF_NO_OUTDOOR				= BIT(4),
75 	NL80211_RRF_NO_HT40MINUS			= BIT(5),
76 	NL80211_RRF_NO_HT40PLUS				= BIT(6),
77 	NL80211_RRF_NO_80MHZ				= BIT(7),
78 	NL80211_RRF_NO_160MHZ				= BIT(8),
79 	NL80211_RRF_NO_HE				= BIT(9),
80 	NL80211_RRF_NO_OFDM				= BIT(10),
81 	NL80211_RRF_NO_320MHZ				= BIT(11),
82 	NL80211_RRF_NO_EHT				= BIT(12),
83 	NL80211_RRF_DFS_CONCURRENT			= BIT(13),
84 	NL80211_RRF_NO_6GHZ_VLP_CLIENT			= BIT(14),
85 	NL80211_RRF_NO_6GHZ_AFC_CLIENT			= BIT(15),
86 	NL80211_RRF_PSD					= BIT(16),
87 };
88 #define	NL80211_RRF_NO_HT40	(NL80211_RRF_NO_HT40MINUS|NL80211_RRF_NO_HT40PLUS)
89 
90 enum nl80211_scan_flags {
91 	NL80211_SCAN_FLAG_FILS_MAX_CHANNEL_TIME		= BIT(0),
92 	NL80211_SCAN_FLAG_OCE_PROBE_REQ_DEFERRAL_SUPPRESSION	= BIT(1),
93 	NL80211_SCAN_FLAG_OCE_PROBE_REQ_HIGH_TX_RATE	= BIT(2),
94 	NL80211_SCAN_FLAG_RANDOM_ADDR			= BIT(3),
95 	NL80211_SCAN_FLAG_COLOCATED_6GHZ		= BIT(4),
96 	NL80211_SCAN_FLAG_RANDOM_SN			= BIT(5),
97 	NL80211_SCAN_FLAG_ACCEPT_BCAST_PROBE_RESP	= BIT(6),
98 };
99 
100 #define	NL80211_MAX_SUPP_REG_RULES			512	/* TODO FIXME, random */
101 
102 #define	NL80211_BSS_CHAN_WIDTH_20			__LINE__ /* TODO FIXME, brcmfmac */
103 
104 enum nl80211_wpa_versions {
105 	NL80211_WPA_VERSION_1	= 1,
106 	NL80211_WPA_VERSION_2,
107 	NL80211_WPA_VERSION_3,
108 };
109 
110 enum nl80211_bss_select_attr {
111 	__NL80211_BSS_SELECT_ATTR_INVALID	= 0,
112 	NL80211_BSS_SELECT_ATTR_BAND_PREF,
113 	NL80211_BSS_SELECT_ATTR_RSSI,
114 	NL80211_BSS_SELECT_ATTR_RSSI_ADJUST,
115 };
116 
117 enum nl80211_sta_flag {
118 	/* XXX TODO */
119 	NL80211_STA_FLAG_ASSOCIATED,
120 	NL80211_STA_FLAG_AUTHENTICATED,
121 	NL80211_STA_FLAG_AUTHORIZED,
122 	NL80211_STA_FLAG_TDLS_PEER,
123 	NL80211_STA_FLAG_WME,
124 };
125 
126 enum nl80211_band {
127 	/* XXX TODO */
128 	NL80211_BAND_2GHZ	= 0,
129 	NL80211_BAND_5GHZ,
130 	NL80211_BAND_60GHZ,
131 	NL80211_BAND_6GHZ,
132 
133 	/* Keep this last. */
134 	NUM_NL80211_BANDS
135 };
136 
137 enum nl80211_chan_flags {
138 	/* XXX TODO */
139 	NL80211_CHAN_NO_HT,
140 };
141 
142 enum nl80211_chan_width {
143 	/* XXX TODO */
144 	NL80211_CHAN_WIDTH_20_NOHT,
145 	NL80211_CHAN_WIDTH_20,
146 	NL80211_CHAN_WIDTH_40,
147 	NL80211_CHAN_WIDTH_80,
148 	NL80211_CHAN_WIDTH_80P80,
149 	NL80211_CHAN_WIDTH_160,
150 	NL80211_CHAN_WIDTH_5,
151 	NL80211_CHAN_WIDTH_10,
152 	NL80211_CHAN_WIDTH_320,
153 };
154 
155 enum nl80211_iftype {
156 	/* XXX TODO */
157 	NL80211_IFTYPE_UNSPECIFIED,
158 	NL80211_IFTYPE_ADHOC,
159 	NL80211_IFTYPE_STATION,
160 	NL80211_IFTYPE_AP,
161 	NL80211_IFTYPE_AP_VLAN,
162 	NL80211_IFTYPE_MONITOR,
163 	NL80211_IFTYPE_P2P_CLIENT,
164 	NL80211_IFTYPE_P2P_DEVICE,
165 	NL80211_IFTYPE_P2P_GO,
166 	NL80211_IFTYPE_MESH_POINT,
167 	NL80211_IFTYPE_WDS,
168 	NL80211_IFTYPE_OCB,
169 	NL80211_IFTYPE_NAN,
170 
171 	/* Keep this last. */
172 	NUM_NL80211_IFTYPES
173 };
174 
175 enum nl80211_preamble {
176 	/* XXX TODO */
177 	NL80211_PREAMBLE_LEGACY,
178 	NL80211_PREAMBLE_HT,
179 	NL80211_PREAMBLE_VHT,
180 	NL80211_PREAMBLE_HE,
181 };
182 
183 enum nl80211_tdls_operation {
184 	/* XXX TODO */
185 	NL80211_TDLS_SETUP,
186 	NL80211_TDLS_TEARDOWN,
187 	NL80211_TDLS_ENABLE_LINK,
188 	NL80211_TDLS_DISABLE_LINK,
189 	NL80211_TDLS_DISCOVERY_REQ,
190 	NL80211_TKIP_DATA_OFFSET_RX_MIC_KEY,
191 	NL80211_TKIP_DATA_OFFSET_TX_MIC_KEY,
192 };
193 
194 enum nl80211_cqm_rssi_threshold_event {
195 	/* XXX TODO */
196 	NL80211_CQM_RSSI_THRESHOLD_EVENT_LOW,
197 	NL80211_CQM_RSSI_THRESHOLD_EVENT_HIGH,
198 };
199 
200 enum nl80211_ext_feature {
201 	/* XXX TODO */
202 	NL80211_EXT_FEATURE_ACCEPT_BCAST_PROBE_RESP,
203 	NL80211_EXT_FEATURE_BSS_PARENT_TSF,
204 	NL80211_EXT_FEATURE_CAN_REPLACE_PTK0,
205 	NL80211_EXT_FEATURE_DFS_OFFLOAD,
206 	NL80211_EXT_FEATURE_ENABLE_FTM_RESPONDER,
207 	NL80211_EXT_FEATURE_EXT_KEY_ID,
208 	NL80211_EXT_FEATURE_FILS_MAX_CHANNEL_TIME,
209 	NL80211_EXT_FEATURE_MU_MIMO_AIR_SNIFFER,
210 	NL80211_EXT_FEATURE_OCE_PROBE_REQ_DEFERRAL_SUPPRESSION,
211 	NL80211_EXT_FEATURE_OCE_PROBE_REQ_HIGH_TX_RATE,
212 	NL80211_EXT_FEATURE_PROTECTED_TWT,
213 	NL80211_EXT_FEATURE_SAE_OFFLOAD,
214 	NL80211_EXT_FEATURE_SCAN_START_TIME,
215 	NL80211_EXT_FEATURE_SET_SCAN_DWELL,
216 	NL80211_EXT_FEATURE_VHT_IBSS,
217 	NL80211_EXT_FEATURE_4WAY_HANDSHAKE_STA_1X,
218 	NL80211_EXT_FEATURE_4WAY_HANDSHAKE_STA_PSK,
219 	NL80211_EXT_FEATURE_BEACON_PROTECTION_CLIENT,
220 	NL80211_EXT_FEATURE_SCAN_RANDOM_SN,
221 	NL80211_EXT_FEATURE_STA_TX_PWR,
222 	NL80211_EXT_FEATURE_CQM_RSSI_LIST,
223 	NL80211_EXT_FEATURE_AQL,
224 	NL80211_EXT_FEATURE_AIRTIME_FAIRNESS,
225 	NL80211_EXT_FEATURE_ACK_SIGNAL_SUPPORT,
226 	NL80211_EXT_FEATURE_BEACON_RATE_LEGACY,
227 	NL80211_EXT_FEATURE_BEACON_RATE_HT,
228 	NL80211_EXT_FEATURE_BEACON_RATE_VHT,
229 	NL80211_EXT_FEATURE_BEACON_RATE_HE,
230 	NL80211_EXT_FEATURE_BSS_COLOR,
231 	NL80211_EXT_FEATURE_FILS_DISCOVERY,
232 	NL80211_EXT_FEATURE_RADAR_BACKGROUND,
233 	NL80211_EXT_FEATURE_UNSOL_BCAST_PROBE_RESP,
234 	NL80211_EXT_FEATURE_BEACON_PROTECTION,
235 	NL80211_EXT_FEATURE_SCAN_MIN_PREQ_CONTENT,
236 	NL80211_EXT_FEATURE_PUNCT,
237 	NL80211_EXT_FEATURE_DFS_CONCURRENT,
238 	NL80211_EXT_FEATURE_MULTICAST_REGISTRATIONS,
239 	NL80211_EXT_FEATURE_SPP_AMSDU_SUPPORT,
240 	NL80211_EXT_FEATURE_SECURE_LTF,
241 	NL80211_EXT_FEATURE_PROT_RANGE_NEGO_AND_MEASURE,
242 	NL80211_EXT_FEATURE_4WAY_HANDSHAKE_AP_PSK,
243 	NL80211_EXT_FEATURE_SAE_OFFLOAD_AP,
244 
245 	/* Keep this last. */
246 	NUM_NL80211_EXT_FEATURES
247 };
248 
249 enum nl80211_sta_info {
250 	/* XXX TODO */
251 	NL80211_STA_INFO_BEACON_RX,
252 	NL80211_STA_INFO_BEACON_SIGNAL_AVG,
253 	NL80211_STA_INFO_BSS_PARAM,
254 	NL80211_STA_INFO_CHAIN_SIGNAL,
255 	NL80211_STA_INFO_CHAIN_SIGNAL_AVG,
256 	NL80211_STA_INFO_CONNECTED_TIME,
257 	NL80211_STA_INFO_INACTIVE_TIME,
258 	NL80211_STA_INFO_SIGNAL,
259 	NL80211_STA_INFO_SIGNAL_AVG,
260 	NL80211_STA_INFO_STA_FLAGS,
261 	NL80211_STA_INFO_RX_BITRATE,
262 	NL80211_STA_INFO_RX_PACKETS,
263 	NL80211_STA_INFO_RX_BYTES,
264 	NL80211_STA_INFO_RX_DROP_MISC,
265 	NL80211_STA_INFO_TX_BITRATE,
266 	NL80211_STA_INFO_TX_PACKETS,
267 	NL80211_STA_INFO_TX_BYTES,
268 	NL80211_STA_INFO_TX_BYTES64,
269 	NL80211_STA_INFO_RX_BYTES64,
270 	NL80211_STA_INFO_TX_FAILED,
271 	NL80211_STA_INFO_TX_RETRIES,
272 	NL80211_STA_INFO_RX_DURATION,
273 	NL80211_STA_INFO_TX_DURATION,
274 	NL80211_STA_INFO_ACK_SIGNAL,
275 	NL80211_STA_INFO_ACK_SIGNAL_AVG,
276 };
277 
278 enum nl80211_ftm_stats {
279 	/* XXX TODO */
280 	NL80211_FTM_STATS_ASAP_NUM,
281 	NL80211_FTM_STATS_FAILED_NUM,
282 	NL80211_FTM_STATS_NON_ASAP_NUM,
283 	NL80211_FTM_STATS_OUT_OF_WINDOW_TRIGGERS_NUM,
284 	NL80211_FTM_STATS_PARTIAL_NUM,
285 	NL80211_FTM_STATS_RESCHEDULE_REQUESTS_NUM,
286 	NL80211_FTM_STATS_SUCCESS_NUM,
287 	NL80211_FTM_STATS_TOTAL_DURATION_MSEC,
288 	NL80211_FTM_STATS_UNKNOWN_TRIGGERS_NUM,
289 };
290 
291 enum nl80211_reg_initiator {
292 	/* XXX TODO */
293 	NL80211_REGDOM_SET_BY_USER,
294 	NL80211_REGDOM_SET_BY_DRIVER,
295 	NL80211_REGDOM_SET_BY_CORE,
296 	NL80211_REGDOM_SET_BY_COUNTRY_IE,
297 };
298 
299 struct nl80211_sta_flag_update {
300 	/* XXX TODO */
301 	int     mask, set;
302 
303 };
304 
305 enum nl80211_tx_power_setting {
306 	/* XXX TODO */
307 	NL80211_TX_POWER_AUTOMATIC,
308 	NL80211_TX_POWER_FIXED,
309 	NL80211_TX_POWER_LIMITED,
310 };
311 
312 enum nl80211_crit_proto_id {
313 	/* XXX TODO */
314 	NL80211_CRIT_PROTO_DHCP,
315 };
316 
317 enum nl80211_auth_type {
318 	NL80211_AUTHTYPE_AUTOMATIC,
319 	NL80211_AUTHTYPE_OPEN_SYSTEM,
320 	NL80211_AUTHTYPE_SHARED_KEY,
321 	NL80211_AUTHTYPE_SAE,
322 };
323 
324 enum nl80211_key_type {
325 	NL80211_KEYTYPE_GROUP,
326 	NL80211_KEYTYPE_PAIRWISE,
327 };
328 
329 enum nl80211_he_ru_alloc {
330 	NL80211_RATE_INFO_HE_RU_ALLOC_26,
331 	NL80211_RATE_INFO_HE_RU_ALLOC_52,
332 	NL80211_RATE_INFO_HE_RU_ALLOC_106,
333 	NL80211_RATE_INFO_HE_RU_ALLOC_242,
334 	NL80211_RATE_INFO_HE_RU_ALLOC_484,
335 	NL80211_RATE_INFO_HE_RU_ALLOC_996,
336 	NL80211_RATE_INFO_HE_RU_ALLOC_2x996,
337 };
338 
339 enum nl80211_he_gi {
340 	NL80211_RATE_INFO_HE_GI_0_8,
341 	NL80211_RATE_INFO_HE_GI_1_6,
342 	NL80211_RATE_INFO_HE_GI_3_2,
343 };
344 
345 enum nl80211_he_ltf {
346 	NL80211_RATE_INFO_HE_1XLTF,
347 	NL80211_RATE_INFO_HE_2XLTF,
348 	NL80211_RATE_INFO_HE_4XLTF,
349 };
350 
351 enum nl80211_eht_gi {
352 	NL80211_RATE_INFO_EHT_GI_0_8,
353 	NL80211_RATE_INFO_EHT_GI_1_6,
354 	NL80211_RATE_INFO_EHT_GI_3_2,
355 };
356 
357 enum nl80211_eht_ru_alloc {
358 	NL80211_RATE_INFO_EHT_RU_ALLOC_26,
359 	NL80211_RATE_INFO_EHT_RU_ALLOC_52,
360 	NL80211_RATE_INFO_EHT_RU_ALLOC_52P26,
361 	NL80211_RATE_INFO_EHT_RU_ALLOC_106,
362 	NL80211_RATE_INFO_EHT_RU_ALLOC_106P26,
363 	NL80211_RATE_INFO_EHT_RU_ALLOC_242,
364 	NL80211_RATE_INFO_EHT_RU_ALLOC_484,
365 	NL80211_RATE_INFO_EHT_RU_ALLOC_484P242,
366 	NL80211_RATE_INFO_EHT_RU_ALLOC_996,
367 	NL80211_RATE_INFO_EHT_RU_ALLOC_996P484,
368 	NL80211_RATE_INFO_EHT_RU_ALLOC_996P484P242,
369 	NL80211_RATE_INFO_EHT_RU_ALLOC_2x996,
370 	NL80211_RATE_INFO_EHT_RU_ALLOC_2x996P484,
371 	NL80211_RATE_INFO_EHT_RU_ALLOC_3x996,
372 	NL80211_RATE_INFO_EHT_RU_ALLOC_3x996P484,
373 	NL80211_RATE_INFO_EHT_RU_ALLOC_4x996,
374 };
375 
376 enum nl80211_dfs_regions {
377 	NL80211_DFS_UNSET,
378 	NL80211_DFS_FCC,
379 	NL80211_DFS_ETSI,
380 	NL80211_DFS_JP,
381 };
382 
383 enum nl80211_dfs_state {
384 	NL80211_DFS_USABLE,
385 };
386 
387 enum nl80211_sar_type {
388 	NL80211_SAR_TYPE_POWER,
389 };
390 
391 #define	NL80211_VHT_NSS_MAX			8
392 #define	NL80211_HE_NSS_MAX			8
393 
394 enum nl80211_tid_cfg_attr {
395 	NL80211_TID_CONFIG_ATTR_NOACK,
396 	NL80211_TID_CONFIG_ATTR_RETRY_SHORT,
397 	NL80211_TID_CONFIG_ATTR_TX_RATE_TYPE,
398 	NL80211_TID_CONFIG_ATTR_TX_RATE,
399 	NL80211_TID_CONFIG_ATTR_RTSCTS_CTRL,
400 	NL80211_TID_CONFIG_ATTR_RETRY_LONG,
401 	NL80211_TID_CONFIG_ATTR_AMPDU_CTRL,
402 	NL80211_TID_CONFIG_ATTR_AMSDU_CTRL,
403 };
404 
405 enum nl80211_tid_config {
406 	NL80211_TID_CONFIG_ENABLE,
407 };
408 
409 enum nl80211_tx_rate_setting {
410 	NL80211_TX_RATE_AUTOMATIC,
411 	NL80211_TX_RATE_FIXED,
412 	NL80211_TX_RATE_LIMITED,
413 };
414 
415 enum nl80211_txrate_gi {
416 	NL80211_TXRATE_DEFAULT_GI,
417 	NL80211_TXRATE_FORCE_SGI,
418 	NL80211_TXRATE_FORCE_LGI,
419 };
420 
421 enum nl80211_probe_resp_offload_support {
422 	NL80211_PROBE_RESP_OFFLOAD_SUPPORT_WPS2,
423 	NL80211_PROBE_RESP_OFFLOAD_SUPPORT_WPS,
424 	NL80211_PROBE_RESP_OFFLOAD_SUPPORT_P2P,
425 };
426 
427 enum nl80211_user_reg_hint_type {
428 	NL80211_USER_REG_HINT_USER,
429 };
430 
431 enum nl80211_hidden_ssid {
432 	NL80211_HIDDEN_SSID_NOT_IN_USE,
433 };
434 
435 #define	NL80211_KCK_LEN				16
436 #define	NL80211_KCK_EXT_LEN			24
437 #define	NL80211_KEK_LEN				16
438 #define	NL80211_KEK_EXT_LEN			32
439 #define	NL80211_REPLAY_CTR_LEN			8
440 #endif	/* _LINUXKPI_LINUX_NL80211_H */
441