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