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