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