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