xref: /freebsd/sys/compat/linuxkpi/common/include/linux/ieee80211.h (revision 0567484734ad9732978e189ebed042f6320e2471)
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 #define	IEEE80211_MLD_CAP_OP_LINK_RECONF_SUPPORT		0x2000
316 
317 struct ieee80211_mcs_info {
318 	uint8_t		rx_mask[IEEE80211_HT_MCS_MASK_LEN];
319 	uint16_t	rx_highest;
320 	uint8_t		tx_params;
321 	uint8_t		__reserved[3];
322 } __packed;
323 
324 /* 802.11-2020, 9.4.2.55.1 HT Capabilities element structure */
325 struct ieee80211_ht_cap {
326 	uint16_t				cap_info;
327 	uint8_t					ampdu_params_info;
328 	struct ieee80211_mcs_info		mcs;
329 	uint16_t				extended_ht_cap_info;
330 	uint32_t				tx_BF_cap_info;
331 	uint8_t					antenna_selection_info;
332 } __packed;
333 
334 #define	IEEE80211_HT_MAX_AMPDU_FACTOR		13
335 #define	IEEE80211_HE_HT_MAX_AMPDU_FACTOR	16
336 #define	IEEE80211_HE_VHT_MAX_AMPDU_FACTOR	20
337 #define	IEEE80211_HE_6GHZ_MAX_AMPDU_FACTOR	13
338 
339 enum ieee80211_ht_max_ampdu_len {
340 	IEEE80211_HT_MAX_AMPDU_64K
341 };
342 
343 enum ieee80211_ampdu_mlme_action {
344 	IEEE80211_AMPDU_RX_START,
345 	IEEE80211_AMPDU_RX_STOP,
346 	IEEE80211_AMPDU_TX_OPERATIONAL,
347 	IEEE80211_AMPDU_TX_START,
348 	IEEE80211_AMPDU_TX_STOP_CONT,
349 	IEEE80211_AMPDU_TX_STOP_FLUSH,
350 	IEEE80211_AMPDU_TX_STOP_FLUSH_CONT
351 };
352 
353 #define	IEEE80211_AMPDU_TX_START_IMMEDIATE	1
354 #define	IEEE80211_AMPDU_TX_START_DELAY_ADDBA	2
355 
356 enum ieee80211_chanctx_switch_mode {
357 	CHANCTX_SWMODE_REASSIGN_VIF,
358 	CHANCTX_SWMODE_SWAP_CONTEXTS,
359 };
360 
361 enum ieee80211_chanctx_change_flags {
362 	IEEE80211_CHANCTX_CHANGE_MIN_WIDTH	= BIT(0),
363 	IEEE80211_CHANCTX_CHANGE_RADAR		= BIT(1),
364 	IEEE80211_CHANCTX_CHANGE_RX_CHAINS	= BIT(2),
365 	IEEE80211_CHANCTX_CHANGE_WIDTH		= BIT(3),
366 	IEEE80211_CHANCTX_CHANGE_CHANNEL	= BIT(4),
367 	IEEE80211_CHANCTX_CHANGE_PUNCTURING	= BIT(5),
368 	IEEE80211_CHANCTX_CHANGE_MIN_DEF	= BIT(6),
369 	IEEE80211_CHANCTX_CHANGE_AP		= BIT(7),
370 };
371 
372 enum ieee80211_frame_release_type {
373 	IEEE80211_FRAME_RELEASE_PSPOLL		= 1,
374 	IEEE80211_FRAME_RELEASE_UAPSD		= 2,
375 };
376 
377 enum ieee80211_p2p_attr_ids {
378 	IEEE80211_P2P_ATTR_DEVICE_ID,
379 	IEEE80211_P2P_ATTR_DEVICE_INFO,
380 	IEEE80211_P2P_ATTR_GROUP_ID,
381 	IEEE80211_P2P_ATTR_LISTEN_CHANNEL,
382 	IEEE80211_P2P_ATTR_ABSENCE_NOTICE,
383 };
384 
385 enum ieee80211_reconfig_type {
386 	IEEE80211_RECONFIG_TYPE_RESTART,
387 	IEEE80211_RECONFIG_TYPE_SUSPEND,
388 };
389 
390 enum ieee80211_roc_type {
391 	IEEE80211_ROC_TYPE_MGMT_TX,
392 	IEEE80211_ROC_TYPE_NORMAL,
393 };
394 
395 enum ieee80211_smps_mode {
396 	IEEE80211_SMPS_OFF,
397 	IEEE80211_SMPS_STATIC,
398 	IEEE80211_SMPS_DYNAMIC,
399 	IEEE80211_SMPS_AUTOMATIC,
400 	IEEE80211_SMPS_NUM_MODES,
401 };
402 
403 /* net80211::IEEE80211_S_* different but represents the state machine. */
404 /* Note: order here is important! */
405 enum ieee80211_sta_state {
406 	IEEE80211_STA_NOTEXIST		= 0,
407 	IEEE80211_STA_NONE		= 1,
408 	IEEE80211_STA_AUTH		= 2,
409 	IEEE80211_STA_ASSOC		= 3,
410 	IEEE80211_STA_AUTHORIZED	= 4,	/* 802.1x */
411 };
412 
413 enum ieee80211_sta_rx_bandwidth {
414 	IEEE80211_STA_RX_BW_20		= 0,
415 	IEEE80211_STA_RX_BW_40,
416 	IEEE80211_STA_RX_BW_80,
417 	IEEE80211_STA_RX_BW_160,
418 	IEEE80211_STA_RX_BW_320,
419 };
420 
421 enum ieee80211_tx_info_flags {
422 	/* XXX TODO .. right shift numbers - not sure where that came from? */
423 	IEEE80211_TX_CTL_AMPDU			= BIT(0),
424 	IEEE80211_TX_CTL_ASSIGN_SEQ		= BIT(1),
425 	IEEE80211_TX_CTL_NO_ACK			= BIT(2),
426 	IEEE80211_TX_CTL_SEND_AFTER_DTIM	= BIT(3),
427 	IEEE80211_TX_CTL_TX_OFFCHAN		= BIT(4),
428 	IEEE80211_TX_CTL_REQ_TX_STATUS		= BIT(5),
429 	IEEE80211_TX_STATUS_EOSP		= BIT(6),
430 	IEEE80211_TX_STAT_ACK			= BIT(7),
431 	IEEE80211_TX_STAT_AMPDU			= BIT(8),
432 	IEEE80211_TX_STAT_AMPDU_NO_BACK		= BIT(9),
433 	IEEE80211_TX_STAT_TX_FILTERED		= BIT(10),
434 	IEEE80211_TX_STAT_NOACK_TRANSMITTED	= BIT(11),
435 	IEEE80211_TX_CTL_FIRST_FRAGMENT		= BIT(12),
436 	IEEE80211_TX_INTFL_DONT_ENCRYPT		= BIT(13),
437 	IEEE80211_TX_CTL_NO_CCK_RATE		= BIT(14),
438 	IEEE80211_TX_CTL_INJECTED		= BIT(15),
439 	IEEE80211_TX_CTL_HW_80211_ENCAP		= BIT(16),
440 	IEEE80211_TX_CTL_USE_MINRATE		= BIT(17),
441 	IEEE80211_TX_CTL_RATE_CTRL_PROBE	= BIT(18),
442 	IEEE80211_TX_CTL_LDPC			= BIT(19),
443 	IEEE80211_TX_CTL_STBC			= BIT(20),
444 } __packed;
445 
446 enum ieee80211_tx_status_flags {
447 	IEEE80211_TX_STATUS_ACK_SIGNAL_VALID	= BIT(0),
448 };
449 
450 enum ieee80211_tx_control_flags {
451 	/* XXX TODO .. right shift numbers */
452 	IEEE80211_TX_CTRL_PORT_CTRL_PROTO	= BIT(0),
453 	IEEE80211_TX_CTRL_PS_RESPONSE		= BIT(1),
454 	IEEE80211_TX_CTRL_RATE_INJECT		= BIT(2),
455 	IEEE80211_TX_CTRL_DONT_USE_RATE_MASK	= BIT(3),
456 	IEEE80211_TX_CTRL_MLO_LINK		= 0xF0000000,	/* This is IEEE80211_LINK_UNSPECIFIED on the high bits. */
457 };
458 
459 enum ieee80211_tx_rate_flags {
460 	/* XXX TODO .. right shift numbers */
461 	IEEE80211_TX_RC_40_MHZ_WIDTH		= BIT(0),
462 	IEEE80211_TX_RC_80_MHZ_WIDTH		= BIT(1),
463 	IEEE80211_TX_RC_160_MHZ_WIDTH		= BIT(2),
464 	IEEE80211_TX_RC_GREEN_FIELD		= BIT(3),
465 	IEEE80211_TX_RC_MCS			= BIT(4),
466 	IEEE80211_TX_RC_SHORT_GI		= BIT(5),
467 	IEEE80211_TX_RC_VHT_MCS			= BIT(6),
468 	IEEE80211_TX_RC_USE_SHORT_PREAMBLE	= BIT(7),
469 };
470 
471 #define	IEEE80211_RNR_TBTT_PARAMS_PSD_RESERVED	-128
472 
473 #define	IEEE80211_HT_CTL_LEN	4
474 
475 struct ieee80211_hdr {		/* net80211::ieee80211_frame_addr4 */
476         __le16		frame_control;
477         __le16		duration_id;
478 	uint8_t		addr1[ETH_ALEN];
479 	uint8_t		addr2[ETH_ALEN];
480 	uint8_t		addr3[ETH_ALEN];
481 	__le16		seq_ctrl;
482 	uint8_t		addr4[ETH_ALEN];
483 };
484 
485 struct ieee80211_hdr_3addr {	/* net80211::ieee80211_frame */
486         __le16		frame_control;
487         __le16		duration_id;
488 	uint8_t		addr1[ETH_ALEN];
489 	uint8_t		addr2[ETH_ALEN];
490 	uint8_t		addr3[ETH_ALEN];
491 	__le16		seq_ctrl;
492 };
493 
494 struct ieee80211_qos_hdr {	/* net80211:ieee80211_qosframe */
495         __le16		frame_control;
496         __le16		duration_id;
497 	uint8_t		addr1[ETH_ALEN];
498 	uint8_t		addr2[ETH_ALEN];
499 	uint8_t		addr3[ETH_ALEN];
500 	__le16		seq_ctrl;
501 	__le16		qos_ctrl;
502 };
503 
504 struct ieee80211_vendor_ie {
505 };
506 
507 /* 802.11-2020, Table 9-359-Block Ack Action field values */
508 enum ieee80211_back {
509 	WLAN_ACTION_ADDBA_REQ		= 0,
510 };
511 
512 enum ieee80211_sa_query {
513 	WLAN_ACTION_SA_QUERY_RESPONSE	= 1,
514 };
515 
516 /* 802.11-2020, Table 9-51-Category values */
517 enum ieee80211_category {
518 	WLAN_CATEGORY_BACK		= 3,
519 	WLAN_CATEGORY_SA_QUERY		= 8,	/* net80211::IEEE80211_ACTION_CAT_SA_QUERY */
520 };
521 
522 /* 80211-2020 9.3.3.2 Format of Management frames */
523 struct ieee80211_mgmt {
524 	__le16		frame_control;
525         __le16		duration_id;
526 	uint8_t		da[ETH_ALEN];
527 	uint8_t		sa[ETH_ALEN];
528 	uint8_t		bssid[ETH_ALEN];
529 	__le16		seq_ctrl;
530 	union {
531 		/* 9.3.3.3 Beacon frame format */
532 		struct {
533 			uint64_t	timestamp;
534 			uint16_t	beacon_int;
535 			uint16_t	capab_info;
536 			uint8_t		variable[0];
537 		} __packed beacon;
538 		/* 9.3.3.5 Association Request frame format */
539 		struct  {
540 			uint16_t	capab_info;
541 			uint16_t	listen_interval;
542 			uint8_t		variable[0];
543 		} __packed assoc_req;
544 		/* 9.3.3.10 Probe Request frame format */
545 		struct {
546 			uint8_t		variable[0];
547 		} __packed probe_req;
548 		/* 9.3.3.11 Probe Response frame format */
549 		struct {
550 			uint64_t	timestamp;
551 			uint16_t	beacon_int;
552 			uint16_t	capab_info;
553 			uint8_t		variable[0];
554 		} __packed probe_resp;
555 		/* 9.3.3.14 Action frame format */
556 		struct {
557 			/* 9.4.1.11 Action field */
558 			uint8_t		category;
559 			/* 9.6.8 Public Action details */
560 			union {
561 				/* 9.6.2.5 TPC Report frame format */
562 				struct {
563 					uint8_t spec_mgmt;
564 					uint8_t dialog_token;
565 					/* uint32_t tpc_rep_elem:: */
566 					uint8_t tpc_elem_id;
567 					uint8_t tpc_elem_length;
568 					uint8_t tpc_elem_tx_power;
569 					uint8_t tpc_elem_link_margin;
570 				} __packed tpc_report;
571 				/* 9.6.8.33 Fine Timing Measurement frame format */
572 				struct {
573 					uint8_t	dialog_token;
574 					uint8_t	follow_up;
575 					uint8_t	tod[6];
576 					uint8_t	toa[6];
577 					uint16_t tod_error;
578 					uint16_t toa_error;
579 					uint8_t variable[0];
580 				} __packed ftm;
581 				/* 802.11-2016, 9.6.5.2 ADDBA Request frame format */
582 				struct {
583 					uint8_t action_code;
584 					uint8_t dialog_token;
585 					uint16_t capab;
586 					uint16_t timeout;
587 					uint16_t start_seq_num;
588 					/* Optional follows... */
589 					uint8_t variable[0];
590 				} __packed addba_req;
591 				/* XXX */
592 				struct {
593 					uint8_t dialog_token;
594 				} __packed wnm_timing_msr;
595 			} u;
596 		} __packed action;
597 		DECLARE_FLEX_ARRAY(uint8_t, body);
598 	} u;
599 } __packed __aligned(2);
600 
601 struct ieee80211_cts {		/* net80211::ieee80211_frame_cts */
602         __le16		frame_control;
603         __le16		duration;
604 	uint8_t		ra[ETH_ALEN];
605 } __packed;
606 
607 struct ieee80211_rts {		/* net80211::ieee80211_frame_rts */
608         __le16		frame_control;
609         __le16		duration;
610 	uint8_t		ra[ETH_ALEN];
611 	uint8_t		ta[ETH_ALEN];
612 } __packed;
613 
614 #define	MHZ_TO_KHZ(_f)		((_f) * 1000)
615 #define	DBI_TO_MBI(_g)		((_g) * 100)
616 #define	MBI_TO_DBI(_x)		((_x) / 100)
617 #define	DBM_TO_MBM(_g)		((_g) * 100)
618 #define	MBM_TO_DBM(_x)		((_x) / 100)
619 
620 #define	IEEE80211_SEQ_TO_SN(_seqn)	(((_seqn) & IEEE80211_SEQ_SEQ_MASK) >> \
621 					    IEEE80211_SEQ_SEQ_SHIFT)
622 #define	IEEE80211_SN_TO_SEQ(_sn)	(((_sn) << IEEE80211_SEQ_SEQ_SHIFT) & \
623 					    IEEE80211_SEQ_SEQ_MASK)
624 
625 /* Time unit (TU) to .. See net80211: IEEE80211_DUR_TU */
626 #define	TU_TO_JIFFIES(_tu)	(usecs_to_jiffies(_tu) * 1024)
627 #define	TU_TO_EXP_TIME(_tu)	(jiffies + TU_TO_JIFFIES(_tu))
628 
629 /* 9.4.2.21.1, Table 9-82. */
630 #define	IEEE80211_SPCT_MSR_RPRT_TYPE_LCI	8
631 #define	IEEE80211_SPCT_MSR_RPRT_TYPE_CIVIC	11
632 
633 /* 9.4.2.1, Table 9-77. Element IDs. */
634 enum ieee80211_eid {
635 	WLAN_EID_SSID				= 0,
636 	WLAN_EID_SUPP_RATES			= 1,
637 	WLAN_EID_DS_PARAMS			= 3,
638 	WLAN_EID_TIM				= 5,
639 	WLAN_EID_COUNTRY			= 7,	/* IEEE80211_ELEMID_COUNTRY */
640 	WLAN_EID_REQUEST			= 10,
641 	WLAN_EID_QBSS_LOAD			= 11,	/* IEEE80211_ELEMID_BSSLOAD */
642 	WLAN_EID_CHANNEL_SWITCH			= 37,
643 	WLAN_EID_MEASURE_REPORT			= 39,
644 	WLAN_EID_HT_CAPABILITY			= 45,	/* IEEE80211_ELEMID_HTCAP */
645 	WLAN_EID_RSN				= 48,	/* IEEE80211_ELEMID_RSN */
646 	WLAN_EID_EXT_SUPP_RATES			= 50,
647 	WLAN_EID_EXT_NON_INHERITANCE		= 56,
648 	WLAN_EID_EXT_CHANSWITCH_ANN		= 60,
649 	WLAN_EID_MULTIPLE_BSSID			= 71,	/* IEEE80211_ELEMID_MULTIBSSID */
650 	WLAN_EID_MULTI_BSSID_IDX		= 85,
651 	WLAN_EID_EXT_CAPABILITY			= 127,
652 	WLAN_EID_VHT_CAPABILITY			= 191,	/* IEEE80211_ELEMID_VHT_CAP */
653 	WLAN_EID_S1G_TWT			= 216,
654 	WLAN_EID_VENDOR_SPECIFIC		= 221,	/* IEEE80211_ELEMID_VENDOR */
655 };
656 
657 enum ieee80211_eid_ext {
658 	WLAN_EID_EXT_HE_CAPABILITY		= 35,
659 };
660 
661 #define	for_each_element(_elem, _data, _len) \
662 	for (_elem = (const struct element *)(_data); \
663 	    (((const uint8_t *)(_data) + (_len) - (const uint8_t *)_elem) >= sizeof(*_elem)) && \
664 		(((const uint8_t *)(_data) + (_len) - (const uint8_t *)_elem) >= (sizeof(*_elem) + _elem->datalen)); \
665 	    _elem = (const struct element *)(_elem->data + _elem->datalen))
666 
667 #define	for_each_element_id(_elem, _eid, _data, _len) \
668 	for_each_element(_elem, _data, _len) \
669 		if (_elem->id == (_eid))
670 
671 /* 9.4.1.7, Table 9-45. Reason codes. */
672 enum ieee80211_reason_code {
673 	/* reserved				= 0, */
674 	WLAN_REASON_UNSPECIFIED			= 1,
675 	WLAN_REASON_DEAUTH_LEAVING		= 3,	/* LEAVING_NETWORK_DEAUTH */
676 	WLAN_REASON_TDLS_TEARDOWN_UNREACHABLE	= 25,
677 	WLAN_REASON_TDLS_TEARDOWN_UNSPECIFIED	= 26,
678 };
679 
680 /* 9.4.1.9, Table 9-46. Status codes. */
681 enum ieee80211_status_code {
682 	WLAN_STATUS_SUCCESS			= 0,
683 	WLAN_STATUS_AUTH_TIMEOUT		= 16,	/* REJECTED_SEQUENCE_TIMEOUT */
684 };
685 
686 /* 9.3.1.22 Trigger frame format; 80211ax-2021 */
687 struct ieee80211_trigger {
688         __le16		frame_control;
689         __le16		duration_id;
690 	uint8_t		ra[ETH_ALEN];
691 	uint8_t		ta[ETH_ALEN];
692 	__le64		common_info;		/* 8+ really */
693 	uint8_t		variable[];
694 };
695 
696 /* Table 9-29c-Trigger Type subfield encoding */
697 enum {
698 	IEEE80211_TRIGGER_TYPE_BASIC		= 0x0,
699 	IEEE80211_TRIGGER_TYPE_MU_BAR		= 0x2,
700 #if 0
701 	/* Not seen yet. */
702 	BFRP					= 0x1,
703 	MU-RTS					= 0x3,
704 	BSRP					= 0x4,
705 	GCR MU-BAR				= 0x5,
706 	BQRP					= 0x6,
707 	NFRP					= 0x7,
708 	/* 0x8..0xf reserved */
709 #endif
710 	IEEE80211_TRIGGER_TYPE_MASK		= 0xf
711 };
712 
713 #define	IEEE80211_TRIGGER_ULBW_MASK		0xc0000
714 #define	IEEE80211_TRIGGER_ULBW_20MHZ		0x0
715 #define	IEEE80211_TRIGGER_ULBW_40MHZ		0x1
716 #define	IEEE80211_TRIGGER_ULBW_80MHZ		0x2
717 #define	IEEE80211_TRIGGER_ULBW_160_80P80MHZ	0x3
718 
719 /* 802.11-2020, Figure 9-687-Control field format; 802.11ax-2021 */
720 #define	IEEE80211_TWT_CONTROL_NEG_TYPE_BROADCAST	BIT(3)
721 #define	IEEE80211_TWT_CONTROL_RX_DISABLED		BIT(4)
722 #define	IEEE80211_TWT_CONTROL_WAKE_DUR_UNIT		BIT(5)
723 
724 /* 802.11-2020, Figure 9-688-Request Type field format; 802.11ax-2021 */
725 #define	IEEE80211_TWT_REQTYPE_SETUP_CMD		(BIT(1) | BIT(2) | BIT(3))
726 #define	IEEE80211_TWT_REQTYPE_TRIGGER		BIT(4)
727 #define	IEEE80211_TWT_REQTYPE_IMPLICIT		BIT(5)
728 #define	IEEE80211_TWT_REQTYPE_FLOWTYPE		BIT(6)
729 #define	IEEE80211_TWT_REQTYPE_FLOWID		(BIT(7) | BIT(8) | BIT(9))
730 #define	IEEE80211_TWT_REQTYPE_WAKE_INT_EXP	(BIT(10) | BIT(11) | BIT(12) | BIT(13) | BIT(14))
731 #define	IEEE80211_TWT_REQTYPE_PROTECTION	BIT(15)
732 
733 struct ieee80211_twt_params {
734 	int	mantissa, min_twt_dur, twt;
735 	uint16_t				req_type;
736 };
737 
738 struct ieee80211_twt_setup {
739 	int	control;
740 	struct ieee80211_twt_params		*params;
741 };
742 
743 /* 802.11-2020, Table 9-297-TWT Setup Command field values */
744 enum ieee80211_twt_setup_cmd {
745 	TWT_SETUP_CMD_REQUEST			= 0,
746 	TWT_SETUP_CMD_SUGGEST			= 1,
747 	/* DEMAND				= 2, */
748 	/* GROUPING				= 3, */
749 	TWT_SETUP_CMD_ACCEPT			= 4,
750 	/* ALTERNATE				= 5 */
751 	TWT_SETUP_CMD_DICTATE			= 6,
752 	TWT_SETUP_CMD_REJECT			= 7,
753 };
754 
755 struct ieee80211_bssid_index {
756 	int	bssid_index;
757 };
758 
759 enum ieee80211_ap_reg_power {
760 	IEEE80211_REG_UNSET_AP,
761 	IEEE80211_REG_LPI_AP,
762 	IEEE80211_REG_SP_AP,
763 	IEEE80211_REG_VLP_AP,
764 };
765 
766 /*
767  * 802.11ax-2021, Table 9-277-Meaning of Maximum Transmit Power Count subfield
768  * if Maximum Transmit Power Interpretation subfield is 1 or 3
769  */
770 #define	IEEE80211_MAX_NUM_PWR_LEVEL		8
771 
772 /*
773  * 802.11ax-2021, Table 9-275a-Maximum Transmit Power Interpretation subfield
774  * encoding (4) * Table E-12-Regulatory Info subfield encoding in the
775  * United States (2)
776  */
777 #define	IEEE80211_TPE_MAX_IE_NUM		8
778 
779 /* 802.11ax-2021, 9.4.2.161 Transmit Power Envelope element */
780 struct ieee80211_tx_pwr_env {
781 	uint8_t		tx_power_info;
782 	uint8_t		tx_power[IEEE80211_MAX_NUM_PWR_LEVEL];
783 };
784 
785 /* 802.11ax-2021, Figure 9-617-Transmit Power Information field format */
786 /* These are field masks (3bit/3bit/2bit). */
787 #define	IEEE80211_TX_PWR_ENV_INFO_COUNT		0x07
788 #define	IEEE80211_TX_PWR_ENV_INFO_INTERPRET	0x38
789 #define	IEEE80211_TX_PWR_ENV_INFO_CATEGORY	0xc0
790 
791 /*
792  * 802.11ax-2021, Table 9-275a-Maximum Transmit Power Interpretation subfield
793  * encoding
794  */
795 enum ieee80211_tx_pwr_interpretation_subfield_enc {
796 	IEEE80211_TPE_LOCAL_EIRP,
797 	IEEE80211_TPE_LOCAL_EIRP_PSD,
798 	IEEE80211_TPE_REG_CLIENT_EIRP,
799 	IEEE80211_TPE_REG_CLIENT_EIRP_PSD,
800 };
801 
802 enum ieee80211_tx_pwr_category_6ghz {
803 	IEEE80211_TPE_CAT_6GHZ_DEFAULT,
804 };
805 
806 /* 802.11-2020, 9.4.2.27 BSS Load element */
807 struct ieee80211_bss_load_elem {
808 	uint16_t				sta_count;
809 	uint8_t					channel_util;
810 	uint16_t				avail_adm_capa;
811 };
812 
813 struct ieee80211_p2p_noa_desc {
814 	uint32_t				count;		/* uint8_t ? */
815 	uint32_t				duration;
816 	uint32_t				interval;
817 	uint32_t				start_time;
818 };
819 
820 struct ieee80211_p2p_noa_attr {
821 	uint8_t					index;
822 	uint8_t					oppps_ctwindow;
823 	struct ieee80211_p2p_noa_desc		desc[4];
824 };
825 
826 
827 /* net80211: IEEE80211_IS_CTL() */
828 static __inline bool
ieee80211_is_ctl(__le16 fc)829 ieee80211_is_ctl(__le16 fc)
830 {
831 	__le16 v;
832 
833 	fc &= htole16(IEEE80211_FC0_TYPE_MASK);
834 	v = htole16(IEEE80211_FC0_TYPE_CTL);
835 
836 	return (fc == v);
837 }
838 
839 /* net80211: IEEE80211_IS_DATA() */
840 static __inline bool
ieee80211_is_data(__le16 fc)841 ieee80211_is_data(__le16 fc)
842 {
843 	__le16 v;
844 
845 	fc &= htole16(IEEE80211_FC0_TYPE_MASK);
846 	v = htole16(IEEE80211_FC0_TYPE_DATA);
847 
848 	return (fc == v);
849 }
850 
851 /* net80211: IEEE80211_IS_QOSDATA() */
852 static __inline bool
ieee80211_is_data_qos(__le16 fc)853 ieee80211_is_data_qos(__le16 fc)
854 {
855 	__le16 v;
856 
857 	fc &= htole16(IEEE80211_FC0_SUBTYPE_QOS_DATA | IEEE80211_FC0_TYPE_MASK);
858 	v = htole16(IEEE80211_FC0_SUBTYPE_QOS_DATA | IEEE80211_FC0_TYPE_DATA);
859 
860 	return (fc == v);
861 }
862 
863 /* net80211: IEEE80211_IS_MGMT() */
864 static __inline bool
ieee80211_is_mgmt(__le16 fc)865 ieee80211_is_mgmt(__le16 fc)
866 {
867 	__le16 v;
868 
869 	fc &= htole16(IEEE80211_FC0_TYPE_MASK);
870 	v = htole16(IEEE80211_FC0_TYPE_MGT);
871 
872 	return (fc == v);
873 }
874 
875 
876 /* Derived from net80211::ieee80211_anyhdrsize. */
877 static __inline unsigned int
ieee80211_hdrlen(__le16 fc)878 ieee80211_hdrlen(__le16 fc)
879 {
880 	unsigned int size;
881 
882 	if (ieee80211_is_ctl(fc)) {
883 		switch (fc & htole16(IEEE80211_FC0_SUBTYPE_MASK)) {
884 		case htole16(IEEE80211_FC0_SUBTYPE_CTS):
885 		case htole16(IEEE80211_FC0_SUBTYPE_ACK):
886 			return sizeof(struct ieee80211_frame_ack);
887 		case htole16(IEEE80211_FC0_SUBTYPE_BAR):
888 			return sizeof(struct ieee80211_frame_bar);
889 		}
890 		return (sizeof(struct ieee80211_frame_min));
891 	}
892 
893 	size = sizeof(struct ieee80211_frame);
894 	if (ieee80211_is_data(fc)) {
895 		if ((fc & htole16(IEEE80211_FC1_DIR_MASK << 8)) ==
896 		    htole16(IEEE80211_FC1_DIR_DSTODS << 8))
897 			size += IEEE80211_ADDR_LEN;
898 		if ((fc & htole16(IEEE80211_FC0_SUBTYPE_QOS_DATA |
899 		    IEEE80211_FC0_TYPE_MASK)) ==
900 		    htole16(IEEE80211_FC0_SUBTYPE_QOS_DATA |
901 		    IEEE80211_FC0_TYPE_DATA))
902 			size += sizeof(uint16_t);
903 	}
904 
905 	if (ieee80211_is_mgmt(fc)) {
906 #ifdef __notyet__
907 		printf("XXX-BZ %s: TODO? fc %#04x size %u\n",
908 		    __func__, fc, size);
909 #endif
910 		;
911 	}
912 
913 	return (size);
914 }
915 
916 static inline bool
ieee80211_is_trigger(__le16 fc)917 ieee80211_is_trigger(__le16 fc)
918 {
919 	__le16 v;
920 
921 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
922 	v = htole16(IEEE80211_FC0_SUBTYPE_TRIGGER | IEEE80211_FC0_TYPE_CTL);
923 
924 	return (fc == v);
925 }
926 
927 static __inline bool
ieee80211_is_action(__le16 fc)928 ieee80211_is_action(__le16 fc)
929 {
930 	__le16 v;
931 
932 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
933 	v = htole16(IEEE80211_FC0_SUBTYPE_ACTION | IEEE80211_FC0_TYPE_MGT);
934 
935 	return (fc == v);
936 }
937 
938 static __inline bool
ieee80211_is_probe_resp(__le16 fc)939 ieee80211_is_probe_resp(__le16 fc)
940 {
941 	__le16 v;
942 
943 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
944 	v = htole16(IEEE80211_FC0_SUBTYPE_PROBE_RESP | IEEE80211_FC0_TYPE_MGT);
945 
946 	return (fc == v);
947 }
948 
949 static __inline bool
ieee80211_is_auth(__le16 fc)950 ieee80211_is_auth(__le16 fc)
951 {
952 	__le16 v;
953 
954 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
955 	v = htole16(IEEE80211_FC0_SUBTYPE_AUTH | IEEE80211_FC0_TYPE_MGT);
956 
957 	return (fc == v);
958 }
959 
960 static __inline bool
ieee80211_is_assoc_req(__le16 fc)961 ieee80211_is_assoc_req(__le16 fc)
962 {
963 	__le16 v;
964 
965 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
966 	v = htole16(IEEE80211_FC0_SUBTYPE_ASSOC_REQ | IEEE80211_FC0_TYPE_MGT);
967 
968 	return (fc == v);
969 }
970 
971 static __inline bool
ieee80211_is_assoc_resp(__le16 fc)972 ieee80211_is_assoc_resp(__le16 fc)
973 {
974 	__le16 v;
975 
976 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
977 	v = htole16(IEEE80211_FC0_SUBTYPE_ASSOC_RESP | IEEE80211_FC0_TYPE_MGT);
978 
979 	return (fc == v);
980 }
981 
982 static __inline bool
ieee80211_is_reassoc_req(__le16 fc)983 ieee80211_is_reassoc_req(__le16 fc)
984 {
985 	__le16 v;
986 
987 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
988 	v = htole16(IEEE80211_FC0_SUBTYPE_REASSOC_REQ | IEEE80211_FC0_TYPE_MGT);
989 
990 	return (fc == v);
991 }
992 
993 static __inline bool
ieee80211_is_reassoc_resp(__le16 fc)994 ieee80211_is_reassoc_resp(__le16 fc)
995 {
996 	__le16 v;
997 
998 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
999 	v = htole16(IEEE80211_FC0_SUBTYPE_REASSOC_RESP | IEEE80211_FC0_TYPE_MGT);
1000 
1001 	return (fc == v);
1002 }
1003 
1004 static __inline bool
ieee80211_is_disassoc(__le16 fc)1005 ieee80211_is_disassoc(__le16 fc)
1006 {
1007 	__le16 v;
1008 
1009 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1010 	v = htole16(IEEE80211_FC0_SUBTYPE_DISASSOC | IEEE80211_FC0_TYPE_MGT);
1011 
1012 	return (fc == v);
1013 }
1014 
1015 static __inline bool
ieee80211_is_data_present(__le16 fc)1016 ieee80211_is_data_present(__le16 fc)
1017 {
1018 	__le16 v;
1019 
1020 	/* If it is a data frame and NODATA is not present. */
1021 	fc &= htole16(IEEE80211_FC0_TYPE_MASK | IEEE80211_FC0_SUBTYPE_NODATA);
1022 	v = htole16(IEEE80211_FC0_TYPE_DATA);
1023 
1024 	return (fc == v);
1025 }
1026 
1027 static __inline bool
ieee80211_is_deauth(__le16 fc)1028 ieee80211_is_deauth(__le16 fc)
1029 {
1030 	__le16 v;
1031 
1032 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1033 	v = htole16(IEEE80211_FC0_SUBTYPE_DEAUTH | IEEE80211_FC0_TYPE_MGT);
1034 
1035 	return (fc == v);
1036 }
1037 
1038 static __inline bool
ieee80211_is_beacon(__le16 fc)1039 ieee80211_is_beacon(__le16 fc)
1040 {
1041 	__le16 v;
1042 
1043 	/*
1044 	 * For as much as I get it this comes in LE and unlike FreeBSD
1045 	 * where we get the entire frame header and u8[], here we get the
1046 	 * 9.2.4.1 Frame Control field only. Mask and compare.
1047 	 */
1048 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1049 	v = htole16(IEEE80211_FC0_SUBTYPE_BEACON | IEEE80211_FC0_TYPE_MGT);
1050 
1051 	return (fc == v);
1052 }
1053 
1054 
1055 static __inline bool
ieee80211_is_probe_req(__le16 fc)1056 ieee80211_is_probe_req(__le16 fc)
1057 {
1058 	__le16 v;
1059 
1060 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1061 	v = htole16(IEEE80211_FC0_SUBTYPE_PROBE_REQ | IEEE80211_FC0_TYPE_MGT);
1062 
1063 	return (fc == v);
1064 }
1065 
1066 static __inline bool
ieee80211_has_protected(__le16 fc)1067 ieee80211_has_protected(__le16 fc)
1068 {
1069 
1070 	return (fc & htole16(IEEE80211_FC1_PROTECTED << 8));
1071 }
1072 
1073 static __inline bool
ieee80211_is_back_req(__le16 fc)1074 ieee80211_is_back_req(__le16 fc)
1075 {
1076 	__le16 v;
1077 
1078 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1079 	v = htole16(IEEE80211_FC0_SUBTYPE_BAR | IEEE80211_FC0_TYPE_CTL);
1080 
1081 	return (fc == v);
1082 }
1083 
1084 static __inline bool
ieee80211_is_bufferable_mmpdu(struct sk_buff * skb)1085 ieee80211_is_bufferable_mmpdu(struct sk_buff *skb)
1086 {
1087 	struct ieee80211_mgmt *mgmt;
1088 	__le16 fc;
1089 
1090 	mgmt = (struct ieee80211_mgmt *)skb->data;
1091 	fc = mgmt->frame_control;
1092 
1093 	/* 11.2.2 Bufferable MMPDUs, 80211-2020. */
1094 	/* XXX we do not care about IBSS yet. */
1095 
1096 	if (!ieee80211_is_mgmt(fc))
1097 		return (false);
1098 	if (ieee80211_is_action(fc))		/* XXX FTM? */
1099 		return (true);			/* XXX false? */
1100 	if (ieee80211_is_disassoc(fc))
1101 		return (true);
1102 	if (ieee80211_is_deauth(fc))
1103 		return (true);
1104 
1105 	TODO();
1106 
1107 	return (false);
1108 }
1109 
1110 static __inline bool
ieee80211_is_nullfunc(__le16 fc)1111 ieee80211_is_nullfunc(__le16 fc)
1112 {
1113 	__le16 v;
1114 
1115 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1116 	v = htole16(IEEE80211_FC0_SUBTYPE_NODATA | IEEE80211_FC0_TYPE_DATA);
1117 
1118 	return (fc == v);
1119 }
1120 
1121 static __inline bool
ieee80211_is_qos_nullfunc(__le16 fc)1122 ieee80211_is_qos_nullfunc(__le16 fc)
1123 {
1124 	__le16 v;
1125 
1126 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1127 	v = htole16(IEEE80211_FC0_SUBTYPE_QOS_NULL | IEEE80211_FC0_TYPE_DATA);
1128 
1129 	return (fc == v);
1130 }
1131 
1132 static __inline bool
ieee80211_is_any_nullfunc(__le16 fc)1133 ieee80211_is_any_nullfunc(__le16 fc)
1134 {
1135 
1136 	return (ieee80211_is_nullfunc(fc) || ieee80211_is_qos_nullfunc(fc));
1137 }
1138 
1139 static inline bool
ieee80211_is_pspoll(__le16 fc)1140 ieee80211_is_pspoll(__le16 fc)
1141 {
1142 	__le16 v;
1143 
1144 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1145 	v = htole16(IEEE80211_FC0_SUBTYPE_PS_POLL | IEEE80211_FC0_TYPE_CTL);
1146 
1147 	return (fc == v);
1148 }
1149 
1150 static __inline bool
ieee80211_has_a4(__le16 fc)1151 ieee80211_has_a4(__le16 fc)
1152 {
1153 	__le16 v;
1154 
1155 	fc &= htole16((IEEE80211_FC1_DIR_TODS | IEEE80211_FC1_DIR_FROMDS) << 8);
1156 	v = htole16((IEEE80211_FC1_DIR_TODS | IEEE80211_FC1_DIR_FROMDS) << 8);
1157 
1158 	return (fc == v);
1159 }
1160 
1161 static __inline bool
ieee80211_has_order(__le16 fc)1162 ieee80211_has_order(__le16 fc)
1163 {
1164 
1165 	return (fc & htole16(IEEE80211_FC1_ORDER << 8));
1166 }
1167 
1168 static __inline bool
ieee80211_has_retry(__le16 fc)1169 ieee80211_has_retry(__le16 fc)
1170 {
1171 
1172 	return (fc & htole16(IEEE80211_FC1_RETRY << 8));
1173 }
1174 
1175 
1176 static __inline bool
ieee80211_has_fromds(__le16 fc)1177 ieee80211_has_fromds(__le16 fc)
1178 {
1179 
1180 	return (fc & htole16(IEEE80211_FC1_DIR_FROMDS << 8));
1181 }
1182 
1183 static __inline bool
ieee80211_has_tods(__le16 fc)1184 ieee80211_has_tods(__le16 fc)
1185 {
1186 
1187 	return (fc & htole16(IEEE80211_FC1_DIR_TODS << 8));
1188 }
1189 
1190 static __inline uint8_t *
ieee80211_get_SA(struct ieee80211_hdr * hdr)1191 ieee80211_get_SA(struct ieee80211_hdr *hdr)
1192 {
1193 
1194 	if (ieee80211_has_a4(hdr->frame_control))
1195 		return (hdr->addr4);
1196 	if (ieee80211_has_fromds(hdr->frame_control))
1197 		return (hdr->addr3);
1198 	return (hdr->addr2);
1199 }
1200 
1201 static __inline uint8_t *
ieee80211_get_DA(struct ieee80211_hdr * hdr)1202 ieee80211_get_DA(struct ieee80211_hdr *hdr)
1203 {
1204 
1205 	if (ieee80211_has_tods(hdr->frame_control))
1206 		return (hdr->addr3);
1207 	return (hdr->addr1);
1208 }
1209 
1210 static __inline bool
ieee80211_is_frag(struct ieee80211_hdr * hdr)1211 ieee80211_is_frag(struct ieee80211_hdr *hdr)
1212 {
1213 	TODO();
1214 	return (false);
1215 }
1216 
1217 static __inline bool
ieee80211_is_first_frag(__le16 fc)1218 ieee80211_is_first_frag(__le16 fc)
1219 {
1220 	TODO();
1221 	return (false);
1222 }
1223 
1224 static __inline bool
ieee80211_is_robust_mgmt_frame(struct sk_buff * skb)1225 ieee80211_is_robust_mgmt_frame(struct sk_buff *skb)
1226 {
1227 	TODO();
1228 	return (false);
1229 }
1230 
1231 static __inline bool
ieee80211_is_ftm(struct sk_buff * skb)1232 ieee80211_is_ftm(struct sk_buff *skb)
1233 {
1234 	TODO();
1235 	return (false);
1236 }
1237 
1238 static __inline bool
ieee80211_is_timing_measurement(struct sk_buff * skb)1239 ieee80211_is_timing_measurement(struct sk_buff *skb)
1240 {
1241 	TODO();
1242 	return (false);
1243 }
1244 
1245 static __inline bool
ieee80211_has_pm(__le16 fc)1246 ieee80211_has_pm(__le16 fc)
1247 {
1248 	TODO();
1249 	return (false);
1250 }
1251 
1252 static __inline bool
ieee80211_has_morefrags(__le16 fc)1253 ieee80211_has_morefrags(__le16 fc)
1254 {
1255 
1256 	fc &= htole16(IEEE80211_FC1_MORE_FRAG << 8);
1257 	return (fc != 0);
1258 }
1259 
1260 static __inline u8 *
ieee80211_get_qos_ctl(struct ieee80211_hdr * hdr)1261 ieee80211_get_qos_ctl(struct ieee80211_hdr *hdr)
1262 {
1263         if (ieee80211_has_a4(hdr->frame_control))
1264                 return (u8 *)hdr + 30;
1265         else
1266                 return (u8 *)hdr + 24;
1267 }
1268 
1269 #endif	/* _LINUXKPI_LINUX_IEEE80211_H */
1270