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