xref: /freebsd/sys/compat/linuxkpi/common/include/linux/ieee80211.h (revision b3e7694832e81d7a904a10f525f8797b753bf0d3)
1 /*-
2  * Copyright (c) 2020-2021 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/bitops.h>
37 #include <linux/if_ether.h>
38 
39 
40 /* 9.4.2.55 Management MIC element (CMAC-256, GMAC-128, and GMAC-256). */
41 struct ieee80211_mmie_16 {
42 	uint8_t		element_id;
43 	uint8_t		length;
44 	uint16_t	key_id;
45 	uint8_t		ipn[6];
46 	uint8_t		mic[16];
47 };
48 
49 #define	IEEE80211_CCMP_HDR_LEN			8	/* 802.11i .. net80211 comment */
50 #define	IEEE80211_CCMP_PN_LEN			6
51 #define	IEEE80211_CCMP_MIC_LEN			8	/* || 16 */
52 #define	IEEE80211_CCMP_256_HDR_LEN		8
53 #define	IEEE80211_CCMP_256_MIC_LEN		16
54 #define	IEEE80211_GCMP_HDR_LEN			8
55 #define	IEEE80211_GCMP_MIC_LEN			16
56 #define	IEEE80211_GCMP_PN_LEN			6
57 #define	IEEE80211_GMAC_PN_LEN			6
58 
59 #define	IEEE80211_MAX_PN_LEN			16
60 
61 #define	IEEE80211_INVAL_HW_QUEUE		((uint8_t)-1)
62 
63 #define	IEEE80211_MAX_AMPDU_BUF_HT		0x40
64 #define	IEEE80211_MAX_AMPDU_BUF			256	/* for HE? */
65 #define	IEEE80211_MAX_AMPDU_BUF_HE		256
66 
67 #define	IEEE80211_MAX_FRAME_LEN			2352
68 #define	IEEE80211_MAX_DATA_LEN			(2300 + IEEE80211_CRC_LEN)
69 
70 #define	IEEE80211_MAX_MPDU_LEN_HT_BA		4095	/* 9.3.2.1 Format of Data frames; non-VHT non-DMG STA */
71 #define	IEEE80211_MAX_MPDU_LEN_HT_3839		3839
72 #define	IEEE80211_MAX_MPDU_LEN_HT_7935		7935
73 #define	IEEE80211_MAX_MPDU_LEN_VHT_3895		3895
74 #define	IEEE80211_MAX_MPDU_LEN_VHT_7991		7991
75 #define	IEEE80211_MAX_MPDU_LEN_VHT_11454	11454
76 
77 #define	IEEE80211_MAX_RTS_THRESHOLD		2346	/* net80211::IEEE80211_RTS_MAX */
78 
79 #define	IEEE80211_MIN_ACTION_SIZE		23	/* ? */
80 
81 /* Wi-Fi Peer-to-Peer (P2P) Technical Specification */
82 #define	IEEE80211_P2P_OPPPS_CTWINDOW_MASK	0x7f
83 #define	IEEE80211_P2P_OPPPS_ENABLE_BIT		BIT(7)
84 
85 /* 802.11-2016, 9.2.4.5.1, Table 9-6 QoS Control Field */
86 #define	IEEE80211_QOS_CTL_TAG1D_MASK		0x0007
87 #define	IEEE80211_QOS_CTL_TID_MASK		IEEE80211_QOS_TID
88 #define	IEEE80211_QOS_CTL_EOSP			0x0010
89 #define	IEEE80211_QOS_CTL_A_MSDU_PRESENT	0x0080
90 #define	IEEE80211_QOS_CTL_ACK_POLICY_MASK	0x0060
91 #define	IEEE80211_QOS_CTL_ACK_POLICY_NOACK	0x0020
92 #define	IEEE80211_QOS_CTL_MESH_CONTROL_PRESENT	0x0100
93 
94 #define	IEEE80211_RATE_SHORT_PREAMBLE		BIT(0)
95 
96 enum ieee80211_rate_control_changed_flags {
97 	IEEE80211_RC_BW_CHANGED			= BIT(0),
98 	IEEE80211_RC_NSS_CHANGED		= BIT(1),
99 	IEEE80211_RC_SUPP_RATES_CHANGED		= BIT(2),
100 	IEEE80211_RC_SMPS_CHANGED		= BIT(3),
101 };
102 
103 #define	IEEE80211_SCTL_FRAG			IEEE80211_SEQ_FRAG_MASK
104 #define	IEEE80211_SCTL_SEQ			IEEE80211_SEQ_SEQ_MASK
105 
106 #define	IEEE80211_TKIP_ICV_LEN			4
107 #define	IEEE80211_TKIP_IV_LEN			8	/* WEP + KID + EXT */
108 
109 #define	IEEE80211_VHT_EXT_NSS_BW_CAPABLE	(1 << 13)	/* assigned to tx_highest */
110 
111 #define	IEEE80211_VHT_MAX_AMPDU_1024K		7	/* 9.4.2.56.3 A-MPDU Parameters field, Table 9-163 */
112 
113 #define	IEEE80211_WEP_IV_LEN			3	/* net80211: IEEE80211_WEP_IVLEN */
114 #define	IEEE80211_WEP_ICV_LEN			4
115 
116 #define	WLAN_AUTH_OPEN				__LINE__ /* TODO FIXME brcmfmac */
117 #define	WLAN_CAPABILITY_IBSS			__LINE__ /* TODO FIXME no longer used? */
118 #define	WLAN_CAPABILITY_SHORT_PREAMBLE		__LINE__ /* TODO FIXME brcmfmac */
119 #define	WLAN_CAPABILITY_SHORT_SLOT_TIME		__LINE__ /* TODO FIXME brcmfmac */
120 
121 enum wlan_ht_cap_sm_ps {
122 	WLAN_HT_CAP_SM_PS_STATIC		= 0,
123 	WLAN_HT_CAP_SM_PS_DYNAMIC,
124 	WLAN_HT_CAP_SM_PS_INVALID,
125 	WLAN_HT_CAP_SM_PS_DISABLED,
126 };
127 
128 #define	WLAN_MAX_KEY_LEN			32 /* TODO FIXME brcmfmac */
129 #define	WLAN_PMKID_LEN				16 /* TODO FIXME brcmfmac */
130 
131 #define	WLAN_KEY_LEN_WEP40			5
132 #define	WLAN_KEY_LEN_WEP104			13
133 #define	WLAN_KEY_LEN_TKIP			32
134 #define	WLAN_KEY_LEN_CCMP			16
135 #define	WLAN_KEY_LEN_GCMP			16
136 #define	WLAN_KEY_LEN_GCMP_256			32
137 
138 /* 802.11-2020, 9.4.2.55.3, Table 9-185 Subfields of the A-MPDU Parameters field */
139 enum ieee80211_min_mpdu_start_spacing {
140 	IEEE80211_HT_MPDU_DENSITY_NONE		= 0,
141 #if 0
142 	IEEE80211_HT_MPDU_DENSITY_XXX		= 1,	/* 1/4 us */
143 	IEEE80211_HT_MPDU_DENSITY_YYY		= 2,	/* 1/2 us */
144 #endif
145 	IEEE80211_HT_MPDU_DENSITY_1		= 3,	/* 1 us */
146 	IEEE80211_HT_MPDU_DENSITY_2		= 4,	/* 2 us */
147 	IEEE80211_HT_MPDU_DENSITY_4		= 5,	/* 4us */
148 	IEEE80211_HT_MPDU_DENSITY_8		= 6,	/* 8us */
149 	IEEE80211_HT_MPDU_DENSITY_16		= 7, 	/* 16us */
150 };
151 
152 /* 9.4.2.57, Table 9-168, HT Operation element fields and subfields */
153 #define	IEEE80211_HT_STBC_PARAM_DUAL_CTS_PROT	0x0080	/* B24.. */
154 
155 #define	IEEE80211_FCTL_FTYPE			IEEE80211_FC0_TYPE_MASK
156 #define	IEEE80211_FCTL_STYPE			IEEE80211_FC0_SUBTYPE_MASK
157 #define	IEEE80211_FCTL_ORDER			(IEEE80211_FC1_ORDER << 8)
158 #define	IEEE80211_FCTL_PROTECTED		(IEEE80211_FC1_PROTECTED << 8)
159 #define	IEEE80211_FCTL_FROMDS			(IEEE80211_FC1_DIR_FROMDS << 8)
160 #define	IEEE80211_FCTL_TODS			(IEEE80211_FC1_DIR_TODS << 8)
161 #define	IEEE80211_FCTL_MOREFRAGS		(IEEE80211_FC1_MORE_FRAG << 8)
162 
163 #define	IEEE80211_FTYPE_MGMT			IEEE80211_FC0_TYPE_MGT
164 #define	IEEE80211_FTYPE_CTL			IEEE80211_FC0_TYPE_CTL
165 #define	IEEE80211_FTYPE_DATA			IEEE80211_FC0_TYPE_DATA
166 
167 #define	IEEE80211_STYPE_ASSOC_REQ		IEEE80211_FC0_SUBTYPE_ASSOC_REQ
168 #define	IEEE80211_STYPE_REASSOC_REQ		IEEE80211_FC0_SUBTYPE_REASSOC_REQ
169 #define	IEEE80211_STYPE_PROBE_REQ		IEEE80211_FC0_SUBTYPE_PROBE_REQ
170 #define	IEEE80211_STYPE_DISASSOC		IEEE80211_FC0_SUBTYPE_DISASSOC
171 #define	IEEE80211_STYPE_AUTH			IEEE80211_FC0_SUBTYPE_AUTH
172 #define	IEEE80211_STYPE_DEAUTH			IEEE80211_FC0_SUBTYPE_DEAUTH
173 #define	IEEE80211_STYPE_ACTION			IEEE80211_FC0_SUBTYPE_ACTION
174 #define	IEEE80211_STYPE_QOS_DATA		IEEE80211_FC0_SUBTYPE_QOS_DATA
175 
176 #define	IEEE80211_NUM_ACS			4	/* net8021::WME_NUM_AC */
177 
178 #define	IEEE80211_MAX_SSID_LEN			32	/* 9.4.2.2 SSID element, net80211: IEEE80211_NWID_LEN */
179 
180 
181 /* Figure 9-27, BAR Control field */
182 #define	IEEE80211_BAR_CTRL_TID_INFO_MASK	0xf000
183 #define	IEEE80211_BAR_CTRL_TID_INFO_SHIFT	12
184 
185 #define	IEEE80211_PPE_THRES_INFO_PPET_SIZE		1 /* TODO FIXME ax? */
186 #define	IEEE80211_PPE_THRES_NSS_MASK			2 /* TODO FIXME ax? */
187 #define	IEEE80211_PPE_THRES_RU_INDEX_BITMASK_POS	3 /* TODO FIXME ax? */
188 #define	IEEE80211_PPE_THRES_RU_INDEX_BITMASK_MASK	8 /* TODO FIXME ax? */
189 #define	IEEE80211_HE_PPE_THRES_INFO_HEADER_SIZE		16	/* TODO FIXME ax? */
190 
191 #define	IEEE80211_HT_OP_MODE_PROTECTION			0x03	/* MASK */
192 #define	IEEE80211_HT_OP_MODE_PROTECTION_NONE		0x00
193 #define	IEEE80211_HT_OP_MODE_PROTECTION_20MHZ		0x01
194 #define	IEEE80211_HT_OP_MODE_PROTECTION_NONHT_MIXED	0x02
195 #define	IEEE80211_HT_OP_MODE_PROTECTION_NONMEMBER	0x03
196 
197 
198 /* 9.6.13.1, Table 9-342 TDLS Action field values. */
199 enum ieee80211_tdls_action_code {
200 	WLAN_TDLS_SETUP_REQUEST			= 0,
201 	WLAN_TDLS_SETUP_RESPONSE		= 1,
202 	WLAN_TDLS_SETUP_CONFIRM			= 2,
203 	WLAN_TDLS_TEARDOWN			= 3,
204 	WLAN_TDLS_PEER_TRAFFIC_INDICATION	= 4,
205 	WLAN_TDLS_CHANNEL_SWITCH_REQUEST	= 5,
206 	WLAN_TDLS_CHANNEL_SWITCH_RESPONSE	= 6,
207 	WLAN_TDLS_PEER_PSM_REQUEST		= 7,
208 	WLAN_TDLS_PEER_PSM_RESPONSE		= 8,
209 	WLAN_TDLS_PEER_TRAFFIC_RESPONSE		= 9,
210 	WLAN_TDLS_DISCOVERY_REQUEST		= 10,
211 	/* 11-255 reserved */
212 };
213 
214 /* 9.4.2.27, Table 9-135. Extended Capabilities field. */
215 /* This is split up into octets CAPA1 = octet 1, ... */
216 #define	WLAN_EXT_CAPA1_EXT_CHANNEL_SWITCHING			BIT(2  % 8)
217 #define	WLAN_EXT_CAPA3_MULTI_BSSID_SUPPORT			BIT(22 % 8)
218 #define	WLAN_EXT_CAPA8_OPMODE_NOTIF				BIT(62 % 8)
219 
220 #define	WLAN_EXT_CAPA10_TWT_REQUESTER_SUPPORT			BIT(5)		/* XXX */
221 #define	WLAN_EXT_CAPA10_OBSS_NARROW_BW_RU_TOLERANCE_SUPPORT	BIT(7)		/* XXX */
222 #define	WLAN_EXT_CAPA10_TWT_RESPONDER_SUPPORT			BIT(6)		/* XXX */
223 
224 
225 /* iwlwifi/mvm/utils:: for (ac = IEEE80211_AC_VO; ac <= IEEE80211_AC_VI; ac++) */
226 /* Would be so much easier if we'd define constants to the same. */
227 enum ieee80211_ac_numbers {
228 	IEEE80211_AC_VO = 0,			/* net80211::WME_AC_VO */
229 	IEEE80211_AC_VI = 1,			/* net80211::WME_AC_VI */
230 	IEEE80211_AC_BE = 2,			/* net80211::WME_AC_BE */
231 	IEEE80211_AC_BK = 3,			/* net80211::WME_AC_BK */
232 };
233 
234 #define	IEEE80211_MAX_QUEUES			16	/* Assume IEEE80211_NUM_TIDS for the moment. */
235 
236 #define	IEEE80211_WMM_IE_STA_QOSINFO_AC_VO	1
237 #define	IEEE80211_WMM_IE_STA_QOSINFO_AC_VI	2
238 #define	IEEE80211_WMM_IE_STA_QOSINFO_AC_BK	4
239 #define	IEEE80211_WMM_IE_STA_QOSINFO_AC_BE	8
240 #define	IEEE80211_WMM_IE_STA_QOSINFO_SP_ALL	0xf
241 
242 
243 /* XXX net80211 calls these IEEE80211_HTCAP_* */
244 #define	IEEE80211_HT_CAP_LDPC_CODING		0x0001	/* IEEE80211_HTCAP_LDPC */
245 #define	IEEE80211_HT_CAP_SUP_WIDTH_20_40	0x0002	/* IEEE80211_HTCAP_CHWIDTH40 */
246 #define	IEEE80211_HT_CAP_SM_PS			0x000c	/* IEEE80211_HTCAP_SMPS */
247 #define	IEEE80211_HT_CAP_SM_PS_SHIFT		2
248 #define	IEEE80211_HT_CAP_GRN_FLD		0x0010	/* IEEE80211_HTCAP_GREENFIELD */
249 #define	IEEE80211_HT_CAP_SGI_20			0x0020	/* IEEE80211_HTCAP_SHORTGI20 */
250 #define	IEEE80211_HT_CAP_SGI_40			0x0040	/* IEEE80211_HTCAP_SHORTGI40 */
251 #define	IEEE80211_HT_CAP_TX_STBC		0x0080	/* IEEE80211_HTCAP_TXSTBC */
252 #define	IEEE80211_HT_CAP_RX_STBC		0x0100	/* IEEE80211_HTCAP_RXSTBC */
253 #define	IEEE80211_HT_CAP_RX_STBC_SHIFT		8	/* IEEE80211_HTCAP_RXSTBC_S */
254 #define	IEEE80211_HT_CAP_MAX_AMSDU		0x0800	/* IEEE80211_HTCAP_MAXAMSDU */
255 #define	IEEE80211_HT_CAP_DSSSCCK40		0x1000	/* IEEE80211_HTCAP_DSSSCCK40 */
256 #define	IEEE80211_HT_CAP_LSIG_TXOP_PROT		0x8000	/* IEEE80211_HTCAP_LSIGTXOPPROT */
257 
258 #define	IEEE80211_HT_MCS_TX_DEFINED		0x0001
259 #define	IEEE80211_HT_MCS_TX_RX_DIFF		0x0002
260 #define	IEEE80211_HT_MCS_TX_MAX_STREAMS_SHIFT	2
261 #define	IEEE80211_HT_MCS_TX_MAX_STREAMS_MASK	0x0c
262 #define	IEEE80211_HT_MCS_RX_HIGHEST_MASK	0x3ff
263 #define	IEEE80211_HT_MCS_MASK_LEN		10
264 
265 struct ieee80211_mcs_info {
266 	uint8_t		rx_mask[IEEE80211_HT_MCS_MASK_LEN];
267 	uint16_t	rx_highest;
268 	uint8_t		tx_params;
269 	uint8_t		__reserved[3];
270 };
271 
272 /* 802.11-2020, 9.4.2.55.1 HT Capabilities element structure */
273 struct ieee80211_ht_cap {
274 	uint16_t				cap_info;
275 	uint8_t					ampdu_params_info;
276 	struct ieee80211_mcs_info		mcs;
277 	uint16_t				extended_ht_cap_info;
278 	uint32_t				tx_BF_cap_info;
279 	uint8_t					antenna_selection_info;
280 };
281 
282 #define	IEEE80211_HT_MAX_AMPDU_FACTOR		13
283 #define	IEEE80211_HE_HT_MAX_AMPDU_FACTOR	16
284 #define	IEEE80211_HE_VHT_MAX_AMPDU_FACTOR	20
285 #define	IEEE80211_HE_6GHZ_MAX_AMPDU_FACTOR	13
286 
287 enum ieee80211_ht_max_ampdu_len {
288 	IEEE80211_HT_MAX_AMPDU_64K
289 };
290 
291 enum ieee80211_ampdu_mlme_action {
292 	IEEE80211_AMPDU_RX_START,
293 	IEEE80211_AMPDU_RX_STOP,
294 	IEEE80211_AMPDU_TX_OPERATIONAL,
295 	IEEE80211_AMPDU_TX_START,
296 	IEEE80211_AMPDU_TX_STOP_CONT,
297 	IEEE80211_AMPDU_TX_STOP_FLUSH,
298 	IEEE80211_AMPDU_TX_STOP_FLUSH_CONT
299 };
300 
301 #define	IEEE80211_AMPDU_TX_START_IMMEDIATE	1
302 #define	IEEE80211_AMPDU_TX_START_DELAY_ADDBA	2
303 
304 enum ieee80211_chanctx_switch_mode {
305 	CHANCTX_SWMODE_REASSIGN_VIF,
306 	CHANCTX_SWMODE_SWAP_CONTEXTS,
307 };
308 
309 enum ieee80211_chanctx_change_flags {
310 	IEEE80211_CHANCTX_CHANGE_MIN_WIDTH	= BIT(0),
311 	IEEE80211_CHANCTX_CHANGE_RADAR		= BIT(1),
312 	IEEE80211_CHANCTX_CHANGE_RX_CHAINS	= BIT(2),
313 	IEEE80211_CHANCTX_CHANGE_WIDTH		= BIT(3),
314 	IEEE80211_CHANCTX_CHANGE_CHANNEL	= BIT(4),
315 };
316 
317 enum ieee80211_frame_release_type {
318 	IEEE80211_FRAME_RELEASE_PSPOLL		= 1,
319 	IEEE80211_FRAME_RELEASE_UAPSD		= 2,
320 };
321 
322 enum ieee80211_p2p_attr_ids {
323 	IEEE80211_P2P_ATTR_DEVICE_ID,
324 	IEEE80211_P2P_ATTR_DEVICE_INFO,
325 	IEEE80211_P2P_ATTR_GROUP_ID,
326 	IEEE80211_P2P_ATTR_LISTEN_CHANNEL,
327 	IEEE80211_P2P_ATTR_ABSENCE_NOTICE,
328 };
329 
330 enum ieee80211_reconfig_type {
331 	IEEE80211_RECONFIG_TYPE_RESTART,
332 	IEEE80211_RECONFIG_TYPE_SUSPEND,
333 };
334 
335 enum ieee80211_roc_type {
336 	IEEE80211_ROC_TYPE_MGMT_TX,
337 	IEEE80211_ROC_TYPE_NORMAL,
338 };
339 
340 enum ieee80211_smps_mode {
341 	IEEE80211_SMPS_OFF,
342 	IEEE80211_SMPS_STATIC,
343 	IEEE80211_SMPS_DYNAMIC,
344 	IEEE80211_SMPS_AUTOMATIC,
345 	IEEE80211_SMPS_NUM_MODES,
346 };
347 
348 /* net80211::IEEE80211_S_* different but represents the state machine. */
349 /* Note: order here is important! */
350 enum ieee80211_sta_state {
351 	IEEE80211_STA_NOTEXIST		= 0,
352 	IEEE80211_STA_NONE		= 1,
353 	IEEE80211_STA_AUTH		= 2,
354 	IEEE80211_STA_ASSOC		= 3,
355 	IEEE80211_STA_AUTHORIZED	= 4,	/* 802.1x */
356 };
357 
358 enum ieee80211_sta_rx_bw {
359 	IEEE80211_STA_RX_BW_20,
360 	IEEE80211_STA_RX_BW_40,
361 	IEEE80211_STA_RX_BW_80,
362 	IEEE80211_STA_RX_BW_160,
363 	IEEE80211_STA_RX_BW_320,
364 };
365 
366 enum ieee80211_tx_info_flags {
367 	/* XXX TODO .. right shift numbers - not sure where that came from? */
368 	IEEE80211_TX_CTL_AMPDU			= BIT(0),
369 	IEEE80211_TX_CTL_ASSIGN_SEQ		= BIT(1),
370 	IEEE80211_TX_CTL_NO_ACK			= BIT(2),
371 	IEEE80211_TX_CTL_SEND_AFTER_DTIM	= BIT(3),
372 	IEEE80211_TX_CTL_TX_OFFCHAN		= BIT(4),
373 	IEEE80211_TX_CTL_REQ_TX_STATUS		= BIT(5),
374 	IEEE80211_TX_STATUS_EOSP		= BIT(6),
375 	IEEE80211_TX_STAT_ACK			= BIT(7),
376 	IEEE80211_TX_STAT_AMPDU			= BIT(8),
377 	IEEE80211_TX_STAT_AMPDU_NO_BACK		= BIT(9),
378 	IEEE80211_TX_STAT_TX_FILTERED		= BIT(10),
379 	IEEE80211_TX_STAT_NOACK_TRANSMITTED	= BIT(11),
380 	IEEE80211_TX_CTL_FIRST_FRAGMENT		= BIT(12),
381 	IEEE80211_TX_INTFL_DONT_ENCRYPT		= BIT(13),
382 	IEEE80211_TX_CTL_NO_CCK_RATE		= BIT(14),
383 	IEEE80211_TX_CTL_INJECTED		= BIT(15),
384 	IEEE80211_TX_CTL_HW_80211_ENCAP		= BIT(16),
385 	IEEE80211_TX_CTL_USE_MINRATE		= BIT(17),
386 	IEEE80211_TX_CTL_RATE_CTRL_PROBE	= BIT(18),
387 };
388 
389 enum ieee80211_tx_control_flags {
390 	/* XXX TODO .. right shift numbers */
391 	IEEE80211_TX_CTRL_PORT_CTRL_PROTO	= BIT(0),
392 	IEEE80211_TX_CTRL_PS_RESPONSE		= BIT(1),
393 };
394 
395 enum ieee80211_tx_rate_flags {
396 	/* XXX TODO .. right shift numbers */
397 	IEEE80211_TX_RC_40_MHZ_WIDTH		= BIT(0),
398 	IEEE80211_TX_RC_80_MHZ_WIDTH		= BIT(1),
399 	IEEE80211_TX_RC_160_MHZ_WIDTH		= BIT(2),
400 	IEEE80211_TX_RC_GREEN_FIELD		= BIT(3),
401 	IEEE80211_TX_RC_MCS			= BIT(4),
402 	IEEE80211_TX_RC_SHORT_GI		= BIT(5),
403 	IEEE80211_TX_RC_VHT_MCS			= BIT(6),
404 	IEEE80211_TX_RC_USE_SHORT_PREAMBLE	= BIT(7),
405 };
406 
407 #define	IEEE80211_HT_CTL_LEN	4
408 
409 struct ieee80211_hdr {		/* net80211::ieee80211_frame_addr4 */
410         __le16		frame_control;
411         __le16		duration_id;
412 	uint8_t		addr1[ETH_ALEN];
413 	uint8_t		addr2[ETH_ALEN];
414 	uint8_t		addr3[ETH_ALEN];
415 	__le16		seq_ctrl;
416 	uint8_t		addr4[ETH_ALEN];
417 };
418 
419 struct ieee80211_hdr_3addr {	/* net80211::ieee80211_frame */
420         __le16		frame_control;
421         __le16		duration_id;
422 	uint8_t		addr1[ETH_ALEN];
423 	uint8_t		addr2[ETH_ALEN];
424 	uint8_t		addr3[ETH_ALEN];
425 	__le16		seq_ctrl;
426 };
427 
428 struct ieee80211_qos_hdr {	/* net80211:ieee80211_qosframe */
429         __le16		frame_control;
430         __le16		duration_id;
431 	uint8_t		addr1[ETH_ALEN];
432 	uint8_t		addr2[ETH_ALEN];
433 	uint8_t		addr3[ETH_ALEN];
434 	__le16		seq_ctrl;
435 	__le16		qos_ctrl;
436 };
437 
438 struct ieee80211_vendor_ie {
439 };
440 
441 /* 802.11-2020, Table 9-359-Block Ack Action field values */
442 enum ieee80211_back {
443 	WLAN_ACTION_ADDBA_REQ		= 0,
444 };
445 
446 /* 802.11-2020, Table 9-51-Category values */
447 enum ieee80211_category {
448 	WLAN_CATEGORY_BACK		= 3,
449 };
450 
451 /* 80211-2020 9.3.3.2 Format of Management frames */
452 struct ieee80211_mgmt {
453 	__le16		frame_control;
454         __le16		duration_id;
455 	uint8_t		da[ETH_ALEN];
456 	uint8_t		sa[ETH_ALEN];
457 	uint8_t		bssid[ETH_ALEN];
458 	__le16		seq_ctrl;
459 	union {
460 		/* 9.3.3.3 Beacon frame format */
461 		struct {
462 			uint64_t	timestamp;
463 			uint16_t	beacon_int;
464 			uint16_t	capab_info;
465 			uint8_t		variable[0];
466 		} beacon;
467 		/* 9.3.3.10 Probe Request frame format */
468 		struct {
469 			uint8_t		variable[0];
470 		} probe_req;
471 		/* 9.3.3.11 Probe Response frame format */
472 		struct {
473 			uint64_t	timestamp;
474 			uint16_t	beacon_int;
475 			uint16_t	capab_info;
476 			uint8_t		variable[0];
477 		} probe_resp;
478 		/* 9.3.3.14 Action frame format */
479 		struct {
480 			/* 9.4.1.11 Action field */
481 			uint8_t		category;
482 			/* 9.6.8 Public Action details */
483 			union {
484 				/* 9.6.2.5 TPC Report frame format */
485 				struct {
486 					uint8_t spec_mgmt;
487 					uint8_t dialog_token;
488 					/* uint32_t tpc_rep_elem:: */
489 					uint8_t tpc_elem_id;
490 					uint8_t tpc_elem_length;
491 					uint8_t tpc_elem_tx_power;
492 					uint8_t tpc_elem_link_margin;
493 				} tpc_report;
494 				/* 9.6.8.33 Fine Timing Measurement frame format */
495 				struct {
496 					uint8_t	dialog_token;
497 					uint8_t	follow_up;
498 					uint8_t	tod[6];
499 					uint8_t	toa[6];
500 					uint16_t tod_error;
501 					uint16_t toa_error;
502 					uint8_t variable[0];
503 				} ftm;
504 				/* 802.11-2016, 9.6.5.2 ADDBA Request frame format */
505 				struct {
506 					uint8_t action_code;
507 					uint8_t dialog_token;
508 					uint16_t capab;
509 					uint16_t timeout;
510 					uint16_t start_seq_num;
511 					/* Optional follows... */
512 					uint8_t variable[0];
513 				} addba_req;
514 			} u;
515 		} action;
516 	} u;
517 };
518 
519 #define	MHZ_TO_KHZ(_f)		((_f) * 1000)
520 #define	DBI_TO_MBI(_g)		((_g) * 100)
521 #define	MBI_TO_DBI(_x)		((_x) / 100)
522 #define	DBM_TO_MBM(_g)		((_g) * 100)
523 #define	MBM_TO_DBM(_x)		((_x) / 100)
524 
525 #define	IEEE80211_SEQ_TO_SN(_seqn)	(((_seqn) & IEEE80211_SEQ_SEQ_MASK) >> \
526 					    IEEE80211_SEQ_SEQ_SHIFT)
527 
528 /* Time unit (TU) to .. See net80211: IEEE80211_DUR_TU */
529 #define	TU_TO_JIFFIES(_tu)	(usecs_to_jiffies(_tu) * 1024)
530 #define	TU_TO_EXP_TIME(_tu)	(jiffies + TU_TO_JIFFIES(_tu))
531 
532 /* 9.4.2.21.1, Table 9-82. */
533 #define	IEEE80211_SPCT_MSR_RPRT_TYPE_LCI	8
534 #define	IEEE80211_SPCT_MSR_RPRT_TYPE_CIVIC	11
535 
536 /* 9.4.2.1, Table 9-77. Element IDs. */
537 enum ieee80211_eid {
538 	WLAN_EID_SSID				= 0,
539 	WLAN_EID_SUPP_RATES			= 1,
540 	WLAN_EID_DS_PARAMS			= 3,
541 	WLAN_EID_TIM				= 5,
542 	WLAN_EID_COUNTRY			= 7,	/* IEEE80211_ELEMID_COUNTRY */
543 	WLAN_EID_REQUEST			= 10,
544 	WLAN_EID_CHANNEL_SWITCH			= 37,
545 	WLAN_EID_MEASURE_REPORT			= 39,
546 	WLAN_EID_HT_CAPABILITY			= 45,	/* IEEE80211_ELEMID_HTCAP */
547 	WLAN_EID_RSN				= 48,	/* IEEE80211_ELEMID_RSN */
548 	WLAN_EID_EXT_SUPP_RATES			= 50,
549 	WLAN_EID_EXT_CHANSWITCH_ANN		= 60,
550 	WLAN_EID_MULTIPLE_BSSID			= 71,	/* IEEE80211_ELEMID_MULTIBSSID */
551 	WLAN_EID_MULTI_BSSID_IDX		= 85,
552 	WLAN_EID_EXT_CAPABILITY			= 127,
553 	WLAN_EID_VHT_CAPABILITY			= 191,	/* IEEE80211_ELEMID_VHT_CAP */
554 	WLAN_EID_VENDOR_SPECIFIC		= 221,	/* IEEE80211_ELEMID_VENDOR */
555 };
556 
557 enum ieee80211_eid_ext {
558 	WLAN_EID_EXT_HE_CAPABILITY		= 35,
559 };
560 
561 #define	for_each_element(_elem, _data, _len) \
562 	for (_elem = (const struct element *)(_data); \
563 	    (((const uint8_t *)(_data) + (_len) - (const uint8_t *)_elem) >= sizeof(*_elem)) && \
564 		(((const uint8_t *)(_data) + (_len) - (const uint8_t *)_elem) >= (sizeof(*_elem) + _elem->datalen)); \
565 	    _elem = (const struct element *)(_elem->data + _elem->datalen))
566 
567 #define	for_each_element_id(_elem, _eid, _data, _len) \
568 	for_each_element(_elem, _data, _len) \
569 		if (_elem->id == (_eid))
570 
571 /* 9.4.1.7, Table 9-45. Reason codes. */
572 enum ieee80211_reason_code {
573 	/* reserved				= 0, */
574 	WLAN_REASON_UNSPECIFIED			= 1,
575 	WLAN_REASON_DEAUTH_LEAVING		= 3,	/* LEAVING_NETWORK_DEAUTH */
576 	WLAN_REASON_TDLS_TEARDOWN_UNREACHABLE	= 25,
577 	WLAN_REASON_TDLS_TEARDOWN_UNSPECIFIED	= 26,
578 };
579 
580 /* 9.4.1.9, Table 9-46. Status codes. */
581 enum ieee80211_status_code {
582 	WLAN_STATUS_SUCCESS			= 0,
583 	WLAN_STATUS_AUTH_TIMEOUT		= 16,	/* REJECTED_SEQUENCE_TIMEOUT */
584 };
585 
586 /* 9.3.1.22 Trigger frame format; 80211ax-2021 */
587 struct ieee80211_trigger {
588         __le16		frame_control;
589         __le16		duration_id;
590 	uint8_t		ra[ETH_ALEN];
591 	uint8_t		ta[ETH_ALEN];
592 	__le64		common_info;		/* 8+ really */
593 	uint8_t		variable[];
594 };
595 
596 /* Table 9-29c-Trigger Type subfield encoding */
597 enum {
598 	IEEE80211_TRIGGER_TYPE_BASIC		= 0x0,
599 #if 0
600 	/* Not seen yet. */
601 	BFRP					= 0x1,
602 	MU-BAR					= 0x2,
603 	MU-RTS					= 0x3,
604 	BSRP					= 0x4,
605 	GCR MU-BAR				= 0x5,
606 	BQRP					= 0x6,
607 	NFRP					= 0x7,
608 	/* 0x8..0xf reserved */
609 #endif
610 	IEEE80211_TRIGGER_TYPE_MASK		= 0xf
611 };
612 
613 /* 802.11-2020, Figure 9-687-Control field format; 802.11ax-2021 */
614 #define	IEEE80211_TWT_CONTROL_NEG_TYPE_BROADCAST	BIT(3)
615 #define	IEEE80211_TWT_CONTROL_RX_DISABLED		BIT(4)
616 #define	IEEE80211_TWT_CONTROL_WAKE_DUR_UNIT		BIT(5)
617 
618 /* 802.11-2020, Figure 9-688-Request Type field format; 802.11ax-2021 */
619 #define	IEEE80211_TWT_REQTYPE_SETUP_CMD		(BIT(1) | BIT(2) | BIT(3))
620 #define	IEEE80211_TWT_REQTYPE_TRIGGER		BIT(4)
621 #define	IEEE80211_TWT_REQTYPE_IMPLICIT		BIT(5)
622 #define	IEEE80211_TWT_REQTYPE_FLOWTYPE		BIT(6)
623 #define	IEEE80211_TWT_REQTYPE_FLOWID		(BIT(7) | BIT(8) | BIT(9))
624 #define	IEEE80211_TWT_REQTYPE_WAKE_INT_EXP	(BIT(10) | BIT(11) | BIT(12) | BIT(13) | BIT(14))
625 #define	IEEE80211_TWT_REQTYPE_PROTECTION	BIT(15)
626 
627 struct ieee80211_twt_params {
628 	int	mantissa, min_twt_dur, twt;
629 	uint16_t				req_type;
630 };
631 
632 struct ieee80211_twt_setup {
633 	int	control;
634 	struct ieee80211_twt_params		*params;
635 };
636 
637 /* 802.11-2020, Table 9-297-TWT Setup Command field values */
638 enum ieee80211_twt_setup_cmd {
639 	TWT_SETUP_CMD_REQUEST			= 0,
640 	TWT_SETUP_CMD_SUGGEST			= 1,
641 	/* DEMAND				= 2, */
642 	/* GROUPING				= 3, */
643 	TWT_SETUP_CMD_ACCEPT			= 4,
644 	/* ALTERNATE				= 5 */
645 	TWT_SETUP_CMD_DICTATE			= 6,
646 	TWT_SETUP_CMD_REJECT			= 7,
647 };
648 
649 struct ieee80211_bssid_index {
650 	int	bssid_index;
651 };
652 
653 /* net80211: IEEE80211_IS_CTL() */
654 static __inline bool
655 ieee80211_is_ctl(__le16 fc)
656 {
657 	__le16 v;
658 
659 	fc &= htole16(IEEE80211_FC0_TYPE_MASK);
660 	v = htole16(IEEE80211_FC0_TYPE_CTL);
661 
662 	return (fc == v);
663 }
664 
665 /* net80211: IEEE80211_IS_DATA() */
666 static __inline bool
667 ieee80211_is_data(__le16 fc)
668 {
669 	__le16 v;
670 
671 	fc &= htole16(IEEE80211_FC0_TYPE_MASK);
672 	v = htole16(IEEE80211_FC0_TYPE_DATA);
673 
674 	return (fc == v);
675 }
676 
677 /* net80211: IEEE80211_IS_QOSDATA() */
678 static __inline bool
679 ieee80211_is_data_qos(__le16 fc)
680 {
681 	__le16 v;
682 
683 	fc &= htole16(IEEE80211_FC0_SUBTYPE_QOS_DATA | IEEE80211_FC0_TYPE_MASK);
684 	v = htole16(IEEE80211_FC0_SUBTYPE_QOS_DATA | IEEE80211_FC0_TYPE_DATA);
685 
686 	return (fc == v);
687 }
688 
689 /* net80211: IEEE80211_IS_MGMT() */
690 static __inline bool
691 ieee80211_is_mgmt(__le16 fc)
692 {
693 	__le16 v;
694 
695 	fc &= htole16(IEEE80211_FC0_TYPE_MASK);
696 	v = htole16(IEEE80211_FC0_TYPE_MGT);
697 
698 	return (fc == v);
699 }
700 
701 
702 /* Derived from net80211::ieee80211_anyhdrsize. */
703 static __inline unsigned int
704 ieee80211_hdrlen(__le16 fc)
705 {
706 	unsigned int size;
707 
708 	if (ieee80211_is_ctl(fc)) {
709 		switch (fc & htole16(IEEE80211_FC0_SUBTYPE_MASK)) {
710 		case htole16(IEEE80211_FC0_SUBTYPE_CTS):
711 		case htole16(IEEE80211_FC0_SUBTYPE_ACK):
712 			return sizeof(struct ieee80211_frame_ack);
713 		case htole16(IEEE80211_FC0_SUBTYPE_BAR):
714 			return sizeof(struct ieee80211_frame_bar);
715 		}
716 		return (sizeof(struct ieee80211_frame_min));
717 	}
718 
719 	size = sizeof(struct ieee80211_frame);
720 	if (ieee80211_is_data(fc)) {
721 		if ((fc & htole16(IEEE80211_FC1_DIR_MASK << 8)) ==
722 		    htole16(IEEE80211_FC1_DIR_DSTODS << 8))
723 			size += IEEE80211_ADDR_LEN;
724 		if ((fc & htole16(IEEE80211_FC0_SUBTYPE_QOS_DATA |
725 		    IEEE80211_FC0_TYPE_MASK)) ==
726 		    htole16(IEEE80211_FC0_SUBTYPE_QOS_DATA |
727 		    IEEE80211_FC0_TYPE_DATA))
728 			size += sizeof(uint16_t);
729 	}
730 
731 	if (ieee80211_is_mgmt(fc)) {
732 #ifdef __notyet__
733 		printf("XXX-BZ %s: TODO? fc %#04x size %u\n",
734 		    __func__, fc, size);
735 #endif
736 		;
737 	}
738 
739 	return (size);
740 }
741 
742 static inline bool
743 ieee80211_is_trigger(__le16 fc)
744 {
745 	__le16 v;
746 
747 	fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
748 	v = htole16(IEEE80211_FC0_SUBTYPE_TRIGGER | IEEE80211_FC0_TYPE_CTL);
749 
750 	return (fc == v);
751 }
752 
753 #endif	/* _LINUXKPI_LINUX_IEEE80211_H */
754