xref: /freebsd/sys/compat/linuxkpi/common/include/linux/ieee80211.h (revision d59c7ea2701fe7b73b32eef49a7c712ef38de5a0)
1 /*-
2  * Copyright (c) 2020-2026 The FreeBSD Foundation
3  * Copyright (c) 2026 Bjoern A. Zeeb
4  *
5  * This software was developed by Björn Zeeb under sponsorship from
6  * the FreeBSD Foundation.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #ifndef	_LINUXKPI_LINUX_IEEE80211_H
31 #define	_LINUXKPI_LINUX_IEEE80211_H
32 
33 #include <sys/types.h>
34 #include <net80211/ieee80211.h>
35 
36 #include <asm/unaligned.h>
37 #include <linux/kernel.h>
38 #include <linux/bitops.h>
39 #include <linux/bitfield.h>
40 #include <linux/if_ether.h>
41 
42 /* linux_80211.c */
43 extern int linuxkpi_debug_80211;
44 #ifndef	D80211_TODO
45 #define	D80211_TODO		0x1
46 #endif
47 #ifndef	D80211_IMPROVE
48 #define	D80211_IMPROVE		0x2
49 #endif
50 #define	TODO(fmt, ...)		if (linuxkpi_debug_80211 & D80211_TODO)	\
51     printf("%s:%d: XXX LKPI80211 TODO " fmt "\n", __func__, __LINE__, ##__VA_ARGS__)
52 #define	IMPROVE(fmt, ...)	if (linuxkpi_debug_80211 & D80211_IMPROVE) \
53     printf("%s:%d: XXX LKPI80211 IMPROVE " fmt "\n", __func__, __LINE__, ##__VA_ARGS__)
54 
55 /* 802.11-2024, 9.4.2.53 MME. */
56 /* BIP-CMAC-128 */
57 struct ieee80211_mmie {
58 	uint8_t		element_id;
59 	uint8_t		length;
60 	uint16_t	key_id;
61 	uint8_t		ipn[6];
62 	uint8_t		mic[8];
63 };
64 /* BIP-CMAC-256, BIP-GMAC-128, BIP-GMAC-256 */
65 struct ieee80211_mmie_16 {
66 	uint8_t		element_id;
67 	uint8_t		length;
68 	uint16_t	key_id;
69 	uint8_t		ipn[6];
70 	uint8_t		mic[16];
71 };
72 
73 #define	IEEE80211_CCMP_HDR_LEN			8	/* 802.11i .. net80211 comment */
74 #define	IEEE80211_CCMP_PN_LEN			6
75 #define	IEEE80211_CCMP_MIC_LEN			8	/* || 16 */
76 #define	IEEE80211_CCMP_256_HDR_LEN		8
77 #define	IEEE80211_CCMP_256_MIC_LEN		16
78 #define	IEEE80211_GCMP_HDR_LEN			8
79 #define	IEEE80211_GCMP_MIC_LEN			16
80 #define	IEEE80211_GCMP_PN_LEN			6
81 #define	IEEE80211_GMAC_PN_LEN			6
82 #define	IEEE80211_CMAC_PN_LEN			6
83 
84 #define	IEEE80211_MAX_PN_LEN			16
85 
86 #define	IEEE80211_INVAL_HW_QUEUE		((uint8_t)-1)
87 
88 #define	IEEE80211_MAX_AMPDU_BUF_HT		IEEE80211_AGGR_BAWMAX
89 #define	IEEE80211_MAX_AMPDU_BUF_HE		256
90 #define	IEEE80211_MAX_AMPDU_BUF_EHT		1024
91 
92 #define	IEEE80211_MAX_FRAME_LEN			2352
93 #define	IEEE80211_MAX_DATA_LEN			(2300 + IEEE80211_CRC_LEN)
94 
95 #define	IEEE80211_MAX_MPDU_LEN_HT_BA		4095	/* 9.3.2.1 Format of Data frames; non-VHT non-DMG STA */
96 #define	IEEE80211_MAX_MPDU_LEN_HT_3839		3839
97 #define	IEEE80211_MAX_MPDU_LEN_HT_7935		7935
98 #define	IEEE80211_MAX_MPDU_LEN_VHT_3895		3895
99 #define	IEEE80211_MAX_MPDU_LEN_VHT_7991		7991
100 #define	IEEE80211_MAX_MPDU_LEN_VHT_11454	11454
101 
102 #define	IEEE80211_MAX_RTS_THRESHOLD		2346	/* net80211::IEEE80211_RTS_MAX */
103 
104 /* Wi-Fi Peer-to-Peer (P2P) Technical Specification */
105 #define	IEEE80211_P2P_OPPPS_CTWINDOW_MASK	0x7f
106 #define	IEEE80211_P2P_OPPPS_ENABLE_BIT		BIT(7)
107 
108 /* 802.11-2016, 9.2.4.5.1, Table 9-6 QoS Control Field */
109 #define	IEEE80211_QOS_CTL_TAG1D_MASK		0x0007
110 #define	IEEE80211_QOS_CTL_TID_MASK		IEEE80211_QOS_TID
111 #define	IEEE80211_QOS_CTL_EOSP			0x0010
112 #define	IEEE80211_QOS_CTL_A_MSDU_PRESENT	0x0080
113 #define	IEEE80211_QOS_CTL_ACK_POLICY_MASK	0x0060
114 #define	IEEE80211_QOS_CTL_ACK_POLICY_NOACK	0x0020
115 #define	IEEE80211_QOS_CTL_MESH_CONTROL_PRESENT	0x0100
116 
117 enum ieee80211_rate_flags {
118 	IEEE80211_RATE_SHORT_PREAMBLE		= BIT(0),	/* 2.4Ghz, CCK */
119 	IEEE80211_RATE_SUPPORTS_5MHZ		= BIT(1),
120 	IEEE80211_RATE_SUPPORTS_10MHZ		= BIT(2),
121 	IEEE80211_RATE_ERP_G			= BIT(3),
122 
123 	/*
124 	 * According to documentation these are flags initialized internally.
125 	 * See lkpi_wiphy_band_annotate().
126 	 */
127 	IEEE80211_RATE_MANDATORY_A		= BIT(4),
128 	IEEE80211_RATE_MANDATORY_G		= BIT(5),
129 	IEEE80211_RATE_MANDATORY_B		= BIT(6),
130 };
131 
132 enum ieee80211_rate_control_changed_flags {
133 	IEEE80211_RC_BW_CHANGED			= BIT(0),
134 	IEEE80211_RC_NSS_CHANGED		= BIT(1),
135 	IEEE80211_RC_SUPP_RATES_CHANGED		= BIT(2),
136 	IEEE80211_RC_SMPS_CHANGED		= BIT(3),
137 };
138 
139 #define	IEEE80211_SCTL_FRAG			IEEE80211_SEQ_FRAG_MASK
140 #define	IEEE80211_SCTL_SEQ			IEEE80211_SEQ_SEQ_MASK
141 
142 #define	IEEE80211_TKIP_ICV_LEN			4
143 #define	IEEE80211_TKIP_IV_LEN			8	/* WEP + KID + EXT */
144 
145 /* 802.11-2016, 9.4.2.158.3 Supported VHT-MCS and NSS Set field. */
146 #define	IEEE80211_VHT_EXT_NSS_BW_CAPABLE	(1 << 13)	/* part of tx_highest */
147 
148 /*
149  * 802.11-2020, 9.4.2.157.2 VHT Capabilities Information field,
150  * Table 9-271-Subfields of the VHT Capabilities Information field (continued).
151  */
152 enum ieee80211_vht_max_ampdu_len_exp {
153 	IEEE80211_VHT_MAX_AMPDU_8K		= 0,
154 	IEEE80211_VHT_MAX_AMPDU_16K		= 1,
155 	IEEE80211_VHT_MAX_AMPDU_32K		= 2,
156 	IEEE80211_VHT_MAX_AMPDU_64K		= 3,
157 	IEEE80211_VHT_MAX_AMPDU_128K		= 4,
158 	IEEE80211_VHT_MAX_AMPDU_256K		= 5,
159 	IEEE80211_VHT_MAX_AMPDU_512K		= 6,
160 	IEEE80211_VHT_MAX_AMPDU_1024K		= 7,
161 };
162 
163 /* 802.11-2020, 9.6.22 VHT Action frame details. */
164 enum ieee80211_vht_actioncode {
165 	/* VHT Compressed Beamforming		= 0, */
166 	WLAN_VHT_ACTION_GROUPID_MGMT		= 1,
167 	/* Operating Mode Notification		= 2, */
168 };
169 
170 #define	IEEE80211_WEP_IV_LEN			3	/* net80211: IEEE80211_WEP_IVLEN */
171 #define	IEEE80211_WEP_ICV_LEN			4
172 
173 #define	WLAN_AUTH_OPEN				__LINE__ /* TODO FIXME brcmfmac */
174 #define	WLAN_CAPABILITY_IBSS			__LINE__ /* TODO FIXME no longer used? */
175 #define	WLAN_CAPABILITY_SHORT_PREAMBLE		__LINE__ /* TODO FIXME brcmfmac */
176 #define	WLAN_CAPABILITY_SHORT_SLOT_TIME		__LINE__ /* TODO FIXME brcmfmac */
177 
178 enum wlan_ht_cap_sm_ps {
179 	WLAN_HT_CAP_SM_PS_STATIC		= 0,
180 	WLAN_HT_CAP_SM_PS_DYNAMIC		= 1,
181 	WLAN_HT_CAP_SM_PS_INVALID		= 2,
182 	WLAN_HT_CAP_SM_PS_DISABLED		= 3
183 };
184 
185 #define	WLAN_MAX_KEY_LEN			32
186 #define	WLAN_PMKID_LEN				16
187 #define	WLAN_PMK_LEN_SUITE_B_192		48
188 
189 enum ieee80211_key_len {
190 	WLAN_KEY_LEN_WEP40			= 5,
191 	WLAN_KEY_LEN_WEP104			= 13,
192 	WLAN_KEY_LEN_TKIP			= 32,
193 	WLAN_KEY_LEN_CCMP			= 16,
194 	WLAN_KEY_LEN_CCMP_256			= 32,
195 	WLAN_KEY_LEN_GCMP			= 16,
196 	WLAN_KEY_LEN_AES_CMAC			= 16,
197 	WLAN_KEY_LEN_GCMP_256			= 32,
198 	WLAN_KEY_LEN_BIP_CMAC_256		= 32,
199 	WLAN_KEY_LEN_BIP_GMAC_128		= 16,
200 	WLAN_KEY_LEN_BIP_GMAC_256		= 32,
201 };
202 
203 /* 802.11-2020, 9.4.2.55.3, Table 9-185 Subfields of the A-MPDU Parameters field */
204 enum ieee80211_min_mpdu_start_spacing {
205 	IEEE80211_HT_MPDU_DENSITY_NONE		= 0,
206 #if 0
207 	IEEE80211_HT_MPDU_DENSITY_XXX		= 1,	/* 1/4 us */
208 #endif
209 	IEEE80211_HT_MPDU_DENSITY_0_5		= 2,	/* 1/2 us */
210 	IEEE80211_HT_MPDU_DENSITY_1		= 3,	/* 1 us */
211 	IEEE80211_HT_MPDU_DENSITY_2		= 4,	/* 2 us */
212 	IEEE80211_HT_MPDU_DENSITY_4		= 5,	/* 4us */
213 	IEEE80211_HT_MPDU_DENSITY_8		= 6,	/* 8us */
214 	IEEE80211_HT_MPDU_DENSITY_16		= 7, 	/* 16us */
215 };
216 
217 /* 9.4.2.57, Table 9-168, HT Operation element fields and subfields */
218 #define	IEEE80211_HT_STBC_PARAM_DUAL_CTS_PROT	0x0080	/* B24.. */
219 
220 #define	IEEE80211_FCTL_FTYPE			IEEE80211_FC0_TYPE_MASK
221 #define	IEEE80211_FCTL_STYPE			IEEE80211_FC0_SUBTYPE_MASK
222 #define	IEEE80211_FCTL_ORDER			(IEEE80211_FC1_ORDER << 8)
223 #define	IEEE80211_FCTL_PROTECTED		(IEEE80211_FC1_PROTECTED << 8)
224 #define	IEEE80211_FCTL_FROMDS			(IEEE80211_FC1_DIR_FROMDS << 8)
225 #define	IEEE80211_FCTL_TODS			(IEEE80211_FC1_DIR_TODS << 8)
226 #define	IEEE80211_FCTL_MOREFRAGS		(IEEE80211_FC1_MORE_FRAG << 8)
227 #define	IEEE80211_FCTL_PM			(IEEE80211_FC1_PWR_MGT << 8)
228 #define	IEEE80211_FCTL_MOREDATA			(IEEE80211_FC1_MORE_DATA << 8)
229 
230 #define	IEEE80211_FTYPE_MGMT			IEEE80211_FC0_TYPE_MGT
231 #define	IEEE80211_FTYPE_CTL			IEEE80211_FC0_TYPE_CTL
232 #define	IEEE80211_FTYPE_DATA			IEEE80211_FC0_TYPE_DATA
233 
234 #define	IEEE80211_STYPE_ASSOC_REQ		IEEE80211_FC0_SUBTYPE_ASSOC_REQ
235 #define	IEEE80211_STYPE_REASSOC_REQ		IEEE80211_FC0_SUBTYPE_REASSOC_REQ
236 #define	IEEE80211_STYPE_PROBE_REQ		IEEE80211_FC0_SUBTYPE_PROBE_REQ
237 #define	IEEE80211_STYPE_DISASSOC		IEEE80211_FC0_SUBTYPE_DISASSOC
238 #define	IEEE80211_STYPE_AUTH			IEEE80211_FC0_SUBTYPE_AUTH
239 #define	IEEE80211_STYPE_DEAUTH			IEEE80211_FC0_SUBTYPE_DEAUTH
240 #define	IEEE80211_STYPE_CTS			IEEE80211_FC0_SUBTYPE_CTS
241 #define	IEEE80211_STYPE_RTS			IEEE80211_FC0_SUBTYPE_RTS
242 #define	IEEE80211_STYPE_ACTION			IEEE80211_FC0_SUBTYPE_ACTION
243 #define	IEEE80211_STYPE_DATA			IEEE80211_FC0_SUBTYPE_DATA
244 #define	IEEE80211_STYPE_QOS_DATA		IEEE80211_FC0_SUBTYPE_QOS_DATA
245 #define	IEEE80211_STYPE_QOS_NULLFUNC		IEEE80211_FC0_SUBTYPE_QOS_NULL
246 #define	IEEE80211_STYPE_QOS_CFACK		0xd0	/* XXX-BZ reserved? */
247 
248 #define	IEEE80211_NUM_ACS			4	/* net8021::WME_NUM_AC */
249 
250 #define	IEEE80211_MAX_SSID_LEN			32	/* 9.4.2.2 SSID element, net80211: IEEE80211_NWID_LEN */
251 
252 
253 /* Figure 9-27, BAR Control field */
254 #define	IEEE80211_BAR_CTRL_TID_INFO_MASK	0xf000
255 #define	IEEE80211_BAR_CTRL_TID_INFO_SHIFT	12
256 
257 #define	IEEE80211_PPE_THRES_INFO_PPET_SIZE		1 /* TODO FIXME ax? */
258 #define	IEEE80211_PPE_THRES_NSS_MASK			2 /* TODO FIXME ax? */
259 #define	IEEE80211_PPE_THRES_RU_INDEX_BITMASK_POS	3 /* TODO FIXME ax? */
260 #define	IEEE80211_PPE_THRES_RU_INDEX_BITMASK_MASK	8 /* TODO FIXME ax? */
261 #define	IEEE80211_HE_PPE_THRES_INFO_HEADER_SIZE		16	/* TODO FIXME ax? */
262 
263 /* 802.11-2012, Table 8-130-HT Operation element fields and subfields, HT Protection */
264 #define	IEEE80211_HT_OP_MODE_PROTECTION			IEEE80211_HTINFO_OPMODE		/* Mask. */
265 #define	IEEE80211_HT_OP_MODE_PROTECTION_NONE		IEEE80211_HTINFO_OPMODE_PURE	/* No protection */
266 #define	IEEE80211_HT_OP_MODE_PROTECTION_NONMEMBER	IEEE80211_HTINFO_OPMODE_PROTOPT	/* Nonmember protection */
267 #define	IEEE80211_HT_OP_MODE_PROTECTION_20MHZ		IEEE80211_HTINFO_OPMODE_HT20PR	/* 20 MHz protection */
268 #define	IEEE80211_HT_OP_MODE_PROTECTION_NONHT_MIXED	IEEE80211_HTINFO_OPMODE_MIXED	/* Non-HT mixed */
269 
270 
271 /* 9.6.13.1, Table 9-342 TDLS Action field values. */
272 enum ieee80211_tdls_action_code {
273 	WLAN_TDLS_SETUP_REQUEST			= 0,
274 	WLAN_TDLS_SETUP_RESPONSE		= 1,
275 	WLAN_TDLS_SETUP_CONFIRM			= 2,
276 	WLAN_TDLS_TEARDOWN			= 3,
277 	WLAN_TDLS_PEER_TRAFFIC_INDICATION	= 4,
278 	WLAN_TDLS_CHANNEL_SWITCH_REQUEST	= 5,
279 	WLAN_TDLS_CHANNEL_SWITCH_RESPONSE	= 6,
280 	WLAN_TDLS_PEER_PSM_REQUEST		= 7,
281 	WLAN_TDLS_PEER_PSM_RESPONSE		= 8,
282 	WLAN_TDLS_PEER_TRAFFIC_RESPONSE		= 9,
283 	WLAN_TDLS_DISCOVERY_REQUEST		= 10,
284 	/* 11-255 reserved */
285 };
286 
287 /* 802.11-2020 9.4.2.26, Table 9-153. Extended Capabilities field. */
288 /* This is split up into octets CAPA1 = octet 1, ... */
289 #define	WLAN_EXT_CAPA1_EXT_CHANNEL_SWITCHING			BIT(2  % 8)
290 #define	WLAN_EXT_CAPA3_MULTI_BSSID_SUPPORT			BIT(22 % 8)
291 #define	WLAN_EXT_CAPA3_TIMING_MEASUREMENT_SUPPORT		BIT(23 % 8)
292 #define	WLAN_EXT_CAPA8_OPMODE_NOTIF				BIT(62 % 8)
293 #define	WLAN_EXT_CAPA8_MAX_MSDU_IN_AMSDU_LSB			BIT(63 % 8)
294 #define	WLAN_EXT_CAPA9_MAX_MSDU_IN_AMSDU_MSB			BIT(64 % 8)
295 #define	WLAN_EXT_CAPA10_TWT_REQUESTER_SUPPORT			BIT(77 % 8)
296 #define	WLAN_EXT_CAPA10_TWT_RESPONDER_SUPPORT			BIT(78 % 8)
297 #define	WLAN_EXT_CAPA10_OBSS_NARROW_BW_RU_TOLERANCE_SUPPORT	BIT(79 % 8)
298 
299 #define	WLAN_EXT_CAPA11_EMA_SUPPORT				0x00	/* XXX TODO FIXME */
300 
301 
302 /* iwlwifi/mvm/utils:: for (ac = IEEE80211_AC_VO; ac <= IEEE80211_AC_VI; ac++) */
303 /* Would be so much easier if we'd define constants to the same. */
304 enum ieee80211_ac_numbers {
305 	IEEE80211_AC_VO = 0,			/* net80211::WME_AC_VO */
306 	IEEE80211_AC_VI = 1,			/* net80211::WME_AC_VI */
307 	IEEE80211_AC_BE = 2,			/* net80211::WME_AC_BE */
308 	IEEE80211_AC_BK = 3,			/* net80211::WME_AC_BK */
309 };
310 
311 #define	IEEE80211_MAX_QUEUES			16	/* Assume IEEE80211_NUM_TIDS for the moment. */
312 
313 #define	IEEE80211_WMM_IE_STA_QOSINFO_AC_VO	1
314 #define	IEEE80211_WMM_IE_STA_QOSINFO_AC_VI	2
315 #define	IEEE80211_WMM_IE_STA_QOSINFO_AC_BK	4
316 #define	IEEE80211_WMM_IE_STA_QOSINFO_AC_BE	8
317 #define	IEEE80211_WMM_IE_STA_QOSINFO_SP_ALL	0xf
318 
319 
320 /* Define the LinuxKPI names directly to the net80211 ones. */
321 #define	IEEE80211_HT_CAP_LDPC_CODING		IEEE80211_HTCAP_LDPC
322 #define	IEEE80211_HT_CAP_SUP_WIDTH_20_40	IEEE80211_HTCAP_CHWIDTH40
323 #define	IEEE80211_HT_CAP_SM_PS			IEEE80211_HTCAP_SMPS
324 #define	IEEE80211_HT_CAP_SM_PS_SHIFT		2
325 #define	IEEE80211_HT_CAP_GRN_FLD		IEEE80211_HTCAP_GREENFIELD
326 #define	IEEE80211_HT_CAP_SGI_20			IEEE80211_HTCAP_SHORTGI20
327 #define	IEEE80211_HT_CAP_SGI_40			IEEE80211_HTCAP_SHORTGI40
328 #define	IEEE80211_HT_CAP_TX_STBC		IEEE80211_HTCAP_TXSTBC
329 #define	IEEE80211_HT_CAP_RX_STBC		IEEE80211_HTCAP_RXSTBC
330 #define	IEEE80211_HT_CAP_RX_STBC_SHIFT		IEEE80211_HTCAP_RXSTBC_S
331 #define	IEEE80211_HT_CAP_MAX_AMSDU		IEEE80211_HTCAP_MAXAMSDU
332 #define	IEEE80211_HT_CAP_DSSSCCK40		IEEE80211_HTCAP_DSSSCCK40
333 #define	IEEE80211_HT_CAP_LSIG_TXOP_PROT		IEEE80211_HTCAP_LSIGTXOPPROT
334 
335 #define	IEEE80211_HT_MCS_TX_DEFINED		0x0001
336 #define	IEEE80211_HT_MCS_TX_RX_DIFF		0x0002
337 #define	IEEE80211_HT_MCS_TX_MAX_STREAMS_SHIFT	2
338 #define	IEEE80211_HT_MCS_TX_MAX_STREAMS_MASK	0x0c
339 #define	IEEE80211_HT_MCS_RX_HIGHEST_MASK	0x3ff
340 #define	IEEE80211_HT_MCS_MASK_LEN		10
341 
342 #define	IEEE80211_MLD_MAX_NUM_LINKS		15
343 #define	IEEE80211_MLD_CAP_OP_MAX_SIMUL_LINKS	0xf
344 #define	IEEE80211_MLD_CAP_OP_TID_TO_LINK_MAP_NEG_SUPP		0x0060
345 #define	IEEE80211_MLD_CAP_OP_TID_TO_LINK_MAP_NEG_SUPP_SAME	1
346 #define	IEEE80211_MLD_CAP_OP_LINK_RECONF_SUPPORT		0x2000
347 
348 struct ieee80211_mcs_info {
349 	uint8_t		rx_mask[IEEE80211_HT_MCS_MASK_LEN];
350 	uint16_t	rx_highest;
351 	uint8_t		tx_params;
352 	uint8_t		__reserved[3];
353 } __packed;
354 
355 /* 802.11-2020, 9.4.2.55.1 HT Capabilities element structure */
356 struct ieee80211_ht_cap {
357 	uint16_t				cap_info;
358 	uint8_t					ampdu_params_info;
359 	struct ieee80211_mcs_info		mcs;
360 	uint16_t				extended_ht_cap_info;
361 	uint32_t				tx_BF_cap_info;
362 	uint8_t					antenna_selection_info;
363 } __packed;
364 
365 #define	IEEE80211_HT_MAX_AMPDU_FACTOR		13
366 #define	IEEE80211_HE_HT_MAX_AMPDU_FACTOR	16
367 #define	IEEE80211_HE_VHT_MAX_AMPDU_FACTOR	20
368 #define	IEEE80211_HE_6GHZ_MAX_AMPDU_FACTOR	13
369 
370 enum ieee80211_ht_max_ampdu_len {
371 	IEEE80211_HT_MAX_AMPDU_64K
372 };
373 
374 enum ieee80211_ampdu_mlme_action {
375 	IEEE80211_AMPDU_RX_START,
376 	IEEE80211_AMPDU_RX_STOP,
377 	IEEE80211_AMPDU_TX_OPERATIONAL,
378 	IEEE80211_AMPDU_TX_START,
379 	IEEE80211_AMPDU_TX_STOP_CONT,
380 	IEEE80211_AMPDU_TX_STOP_FLUSH,
381 	IEEE80211_AMPDU_TX_STOP_FLUSH_CONT
382 };
383 
384 #define	IEEE80211_AMPDU_TX_START_IMMEDIATE	1
385 #define	IEEE80211_AMPDU_TX_START_DELAY_ADDBA	2
386 
387 enum ieee80211_chanctx_switch_mode {
388 	CHANCTX_SWMODE_REASSIGN_VIF,
389 	CHANCTX_SWMODE_SWAP_CONTEXTS,
390 };
391 
392 enum ieee80211_chanctx_change_flags {
393 	IEEE80211_CHANCTX_CHANGE_MIN_WIDTH	= BIT(0),
394 	IEEE80211_CHANCTX_CHANGE_RADAR		= BIT(1),
395 	IEEE80211_CHANCTX_CHANGE_RX_CHAINS	= BIT(2),
396 	IEEE80211_CHANCTX_CHANGE_WIDTH		= BIT(3),
397 	IEEE80211_CHANCTX_CHANGE_CHANNEL	= BIT(4),
398 	IEEE80211_CHANCTX_CHANGE_PUNCTURING	= BIT(5),
399 	IEEE80211_CHANCTX_CHANGE_MIN_DEF	= BIT(6),
400 	IEEE80211_CHANCTX_CHANGE_AP		= BIT(7),
401 };
402 
403 enum ieee80211_frame_release_type {
404 	IEEE80211_FRAME_RELEASE_PSPOLL		= 1,
405 	IEEE80211_FRAME_RELEASE_UAPSD		= 2,
406 };
407 
408 enum ieee80211_p2p_attr_ids {
409 	IEEE80211_P2P_ATTR_DEVICE_ID,
410 	IEEE80211_P2P_ATTR_DEVICE_INFO,
411 	IEEE80211_P2P_ATTR_GROUP_ID,
412 	IEEE80211_P2P_ATTR_LISTEN_CHANNEL,
413 	IEEE80211_P2P_ATTR_ABSENCE_NOTICE,
414 };
415 
416 enum ieee80211_reconfig_type {
417 	IEEE80211_RECONFIG_TYPE_RESTART,
418 	IEEE80211_RECONFIG_TYPE_SUSPEND,
419 };
420 
421 enum ieee80211_roc_type {
422 	IEEE80211_ROC_TYPE_MGMT_TX,
423 	IEEE80211_ROC_TYPE_NORMAL,
424 };
425 
426 enum ieee80211_smps_mode {
427 	IEEE80211_SMPS_OFF,
428 	IEEE80211_SMPS_STATIC,
429 	IEEE80211_SMPS_DYNAMIC,
430 	IEEE80211_SMPS_AUTOMATIC,
431 	IEEE80211_SMPS_NUM_MODES,
432 };
433 
434 /* net80211::IEEE80211_S_* different but represents the state machine. */
435 /* Note: order here is important! */
436 enum ieee80211_sta_state {
437 	IEEE80211_STA_NOTEXIST		= 0,
438 	IEEE80211_STA_NONE		= 1,
439 	IEEE80211_STA_AUTH		= 2,
440 	IEEE80211_STA_ASSOC		= 3,
441 	IEEE80211_STA_AUTHORIZED	= 4,	/* 802.1x */
442 };
443 
444 enum ieee80211_sta_rx_bandwidth {
445 	IEEE80211_STA_RX_BW_20		= 0,
446 	IEEE80211_STA_RX_BW_40,
447 	IEEE80211_STA_RX_BW_80,
448 	IEEE80211_STA_RX_BW_160,
449 	IEEE80211_STA_RX_BW_320,
450 };
451 
452 enum ieee80211_tx_info_flags {
453 	/* XXX TODO .. right shift numbers - not sure where that came from? */
454 	IEEE80211_TX_CTL_AMPDU			= BIT(0),
455 	IEEE80211_TX_CTL_ASSIGN_SEQ		= BIT(1),
456 	IEEE80211_TX_CTL_NO_ACK			= BIT(2),
457 	IEEE80211_TX_CTL_SEND_AFTER_DTIM	= BIT(3),
458 	IEEE80211_TX_CTL_TX_OFFCHAN		= BIT(4),
459 	IEEE80211_TX_CTL_REQ_TX_STATUS		= BIT(5),
460 	IEEE80211_TX_STATUS_EOSP		= BIT(6),
461 	IEEE80211_TX_STAT_ACK			= BIT(7),
462 	IEEE80211_TX_STAT_AMPDU			= BIT(8),
463 	IEEE80211_TX_STAT_AMPDU_NO_BACK		= BIT(9),
464 	IEEE80211_TX_STAT_TX_FILTERED		= BIT(10),
465 	IEEE80211_TX_STAT_NOACK_TRANSMITTED	= BIT(11),
466 	IEEE80211_TX_CTL_FIRST_FRAGMENT		= BIT(12),
467 	IEEE80211_TX_INTFL_DONT_ENCRYPT		= BIT(13),
468 	IEEE80211_TX_CTL_NO_CCK_RATE		= BIT(14),
469 	IEEE80211_TX_CTL_INJECTED		= BIT(15),
470 	IEEE80211_TX_CTL_HW_80211_ENCAP		= BIT(16),
471 	IEEE80211_TX_CTL_USE_MINRATE		= BIT(17),
472 	IEEE80211_TX_CTL_RATE_CTRL_PROBE	= BIT(18),
473 	IEEE80211_TX_CTL_LDPC			= BIT(19),
474 	IEEE80211_TX_CTL_STBC			= BIT(20),
475 } __packed;
476 
477 #define	IEEE80211_TX_INFO_FLAGS						\
478     "\010\1CTL_AMPDU\2CTL_ASSIGN_SEQ\3CTL_NO_ACK\4CTL_SEND_AFTER_DTIM"	\
479     "\5CTL_TX_OFFCHAN\6CTL_REQ_TX_STATUS"				\
480     "\7STATUS_EOSP\10STAT_ACK\11STAT_AMPDU\12STAT_AMPDU_NO_BACK"	\
481     "\13STAT_TX_FILTERED\14STAT_NOACK_TRANSMITTED"			\
482     "\15CTL_FIRST_FRAGMENT\16INTFL_DONT_ENCRYPT\17CTL_NO_CCK_RATE"	\
483     "\20CTL_INJECTED\21CTL_HW_80211_ENCAP\22CTL_USE_MINRATE"		\
484     "\23CTL_RATE_CTRL_PROBE\24CTL_LDPC\25CTL_STBC"
485 
486 enum ieee80211_tx_status_flags {
487 	IEEE80211_TX_STATUS_ACK_SIGNAL_VALID	= BIT(0),
488 };
489 #define	IEEE80211_TX_STATUS_FLAGS					\
490     "\010\1ACK_SIGNAL_VALID"
491 
492 enum ieee80211_tx_control_flags {
493 	/* XXX TODO .. right shift numbers */
494 	IEEE80211_TX_CTRL_PORT_CTRL_PROTO	= BIT(0),
495 	IEEE80211_TX_CTRL_PS_RESPONSE		= BIT(1),
496 	IEEE80211_TX_CTRL_RATE_INJECT		= BIT(2),
497 	IEEE80211_TX_CTRL_DONT_USE_RATE_MASK	= BIT(3),
498 	IEEE80211_TX_CTRL_MLO_LINK		= 0xF0000000,	/* This is IEEE80211_LINK_UNSPECIFIED on the high bits. */
499 };
500 
501 #define	IEEE80211_RNR_TBTT_PARAMS_PSD_RESERVED	-128
502 
503 #define	IEEE80211_HT_CTL_LEN	4
504 
505 struct ieee80211_hdr {		/* net80211::ieee80211_frame_addr4 */
506         __le16		frame_control;
507         __le16		duration_id;
508 	uint8_t		addr1[ETH_ALEN];
509 	uint8_t		addr2[ETH_ALEN];
510 	uint8_t		addr3[ETH_ALEN];
511 	__le16		seq_ctrl;
512 	uint8_t		addr4[ETH_ALEN];
513 };
514 
515 struct ieee80211_hdr_3addr {	/* net80211::ieee80211_frame */
516         __le16		frame_control;
517         __le16		duration_id;
518 	uint8_t		addr1[ETH_ALEN];
519 	uint8_t		addr2[ETH_ALEN];
520 	uint8_t		addr3[ETH_ALEN];
521 	__le16		seq_ctrl;
522 };
523 
524 struct ieee80211_qos_hdr {	/* net80211:ieee80211_qosframe */
525         __le16		frame_control;
526         __le16		duration_id;
527 	uint8_t		addr1[ETH_ALEN];
528 	uint8_t		addr2[ETH_ALEN];
529 	uint8_t		addr3[ETH_ALEN];
530 	__le16		seq_ctrl;
531 	__le16		qos_ctrl;
532 };
533 
534 struct ieee80211_vendor_ie {
535 };
536 
537 /* 802.11-2020, Table 9-359-Block Ack Action field values */
538 enum ieee80211_back {
539 	WLAN_ACTION_ADDBA_REQ		= 0,
540 };
541 
542 enum ieee80211_sa_query {
543 	WLAN_ACTION_SA_QUERY_RESPONSE	= 1,
544 };
545 
546 /* 802.11-2020, Table 9-51-Category values */
547 enum ieee80211_category {
548 	WLAN_CATEGORY_BACK		= 3,
549 	WLAN_CATEGORY_SA_QUERY		= 8,	/* net80211::IEEE80211_ACTION_CAT_SA_QUERY */
550 	WLAN_CATEGORY_VHT		= 21,
551 };
552 
553 /* 80211-2020 9.3.3.2 Format of Management frames */
554 struct ieee80211_mgmt {
555 	__le16		frame_control;
556         __le16		duration_id;
557 	uint8_t		da[ETH_ALEN];
558 	uint8_t		sa[ETH_ALEN];
559 	uint8_t		bssid[ETH_ALEN];
560 	__le16		seq_ctrl;
561 	union {
562 		/* 9.3.3.3 Beacon frame format */
563 		struct {
564 			uint64_t	timestamp;
565 			uint16_t	beacon_int;
566 			uint16_t	capab_info;
567 			uint8_t		variable[0];
568 		} __packed beacon;
569 		/* 9.3.3.5 Association Request frame format */
570 		struct  {
571 			uint16_t	capab_info;
572 			uint16_t	listen_interval;
573 			uint8_t		variable[0];
574 		} __packed assoc_req;
575 		/* 9.3.3.6 Association Response frame format */
576 		/* 9.3.3.8 Reassociation Response frame format */
577 		struct {
578 			uint16_t	capab_info;
579 			uint16_t	status_code;
580 			uint16_t	aid;
581 			uint8_t		variable[0];
582 		} __packed assoc_resp, reassoc_resp;
583 		/* 9.3.3.10 Probe Request frame format */
584 		struct {
585 			uint8_t		variable[0];
586 		} __packed probe_req;
587 		/* 9.3.3.11 Probe Response frame format */
588 		struct {
589 			uint64_t	timestamp;
590 			uint16_t	beacon_int;
591 			uint16_t	capab_info;
592 			uint8_t		variable[0];
593 		} __packed probe_resp;
594 		/* 9.3.3.14 Action frame format */
595 		struct {
596 			/* 9.4.1.11 Action field */
597 			uint8_t		category;
598 			/* 9.6.8 Public Action details */
599 			union {
600 				/* 9.6.2.5 TPC Report frame format */
601 				struct {
602 					uint8_t spec_mgmt;
603 					uint8_t dialog_token;
604 					/* uint32_t tpc_rep_elem:: */
605 					uint8_t tpc_elem_id;
606 					uint8_t tpc_elem_length;
607 					uint8_t tpc_elem_tx_power;
608 					uint8_t tpc_elem_link_margin;
609 				} __packed tpc_report;
610 				/* 802.11-2024, 9.6.7.32 FTM Request frame format */
611 				struct {
612 					uint8_t	public_action;
613 					uint8_t trigger;
614 					uint8_t variable[0];
615 				} __packed ftmr;
616 				/* 802.11az-2022, 9.6.7.33 Fine Timing Measurement (FTM) frame format */
617 				/* XXX CHANGED IN 802.11-2024, 9.6.7.33 Fine Timing Measurement frame format */
618 				struct {
619 					uint8_t	public_action;
620 					uint8_t dialog_token;
621 					uint8_t follow_up;
622 					uint8_t tod[6];
623 					uint8_t toa[6];
624 					uint16_t tod_error;
625 					uint16_t toa_error;
626 					uint8_t variable[0];
627 				} __packed ftm;
628 				/* 802.11-2024, 9.6.4.2 ADDBA Request frame format */
629 				struct {
630 					uint8_t action_code;
631 					uint8_t dialog_token;
632 					uint16_t capab;
633 					uint16_t timeout;
634 					uint16_t start_seq_num;
635 					/* Optional follows... */
636 					uint8_t variable[0];
637 				} __packed addba_req;
638 				/* 802.11-2024, 9.6.13.3 Event Report frame format */
639 				struct {
640 					uint8_t wnm_action;
641 					uint8_t dialog_token;
642 					/* Optional follows... */
643 					uint8_t variable[0];
644 				} __packed wnm_timing_msr;
645 			} u;
646 		} __packed action;
647 		DECLARE_FLEX_ARRAY(uint8_t, body);
648 	} u;
649 } __packed __aligned(2);
650 
651 #define	IEEE80211_MIN_ACTION_SIZE	offsetof(struct ieee80211_mgmt, u.action.u)
652 
653 struct ieee80211_cts {		/* net80211::ieee80211_frame_cts */
654         __le16		frame_control;
655         __le16		duration;
656 	uint8_t		ra[ETH_ALEN];
657 } __packed;
658 
659 struct ieee80211_rts {		/* net80211::ieee80211_frame_rts */
660         __le16		frame_control;
661         __le16		duration;
662 	uint8_t		ra[ETH_ALEN];
663 	uint8_t		ta[ETH_ALEN];
664 } __packed;
665 
666 #define	MHZ_TO_KHZ(_f)		((_f) * 1000)
667 #define	DBI_TO_MBI(_g)		((_g) * 100)
668 #define	MBI_TO_DBI(_x)		((_x) / 100)
669 #define	DBM_TO_MBM(_g)		((_g) * 100)
670 #define	MBM_TO_DBM(_x)		((_x) / 100)
671 
672 #define	IEEE80211_SEQ_TO_SN(_seqn)	(((_seqn) & IEEE80211_SEQ_SEQ_MASK) >> \
673 					    IEEE80211_SEQ_SEQ_SHIFT)
674 #define	IEEE80211_SN_TO_SEQ(_sn)	(((_sn) << IEEE80211_SEQ_SEQ_SHIFT) & \
675 					    IEEE80211_SEQ_SEQ_MASK)
676 
677 /* Time unit (TU) to .. See net80211: IEEE80211_DUR_TU */
678 #define	TU_TO_JIFFIES(_tu)	(usecs_to_jiffies(_tu) * 1024)
679 #define	TU_TO_EXP_TIME(_tu)	(jiffies + TU_TO_JIFFIES(_tu))
680 
681 /* 9.4.2.21.1, Table 9-82. */
682 #define	IEEE80211_SPCT_MSR_RPRT_TYPE_LCI	8
683 #define	IEEE80211_SPCT_MSR_RPRT_TYPE_CIVIC	11
684 
685 /* 9.4.2.1, Table 9-77. Element IDs. */
686 enum ieee80211_eid {
687 	WLAN_EID_SSID				= 0,
688 	WLAN_EID_SUPP_RATES			= 1,
689 	WLAN_EID_DS_PARAMS			= 3,
690 	WLAN_EID_TIM				= 5,
691 	WLAN_EID_COUNTRY			= 7,	/* IEEE80211_ELEMID_COUNTRY */
692 	WLAN_EID_REQUEST			= 10,
693 	WLAN_EID_QBSS_LOAD			= 11,	/* IEEE80211_ELEMID_BSSLOAD */
694 	WLAN_EID_CHANNEL_SWITCH			= 37,
695 	WLAN_EID_MEASURE_REPORT			= 39,
696 	WLAN_EID_HT_CAPABILITY			= 45,	/* IEEE80211_ELEMID_HTCAP */
697 	WLAN_EID_RSN				= 48,	/* IEEE80211_ELEMID_RSN */
698 	WLAN_EID_EXT_SUPP_RATES			= 50,
699 	WLAN_EID_EXT_NON_INHERITANCE		= 56,
700 	WLAN_EID_EXT_CHANSWITCH_ANN		= 60,
701 	WLAN_EID_HT_OPERATION			= 61,	/* IEEE80211_ELEMID_HTINFO */
702 	WLAN_EID_MULTIPLE_BSSID			= 71,	/* IEEE80211_ELEMID_MULTIBSSID */
703 	WLAN_EID_MULTI_BSSID_IDX		= 85,
704 	WLAN_EID_EXT_CAPABILITY			= 127,
705 	WLAN_EID_VHT_CAPABILITY			= 191,	/* IEEE80211_ELEMID_VHT_CAP */
706 	WLAN_EID_S1G_TWT			= 216,
707 	WLAN_EID_VENDOR_SPECIFIC		= 221,	/* IEEE80211_ELEMID_VENDOR */
708 };
709 
710 enum ieee80211_eid_ext {
711 	WLAN_EID_EXT_HE_CAPABILITY		= 35,
712 };
713 
714 #define	for_each_element(_elem, _data, _len) \
715 	for (_elem = (const struct element *)(_data); \
716 	    (((const uint8_t *)(_data) + (_len) - (const uint8_t *)_elem) >= sizeof(*_elem)) && \
717 		(((const uint8_t *)(_data) + (_len) - (const uint8_t *)_elem) >= (sizeof(*_elem) + _elem->datalen)); \
718 	    _elem = (const struct element *)(_elem->data + _elem->datalen))
719 
720 #define	for_each_element_id(_elem, _eid, _data, _len) \
721 	for_each_element(_elem, _data, _len) \
722 		if (_elem->id == (_eid))
723 
724 /* 9.4.1.7, Table 9-45. Reason codes. */
725 enum ieee80211_reason_code {
726 	/* reserved				= 0, */
727 	WLAN_REASON_UNSPECIFIED			= 1,
728 	WLAN_REASON_DEAUTH_LEAVING		= 3,	/* LEAVING_NETWORK_DEAUTH */
729 	WLAN_REASON_TDLS_TEARDOWN_UNREACHABLE	= 25,
730 	WLAN_REASON_TDLS_TEARDOWN_UNSPECIFIED	= 26,
731 };
732 
733 /* 9.4.1.9, Table 9-46. Status codes. */
734 enum ieee80211_status_code {
735 	WLAN_STATUS_SUCCESS			= 0,
736 	WLAN_STATUS_AUTH_TIMEOUT		= 16,	/* REJECTED_SEQUENCE_TIMEOUT */
737 };
738 
739 /* 9.3.1.22 Trigger frame format; 80211ax-2021 */
740 struct ieee80211_trigger {
741         __le16		frame_control;
742         __le16		duration_id;
743 	uint8_t		ra[ETH_ALEN];
744 	uint8_t		ta[ETH_ALEN];
745 	__le64		common_info;		/* 8+ really */
746 	uint8_t		variable[];
747 };
748 
749 /* Table 9-29c-Trigger Type subfield encoding */
750 enum {
751 	IEEE80211_TRIGGER_TYPE_BASIC		= 0x0,
752 	IEEE80211_TRIGGER_TYPE_BFRP		= 0x1,
753 	IEEE80211_TRIGGER_TYPE_MU_BAR		= 0x2,
754 	IEEE80211_TRIGGER_TYPE_MU_RTS		= 0x3,
755 	IEEE80211_TRIGGER_TYPE_BSRP		= 0x4,
756 	IEEE80211_TRIGGER_TYPE_BQRP		= 0x6,
757 	IEEE80211_TRIGGER_TYPE_NFRP		= 0x7,
758 #if 0
759 	/* Not seen yet. */
760 	GCR MU-BAR				= 0x5,
761 	/* 0x8..0xf reserved */
762 #endif
763 	IEEE80211_TRIGGER_TYPE_MASK		= 0xf
764 };
765 
766 #define	IEEE80211_TRIGGER_ULBW_MASK		0xc0000
767 #define	IEEE80211_TRIGGER_ULBW_20MHZ		0x0
768 #define	IEEE80211_TRIGGER_ULBW_40MHZ		0x1
769 #define	IEEE80211_TRIGGER_ULBW_80MHZ		0x2
770 #define	IEEE80211_TRIGGER_ULBW_160_80P80MHZ	0x3
771 
772 /* 802.11-2020, Figure 9-687-Control field format; 802.11ax-2021 */
773 #define	IEEE80211_TWT_CONTROL_NEG_TYPE_BROADCAST	BIT(3)
774 #define	IEEE80211_TWT_CONTROL_RX_DISABLED		BIT(4)
775 #define	IEEE80211_TWT_CONTROL_WAKE_DUR_UNIT		BIT(5)
776 
777 /* 802.11-2020, Figure 9-688-Request Type field format; 802.11ax-2021 */
778 #define	IEEE80211_TWT_REQTYPE_SETUP_CMD		(BIT(1) | BIT(2) | BIT(3))
779 #define	IEEE80211_TWT_REQTYPE_TRIGGER		BIT(4)
780 #define	IEEE80211_TWT_REQTYPE_IMPLICIT		BIT(5)
781 #define	IEEE80211_TWT_REQTYPE_FLOWTYPE		BIT(6)
782 #define	IEEE80211_TWT_REQTYPE_FLOWID		(BIT(7) | BIT(8) | BIT(9))
783 #define	IEEE80211_TWT_REQTYPE_WAKE_INT_EXP	(BIT(10) | BIT(11) | BIT(12) | BIT(13) | BIT(14))
784 #define	IEEE80211_TWT_REQTYPE_PROTECTION	BIT(15)
785 
786 struct ieee80211_twt_params {
787 	int	mantissa, min_twt_dur, twt;
788 	uint16_t				req_type;
789 };
790 
791 struct ieee80211_twt_setup {
792 	int	control;
793 	struct ieee80211_twt_params		*params;
794 };
795 
796 /* 802.11-2020, Table 9-297-TWT Setup Command field values */
797 enum ieee80211_twt_setup_cmd {
798 	TWT_SETUP_CMD_REQUEST			= 0,
799 	TWT_SETUP_CMD_SUGGEST			= 1,
800 	/* DEMAND				= 2, */
801 	/* GROUPING				= 3, */
802 	TWT_SETUP_CMD_ACCEPT			= 4,
803 	/* ALTERNATE				= 5 */
804 	TWT_SETUP_CMD_DICTATE			= 6,
805 	TWT_SETUP_CMD_REJECT			= 7,
806 };
807 
808 struct ieee80211_bssid_index {
809 	int	bssid_index;
810 };
811 
812 enum ieee80211_ap_reg_power {
813 	IEEE80211_REG_UNSET_AP,
814 	IEEE80211_REG_LPI_AP,
815 	IEEE80211_REG_SP_AP,
816 	IEEE80211_REG_VLP_AP,
817 };
818 
819 /*
820  * 802.11ax-2021, Table 9-277-Meaning of Maximum Transmit Power Count subfield
821  * if Maximum Transmit Power Interpretation subfield is 1 or 3
822  */
823 #define	IEEE80211_MAX_NUM_PWR_LEVEL		8
824 
825 /*
826  * 802.11ax-2021, Table 9-275a-Maximum Transmit Power Interpretation subfield
827  * encoding (4) * Table E-12-Regulatory Info subfield encoding in the
828  * United States (2)
829  */
830 #define	IEEE80211_TPE_MAX_IE_NUM		8
831 
832 /* 802.11ax-2021, 9.4.2.161 Transmit Power Envelope element */
833 struct ieee80211_tx_pwr_env {
834 	uint8_t		tx_power_info;
835 	uint8_t		tx_power[IEEE80211_MAX_NUM_PWR_LEVEL];
836 };
837 
838 /* 802.11ax-2021, Figure 9-617-Transmit Power Information field format */
839 /* These are field masks (3bit/3bit/2bit). */
840 #define	IEEE80211_TX_PWR_ENV_INFO_COUNT		0x07
841 #define	IEEE80211_TX_PWR_ENV_INFO_INTERPRET	0x38
842 #define	IEEE80211_TX_PWR_ENV_INFO_CATEGORY	0xc0
843 
844 /*
845  * 802.11ax-2021, Table 9-275a-Maximum Transmit Power Interpretation subfield
846  * encoding
847  */
848 enum ieee80211_tx_pwr_interpretation_subfield_enc {
849 	IEEE80211_TPE_LOCAL_EIRP,
850 	IEEE80211_TPE_LOCAL_EIRP_PSD,
851 	IEEE80211_TPE_REG_CLIENT_EIRP,
852 	IEEE80211_TPE_REG_CLIENT_EIRP_PSD,
853 };
854 
855 enum ieee80211_tx_pwr_category_6ghz {
856 	IEEE80211_TPE_CAT_6GHZ_DEFAULT,
857 };
858 
859 /* 802.11-2020, 9.4.2.27 BSS Load element */
860 struct ieee80211_bss_load_elem {
861 	uint16_t				sta_count;
862 	uint8_t					channel_util;
863 	uint16_t				avail_adm_capa;
864 };
865 
866 struct ieee80211_p2p_noa_desc {
867 	uint32_t				count;		/* uint8_t ? */
868 	uint32_t				duration;
869 	uint32_t				interval;
870 	uint32_t				start_time;
871 };
872 
873 struct ieee80211_p2p_noa_attr {
874 	uint8_t					index;
875 	uint8_t					oppps_ctwindow;
876 	struct ieee80211_p2p_noa_desc		desc[4];
877 };
878 
879 
880 /* net80211: IEEE80211_IS_CTL() */
881 static __inline bool
882 ieee80211_is_ctl(__le16 fc)
883 {
884 	__le16 v;
885 
886 	fc &= htole16(IEEE80211_FC0_TYPE_MASK);
887 	v = htole16(IEEE80211_FC0_TYPE_CTL);
888 
889 	return (fc == v);
890 }
891 
892 /* net80211: IEEE80211_IS_DATA() */
893 static __inline bool
894 ieee80211_is_data(__le16 fc)
895 {
896 	__le16 v;
897 
898 	fc &= htole16(IEEE80211_FC0_TYPE_MASK);
899 	v = htole16(IEEE80211_FC0_TYPE_DATA);
900 
901 	return (fc == v);
902 }
903 
904 /* net80211: IEEE80211_IS_QOSDATA() */
905 static __inline bool
906 ieee80211_is_data_qos(__le16 fc)
907 {
908 	__le16 v;
909 
910 	fc &= htole16(IEEE80211_FC0_SUBTYPE_QOS_DATA | IEEE80211_FC0_TYPE_MASK);
911 	v = htole16(IEEE80211_FC0_SUBTYPE_QOS_DATA | IEEE80211_FC0_TYPE_DATA);
912 
913 	return (fc == v);
914 }
915 
916 /* net80211: IEEE80211_IS_MGMT() */
917 static __inline bool
918 ieee80211_is_mgmt(__le16 fc)
919 {
920 	__le16 v;
921 
922 	fc &= htole16(IEEE80211_FC0_TYPE_MASK);
923 	v = htole16(IEEE80211_FC0_TYPE_MGT);
924 
925 	return (fc == v);
926 }
927 
928 
929 /* Derived from net80211::ieee80211_anyhdrsize. */
930 static __inline unsigned int
931 ieee80211_hdrlen(__le16 fc)
932 {
933 	unsigned int size;
934 
935 	if (ieee80211_is_ctl(fc)) {
936 		switch (fc & htole16(IEEE80211_FC0_SUBTYPE_MASK)) {
937 		case htole16(IEEE80211_FC0_SUBTYPE_CTS):
938 		case htole16(IEEE80211_FC0_SUBTYPE_ACK):
939 			return sizeof(struct ieee80211_frame_ack);
940 		case htole16(IEEE80211_FC0_SUBTYPE_BAR):
941 			return sizeof(struct ieee80211_frame_bar);
942 		}
943 		return (sizeof(struct ieee80211_frame_min));
944 	}
945 
946 	size = sizeof(struct ieee80211_frame);
947 	if (ieee80211_is_data(fc)) {
948 		if ((fc & htole16(IEEE80211_FC1_DIR_MASK << 8)) ==
949 		    htole16(IEEE80211_FC1_DIR_DSTODS << 8))
950 			size += IEEE80211_ADDR_LEN;
951 		if ((fc & htole16(IEEE80211_FC0_SUBTYPE_QOS_DATA |
952 		    IEEE80211_FC0_TYPE_MASK)) ==
953 		    htole16(IEEE80211_FC0_SUBTYPE_QOS_DATA |
954 		    IEEE80211_FC0_TYPE_DATA))
955 			size += sizeof(uint16_t);
956 	}
957 
958 	if (ieee80211_is_mgmt(fc)) {
959 #ifdef __notyet__
960 		printf("XXX-BZ %s: TODO? fc %#04x size %u\n",
961 		    __func__, fc, size);
962 #endif
963 		;
964 	}
965 
966 	return (size);
967 }
968 
969 static inline bool
970 ieee80211_is_trigger(__le16 fc)
971 {
972 	__le16 v;
973 
974 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
975 	v = htole16(IEEE80211_FC0_SUBTYPE_TRIGGER | IEEE80211_FC0_TYPE_CTL);
976 
977 	return (fc == v);
978 }
979 
980 static __inline bool
981 ieee80211_is_action(__le16 fc)
982 {
983 	__le16 v;
984 
985 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
986 	v = htole16(IEEE80211_FC0_SUBTYPE_ACTION | IEEE80211_FC0_TYPE_MGT);
987 
988 	return (fc == v);
989 }
990 
991 static __inline bool
992 ieee80211_is_probe_resp(__le16 fc)
993 {
994 	__le16 v;
995 
996 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
997 	v = htole16(IEEE80211_FC0_SUBTYPE_PROBE_RESP | IEEE80211_FC0_TYPE_MGT);
998 
999 	return (fc == v);
1000 }
1001 
1002 static __inline bool
1003 ieee80211_is_auth(__le16 fc)
1004 {
1005 	__le16 v;
1006 
1007 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1008 	v = htole16(IEEE80211_FC0_SUBTYPE_AUTH | IEEE80211_FC0_TYPE_MGT);
1009 
1010 	return (fc == v);
1011 }
1012 
1013 static __inline bool
1014 ieee80211_is_assoc_req(__le16 fc)
1015 {
1016 	__le16 v;
1017 
1018 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1019 	v = htole16(IEEE80211_FC0_SUBTYPE_ASSOC_REQ | IEEE80211_FC0_TYPE_MGT);
1020 
1021 	return (fc == v);
1022 }
1023 
1024 static __inline bool
1025 ieee80211_is_assoc_resp(__le16 fc)
1026 {
1027 	__le16 v;
1028 
1029 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1030 	v = htole16(IEEE80211_FC0_SUBTYPE_ASSOC_RESP | IEEE80211_FC0_TYPE_MGT);
1031 
1032 	return (fc == v);
1033 }
1034 
1035 static __inline bool
1036 ieee80211_is_reassoc_req(__le16 fc)
1037 {
1038 	__le16 v;
1039 
1040 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1041 	v = htole16(IEEE80211_FC0_SUBTYPE_REASSOC_REQ | IEEE80211_FC0_TYPE_MGT);
1042 
1043 	return (fc == v);
1044 }
1045 
1046 static __inline bool
1047 ieee80211_is_reassoc_resp(__le16 fc)
1048 {
1049 	__le16 v;
1050 
1051 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1052 	v = htole16(IEEE80211_FC0_SUBTYPE_REASSOC_RESP | IEEE80211_FC0_TYPE_MGT);
1053 
1054 	return (fc == v);
1055 }
1056 
1057 static __inline bool
1058 ieee80211_is_disassoc(__le16 fc)
1059 {
1060 	__le16 v;
1061 
1062 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1063 	v = htole16(IEEE80211_FC0_SUBTYPE_DISASSOC | IEEE80211_FC0_TYPE_MGT);
1064 
1065 	return (fc == v);
1066 }
1067 
1068 static __inline bool
1069 ieee80211_is_data_present(__le16 fc)
1070 {
1071 	__le16 v;
1072 
1073 	/* If it is a data frame and NODATA is not present. */
1074 	fc &= htole16(IEEE80211_FC0_TYPE_MASK | IEEE80211_FC0_SUBTYPE_NODATA);
1075 	v = htole16(IEEE80211_FC0_TYPE_DATA);
1076 
1077 	return (fc == v);
1078 }
1079 
1080 static __inline bool
1081 ieee80211_is_deauth(__le16 fc)
1082 {
1083 	__le16 v;
1084 
1085 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1086 	v = htole16(IEEE80211_FC0_SUBTYPE_DEAUTH | IEEE80211_FC0_TYPE_MGT);
1087 
1088 	return (fc == v);
1089 }
1090 
1091 static __inline bool
1092 ieee80211_is_beacon(__le16 fc)
1093 {
1094 	__le16 v;
1095 
1096 	/*
1097 	 * For as much as I get it this comes in LE and unlike FreeBSD
1098 	 * where we get the entire frame header and u8[], here we get the
1099 	 * 9.2.4.1 Frame Control field only. Mask and compare.
1100 	 */
1101 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1102 	v = htole16(IEEE80211_FC0_SUBTYPE_BEACON | IEEE80211_FC0_TYPE_MGT);
1103 
1104 	return (fc == v);
1105 }
1106 
1107 
1108 static __inline bool
1109 ieee80211_is_probe_req(__le16 fc)
1110 {
1111 	__le16 v;
1112 
1113 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1114 	v = htole16(IEEE80211_FC0_SUBTYPE_PROBE_REQ | IEEE80211_FC0_TYPE_MGT);
1115 
1116 	return (fc == v);
1117 }
1118 
1119 static __inline bool
1120 ieee80211_has_protected(__le16 fc)
1121 {
1122 
1123 	return (fc & htole16(IEEE80211_FC1_PROTECTED << 8));
1124 }
1125 
1126 static __inline bool
1127 ieee80211_is_back_req(__le16 fc)
1128 {
1129 	__le16 v;
1130 
1131 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1132 	v = htole16(IEEE80211_FC0_SUBTYPE_BAR | IEEE80211_FC0_TYPE_CTL);
1133 
1134 	return (fc == v);
1135 }
1136 
1137 static __inline bool
1138 ieee80211_is_bufferable_mmpdu(struct sk_buff *skb)
1139 {
1140 	struct ieee80211_mgmt *mgmt;
1141 	__le16 fc;
1142 
1143 	KASSERT(skb->len >= sizeof(fc), ("%s: skb %p short len %d\n",
1144 	    __func__, skb, skb->len));
1145 
1146 	mgmt = (struct ieee80211_mgmt *)skb->data;
1147 	fc = mgmt->frame_control;
1148 
1149 	/* 11.2.2 Bufferable MMPDUs, 802.11-2024. */
1150 	IMPROVE("XXX IBBS");
1151 
1152 	if (!ieee80211_is_mgmt(fc))
1153 		return (false);
1154 	if (ieee80211_is_disassoc(fc))
1155 		return (true);
1156 	if (ieee80211_is_deauth(fc))
1157 		return (true);
1158 	if (!ieee80211_is_action(fc))
1159 		return (false);
1160 
1161 	/*
1162 	 * Now we know it is an action frame, so we can check for a proper
1163 	 * length before accessing any further data to check if it is an
1164 	 * FTM/FTMR, which is non-bufferable.
1165 	 * 9.6.7.32 FTM Request frame format
1166 	 * 9.6.7.33 FTM frame format
1167 	 */
1168 	if (skb->len < offsetofend(typeof(*mgmt), u.action.u.ftm.public_action))
1169 		return (false);
1170 
1171 	if (mgmt->u.action.category != IEEE80211_ACTION_CAT_PUBLIC)
1172 		return (false);
1173 
1174 	if (mgmt->u.action.u.ftm.public_action == 33 ||	/* FTM xxx defines? */
1175 	    mgmt->u.action.u.ftmr.public_action == 32) /* FTMR xxx defines? */
1176 		return (false);
1177 
1178 	return (true);
1179 }
1180 
1181 static __inline bool
1182 ieee80211_is_nullfunc(__le16 fc)
1183 {
1184 	__le16 v;
1185 
1186 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1187 	v = htole16(IEEE80211_FC0_SUBTYPE_NODATA | IEEE80211_FC0_TYPE_DATA);
1188 
1189 	return (fc == v);
1190 }
1191 
1192 static __inline bool
1193 ieee80211_is_qos_nullfunc(__le16 fc)
1194 {
1195 	__le16 v;
1196 
1197 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1198 	v = htole16(IEEE80211_FC0_SUBTYPE_QOS_NULL | IEEE80211_FC0_TYPE_DATA);
1199 
1200 	return (fc == v);
1201 }
1202 
1203 static __inline bool
1204 ieee80211_is_any_nullfunc(__le16 fc)
1205 {
1206 
1207 	return (ieee80211_is_nullfunc(fc) || ieee80211_is_qos_nullfunc(fc));
1208 }
1209 
1210 static inline bool
1211 ieee80211_is_pspoll(__le16 fc)
1212 {
1213 	__le16 v;
1214 
1215 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1216 	v = htole16(IEEE80211_FC0_SUBTYPE_PS_POLL | IEEE80211_FC0_TYPE_CTL);
1217 
1218 	return (fc == v);
1219 }
1220 
1221 static __inline bool
1222 ieee80211_has_a4(__le16 fc)
1223 {
1224 	__le16 v;
1225 
1226 	fc &= htole16((IEEE80211_FC1_DIR_TODS | IEEE80211_FC1_DIR_FROMDS) << 8);
1227 	v = htole16((IEEE80211_FC1_DIR_TODS | IEEE80211_FC1_DIR_FROMDS) << 8);
1228 
1229 	return (fc == v);
1230 }
1231 
1232 static __inline bool
1233 ieee80211_has_order(__le16 fc)
1234 {
1235 
1236 	return (fc & htole16(IEEE80211_FC1_ORDER << 8));
1237 }
1238 
1239 static __inline bool
1240 ieee80211_has_retry(__le16 fc)
1241 {
1242 
1243 	return (fc & htole16(IEEE80211_FC1_RETRY << 8));
1244 }
1245 
1246 
1247 static __inline bool
1248 ieee80211_has_fromds(__le16 fc)
1249 {
1250 
1251 	return (fc & htole16(IEEE80211_FC1_DIR_FROMDS << 8));
1252 }
1253 
1254 static __inline bool
1255 ieee80211_has_tods(__le16 fc)
1256 {
1257 
1258 	return (fc & htole16(IEEE80211_FC1_DIR_TODS << 8));
1259 }
1260 
1261 static __inline uint8_t *
1262 ieee80211_get_SA(struct ieee80211_hdr *hdr)
1263 {
1264 
1265 	if (ieee80211_has_a4(hdr->frame_control))
1266 		return (hdr->addr4);
1267 	if (ieee80211_has_fromds(hdr->frame_control))
1268 		return (hdr->addr3);
1269 	return (hdr->addr2);
1270 }
1271 
1272 static __inline uint8_t *
1273 ieee80211_get_DA(struct ieee80211_hdr *hdr)
1274 {
1275 
1276 	if (ieee80211_has_tods(hdr->frame_control))
1277 		return (hdr->addr3);
1278 	return (hdr->addr1);
1279 }
1280 
1281 static __inline bool
1282 ieee80211_has_morefrags(__le16 fc)
1283 {
1284 
1285 	fc &= htole16(IEEE80211_FC1_MORE_FRAG << 8);
1286 	return (fc != 0);
1287 }
1288 
1289 static __inline bool
1290 ieee80211_is_frag(struct ieee80211_hdr *hdr)
1291 {
1292 	return (ieee80211_has_morefrags(hdr->frame_control) ||
1293 	    (hdr->seq_ctrl & htole16(IEEE80211_SEQ_FRAG_MASK)) != 0);
1294 }
1295 
1296 static __inline bool
1297 ieee80211_is_first_frag(__le16 seq_ctrl)
1298 {
1299 	return ((seq_ctrl & htole16(IEEE80211_SEQ_FRAG_MASK)) == 0);
1300 }
1301 
1302 static __inline bool
1303 ieee80211_is_robust_mgmt_frame(struct sk_buff *skb)
1304 {
1305 	struct ieee80211_mgmt *mgmt;
1306 
1307 	if (skb->len < sizeof(mgmt->frame_control))
1308 		return (false);
1309 	mgmt = (struct ieee80211_mgmt *)skb->data;
1310 
1311 	/* 802.11-2024, 12.2.7 Requirements for management frame protection */
1312 
1313 	if (ieee80211_is_disassoc(mgmt->frame_control))
1314 		return (true);
1315 	if (ieee80211_is_deauth(mgmt->frame_control))
1316 		return (true);
1317 
1318 	if (!ieee80211_is_action(mgmt->frame_control))
1319 		return (false);
1320 
1321 	/*
1322 	 * If the action frame is a protected frame the peer has already
1323 	 * decided that it is a robust mgmt frame.
1324 	 * This is not exactly in the books but maintaining the below
1325 	 * table will go out of sync eventually and this can save us.
1326 	 */
1327 	if (ieee80211_has_protected(mgmt->frame_control))
1328 		return (true);
1329 
1330 	/*
1331 	 * 802.11-2024, 9.4.1.11 Action Fields,
1332 	 * Table 9-81-Category values;  check for the ones marked Robust: no.
1333 	 */
1334 	/* Check length again before accessing more data. */
1335 	if (skb->len < offsetofend(typeof(*mgmt), u.action.category))
1336 		return (false);
1337 
1338 	switch (mgmt->u.action.category) {
1339 	case 4:		/* Public */
1340 	case 7:		/* HT */
1341 	case 11:	/* Unprotected WNM */
1342 	/* 12 */	/* TDLS */
1343 	case 15:	/* Self-protected */
1344 	case 20:	/* Unprotected DMG */
1345 	case 21:	/* VHT */
1346 	case 22:	/* Unprotected S1G */
1347 	case 30:	/* HE */
1348 	case 127:	/* Vendor-specific */
1349 		return (false);
1350 	default:
1351 		return (true);
1352 	}
1353 }
1354 
1355 static __inline bool
1356 ieee80211_is_ftm(struct sk_buff *skb)
1357 {
1358 	struct ieee80211_mgmt *mgmt;
1359 
1360 	/* First check length before accessing data. */
1361 	if (skb->len < offsetofend(typeof(*mgmt), u.action.u.ftm.public_action))
1362 		return (false);
1363 
1364 	mgmt = (struct ieee80211_mgmt *)skb->data;
1365 	if (!ieee80211_is_action(mgmt->frame_control))
1366 		return (false);
1367 	if (mgmt->u.action.category != IEEE80211_ACTION_CAT_PUBLIC)
1368 		return (false);
1369 	if (mgmt->u.action.u.ftm.public_action == 33)	/* FTM xxx defines? */
1370 		return (true);
1371 
1372 	return (false);
1373 }
1374 
1375 static __inline bool
1376 ieee80211_is_timing_measurement(struct sk_buff *skb)
1377 {
1378         struct ieee80211_mgmt *mgmt;
1379 
1380 	/* First check length before accessing data. */
1381 	if (skb->len < offsetofend(typeof(*mgmt), u.action.u.wnm_timing_msr.wnm_action))
1382 		return (false);
1383 
1384 	mgmt = (struct ieee80211_mgmt *)skb->data;
1385 	if (!ieee80211_is_action(mgmt->frame_control))
1386 		return (false);
1387 
1388 	if (mgmt->u.action.category != IEEE80211_ACTION_CAT_UNPROTECTED_WNM)
1389 		return (false);
1390 	if (mgmt->u.action.u.wnm_timing_msr.wnm_action == 1)	/* Event Report xxx defines? */
1391 		return (true);
1392 
1393 	return (false);
1394 }
1395 
1396 static __inline bool
1397 ieee80211_has_pm(__le16 fc)
1398 {
1399 	fc &= htole16(IEEE80211_FC1_PWR_MGT << 8);
1400 	return (fc != 0);
1401 }
1402 
1403 static __inline u8 *
1404 ieee80211_get_qos_ctl(struct ieee80211_hdr *hdr)
1405 {
1406         if (ieee80211_has_a4(hdr->frame_control))
1407                 return (u8 *)hdr + 30;
1408         else
1409                 return (u8 *)hdr + 24;
1410 }
1411 
1412 #endif	/* _LINUXKPI_LINUX_IEEE80211_H */
1413