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