1 /*-
2 * Copyright (c) 2020-2025 The FreeBSD Foundation
3 *
4 * This software was developed by Björn Zeeb under sponsorship from
5 * the FreeBSD Foundation.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29 #ifndef _LINUXKPI_LINUX_IEEE80211_H
30 #define _LINUXKPI_LINUX_IEEE80211_H
31
32 #include <sys/types.h>
33 #include <net80211/ieee80211.h>
34
35 #include <asm/unaligned.h>
36 #include <linux/kernel.h>
37 #include <linux/bitops.h>
38 #include <linux/bitfield.h>
39 #include <linux/if_ether.h>
40
41 /* linux_80211.c */
42 extern int linuxkpi_debug_80211;
43 #ifndef D80211_TODO
44 #define D80211_TODO 0x1
45 #endif
46 #ifndef D80211_IMPROVE
47 #define D80211_IMPROVE 0x2
48 #endif
49 #define TODO(fmt, ...) if (linuxkpi_debug_80211 & D80211_TODO) \
50 printf("%s:%d: XXX LKPI80211 TODO " fmt "\n", __func__, __LINE__, ##__VA_ARGS__)
51 #define IMPROVE(fmt, ...) if (linuxkpi_debug_80211 & D80211_IMPROVE) \
52 printf("%s:%d: XXX LKPI80211 IMPROVE " fmt "\n", __func__, __LINE__, ##__VA_ARGS__)
53
54
55 /* 9.4.2.55 Management MIC element (CMAC-256, GMAC-128, and GMAC-256). */
56 struct ieee80211_mmie_16 {
57 uint8_t element_id;
58 uint8_t length;
59 uint16_t key_id;
60 uint8_t ipn[6];
61 uint8_t mic[16];
62 };
63
64 #define IEEE80211_CCMP_HDR_LEN 8 /* 802.11i .. net80211 comment */
65 #define IEEE80211_CCMP_PN_LEN 6
66 #define IEEE80211_CCMP_MIC_LEN 8 /* || 16 */
67 #define IEEE80211_CCMP_256_HDR_LEN 8
68 #define IEEE80211_CCMP_256_MIC_LEN 16
69 #define IEEE80211_GCMP_HDR_LEN 8
70 #define IEEE80211_GCMP_MIC_LEN 16
71 #define IEEE80211_GCMP_PN_LEN 6
72 #define IEEE80211_GMAC_PN_LEN 6
73 #define IEEE80211_CMAC_PN_LEN 6
74
75 #define IEEE80211_MAX_PN_LEN 16
76
77 #define IEEE80211_INVAL_HW_QUEUE ((uint8_t)-1)
78
79 #define IEEE80211_MAX_AMPDU_BUF_HT IEEE80211_AGGR_BAWMAX
80 #define IEEE80211_MAX_AMPDU_BUF_HE 256
81 #define IEEE80211_MAX_AMPDU_BUF_EHT 1024
82
83 #define IEEE80211_MAX_FRAME_LEN 2352
84 #define IEEE80211_MAX_DATA_LEN (2300 + IEEE80211_CRC_LEN)
85
86 #define IEEE80211_MAX_MPDU_LEN_HT_BA 4095 /* 9.3.2.1 Format of Data frames; non-VHT non-DMG STA */
87 #define IEEE80211_MAX_MPDU_LEN_HT_3839 3839
88 #define IEEE80211_MAX_MPDU_LEN_HT_7935 7935
89 #define IEEE80211_MAX_MPDU_LEN_VHT_3895 3895
90 #define IEEE80211_MAX_MPDU_LEN_VHT_7991 7991
91 #define IEEE80211_MAX_MPDU_LEN_VHT_11454 11454
92
93 #define IEEE80211_MAX_RTS_THRESHOLD 2346 /* net80211::IEEE80211_RTS_MAX */
94
95 #define IEEE80211_MIN_ACTION_SIZE 23 /* ? */
96
97 /* Wi-Fi Peer-to-Peer (P2P) Technical Specification */
98 #define IEEE80211_P2P_OPPPS_CTWINDOW_MASK 0x7f
99 #define IEEE80211_P2P_OPPPS_ENABLE_BIT BIT(7)
100
101 /* 802.11-2016, 9.2.4.5.1, Table 9-6 QoS Control Field */
102 #define IEEE80211_QOS_CTL_TAG1D_MASK 0x0007
103 #define IEEE80211_QOS_CTL_TID_MASK IEEE80211_QOS_TID
104 #define IEEE80211_QOS_CTL_EOSP 0x0010
105 #define IEEE80211_QOS_CTL_A_MSDU_PRESENT 0x0080
106 #define IEEE80211_QOS_CTL_ACK_POLICY_MASK 0x0060
107 #define IEEE80211_QOS_CTL_ACK_POLICY_NOACK 0x0020
108 #define IEEE80211_QOS_CTL_MESH_CONTROL_PRESENT 0x0100
109
110 enum ieee80211_rate_flags {
111 IEEE80211_RATE_SHORT_PREAMBLE = BIT(0),
112 };
113
114 enum ieee80211_rate_control_changed_flags {
115 IEEE80211_RC_BW_CHANGED = BIT(0),
116 IEEE80211_RC_NSS_CHANGED = BIT(1),
117 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
118 IEEE80211_RC_SMPS_CHANGED = BIT(3),
119 };
120
121 #define IEEE80211_SCTL_FRAG IEEE80211_SEQ_FRAG_MASK
122 #define IEEE80211_SCTL_SEQ IEEE80211_SEQ_SEQ_MASK
123
124 #define IEEE80211_TKIP_ICV_LEN 4
125 #define IEEE80211_TKIP_IV_LEN 8 /* WEP + KID + EXT */
126
127 /* 802.11-2016, 9.4.2.158.3 Supported VHT-MCS and NSS Set field. */
128 #define IEEE80211_VHT_EXT_NSS_BW_CAPABLE (1 << 13) /* part of tx_highest */
129
130 /*
131 * 802.11-2020, 9.4.2.157.2 VHT Capabilities Information field,
132 * Table 9-271-Subfields of the VHT Capabilities Information field (continued).
133 */
134 enum ieee80211_vht_max_ampdu_len_exp {
135 IEEE80211_VHT_MAX_AMPDU_8K = 0,
136 IEEE80211_VHT_MAX_AMPDU_16K = 1,
137 IEEE80211_VHT_MAX_AMPDU_32K = 2,
138 IEEE80211_VHT_MAX_AMPDU_64K = 3,
139 IEEE80211_VHT_MAX_AMPDU_128K = 4,
140 IEEE80211_VHT_MAX_AMPDU_256K = 5,
141 IEEE80211_VHT_MAX_AMPDU_512K = 6,
142 IEEE80211_VHT_MAX_AMPDU_1024K = 7,
143 };
144
145 #define IEEE80211_WEP_IV_LEN 3 /* net80211: IEEE80211_WEP_IVLEN */
146 #define IEEE80211_WEP_ICV_LEN 4
147
148 #define WLAN_AUTH_OPEN __LINE__ /* TODO FIXME brcmfmac */
149 #define WLAN_CAPABILITY_IBSS __LINE__ /* TODO FIXME no longer used? */
150 #define WLAN_CAPABILITY_SHORT_PREAMBLE __LINE__ /* TODO FIXME brcmfmac */
151 #define WLAN_CAPABILITY_SHORT_SLOT_TIME __LINE__ /* TODO FIXME brcmfmac */
152
153 enum wlan_ht_cap_sm_ps {
154 WLAN_HT_CAP_SM_PS_STATIC = 0,
155 WLAN_HT_CAP_SM_PS_DYNAMIC = 1,
156 WLAN_HT_CAP_SM_PS_INVALID = 2,
157 WLAN_HT_CAP_SM_PS_DISABLED = 3
158 };
159
160 #define WLAN_MAX_KEY_LEN 32
161 #define WLAN_PMKID_LEN 16
162 #define WLAN_PMK_LEN_SUITE_B_192 48
163
164 enum ieee80211_key_len {
165 WLAN_KEY_LEN_WEP40 = 5,
166 WLAN_KEY_LEN_WEP104 = 13,
167 WLAN_KEY_LEN_TKIP = 32,
168 WLAN_KEY_LEN_CCMP = 16,
169 WLAN_KEY_LEN_CCMP_256 = 32,
170 WLAN_KEY_LEN_GCMP = 16,
171 WLAN_KEY_LEN_AES_CMAC = 16,
172 WLAN_KEY_LEN_GCMP_256 = 32,
173 WLAN_KEY_LEN_BIP_CMAC_256 = 32,
174 WLAN_KEY_LEN_BIP_GMAC_128 = 16,
175 WLAN_KEY_LEN_BIP_GMAC_256 = 32,
176 };
177
178 /* 802.11-2020, 9.4.2.55.3, Table 9-185 Subfields of the A-MPDU Parameters field */
179 enum ieee80211_min_mpdu_start_spacing {
180 IEEE80211_HT_MPDU_DENSITY_NONE = 0,
181 #if 0
182 IEEE80211_HT_MPDU_DENSITY_XXX = 1, /* 1/4 us */
183 #endif
184 IEEE80211_HT_MPDU_DENSITY_0_5 = 2, /* 1/2 us */
185 IEEE80211_HT_MPDU_DENSITY_1 = 3, /* 1 us */
186 IEEE80211_HT_MPDU_DENSITY_2 = 4, /* 2 us */
187 IEEE80211_HT_MPDU_DENSITY_4 = 5, /* 4us */
188 IEEE80211_HT_MPDU_DENSITY_8 = 6, /* 8us */
189 IEEE80211_HT_MPDU_DENSITY_16 = 7, /* 16us */
190 };
191
192 /* 9.4.2.57, Table 9-168, HT Operation element fields and subfields */
193 #define IEEE80211_HT_STBC_PARAM_DUAL_CTS_PROT 0x0080 /* B24.. */
194
195 #define IEEE80211_FCTL_FTYPE IEEE80211_FC0_TYPE_MASK
196 #define IEEE80211_FCTL_STYPE IEEE80211_FC0_SUBTYPE_MASK
197 #define IEEE80211_FCTL_ORDER (IEEE80211_FC1_ORDER << 8)
198 #define IEEE80211_FCTL_PROTECTED (IEEE80211_FC1_PROTECTED << 8)
199 #define IEEE80211_FCTL_FROMDS (IEEE80211_FC1_DIR_FROMDS << 8)
200 #define IEEE80211_FCTL_TODS (IEEE80211_FC1_DIR_TODS << 8)
201 #define IEEE80211_FCTL_MOREFRAGS (IEEE80211_FC1_MORE_FRAG << 8)
202 #define IEEE80211_FCTL_PM (IEEE80211_FC1_PWR_MGT << 8)
203
204 #define IEEE80211_FTYPE_MGMT IEEE80211_FC0_TYPE_MGT
205 #define IEEE80211_FTYPE_CTL IEEE80211_FC0_TYPE_CTL
206 #define IEEE80211_FTYPE_DATA IEEE80211_FC0_TYPE_DATA
207
208 #define IEEE80211_STYPE_ASSOC_REQ IEEE80211_FC0_SUBTYPE_ASSOC_REQ
209 #define IEEE80211_STYPE_REASSOC_REQ IEEE80211_FC0_SUBTYPE_REASSOC_REQ
210 #define IEEE80211_STYPE_PROBE_REQ IEEE80211_FC0_SUBTYPE_PROBE_REQ
211 #define IEEE80211_STYPE_DISASSOC IEEE80211_FC0_SUBTYPE_DISASSOC
212 #define IEEE80211_STYPE_AUTH IEEE80211_FC0_SUBTYPE_AUTH
213 #define IEEE80211_STYPE_DEAUTH IEEE80211_FC0_SUBTYPE_DEAUTH
214 #define IEEE80211_STYPE_CTS IEEE80211_FC0_SUBTYPE_CTS
215 #define IEEE80211_STYPE_RTS IEEE80211_FC0_SUBTYPE_RTS
216 #define IEEE80211_STYPE_ACTION IEEE80211_FC0_SUBTYPE_ACTION
217 #define IEEE80211_STYPE_DATA IEEE80211_FC0_SUBTYPE_DATA
218 #define IEEE80211_STYPE_QOS_DATA IEEE80211_FC0_SUBTYPE_QOS_DATA
219 #define IEEE80211_STYPE_QOS_NULLFUNC IEEE80211_FC0_SUBTYPE_QOS_NULL
220 #define IEEE80211_STYPE_QOS_CFACK 0xd0 /* XXX-BZ reserved? */
221
222 #define IEEE80211_NUM_ACS 4 /* net8021::WME_NUM_AC */
223
224 #define IEEE80211_MAX_SSID_LEN 32 /* 9.4.2.2 SSID element, net80211: IEEE80211_NWID_LEN */
225
226
227 /* Figure 9-27, BAR Control field */
228 #define IEEE80211_BAR_CTRL_TID_INFO_MASK 0xf000
229 #define IEEE80211_BAR_CTRL_TID_INFO_SHIFT 12
230
231 #define IEEE80211_PPE_THRES_INFO_PPET_SIZE 1 /* TODO FIXME ax? */
232 #define IEEE80211_PPE_THRES_NSS_MASK 2 /* TODO FIXME ax? */
233 #define IEEE80211_PPE_THRES_RU_INDEX_BITMASK_POS 3 /* TODO FIXME ax? */
234 #define IEEE80211_PPE_THRES_RU_INDEX_BITMASK_MASK 8 /* TODO FIXME ax? */
235 #define IEEE80211_HE_PPE_THRES_INFO_HEADER_SIZE 16 /* TODO FIXME ax? */
236
237 /* 802.11-2012, Table 8-130-HT Operation element fields and subfields, HT Protection */
238 #define IEEE80211_HT_OP_MODE_PROTECTION IEEE80211_HTINFO_OPMODE /* Mask. */
239 #define IEEE80211_HT_OP_MODE_PROTECTION_NONE IEEE80211_HTINFO_OPMODE_PURE /* No protection */
240 #define IEEE80211_HT_OP_MODE_PROTECTION_NONMEMBER IEEE80211_HTINFO_OPMODE_PROTOPT /* Nonmember protection */
241 #define IEEE80211_HT_OP_MODE_PROTECTION_20MHZ IEEE80211_HTINFO_OPMODE_HT20PR /* 20 MHz protection */
242 #define IEEE80211_HT_OP_MODE_PROTECTION_NONHT_MIXED IEEE80211_HTINFO_OPMODE_MIXED /* Non-HT mixed */
243
244
245 /* 9.6.13.1, Table 9-342 TDLS Action field values. */
246 enum ieee80211_tdls_action_code {
247 WLAN_TDLS_SETUP_REQUEST = 0,
248 WLAN_TDLS_SETUP_RESPONSE = 1,
249 WLAN_TDLS_SETUP_CONFIRM = 2,
250 WLAN_TDLS_TEARDOWN = 3,
251 WLAN_TDLS_PEER_TRAFFIC_INDICATION = 4,
252 WLAN_TDLS_CHANNEL_SWITCH_REQUEST = 5,
253 WLAN_TDLS_CHANNEL_SWITCH_RESPONSE = 6,
254 WLAN_TDLS_PEER_PSM_REQUEST = 7,
255 WLAN_TDLS_PEER_PSM_RESPONSE = 8,
256 WLAN_TDLS_PEER_TRAFFIC_RESPONSE = 9,
257 WLAN_TDLS_DISCOVERY_REQUEST = 10,
258 /* 11-255 reserved */
259 };
260
261 /* 802.11-2020 9.4.2.26, Table 9-153. Extended Capabilities field. */
262 /* This is split up into octets CAPA1 = octet 1, ... */
263 #define WLAN_EXT_CAPA1_EXT_CHANNEL_SWITCHING BIT(2 % 8)
264 #define WLAN_EXT_CAPA3_MULTI_BSSID_SUPPORT BIT(22 % 8)
265 #define WLAN_EXT_CAPA3_TIMING_MEASUREMENT_SUPPORT BIT(23 % 8)
266 #define WLAN_EXT_CAPA8_OPMODE_NOTIF BIT(62 % 8)
267 #define WLAN_EXT_CAPA8_MAX_MSDU_IN_AMSDU_LSB BIT(63 % 8)
268 #define WLAN_EXT_CAPA9_MAX_MSDU_IN_AMSDU_MSB BIT(64 % 8)
269 #define WLAN_EXT_CAPA10_TWT_REQUESTER_SUPPORT BIT(77 % 8)
270 #define WLAN_EXT_CAPA10_TWT_RESPONDER_SUPPORT BIT(78 % 8)
271 #define WLAN_EXT_CAPA10_OBSS_NARROW_BW_RU_TOLERANCE_SUPPORT BIT(79 % 8)
272
273 #define WLAN_EXT_CAPA11_EMA_SUPPORT 0x00 /* XXX TODO FIXME */
274
275
276 /* iwlwifi/mvm/utils:: for (ac = IEEE80211_AC_VO; ac <= IEEE80211_AC_VI; ac++) */
277 /* Would be so much easier if we'd define constants to the same. */
278 enum ieee80211_ac_numbers {
279 IEEE80211_AC_VO = 0, /* net80211::WME_AC_VO */
280 IEEE80211_AC_VI = 1, /* net80211::WME_AC_VI */
281 IEEE80211_AC_BE = 2, /* net80211::WME_AC_BE */
282 IEEE80211_AC_BK = 3, /* net80211::WME_AC_BK */
283 };
284
285 #define IEEE80211_MAX_QUEUES 16 /* Assume IEEE80211_NUM_TIDS for the moment. */
286
287 #define IEEE80211_WMM_IE_STA_QOSINFO_AC_VO 1
288 #define IEEE80211_WMM_IE_STA_QOSINFO_AC_VI 2
289 #define IEEE80211_WMM_IE_STA_QOSINFO_AC_BK 4
290 #define IEEE80211_WMM_IE_STA_QOSINFO_AC_BE 8
291 #define IEEE80211_WMM_IE_STA_QOSINFO_SP_ALL 0xf
292
293
294 /* Define the LinuxKPI names directly to the net80211 ones. */
295 #define IEEE80211_HT_CAP_LDPC_CODING IEEE80211_HTCAP_LDPC
296 #define IEEE80211_HT_CAP_SUP_WIDTH_20_40 IEEE80211_HTCAP_CHWIDTH40
297 #define IEEE80211_HT_CAP_SM_PS IEEE80211_HTCAP_SMPS
298 #define IEEE80211_HT_CAP_SM_PS_SHIFT 2
299 #define IEEE80211_HT_CAP_GRN_FLD IEEE80211_HTCAP_GREENFIELD
300 #define IEEE80211_HT_CAP_SGI_20 IEEE80211_HTCAP_SHORTGI20
301 #define IEEE80211_HT_CAP_SGI_40 IEEE80211_HTCAP_SHORTGI40
302 #define IEEE80211_HT_CAP_TX_STBC IEEE80211_HTCAP_TXSTBC
303 #define IEEE80211_HT_CAP_RX_STBC IEEE80211_HTCAP_RXSTBC
304 #define IEEE80211_HT_CAP_RX_STBC_SHIFT IEEE80211_HTCAP_RXSTBC_S
305 #define IEEE80211_HT_CAP_MAX_AMSDU IEEE80211_HTCAP_MAXAMSDU
306 #define IEEE80211_HT_CAP_DSSSCCK40 IEEE80211_HTCAP_DSSSCCK40
307 #define IEEE80211_HT_CAP_LSIG_TXOP_PROT IEEE80211_HTCAP_LSIGTXOPPROT
308
309 #define IEEE80211_HT_MCS_TX_DEFINED 0x0001
310 #define IEEE80211_HT_MCS_TX_RX_DIFF 0x0002
311 #define IEEE80211_HT_MCS_TX_MAX_STREAMS_SHIFT 2
312 #define IEEE80211_HT_MCS_TX_MAX_STREAMS_MASK 0x0c
313 #define IEEE80211_HT_MCS_RX_HIGHEST_MASK 0x3ff
314 #define IEEE80211_HT_MCS_MASK_LEN 10
315
316 #define IEEE80211_MLD_MAX_NUM_LINKS 15
317 #define IEEE80211_MLD_CAP_OP_MAX_SIMUL_LINKS 0xf
318 #define IEEE80211_MLD_CAP_OP_TID_TO_LINK_MAP_NEG_SUPP 0x0060
319 #define IEEE80211_MLD_CAP_OP_TID_TO_LINK_MAP_NEG_SUPP_SAME 1
320 #define IEEE80211_MLD_CAP_OP_LINK_RECONF_SUPPORT 0x2000
321
322 struct ieee80211_mcs_info {
323 uint8_t rx_mask[IEEE80211_HT_MCS_MASK_LEN];
324 uint16_t rx_highest;
325 uint8_t tx_params;
326 uint8_t __reserved[3];
327 } __packed;
328
329 /* 802.11-2020, 9.4.2.55.1 HT Capabilities element structure */
330 struct ieee80211_ht_cap {
331 uint16_t cap_info;
332 uint8_t ampdu_params_info;
333 struct ieee80211_mcs_info mcs;
334 uint16_t extended_ht_cap_info;
335 uint32_t tx_BF_cap_info;
336 uint8_t antenna_selection_info;
337 } __packed;
338
339 #define IEEE80211_HT_MAX_AMPDU_FACTOR 13
340 #define IEEE80211_HE_HT_MAX_AMPDU_FACTOR 16
341 #define IEEE80211_HE_VHT_MAX_AMPDU_FACTOR 20
342 #define IEEE80211_HE_6GHZ_MAX_AMPDU_FACTOR 13
343
344 enum ieee80211_ht_max_ampdu_len {
345 IEEE80211_HT_MAX_AMPDU_64K
346 };
347
348 enum ieee80211_ampdu_mlme_action {
349 IEEE80211_AMPDU_RX_START,
350 IEEE80211_AMPDU_RX_STOP,
351 IEEE80211_AMPDU_TX_OPERATIONAL,
352 IEEE80211_AMPDU_TX_START,
353 IEEE80211_AMPDU_TX_STOP_CONT,
354 IEEE80211_AMPDU_TX_STOP_FLUSH,
355 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT
356 };
357
358 #define IEEE80211_AMPDU_TX_START_IMMEDIATE 1
359 #define IEEE80211_AMPDU_TX_START_DELAY_ADDBA 2
360
361 enum ieee80211_chanctx_switch_mode {
362 CHANCTX_SWMODE_REASSIGN_VIF,
363 CHANCTX_SWMODE_SWAP_CONTEXTS,
364 };
365
366 enum ieee80211_chanctx_change_flags {
367 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(0),
368 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(1),
369 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(2),
370 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(3),
371 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(4),
372 IEEE80211_CHANCTX_CHANGE_PUNCTURING = BIT(5),
373 IEEE80211_CHANCTX_CHANGE_MIN_DEF = BIT(6),
374 IEEE80211_CHANCTX_CHANGE_AP = BIT(7),
375 };
376
377 enum ieee80211_frame_release_type {
378 IEEE80211_FRAME_RELEASE_PSPOLL = 1,
379 IEEE80211_FRAME_RELEASE_UAPSD = 2,
380 };
381
382 enum ieee80211_p2p_attr_ids {
383 IEEE80211_P2P_ATTR_DEVICE_ID,
384 IEEE80211_P2P_ATTR_DEVICE_INFO,
385 IEEE80211_P2P_ATTR_GROUP_ID,
386 IEEE80211_P2P_ATTR_LISTEN_CHANNEL,
387 IEEE80211_P2P_ATTR_ABSENCE_NOTICE,
388 };
389
390 enum ieee80211_reconfig_type {
391 IEEE80211_RECONFIG_TYPE_RESTART,
392 IEEE80211_RECONFIG_TYPE_SUSPEND,
393 };
394
395 enum ieee80211_roc_type {
396 IEEE80211_ROC_TYPE_MGMT_TX,
397 IEEE80211_ROC_TYPE_NORMAL,
398 };
399
400 enum ieee80211_smps_mode {
401 IEEE80211_SMPS_OFF,
402 IEEE80211_SMPS_STATIC,
403 IEEE80211_SMPS_DYNAMIC,
404 IEEE80211_SMPS_AUTOMATIC,
405 IEEE80211_SMPS_NUM_MODES,
406 };
407
408 /* net80211::IEEE80211_S_* different but represents the state machine. */
409 /* Note: order here is important! */
410 enum ieee80211_sta_state {
411 IEEE80211_STA_NOTEXIST = 0,
412 IEEE80211_STA_NONE = 1,
413 IEEE80211_STA_AUTH = 2,
414 IEEE80211_STA_ASSOC = 3,
415 IEEE80211_STA_AUTHORIZED = 4, /* 802.1x */
416 };
417
418 enum ieee80211_sta_rx_bandwidth {
419 IEEE80211_STA_RX_BW_20 = 0,
420 IEEE80211_STA_RX_BW_40,
421 IEEE80211_STA_RX_BW_80,
422 IEEE80211_STA_RX_BW_160,
423 IEEE80211_STA_RX_BW_320,
424 };
425
426 enum ieee80211_tx_info_flags {
427 /* XXX TODO .. right shift numbers - not sure where that came from? */
428 IEEE80211_TX_CTL_AMPDU = BIT(0),
429 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
430 IEEE80211_TX_CTL_NO_ACK = BIT(2),
431 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(3),
432 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(4),
433 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(5),
434 IEEE80211_TX_STATUS_EOSP = BIT(6),
435 IEEE80211_TX_STAT_ACK = BIT(7),
436 IEEE80211_TX_STAT_AMPDU = BIT(8),
437 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(9),
438 IEEE80211_TX_STAT_TX_FILTERED = BIT(10),
439 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(11),
440 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(12),
441 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(13),
442 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(14),
443 IEEE80211_TX_CTL_INJECTED = BIT(15),
444 IEEE80211_TX_CTL_HW_80211_ENCAP = BIT(16),
445 IEEE80211_TX_CTL_USE_MINRATE = BIT(17),
446 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(18),
447 IEEE80211_TX_CTL_LDPC = BIT(19),
448 IEEE80211_TX_CTL_STBC = BIT(20),
449 } __packed;
450
451 enum ieee80211_tx_status_flags {
452 IEEE80211_TX_STATUS_ACK_SIGNAL_VALID = BIT(0),
453 };
454
455 enum ieee80211_tx_control_flags {
456 /* XXX TODO .. right shift numbers */
457 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
458 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
459 IEEE80211_TX_CTRL_RATE_INJECT = BIT(2),
460 IEEE80211_TX_CTRL_DONT_USE_RATE_MASK = BIT(3),
461 IEEE80211_TX_CTRL_MLO_LINK = 0xF0000000, /* This is IEEE80211_LINK_UNSPECIFIED on the high bits. */
462 };
463
464 enum ieee80211_tx_rate_flags {
465 /* XXX TODO .. right shift numbers */
466 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(0),
467 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(1),
468 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(2),
469 IEEE80211_TX_RC_GREEN_FIELD = BIT(3),
470 IEEE80211_TX_RC_MCS = BIT(4),
471 IEEE80211_TX_RC_SHORT_GI = BIT(5),
472 IEEE80211_TX_RC_VHT_MCS = BIT(6),
473 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(7),
474 };
475
476 #define IEEE80211_RNR_TBTT_PARAMS_PSD_RESERVED -128
477
478 #define IEEE80211_HT_CTL_LEN 4
479
480 struct ieee80211_hdr { /* net80211::ieee80211_frame_addr4 */
481 __le16 frame_control;
482 __le16 duration_id;
483 uint8_t addr1[ETH_ALEN];
484 uint8_t addr2[ETH_ALEN];
485 uint8_t addr3[ETH_ALEN];
486 __le16 seq_ctrl;
487 uint8_t addr4[ETH_ALEN];
488 };
489
490 struct ieee80211_hdr_3addr { /* net80211::ieee80211_frame */
491 __le16 frame_control;
492 __le16 duration_id;
493 uint8_t addr1[ETH_ALEN];
494 uint8_t addr2[ETH_ALEN];
495 uint8_t addr3[ETH_ALEN];
496 __le16 seq_ctrl;
497 };
498
499 struct ieee80211_qos_hdr { /* net80211:ieee80211_qosframe */
500 __le16 frame_control;
501 __le16 duration_id;
502 uint8_t addr1[ETH_ALEN];
503 uint8_t addr2[ETH_ALEN];
504 uint8_t addr3[ETH_ALEN];
505 __le16 seq_ctrl;
506 __le16 qos_ctrl;
507 };
508
509 struct ieee80211_vendor_ie {
510 };
511
512 /* 802.11-2020, Table 9-359-Block Ack Action field values */
513 enum ieee80211_back {
514 WLAN_ACTION_ADDBA_REQ = 0,
515 };
516
517 enum ieee80211_sa_query {
518 WLAN_ACTION_SA_QUERY_RESPONSE = 1,
519 };
520
521 /* 802.11-2020, Table 9-51-Category values */
522 enum ieee80211_category {
523 WLAN_CATEGORY_BACK = 3,
524 WLAN_CATEGORY_SA_QUERY = 8, /* net80211::IEEE80211_ACTION_CAT_SA_QUERY */
525 };
526
527 /* 80211-2020 9.3.3.2 Format of Management frames */
528 struct ieee80211_mgmt {
529 __le16 frame_control;
530 __le16 duration_id;
531 uint8_t da[ETH_ALEN];
532 uint8_t sa[ETH_ALEN];
533 uint8_t bssid[ETH_ALEN];
534 __le16 seq_ctrl;
535 union {
536 /* 9.3.3.3 Beacon frame format */
537 struct {
538 uint64_t timestamp;
539 uint16_t beacon_int;
540 uint16_t capab_info;
541 uint8_t variable[0];
542 } __packed beacon;
543 /* 9.3.3.5 Association Request frame format */
544 struct {
545 uint16_t capab_info;
546 uint16_t listen_interval;
547 uint8_t variable[0];
548 } __packed assoc_req;
549 /* 9.3.3.10 Probe Request frame format */
550 struct {
551 uint8_t variable[0];
552 } __packed probe_req;
553 /* 9.3.3.11 Probe Response frame format */
554 struct {
555 uint64_t timestamp;
556 uint16_t beacon_int;
557 uint16_t capab_info;
558 uint8_t variable[0];
559 } __packed probe_resp;
560 /* 9.3.3.14 Action frame format */
561 struct {
562 /* 9.4.1.11 Action field */
563 uint8_t category;
564 /* 9.6.8 Public Action details */
565 union {
566 /* 9.6.2.5 TPC Report frame format */
567 struct {
568 uint8_t spec_mgmt;
569 uint8_t dialog_token;
570 /* uint32_t tpc_rep_elem:: */
571 uint8_t tpc_elem_id;
572 uint8_t tpc_elem_length;
573 uint8_t tpc_elem_tx_power;
574 uint8_t tpc_elem_link_margin;
575 } __packed tpc_report;
576 /* 802.11-2024, 9.6.7.32 FTM Request frame format */
577 struct {
578 uint8_t public_action;
579 uint8_t trigger;
580 uint8_t variable[0];
581 } __packed ftmr;
582 /* 802.11az-2022, 9.6.7.33 Fine Timing Measurement (FTM) frame format */
583 /* XXX CHANGED IN 802.11-2024, 9.6.7.33 Fine Timing Measurement frame format */
584 struct {
585 uint8_t public_action;
586 uint8_t dialog_token;
587 uint8_t follow_up;
588 uint8_t tod[6];
589 uint8_t toa[6];
590 uint16_t tod_error;
591 uint16_t toa_error;
592 uint8_t variable[0];
593 } __packed ftm;
594 /* 802.11-2024, 9.6.4.2 ADDBA Request frame format */
595 struct {
596 uint8_t action_code;
597 uint8_t dialog_token;
598 uint16_t capab;
599 uint16_t timeout;
600 uint16_t start_seq_num;
601 /* Optional follows... */
602 uint8_t variable[0];
603 } __packed addba_req;
604 /* 802.11-2024, 9.6.13.3 Event Report frame format */
605 struct {
606 uint8_t wnm_action;
607 uint8_t dialog_token;
608 /* Optional follows... */
609 uint8_t variable[0];
610 } __packed wnm_timing_msr;
611 } u;
612 } __packed action;
613 DECLARE_FLEX_ARRAY(uint8_t, body);
614 } u;
615 } __packed __aligned(2);
616
617 struct ieee80211_cts { /* net80211::ieee80211_frame_cts */
618 __le16 frame_control;
619 __le16 duration;
620 uint8_t ra[ETH_ALEN];
621 } __packed;
622
623 struct ieee80211_rts { /* net80211::ieee80211_frame_rts */
624 __le16 frame_control;
625 __le16 duration;
626 uint8_t ra[ETH_ALEN];
627 uint8_t ta[ETH_ALEN];
628 } __packed;
629
630 #define MHZ_TO_KHZ(_f) ((_f) * 1000)
631 #define DBI_TO_MBI(_g) ((_g) * 100)
632 #define MBI_TO_DBI(_x) ((_x) / 100)
633 #define DBM_TO_MBM(_g) ((_g) * 100)
634 #define MBM_TO_DBM(_x) ((_x) / 100)
635
636 #define IEEE80211_SEQ_TO_SN(_seqn) (((_seqn) & IEEE80211_SEQ_SEQ_MASK) >> \
637 IEEE80211_SEQ_SEQ_SHIFT)
638 #define IEEE80211_SN_TO_SEQ(_sn) (((_sn) << IEEE80211_SEQ_SEQ_SHIFT) & \
639 IEEE80211_SEQ_SEQ_MASK)
640
641 /* Time unit (TU) to .. See net80211: IEEE80211_DUR_TU */
642 #define TU_TO_JIFFIES(_tu) (usecs_to_jiffies(_tu) * 1024)
643 #define TU_TO_EXP_TIME(_tu) (jiffies + TU_TO_JIFFIES(_tu))
644
645 /* 9.4.2.21.1, Table 9-82. */
646 #define IEEE80211_SPCT_MSR_RPRT_TYPE_LCI 8
647 #define IEEE80211_SPCT_MSR_RPRT_TYPE_CIVIC 11
648
649 /* 9.4.2.1, Table 9-77. Element IDs. */
650 enum ieee80211_eid {
651 WLAN_EID_SSID = 0,
652 WLAN_EID_SUPP_RATES = 1,
653 WLAN_EID_DS_PARAMS = 3,
654 WLAN_EID_TIM = 5,
655 WLAN_EID_COUNTRY = 7, /* IEEE80211_ELEMID_COUNTRY */
656 WLAN_EID_REQUEST = 10,
657 WLAN_EID_QBSS_LOAD = 11, /* IEEE80211_ELEMID_BSSLOAD */
658 WLAN_EID_CHANNEL_SWITCH = 37,
659 WLAN_EID_MEASURE_REPORT = 39,
660 WLAN_EID_HT_CAPABILITY = 45, /* IEEE80211_ELEMID_HTCAP */
661 WLAN_EID_RSN = 48, /* IEEE80211_ELEMID_RSN */
662 WLAN_EID_EXT_SUPP_RATES = 50,
663 WLAN_EID_EXT_NON_INHERITANCE = 56,
664 WLAN_EID_EXT_CHANSWITCH_ANN = 60,
665 WLAN_EID_MULTIPLE_BSSID = 71, /* IEEE80211_ELEMID_MULTIBSSID */
666 WLAN_EID_MULTI_BSSID_IDX = 85,
667 WLAN_EID_EXT_CAPABILITY = 127,
668 WLAN_EID_VHT_CAPABILITY = 191, /* IEEE80211_ELEMID_VHT_CAP */
669 WLAN_EID_S1G_TWT = 216,
670 WLAN_EID_VENDOR_SPECIFIC = 221, /* IEEE80211_ELEMID_VENDOR */
671 };
672
673 enum ieee80211_eid_ext {
674 WLAN_EID_EXT_HE_CAPABILITY = 35,
675 };
676
677 #define for_each_element(_elem, _data, _len) \
678 for (_elem = (const struct element *)(_data); \
679 (((const uint8_t *)(_data) + (_len) - (const uint8_t *)_elem) >= sizeof(*_elem)) && \
680 (((const uint8_t *)(_data) + (_len) - (const uint8_t *)_elem) >= (sizeof(*_elem) + _elem->datalen)); \
681 _elem = (const struct element *)(_elem->data + _elem->datalen))
682
683 #define for_each_element_id(_elem, _eid, _data, _len) \
684 for_each_element(_elem, _data, _len) \
685 if (_elem->id == (_eid))
686
687 /* 9.4.1.7, Table 9-45. Reason codes. */
688 enum ieee80211_reason_code {
689 /* reserved = 0, */
690 WLAN_REASON_UNSPECIFIED = 1,
691 WLAN_REASON_DEAUTH_LEAVING = 3, /* LEAVING_NETWORK_DEAUTH */
692 WLAN_REASON_TDLS_TEARDOWN_UNREACHABLE = 25,
693 WLAN_REASON_TDLS_TEARDOWN_UNSPECIFIED = 26,
694 };
695
696 /* 9.4.1.9, Table 9-46. Status codes. */
697 enum ieee80211_status_code {
698 WLAN_STATUS_SUCCESS = 0,
699 WLAN_STATUS_AUTH_TIMEOUT = 16, /* REJECTED_SEQUENCE_TIMEOUT */
700 };
701
702 /* 9.3.1.22 Trigger frame format; 80211ax-2021 */
703 struct ieee80211_trigger {
704 __le16 frame_control;
705 __le16 duration_id;
706 uint8_t ra[ETH_ALEN];
707 uint8_t ta[ETH_ALEN];
708 __le64 common_info; /* 8+ really */
709 uint8_t variable[];
710 };
711
712 /* Table 9-29c-Trigger Type subfield encoding */
713 enum {
714 IEEE80211_TRIGGER_TYPE_BASIC = 0x0,
715 IEEE80211_TRIGGER_TYPE_MU_BAR = 0x2,
716 #if 0
717 /* Not seen yet. */
718 BFRP = 0x1,
719 MU-RTS = 0x3,
720 BSRP = 0x4,
721 GCR MU-BAR = 0x5,
722 BQRP = 0x6,
723 NFRP = 0x7,
724 /* 0x8..0xf reserved */
725 #endif
726 IEEE80211_TRIGGER_TYPE_MASK = 0xf
727 };
728
729 #define IEEE80211_TRIGGER_ULBW_MASK 0xc0000
730 #define IEEE80211_TRIGGER_ULBW_20MHZ 0x0
731 #define IEEE80211_TRIGGER_ULBW_40MHZ 0x1
732 #define IEEE80211_TRIGGER_ULBW_80MHZ 0x2
733 #define IEEE80211_TRIGGER_ULBW_160_80P80MHZ 0x3
734
735 /* 802.11-2020, Figure 9-687-Control field format; 802.11ax-2021 */
736 #define IEEE80211_TWT_CONTROL_NEG_TYPE_BROADCAST BIT(3)
737 #define IEEE80211_TWT_CONTROL_RX_DISABLED BIT(4)
738 #define IEEE80211_TWT_CONTROL_WAKE_DUR_UNIT BIT(5)
739
740 /* 802.11-2020, Figure 9-688-Request Type field format; 802.11ax-2021 */
741 #define IEEE80211_TWT_REQTYPE_SETUP_CMD (BIT(1) | BIT(2) | BIT(3))
742 #define IEEE80211_TWT_REQTYPE_TRIGGER BIT(4)
743 #define IEEE80211_TWT_REQTYPE_IMPLICIT BIT(5)
744 #define IEEE80211_TWT_REQTYPE_FLOWTYPE BIT(6)
745 #define IEEE80211_TWT_REQTYPE_FLOWID (BIT(7) | BIT(8) | BIT(9))
746 #define IEEE80211_TWT_REQTYPE_WAKE_INT_EXP (BIT(10) | BIT(11) | BIT(12) | BIT(13) | BIT(14))
747 #define IEEE80211_TWT_REQTYPE_PROTECTION BIT(15)
748
749 struct ieee80211_twt_params {
750 int mantissa, min_twt_dur, twt;
751 uint16_t req_type;
752 };
753
754 struct ieee80211_twt_setup {
755 int control;
756 struct ieee80211_twt_params *params;
757 };
758
759 /* 802.11-2020, Table 9-297-TWT Setup Command field values */
760 enum ieee80211_twt_setup_cmd {
761 TWT_SETUP_CMD_REQUEST = 0,
762 TWT_SETUP_CMD_SUGGEST = 1,
763 /* DEMAND = 2, */
764 /* GROUPING = 3, */
765 TWT_SETUP_CMD_ACCEPT = 4,
766 /* ALTERNATE = 5 */
767 TWT_SETUP_CMD_DICTATE = 6,
768 TWT_SETUP_CMD_REJECT = 7,
769 };
770
771 struct ieee80211_bssid_index {
772 int bssid_index;
773 };
774
775 enum ieee80211_ap_reg_power {
776 IEEE80211_REG_UNSET_AP,
777 IEEE80211_REG_LPI_AP,
778 IEEE80211_REG_SP_AP,
779 IEEE80211_REG_VLP_AP,
780 };
781
782 /*
783 * 802.11ax-2021, Table 9-277-Meaning of Maximum Transmit Power Count subfield
784 * if Maximum Transmit Power Interpretation subfield is 1 or 3
785 */
786 #define IEEE80211_MAX_NUM_PWR_LEVEL 8
787
788 /*
789 * 802.11ax-2021, Table 9-275a-Maximum Transmit Power Interpretation subfield
790 * encoding (4) * Table E-12-Regulatory Info subfield encoding in the
791 * United States (2)
792 */
793 #define IEEE80211_TPE_MAX_IE_NUM 8
794
795 /* 802.11ax-2021, 9.4.2.161 Transmit Power Envelope element */
796 struct ieee80211_tx_pwr_env {
797 uint8_t tx_power_info;
798 uint8_t tx_power[IEEE80211_MAX_NUM_PWR_LEVEL];
799 };
800
801 /* 802.11ax-2021, Figure 9-617-Transmit Power Information field format */
802 /* These are field masks (3bit/3bit/2bit). */
803 #define IEEE80211_TX_PWR_ENV_INFO_COUNT 0x07
804 #define IEEE80211_TX_PWR_ENV_INFO_INTERPRET 0x38
805 #define IEEE80211_TX_PWR_ENV_INFO_CATEGORY 0xc0
806
807 /*
808 * 802.11ax-2021, Table 9-275a-Maximum Transmit Power Interpretation subfield
809 * encoding
810 */
811 enum ieee80211_tx_pwr_interpretation_subfield_enc {
812 IEEE80211_TPE_LOCAL_EIRP,
813 IEEE80211_TPE_LOCAL_EIRP_PSD,
814 IEEE80211_TPE_REG_CLIENT_EIRP,
815 IEEE80211_TPE_REG_CLIENT_EIRP_PSD,
816 };
817
818 enum ieee80211_tx_pwr_category_6ghz {
819 IEEE80211_TPE_CAT_6GHZ_DEFAULT,
820 };
821
822 /* 802.11-2020, 9.4.2.27 BSS Load element */
823 struct ieee80211_bss_load_elem {
824 uint16_t sta_count;
825 uint8_t channel_util;
826 uint16_t avail_adm_capa;
827 };
828
829 struct ieee80211_p2p_noa_desc {
830 uint32_t count; /* uint8_t ? */
831 uint32_t duration;
832 uint32_t interval;
833 uint32_t start_time;
834 };
835
836 struct ieee80211_p2p_noa_attr {
837 uint8_t index;
838 uint8_t oppps_ctwindow;
839 struct ieee80211_p2p_noa_desc desc[4];
840 };
841
842
843 /* net80211: IEEE80211_IS_CTL() */
844 static __inline bool
ieee80211_is_ctl(__le16 fc)845 ieee80211_is_ctl(__le16 fc)
846 {
847 __le16 v;
848
849 fc &= htole16(IEEE80211_FC0_TYPE_MASK);
850 v = htole16(IEEE80211_FC0_TYPE_CTL);
851
852 return (fc == v);
853 }
854
855 /* net80211: IEEE80211_IS_DATA() */
856 static __inline bool
ieee80211_is_data(__le16 fc)857 ieee80211_is_data(__le16 fc)
858 {
859 __le16 v;
860
861 fc &= htole16(IEEE80211_FC0_TYPE_MASK);
862 v = htole16(IEEE80211_FC0_TYPE_DATA);
863
864 return (fc == v);
865 }
866
867 /* net80211: IEEE80211_IS_QOSDATA() */
868 static __inline bool
ieee80211_is_data_qos(__le16 fc)869 ieee80211_is_data_qos(__le16 fc)
870 {
871 __le16 v;
872
873 fc &= htole16(IEEE80211_FC0_SUBTYPE_QOS_DATA | IEEE80211_FC0_TYPE_MASK);
874 v = htole16(IEEE80211_FC0_SUBTYPE_QOS_DATA | IEEE80211_FC0_TYPE_DATA);
875
876 return (fc == v);
877 }
878
879 /* net80211: IEEE80211_IS_MGMT() */
880 static __inline bool
ieee80211_is_mgmt(__le16 fc)881 ieee80211_is_mgmt(__le16 fc)
882 {
883 __le16 v;
884
885 fc &= htole16(IEEE80211_FC0_TYPE_MASK);
886 v = htole16(IEEE80211_FC0_TYPE_MGT);
887
888 return (fc == v);
889 }
890
891
892 /* Derived from net80211::ieee80211_anyhdrsize. */
893 static __inline unsigned int
ieee80211_hdrlen(__le16 fc)894 ieee80211_hdrlen(__le16 fc)
895 {
896 unsigned int size;
897
898 if (ieee80211_is_ctl(fc)) {
899 switch (fc & htole16(IEEE80211_FC0_SUBTYPE_MASK)) {
900 case htole16(IEEE80211_FC0_SUBTYPE_CTS):
901 case htole16(IEEE80211_FC0_SUBTYPE_ACK):
902 return sizeof(struct ieee80211_frame_ack);
903 case htole16(IEEE80211_FC0_SUBTYPE_BAR):
904 return sizeof(struct ieee80211_frame_bar);
905 }
906 return (sizeof(struct ieee80211_frame_min));
907 }
908
909 size = sizeof(struct ieee80211_frame);
910 if (ieee80211_is_data(fc)) {
911 if ((fc & htole16(IEEE80211_FC1_DIR_MASK << 8)) ==
912 htole16(IEEE80211_FC1_DIR_DSTODS << 8))
913 size += IEEE80211_ADDR_LEN;
914 if ((fc & htole16(IEEE80211_FC0_SUBTYPE_QOS_DATA |
915 IEEE80211_FC0_TYPE_MASK)) ==
916 htole16(IEEE80211_FC0_SUBTYPE_QOS_DATA |
917 IEEE80211_FC0_TYPE_DATA))
918 size += sizeof(uint16_t);
919 }
920
921 if (ieee80211_is_mgmt(fc)) {
922 #ifdef __notyet__
923 printf("XXX-BZ %s: TODO? fc %#04x size %u\n",
924 __func__, fc, size);
925 #endif
926 ;
927 }
928
929 return (size);
930 }
931
932 static inline bool
ieee80211_is_trigger(__le16 fc)933 ieee80211_is_trigger(__le16 fc)
934 {
935 __le16 v;
936
937 fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
938 v = htole16(IEEE80211_FC0_SUBTYPE_TRIGGER | IEEE80211_FC0_TYPE_CTL);
939
940 return (fc == v);
941 }
942
943 static __inline bool
ieee80211_is_action(__le16 fc)944 ieee80211_is_action(__le16 fc)
945 {
946 __le16 v;
947
948 fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
949 v = htole16(IEEE80211_FC0_SUBTYPE_ACTION | IEEE80211_FC0_TYPE_MGT);
950
951 return (fc == v);
952 }
953
954 static __inline bool
ieee80211_is_probe_resp(__le16 fc)955 ieee80211_is_probe_resp(__le16 fc)
956 {
957 __le16 v;
958
959 fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
960 v = htole16(IEEE80211_FC0_SUBTYPE_PROBE_RESP | IEEE80211_FC0_TYPE_MGT);
961
962 return (fc == v);
963 }
964
965 static __inline bool
ieee80211_is_auth(__le16 fc)966 ieee80211_is_auth(__le16 fc)
967 {
968 __le16 v;
969
970 fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
971 v = htole16(IEEE80211_FC0_SUBTYPE_AUTH | IEEE80211_FC0_TYPE_MGT);
972
973 return (fc == v);
974 }
975
976 static __inline bool
ieee80211_is_assoc_req(__le16 fc)977 ieee80211_is_assoc_req(__le16 fc)
978 {
979 __le16 v;
980
981 fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
982 v = htole16(IEEE80211_FC0_SUBTYPE_ASSOC_REQ | IEEE80211_FC0_TYPE_MGT);
983
984 return (fc == v);
985 }
986
987 static __inline bool
ieee80211_is_assoc_resp(__le16 fc)988 ieee80211_is_assoc_resp(__le16 fc)
989 {
990 __le16 v;
991
992 fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
993 v = htole16(IEEE80211_FC0_SUBTYPE_ASSOC_RESP | IEEE80211_FC0_TYPE_MGT);
994
995 return (fc == v);
996 }
997
998 static __inline bool
ieee80211_is_reassoc_req(__le16 fc)999 ieee80211_is_reassoc_req(__le16 fc)
1000 {
1001 __le16 v;
1002
1003 fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1004 v = htole16(IEEE80211_FC0_SUBTYPE_REASSOC_REQ | IEEE80211_FC0_TYPE_MGT);
1005
1006 return (fc == v);
1007 }
1008
1009 static __inline bool
ieee80211_is_reassoc_resp(__le16 fc)1010 ieee80211_is_reassoc_resp(__le16 fc)
1011 {
1012 __le16 v;
1013
1014 fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1015 v = htole16(IEEE80211_FC0_SUBTYPE_REASSOC_RESP | IEEE80211_FC0_TYPE_MGT);
1016
1017 return (fc == v);
1018 }
1019
1020 static __inline bool
ieee80211_is_disassoc(__le16 fc)1021 ieee80211_is_disassoc(__le16 fc)
1022 {
1023 __le16 v;
1024
1025 fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1026 v = htole16(IEEE80211_FC0_SUBTYPE_DISASSOC | IEEE80211_FC0_TYPE_MGT);
1027
1028 return (fc == v);
1029 }
1030
1031 static __inline bool
ieee80211_is_data_present(__le16 fc)1032 ieee80211_is_data_present(__le16 fc)
1033 {
1034 __le16 v;
1035
1036 /* If it is a data frame and NODATA is not present. */
1037 fc &= htole16(IEEE80211_FC0_TYPE_MASK | IEEE80211_FC0_SUBTYPE_NODATA);
1038 v = htole16(IEEE80211_FC0_TYPE_DATA);
1039
1040 return (fc == v);
1041 }
1042
1043 static __inline bool
ieee80211_is_deauth(__le16 fc)1044 ieee80211_is_deauth(__le16 fc)
1045 {
1046 __le16 v;
1047
1048 fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1049 v = htole16(IEEE80211_FC0_SUBTYPE_DEAUTH | IEEE80211_FC0_TYPE_MGT);
1050
1051 return (fc == v);
1052 }
1053
1054 static __inline bool
ieee80211_is_beacon(__le16 fc)1055 ieee80211_is_beacon(__le16 fc)
1056 {
1057 __le16 v;
1058
1059 /*
1060 * For as much as I get it this comes in LE and unlike FreeBSD
1061 * where we get the entire frame header and u8[], here we get the
1062 * 9.2.4.1 Frame Control field only. Mask and compare.
1063 */
1064 fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1065 v = htole16(IEEE80211_FC0_SUBTYPE_BEACON | IEEE80211_FC0_TYPE_MGT);
1066
1067 return (fc == v);
1068 }
1069
1070
1071 static __inline bool
ieee80211_is_probe_req(__le16 fc)1072 ieee80211_is_probe_req(__le16 fc)
1073 {
1074 __le16 v;
1075
1076 fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1077 v = htole16(IEEE80211_FC0_SUBTYPE_PROBE_REQ | IEEE80211_FC0_TYPE_MGT);
1078
1079 return (fc == v);
1080 }
1081
1082 static __inline bool
ieee80211_has_protected(__le16 fc)1083 ieee80211_has_protected(__le16 fc)
1084 {
1085
1086 return (fc & htole16(IEEE80211_FC1_PROTECTED << 8));
1087 }
1088
1089 static __inline bool
ieee80211_is_back_req(__le16 fc)1090 ieee80211_is_back_req(__le16 fc)
1091 {
1092 __le16 v;
1093
1094 fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1095 v = htole16(IEEE80211_FC0_SUBTYPE_BAR | IEEE80211_FC0_TYPE_CTL);
1096
1097 return (fc == v);
1098 }
1099
1100 static __inline bool
ieee80211_is_bufferable_mmpdu(struct sk_buff * skb)1101 ieee80211_is_bufferable_mmpdu(struct sk_buff *skb)
1102 {
1103 struct ieee80211_mgmt *mgmt;
1104 __le16 fc;
1105
1106 KASSERT(skb->len >= sizeof(fc), ("%s: skb %p short len %d\n",
1107 __func__, skb, skb->len));
1108
1109 mgmt = (struct ieee80211_mgmt *)skb->data;
1110 fc = mgmt->frame_control;
1111
1112 /* 11.2.2 Bufferable MMPDUs, 802.11-2024. */
1113 IMPROVE("XXX IBBS");
1114
1115 if (!ieee80211_is_mgmt(fc))
1116 return (false);
1117 if (ieee80211_is_disassoc(fc))
1118 return (true);
1119 if (ieee80211_is_deauth(fc))
1120 return (true);
1121 if (!ieee80211_is_action(fc))
1122 return (false);
1123
1124 /*
1125 * Now we know it is an action frame, so we can check for a proper
1126 * length before accessing any further data to check if it is an
1127 * FTM/FTMR, which is non-bufferable.
1128 * 9.6.7.32 FTM Request frame format
1129 * 9.6.7.33 FTM frame format
1130 */
1131 if (skb->len < offsetofend(typeof(*mgmt), u.action.u.ftm.public_action))
1132 return (false);
1133
1134 if (mgmt->u.action.category != IEEE80211_ACTION_CAT_PUBLIC)
1135 return (false);
1136
1137 if (mgmt->u.action.u.ftm.public_action == 33 || /* FTM xxx defines? */
1138 mgmt->u.action.u.ftmr.public_action == 32) /* FTMR xxx defines? */
1139 return (false);
1140
1141 return (true);
1142 }
1143
1144 static __inline bool
ieee80211_is_nullfunc(__le16 fc)1145 ieee80211_is_nullfunc(__le16 fc)
1146 {
1147 __le16 v;
1148
1149 fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1150 v = htole16(IEEE80211_FC0_SUBTYPE_NODATA | IEEE80211_FC0_TYPE_DATA);
1151
1152 return (fc == v);
1153 }
1154
1155 static __inline bool
ieee80211_is_qos_nullfunc(__le16 fc)1156 ieee80211_is_qos_nullfunc(__le16 fc)
1157 {
1158 __le16 v;
1159
1160 fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1161 v = htole16(IEEE80211_FC0_SUBTYPE_QOS_NULL | IEEE80211_FC0_TYPE_DATA);
1162
1163 return (fc == v);
1164 }
1165
1166 static __inline bool
ieee80211_is_any_nullfunc(__le16 fc)1167 ieee80211_is_any_nullfunc(__le16 fc)
1168 {
1169
1170 return (ieee80211_is_nullfunc(fc) || ieee80211_is_qos_nullfunc(fc));
1171 }
1172
1173 static inline bool
ieee80211_is_pspoll(__le16 fc)1174 ieee80211_is_pspoll(__le16 fc)
1175 {
1176 __le16 v;
1177
1178 fc &= htole16(IEEE80211_FC0_SUBTYPE_MASK | IEEE80211_FC0_TYPE_MASK);
1179 v = htole16(IEEE80211_FC0_SUBTYPE_PS_POLL | IEEE80211_FC0_TYPE_CTL);
1180
1181 return (fc == v);
1182 }
1183
1184 static __inline bool
ieee80211_has_a4(__le16 fc)1185 ieee80211_has_a4(__le16 fc)
1186 {
1187 __le16 v;
1188
1189 fc &= htole16((IEEE80211_FC1_DIR_TODS | IEEE80211_FC1_DIR_FROMDS) << 8);
1190 v = htole16((IEEE80211_FC1_DIR_TODS | IEEE80211_FC1_DIR_FROMDS) << 8);
1191
1192 return (fc == v);
1193 }
1194
1195 static __inline bool
ieee80211_has_order(__le16 fc)1196 ieee80211_has_order(__le16 fc)
1197 {
1198
1199 return (fc & htole16(IEEE80211_FC1_ORDER << 8));
1200 }
1201
1202 static __inline bool
ieee80211_has_retry(__le16 fc)1203 ieee80211_has_retry(__le16 fc)
1204 {
1205
1206 return (fc & htole16(IEEE80211_FC1_RETRY << 8));
1207 }
1208
1209
1210 static __inline bool
ieee80211_has_fromds(__le16 fc)1211 ieee80211_has_fromds(__le16 fc)
1212 {
1213
1214 return (fc & htole16(IEEE80211_FC1_DIR_FROMDS << 8));
1215 }
1216
1217 static __inline bool
ieee80211_has_tods(__le16 fc)1218 ieee80211_has_tods(__le16 fc)
1219 {
1220
1221 return (fc & htole16(IEEE80211_FC1_DIR_TODS << 8));
1222 }
1223
1224 static __inline uint8_t *
ieee80211_get_SA(struct ieee80211_hdr * hdr)1225 ieee80211_get_SA(struct ieee80211_hdr *hdr)
1226 {
1227
1228 if (ieee80211_has_a4(hdr->frame_control))
1229 return (hdr->addr4);
1230 if (ieee80211_has_fromds(hdr->frame_control))
1231 return (hdr->addr3);
1232 return (hdr->addr2);
1233 }
1234
1235 static __inline uint8_t *
ieee80211_get_DA(struct ieee80211_hdr * hdr)1236 ieee80211_get_DA(struct ieee80211_hdr *hdr)
1237 {
1238
1239 if (ieee80211_has_tods(hdr->frame_control))
1240 return (hdr->addr3);
1241 return (hdr->addr1);
1242 }
1243
1244 static __inline bool
ieee80211_has_morefrags(__le16 fc)1245 ieee80211_has_morefrags(__le16 fc)
1246 {
1247
1248 fc &= htole16(IEEE80211_FC1_MORE_FRAG << 8);
1249 return (fc != 0);
1250 }
1251
1252 static __inline bool
ieee80211_is_frag(struct ieee80211_hdr * hdr)1253 ieee80211_is_frag(struct ieee80211_hdr *hdr)
1254 {
1255 return (ieee80211_has_morefrags(hdr->frame_control) ||
1256 (hdr->seq_ctrl & htole16(IEEE80211_SEQ_FRAG_MASK)) != 0);
1257 }
1258
1259 static __inline bool
ieee80211_is_first_frag(__le16 seq_ctrl)1260 ieee80211_is_first_frag(__le16 seq_ctrl)
1261 {
1262 return ((seq_ctrl & htole16(IEEE80211_SEQ_FRAG_MASK)) == 0);
1263 }
1264
1265 static __inline bool
ieee80211_is_robust_mgmt_frame(struct sk_buff * skb)1266 ieee80211_is_robust_mgmt_frame(struct sk_buff *skb)
1267 {
1268 struct ieee80211_mgmt *mgmt;
1269
1270 if (skb->len < sizeof(mgmt->frame_control))
1271 return (false);
1272 mgmt = (struct ieee80211_mgmt *)skb->data;
1273
1274 /* 802.11-2024, 12.2.7 Requirements for management frame protection */
1275
1276 if (ieee80211_is_disassoc(mgmt->frame_control))
1277 return (true);
1278 if (ieee80211_is_deauth(mgmt->frame_control))
1279 return (true);
1280
1281 if (!ieee80211_is_action(mgmt->frame_control))
1282 return (false);
1283
1284 /*
1285 * If the action frame is a protected frame the peer has already
1286 * decided that it is a robust mgmt frame.
1287 * This is not exactly in the books but maintaining the below
1288 * table will go out of sync eventually and this can save us.
1289 */
1290 if (ieee80211_has_protected(mgmt->frame_control))
1291 return (true);
1292
1293 /*
1294 * 802.11-2024, 9.4.1.11 Action Fields,
1295 * Table 9-81-Category values; check for the ones marked Robust: no.
1296 */
1297 /* Check length again before accessing more data. */
1298 if (skb->len < offsetofend(typeof(*mgmt), u.action.category))
1299 return (false);
1300
1301 switch (mgmt->u.action.category) {
1302 case 4: /* Public */
1303 case 7: /* HT */
1304 case 11: /* Unprotected WNM */
1305 /* 12 */ /* TDLS */
1306 case 15: /* Self-protected */
1307 case 20: /* Unprotected DMG */
1308 case 21: /* VHT */
1309 case 22: /* Unprotected S1G */
1310 case 30: /* HE */
1311 case 127: /* Vendor-specific */
1312 return (false);
1313 default:
1314 return (true);
1315 }
1316 }
1317
1318 static __inline bool
ieee80211_is_ftm(struct sk_buff * skb)1319 ieee80211_is_ftm(struct sk_buff *skb)
1320 {
1321 struct ieee80211_mgmt *mgmt;
1322
1323 /* First check length before accessing data. */
1324 if (skb->len < offsetofend(typeof(*mgmt), u.action.u.ftm.public_action))
1325 return (false);
1326
1327 mgmt = (struct ieee80211_mgmt *)skb->data;
1328 if (!ieee80211_is_action(mgmt->frame_control))
1329 return (false);
1330 if (mgmt->u.action.category != IEEE80211_ACTION_CAT_PUBLIC)
1331 return (false);
1332 if (mgmt->u.action.u.ftm.public_action == 33) /* FTM xxx defines? */
1333 return (true);
1334
1335 return (false);
1336 }
1337
1338 static __inline bool
ieee80211_is_timing_measurement(struct sk_buff * skb)1339 ieee80211_is_timing_measurement(struct sk_buff *skb)
1340 {
1341 struct ieee80211_mgmt *mgmt;
1342
1343 /* First check length before accessing data. */
1344 if (skb->len < offsetofend(typeof(*mgmt), u.action.u.wnm_timing_msr.wnm_action))
1345 return (false);
1346
1347 mgmt = (struct ieee80211_mgmt *)skb->data;
1348 if (!ieee80211_is_action(mgmt->frame_control))
1349 return (false);
1350
1351 if (mgmt->u.action.category != IEEE80211_ACTION_CAT_UNPROTECTED_WNM)
1352 return (false);
1353 if (mgmt->u.action.u.wnm_timing_msr.wnm_action == 1) /* Event Report xxx defines? */
1354 return (true);
1355
1356 return (false);
1357 }
1358
1359 static __inline bool
ieee80211_has_pm(__le16 fc)1360 ieee80211_has_pm(__le16 fc)
1361 {
1362 fc &= htole16(IEEE80211_FC1_PWR_MGT << 8);
1363 return (fc != 0);
1364 }
1365
1366 static __inline u8 *
ieee80211_get_qos_ctl(struct ieee80211_hdr * hdr)1367 ieee80211_get_qos_ctl(struct ieee80211_hdr *hdr)
1368 {
1369 if (ieee80211_has_a4(hdr->frame_control))
1370 return (u8 *)hdr + 30;
1371 else
1372 return (u8 *)hdr + 24;
1373 }
1374
1375 #endif /* _LINUXKPI_LINUX_IEEE80211_H */
1376