xref: /linux/include/net/cfg80211.h (revision 0ce92d548b44649a8de706f9bb9e74a4ed2f18a7)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 #ifndef __NET_CFG80211_H
3 #define __NET_CFG80211_H
4 /*
5  * 802.11 device and configuration interface
6  *
7  * Copyright 2006-2010	Johannes Berg <johannes@sipsolutions.net>
8  * Copyright 2013-2014 Intel Mobile Communications GmbH
9  * Copyright 2015-2017	Intel Deutschland GmbH
10  * Copyright (C) 2018-2025 Intel Corporation
11  */
12 
13 #include <linux/ethtool.h>
14 #include <uapi/linux/rfkill.h>
15 #include <linux/netdevice.h>
16 #include <linux/debugfs.h>
17 #include <linux/list.h>
18 #include <linux/bug.h>
19 #include <linux/netlink.h>
20 #include <linux/skbuff.h>
21 #include <linux/nl80211.h>
22 #include <linux/if_ether.h>
23 #include <linux/ieee80211.h>
24 #include <linux/net.h>
25 #include <linux/rfkill.h>
26 #include <net/regulatory.h>
27 
28 /**
29  * DOC: Introduction
30  *
31  * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
32  * userspace and drivers, and offers some utility functionality associated
33  * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
34  * by all modern wireless drivers in Linux, so that they offer a consistent
35  * API through nl80211. For backward compatibility, cfg80211 also offers
36  * wireless extensions to userspace, but hides them from drivers completely.
37  *
38  * Additionally, cfg80211 contains code to help enforce regulatory spectrum
39  * use restrictions.
40  */
41 
42 
43 /**
44  * DOC: Device registration
45  *
46  * In order for a driver to use cfg80211, it must register the hardware device
47  * with cfg80211. This happens through a number of hardware capability structs
48  * described below.
49  *
50  * The fundamental structure for each device is the 'wiphy', of which each
51  * instance describes a physical wireless device connected to the system. Each
52  * such wiphy can have zero, one, or many virtual interfaces associated with
53  * it, which need to be identified as such by pointing the network interface's
54  * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
55  * the wireless part of the interface. Normally this struct is embedded in the
56  * network interface's private data area. Drivers can optionally allow creating
57  * or destroying virtual interfaces on the fly, but without at least one or the
58  * ability to create some the wireless device isn't useful.
59  *
60  * Each wiphy structure contains device capability information, and also has
61  * a pointer to the various operations the driver offers. The definitions and
62  * structures here describe these capabilities in detail.
63  */
64 
65 struct wiphy;
66 
67 /*
68  * wireless hardware capability structures
69  */
70 
71 /**
72  * enum ieee80211_channel_flags - channel flags
73  *
74  * Channel flags set by the regulatory control code.
75  *
76  * @IEEE80211_CHAN_DISABLED: This channel is disabled.
77  * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
78  *	sending probe requests or beaconing.
79  * @IEEE80211_CHAN_PSD: Power spectral density (in dBm) is set for this
80  *	channel.
81  * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
82  * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
83  *	is not permitted.
84  * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
85  *	is not permitted.
86  * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
87  * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
88  *	this flag indicates that an 80 MHz channel cannot use this
89  *	channel as the control or any of the secondary channels.
90  *	This may be due to the driver or due to regulatory bandwidth
91  *	restrictions.
92  * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
93  *	this flag indicates that an 160 MHz channel cannot use this
94  *	channel as the control or any of the secondary channels.
95  *	This may be due to the driver or due to regulatory bandwidth
96  *	restrictions.
97  * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
98  * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
99  * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
100  *	on this channel.
101  * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
102  *	on this channel.
103  * @IEEE80211_CHAN_NO_HE: HE operation is not permitted on this channel.
104  * @IEEE80211_CHAN_1MHZ: 1 MHz bandwidth is permitted
105  *	on this channel.
106  * @IEEE80211_CHAN_2MHZ: 2 MHz bandwidth is permitted
107  *	on this channel.
108  * @IEEE80211_CHAN_4MHZ: 4 MHz bandwidth is permitted
109  *	on this channel.
110  * @IEEE80211_CHAN_8MHZ: 8 MHz bandwidth is permitted
111  *	on this channel.
112  * @IEEE80211_CHAN_16MHZ: 16 MHz bandwidth is permitted
113  *	on this channel.
114  * @IEEE80211_CHAN_NO_320MHZ: If the driver supports 320 MHz on the band,
115  *	this flag indicates that a 320 MHz channel cannot use this
116  *	channel as the control or any of the secondary channels.
117  *	This may be due to the driver or due to regulatory bandwidth
118  *	restrictions.
119  * @IEEE80211_CHAN_NO_EHT: EHT operation is not permitted on this channel.
120  * @IEEE80211_CHAN_DFS_CONCURRENT: See %NL80211_RRF_DFS_CONCURRENT
121  * @IEEE80211_CHAN_NO_6GHZ_VLP_CLIENT: Client connection with VLP AP
122  *	not permitted using this channel
123  * @IEEE80211_CHAN_NO_6GHZ_AFC_CLIENT: Client connection with AFC AP
124  *	not permitted using this channel
125  * @IEEE80211_CHAN_CAN_MONITOR: This channel can be used for monitor
126  *	mode even in the presence of other (regulatory) restrictions,
127  *	even if it is otherwise disabled.
128  * @IEEE80211_CHAN_ALLOW_6GHZ_VLP_AP: Allow using this channel for AP operation
129  *	with very low power (VLP), even if otherwise set to NO_IR.
130  * @IEEE80211_CHAN_ALLOW_20MHZ_ACTIVITY: Allow activity on a 20 MHz channel,
131  *	even if otherwise set to NO_IR.
132  */
133 enum ieee80211_channel_flags {
134 	IEEE80211_CHAN_DISABLED			= BIT(0),
135 	IEEE80211_CHAN_NO_IR			= BIT(1),
136 	IEEE80211_CHAN_PSD			= BIT(2),
137 	IEEE80211_CHAN_RADAR			= BIT(3),
138 	IEEE80211_CHAN_NO_HT40PLUS		= BIT(4),
139 	IEEE80211_CHAN_NO_HT40MINUS		= BIT(5),
140 	IEEE80211_CHAN_NO_OFDM			= BIT(6),
141 	IEEE80211_CHAN_NO_80MHZ			= BIT(7),
142 	IEEE80211_CHAN_NO_160MHZ		= BIT(8),
143 	IEEE80211_CHAN_INDOOR_ONLY		= BIT(9),
144 	IEEE80211_CHAN_IR_CONCURRENT		= BIT(10),
145 	IEEE80211_CHAN_NO_20MHZ			= BIT(11),
146 	IEEE80211_CHAN_NO_10MHZ			= BIT(12),
147 	IEEE80211_CHAN_NO_HE			= BIT(13),
148 	IEEE80211_CHAN_1MHZ			= BIT(14),
149 	IEEE80211_CHAN_2MHZ			= BIT(15),
150 	IEEE80211_CHAN_4MHZ			= BIT(16),
151 	IEEE80211_CHAN_8MHZ			= BIT(17),
152 	IEEE80211_CHAN_16MHZ			= BIT(18),
153 	IEEE80211_CHAN_NO_320MHZ		= BIT(19),
154 	IEEE80211_CHAN_NO_EHT			= BIT(20),
155 	IEEE80211_CHAN_DFS_CONCURRENT		= BIT(21),
156 	IEEE80211_CHAN_NO_6GHZ_VLP_CLIENT	= BIT(22),
157 	IEEE80211_CHAN_NO_6GHZ_AFC_CLIENT	= BIT(23),
158 	IEEE80211_CHAN_CAN_MONITOR		= BIT(24),
159 	IEEE80211_CHAN_ALLOW_6GHZ_VLP_AP	= BIT(25),
160 	IEEE80211_CHAN_ALLOW_20MHZ_ACTIVITY     = BIT(26),
161 };
162 
163 #define IEEE80211_CHAN_NO_HT40 \
164 	(IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
165 
166 #define IEEE80211_DFS_MIN_CAC_TIME_MS		60000
167 #define IEEE80211_DFS_MIN_NOP_TIME_MS		(30 * 60 * 1000)
168 
169 /**
170  * struct ieee80211_channel - channel definition
171  *
172  * This structure describes a single channel for use
173  * with cfg80211.
174  *
175  * @center_freq: center frequency in MHz
176  * @freq_offset: offset from @center_freq, in KHz
177  * @hw_value: hardware-specific value for the channel
178  * @flags: channel flags from &enum ieee80211_channel_flags.
179  * @orig_flags: channel flags at registration time, used by regulatory
180  *	code to support devices with additional restrictions
181  * @band: band this channel belongs to.
182  * @max_antenna_gain: maximum antenna gain in dBi
183  * @max_power: maximum transmission power (in dBm)
184  * @max_reg_power: maximum regulatory transmission power (in dBm)
185  * @beacon_found: helper to regulatory code to indicate when a beacon
186  *	has been found on this channel. Use regulatory_hint_found_beacon()
187  *	to enable this, this is useful only on 5 GHz band.
188  * @orig_mag: internal use
189  * @orig_mpwr: internal use
190  * @dfs_state: current state of this channel. Only relevant if radar is required
191  *	on this channel.
192  * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
193  * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
194  * @psd: power spectral density (in dBm)
195  */
196 struct ieee80211_channel {
197 	enum nl80211_band band;
198 	u32 center_freq;
199 	u16 freq_offset;
200 	u16 hw_value;
201 	u32 flags;
202 	int max_antenna_gain;
203 	int max_power;
204 	int max_reg_power;
205 	bool beacon_found;
206 	u32 orig_flags;
207 	int orig_mag, orig_mpwr;
208 	enum nl80211_dfs_state dfs_state;
209 	unsigned long dfs_state_entered;
210 	unsigned int dfs_cac_ms;
211 	s8 psd;
212 };
213 
214 /**
215  * enum ieee80211_rate_flags - rate flags
216  *
217  * Hardware/specification flags for rates. These are structured
218  * in a way that allows using the same bitrate structure for
219  * different bands/PHY modes.
220  *
221  * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
222  *	preamble on this bitrate; only relevant in 2.4GHz band and
223  *	with CCK rates.
224  * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
225  *	when used with 802.11a (on the 5 GHz band); filled by the
226  *	core code when registering the wiphy.
227  * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
228  *	when used with 802.11b (on the 2.4 GHz band); filled by the
229  *	core code when registering the wiphy.
230  * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
231  *	when used with 802.11g (on the 2.4 GHz band); filled by the
232  *	core code when registering the wiphy.
233  * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
234  * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
235  * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
236  */
237 enum ieee80211_rate_flags {
238 	IEEE80211_RATE_SHORT_PREAMBLE	= BIT(0),
239 	IEEE80211_RATE_MANDATORY_A	= BIT(1),
240 	IEEE80211_RATE_MANDATORY_B	= BIT(2),
241 	IEEE80211_RATE_MANDATORY_G	= BIT(3),
242 	IEEE80211_RATE_ERP_G		= BIT(4),
243 	IEEE80211_RATE_SUPPORTS_5MHZ	= BIT(5),
244 	IEEE80211_RATE_SUPPORTS_10MHZ	= BIT(6),
245 };
246 
247 /**
248  * enum ieee80211_bss_type - BSS type filter
249  *
250  * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
251  * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
252  * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
253  * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
254  * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
255  */
256 enum ieee80211_bss_type {
257 	IEEE80211_BSS_TYPE_ESS,
258 	IEEE80211_BSS_TYPE_PBSS,
259 	IEEE80211_BSS_TYPE_IBSS,
260 	IEEE80211_BSS_TYPE_MBSS,
261 	IEEE80211_BSS_TYPE_ANY
262 };
263 
264 /**
265  * enum ieee80211_privacy - BSS privacy filter
266  *
267  * @IEEE80211_PRIVACY_ON: privacy bit set
268  * @IEEE80211_PRIVACY_OFF: privacy bit clear
269  * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
270  */
271 enum ieee80211_privacy {
272 	IEEE80211_PRIVACY_ON,
273 	IEEE80211_PRIVACY_OFF,
274 	IEEE80211_PRIVACY_ANY
275 };
276 
277 #define IEEE80211_PRIVACY(x)	\
278 	((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
279 
280 /**
281  * struct ieee80211_rate - bitrate definition
282  *
283  * This structure describes a bitrate that an 802.11 PHY can
284  * operate with. The two values @hw_value and @hw_value_short
285  * are only for driver use when pointers to this structure are
286  * passed around.
287  *
288  * @flags: rate-specific flags from &enum ieee80211_rate_flags
289  * @bitrate: bitrate in units of 100 Kbps
290  * @hw_value: driver/hardware value for this rate
291  * @hw_value_short: driver/hardware value for this rate when
292  *	short preamble is used
293  */
294 struct ieee80211_rate {
295 	u32 flags;
296 	u16 bitrate;
297 	u16 hw_value, hw_value_short;
298 };
299 
300 /**
301  * struct ieee80211_he_obss_pd - AP settings for spatial reuse
302  *
303  * @enable: is the feature enabled.
304  * @sr_ctrl: The SR Control field of SRP element.
305  * @non_srg_max_offset: non-SRG maximum tx power offset
306  * @min_offset: minimal tx power offset an associated station shall use
307  * @max_offset: maximum tx power offset an associated station shall use
308  * @bss_color_bitmap: bitmap that indicates the BSS color values used by
309  *	members of the SRG
310  * @partial_bssid_bitmap: bitmap that indicates the partial BSSID values
311  *	used by members of the SRG
312  */
313 struct ieee80211_he_obss_pd {
314 	bool enable;
315 	u8 sr_ctrl;
316 	u8 non_srg_max_offset;
317 	u8 min_offset;
318 	u8 max_offset;
319 	u8 bss_color_bitmap[8];
320 	u8 partial_bssid_bitmap[8];
321 };
322 
323 /**
324  * struct cfg80211_he_bss_color - AP settings for BSS coloring
325  *
326  * @color: the current color.
327  * @enabled: HE BSS color is used
328  * @partial: define the AID equation.
329  */
330 struct cfg80211_he_bss_color {
331 	u8 color;
332 	bool enabled;
333 	bool partial;
334 };
335 
336 /**
337  * struct ieee80211_sta_ht_cap - STA's HT capabilities
338  *
339  * This structure describes most essential parameters needed
340  * to describe 802.11n HT capabilities for an STA.
341  *
342  * @ht_supported: is HT supported by the STA
343  * @cap: HT capabilities map as described in 802.11n spec
344  * @ampdu_factor: Maximum A-MPDU length factor
345  * @ampdu_density: Minimum A-MPDU spacing
346  * @mcs: Supported MCS rates
347  */
348 struct ieee80211_sta_ht_cap {
349 	u16 cap; /* use IEEE80211_HT_CAP_ */
350 	bool ht_supported;
351 	u8 ampdu_factor;
352 	u8 ampdu_density;
353 	struct ieee80211_mcs_info mcs;
354 };
355 
356 /**
357  * struct ieee80211_sta_vht_cap - STA's VHT capabilities
358  *
359  * This structure describes most essential parameters needed
360  * to describe 802.11ac VHT capabilities for an STA.
361  *
362  * @vht_supported: is VHT supported by the STA
363  * @cap: VHT capabilities map as described in 802.11ac spec
364  * @vht_mcs: Supported VHT MCS rates
365  */
366 struct ieee80211_sta_vht_cap {
367 	bool vht_supported;
368 	u32 cap; /* use IEEE80211_VHT_CAP_ */
369 	struct ieee80211_vht_mcs_info vht_mcs;
370 };
371 
372 #define IEEE80211_HE_PPE_THRES_MAX_LEN		25
373 
374 /**
375  * struct ieee80211_sta_he_cap - STA's HE capabilities
376  *
377  * This structure describes most essential parameters needed
378  * to describe 802.11ax HE capabilities for a STA.
379  *
380  * @has_he: true iff HE data is valid.
381  * @he_cap_elem: Fixed portion of the HE capabilities element.
382  * @he_mcs_nss_supp: The supported NSS/MCS combinations.
383  * @ppe_thres: Holds the PPE Thresholds data.
384  */
385 struct ieee80211_sta_he_cap {
386 	bool has_he;
387 	struct ieee80211_he_cap_elem he_cap_elem;
388 	struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp;
389 	u8 ppe_thres[IEEE80211_HE_PPE_THRES_MAX_LEN];
390 };
391 
392 /**
393  * struct ieee80211_eht_mcs_nss_supp - EHT max supported NSS per MCS
394  *
395  * See P802.11be_D1.3 Table 9-401k - "Subfields of the Supported EHT-MCS
396  * and NSS Set field"
397  *
398  * @only_20mhz: MCS/NSS support for 20 MHz-only STA.
399  * @bw: MCS/NSS support for 80, 160 and 320 MHz
400  * @bw._80: MCS/NSS support for BW <= 80 MHz
401  * @bw._160: MCS/NSS support for BW = 160 MHz
402  * @bw._320: MCS/NSS support for BW = 320 MHz
403  */
404 struct ieee80211_eht_mcs_nss_supp {
405 	union {
406 		struct ieee80211_eht_mcs_nss_supp_20mhz_only only_20mhz;
407 		struct {
408 			struct ieee80211_eht_mcs_nss_supp_bw _80;
409 			struct ieee80211_eht_mcs_nss_supp_bw _160;
410 			struct ieee80211_eht_mcs_nss_supp_bw _320;
411 		} __packed bw;
412 	} __packed;
413 } __packed;
414 
415 #define IEEE80211_EHT_PPE_THRES_MAX_LEN		32
416 
417 /**
418  * struct ieee80211_sta_eht_cap - STA's EHT capabilities
419  *
420  * This structure describes most essential parameters needed
421  * to describe 802.11be EHT capabilities for a STA.
422  *
423  * @has_eht: true iff EHT data is valid.
424  * @eht_cap_elem: Fixed portion of the eht capabilities element.
425  * @eht_mcs_nss_supp: The supported NSS/MCS combinations.
426  * @eht_ppe_thres: Holds the PPE Thresholds data.
427  */
428 struct ieee80211_sta_eht_cap {
429 	bool has_eht;
430 	struct ieee80211_eht_cap_elem_fixed eht_cap_elem;
431 	struct ieee80211_eht_mcs_nss_supp eht_mcs_nss_supp;
432 	u8 eht_ppe_thres[IEEE80211_EHT_PPE_THRES_MAX_LEN];
433 };
434 
435 /* sparse defines __CHECKER__; see Documentation/dev-tools/sparse.rst */
436 #ifdef __CHECKER__
437 /*
438  * This is used to mark the sband->iftype_data pointer which is supposed
439  * to be an array with special access semantics (per iftype), but a lot
440  * of code got it wrong in the past, so with this marking sparse will be
441  * noisy when the pointer is used directly.
442  */
443 # define __iftd		__attribute__((noderef, address_space(__iftype_data)))
444 #else
445 # define __iftd
446 #endif /* __CHECKER__ */
447 
448 /**
449  * struct ieee80211_sband_iftype_data - sband data per interface type
450  *
451  * This structure encapsulates sband data that is relevant for the
452  * interface types defined in @types_mask.  Each type in the
453  * @types_mask must be unique across all instances of iftype_data.
454  *
455  * @types_mask: interface types mask
456  * @he_cap: holds the HE capabilities
457  * @he_6ghz_capa: HE 6 GHz capabilities, must be filled in for a
458  *	6 GHz band channel (and 0 may be valid value).
459  * @eht_cap: STA's EHT capabilities
460  * @vendor_elems: vendor element(s) to advertise
461  * @vendor_elems.data: vendor element(s) data
462  * @vendor_elems.len: vendor element(s) length
463  */
464 struct ieee80211_sband_iftype_data {
465 	u16 types_mask;
466 	struct ieee80211_sta_he_cap he_cap;
467 	struct ieee80211_he_6ghz_capa he_6ghz_capa;
468 	struct ieee80211_sta_eht_cap eht_cap;
469 	struct {
470 		const u8 *data;
471 		unsigned int len;
472 	} vendor_elems;
473 };
474 
475 /**
476  * enum ieee80211_edmg_bw_config - allowed channel bandwidth configurations
477  *
478  * @IEEE80211_EDMG_BW_CONFIG_4: 2.16GHz
479  * @IEEE80211_EDMG_BW_CONFIG_5: 2.16GHz and 4.32GHz
480  * @IEEE80211_EDMG_BW_CONFIG_6: 2.16GHz, 4.32GHz and 6.48GHz
481  * @IEEE80211_EDMG_BW_CONFIG_7: 2.16GHz, 4.32GHz, 6.48GHz and 8.64GHz
482  * @IEEE80211_EDMG_BW_CONFIG_8: 2.16GHz and 2.16GHz + 2.16GHz
483  * @IEEE80211_EDMG_BW_CONFIG_9: 2.16GHz, 4.32GHz and 2.16GHz + 2.16GHz
484  * @IEEE80211_EDMG_BW_CONFIG_10: 2.16GHz, 4.32GHz, 6.48GHz and 2.16GHz+2.16GHz
485  * @IEEE80211_EDMG_BW_CONFIG_11: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz and
486  *	2.16GHz+2.16GHz
487  * @IEEE80211_EDMG_BW_CONFIG_12: 2.16GHz, 2.16GHz + 2.16GHz and
488  *	4.32GHz + 4.32GHz
489  * @IEEE80211_EDMG_BW_CONFIG_13: 2.16GHz, 4.32GHz, 2.16GHz + 2.16GHz and
490  *	4.32GHz + 4.32GHz
491  * @IEEE80211_EDMG_BW_CONFIG_14: 2.16GHz, 4.32GHz, 6.48GHz, 2.16GHz + 2.16GHz
492  *	and 4.32GHz + 4.32GHz
493  * @IEEE80211_EDMG_BW_CONFIG_15: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz,
494  *	2.16GHz + 2.16GHz and 4.32GHz + 4.32GHz
495  */
496 enum ieee80211_edmg_bw_config {
497 	IEEE80211_EDMG_BW_CONFIG_4	= 4,
498 	IEEE80211_EDMG_BW_CONFIG_5	= 5,
499 	IEEE80211_EDMG_BW_CONFIG_6	= 6,
500 	IEEE80211_EDMG_BW_CONFIG_7	= 7,
501 	IEEE80211_EDMG_BW_CONFIG_8	= 8,
502 	IEEE80211_EDMG_BW_CONFIG_9	= 9,
503 	IEEE80211_EDMG_BW_CONFIG_10	= 10,
504 	IEEE80211_EDMG_BW_CONFIG_11	= 11,
505 	IEEE80211_EDMG_BW_CONFIG_12	= 12,
506 	IEEE80211_EDMG_BW_CONFIG_13	= 13,
507 	IEEE80211_EDMG_BW_CONFIG_14	= 14,
508 	IEEE80211_EDMG_BW_CONFIG_15	= 15,
509 };
510 
511 /**
512  * struct ieee80211_edmg - EDMG configuration
513  *
514  * This structure describes most essential parameters needed
515  * to describe 802.11ay EDMG configuration
516  *
517  * @channels: bitmap that indicates the 2.16 GHz channel(s)
518  *	that are allowed to be used for transmissions.
519  *	Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
520  *	Set to 0 indicate EDMG not supported.
521  * @bw_config: Channel BW Configuration subfield encodes
522  *	the allowed channel bandwidth configurations
523  */
524 struct ieee80211_edmg {
525 	u8 channels;
526 	enum ieee80211_edmg_bw_config bw_config;
527 };
528 
529 /**
530  * struct ieee80211_sta_s1g_cap - STA's S1G capabilities
531  *
532  * This structure describes most essential parameters needed
533  * to describe 802.11ah S1G capabilities for a STA.
534  *
535  * @s1g: is STA an S1G STA
536  * @cap: S1G capabilities information
537  * @nss_mcs: Supported NSS MCS set
538  */
539 struct ieee80211_sta_s1g_cap {
540 	bool s1g;
541 	u8 cap[10]; /* use S1G_CAPAB_ */
542 	u8 nss_mcs[5];
543 };
544 
545 /**
546  * struct ieee80211_supported_band - frequency band definition
547  *
548  * This structure describes a frequency band a wiphy
549  * is able to operate in.
550  *
551  * @channels: Array of channels the hardware can operate with
552  *	in this band.
553  * @band: the band this structure represents
554  * @n_channels: Number of channels in @channels
555  * @bitrates: Array of bitrates the hardware can operate with
556  *	in this band. Must be sorted to give a valid "supported
557  *	rates" IE, i.e. CCK rates first, then OFDM.
558  * @n_bitrates: Number of bitrates in @bitrates
559  * @ht_cap: HT capabilities in this band
560  * @vht_cap: VHT capabilities in this band
561  * @s1g_cap: S1G capabilities in this band
562  * @edmg_cap: EDMG capabilities in this band
563  * @s1g_cap: S1G capabilities in this band (S1G band only, of course)
564  * @n_iftype_data: number of iftype data entries
565  * @iftype_data: interface type data entries.  Note that the bits in
566  *	@types_mask inside this structure cannot overlap (i.e. only
567  *	one occurrence of each type is allowed across all instances of
568  *	iftype_data).
569  */
570 struct ieee80211_supported_band {
571 	struct ieee80211_channel *channels;
572 	struct ieee80211_rate *bitrates;
573 	enum nl80211_band band;
574 	int n_channels;
575 	int n_bitrates;
576 	struct ieee80211_sta_ht_cap ht_cap;
577 	struct ieee80211_sta_vht_cap vht_cap;
578 	struct ieee80211_sta_s1g_cap s1g_cap;
579 	struct ieee80211_edmg edmg_cap;
580 	u16 n_iftype_data;
581 	const struct ieee80211_sband_iftype_data __iftd *iftype_data;
582 };
583 
584 /**
585  * _ieee80211_set_sband_iftype_data - set sband iftype data array
586  * @sband: the sband to initialize
587  * @iftd: the iftype data array pointer
588  * @n_iftd: the length of the iftype data array
589  *
590  * Set the sband iftype data array; use this where the length cannot
591  * be derived from the ARRAY_SIZE() of the argument, but prefer
592  * ieee80211_set_sband_iftype_data() where it can be used.
593  */
594 static inline void
595 _ieee80211_set_sband_iftype_data(struct ieee80211_supported_band *sband,
596 				 const struct ieee80211_sband_iftype_data *iftd,
597 				 u16 n_iftd)
598 {
599 	sband->iftype_data = (const void __iftd __force *)iftd;
600 	sband->n_iftype_data = n_iftd;
601 }
602 
603 /**
604  * ieee80211_set_sband_iftype_data - set sband iftype data array
605  * @sband: the sband to initialize
606  * @iftd: the iftype data array
607  */
608 #define ieee80211_set_sband_iftype_data(sband, iftd)	\
609 	_ieee80211_set_sband_iftype_data(sband, iftd, ARRAY_SIZE(iftd))
610 
611 /**
612  * for_each_sband_iftype_data - iterate sband iftype data entries
613  * @sband: the sband whose iftype_data array to iterate
614  * @i: iterator counter
615  * @iftd: iftype data pointer to set
616  */
617 #define for_each_sband_iftype_data(sband, i, iftd)				\
618 	for (i = 0, iftd = (const void __force *)&(sband)->iftype_data[i];	\
619 	     i < (sband)->n_iftype_data;					\
620 	     i++, iftd = (const void __force *)&(sband)->iftype_data[i])
621 
622 /**
623  * ieee80211_get_sband_iftype_data - return sband data for a given iftype
624  * @sband: the sband to search for the STA on
625  * @iftype: enum nl80211_iftype
626  *
627  * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
628  */
629 static inline const struct ieee80211_sband_iftype_data *
630 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband,
631 				u8 iftype)
632 {
633 	const struct ieee80211_sband_iftype_data *data;
634 	int i;
635 
636 	if (WARN_ON(iftype >= NL80211_IFTYPE_MAX))
637 		return NULL;
638 
639 	if (iftype == NL80211_IFTYPE_AP_VLAN)
640 		iftype = NL80211_IFTYPE_AP;
641 
642 	for_each_sband_iftype_data(sband, i, data) {
643 		if (data->types_mask & BIT(iftype))
644 			return data;
645 	}
646 
647 	return NULL;
648 }
649 
650 /**
651  * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype
652  * @sband: the sband to search for the iftype on
653  * @iftype: enum nl80211_iftype
654  *
655  * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
656  */
657 static inline const struct ieee80211_sta_he_cap *
658 ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band *sband,
659 			    u8 iftype)
660 {
661 	const struct ieee80211_sband_iftype_data *data =
662 		ieee80211_get_sband_iftype_data(sband, iftype);
663 
664 	if (data && data->he_cap.has_he)
665 		return &data->he_cap;
666 
667 	return NULL;
668 }
669 
670 /**
671  * ieee80211_get_he_6ghz_capa - return HE 6 GHz capabilities
672  * @sband: the sband to search for the STA on
673  * @iftype: the iftype to search for
674  *
675  * Return: the 6GHz capabilities
676  */
677 static inline __le16
678 ieee80211_get_he_6ghz_capa(const struct ieee80211_supported_band *sband,
679 			   enum nl80211_iftype iftype)
680 {
681 	const struct ieee80211_sband_iftype_data *data =
682 		ieee80211_get_sband_iftype_data(sband, iftype);
683 
684 	if (WARN_ON(!data || !data->he_cap.has_he))
685 		return 0;
686 
687 	return data->he_6ghz_capa.capa;
688 }
689 
690 /**
691  * ieee80211_get_eht_iftype_cap - return ETH capabilities for an sband's iftype
692  * @sband: the sband to search for the iftype on
693  * @iftype: enum nl80211_iftype
694  *
695  * Return: pointer to the struct ieee80211_sta_eht_cap, or NULL is none found
696  */
697 static inline const struct ieee80211_sta_eht_cap *
698 ieee80211_get_eht_iftype_cap(const struct ieee80211_supported_band *sband,
699 			     enum nl80211_iftype iftype)
700 {
701 	const struct ieee80211_sband_iftype_data *data =
702 		ieee80211_get_sband_iftype_data(sband, iftype);
703 
704 	if (data && data->eht_cap.has_eht)
705 		return &data->eht_cap;
706 
707 	return NULL;
708 }
709 
710 /**
711  * wiphy_read_of_freq_limits - read frequency limits from device tree
712  *
713  * @wiphy: the wireless device to get extra limits for
714  *
715  * Some devices may have extra limitations specified in DT. This may be useful
716  * for chipsets that normally support more bands but are limited due to board
717  * design (e.g. by antennas or external power amplifier).
718  *
719  * This function reads info from DT and uses it to *modify* channels (disable
720  * unavailable ones). It's usually a *bad* idea to use it in drivers with
721  * shared channel data as DT limitations are device specific. You should make
722  * sure to call it only if channels in wiphy are copied and can be modified
723  * without affecting other devices.
724  *
725  * As this function access device node it has to be called after set_wiphy_dev.
726  * It also modifies channels so they have to be set first.
727  * If using this helper, call it before wiphy_register().
728  */
729 #ifdef CONFIG_OF
730 void wiphy_read_of_freq_limits(struct wiphy *wiphy);
731 #else /* CONFIG_OF */
732 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
733 {
734 }
735 #endif /* !CONFIG_OF */
736 
737 
738 /*
739  * Wireless hardware/device configuration structures and methods
740  */
741 
742 /**
743  * DOC: Actions and configuration
744  *
745  * Each wireless device and each virtual interface offer a set of configuration
746  * operations and other actions that are invoked by userspace. Each of these
747  * actions is described in the operations structure, and the parameters these
748  * operations use are described separately.
749  *
750  * Additionally, some operations are asynchronous and expect to get status
751  * information via some functions that drivers need to call.
752  *
753  * Scanning and BSS list handling with its associated functionality is described
754  * in a separate chapter.
755  */
756 
757 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
758 				    WLAN_USER_POSITION_LEN)
759 
760 /**
761  * struct vif_params - describes virtual interface parameters
762  * @flags: monitor interface flags, unchanged if 0, otherwise
763  *	%MONITOR_FLAG_CHANGED will be set
764  * @use_4addr: use 4-address frames
765  * @macaddr: address to use for this virtual interface.
766  *	If this parameter is set to zero address the driver may
767  *	determine the address as needed.
768  *	This feature is only fully supported by drivers that enable the
769  *	%NL80211_FEATURE_MAC_ON_CREATE flag.  Others may support creating
770  **	only p2p devices with specified MAC.
771  * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
772  *	belonging to that MU-MIMO groupID; %NULL if not changed
773  * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
774  *	MU-MIMO packets going to the specified station; %NULL if not changed
775  */
776 struct vif_params {
777 	u32 flags;
778 	int use_4addr;
779 	u8 macaddr[ETH_ALEN];
780 	const u8 *vht_mumimo_groups;
781 	const u8 *vht_mumimo_follow_addr;
782 };
783 
784 /**
785  * struct key_params - key information
786  *
787  * Information about a key
788  *
789  * @key: key material
790  * @key_len: length of key material
791  * @cipher: cipher suite selector
792  * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
793  *	with the get_key() callback, must be in little endian,
794  *	length given by @seq_len.
795  * @seq_len: length of @seq.
796  * @vlan_id: vlan_id for VLAN group key (if nonzero)
797  * @mode: key install mode (RX_TX, NO_TX or SET_TX)
798  */
799 struct key_params {
800 	const u8 *key;
801 	const u8 *seq;
802 	int key_len;
803 	int seq_len;
804 	u16 vlan_id;
805 	u32 cipher;
806 	enum nl80211_key_mode mode;
807 };
808 
809 /**
810  * struct cfg80211_chan_def - channel definition
811  * @chan: the (control) channel
812  * @width: channel width
813  * @center_freq1: center frequency of first segment
814  * @center_freq2: center frequency of second segment
815  *	(only with 80+80 MHz)
816  * @edmg: define the EDMG channels configuration.
817  *	If edmg is requested (i.e. the .channels member is non-zero),
818  *	chan will define the primary channel and all other
819  *	parameters are ignored.
820  * @freq1_offset: offset from @center_freq1, in KHz
821  * @punctured: mask of the punctured 20 MHz subchannels, with
822  *	bits turned on being disabled (punctured); numbered
823  *	from lower to higher frequency (like in the spec)
824  */
825 struct cfg80211_chan_def {
826 	struct ieee80211_channel *chan;
827 	enum nl80211_chan_width width;
828 	u32 center_freq1;
829 	u32 center_freq2;
830 	struct ieee80211_edmg edmg;
831 	u16 freq1_offset;
832 	u16 punctured;
833 };
834 
835 /*
836  * cfg80211_bitrate_mask - masks for bitrate control
837  */
838 struct cfg80211_bitrate_mask {
839 	struct {
840 		u32 legacy;
841 		u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
842 		u16 vht_mcs[NL80211_VHT_NSS_MAX];
843 		u16 he_mcs[NL80211_HE_NSS_MAX];
844 		enum nl80211_txrate_gi gi;
845 		enum nl80211_he_gi he_gi;
846 		enum nl80211_he_ltf he_ltf;
847 	} control[NUM_NL80211_BANDS];
848 };
849 
850 
851 /**
852  * struct cfg80211_tid_cfg - TID specific configuration
853  * @config_override: Flag to notify driver to reset TID configuration
854  *	of the peer.
855  * @tids: bitmap of TIDs to modify
856  * @mask: bitmap of attributes indicating which parameter changed,
857  *	similar to &nl80211_tid_config_supp.
858  * @noack: noack configuration value for the TID
859  * @retry_long: retry count value
860  * @retry_short: retry count value
861  * @ampdu: Enable/Disable MPDU aggregation
862  * @rtscts: Enable/Disable RTS/CTS
863  * @amsdu: Enable/Disable MSDU aggregation
864  * @txrate_type: Tx bitrate mask type
865  * @txrate_mask: Tx bitrate to be applied for the TID
866  */
867 struct cfg80211_tid_cfg {
868 	bool config_override;
869 	u8 tids;
870 	u64 mask;
871 	enum nl80211_tid_config noack;
872 	u8 retry_long, retry_short;
873 	enum nl80211_tid_config ampdu;
874 	enum nl80211_tid_config rtscts;
875 	enum nl80211_tid_config amsdu;
876 	enum nl80211_tx_rate_setting txrate_type;
877 	struct cfg80211_bitrate_mask txrate_mask;
878 };
879 
880 /**
881  * struct cfg80211_tid_config - TID configuration
882  * @peer: Station's MAC address
883  * @n_tid_conf: Number of TID specific configurations to be applied
884  * @tid_conf: Configuration change info
885  */
886 struct cfg80211_tid_config {
887 	const u8 *peer;
888 	u32 n_tid_conf;
889 	struct cfg80211_tid_cfg tid_conf[] __counted_by(n_tid_conf);
890 };
891 
892 /**
893  * struct cfg80211_fils_aad - FILS AAD data
894  * @macaddr: STA MAC address
895  * @kek: FILS KEK
896  * @kek_len: FILS KEK length
897  * @snonce: STA Nonce
898  * @anonce: AP Nonce
899  */
900 struct cfg80211_fils_aad {
901 	const u8 *macaddr;
902 	const u8 *kek;
903 	u8 kek_len;
904 	const u8 *snonce;
905 	const u8 *anonce;
906 };
907 
908 /**
909  * struct cfg80211_set_hw_timestamp - enable/disable HW timestamping
910  * @macaddr: peer MAC address. NULL to enable/disable HW timestamping for all
911  *	addresses.
912  * @enable: if set, enable HW timestamping for the specified MAC address.
913  *	Otherwise disable HW timestamping for the specified MAC address.
914  */
915 struct cfg80211_set_hw_timestamp {
916 	const u8 *macaddr;
917 	bool enable;
918 };
919 
920 /**
921  * cfg80211_get_chandef_type - return old channel type from chandef
922  * @chandef: the channel definition
923  *
924  * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
925  * chandef, which must have a bandwidth allowing this conversion.
926  */
927 static inline enum nl80211_channel_type
928 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
929 {
930 	switch (chandef->width) {
931 	case NL80211_CHAN_WIDTH_20_NOHT:
932 		return NL80211_CHAN_NO_HT;
933 	case NL80211_CHAN_WIDTH_20:
934 		return NL80211_CHAN_HT20;
935 	case NL80211_CHAN_WIDTH_40:
936 		if (chandef->center_freq1 > chandef->chan->center_freq)
937 			return NL80211_CHAN_HT40PLUS;
938 		return NL80211_CHAN_HT40MINUS;
939 	default:
940 		WARN_ON(1);
941 		return NL80211_CHAN_NO_HT;
942 	}
943 }
944 
945 /**
946  * cfg80211_chandef_create - create channel definition using channel type
947  * @chandef: the channel definition struct to fill
948  * @channel: the control channel
949  * @chantype: the channel type
950  *
951  * Given a channel type, create a channel definition.
952  */
953 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
954 			     struct ieee80211_channel *channel,
955 			     enum nl80211_channel_type chantype);
956 
957 /**
958  * cfg80211_chandef_identical - check if two channel definitions are identical
959  * @chandef1: first channel definition
960  * @chandef2: second channel definition
961  *
962  * Return: %true if the channels defined by the channel definitions are
963  * identical, %false otherwise.
964  */
965 static inline bool
966 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
967 			   const struct cfg80211_chan_def *chandef2)
968 {
969 	return (chandef1->chan == chandef2->chan &&
970 		chandef1->width == chandef2->width &&
971 		chandef1->center_freq1 == chandef2->center_freq1 &&
972 		chandef1->freq1_offset == chandef2->freq1_offset &&
973 		chandef1->center_freq2 == chandef2->center_freq2 &&
974 		chandef1->punctured == chandef2->punctured);
975 }
976 
977 /**
978  * cfg80211_chandef_is_edmg - check if chandef represents an EDMG channel
979  *
980  * @chandef: the channel definition
981  *
982  * Return: %true if EDMG defined, %false otherwise.
983  */
984 static inline bool
985 cfg80211_chandef_is_edmg(const struct cfg80211_chan_def *chandef)
986 {
987 	return chandef->edmg.channels || chandef->edmg.bw_config;
988 }
989 
990 /**
991  * cfg80211_chandef_compatible - check if two channel definitions are compatible
992  * @chandef1: first channel definition
993  * @chandef2: second channel definition
994  *
995  * Return: %NULL if the given channel definitions are incompatible,
996  * chandef1 or chandef2 otherwise.
997  */
998 const struct cfg80211_chan_def *
999 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
1000 			    const struct cfg80211_chan_def *chandef2);
1001 
1002 /**
1003  * nl80211_chan_width_to_mhz - get the channel width in MHz
1004  * @chan_width: the channel width from &enum nl80211_chan_width
1005  *
1006  * Return: channel width in MHz if the chan_width from &enum nl80211_chan_width
1007  * is valid. -1 otherwise.
1008  */
1009 int nl80211_chan_width_to_mhz(enum nl80211_chan_width chan_width);
1010 
1011 /**
1012  * cfg80211_chandef_get_width - return chandef width in MHz
1013  * @c: chandef to return bandwidth for
1014  * Return: channel width in MHz for the given chandef; note that it returns
1015  *	80 for 80+80 configurations
1016  */
1017 static inline int cfg80211_chandef_get_width(const struct cfg80211_chan_def *c)
1018 {
1019 	return nl80211_chan_width_to_mhz(c->width);
1020 }
1021 
1022 /**
1023  * cfg80211_chandef_valid - check if a channel definition is valid
1024  * @chandef: the channel definition to check
1025  * Return: %true if the channel definition is valid. %false otherwise.
1026  */
1027 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
1028 
1029 /**
1030  * cfg80211_chandef_usable - check if secondary channels can be used
1031  * @wiphy: the wiphy to validate against
1032  * @chandef: the channel definition to check
1033  * @prohibited_flags: the regulatory channel flags that must not be set
1034  * Return: %true if secondary channels are usable. %false otherwise.
1035  */
1036 bool cfg80211_chandef_usable(struct wiphy *wiphy,
1037 			     const struct cfg80211_chan_def *chandef,
1038 			     u32 prohibited_flags);
1039 
1040 /**
1041  * cfg80211_chandef_dfs_required - checks if radar detection is required
1042  * @wiphy: the wiphy to validate against
1043  * @chandef: the channel definition to check
1044  * @iftype: the interface type as specified in &enum nl80211_iftype
1045  * Returns:
1046  *	1 if radar detection is required, 0 if it is not, < 0 on error
1047  */
1048 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
1049 				  const struct cfg80211_chan_def *chandef,
1050 				  enum nl80211_iftype iftype);
1051 
1052 /**
1053  * cfg80211_chandef_dfs_usable - checks if chandef is DFS usable and we
1054  *				 can/need start CAC on such channel
1055  * @wiphy: the wiphy to validate against
1056  * @chandef: the channel definition to check
1057  *
1058  * Return: true if all channels available and at least
1059  *	   one channel requires CAC (NL80211_DFS_USABLE)
1060  */
1061 bool cfg80211_chandef_dfs_usable(struct wiphy *wiphy,
1062 				 const struct cfg80211_chan_def *chandef);
1063 
1064 /**
1065  * cfg80211_chandef_dfs_cac_time - get the DFS CAC time (in ms) for given
1066  *				   channel definition
1067  * @wiphy: the wiphy to validate against
1068  * @chandef: the channel definition to check
1069  *
1070  * Returns: DFS CAC time (in ms) which applies for this channel definition
1071  */
1072 unsigned int
1073 cfg80211_chandef_dfs_cac_time(struct wiphy *wiphy,
1074 			      const struct cfg80211_chan_def *chandef);
1075 
1076 /**
1077  * cfg80211_chandef_primary - calculate primary 40/80/160 MHz freq
1078  * @chandef: chandef to calculate for
1079  * @primary_chan_width: primary channel width to calculate center for
1080  * @punctured: punctured sub-channel bitmap, will be recalculated
1081  *	according to the new bandwidth, can be %NULL
1082  *
1083  * Returns: the primary 40/80/160 MHz channel center frequency, or -1
1084  *	for errors, updating the punctured bitmap
1085  */
1086 int cfg80211_chandef_primary(const struct cfg80211_chan_def *chandef,
1087 			     enum nl80211_chan_width primary_chan_width,
1088 			     u16 *punctured);
1089 
1090 /**
1091  * nl80211_send_chandef - sends the channel definition.
1092  * @msg: the msg to send channel definition
1093  * @chandef: the channel definition to check
1094  *
1095  * Returns: 0 if sent the channel definition to msg, < 0 on error
1096  **/
1097 int nl80211_send_chandef(struct sk_buff *msg, const struct cfg80211_chan_def *chandef);
1098 
1099 /**
1100  * ieee80211_chandef_max_power - maximum transmission power for the chandef
1101  *
1102  * In some regulations, the transmit power may depend on the configured channel
1103  * bandwidth which may be defined as dBm/MHz. This function returns the actual
1104  * max_power for non-standard (20 MHz) channels.
1105  *
1106  * @chandef: channel definition for the channel
1107  *
1108  * Returns: maximum allowed transmission power in dBm for the chandef
1109  */
1110 static inline int
1111 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
1112 {
1113 	switch (chandef->width) {
1114 	case NL80211_CHAN_WIDTH_5:
1115 		return min(chandef->chan->max_reg_power - 6,
1116 			   chandef->chan->max_power);
1117 	case NL80211_CHAN_WIDTH_10:
1118 		return min(chandef->chan->max_reg_power - 3,
1119 			   chandef->chan->max_power);
1120 	default:
1121 		break;
1122 	}
1123 	return chandef->chan->max_power;
1124 }
1125 
1126 /**
1127  * cfg80211_any_usable_channels - check for usable channels
1128  * @wiphy: the wiphy to check for
1129  * @band_mask: which bands to check on
1130  * @prohibited_flags: which channels to not consider usable,
1131  *	%IEEE80211_CHAN_DISABLED is always taken into account
1132  *
1133  * Return: %true if usable channels found, %false otherwise
1134  */
1135 bool cfg80211_any_usable_channels(struct wiphy *wiphy,
1136 				  unsigned long band_mask,
1137 				  u32 prohibited_flags);
1138 
1139 /**
1140  * enum survey_info_flags - survey information flags
1141  *
1142  * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
1143  * @SURVEY_INFO_IN_USE: channel is currently being used
1144  * @SURVEY_INFO_TIME: active time (in ms) was filled in
1145  * @SURVEY_INFO_TIME_BUSY: busy time was filled in
1146  * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
1147  * @SURVEY_INFO_TIME_RX: receive time was filled in
1148  * @SURVEY_INFO_TIME_TX: transmit time was filled in
1149  * @SURVEY_INFO_TIME_SCAN: scan time was filled in
1150  * @SURVEY_INFO_TIME_BSS_RX: local BSS receive time was filled in
1151  *
1152  * Used by the driver to indicate which info in &struct survey_info
1153  * it has filled in during the get_survey().
1154  */
1155 enum survey_info_flags {
1156 	SURVEY_INFO_NOISE_DBM		= BIT(0),
1157 	SURVEY_INFO_IN_USE		= BIT(1),
1158 	SURVEY_INFO_TIME		= BIT(2),
1159 	SURVEY_INFO_TIME_BUSY		= BIT(3),
1160 	SURVEY_INFO_TIME_EXT_BUSY	= BIT(4),
1161 	SURVEY_INFO_TIME_RX		= BIT(5),
1162 	SURVEY_INFO_TIME_TX		= BIT(6),
1163 	SURVEY_INFO_TIME_SCAN		= BIT(7),
1164 	SURVEY_INFO_TIME_BSS_RX		= BIT(8),
1165 };
1166 
1167 /**
1168  * struct survey_info - channel survey response
1169  *
1170  * @channel: the channel this survey record reports, may be %NULL for a single
1171  *	record to report global statistics
1172  * @filled: bitflag of flags from &enum survey_info_flags
1173  * @noise: channel noise in dBm. This and all following fields are
1174  *	optional
1175  * @time: amount of time in ms the radio was turn on (on the channel)
1176  * @time_busy: amount of time the primary channel was sensed busy
1177  * @time_ext_busy: amount of time the extension channel was sensed busy
1178  * @time_rx: amount of time the radio spent receiving data
1179  * @time_tx: amount of time the radio spent transmitting data
1180  * @time_scan: amount of time the radio spent for scanning
1181  * @time_bss_rx: amount of time the radio spent receiving data on a local BSS
1182  *
1183  * Used by dump_survey() to report back per-channel survey information.
1184  *
1185  * This structure can later be expanded with things like
1186  * channel duty cycle etc.
1187  */
1188 struct survey_info {
1189 	struct ieee80211_channel *channel;
1190 	u64 time;
1191 	u64 time_busy;
1192 	u64 time_ext_busy;
1193 	u64 time_rx;
1194 	u64 time_tx;
1195 	u64 time_scan;
1196 	u64 time_bss_rx;
1197 	u32 filled;
1198 	s8 noise;
1199 };
1200 
1201 #define CFG80211_MAX_NUM_AKM_SUITES	10
1202 
1203 /**
1204  * struct cfg80211_crypto_settings - Crypto settings
1205  * @wpa_versions: indicates which, if any, WPA versions are enabled
1206  *	(from enum nl80211_wpa_versions)
1207  * @cipher_group: group key cipher suite (or 0 if unset)
1208  * @n_ciphers_pairwise: number of AP supported unicast ciphers
1209  * @ciphers_pairwise: unicast key cipher suites
1210  * @n_akm_suites: number of AKM suites
1211  * @akm_suites: AKM suites
1212  * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
1213  *	sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1214  *	required to assume that the port is unauthorized until authorized by
1215  *	user space. Otherwise, port is marked authorized by default.
1216  * @control_port_ethertype: the control port protocol that should be
1217  *	allowed through even on unauthorized ports
1218  * @control_port_no_encrypt: TRUE to prevent encryption of control port
1219  *	protocol frames.
1220  * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1221  *	port frames over NL80211 instead of the network interface.
1222  * @control_port_no_preauth: disables pre-auth rx over the nl80211 control
1223  *	port for mac80211
1224  * @psk: PSK (for devices supporting 4-way-handshake offload)
1225  * @sae_pwd: password for SAE authentication (for devices supporting SAE
1226  *	offload)
1227  * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
1228  * @sae_pwe: The mechanisms allowed for SAE PWE derivation:
1229  *
1230  *	NL80211_SAE_PWE_UNSPECIFIED
1231  *	  Not-specified, used to indicate userspace did not specify any
1232  *	  preference. The driver should follow its internal policy in
1233  *	  such a scenario.
1234  *
1235  *	NL80211_SAE_PWE_HUNT_AND_PECK
1236  *	  Allow hunting-and-pecking loop only
1237  *
1238  *	NL80211_SAE_PWE_HASH_TO_ELEMENT
1239  *	  Allow hash-to-element only
1240  *
1241  *	NL80211_SAE_PWE_BOTH
1242  *	  Allow either hunting-and-pecking loop or hash-to-element
1243  */
1244 struct cfg80211_crypto_settings {
1245 	u32 wpa_versions;
1246 	u32 cipher_group;
1247 	int n_ciphers_pairwise;
1248 	u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
1249 	int n_akm_suites;
1250 	u32 akm_suites[CFG80211_MAX_NUM_AKM_SUITES];
1251 	bool control_port;
1252 	__be16 control_port_ethertype;
1253 	bool control_port_no_encrypt;
1254 	bool control_port_over_nl80211;
1255 	bool control_port_no_preauth;
1256 	const u8 *psk;
1257 	const u8 *sae_pwd;
1258 	u8 sae_pwd_len;
1259 	enum nl80211_sae_pwe_mechanism sae_pwe;
1260 };
1261 
1262 /**
1263  * struct cfg80211_mbssid_config - AP settings for multi bssid
1264  *
1265  * @tx_wdev: pointer to the transmitted interface in the MBSSID set
1266  * @tx_link_id: link ID of the transmitted profile in an MLD.
1267  * @index: index of this AP in the multi bssid group.
1268  * @ema: set to true if the beacons should be sent out in EMA mode.
1269  */
1270 struct cfg80211_mbssid_config {
1271 	struct wireless_dev *tx_wdev;
1272 	u8 tx_link_id;
1273 	u8 index;
1274 	bool ema;
1275 };
1276 
1277 /**
1278  * struct cfg80211_mbssid_elems - Multiple BSSID elements
1279  *
1280  * @cnt: Number of elements in array %elems.
1281  *
1282  * @elem: Array of multiple BSSID element(s) to be added into Beacon frames.
1283  * @elem.data: Data for multiple BSSID elements.
1284  * @elem.len: Length of data.
1285  */
1286 struct cfg80211_mbssid_elems {
1287 	u8 cnt;
1288 	struct {
1289 		const u8 *data;
1290 		size_t len;
1291 	} elem[] __counted_by(cnt);
1292 };
1293 
1294 /**
1295  * struct cfg80211_rnr_elems - Reduced neighbor report (RNR) elements
1296  *
1297  * @cnt: Number of elements in array %elems.
1298  *
1299  * @elem: Array of RNR element(s) to be added into Beacon frames.
1300  * @elem.data: Data for RNR elements.
1301  * @elem.len: Length of data.
1302  */
1303 struct cfg80211_rnr_elems {
1304 	u8 cnt;
1305 	struct {
1306 		const u8 *data;
1307 		size_t len;
1308 	} elem[] __counted_by(cnt);
1309 };
1310 
1311 /**
1312  * struct cfg80211_beacon_data - beacon data
1313  * @link_id: the link ID for the AP MLD link sending this beacon
1314  * @head: head portion of beacon (before TIM IE)
1315  *	or %NULL if not changed
1316  * @tail: tail portion of beacon (after TIM IE)
1317  *	or %NULL if not changed
1318  * @head_len: length of @head
1319  * @tail_len: length of @tail
1320  * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
1321  * @beacon_ies_len: length of beacon_ies in octets
1322  * @proberesp_ies: extra information element(s) to add into Probe Response
1323  *	frames or %NULL
1324  * @proberesp_ies_len: length of proberesp_ies in octets
1325  * @assocresp_ies: extra information element(s) to add into (Re)Association
1326  *	Response frames or %NULL
1327  * @assocresp_ies_len: length of assocresp_ies in octets
1328  * @probe_resp_len: length of probe response template (@probe_resp)
1329  * @probe_resp: probe response template (AP mode only)
1330  * @mbssid_ies: multiple BSSID elements
1331  * @rnr_ies: reduced neighbor report elements
1332  * @ftm_responder: enable FTM responder functionality; -1 for no change
1333  *	(which also implies no change in LCI/civic location data)
1334  * @lci: Measurement Report element content, starting with Measurement Token
1335  *	(measurement type 8)
1336  * @civicloc: Measurement Report element content, starting with Measurement
1337  *	Token (measurement type 11)
1338  * @lci_len: LCI data length
1339  * @civicloc_len: Civic location data length
1340  * @he_bss_color: BSS Color settings
1341  * @he_bss_color_valid: indicates whether bss color
1342  *	attribute is present in beacon data or not.
1343  */
1344 struct cfg80211_beacon_data {
1345 	unsigned int link_id;
1346 
1347 	const u8 *head, *tail;
1348 	const u8 *beacon_ies;
1349 	const u8 *proberesp_ies;
1350 	const u8 *assocresp_ies;
1351 	const u8 *probe_resp;
1352 	const u8 *lci;
1353 	const u8 *civicloc;
1354 	struct cfg80211_mbssid_elems *mbssid_ies;
1355 	struct cfg80211_rnr_elems *rnr_ies;
1356 	s8 ftm_responder;
1357 
1358 	size_t head_len, tail_len;
1359 	size_t beacon_ies_len;
1360 	size_t proberesp_ies_len;
1361 	size_t assocresp_ies_len;
1362 	size_t probe_resp_len;
1363 	size_t lci_len;
1364 	size_t civicloc_len;
1365 	struct cfg80211_he_bss_color he_bss_color;
1366 	bool he_bss_color_valid;
1367 };
1368 
1369 struct mac_address {
1370 	u8 addr[ETH_ALEN];
1371 };
1372 
1373 /**
1374  * struct cfg80211_acl_data - Access control list data
1375  *
1376  * @acl_policy: ACL policy to be applied on the station's
1377  *	entry specified by mac_addr
1378  * @n_acl_entries: Number of MAC address entries passed
1379  * @mac_addrs: List of MAC addresses of stations to be used for ACL
1380  */
1381 struct cfg80211_acl_data {
1382 	enum nl80211_acl_policy acl_policy;
1383 	int n_acl_entries;
1384 
1385 	/* Keep it last */
1386 	struct mac_address mac_addrs[] __counted_by(n_acl_entries);
1387 };
1388 
1389 /**
1390  * struct cfg80211_fils_discovery - FILS discovery parameters from
1391  * IEEE Std 802.11ai-2016, Annex C.3 MIB detail.
1392  *
1393  * @update: Set to true if the feature configuration should be updated.
1394  * @min_interval: Minimum packet interval in TUs (0 - 10000)
1395  * @max_interval: Maximum packet interval in TUs (0 - 10000)
1396  * @tmpl_len: Template length
1397  * @tmpl: Template data for FILS discovery frame including the action
1398  *	frame headers.
1399  */
1400 struct cfg80211_fils_discovery {
1401 	bool update;
1402 	u32 min_interval;
1403 	u32 max_interval;
1404 	size_t tmpl_len;
1405 	const u8 *tmpl;
1406 };
1407 
1408 /**
1409  * struct cfg80211_unsol_bcast_probe_resp - Unsolicited broadcast probe
1410  *	response parameters in 6GHz.
1411  *
1412  * @update: Set to true if the feature configuration should be updated.
1413  * @interval: Packet interval in TUs. Maximum allowed is 20 TU, as mentioned
1414  *	in IEEE P802.11ax/D6.0 26.17.2.3.2 - AP behavior for fast passive
1415  *	scanning
1416  * @tmpl_len: Template length
1417  * @tmpl: Template data for probe response
1418  */
1419 struct cfg80211_unsol_bcast_probe_resp {
1420 	bool update;
1421 	u32 interval;
1422 	size_t tmpl_len;
1423 	const u8 *tmpl;
1424 };
1425 
1426 /**
1427  * struct cfg80211_ap_settings - AP configuration
1428  *
1429  * Used to configure an AP interface.
1430  *
1431  * @chandef: defines the channel to use
1432  * @beacon: beacon data
1433  * @beacon_interval: beacon interval
1434  * @dtim_period: DTIM period
1435  * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
1436  *	user space)
1437  * @ssid_len: length of @ssid
1438  * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
1439  * @crypto: crypto settings
1440  * @privacy: the BSS uses privacy
1441  * @auth_type: Authentication type (algorithm)
1442  * @inactivity_timeout: time in seconds to determine station's inactivity.
1443  * @p2p_ctwindow: P2P CT Window
1444  * @p2p_opp_ps: P2P opportunistic PS
1445  * @acl: ACL configuration used by the drivers which has support for
1446  *	MAC address based access control
1447  * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
1448  *	networks.
1449  * @beacon_rate: bitrate to be used for beacons
1450  * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
1451  * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
1452  * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
1453  * @eht_cap: EHT capabilities (or %NULL if EHT isn't enabled)
1454  * @eht_oper: EHT operation IE (or %NULL if EHT isn't enabled)
1455  * @ht_required: stations must support HT
1456  * @vht_required: stations must support VHT
1457  * @twt_responder: Enable Target Wait Time
1458  * @he_required: stations must support HE
1459  * @sae_h2e_required: stations must support direct H2E technique in SAE
1460  * @flags: flags, as defined in &enum nl80211_ap_settings_flags
1461  * @he_obss_pd: OBSS Packet Detection settings
1462  * @he_oper: HE operation IE (or %NULL if HE isn't enabled)
1463  * @fils_discovery: FILS discovery transmission parameters
1464  * @unsol_bcast_probe_resp: Unsolicited broadcast probe response parameters
1465  * @mbssid_config: AP settings for multiple bssid
1466  */
1467 struct cfg80211_ap_settings {
1468 	struct cfg80211_chan_def chandef;
1469 
1470 	struct cfg80211_beacon_data beacon;
1471 
1472 	int beacon_interval, dtim_period;
1473 	const u8 *ssid;
1474 	size_t ssid_len;
1475 	enum nl80211_hidden_ssid hidden_ssid;
1476 	struct cfg80211_crypto_settings crypto;
1477 	bool privacy;
1478 	enum nl80211_auth_type auth_type;
1479 	int inactivity_timeout;
1480 	u8 p2p_ctwindow;
1481 	bool p2p_opp_ps;
1482 	const struct cfg80211_acl_data *acl;
1483 	bool pbss;
1484 	struct cfg80211_bitrate_mask beacon_rate;
1485 
1486 	const struct ieee80211_ht_cap *ht_cap;
1487 	const struct ieee80211_vht_cap *vht_cap;
1488 	const struct ieee80211_he_cap_elem *he_cap;
1489 	const struct ieee80211_he_operation *he_oper;
1490 	const struct ieee80211_eht_cap_elem *eht_cap;
1491 	const struct ieee80211_eht_operation *eht_oper;
1492 	bool ht_required, vht_required, he_required, sae_h2e_required;
1493 	bool twt_responder;
1494 	u32 flags;
1495 	struct ieee80211_he_obss_pd he_obss_pd;
1496 	struct cfg80211_fils_discovery fils_discovery;
1497 	struct cfg80211_unsol_bcast_probe_resp unsol_bcast_probe_resp;
1498 	struct cfg80211_mbssid_config mbssid_config;
1499 };
1500 
1501 
1502 /**
1503  * struct cfg80211_ap_update - AP configuration update
1504  *
1505  * Subset of &struct cfg80211_ap_settings, for updating a running AP.
1506  *
1507  * @beacon: beacon data
1508  * @fils_discovery: FILS discovery transmission parameters
1509  * @unsol_bcast_probe_resp: Unsolicited broadcast probe response parameters
1510  */
1511 struct cfg80211_ap_update {
1512 	struct cfg80211_beacon_data beacon;
1513 	struct cfg80211_fils_discovery fils_discovery;
1514 	struct cfg80211_unsol_bcast_probe_resp unsol_bcast_probe_resp;
1515 };
1516 
1517 /**
1518  * struct cfg80211_csa_settings - channel switch settings
1519  *
1520  * Used for channel switch
1521  *
1522  * @chandef: defines the channel to use after the switch
1523  * @beacon_csa: beacon data while performing the switch
1524  * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1525  * @counter_offsets_presp: offsets of the counters within the probe response
1526  * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
1527  * @n_counter_offsets_presp: number of csa counters in the probe response
1528  * @beacon_after: beacon data to be used on the new channel
1529  * @radar_required: whether radar detection is required on the new channel
1530  * @block_tx: whether transmissions should be blocked while changing
1531  * @count: number of beacons until switch
1532  * @link_id: defines the link on which channel switch is expected during
1533  *	MLO. 0 in case of non-MLO.
1534  */
1535 struct cfg80211_csa_settings {
1536 	struct cfg80211_chan_def chandef;
1537 	struct cfg80211_beacon_data beacon_csa;
1538 	const u16 *counter_offsets_beacon;
1539 	const u16 *counter_offsets_presp;
1540 	unsigned int n_counter_offsets_beacon;
1541 	unsigned int n_counter_offsets_presp;
1542 	struct cfg80211_beacon_data beacon_after;
1543 	bool radar_required;
1544 	bool block_tx;
1545 	u8 count;
1546 	u8 link_id;
1547 };
1548 
1549 /**
1550  * struct cfg80211_color_change_settings - color change settings
1551  *
1552  * Used for bss color change
1553  *
1554  * @beacon_color_change: beacon data while performing the color countdown
1555  * @counter_offset_beacon: offsets of the counters within the beacon (tail)
1556  * @counter_offset_presp: offsets of the counters within the probe response
1557  * @beacon_next: beacon data to be used after the color change
1558  * @count: number of beacons until the color change
1559  * @color: the color used after the change
1560  * @link_id: defines the link on which color change is expected during MLO.
1561  *	0 in case of non-MLO.
1562  */
1563 struct cfg80211_color_change_settings {
1564 	struct cfg80211_beacon_data beacon_color_change;
1565 	u16 counter_offset_beacon;
1566 	u16 counter_offset_presp;
1567 	struct cfg80211_beacon_data beacon_next;
1568 	u8 count;
1569 	u8 color;
1570 	u8 link_id;
1571 };
1572 
1573 /**
1574  * struct iface_combination_params - input parameters for interface combinations
1575  *
1576  * Used to pass interface combination parameters
1577  *
1578  * @radio_idx: wiphy radio index or -1 for global
1579  * @num_different_channels: the number of different channels we want
1580  *	to use for verification
1581  * @radar_detect: a bitmap where each bit corresponds to a channel
1582  *	width where radar detection is needed, as in the definition of
1583  *	&struct ieee80211_iface_combination.@radar_detect_widths
1584  * @iftype_num: array with the number of interfaces of each interface
1585  *	type.  The index is the interface type as specified in &enum
1586  *	nl80211_iftype.
1587  * @new_beacon_int: set this to the beacon interval of a new interface
1588  *	that's not operating yet, if such is to be checked as part of
1589  *	the verification
1590  */
1591 struct iface_combination_params {
1592 	int radio_idx;
1593 	int num_different_channels;
1594 	u8 radar_detect;
1595 	int iftype_num[NUM_NL80211_IFTYPES];
1596 	u32 new_beacon_int;
1597 };
1598 
1599 /**
1600  * enum station_parameters_apply_mask - station parameter values to apply
1601  * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
1602  * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
1603  * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
1604  *
1605  * Not all station parameters have in-band "no change" signalling,
1606  * for those that don't these flags will are used.
1607  */
1608 enum station_parameters_apply_mask {
1609 	STATION_PARAM_APPLY_UAPSD = BIT(0),
1610 	STATION_PARAM_APPLY_CAPABILITY = BIT(1),
1611 	STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
1612 };
1613 
1614 /**
1615  * struct sta_txpwr - station txpower configuration
1616  *
1617  * Used to configure txpower for station.
1618  *
1619  * @power: tx power (in dBm) to be used for sending data traffic. If tx power
1620  *	is not provided, the default per-interface tx power setting will be
1621  *	overriding. Driver should be picking up the lowest tx power, either tx
1622  *	power per-interface or per-station.
1623  * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1624  *	will be less than or equal to specified from userspace, whereas if TPC
1625  *	%type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1626  *	NL80211_TX_POWER_FIXED is not a valid configuration option for
1627  *	per peer TPC.
1628  */
1629 struct sta_txpwr {
1630 	s16 power;
1631 	enum nl80211_tx_power_setting type;
1632 };
1633 
1634 /**
1635  * struct link_station_parameters - link station parameters
1636  *
1637  * Used to change and create a new link station.
1638  *
1639  * @mld_mac: MAC address of the station
1640  * @link_id: the link id (-1 for non-MLD station)
1641  * @link_mac: MAC address of the link
1642  * @supported_rates: supported rates in IEEE 802.11 format
1643  *	(or NULL for no change)
1644  * @supported_rates_len: number of supported rates
1645  * @ht_capa: HT capabilities of station
1646  * @vht_capa: VHT capabilities of station
1647  * @opmode_notif: operating mode field from Operating Mode Notification
1648  * @opmode_notif_used: information if operating mode field is used
1649  * @he_capa: HE capabilities of station
1650  * @he_capa_len: the length of the HE capabilities
1651  * @txpwr: transmit power for an associated station
1652  * @txpwr_set: txpwr field is set
1653  * @he_6ghz_capa: HE 6 GHz Band capabilities of station
1654  * @eht_capa: EHT capabilities of station
1655  * @eht_capa_len: the length of the EHT capabilities
1656  * @s1g_capa: S1G capabilities of station
1657  */
1658 struct link_station_parameters {
1659 	const u8 *mld_mac;
1660 	int link_id;
1661 	const u8 *link_mac;
1662 	const u8 *supported_rates;
1663 	u8 supported_rates_len;
1664 	const struct ieee80211_ht_cap *ht_capa;
1665 	const struct ieee80211_vht_cap *vht_capa;
1666 	u8 opmode_notif;
1667 	bool opmode_notif_used;
1668 	const struct ieee80211_he_cap_elem *he_capa;
1669 	u8 he_capa_len;
1670 	struct sta_txpwr txpwr;
1671 	bool txpwr_set;
1672 	const struct ieee80211_he_6ghz_capa *he_6ghz_capa;
1673 	const struct ieee80211_eht_cap_elem *eht_capa;
1674 	u8 eht_capa_len;
1675 	const struct ieee80211_s1g_cap *s1g_capa;
1676 };
1677 
1678 /**
1679  * struct link_station_del_parameters - link station deletion parameters
1680  *
1681  * Used to delete a link station entry (or all stations).
1682  *
1683  * @mld_mac: MAC address of the station
1684  * @link_id: the link id
1685  */
1686 struct link_station_del_parameters {
1687 	const u8 *mld_mac;
1688 	u32 link_id;
1689 };
1690 
1691 /**
1692  * struct cfg80211_ttlm_params: TID to link mapping parameters
1693  *
1694  * Used for setting a TID to link mapping.
1695  *
1696  * @dlink: Downlink TID to link mapping, as defined in section 9.4.2.314
1697  *     (TID-To-Link Mapping element) in Draft P802.11be_D4.0.
1698  * @ulink: Uplink TID to link mapping, as defined in section 9.4.2.314
1699  *     (TID-To-Link Mapping element) in Draft P802.11be_D4.0.
1700  */
1701 struct cfg80211_ttlm_params {
1702 	u16 dlink[8];
1703 	u16 ulink[8];
1704 };
1705 
1706 /**
1707  * struct station_parameters - station parameters
1708  *
1709  * Used to change and create a new station.
1710  *
1711  * @vlan: vlan interface station should belong to
1712  * @sta_flags_mask: station flags that changed
1713  *	(bitmask of BIT(%NL80211_STA_FLAG_...))
1714  * @sta_flags_set: station flags values
1715  *	(bitmask of BIT(%NL80211_STA_FLAG_...))
1716  * @listen_interval: listen interval or -1 for no change
1717  * @aid: AID or zero for no change
1718  * @vlan_id: VLAN ID for station (if nonzero)
1719  * @peer_aid: mesh peer AID or zero for no change
1720  * @plink_action: plink action to take
1721  * @plink_state: set the peer link state for a station
1722  * @uapsd_queues: bitmap of queues configured for uapsd. same format
1723  *	as the AC bitmap in the QoS info field
1724  * @max_sp: max Service Period. same format as the MAX_SP in the
1725  *	QoS info field (but already shifted down)
1726  * @sta_modify_mask: bitmap indicating which parameters changed
1727  *	(for those that don't have a natural "no change" value),
1728  *	see &enum station_parameters_apply_mask
1729  * @local_pm: local link-specific mesh power save mode (no change when set
1730  *	to unknown)
1731  * @capability: station capability
1732  * @ext_capab: extended capabilities of the station
1733  * @ext_capab_len: number of extended capabilities
1734  * @supported_channels: supported channels in IEEE 802.11 format
1735  * @supported_channels_len: number of supported channels
1736  * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1737  * @supported_oper_classes_len: number of supported operating classes
1738  * @support_p2p_ps: information if station supports P2P PS mechanism
1739  * @airtime_weight: airtime scheduler weight for this station
1740  * @eml_cap_present: Specifies if EML capabilities field (@eml_cap) is
1741  *	present/updated
1742  * @eml_cap: EML capabilities of this station
1743  * @link_sta_params: link related params.
1744  */
1745 struct station_parameters {
1746 	struct net_device *vlan;
1747 	u32 sta_flags_mask, sta_flags_set;
1748 	u32 sta_modify_mask;
1749 	int listen_interval;
1750 	u16 aid;
1751 	u16 vlan_id;
1752 	u16 peer_aid;
1753 	u8 plink_action;
1754 	u8 plink_state;
1755 	u8 uapsd_queues;
1756 	u8 max_sp;
1757 	enum nl80211_mesh_power_mode local_pm;
1758 	u16 capability;
1759 	const u8 *ext_capab;
1760 	u8 ext_capab_len;
1761 	const u8 *supported_channels;
1762 	u8 supported_channels_len;
1763 	const u8 *supported_oper_classes;
1764 	u8 supported_oper_classes_len;
1765 	int support_p2p_ps;
1766 	u16 airtime_weight;
1767 	bool eml_cap_present;
1768 	u16 eml_cap;
1769 	struct link_station_parameters link_sta_params;
1770 };
1771 
1772 /**
1773  * struct station_del_parameters - station deletion parameters
1774  *
1775  * Used to delete a station entry (or all stations).
1776  *
1777  * @mac: MAC address of the station to remove or NULL to remove all stations
1778  * @subtype: Management frame subtype to use for indicating removal
1779  *	(10 = Disassociation, 12 = Deauthentication)
1780  * @reason_code: Reason code for the Disassociation/Deauthentication frame
1781  * @link_id: Link ID indicating a link that stations to be flushed must be
1782  *	using; valid only for MLO, but can also be -1 for MLO to really
1783  *	remove all stations.
1784  */
1785 struct station_del_parameters {
1786 	const u8 *mac;
1787 	u8 subtype;
1788 	u16 reason_code;
1789 	int link_id;
1790 };
1791 
1792 /**
1793  * enum cfg80211_station_type - the type of station being modified
1794  * @CFG80211_STA_AP_CLIENT: client of an AP interface
1795  * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1796  *	unassociated (update properties for this type of client is permitted)
1797  * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1798  *	the AP MLME in the device
1799  * @CFG80211_STA_AP_STA: AP station on managed interface
1800  * @CFG80211_STA_IBSS: IBSS station
1801  * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1802  *	while TDLS setup is in progress, it moves out of this state when
1803  *	being marked authorized; use this only if TDLS with external setup is
1804  *	supported/used)
1805  * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1806  *	entry that is operating, has been marked authorized by userspace)
1807  * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1808  * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1809  */
1810 enum cfg80211_station_type {
1811 	CFG80211_STA_AP_CLIENT,
1812 	CFG80211_STA_AP_CLIENT_UNASSOC,
1813 	CFG80211_STA_AP_MLME_CLIENT,
1814 	CFG80211_STA_AP_STA,
1815 	CFG80211_STA_IBSS,
1816 	CFG80211_STA_TDLS_PEER_SETUP,
1817 	CFG80211_STA_TDLS_PEER_ACTIVE,
1818 	CFG80211_STA_MESH_PEER_KERNEL,
1819 	CFG80211_STA_MESH_PEER_USER,
1820 };
1821 
1822 /**
1823  * cfg80211_check_station_change - validate parameter changes
1824  * @wiphy: the wiphy this operates on
1825  * @params: the new parameters for a station
1826  * @statype: the type of station being modified
1827  *
1828  * Utility function for the @change_station driver method. Call this function
1829  * with the appropriate station type looking up the station (and checking that
1830  * it exists). It will verify whether the station change is acceptable.
1831  *
1832  * Return: 0 if the change is acceptable, otherwise an error code. Note that
1833  * it may modify the parameters for backward compatibility reasons, so don't
1834  * use them before calling this.
1835  */
1836 int cfg80211_check_station_change(struct wiphy *wiphy,
1837 				  struct station_parameters *params,
1838 				  enum cfg80211_station_type statype);
1839 
1840 /**
1841  * enum rate_info_flags - bitrate info flags
1842  *
1843  * Used by the driver to indicate the specific rate transmission
1844  * type for 802.11n transmissions.
1845  *
1846  * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1847  * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1848  * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1849  * @RATE_INFO_FLAGS_DMG: 60GHz MCS
1850  * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1851  * @RATE_INFO_FLAGS_EDMG: 60GHz MCS in EDMG mode
1852  * @RATE_INFO_FLAGS_EXTENDED_SC_DMG: 60GHz extended SC MCS
1853  * @RATE_INFO_FLAGS_EHT_MCS: EHT MCS information
1854  * @RATE_INFO_FLAGS_S1G_MCS: MCS field filled with S1G MCS
1855  */
1856 enum rate_info_flags {
1857 	RATE_INFO_FLAGS_MCS			= BIT(0),
1858 	RATE_INFO_FLAGS_VHT_MCS			= BIT(1),
1859 	RATE_INFO_FLAGS_SHORT_GI		= BIT(2),
1860 	RATE_INFO_FLAGS_DMG			= BIT(3),
1861 	RATE_INFO_FLAGS_HE_MCS			= BIT(4),
1862 	RATE_INFO_FLAGS_EDMG			= BIT(5),
1863 	RATE_INFO_FLAGS_EXTENDED_SC_DMG		= BIT(6),
1864 	RATE_INFO_FLAGS_EHT_MCS			= BIT(7),
1865 	RATE_INFO_FLAGS_S1G_MCS			= BIT(8),
1866 };
1867 
1868 /**
1869  * enum rate_info_bw - rate bandwidth information
1870  *
1871  * Used by the driver to indicate the rate bandwidth.
1872  *
1873  * @RATE_INFO_BW_5: 5 MHz bandwidth
1874  * @RATE_INFO_BW_10: 10 MHz bandwidth
1875  * @RATE_INFO_BW_20: 20 MHz bandwidth
1876  * @RATE_INFO_BW_40: 40 MHz bandwidth
1877  * @RATE_INFO_BW_80: 80 MHz bandwidth
1878  * @RATE_INFO_BW_160: 160 MHz bandwidth
1879  * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1880  * @RATE_INFO_BW_320: 320 MHz bandwidth
1881  * @RATE_INFO_BW_EHT_RU: bandwidth determined by EHT RU allocation
1882  * @RATE_INFO_BW_1: 1 MHz bandwidth
1883  * @RATE_INFO_BW_2: 2 MHz bandwidth
1884  * @RATE_INFO_BW_4: 4 MHz bandwidth
1885  * @RATE_INFO_BW_8: 8 MHz bandwidth
1886  * @RATE_INFO_BW_16: 16 MHz bandwidth
1887  */
1888 enum rate_info_bw {
1889 	RATE_INFO_BW_20 = 0,
1890 	RATE_INFO_BW_5,
1891 	RATE_INFO_BW_10,
1892 	RATE_INFO_BW_40,
1893 	RATE_INFO_BW_80,
1894 	RATE_INFO_BW_160,
1895 	RATE_INFO_BW_HE_RU,
1896 	RATE_INFO_BW_320,
1897 	RATE_INFO_BW_EHT_RU,
1898 	RATE_INFO_BW_1,
1899 	RATE_INFO_BW_2,
1900 	RATE_INFO_BW_4,
1901 	RATE_INFO_BW_8,
1902 	RATE_INFO_BW_16,
1903 };
1904 
1905 /**
1906  * struct rate_info - bitrate information
1907  *
1908  * Information about a receiving or transmitting bitrate
1909  *
1910  * @flags: bitflag of flags from &enum rate_info_flags
1911  * @legacy: bitrate in 100kbit/s for 802.11abg
1912  * @mcs: mcs index if struct describes an HT/VHT/HE/EHT/S1G rate
1913  * @nss: number of streams (VHT & HE only)
1914  * @bw: bandwidth (from &enum rate_info_bw)
1915  * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1916  * @he_dcm: HE DCM value
1917  * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1918  *	only valid if bw is %RATE_INFO_BW_HE_RU)
1919  * @n_bonded_ch: In case of EDMG the number of bonded channels (1-4)
1920  * @eht_gi: EHT guard interval (from &enum nl80211_eht_gi)
1921  * @eht_ru_alloc: EHT RU allocation (from &enum nl80211_eht_ru_alloc,
1922  *	only valid if bw is %RATE_INFO_BW_EHT_RU)
1923  */
1924 struct rate_info {
1925 	u16 flags;
1926 	u16 legacy;
1927 	u8 mcs;
1928 	u8 nss;
1929 	u8 bw;
1930 	u8 he_gi;
1931 	u8 he_dcm;
1932 	u8 he_ru_alloc;
1933 	u8 n_bonded_ch;
1934 	u8 eht_gi;
1935 	u8 eht_ru_alloc;
1936 };
1937 
1938 /**
1939  * enum bss_param_flags - bitrate info flags
1940  *
1941  * Used by the driver to indicate the specific rate transmission
1942  * type for 802.11n transmissions.
1943  *
1944  * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1945  * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1946  * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1947  */
1948 enum bss_param_flags {
1949 	BSS_PARAM_FLAGS_CTS_PROT	= BIT(0),
1950 	BSS_PARAM_FLAGS_SHORT_PREAMBLE	= BIT(1),
1951 	BSS_PARAM_FLAGS_SHORT_SLOT_TIME	= BIT(2),
1952 };
1953 
1954 /**
1955  * struct sta_bss_parameters - BSS parameters for the attached station
1956  *
1957  * Information about the currently associated BSS
1958  *
1959  * @flags: bitflag of flags from &enum bss_param_flags
1960  * @dtim_period: DTIM period for the BSS
1961  * @beacon_interval: beacon interval
1962  */
1963 struct sta_bss_parameters {
1964 	u8 flags;
1965 	u8 dtim_period;
1966 	u16 beacon_interval;
1967 };
1968 
1969 /**
1970  * struct cfg80211_txq_stats - TXQ statistics for this TID
1971  * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1972  *	indicate the relevant values in this struct are filled
1973  * @backlog_bytes: total number of bytes currently backlogged
1974  * @backlog_packets: total number of packets currently backlogged
1975  * @flows: number of new flows seen
1976  * @drops: total number of packets dropped
1977  * @ecn_marks: total number of packets marked with ECN CE
1978  * @overlimit: number of drops due to queue space overflow
1979  * @overmemory: number of drops due to memory limit overflow
1980  * @collisions: number of hash collisions
1981  * @tx_bytes: total number of bytes dequeued
1982  * @tx_packets: total number of packets dequeued
1983  * @max_flows: maximum number of flows supported
1984  */
1985 struct cfg80211_txq_stats {
1986 	u32 filled;
1987 	u32 backlog_bytes;
1988 	u32 backlog_packets;
1989 	u32 flows;
1990 	u32 drops;
1991 	u32 ecn_marks;
1992 	u32 overlimit;
1993 	u32 overmemory;
1994 	u32 collisions;
1995 	u32 tx_bytes;
1996 	u32 tx_packets;
1997 	u32 max_flows;
1998 };
1999 
2000 /**
2001  * struct cfg80211_tid_stats - per-TID statistics
2002  * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
2003  *	indicate the relevant values in this struct are filled
2004  * @rx_msdu: number of received MSDUs
2005  * @tx_msdu: number of (attempted) transmitted MSDUs
2006  * @tx_msdu_retries: number of retries (not counting the first) for
2007  *	transmitted MSDUs
2008  * @tx_msdu_failed: number of failed transmitted MSDUs
2009  * @txq_stats: TXQ statistics
2010  */
2011 struct cfg80211_tid_stats {
2012 	u32 filled;
2013 	u64 rx_msdu;
2014 	u64 tx_msdu;
2015 	u64 tx_msdu_retries;
2016 	u64 tx_msdu_failed;
2017 	struct cfg80211_txq_stats txq_stats;
2018 };
2019 
2020 #define IEEE80211_MAX_CHAINS	4
2021 
2022 /**
2023  * struct link_station_info - link station information
2024  *
2025  * Link station information filled by driver for get_station() and
2026  *	dump_station().
2027  * @filled: bit flag of flags using the bits of &enum nl80211_sta_info to
2028  *	indicate the relevant values in this struct for them
2029  * @connected_time: time(in secs) since a link of station is last connected
2030  * @inactive_time: time since last activity for link station(tx/rx)
2031  *	in milliseconds
2032  * @assoc_at: bootime (ns) of the last association of link of station
2033  * @rx_bytes: bytes (size of MPDUs) received from this link of station
2034  * @tx_bytes: bytes (size of MPDUs) transmitted to this link of station
2035  * @signal: The signal strength, type depends on the wiphy's signal_type.
2036  *	For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
2037  * @signal_avg: Average signal strength, type depends on the wiphy's
2038  *	signal_type. For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_
2039  * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
2040  * @chain_signal: per-chain signal strength of last received packet in dBm
2041  * @chain_signal_avg: per-chain signal strength average in dBm
2042  * @txrate: current unicast bitrate from this link of station
2043  * @rxrate: current unicast bitrate to this link of station
2044  * @rx_packets: packets (MSDUs & MMPDUs) received from this link of station
2045  * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this link of station
2046  * @tx_retries: cumulative retry counts (MPDUs) for this link of station
2047  * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
2048  * @rx_dropped_misc:  Dropped for un-specified reason.
2049  * @bss_param: current BSS parameters
2050  * @beacon_loss_count: Number of times beacon loss event has triggered.
2051  * @expected_throughput: expected throughput in kbps (including 802.11 headers)
2052  *	towards this station.
2053  * @rx_beacon: number of beacons received from this peer
2054  * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
2055  *	from this peer
2056  * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
2057  * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
2058  * @airtime_weight: current airtime scheduling weight
2059  * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
2060  *	(IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
2061  *	Note that this doesn't use the @filled bit, but is used if non-NULL.
2062  * @ack_signal: signal strength (in dBm) of the last ACK frame.
2063  * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
2064  *	been sent.
2065  * @rx_mpdu_count: number of MPDUs received from this station
2066  * @fcs_err_count: number of packets (MPDUs) received from this station with
2067  *	an FCS error. This counter should be incremented only when TA of the
2068  *	received packet with an FCS error matches the peer MAC address.
2069  * @addr: For MLO STA connection, filled with address of the link of station.
2070  */
2071 struct link_station_info {
2072 	u64 filled;
2073 	u32 connected_time;
2074 	u32 inactive_time;
2075 	u64 assoc_at;
2076 	u64 rx_bytes;
2077 	u64 tx_bytes;
2078 	s8 signal;
2079 	s8 signal_avg;
2080 
2081 	u8 chains;
2082 	s8 chain_signal[IEEE80211_MAX_CHAINS];
2083 	s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
2084 
2085 	struct rate_info txrate;
2086 	struct rate_info rxrate;
2087 	u32 rx_packets;
2088 	u32 tx_packets;
2089 	u32 tx_retries;
2090 	u32 tx_failed;
2091 	u32 rx_dropped_misc;
2092 	struct sta_bss_parameters bss_param;
2093 
2094 	u32 beacon_loss_count;
2095 
2096 	u32 expected_throughput;
2097 
2098 	u64 tx_duration;
2099 	u64 rx_duration;
2100 	u64 rx_beacon;
2101 	u8 rx_beacon_signal_avg;
2102 
2103 	u16 airtime_weight;
2104 
2105 	s8 ack_signal;
2106 	s8 avg_ack_signal;
2107 	struct cfg80211_tid_stats *pertid;
2108 
2109 	u32 rx_mpdu_count;
2110 	u32 fcs_err_count;
2111 
2112 	u8 addr[ETH_ALEN] __aligned(2);
2113 };
2114 
2115 /**
2116  * struct station_info - station information
2117  *
2118  * Station information filled by driver for get_station() and dump_station.
2119  *
2120  * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
2121  *	indicate the relevant values in this struct for them
2122  * @connected_time: time(in secs) since a station is last connected
2123  * @inactive_time: time since last station activity (tx/rx) in milliseconds
2124  * @assoc_at: bootime (ns) of the last association
2125  * @rx_bytes: bytes (size of MPDUs) received from this station
2126  * @tx_bytes: bytes (size of MPDUs) transmitted to this station
2127  * @signal: The signal strength, type depends on the wiphy's signal_type.
2128  *	For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
2129  * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
2130  *	For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
2131  * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
2132  * @chain_signal: per-chain signal strength of last received packet in dBm
2133  * @chain_signal_avg: per-chain signal strength average in dBm
2134  * @txrate: current unicast bitrate from this station
2135  * @rxrate: current unicast bitrate to this station
2136  * @rx_packets: packets (MSDUs & MMPDUs) received from this station
2137  * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
2138  * @tx_retries: cumulative retry counts (MPDUs)
2139  * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
2140  * @rx_dropped_misc:  Dropped for un-specified reason.
2141  * @bss_param: current BSS parameters
2142  * @generation: generation number for nl80211 dumps.
2143  *	This number should increase every time the list of stations
2144  *	changes, i.e. when a station is added or removed, so that
2145  *	userspace can tell whether it got a consistent snapshot.
2146  * @beacon_loss_count: Number of times beacon loss event has triggered.
2147  * @assoc_req_ies: IEs from (Re)Association Request.
2148  *	This is used only when in AP mode with drivers that do not use
2149  *	user space MLME/SME implementation. The information is provided for
2150  *	the cfg80211_new_sta() calls to notify user space of the IEs.
2151  * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
2152  * @sta_flags: station flags mask & values
2153  * @t_offset: Time offset of the station relative to this host.
2154  * @llid: mesh local link id
2155  * @plid: mesh peer link id
2156  * @plink_state: mesh peer link state
2157  * @connected_to_gate: true if mesh STA has a path to mesh gate
2158  * @connected_to_as: true if mesh STA has a path to authentication server
2159  * @airtime_link_metric: mesh airtime link metric.
2160  * @local_pm: local mesh STA power save mode
2161  * @peer_pm: peer mesh STA power save mode
2162  * @nonpeer_pm: non-peer mesh STA power save mode
2163  * @expected_throughput: expected throughput in kbps (including 802.11 headers)
2164  *	towards this station.
2165  * @rx_beacon: number of beacons received from this peer
2166  * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
2167  *	from this peer
2168  * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
2169  * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
2170  * @airtime_weight: current airtime scheduling weight
2171  * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
2172  *	(IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
2173  *	Note that this doesn't use the @filled bit, but is used if non-NULL.
2174  * @ack_signal: signal strength (in dBm) of the last ACK frame.
2175  * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
2176  *	been sent.
2177  * @rx_mpdu_count: number of MPDUs received from this station
2178  * @fcs_err_count: number of packets (MPDUs) received from this station with
2179  *	an FCS error. This counter should be incremented only when TA of the
2180  *	received packet with an FCS error matches the peer MAC address.
2181  * @mlo_params_valid: Indicates @assoc_link_id and @mld_addr fields are filled
2182  *	by driver. Drivers use this only in cfg80211_new_sta() calls when AP
2183  *	MLD's MLME/SME is offload to driver. Drivers won't fill this
2184  *	information in cfg80211_del_sta_sinfo(), get_station() and
2185  *	dump_station() callbacks.
2186  * @assoc_link_id: Indicates MLO link ID of the AP, with which the station
2187  *	completed (re)association. This information filled for both MLO
2188  *	and non-MLO STA connections when the AP affiliated with an MLD.
2189  * @mld_addr: For MLO STA connection, filled with MLD address of the station.
2190  *	For non-MLO STA connection, filled with all zeros.
2191  * @assoc_resp_ies: IEs from (Re)Association Response.
2192  *	This is used only when in AP mode with drivers that do not use user
2193  *	space MLME/SME implementation. The information is provided only for the
2194  *	cfg80211_new_sta() calls to notify user space of the IEs. Drivers won't
2195  *	fill this information in cfg80211_del_sta_sinfo(), get_station() and
2196  *	dump_station() callbacks. User space needs this information to determine
2197  *	the accepted and rejected affiliated links of the connected station.
2198  * @assoc_resp_ies_len: Length of @assoc_resp_ies buffer in octets.
2199  * @valid_links: bitmap of valid links, or 0 for non-MLO. Drivers fill this
2200  *	information in cfg80211_new_sta(), cfg80211_del_sta_sinfo(),
2201  *	get_station() and dump_station() callbacks.
2202  * @links: reference to Link sta entries for MLO STA, all link specific
2203  *	information is accessed through links[link_id].
2204  */
2205 struct station_info {
2206 	u64 filled;
2207 	u32 connected_time;
2208 	u32 inactive_time;
2209 	u64 assoc_at;
2210 	u64 rx_bytes;
2211 	u64 tx_bytes;
2212 	s8 signal;
2213 	s8 signal_avg;
2214 
2215 	u8 chains;
2216 	s8 chain_signal[IEEE80211_MAX_CHAINS];
2217 	s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
2218 
2219 	struct rate_info txrate;
2220 	struct rate_info rxrate;
2221 	u32 rx_packets;
2222 	u32 tx_packets;
2223 	u32 tx_retries;
2224 	u32 tx_failed;
2225 	u32 rx_dropped_misc;
2226 	struct sta_bss_parameters bss_param;
2227 	struct nl80211_sta_flag_update sta_flags;
2228 
2229 	int generation;
2230 
2231 	u32 beacon_loss_count;
2232 
2233 	const u8 *assoc_req_ies;
2234 	size_t assoc_req_ies_len;
2235 
2236 	s64 t_offset;
2237 	u16 llid;
2238 	u16 plid;
2239 	u8 plink_state;
2240 	u8 connected_to_gate;
2241 	u8 connected_to_as;
2242 	u32 airtime_link_metric;
2243 	enum nl80211_mesh_power_mode local_pm;
2244 	enum nl80211_mesh_power_mode peer_pm;
2245 	enum nl80211_mesh_power_mode nonpeer_pm;
2246 
2247 	u32 expected_throughput;
2248 
2249 	u16 airtime_weight;
2250 
2251 	s8 ack_signal;
2252 	s8 avg_ack_signal;
2253 	struct cfg80211_tid_stats *pertid;
2254 
2255 	u64 tx_duration;
2256 	u64 rx_duration;
2257 	u64 rx_beacon;
2258 	u8 rx_beacon_signal_avg;
2259 
2260 	u32 rx_mpdu_count;
2261 	u32 fcs_err_count;
2262 
2263 	bool mlo_params_valid;
2264 	u8 assoc_link_id;
2265 	u8 mld_addr[ETH_ALEN] __aligned(2);
2266 	const u8 *assoc_resp_ies;
2267 	size_t assoc_resp_ies_len;
2268 
2269 	u16 valid_links;
2270 	struct link_station_info *links[IEEE80211_MLD_MAX_NUM_LINKS];
2271 };
2272 
2273 /**
2274  * struct cfg80211_sar_sub_specs - sub specs limit
2275  * @power: power limitation in 0.25dbm
2276  * @freq_range_index: index the power limitation applies to
2277  */
2278 struct cfg80211_sar_sub_specs {
2279 	s32 power;
2280 	u32 freq_range_index;
2281 };
2282 
2283 /**
2284  * struct cfg80211_sar_specs - sar limit specs
2285  * @type: it's set with power in 0.25dbm or other types
2286  * @num_sub_specs: number of sar sub specs
2287  * @sub_specs: memory to hold the sar sub specs
2288  */
2289 struct cfg80211_sar_specs {
2290 	enum nl80211_sar_type type;
2291 	u32 num_sub_specs;
2292 	struct cfg80211_sar_sub_specs sub_specs[] __counted_by(num_sub_specs);
2293 };
2294 
2295 
2296 /**
2297  * struct cfg80211_sar_freq_ranges - sar frequency ranges
2298  * @start_freq:  start range edge frequency
2299  * @end_freq:    end range edge frequency
2300  */
2301 struct cfg80211_sar_freq_ranges {
2302 	u32 start_freq;
2303 	u32 end_freq;
2304 };
2305 
2306 /**
2307  * struct cfg80211_sar_capa - sar limit capability
2308  * @type: it's set via power in 0.25dbm or other types
2309  * @num_freq_ranges: number of frequency ranges
2310  * @freq_ranges: memory to hold the freq ranges.
2311  *
2312  * Note: WLAN driver may append new ranges or split an existing
2313  * range to small ones and then append them.
2314  */
2315 struct cfg80211_sar_capa {
2316 	enum nl80211_sar_type type;
2317 	u32 num_freq_ranges;
2318 	const struct cfg80211_sar_freq_ranges *freq_ranges;
2319 };
2320 
2321 #if IS_ENABLED(CONFIG_CFG80211)
2322 /**
2323  * cfg80211_get_station - retrieve information about a given station
2324  * @dev: the device where the station is supposed to be connected to
2325  * @mac_addr: the mac address of the station of interest
2326  * @sinfo: pointer to the structure to fill with the information
2327  *
2328  * Return: 0 on success and sinfo is filled with the available information
2329  * otherwise returns a negative error code and the content of sinfo has to be
2330  * considered undefined.
2331  */
2332 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
2333 			 struct station_info *sinfo);
2334 #else
2335 static inline int cfg80211_get_station(struct net_device *dev,
2336 				       const u8 *mac_addr,
2337 				       struct station_info *sinfo)
2338 {
2339 	return -ENOENT;
2340 }
2341 #endif
2342 
2343 /**
2344  * enum monitor_flags - monitor flags
2345  *
2346  * Monitor interface configuration flags. Note that these must be the bits
2347  * according to the nl80211 flags.
2348  *
2349  * @MONITOR_FLAG_CHANGED: set if the flags were changed
2350  * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
2351  * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
2352  * @MONITOR_FLAG_CONTROL: pass control frames
2353  * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
2354  * @MONITOR_FLAG_COOK_FRAMES: deprecated, will unconditionally be refused
2355  * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
2356  * @MONITOR_FLAG_SKIP_TX: do not pass locally transmitted frames
2357  */
2358 enum monitor_flags {
2359 	MONITOR_FLAG_CHANGED		= BIT(__NL80211_MNTR_FLAG_INVALID),
2360 	MONITOR_FLAG_FCSFAIL		= BIT(NL80211_MNTR_FLAG_FCSFAIL),
2361 	MONITOR_FLAG_PLCPFAIL		= BIT(NL80211_MNTR_FLAG_PLCPFAIL),
2362 	MONITOR_FLAG_CONTROL		= BIT(NL80211_MNTR_FLAG_CONTROL),
2363 	MONITOR_FLAG_OTHER_BSS		= BIT(NL80211_MNTR_FLAG_OTHER_BSS),
2364 	MONITOR_FLAG_COOK_FRAMES	= BIT(NL80211_MNTR_FLAG_COOK_FRAMES),
2365 	MONITOR_FLAG_ACTIVE		= BIT(NL80211_MNTR_FLAG_ACTIVE),
2366 	MONITOR_FLAG_SKIP_TX		= BIT(NL80211_MNTR_FLAG_SKIP_TX),
2367 };
2368 
2369 /**
2370  * enum mpath_info_flags -  mesh path information flags
2371  *
2372  * Used by the driver to indicate which info in &struct mpath_info it has filled
2373  * in during get_station() or dump_station().
2374  *
2375  * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
2376  * @MPATH_INFO_SN: @sn filled
2377  * @MPATH_INFO_METRIC: @metric filled
2378  * @MPATH_INFO_EXPTIME: @exptime filled
2379  * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
2380  * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
2381  * @MPATH_INFO_FLAGS: @flags filled
2382  * @MPATH_INFO_HOP_COUNT: @hop_count filled
2383  * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
2384  */
2385 enum mpath_info_flags {
2386 	MPATH_INFO_FRAME_QLEN		= BIT(0),
2387 	MPATH_INFO_SN			= BIT(1),
2388 	MPATH_INFO_METRIC		= BIT(2),
2389 	MPATH_INFO_EXPTIME		= BIT(3),
2390 	MPATH_INFO_DISCOVERY_TIMEOUT	= BIT(4),
2391 	MPATH_INFO_DISCOVERY_RETRIES	= BIT(5),
2392 	MPATH_INFO_FLAGS		= BIT(6),
2393 	MPATH_INFO_HOP_COUNT		= BIT(7),
2394 	MPATH_INFO_PATH_CHANGE		= BIT(8),
2395 };
2396 
2397 /**
2398  * struct mpath_info - mesh path information
2399  *
2400  * Mesh path information filled by driver for get_mpath() and dump_mpath().
2401  *
2402  * @filled: bitfield of flags from &enum mpath_info_flags
2403  * @frame_qlen: number of queued frames for this destination
2404  * @sn: target sequence number
2405  * @metric: metric (cost) of this mesh path
2406  * @exptime: expiration time for the mesh path from now, in msecs
2407  * @flags: mesh path flags from &enum mesh_path_flags
2408  * @discovery_timeout: total mesh path discovery timeout, in msecs
2409  * @discovery_retries: mesh path discovery retries
2410  * @generation: generation number for nl80211 dumps.
2411  *	This number should increase every time the list of mesh paths
2412  *	changes, i.e. when a station is added or removed, so that
2413  *	userspace can tell whether it got a consistent snapshot.
2414  * @hop_count: hops to destination
2415  * @path_change_count: total number of path changes to destination
2416  */
2417 struct mpath_info {
2418 	u32 filled;
2419 	u32 frame_qlen;
2420 	u32 sn;
2421 	u32 metric;
2422 	u32 exptime;
2423 	u32 discovery_timeout;
2424 	u8 discovery_retries;
2425 	u8 flags;
2426 	u8 hop_count;
2427 	u32 path_change_count;
2428 
2429 	int generation;
2430 };
2431 
2432 /**
2433  * struct bss_parameters - BSS parameters
2434  *
2435  * Used to change BSS parameters (mainly for AP mode).
2436  *
2437  * @link_id: link_id or -1 for non-MLD
2438  * @use_cts_prot: Whether to use CTS protection
2439  *	(0 = no, 1 = yes, -1 = do not change)
2440  * @use_short_preamble: Whether the use of short preambles is allowed
2441  *	(0 = no, 1 = yes, -1 = do not change)
2442  * @use_short_slot_time: Whether the use of short slot time is allowed
2443  *	(0 = no, 1 = yes, -1 = do not change)
2444  * @basic_rates: basic rates in IEEE 802.11 format
2445  *	(or NULL for no change)
2446  * @basic_rates_len: number of basic rates
2447  * @ap_isolate: do not forward packets between connected stations
2448  *	(0 = no, 1 = yes, -1 = do not change)
2449  * @ht_opmode: HT Operation mode
2450  *	(u16 = opmode, -1 = do not change)
2451  * @p2p_ctwindow: P2P CT Window (-1 = no change)
2452  * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
2453  */
2454 struct bss_parameters {
2455 	int link_id;
2456 	int use_cts_prot;
2457 	int use_short_preamble;
2458 	int use_short_slot_time;
2459 	const u8 *basic_rates;
2460 	u8 basic_rates_len;
2461 	int ap_isolate;
2462 	int ht_opmode;
2463 	s8 p2p_ctwindow, p2p_opp_ps;
2464 };
2465 
2466 /**
2467  * struct mesh_config - 802.11s mesh configuration
2468  *
2469  * These parameters can be changed while the mesh is active.
2470  *
2471  * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
2472  *	by the Mesh Peering Open message
2473  * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
2474  *	used by the Mesh Peering Open message
2475  * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
2476  *	the mesh peering management to close a mesh peering
2477  * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
2478  *	mesh interface
2479  * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
2480  *	be sent to establish a new peer link instance in a mesh
2481  * @dot11MeshTTL: the value of TTL field set at a source mesh STA
2482  * @element_ttl: the value of TTL field set at a mesh STA for path selection
2483  *	elements
2484  * @auto_open_plinks: whether we should automatically open peer links when we
2485  *	detect compatible mesh peers
2486  * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
2487  *	synchronize to for 11s default synchronization method
2488  * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
2489  *	that an originator mesh STA can send to a particular path target
2490  * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
2491  * @min_discovery_timeout: the minimum length of time to wait until giving up on
2492  *	a path discovery in milliseconds
2493  * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
2494  *	receiving a PREQ shall consider the forwarding information from the
2495  *	root to be valid. (TU = time unit)
2496  * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
2497  *	which a mesh STA can send only one action frame containing a PREQ
2498  *	element
2499  * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
2500  *	which a mesh STA can send only one Action frame containing a PERR
2501  *	element
2502  * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
2503  *	it takes for an HWMP information element to propagate across the mesh
2504  * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
2505  * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
2506  *	announcements are transmitted
2507  * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
2508  *	station has access to a broader network beyond the MBSS. (This is
2509  *	missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
2510  *	only means that the station will announce others it's a mesh gate, but
2511  *	not necessarily using the gate announcement protocol. Still keeping the
2512  *	same nomenclature to be in sync with the spec)
2513  * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
2514  *	entity (default is TRUE - forwarding entity)
2515  * @rssi_threshold: the threshold for average signal strength of candidate
2516  *	station to establish a peer link
2517  * @ht_opmode: mesh HT protection mode
2518  *
2519  * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
2520  *	receiving a proactive PREQ shall consider the forwarding information to
2521  *	the root mesh STA to be valid.
2522  *
2523  * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
2524  *	PREQs are transmitted.
2525  * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
2526  *	during which a mesh STA can send only one Action frame containing
2527  *	a PREQ element for root path confirmation.
2528  * @power_mode: The default mesh power save mode which will be the initial
2529  *	setting for new peer links.
2530  * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
2531  *	after transmitting its beacon.
2532  * @plink_timeout: If no tx activity is seen from a STA we've established
2533  *	peering with for longer than this time (in seconds), then remove it
2534  *	from the STA's list of peers.  Default is 30 minutes.
2535  * @dot11MeshConnectedToAuthServer: if set to true then this mesh STA
2536  *	will advertise that it is connected to a authentication server
2537  *	in the mesh formation field.
2538  * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
2539  *      connected to a mesh gate in mesh formation info.  If false, the
2540  *      value in mesh formation is determined by the presence of root paths
2541  *      in the mesh path table
2542  * @dot11MeshNolearn: Try to avoid multi-hop path discovery (e.g. PREQ/PREP
2543  *      for HWMP) if the destination is a direct neighbor. Note that this might
2544  *      not be the optimal decision as a multi-hop route might be better. So
2545  *      if using this setting you will likely also want to disable
2546  *      dot11MeshForwarding and use another mesh routing protocol on top.
2547  */
2548 struct mesh_config {
2549 	u16 dot11MeshRetryTimeout;
2550 	u16 dot11MeshConfirmTimeout;
2551 	u16 dot11MeshHoldingTimeout;
2552 	u16 dot11MeshMaxPeerLinks;
2553 	u8 dot11MeshMaxRetries;
2554 	u8 dot11MeshTTL;
2555 	u8 element_ttl;
2556 	bool auto_open_plinks;
2557 	u32 dot11MeshNbrOffsetMaxNeighbor;
2558 	u8 dot11MeshHWMPmaxPREQretries;
2559 	u32 path_refresh_time;
2560 	u16 min_discovery_timeout;
2561 	u32 dot11MeshHWMPactivePathTimeout;
2562 	u16 dot11MeshHWMPpreqMinInterval;
2563 	u16 dot11MeshHWMPperrMinInterval;
2564 	u16 dot11MeshHWMPnetDiameterTraversalTime;
2565 	u8 dot11MeshHWMPRootMode;
2566 	bool dot11MeshConnectedToMeshGate;
2567 	bool dot11MeshConnectedToAuthServer;
2568 	u16 dot11MeshHWMPRannInterval;
2569 	bool dot11MeshGateAnnouncementProtocol;
2570 	bool dot11MeshForwarding;
2571 	s32 rssi_threshold;
2572 	u16 ht_opmode;
2573 	u32 dot11MeshHWMPactivePathToRootTimeout;
2574 	u16 dot11MeshHWMProotInterval;
2575 	u16 dot11MeshHWMPconfirmationInterval;
2576 	enum nl80211_mesh_power_mode power_mode;
2577 	u16 dot11MeshAwakeWindowDuration;
2578 	u32 plink_timeout;
2579 	bool dot11MeshNolearn;
2580 };
2581 
2582 /**
2583  * struct mesh_setup - 802.11s mesh setup configuration
2584  * @chandef: defines the channel to use
2585  * @mesh_id: the mesh ID
2586  * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
2587  * @sync_method: which synchronization method to use
2588  * @path_sel_proto: which path selection protocol to use
2589  * @path_metric: which metric to use
2590  * @auth_id: which authentication method this mesh is using
2591  * @ie: vendor information elements (optional)
2592  * @ie_len: length of vendor information elements
2593  * @is_authenticated: this mesh requires authentication
2594  * @is_secure: this mesh uses security
2595  * @user_mpm: userspace handles all MPM functions
2596  * @dtim_period: DTIM period to use
2597  * @beacon_interval: beacon interval to use
2598  * @mcast_rate: multicast rate for Mesh Node [6Mbps is the default for 802.11a]
2599  * @basic_rates: basic rates to use when creating the mesh
2600  * @beacon_rate: bitrate to be used for beacons
2601  * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2602  *	changes the channel when a radar is detected. This is required
2603  *	to operate on DFS channels.
2604  * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2605  *	port frames over NL80211 instead of the network interface.
2606  *
2607  * These parameters are fixed when the mesh is created.
2608  */
2609 struct mesh_setup {
2610 	struct cfg80211_chan_def chandef;
2611 	const u8 *mesh_id;
2612 	u8 mesh_id_len;
2613 	u8 sync_method;
2614 	u8 path_sel_proto;
2615 	u8 path_metric;
2616 	u8 auth_id;
2617 	const u8 *ie;
2618 	u8 ie_len;
2619 	bool is_authenticated;
2620 	bool is_secure;
2621 	bool user_mpm;
2622 	u8 dtim_period;
2623 	u16 beacon_interval;
2624 	int mcast_rate[NUM_NL80211_BANDS];
2625 	u32 basic_rates;
2626 	struct cfg80211_bitrate_mask beacon_rate;
2627 	bool userspace_handles_dfs;
2628 	bool control_port_over_nl80211;
2629 };
2630 
2631 /**
2632  * struct ocb_setup - 802.11p OCB mode setup configuration
2633  * @chandef: defines the channel to use
2634  *
2635  * These parameters are fixed when connecting to the network
2636  */
2637 struct ocb_setup {
2638 	struct cfg80211_chan_def chandef;
2639 };
2640 
2641 /**
2642  * struct ieee80211_txq_params - TX queue parameters
2643  * @ac: AC identifier
2644  * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
2645  * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
2646  *	1..32767]
2647  * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
2648  *	1..32767]
2649  * @aifs: Arbitration interframe space [0..255]
2650  * @link_id: link_id or -1 for non-MLD
2651  */
2652 struct ieee80211_txq_params {
2653 	enum nl80211_ac ac;
2654 	u16 txop;
2655 	u16 cwmin;
2656 	u16 cwmax;
2657 	u8 aifs;
2658 	int link_id;
2659 };
2660 
2661 /**
2662  * DOC: Scanning and BSS list handling
2663  *
2664  * The scanning process itself is fairly simple, but cfg80211 offers quite
2665  * a bit of helper functionality. To start a scan, the scan operation will
2666  * be invoked with a scan definition. This scan definition contains the
2667  * channels to scan, and the SSIDs to send probe requests for (including the
2668  * wildcard, if desired). A passive scan is indicated by having no SSIDs to
2669  * probe. Additionally, a scan request may contain extra information elements
2670  * that should be added to the probe request. The IEs are guaranteed to be
2671  * well-formed, and will not exceed the maximum length the driver advertised
2672  * in the wiphy structure.
2673  *
2674  * When scanning finds a BSS, cfg80211 needs to be notified of that, because
2675  * it is responsible for maintaining the BSS list; the driver should not
2676  * maintain a list itself. For this notification, various functions exist.
2677  *
2678  * Since drivers do not maintain a BSS list, there are also a number of
2679  * functions to search for a BSS and obtain information about it from the
2680  * BSS structure cfg80211 maintains. The BSS list is also made available
2681  * to userspace.
2682  */
2683 
2684 /**
2685  * struct cfg80211_ssid - SSID description
2686  * @ssid: the SSID
2687  * @ssid_len: length of the ssid
2688  */
2689 struct cfg80211_ssid {
2690 	u8 ssid[IEEE80211_MAX_SSID_LEN];
2691 	u8 ssid_len;
2692 };
2693 
2694 /**
2695  * struct cfg80211_scan_info - information about completed scan
2696  * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
2697  *	wireless device that requested the scan is connected to. If this
2698  *	information is not available, this field is left zero.
2699  * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
2700  * @aborted: set to true if the scan was aborted for any reason,
2701  *	userspace will be notified of that
2702  */
2703 struct cfg80211_scan_info {
2704 	u64 scan_start_tsf;
2705 	u8 tsf_bssid[ETH_ALEN] __aligned(2);
2706 	bool aborted;
2707 };
2708 
2709 /**
2710  * struct cfg80211_scan_6ghz_params - relevant for 6 GHz only
2711  *
2712  * @short_ssid: short ssid to scan for
2713  * @bssid: bssid to scan for
2714  * @channel_idx: idx of the channel in the channel array in the scan request
2715  *	 which the above info is relevant to
2716  * @unsolicited_probe: the AP transmits unsolicited probe response every 20 TU
2717  * @short_ssid_valid: @short_ssid is valid and can be used
2718  * @psc_no_listen: when set, and the channel is a PSC channel, no need to wait
2719  *       20 TUs before starting to send probe requests.
2720  * @psd_20: The AP's 20 MHz PSD value.
2721  */
2722 struct cfg80211_scan_6ghz_params {
2723 	u32 short_ssid;
2724 	u32 channel_idx;
2725 	u8 bssid[ETH_ALEN];
2726 	bool unsolicited_probe;
2727 	bool short_ssid_valid;
2728 	bool psc_no_listen;
2729 	s8 psd_20;
2730 };
2731 
2732 /**
2733  * struct cfg80211_scan_request - scan request description
2734  *
2735  * @ssids: SSIDs to scan for (active scan only)
2736  * @n_ssids: number of SSIDs
2737  * @channels: channels to scan on.
2738  * @n_channels: total number of channels to scan
2739  * @ie: optional information element(s) to add into Probe Request or %NULL
2740  * @ie_len: length of ie in octets
2741  * @duration: how long to listen on each channel, in TUs. If
2742  *	%duration_mandatory is not set, this is the maximum dwell time and
2743  *	the actual dwell time may be shorter.
2744  * @duration_mandatory: if set, the scan duration must be as specified by the
2745  *	%duration field.
2746  * @flags: control flags from &enum nl80211_scan_flags
2747  * @rates: bitmap of rates to advertise for each band
2748  * @wiphy: the wiphy this was for
2749  * @scan_start: time (in jiffies) when the scan started
2750  * @wdev: the wireless device to scan for
2751  * @no_cck: used to send probe requests at non CCK rate in 2GHz band
2752  * @mac_addr: MAC address used with randomisation
2753  * @mac_addr_mask: MAC address mask used with randomisation, bits that
2754  *	are 0 in the mask should be randomised, bits that are 1 should
2755  *	be taken from the @mac_addr
2756  * @scan_6ghz: relevant for split scan request only,
2757  *	true if this is a 6 GHz scan request
2758  * @first_part: %true if this is the first part of a split scan request or a
2759  *	scan that was not split. May be %true for a @scan_6ghz scan if no other
2760  *	channels were requested
2761  * @n_6ghz_params: number of 6 GHz params
2762  * @scan_6ghz_params: 6 GHz params
2763  * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
2764  * @tsf_report_link_id: for MLO, indicates the link ID of the BSS that should be
2765  *      used for TSF reporting. Can be set to -1 to indicate no preference.
2766  */
2767 struct cfg80211_scan_request {
2768 	struct cfg80211_ssid *ssids;
2769 	int n_ssids;
2770 	u32 n_channels;
2771 	const u8 *ie;
2772 	size_t ie_len;
2773 	u16 duration;
2774 	bool duration_mandatory;
2775 	u32 flags;
2776 
2777 	u32 rates[NUM_NL80211_BANDS];
2778 
2779 	struct wireless_dev *wdev;
2780 
2781 	u8 mac_addr[ETH_ALEN] __aligned(2);
2782 	u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2783 	u8 bssid[ETH_ALEN] __aligned(2);
2784 	struct wiphy *wiphy;
2785 	unsigned long scan_start;
2786 	bool no_cck;
2787 	bool scan_6ghz;
2788 	bool first_part;
2789 	u32 n_6ghz_params;
2790 	struct cfg80211_scan_6ghz_params *scan_6ghz_params;
2791 	s8 tsf_report_link_id;
2792 
2793 	/* keep last */
2794 	struct ieee80211_channel *channels[] __counted_by(n_channels);
2795 };
2796 
2797 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
2798 {
2799 	int i;
2800 
2801 	get_random_bytes(buf, ETH_ALEN);
2802 	for (i = 0; i < ETH_ALEN; i++) {
2803 		buf[i] &= ~mask[i];
2804 		buf[i] |= addr[i] & mask[i];
2805 	}
2806 }
2807 
2808 /**
2809  * struct cfg80211_match_set - sets of attributes to match
2810  *
2811  * @ssid: SSID to be matched; may be zero-length in case of BSSID match
2812  *	or no match (RSSI only)
2813  * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
2814  *	or no match (RSSI only)
2815  * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
2816  */
2817 struct cfg80211_match_set {
2818 	struct cfg80211_ssid ssid;
2819 	u8 bssid[ETH_ALEN];
2820 	s32 rssi_thold;
2821 };
2822 
2823 /**
2824  * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
2825  *
2826  * @interval: interval between scheduled scan iterations. In seconds.
2827  * @iterations: number of scan iterations in this scan plan. Zero means
2828  *	infinite loop.
2829  *	The last scan plan will always have this parameter set to zero,
2830  *	all other scan plans will have a finite number of iterations.
2831  */
2832 struct cfg80211_sched_scan_plan {
2833 	u32 interval;
2834 	u32 iterations;
2835 };
2836 
2837 /**
2838  * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
2839  *
2840  * @band: band of BSS which should match for RSSI level adjustment.
2841  * @delta: value of RSSI level adjustment.
2842  */
2843 struct cfg80211_bss_select_adjust {
2844 	enum nl80211_band band;
2845 	s8 delta;
2846 };
2847 
2848 /**
2849  * struct cfg80211_sched_scan_request - scheduled scan request description
2850  *
2851  * @reqid: identifies this request.
2852  * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
2853  * @n_ssids: number of SSIDs
2854  * @n_channels: total number of channels to scan
2855  * @ie: optional information element(s) to add into Probe Request or %NULL
2856  * @ie_len: length of ie in octets
2857  * @flags: control flags from &enum nl80211_scan_flags
2858  * @match_sets: sets of parameters to be matched for a scan result
2859  *	entry to be considered valid and to be passed to the host
2860  *	(others are filtered out).
2861  *	If omitted, all results are passed.
2862  * @n_match_sets: number of match sets
2863  * @report_results: indicates that results were reported for this request
2864  * @wiphy: the wiphy this was for
2865  * @dev: the interface
2866  * @scan_start: start time of the scheduled scan
2867  * @channels: channels to scan
2868  * @min_rssi_thold: for drivers only supporting a single threshold, this
2869  *	contains the minimum over all matchsets
2870  * @mac_addr: MAC address used with randomisation
2871  * @mac_addr_mask: MAC address mask used with randomisation, bits that
2872  *	are 0 in the mask should be randomised, bits that are 1 should
2873  *	be taken from the @mac_addr
2874  * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
2875  *	index must be executed first.
2876  * @n_scan_plans: number of scan plans, at least 1.
2877  * @rcu_head: RCU callback used to free the struct
2878  * @owner_nlportid: netlink portid of owner (if this should is a request
2879  *	owned by a particular socket)
2880  * @nl_owner_dead: netlink owner socket was closed - this request be freed
2881  * @list: for keeping list of requests.
2882  * @delay: delay in seconds to use before starting the first scan
2883  *	cycle.  The driver may ignore this parameter and start
2884  *	immediately (or at any other time), if this feature is not
2885  *	supported.
2886  * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
2887  * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
2888  *	reporting in connected state to cases where a matching BSS is determined
2889  *	to have better or slightly worse RSSI than the current connected BSS.
2890  *	The relative RSSI threshold values are ignored in disconnected state.
2891  * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
2892  *	to the specified band while deciding whether a better BSS is reported
2893  *	using @relative_rssi. If delta is a negative number, the BSSs that
2894  *	belong to the specified band will be penalized by delta dB in relative
2895  *	comparisons.
2896  */
2897 struct cfg80211_sched_scan_request {
2898 	u64 reqid;
2899 	struct cfg80211_ssid *ssids;
2900 	int n_ssids;
2901 	u32 n_channels;
2902 	const u8 *ie;
2903 	size_t ie_len;
2904 	u32 flags;
2905 	struct cfg80211_match_set *match_sets;
2906 	int n_match_sets;
2907 	s32 min_rssi_thold;
2908 	u32 delay;
2909 	struct cfg80211_sched_scan_plan *scan_plans;
2910 	int n_scan_plans;
2911 
2912 	u8 mac_addr[ETH_ALEN] __aligned(2);
2913 	u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2914 
2915 	bool relative_rssi_set;
2916 	s8 relative_rssi;
2917 	struct cfg80211_bss_select_adjust rssi_adjust;
2918 
2919 	/* internal */
2920 	struct wiphy *wiphy;
2921 	struct net_device *dev;
2922 	unsigned long scan_start;
2923 	bool report_results;
2924 	struct rcu_head rcu_head;
2925 	u32 owner_nlportid;
2926 	bool nl_owner_dead;
2927 	struct list_head list;
2928 
2929 	/* keep last */
2930 	struct ieee80211_channel *channels[] __counted_by(n_channels);
2931 };
2932 
2933 /**
2934  * enum cfg80211_signal_type - signal type
2935  *
2936  * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2937  * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2938  * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2939  */
2940 enum cfg80211_signal_type {
2941 	CFG80211_SIGNAL_TYPE_NONE,
2942 	CFG80211_SIGNAL_TYPE_MBM,
2943 	CFG80211_SIGNAL_TYPE_UNSPEC,
2944 };
2945 
2946 /**
2947  * struct cfg80211_inform_bss - BSS inform data
2948  * @chan: channel the frame was received on
2949  * @signal: signal strength value, according to the wiphy's
2950  *	signal type
2951  * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2952  *	received; should match the time when the frame was actually
2953  *	received by the device (not just by the host, in case it was
2954  *	buffered on the device) and be accurate to about 10ms.
2955  *	If the frame isn't buffered, just passing the return value of
2956  *	ktime_get_boottime_ns() is likely appropriate.
2957  * @parent_tsf: the time at the start of reception of the first octet of the
2958  *	timestamp field of the frame. The time is the TSF of the BSS specified
2959  *	by %parent_bssid.
2960  * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2961  *	the BSS that requested the scan in which the beacon/probe was received.
2962  * @chains: bitmask for filled values in @chain_signal.
2963  * @chain_signal: per-chain signal strength of last received BSS in dBm.
2964  * @restrict_use: restrict usage, if not set, assume @use_for is
2965  *	%NL80211_BSS_USE_FOR_NORMAL.
2966  * @use_for: bitmap of possible usage for this BSS, see
2967  *	&enum nl80211_bss_use_for
2968  * @cannot_use_reasons: the reasons (bitmap) for not being able to connect,
2969  *	if @restrict_use is set and @use_for is zero (empty); may be 0 for
2970  *	unspecified reasons; see &enum nl80211_bss_cannot_use_reasons
2971  * @drv_data: Data to be passed through to @inform_bss
2972  */
2973 struct cfg80211_inform_bss {
2974 	struct ieee80211_channel *chan;
2975 	s32 signal;
2976 	u64 boottime_ns;
2977 	u64 parent_tsf;
2978 	u8 parent_bssid[ETH_ALEN] __aligned(2);
2979 	u8 chains;
2980 	s8 chain_signal[IEEE80211_MAX_CHAINS];
2981 
2982 	u8 restrict_use:1, use_for:7;
2983 	u8 cannot_use_reasons;
2984 
2985 	void *drv_data;
2986 };
2987 
2988 /**
2989  * struct cfg80211_bss_ies - BSS entry IE data
2990  * @tsf: TSF contained in the frame that carried these IEs
2991  * @rcu_head: internal use, for freeing
2992  * @len: length of the IEs
2993  * @from_beacon: these IEs are known to come from a beacon
2994  * @data: IE data
2995  */
2996 struct cfg80211_bss_ies {
2997 	u64 tsf;
2998 	struct rcu_head rcu_head;
2999 	int len;
3000 	bool from_beacon;
3001 	u8 data[];
3002 };
3003 
3004 /**
3005  * struct cfg80211_bss - BSS description
3006  *
3007  * This structure describes a BSS (which may also be a mesh network)
3008  * for use in scan results and similar.
3009  *
3010  * @channel: channel this BSS is on
3011  * @bssid: BSSID of the BSS
3012  * @beacon_interval: the beacon interval as from the frame
3013  * @capability: the capability field in host byte order
3014  * @ies: the information elements (Note that there is no guarantee that these
3015  *	are well-formed!); this is a pointer to either the beacon_ies or
3016  *	proberesp_ies depending on whether Probe Response frame has been
3017  *	received. It is always non-%NULL.
3018  * @beacon_ies: the information elements from the last Beacon frame
3019  *	(implementation note: if @hidden_beacon_bss is set this struct doesn't
3020  *	own the beacon_ies, but they're just pointers to the ones from the
3021  *	@hidden_beacon_bss struct)
3022  * @proberesp_ies: the information elements from the last Probe Response frame
3023  * @proberesp_ecsa_stuck: ECSA element is stuck in the Probe Response frame,
3024  *	cannot rely on it having valid data
3025  * @hidden_beacon_bss: in case this BSS struct represents a probe response from
3026  *	a BSS that hides the SSID in its beacon, this points to the BSS struct
3027  *	that holds the beacon data. @beacon_ies is still valid, of course, and
3028  *	points to the same data as hidden_beacon_bss->beacon_ies in that case.
3029  * @transmitted_bss: pointer to the transmitted BSS, if this is a
3030  *	non-transmitted one (multi-BSSID support)
3031  * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
3032  *	(multi-BSSID support)
3033  * @signal: signal strength value (type depends on the wiphy's signal_type)
3034  * @ts_boottime: timestamp of the last BSS update in nanoseconds since boot
3035  * @chains: bitmask for filled values in @chain_signal.
3036  * @chain_signal: per-chain signal strength of last received BSS in dBm.
3037  * @bssid_index: index in the multiple BSS set
3038  * @max_bssid_indicator: max number of members in the BSS set
3039  * @use_for: bitmap of possible usage for this BSS, see
3040  *	&enum nl80211_bss_use_for
3041  * @cannot_use_reasons: the reasons (bitmap) for not being able to connect,
3042  *	if @restrict_use is set and @use_for is zero (empty); may be 0 for
3043  *	unspecified reasons; see &enum nl80211_bss_cannot_use_reasons
3044  * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
3045  */
3046 struct cfg80211_bss {
3047 	struct ieee80211_channel *channel;
3048 
3049 	const struct cfg80211_bss_ies __rcu *ies;
3050 	const struct cfg80211_bss_ies __rcu *beacon_ies;
3051 	const struct cfg80211_bss_ies __rcu *proberesp_ies;
3052 
3053 	struct cfg80211_bss *hidden_beacon_bss;
3054 	struct cfg80211_bss *transmitted_bss;
3055 	struct list_head nontrans_list;
3056 
3057 	s32 signal;
3058 
3059 	u64 ts_boottime;
3060 
3061 	u16 beacon_interval;
3062 	u16 capability;
3063 
3064 	u8 bssid[ETH_ALEN];
3065 	u8 chains;
3066 	s8 chain_signal[IEEE80211_MAX_CHAINS];
3067 
3068 	u8 proberesp_ecsa_stuck:1;
3069 
3070 	u8 bssid_index;
3071 	u8 max_bssid_indicator;
3072 
3073 	u8 use_for;
3074 	u8 cannot_use_reasons;
3075 
3076 	u8 priv[] __aligned(sizeof(void *));
3077 };
3078 
3079 /**
3080  * ieee80211_bss_get_elem - find element with given ID
3081  * @bss: the bss to search
3082  * @id: the element ID
3083  *
3084  * Note that the return value is an RCU-protected pointer, so
3085  * rcu_read_lock() must be held when calling this function.
3086  * Return: %NULL if not found.
3087  */
3088 const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
3089 
3090 /**
3091  * ieee80211_bss_get_ie - find IE with given ID
3092  * @bss: the bss to search
3093  * @id: the element ID
3094  *
3095  * Note that the return value is an RCU-protected pointer, so
3096  * rcu_read_lock() must be held when calling this function.
3097  * Return: %NULL if not found.
3098  */
3099 static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
3100 {
3101 	return (const void *)ieee80211_bss_get_elem(bss, id);
3102 }
3103 
3104 
3105 /**
3106  * struct cfg80211_auth_request - Authentication request data
3107  *
3108  * This structure provides information needed to complete IEEE 802.11
3109  * authentication.
3110  *
3111  * @bss: The BSS to authenticate with, the callee must obtain a reference
3112  *	to it if it needs to keep it.
3113  * @supported_selectors: List of selectors that should be assumed to be
3114  *	supported by the station.
3115  *	SAE_H2E must be assumed supported if set to %NULL.
3116  * @supported_selectors_len: Length of supported_selectors in octets.
3117  * @auth_type: Authentication type (algorithm)
3118  * @ie: Extra IEs to add to Authentication frame or %NULL
3119  * @ie_len: Length of ie buffer in octets
3120  * @key_len: length of WEP key for shared key authentication
3121  * @key_idx: index of WEP key for shared key authentication
3122  * @key: WEP key for shared key authentication
3123  * @auth_data: Fields and elements in Authentication frames. This contains
3124  *	the authentication frame body (non-IE and IE data), excluding the
3125  *	Authentication algorithm number, i.e., starting at the Authentication
3126  *	transaction sequence number field.
3127  * @auth_data_len: Length of auth_data buffer in octets
3128  * @link_id: if >= 0, indicates authentication should be done as an MLD,
3129  *	the interface address is included as the MLD address and the
3130  *	necessary link (with the given link_id) will be created (and
3131  *	given an MLD address) by the driver
3132  * @ap_mld_addr: AP MLD address in case of authentication request with
3133  *	an AP MLD, valid iff @link_id >= 0
3134  */
3135 struct cfg80211_auth_request {
3136 	struct cfg80211_bss *bss;
3137 	const u8 *ie;
3138 	size_t ie_len;
3139 	const u8 *supported_selectors;
3140 	u8 supported_selectors_len;
3141 	enum nl80211_auth_type auth_type;
3142 	const u8 *key;
3143 	u8 key_len;
3144 	s8 key_idx;
3145 	const u8 *auth_data;
3146 	size_t auth_data_len;
3147 	s8 link_id;
3148 	const u8 *ap_mld_addr;
3149 };
3150 
3151 /**
3152  * struct cfg80211_assoc_link - per-link information for MLO association
3153  * @bss: the BSS pointer, see also &struct cfg80211_assoc_request::bss;
3154  *	if this is %NULL for a link, that link is not requested
3155  * @elems: extra elements for the per-STA profile for this link
3156  * @elems_len: length of the elements
3157  * @disabled: If set this link should be included during association etc. but it
3158  *	should not be used until enabled by the AP MLD.
3159  * @error: per-link error code, must be <= 0. If there is an error, then the
3160  *	operation as a whole must fail.
3161  */
3162 struct cfg80211_assoc_link {
3163 	struct cfg80211_bss *bss;
3164 	const u8 *elems;
3165 	size_t elems_len;
3166 	bool disabled;
3167 	int error;
3168 };
3169 
3170 /**
3171  * struct cfg80211_ml_reconf_req - MLO link reconfiguration request
3172  * @add_links: data for links to add, see &struct cfg80211_assoc_link
3173  * @rem_links: bitmap of links to remove
3174  * @ext_mld_capa_ops: extended MLD capabilities and operations set by
3175  *	userspace for the ML reconfiguration action frame
3176  */
3177 struct cfg80211_ml_reconf_req {
3178 	struct cfg80211_assoc_link add_links[IEEE80211_MLD_MAX_NUM_LINKS];
3179 	u16 rem_links;
3180 	u16 ext_mld_capa_ops;
3181 };
3182 
3183 /**
3184  * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
3185  *
3186  * @ASSOC_REQ_DISABLE_HT:  Disable HT (802.11n)
3187  * @ASSOC_REQ_DISABLE_VHT:  Disable VHT
3188  * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
3189  * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
3190  *	authentication capability. Drivers can offload authentication to
3191  *	userspace if this flag is set. Only applicable for cfg80211_connect()
3192  *	request (connect callback).
3193  * @ASSOC_REQ_DISABLE_HE:  Disable HE
3194  * @ASSOC_REQ_DISABLE_EHT:  Disable EHT
3195  * @CONNECT_REQ_MLO_SUPPORT: Userspace indicates support for handling MLD links.
3196  *	Drivers shall disable MLO features for the current association if this
3197  *	flag is not set.
3198  * @ASSOC_REQ_SPP_AMSDU: SPP A-MSDUs will be used on this connection (if any)
3199  */
3200 enum cfg80211_assoc_req_flags {
3201 	ASSOC_REQ_DISABLE_HT			= BIT(0),
3202 	ASSOC_REQ_DISABLE_VHT			= BIT(1),
3203 	ASSOC_REQ_USE_RRM			= BIT(2),
3204 	CONNECT_REQ_EXTERNAL_AUTH_SUPPORT	= BIT(3),
3205 	ASSOC_REQ_DISABLE_HE			= BIT(4),
3206 	ASSOC_REQ_DISABLE_EHT			= BIT(5),
3207 	CONNECT_REQ_MLO_SUPPORT			= BIT(6),
3208 	ASSOC_REQ_SPP_AMSDU			= BIT(7),
3209 };
3210 
3211 /**
3212  * struct cfg80211_assoc_request - (Re)Association request data
3213  *
3214  * This structure provides information needed to complete IEEE 802.11
3215  * (re)association.
3216  * @bss: The BSS to associate with. If the call is successful the driver is
3217  *	given a reference that it must give back to cfg80211_send_rx_assoc()
3218  *	or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
3219  *	association requests while already associating must be rejected.
3220  *	This also applies to the @links.bss parameter, which is used instead
3221  *	of this one (it is %NULL) for MLO associations.
3222  * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
3223  * @ie_len: Length of ie buffer in octets
3224  * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
3225  * @crypto: crypto settings
3226  * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
3227  *	to indicate a request to reassociate within the ESS instead of a request
3228  *	do the initial association with the ESS. When included, this is set to
3229  *	the BSSID of the current association, i.e., to the value that is
3230  *	included in the Current AP address field of the Reassociation Request
3231  *	frame.
3232  * @flags:  See &enum cfg80211_assoc_req_flags
3233  * @supported_selectors: supported BSS selectors in IEEE 802.11 format
3234  *	(or %NULL for no change).
3235  *	If %NULL, then support for SAE_H2E should be assumed.
3236  * @supported_selectors_len: number of supported BSS selectors
3237  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
3238  *	will be used in ht_capa.  Un-supported values will be ignored.
3239  * @ht_capa_mask:  The bits of ht_capa which are to be used.
3240  * @vht_capa: VHT capability override
3241  * @vht_capa_mask: VHT capability mask indicating which fields to use
3242  * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
3243  *	%NULL if FILS is not used.
3244  * @fils_kek_len: Length of fils_kek in octets
3245  * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
3246  *	Request/Response frame or %NULL if FILS is not used. This field starts
3247  *	with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
3248  * @s1g_capa: S1G capability override
3249  * @s1g_capa_mask: S1G capability override mask
3250  * @links: per-link information for MLO connections
3251  * @link_id: >= 0 for MLO connections, where links are given, and indicates
3252  *	the link on which the association request should be sent
3253  * @ap_mld_addr: AP MLD address in case of MLO association request,
3254  *	valid iff @link_id >= 0
3255  * @ext_mld_capa_ops: extended MLD capabilities and operations set by
3256  *	userspace for the association
3257  */
3258 struct cfg80211_assoc_request {
3259 	struct cfg80211_bss *bss;
3260 	const u8 *ie, *prev_bssid;
3261 	size_t ie_len;
3262 	struct cfg80211_crypto_settings crypto;
3263 	bool use_mfp;
3264 	u32 flags;
3265 	const u8 *supported_selectors;
3266 	u8 supported_selectors_len;
3267 	struct ieee80211_ht_cap ht_capa;
3268 	struct ieee80211_ht_cap ht_capa_mask;
3269 	struct ieee80211_vht_cap vht_capa, vht_capa_mask;
3270 	const u8 *fils_kek;
3271 	size_t fils_kek_len;
3272 	const u8 *fils_nonces;
3273 	struct ieee80211_s1g_cap s1g_capa, s1g_capa_mask;
3274 	struct cfg80211_assoc_link links[IEEE80211_MLD_MAX_NUM_LINKS];
3275 	const u8 *ap_mld_addr;
3276 	s8 link_id;
3277 	u16 ext_mld_capa_ops;
3278 };
3279 
3280 /**
3281  * struct cfg80211_deauth_request - Deauthentication request data
3282  *
3283  * This structure provides information needed to complete IEEE 802.11
3284  * deauthentication.
3285  *
3286  * @bssid: the BSSID or AP MLD address to deauthenticate from
3287  * @ie: Extra IEs to add to Deauthentication frame or %NULL
3288  * @ie_len: Length of ie buffer in octets
3289  * @reason_code: The reason code for the deauthentication
3290  * @local_state_change: if set, change local state only and
3291  *	do not set a deauth frame
3292  */
3293 struct cfg80211_deauth_request {
3294 	const u8 *bssid;
3295 	const u8 *ie;
3296 	size_t ie_len;
3297 	u16 reason_code;
3298 	bool local_state_change;
3299 };
3300 
3301 /**
3302  * struct cfg80211_disassoc_request - Disassociation request data
3303  *
3304  * This structure provides information needed to complete IEEE 802.11
3305  * disassociation.
3306  *
3307  * @ap_addr: the BSSID or AP MLD address to disassociate from
3308  * @ie: Extra IEs to add to Disassociation frame or %NULL
3309  * @ie_len: Length of ie buffer in octets
3310  * @reason_code: The reason code for the disassociation
3311  * @local_state_change: This is a request for a local state only, i.e., no
3312  *	Disassociation frame is to be transmitted.
3313  */
3314 struct cfg80211_disassoc_request {
3315 	const u8 *ap_addr;
3316 	const u8 *ie;
3317 	size_t ie_len;
3318 	u16 reason_code;
3319 	bool local_state_change;
3320 };
3321 
3322 /**
3323  * struct cfg80211_ibss_params - IBSS parameters
3324  *
3325  * This structure defines the IBSS parameters for the join_ibss()
3326  * method.
3327  *
3328  * @ssid: The SSID, will always be non-null.
3329  * @ssid_len: The length of the SSID, will always be non-zero.
3330  * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
3331  *	search for IBSSs with a different BSSID.
3332  * @chandef: defines the channel to use if no other IBSS to join can be found
3333  * @channel_fixed: The channel should be fixed -- do not search for
3334  *	IBSSs to join on other channels.
3335  * @ie: information element(s) to include in the beacon
3336  * @ie_len: length of that
3337  * @beacon_interval: beacon interval to use
3338  * @privacy: this is a protected network, keys will be configured
3339  *	after joining
3340  * @control_port: whether user space controls IEEE 802.1X port, i.e.,
3341  *	sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
3342  *	required to assume that the port is unauthorized until authorized by
3343  *	user space. Otherwise, port is marked authorized by default.
3344  * @control_port_over_nl80211: TRUE if userspace expects to exchange control
3345  *	port frames over NL80211 instead of the network interface.
3346  * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
3347  *	changes the channel when a radar is detected. This is required
3348  *	to operate on DFS channels.
3349  * @basic_rates: bitmap of basic rates to use when creating the IBSS
3350  * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
3351  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
3352  *	will be used in ht_capa.  Un-supported values will be ignored.
3353  * @ht_capa_mask:  The bits of ht_capa which are to be used.
3354  * @wep_keys: static WEP keys, if not NULL points to an array of
3355  *	CFG80211_MAX_WEP_KEYS WEP keys
3356  * @wep_tx_key: key index (0..3) of the default TX static WEP key
3357  */
3358 struct cfg80211_ibss_params {
3359 	const u8 *ssid;
3360 	const u8 *bssid;
3361 	struct cfg80211_chan_def chandef;
3362 	const u8 *ie;
3363 	u8 ssid_len, ie_len;
3364 	u16 beacon_interval;
3365 	u32 basic_rates;
3366 	bool channel_fixed;
3367 	bool privacy;
3368 	bool control_port;
3369 	bool control_port_over_nl80211;
3370 	bool userspace_handles_dfs;
3371 	int mcast_rate[NUM_NL80211_BANDS];
3372 	struct ieee80211_ht_cap ht_capa;
3373 	struct ieee80211_ht_cap ht_capa_mask;
3374 	struct key_params *wep_keys;
3375 	int wep_tx_key;
3376 };
3377 
3378 /**
3379  * struct cfg80211_bss_selection - connection parameters for BSS selection.
3380  *
3381  * @behaviour: requested BSS selection behaviour.
3382  * @param: parameters for requestion behaviour.
3383  * @param.band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
3384  * @param.adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
3385  */
3386 struct cfg80211_bss_selection {
3387 	enum nl80211_bss_select_attr behaviour;
3388 	union {
3389 		enum nl80211_band band_pref;
3390 		struct cfg80211_bss_select_adjust adjust;
3391 	} param;
3392 };
3393 
3394 /**
3395  * struct cfg80211_connect_params - Connection parameters
3396  *
3397  * This structure provides information needed to complete IEEE 802.11
3398  * authentication and association.
3399  *
3400  * @channel: The channel to use or %NULL if not specified (auto-select based
3401  *	on scan results)
3402  * @channel_hint: The channel of the recommended BSS for initial connection or
3403  *	%NULL if not specified
3404  * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
3405  *	results)
3406  * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
3407  *	%NULL if not specified. Unlike the @bssid parameter, the driver is
3408  *	allowed to ignore this @bssid_hint if it has knowledge of a better BSS
3409  *	to use.
3410  * @ssid: SSID
3411  * @ssid_len: Length of ssid in octets
3412  * @auth_type: Authentication type (algorithm)
3413  * @ie: IEs for association request
3414  * @ie_len: Length of assoc_ie in octets
3415  * @privacy: indicates whether privacy-enabled APs should be used
3416  * @mfp: indicate whether management frame protection is used
3417  * @crypto: crypto settings
3418  * @key_len: length of WEP key for shared key authentication
3419  * @key_idx: index of WEP key for shared key authentication
3420  * @key: WEP key for shared key authentication
3421  * @flags:  See &enum cfg80211_assoc_req_flags
3422  * @bg_scan_period:  Background scan period in seconds
3423  *	or -1 to indicate that default value is to be used.
3424  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
3425  *	will be used in ht_capa.  Un-supported values will be ignored.
3426  * @ht_capa_mask:  The bits of ht_capa which are to be used.
3427  * @vht_capa:  VHT Capability overrides
3428  * @vht_capa_mask: The bits of vht_capa which are to be used.
3429  * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
3430  *	networks.
3431  * @bss_select: criteria to be used for BSS selection.
3432  * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
3433  *	to indicate a request to reassociate within the ESS instead of a request
3434  *	do the initial association with the ESS. When included, this is set to
3435  *	the BSSID of the current association, i.e., to the value that is
3436  *	included in the Current AP address field of the Reassociation Request
3437  *	frame.
3438  * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
3439  *	NAI or %NULL if not specified. This is used to construct FILS wrapped
3440  *	data IE.
3441  * @fils_erp_username_len: Length of @fils_erp_username in octets.
3442  * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
3443  *	%NULL if not specified. This specifies the domain name of ER server and
3444  *	is used to construct FILS wrapped data IE.
3445  * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
3446  * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
3447  *	messages. This is also used to construct FILS wrapped data IE.
3448  * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
3449  *	keys in FILS or %NULL if not specified.
3450  * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
3451  * @want_1x: indicates user-space supports and wants to use 802.1X driver
3452  *	offload of 4-way handshake.
3453  * @edmg: define the EDMG channels.
3454  *	This may specify multiple channels and bonding options for the driver
3455  *	to choose from, based on BSS configuration.
3456  */
3457 struct cfg80211_connect_params {
3458 	struct ieee80211_channel *channel;
3459 	struct ieee80211_channel *channel_hint;
3460 	const u8 *bssid;
3461 	const u8 *bssid_hint;
3462 	const u8 *ssid;
3463 	size_t ssid_len;
3464 	enum nl80211_auth_type auth_type;
3465 	const u8 *ie;
3466 	size_t ie_len;
3467 	bool privacy;
3468 	enum nl80211_mfp mfp;
3469 	struct cfg80211_crypto_settings crypto;
3470 	const u8 *key;
3471 	u8 key_len, key_idx;
3472 	u32 flags;
3473 	int bg_scan_period;
3474 	struct ieee80211_ht_cap ht_capa;
3475 	struct ieee80211_ht_cap ht_capa_mask;
3476 	struct ieee80211_vht_cap vht_capa;
3477 	struct ieee80211_vht_cap vht_capa_mask;
3478 	bool pbss;
3479 	struct cfg80211_bss_selection bss_select;
3480 	const u8 *prev_bssid;
3481 	const u8 *fils_erp_username;
3482 	size_t fils_erp_username_len;
3483 	const u8 *fils_erp_realm;
3484 	size_t fils_erp_realm_len;
3485 	u16 fils_erp_next_seq_num;
3486 	const u8 *fils_erp_rrk;
3487 	size_t fils_erp_rrk_len;
3488 	bool want_1x;
3489 	struct ieee80211_edmg edmg;
3490 };
3491 
3492 /**
3493  * enum cfg80211_connect_params_changed - Connection parameters being updated
3494  *
3495  * This enum provides information of all connect parameters that
3496  * have to be updated as part of update_connect_params() call.
3497  *
3498  * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
3499  * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
3500  *	username, erp sequence number and rrk) are updated
3501  * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
3502  */
3503 enum cfg80211_connect_params_changed {
3504 	UPDATE_ASSOC_IES		= BIT(0),
3505 	UPDATE_FILS_ERP_INFO		= BIT(1),
3506 	UPDATE_AUTH_TYPE		= BIT(2),
3507 };
3508 
3509 /**
3510  * enum wiphy_params_flags - set_wiphy_params bitfield values
3511  * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
3512  * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
3513  * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
3514  * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
3515  * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
3516  * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
3517  * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
3518  * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
3519  * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
3520  */
3521 enum wiphy_params_flags {
3522 	WIPHY_PARAM_RETRY_SHORT		= BIT(0),
3523 	WIPHY_PARAM_RETRY_LONG		= BIT(1),
3524 	WIPHY_PARAM_FRAG_THRESHOLD	= BIT(2),
3525 	WIPHY_PARAM_RTS_THRESHOLD	= BIT(3),
3526 	WIPHY_PARAM_COVERAGE_CLASS	= BIT(4),
3527 	WIPHY_PARAM_DYN_ACK		= BIT(5),
3528 	WIPHY_PARAM_TXQ_LIMIT		= BIT(6),
3529 	WIPHY_PARAM_TXQ_MEMORY_LIMIT	= BIT(7),
3530 	WIPHY_PARAM_TXQ_QUANTUM		= BIT(8),
3531 };
3532 
3533 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT	256
3534 
3535 /* The per TXQ device queue limit in airtime */
3536 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_L	5000
3537 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_H	12000
3538 
3539 /* The per interface airtime threshold to switch to lower queue limit */
3540 #define IEEE80211_AQL_THRESHOLD			24000
3541 
3542 /**
3543  * struct cfg80211_pmksa - PMK Security Association
3544  *
3545  * This structure is passed to the set/del_pmksa() method for PMKSA
3546  * caching.
3547  *
3548  * @bssid: The AP's BSSID (may be %NULL).
3549  * @pmkid: The identifier to refer a PMKSA.
3550  * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
3551  *	derivation by a FILS STA. Otherwise, %NULL.
3552  * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
3553  *	the hash algorithm used to generate this.
3554  * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
3555  *	cache identifier (may be %NULL).
3556  * @ssid_len: Length of the @ssid in octets.
3557  * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
3558  *	scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
3559  *	%NULL).
3560  * @pmk_lifetime: Maximum lifetime for PMKSA in seconds
3561  *	(dot11RSNAConfigPMKLifetime) or 0 if not specified.
3562  *	The configured PMKSA must not be used for PMKSA caching after
3563  *	expiration and any keys derived from this PMK become invalid on
3564  *	expiration, i.e., the current association must be dropped if the PMK
3565  *	used for it expires.
3566  * @pmk_reauth_threshold: Threshold time for reauthentication (percentage of
3567  *	PMK lifetime, dot11RSNAConfigPMKReauthThreshold) or 0 if not specified.
3568  *	Drivers are expected to trigger a full authentication instead of using
3569  *	this PMKSA for caching when reassociating to a new BSS after this
3570  *	threshold to generate a new PMK before the current one expires.
3571  */
3572 struct cfg80211_pmksa {
3573 	const u8 *bssid;
3574 	const u8 *pmkid;
3575 	const u8 *pmk;
3576 	size_t pmk_len;
3577 	const u8 *ssid;
3578 	size_t ssid_len;
3579 	const u8 *cache_id;
3580 	u32 pmk_lifetime;
3581 	u8 pmk_reauth_threshold;
3582 };
3583 
3584 /**
3585  * struct cfg80211_pkt_pattern - packet pattern
3586  * @mask: bitmask where to match pattern and where to ignore bytes,
3587  *	one bit per byte, in same format as nl80211
3588  * @pattern: bytes to match where bitmask is 1
3589  * @pattern_len: length of pattern (in bytes)
3590  * @pkt_offset: packet offset (in bytes)
3591  *
3592  * Internal note: @mask and @pattern are allocated in one chunk of
3593  * memory, free @mask only!
3594  */
3595 struct cfg80211_pkt_pattern {
3596 	const u8 *mask, *pattern;
3597 	int pattern_len;
3598 	int pkt_offset;
3599 };
3600 
3601 /**
3602  * struct cfg80211_wowlan_tcp - TCP connection parameters
3603  *
3604  * @sock: (internal) socket for source port allocation
3605  * @src: source IP address
3606  * @dst: destination IP address
3607  * @dst_mac: destination MAC address
3608  * @src_port: source port
3609  * @dst_port: destination port
3610  * @payload_len: data payload length
3611  * @payload: data payload buffer
3612  * @payload_seq: payload sequence stamping configuration
3613  * @data_interval: interval at which to send data packets
3614  * @wake_len: wakeup payload match length
3615  * @wake_data: wakeup payload match data
3616  * @wake_mask: wakeup payload match mask
3617  * @tokens_size: length of the tokens buffer
3618  * @payload_tok: payload token usage configuration
3619  */
3620 struct cfg80211_wowlan_tcp {
3621 	struct socket *sock;
3622 	__be32 src, dst;
3623 	u16 src_port, dst_port;
3624 	u8 dst_mac[ETH_ALEN];
3625 	int payload_len;
3626 	const u8 *payload;
3627 	struct nl80211_wowlan_tcp_data_seq payload_seq;
3628 	u32 data_interval;
3629 	u32 wake_len;
3630 	const u8 *wake_data, *wake_mask;
3631 	u32 tokens_size;
3632 	/* must be last, variable member */
3633 	struct nl80211_wowlan_tcp_data_token payload_tok;
3634 };
3635 
3636 /**
3637  * struct cfg80211_wowlan - Wake on Wireless-LAN support info
3638  *
3639  * This structure defines the enabled WoWLAN triggers for the device.
3640  * @any: wake up on any activity -- special trigger if device continues
3641  *	operating as normal during suspend
3642  * @disconnect: wake up if getting disconnected
3643  * @magic_pkt: wake up on receiving magic packet
3644  * @patterns: wake up on receiving packet matching a pattern
3645  * @n_patterns: number of patterns
3646  * @gtk_rekey_failure: wake up on GTK rekey failure
3647  * @eap_identity_req: wake up on EAP identity request packet
3648  * @four_way_handshake: wake up on 4-way handshake
3649  * @rfkill_release: wake up when rfkill is released
3650  * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
3651  *	NULL if not configured.
3652  * @nd_config: configuration for the scan to be used for net detect wake.
3653  */
3654 struct cfg80211_wowlan {
3655 	bool any, disconnect, magic_pkt, gtk_rekey_failure,
3656 	     eap_identity_req, four_way_handshake,
3657 	     rfkill_release;
3658 	struct cfg80211_pkt_pattern *patterns;
3659 	struct cfg80211_wowlan_tcp *tcp;
3660 	int n_patterns;
3661 	struct cfg80211_sched_scan_request *nd_config;
3662 };
3663 
3664 /**
3665  * struct cfg80211_coalesce_rules - Coalesce rule parameters
3666  *
3667  * This structure defines coalesce rule for the device.
3668  * @delay: maximum coalescing delay in msecs.
3669  * @condition: condition for packet coalescence.
3670  *	see &enum nl80211_coalesce_condition.
3671  * @patterns: array of packet patterns
3672  * @n_patterns: number of patterns
3673  */
3674 struct cfg80211_coalesce_rules {
3675 	int delay;
3676 	enum nl80211_coalesce_condition condition;
3677 	struct cfg80211_pkt_pattern *patterns;
3678 	int n_patterns;
3679 };
3680 
3681 /**
3682  * struct cfg80211_coalesce - Packet coalescing settings
3683  *
3684  * This structure defines coalescing settings.
3685  * @rules: array of coalesce rules
3686  * @n_rules: number of rules
3687  */
3688 struct cfg80211_coalesce {
3689 	int n_rules;
3690 	struct cfg80211_coalesce_rules rules[] __counted_by(n_rules);
3691 };
3692 
3693 /**
3694  * struct cfg80211_wowlan_nd_match - information about the match
3695  *
3696  * @ssid: SSID of the match that triggered the wake up
3697  * @n_channels: Number of channels where the match occurred.  This
3698  *	value may be zero if the driver can't report the channels.
3699  * @channels: center frequencies of the channels where a match
3700  *	occurred (in MHz)
3701  */
3702 struct cfg80211_wowlan_nd_match {
3703 	struct cfg80211_ssid ssid;
3704 	int n_channels;
3705 	u32 channels[] __counted_by(n_channels);
3706 };
3707 
3708 /**
3709  * struct cfg80211_wowlan_nd_info - net detect wake up information
3710  *
3711  * @n_matches: Number of match information instances provided in
3712  *	@matches.  This value may be zero if the driver can't provide
3713  *	match information.
3714  * @matches: Array of pointers to matches containing information about
3715  *	the matches that triggered the wake up.
3716  */
3717 struct cfg80211_wowlan_nd_info {
3718 	int n_matches;
3719 	struct cfg80211_wowlan_nd_match *matches[] __counted_by(n_matches);
3720 };
3721 
3722 /**
3723  * struct cfg80211_wowlan_wakeup - wakeup report
3724  * @disconnect: woke up by getting disconnected
3725  * @magic_pkt: woke up by receiving magic packet
3726  * @gtk_rekey_failure: woke up by GTK rekey failure
3727  * @eap_identity_req: woke up by EAP identity request packet
3728  * @four_way_handshake: woke up by 4-way handshake
3729  * @rfkill_release: woke up by rfkill being released
3730  * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
3731  * @packet_present_len: copied wakeup packet data
3732  * @packet_len: original wakeup packet length
3733  * @packet: The packet causing the wakeup, if any.
3734  * @packet_80211:  For pattern match, magic packet and other data
3735  *	frame triggers an 802.3 frame should be reported, for
3736  *	disconnect due to deauth 802.11 frame. This indicates which
3737  *	it is.
3738  * @tcp_match: TCP wakeup packet received
3739  * @tcp_connlost: TCP connection lost or failed to establish
3740  * @tcp_nomoretokens: TCP data ran out of tokens
3741  * @net_detect: if not %NULL, woke up because of net detect
3742  * @unprot_deauth_disassoc: woke up due to unprotected deauth or
3743  *	disassoc frame (in MFP).
3744  */
3745 struct cfg80211_wowlan_wakeup {
3746 	bool disconnect, magic_pkt, gtk_rekey_failure,
3747 	     eap_identity_req, four_way_handshake,
3748 	     rfkill_release, packet_80211,
3749 	     tcp_match, tcp_connlost, tcp_nomoretokens,
3750 	     unprot_deauth_disassoc;
3751 	s32 pattern_idx;
3752 	u32 packet_present_len, packet_len;
3753 	const void *packet;
3754 	struct cfg80211_wowlan_nd_info *net_detect;
3755 };
3756 
3757 /**
3758  * struct cfg80211_gtk_rekey_data - rekey data
3759  * @kek: key encryption key (@kek_len bytes)
3760  * @kck: key confirmation key (@kck_len bytes)
3761  * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
3762  * @kek_len: length of kek
3763  * @kck_len: length of kck
3764  * @akm: akm (oui, id)
3765  */
3766 struct cfg80211_gtk_rekey_data {
3767 	const u8 *kek, *kck, *replay_ctr;
3768 	u32 akm;
3769 	u8 kek_len, kck_len;
3770 };
3771 
3772 /**
3773  * struct cfg80211_update_ft_ies_params - FT IE Information
3774  *
3775  * This structure provides information needed to update the fast transition IE
3776  *
3777  * @md: The Mobility Domain ID, 2 Octet value
3778  * @ie: Fast Transition IEs
3779  * @ie_len: Length of ft_ie in octets
3780  */
3781 struct cfg80211_update_ft_ies_params {
3782 	u16 md;
3783 	const u8 *ie;
3784 	size_t ie_len;
3785 };
3786 
3787 /**
3788  * struct cfg80211_mgmt_tx_params - mgmt tx parameters
3789  *
3790  * This structure provides information needed to transmit a mgmt frame
3791  *
3792  * @chan: channel to use
3793  * @offchan: indicates whether off channel operation is required
3794  * @wait: duration for ROC
3795  * @buf: buffer to transmit
3796  * @len: buffer length
3797  * @no_cck: don't use cck rates for this frame
3798  * @dont_wait_for_ack: tells the low level not to wait for an ack
3799  * @n_csa_offsets: length of csa_offsets array
3800  * @csa_offsets: array of all the csa offsets in the frame
3801  * @link_id: for MLO, the link ID to transmit on, -1 if not given; note
3802  *	that the link ID isn't validated (much), it's in range but the
3803  *	link might not exist (or be used by the receiver STA)
3804  */
3805 struct cfg80211_mgmt_tx_params {
3806 	struct ieee80211_channel *chan;
3807 	bool offchan;
3808 	unsigned int wait;
3809 	const u8 *buf;
3810 	size_t len;
3811 	bool no_cck;
3812 	bool dont_wait_for_ack;
3813 	int n_csa_offsets;
3814 	const u16 *csa_offsets;
3815 	int link_id;
3816 };
3817 
3818 /**
3819  * struct cfg80211_dscp_exception - DSCP exception
3820  *
3821  * @dscp: DSCP value that does not adhere to the user priority range definition
3822  * @up: user priority value to which the corresponding DSCP value belongs
3823  */
3824 struct cfg80211_dscp_exception {
3825 	u8 dscp;
3826 	u8 up;
3827 };
3828 
3829 /**
3830  * struct cfg80211_dscp_range - DSCP range definition for user priority
3831  *
3832  * @low: lowest DSCP value of this user priority range, inclusive
3833  * @high: highest DSCP value of this user priority range, inclusive
3834  */
3835 struct cfg80211_dscp_range {
3836 	u8 low;
3837 	u8 high;
3838 };
3839 
3840 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
3841 #define IEEE80211_QOS_MAP_MAX_EX	21
3842 #define IEEE80211_QOS_MAP_LEN_MIN	16
3843 #define IEEE80211_QOS_MAP_LEN_MAX \
3844 	(IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
3845 
3846 /**
3847  * struct cfg80211_qos_map - QoS Map Information
3848  *
3849  * This struct defines the Interworking QoS map setting for DSCP values
3850  *
3851  * @num_des: number of DSCP exceptions (0..21)
3852  * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
3853  *	the user priority DSCP range definition
3854  * @up: DSCP range definition for a particular user priority
3855  */
3856 struct cfg80211_qos_map {
3857 	u8 num_des;
3858 	struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
3859 	struct cfg80211_dscp_range up[8];
3860 };
3861 
3862 /**
3863  * struct cfg80211_nan_conf - NAN configuration
3864  *
3865  * This struct defines NAN configuration parameters
3866  *
3867  * @master_pref: master preference (1 - 255)
3868  * @bands: operating bands, a bitmap of &enum nl80211_band values.
3869  *	For instance, for NL80211_BAND_2GHZ, bit 0 would be set
3870  *	(i.e. BIT(NL80211_BAND_2GHZ)).
3871  */
3872 struct cfg80211_nan_conf {
3873 	u8 master_pref;
3874 	u8 bands;
3875 };
3876 
3877 /**
3878  * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
3879  * configuration
3880  *
3881  * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
3882  * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
3883  */
3884 enum cfg80211_nan_conf_changes {
3885 	CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
3886 	CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
3887 };
3888 
3889 /**
3890  * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
3891  *
3892  * @filter: the content of the filter
3893  * @len: the length of the filter
3894  */
3895 struct cfg80211_nan_func_filter {
3896 	const u8 *filter;
3897 	u8 len;
3898 };
3899 
3900 /**
3901  * struct cfg80211_nan_func - a NAN function
3902  *
3903  * @type: &enum nl80211_nan_function_type
3904  * @service_id: the service ID of the function
3905  * @publish_type: &nl80211_nan_publish_type
3906  * @close_range: if true, the range should be limited. Threshold is
3907  *	implementation specific.
3908  * @publish_bcast: if true, the solicited publish should be broadcasted
3909  * @subscribe_active: if true, the subscribe is active
3910  * @followup_id: the instance ID for follow up
3911  * @followup_reqid: the requester instance ID for follow up
3912  * @followup_dest: MAC address of the recipient of the follow up
3913  * @ttl: time to live counter in DW.
3914  * @serv_spec_info: Service Specific Info
3915  * @serv_spec_info_len: Service Specific Info length
3916  * @srf_include: if true, SRF is inclusive
3917  * @srf_bf: Bloom Filter
3918  * @srf_bf_len: Bloom Filter length
3919  * @srf_bf_idx: Bloom Filter index
3920  * @srf_macs: SRF MAC addresses
3921  * @srf_num_macs: number of MAC addresses in SRF
3922  * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
3923  * @tx_filters: filters that should be transmitted in the SDF.
3924  * @num_rx_filters: length of &rx_filters.
3925  * @num_tx_filters: length of &tx_filters.
3926  * @instance_id: driver allocated id of the function.
3927  * @cookie: unique NAN function identifier.
3928  */
3929 struct cfg80211_nan_func {
3930 	enum nl80211_nan_function_type type;
3931 	u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
3932 	u8 publish_type;
3933 	bool close_range;
3934 	bool publish_bcast;
3935 	bool subscribe_active;
3936 	u8 followup_id;
3937 	u8 followup_reqid;
3938 	struct mac_address followup_dest;
3939 	u32 ttl;
3940 	const u8 *serv_spec_info;
3941 	u8 serv_spec_info_len;
3942 	bool srf_include;
3943 	const u8 *srf_bf;
3944 	u8 srf_bf_len;
3945 	u8 srf_bf_idx;
3946 	struct mac_address *srf_macs;
3947 	int srf_num_macs;
3948 	struct cfg80211_nan_func_filter *rx_filters;
3949 	struct cfg80211_nan_func_filter *tx_filters;
3950 	u8 num_tx_filters;
3951 	u8 num_rx_filters;
3952 	u8 instance_id;
3953 	u64 cookie;
3954 };
3955 
3956 /**
3957  * struct cfg80211_pmk_conf - PMK configuration
3958  *
3959  * @aa: authenticator address
3960  * @pmk_len: PMK length in bytes.
3961  * @pmk: the PMK material
3962  * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
3963  *	is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
3964  *	holds PMK-R0.
3965  */
3966 struct cfg80211_pmk_conf {
3967 	const u8 *aa;
3968 	u8 pmk_len;
3969 	const u8 *pmk;
3970 	const u8 *pmk_r0_name;
3971 };
3972 
3973 /**
3974  * struct cfg80211_external_auth_params - Trigger External authentication.
3975  *
3976  * Commonly used across the external auth request and event interfaces.
3977  *
3978  * @action: action type / trigger for external authentication. Only significant
3979  *	for the authentication request event interface (driver to user space).
3980  * @bssid: BSSID of the peer with which the authentication has
3981  *	to happen. Used by both the authentication request event and
3982  *	authentication response command interface.
3983  * @ssid: SSID of the AP.  Used by both the authentication request event and
3984  *	authentication response command interface.
3985  * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
3986  *	authentication request event interface.
3987  * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
3988  *	use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
3989  *	the real status code for failures. Used only for the authentication
3990  *	response command interface (user space to driver).
3991  * @pmkid: The identifier to refer a PMKSA.
3992  * @mld_addr: MLD address of the peer. Used by the authentication request event
3993  *	interface. Driver indicates this to enable MLO during the authentication
3994  *	offload to user space. Driver shall look at %NL80211_ATTR_MLO_SUPPORT
3995  *	flag capability in NL80211_CMD_CONNECT to know whether the user space
3996  *	supports enabling MLO during the authentication offload.
3997  *	User space should use the address of the interface (on which the
3998  *	authentication request event reported) as self MLD address. User space
3999  *	and driver should use MLD addresses in RA, TA and BSSID fields of
4000  *	authentication frames sent or received via cfg80211. The driver
4001  *	translates the MLD addresses to/from link addresses based on the link
4002  *	chosen for the authentication.
4003  */
4004 struct cfg80211_external_auth_params {
4005 	enum nl80211_external_auth_action action;
4006 	u8 bssid[ETH_ALEN] __aligned(2);
4007 	struct cfg80211_ssid ssid;
4008 	unsigned int key_mgmt_suite;
4009 	u16 status;
4010 	const u8 *pmkid;
4011 	u8 mld_addr[ETH_ALEN] __aligned(2);
4012 };
4013 
4014 /**
4015  * struct cfg80211_ftm_responder_stats - FTM responder statistics
4016  *
4017  * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
4018  *	indicate the relevant values in this struct for them
4019  * @success_num: number of FTM sessions in which all frames were successfully
4020  *	answered
4021  * @partial_num: number of FTM sessions in which part of frames were
4022  *	successfully answered
4023  * @failed_num: number of failed FTM sessions
4024  * @asap_num: number of ASAP FTM sessions
4025  * @non_asap_num: number of  non-ASAP FTM sessions
4026  * @total_duration_ms: total sessions durations - gives an indication
4027  *	of how much time the responder was busy
4028  * @unknown_triggers_num: number of unknown FTM triggers - triggers from
4029  *	initiators that didn't finish successfully the negotiation phase with
4030  *	the responder
4031  * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
4032  *	for a new scheduling although it already has scheduled FTM slot
4033  * @out_of_window_triggers_num: total FTM triggers out of scheduled window
4034  */
4035 struct cfg80211_ftm_responder_stats {
4036 	u32 filled;
4037 	u32 success_num;
4038 	u32 partial_num;
4039 	u32 failed_num;
4040 	u32 asap_num;
4041 	u32 non_asap_num;
4042 	u64 total_duration_ms;
4043 	u32 unknown_triggers_num;
4044 	u32 reschedule_requests_num;
4045 	u32 out_of_window_triggers_num;
4046 };
4047 
4048 /**
4049  * struct cfg80211_pmsr_ftm_result - FTM result
4050  * @failure_reason: if this measurement failed (PMSR status is
4051  *	%NL80211_PMSR_STATUS_FAILURE), this gives a more precise
4052  *	reason than just "failure"
4053  * @burst_index: if reporting partial results, this is the index
4054  *	in [0 .. num_bursts-1] of the burst that's being reported
4055  * @num_ftmr_attempts: number of FTM request frames transmitted
4056  * @num_ftmr_successes: number of FTM request frames acked
4057  * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
4058  *	fill this to indicate in how many seconds a retry is deemed possible
4059  *	by the responder
4060  * @num_bursts_exp: actual number of bursts exponent negotiated
4061  * @burst_duration: actual burst duration negotiated
4062  * @ftms_per_burst: actual FTMs per burst negotiated
4063  * @lci_len: length of LCI information (if present)
4064  * @civicloc_len: length of civic location information (if present)
4065  * @lci: LCI data (may be %NULL)
4066  * @civicloc: civic location data (may be %NULL)
4067  * @rssi_avg: average RSSI over FTM action frames reported
4068  * @rssi_spread: spread of the RSSI over FTM action frames reported
4069  * @tx_rate: bitrate for transmitted FTM action frame response
4070  * @rx_rate: bitrate of received FTM action frame
4071  * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
4072  * @rtt_variance: variance of RTTs measured (note that standard deviation is
4073  *	the square root of the variance)
4074  * @rtt_spread: spread of the RTTs measured
4075  * @dist_avg: average of distances (mm) measured
4076  *	(must have either this or @rtt_avg)
4077  * @dist_variance: variance of distances measured (see also @rtt_variance)
4078  * @dist_spread: spread of distances measured (see also @rtt_spread)
4079  * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
4080  * @num_ftmr_successes_valid: @num_ftmr_successes is valid
4081  * @rssi_avg_valid: @rssi_avg is valid
4082  * @rssi_spread_valid: @rssi_spread is valid
4083  * @tx_rate_valid: @tx_rate is valid
4084  * @rx_rate_valid: @rx_rate is valid
4085  * @rtt_avg_valid: @rtt_avg is valid
4086  * @rtt_variance_valid: @rtt_variance is valid
4087  * @rtt_spread_valid: @rtt_spread is valid
4088  * @dist_avg_valid: @dist_avg is valid
4089  * @dist_variance_valid: @dist_variance is valid
4090  * @dist_spread_valid: @dist_spread is valid
4091  */
4092 struct cfg80211_pmsr_ftm_result {
4093 	const u8 *lci;
4094 	const u8 *civicloc;
4095 	unsigned int lci_len;
4096 	unsigned int civicloc_len;
4097 	enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
4098 	u32 num_ftmr_attempts, num_ftmr_successes;
4099 	s16 burst_index;
4100 	u8 busy_retry_time;
4101 	u8 num_bursts_exp;
4102 	u8 burst_duration;
4103 	u8 ftms_per_burst;
4104 	s32 rssi_avg;
4105 	s32 rssi_spread;
4106 	struct rate_info tx_rate, rx_rate;
4107 	s64 rtt_avg;
4108 	s64 rtt_variance;
4109 	s64 rtt_spread;
4110 	s64 dist_avg;
4111 	s64 dist_variance;
4112 	s64 dist_spread;
4113 
4114 	u16 num_ftmr_attempts_valid:1,
4115 	    num_ftmr_successes_valid:1,
4116 	    rssi_avg_valid:1,
4117 	    rssi_spread_valid:1,
4118 	    tx_rate_valid:1,
4119 	    rx_rate_valid:1,
4120 	    rtt_avg_valid:1,
4121 	    rtt_variance_valid:1,
4122 	    rtt_spread_valid:1,
4123 	    dist_avg_valid:1,
4124 	    dist_variance_valid:1,
4125 	    dist_spread_valid:1;
4126 };
4127 
4128 /**
4129  * struct cfg80211_pmsr_result - peer measurement result
4130  * @addr: address of the peer
4131  * @host_time: host time (use ktime_get_boottime() adjust to the time when the
4132  *	measurement was made)
4133  * @ap_tsf: AP's TSF at measurement time
4134  * @status: status of the measurement
4135  * @final: if reporting partial results, mark this as the last one; if not
4136  *	reporting partial results always set this flag
4137  * @ap_tsf_valid: indicates the @ap_tsf value is valid
4138  * @type: type of the measurement reported, note that we only support reporting
4139  *	one type at a time, but you can report multiple results separately and
4140  *	they're all aggregated for userspace.
4141  * @ftm: FTM result
4142  */
4143 struct cfg80211_pmsr_result {
4144 	u64 host_time, ap_tsf;
4145 	enum nl80211_peer_measurement_status status;
4146 
4147 	u8 addr[ETH_ALEN];
4148 
4149 	u8 final:1,
4150 	   ap_tsf_valid:1;
4151 
4152 	enum nl80211_peer_measurement_type type;
4153 
4154 	union {
4155 		struct cfg80211_pmsr_ftm_result ftm;
4156 	};
4157 };
4158 
4159 /**
4160  * struct cfg80211_pmsr_ftm_request_peer - FTM request data
4161  * @requested: indicates FTM is requested
4162  * @preamble: frame preamble to use
4163  * @burst_period: burst period to use
4164  * @asap: indicates to use ASAP mode
4165  * @num_bursts_exp: number of bursts exponent
4166  * @burst_duration: burst duration
4167  * @ftms_per_burst: number of FTMs per burst
4168  * @ftmr_retries: number of retries for FTM request
4169  * @request_lci: request LCI information
4170  * @request_civicloc: request civic location information
4171  * @trigger_based: use trigger based ranging for the measurement
4172  *		 If neither @trigger_based nor @non_trigger_based is set,
4173  *		 EDCA based ranging will be used.
4174  * @non_trigger_based: use non trigger based ranging for the measurement
4175  *		 If neither @trigger_based nor @non_trigger_based is set,
4176  *		 EDCA based ranging will be used.
4177  * @lmr_feedback: negotiate for I2R LMR feedback. Only valid if either
4178  *		 @trigger_based or @non_trigger_based is set.
4179  * @bss_color: the bss color of the responder. Optional. Set to zero to
4180  *	indicate the driver should set the BSS color. Only valid if
4181  *	@non_trigger_based or @trigger_based is set.
4182  *
4183  * See also nl80211 for the respective attribute documentation.
4184  */
4185 struct cfg80211_pmsr_ftm_request_peer {
4186 	enum nl80211_preamble preamble;
4187 	u16 burst_period;
4188 	u8 requested:1,
4189 	   asap:1,
4190 	   request_lci:1,
4191 	   request_civicloc:1,
4192 	   trigger_based:1,
4193 	   non_trigger_based:1,
4194 	   lmr_feedback:1;
4195 	u8 num_bursts_exp;
4196 	u8 burst_duration;
4197 	u8 ftms_per_burst;
4198 	u8 ftmr_retries;
4199 	u8 bss_color;
4200 };
4201 
4202 /**
4203  * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
4204  * @addr: MAC address
4205  * @chandef: channel to use
4206  * @report_ap_tsf: report the associated AP's TSF
4207  * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
4208  */
4209 struct cfg80211_pmsr_request_peer {
4210 	u8 addr[ETH_ALEN];
4211 	struct cfg80211_chan_def chandef;
4212 	u8 report_ap_tsf:1;
4213 	struct cfg80211_pmsr_ftm_request_peer ftm;
4214 };
4215 
4216 /**
4217  * struct cfg80211_pmsr_request - peer measurement request
4218  * @cookie: cookie, set by cfg80211
4219  * @nl_portid: netlink portid - used by cfg80211
4220  * @drv_data: driver data for this request, if required for aborting,
4221  *	not otherwise freed or anything by cfg80211
4222  * @mac_addr: MAC address used for (randomised) request
4223  * @mac_addr_mask: MAC address mask used for randomisation, bits that
4224  *	are 0 in the mask should be randomised, bits that are 1 should
4225  *	be taken from the @mac_addr
4226  * @list: used by cfg80211 to hold on to the request
4227  * @timeout: timeout (in milliseconds) for the whole operation, if
4228  *	zero it means there's no timeout
4229  * @n_peers: number of peers to do measurements with
4230  * @peers: per-peer measurement request data
4231  */
4232 struct cfg80211_pmsr_request {
4233 	u64 cookie;
4234 	void *drv_data;
4235 	u32 n_peers;
4236 	u32 nl_portid;
4237 
4238 	u32 timeout;
4239 
4240 	u8 mac_addr[ETH_ALEN] __aligned(2);
4241 	u8 mac_addr_mask[ETH_ALEN] __aligned(2);
4242 
4243 	struct list_head list;
4244 
4245 	struct cfg80211_pmsr_request_peer peers[] __counted_by(n_peers);
4246 };
4247 
4248 /**
4249  * struct cfg80211_update_owe_info - OWE Information
4250  *
4251  * This structure provides information needed for the drivers to offload OWE
4252  * (Opportunistic Wireless Encryption) processing to the user space.
4253  *
4254  * Commonly used across update_owe_info request and event interfaces.
4255  *
4256  * @peer: MAC address of the peer device for which the OWE processing
4257  *	has to be done.
4258  * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
4259  *	processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
4260  *	cannot give you the real status code for failures. Used only for
4261  *	OWE update request command interface (user space to driver).
4262  * @ie: IEs obtained from the peer or constructed by the user space. These are
4263  *	the IEs of the remote peer in the event from the host driver and
4264  *	the constructed IEs by the user space in the request interface.
4265  * @ie_len: Length of IEs in octets.
4266  * @assoc_link_id: MLO link ID of the AP, with which (re)association requested
4267  *	by peer. This will be filled by driver for both MLO and non-MLO station
4268  *	connections when the AP affiliated with an MLD. For non-MLD AP mode, it
4269  *	will be -1. Used only with OWE update event (driver to user space).
4270  * @peer_mld_addr: For MLO connection, MLD address of the peer. For non-MLO
4271  *	connection, it will be all zeros. This is applicable only when
4272  *	@assoc_link_id is not -1, i.e., the AP affiliated with an MLD. Used only
4273  *	with OWE update event (driver to user space).
4274  */
4275 struct cfg80211_update_owe_info {
4276 	u8 peer[ETH_ALEN] __aligned(2);
4277 	u16 status;
4278 	const u8 *ie;
4279 	size_t ie_len;
4280 	int assoc_link_id;
4281 	u8 peer_mld_addr[ETH_ALEN] __aligned(2);
4282 };
4283 
4284 /**
4285  * struct mgmt_frame_regs - management frame registrations data
4286  * @global_stypes: bitmap of management frame subtypes registered
4287  *	for the entire device
4288  * @interface_stypes: bitmap of management frame subtypes registered
4289  *	for the given interface
4290  * @global_mcast_stypes: mcast RX is needed globally for these subtypes
4291  * @interface_mcast_stypes: mcast RX is needed on this interface
4292  *	for these subtypes
4293  */
4294 struct mgmt_frame_regs {
4295 	u32 global_stypes, interface_stypes;
4296 	u32 global_mcast_stypes, interface_mcast_stypes;
4297 };
4298 
4299 /**
4300  * struct cfg80211_ops - backend description for wireless configuration
4301  *
4302  * This struct is registered by fullmac card drivers and/or wireless stacks
4303  * in order to handle configuration requests on their interfaces.
4304  *
4305  * All callbacks except where otherwise noted should return 0
4306  * on success or a negative error code.
4307  *
4308  * All operations are invoked with the wiphy mutex held. The RTNL may be
4309  * held in addition (due to wireless extensions) but this cannot be relied
4310  * upon except in cases where documented below. Note that due to ordering,
4311  * the RTNL also cannot be acquired in any handlers.
4312  *
4313  * @suspend: wiphy device needs to be suspended. The variable @wow will
4314  *	be %NULL or contain the enabled Wake-on-Wireless triggers that are
4315  *	configured for the device.
4316  * @resume: wiphy device needs to be resumed
4317  * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
4318  *	to call device_set_wakeup_enable() to enable/disable wakeup from
4319  *	the device.
4320  *
4321  * @add_virtual_intf: create a new virtual interface with the given name,
4322  *	must set the struct wireless_dev's iftype. Beware: You must create
4323  *	the new netdev in the wiphy's network namespace! Returns the struct
4324  *	wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
4325  *	also set the address member in the wdev.
4326  *	This additionally holds the RTNL to be able to do netdev changes.
4327  *
4328  * @del_virtual_intf: remove the virtual interface
4329  *	This additionally holds the RTNL to be able to do netdev changes.
4330  *
4331  * @change_virtual_intf: change type/configuration of virtual interface,
4332  *	keep the struct wireless_dev's iftype updated.
4333  *	This additionally holds the RTNL to be able to do netdev changes.
4334  *
4335  * @add_intf_link: Add a new MLO link to the given interface. Note that
4336  *	the wdev->link[] data structure has been updated, so the new link
4337  *	address is available.
4338  * @del_intf_link: Remove an MLO link from the given interface.
4339  *
4340  * @add_key: add a key with the given parameters. @mac_addr will be %NULL
4341  *	when adding a group key. @link_id will be -1 for non-MLO connection.
4342  *	For MLO connection, @link_id will be >= 0 for group key and -1 for
4343  *	pairwise key, @mac_addr will be peer's MLD address for MLO pairwise key.
4344  *
4345  * @get_key: get information about the key with the given parameters.
4346  *	@mac_addr will be %NULL when requesting information for a group
4347  *	key. All pointers given to the @callback function need not be valid
4348  *	after it returns. This function should return an error if it is
4349  *	not possible to retrieve the key, -ENOENT if it doesn't exist.
4350  *	@link_id will be -1 for non-MLO connection. For MLO connection,
4351  *	@link_id will be >= 0 for group key and -1 for pairwise key, @mac_addr
4352  *	will be peer's MLD address for MLO pairwise key.
4353  *
4354  * @del_key: remove a key given the @mac_addr (%NULL for a group key)
4355  *	and @key_index, return -ENOENT if the key doesn't exist. @link_id will
4356  *	be -1 for non-MLO connection. For MLO connection, @link_id will be >= 0
4357  *	for group key and -1 for pairwise key, @mac_addr will be peer's MLD
4358  *	address for MLO pairwise key.
4359  *
4360  * @set_default_key: set the default key on an interface. @link_id will be >= 0
4361  *	for MLO connection and -1 for non-MLO connection.
4362  *
4363  * @set_default_mgmt_key: set the default management frame key on an interface.
4364  *	@link_id will be >= 0 for MLO connection and -1 for non-MLO connection.
4365  *
4366  * @set_default_beacon_key: set the default Beacon frame key on an interface.
4367  *	@link_id will be >= 0 for MLO connection and -1 for non-MLO connection.
4368  *
4369  * @set_rekey_data: give the data necessary for GTK rekeying to the driver
4370  *
4371  * @start_ap: Start acting in AP mode defined by the parameters.
4372  * @change_beacon: Change the beacon parameters for an access point mode
4373  *	interface. This should reject the call when AP mode wasn't started.
4374  * @stop_ap: Stop being an AP, including stopping beaconing.
4375  *
4376  * @add_station: Add a new station.
4377  * @del_station: Remove a station
4378  * @change_station: Modify a given station. Note that flags changes are not much
4379  *	validated in cfg80211, in particular the auth/assoc/authorized flags
4380  *	might come to the driver in invalid combinations -- make sure to check
4381  *	them, also against the existing state! Drivers must call
4382  *	cfg80211_check_station_change() to validate the information.
4383  * @get_station: get station information for the station identified by @mac
4384  * @dump_station: dump station callback -- resume dump at index @idx
4385  *
4386  * @add_mpath: add a fixed mesh path
4387  * @del_mpath: delete a given mesh path
4388  * @change_mpath: change a given mesh path
4389  * @get_mpath: get a mesh path for the given parameters
4390  * @dump_mpath: dump mesh path callback -- resume dump at index @idx
4391  * @get_mpp: get a mesh proxy path for the given parameters
4392  * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
4393  * @join_mesh: join the mesh network with the specified parameters
4394  *	(invoked with the wireless_dev mutex held)
4395  * @leave_mesh: leave the current mesh network
4396  *	(invoked with the wireless_dev mutex held)
4397  *
4398  * @get_mesh_config: Get the current mesh configuration
4399  *
4400  * @update_mesh_config: Update mesh parameters on a running mesh.
4401  *	The mask is a bitfield which tells us which parameters to
4402  *	set, and which to leave alone.
4403  *
4404  * @change_bss: Modify parameters for a given BSS.
4405  *
4406  * @inform_bss: Called by cfg80211 while being informed about new BSS data
4407  *	for every BSS found within the reported data or frame. This is called
4408  *	from within the cfg8011 inform_bss handlers while holding the bss_lock.
4409  *	The data parameter is passed through from drv_data inside
4410  *	struct cfg80211_inform_bss.
4411  *	The new IE data for the BSS is explicitly passed.
4412  *
4413  * @set_txq_params: Set TX queue parameters
4414  *
4415  * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
4416  *	as it doesn't implement join_mesh and needs to set the channel to
4417  *	join the mesh instead.
4418  *
4419  * @set_monitor_channel: Set the monitor mode channel for the device. If other
4420  *	interfaces are active this callback should reject the configuration.
4421  *	If no interfaces are active or the device is down, the channel should
4422  *	be stored for when a monitor interface becomes active.
4423  *
4424  * @scan: Request to do a scan. If returning zero, the scan request is given
4425  *	the driver, and will be valid until passed to cfg80211_scan_done().
4426  *	For scan results, call cfg80211_inform_bss(); you can call this outside
4427  *	the scan/scan_done bracket too.
4428  * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
4429  *	indicate the status of the scan through cfg80211_scan_done().
4430  *
4431  * @auth: Request to authenticate with the specified peer
4432  *	(invoked with the wireless_dev mutex held)
4433  * @assoc: Request to (re)associate with the specified peer
4434  *	(invoked with the wireless_dev mutex held)
4435  * @deauth: Request to deauthenticate from the specified peer
4436  *	(invoked with the wireless_dev mutex held)
4437  * @disassoc: Request to disassociate from the specified peer
4438  *	(invoked with the wireless_dev mutex held)
4439  *
4440  * @connect: Connect to the ESS with the specified parameters. When connected,
4441  *	call cfg80211_connect_result()/cfg80211_connect_bss() with status code
4442  *	%WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
4443  *	cfg80211_connect_result()/cfg80211_connect_bss() with the status code
4444  *	from the AP or cfg80211_connect_timeout() if no frame with status code
4445  *	was received.
4446  *	The driver is allowed to roam to other BSSes within the ESS when the
4447  *	other BSS matches the connect parameters. When such roaming is initiated
4448  *	by the driver, the driver is expected to verify that the target matches
4449  *	the configured security parameters and to use Reassociation Request
4450  *	frame instead of Association Request frame.
4451  *	The connect function can also be used to request the driver to perform a
4452  *	specific roam when connected to an ESS. In that case, the prev_bssid
4453  *	parameter is set to the BSSID of the currently associated BSS as an
4454  *	indication of requesting reassociation.
4455  *	In both the driver-initiated and new connect() call initiated roaming
4456  *	cases, the result of roaming is indicated with a call to
4457  *	cfg80211_roamed(). (invoked with the wireless_dev mutex held)
4458  * @update_connect_params: Update the connect parameters while connected to a
4459  *	BSS. The updated parameters can be used by driver/firmware for
4460  *	subsequent BSS selection (roaming) decisions and to form the
4461  *	Authentication/(Re)Association Request frames. This call does not
4462  *	request an immediate disassociation or reassociation with the current
4463  *	BSS, i.e., this impacts only subsequent (re)associations. The bits in
4464  *	changed are defined in &enum cfg80211_connect_params_changed.
4465  *	(invoked with the wireless_dev mutex held)
4466  * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
4467  *      connection is in progress. Once done, call cfg80211_disconnected() in
4468  *      case connection was already established (invoked with the
4469  *      wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
4470  *
4471  * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
4472  *	cfg80211_ibss_joined(), also call that function when changing BSSID due
4473  *	to a merge.
4474  *	(invoked with the wireless_dev mutex held)
4475  * @leave_ibss: Leave the IBSS.
4476  *	(invoked with the wireless_dev mutex held)
4477  *
4478  * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
4479  *	MESH mode)
4480  *
4481  * @set_wiphy_params: Notify that wiphy parameters have changed;
4482  *	@changed bitfield (see &enum wiphy_params_flags) describes which values
4483  *	have changed. The actual parameter values are available in
4484  *	struct wiphy. If returning an error, no value should be changed.
4485  *
4486  * @set_tx_power: set the transmit power according to the parameters,
4487  *	the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
4488  *	wdev may be %NULL if power was set for the wiphy, and will
4489  *	always be %NULL unless the driver supports per-vif TX power
4490  *	(as advertised by the nl80211 feature flag.)
4491  * @get_tx_power: store the current TX power into the dbm variable;
4492  *	return 0 if successful
4493  *
4494  * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
4495  *	functions to adjust rfkill hw state
4496  *
4497  * @dump_survey: get site survey information.
4498  *
4499  * @remain_on_channel: Request the driver to remain awake on the specified
4500  *	channel for the specified duration to complete an off-channel
4501  *	operation (e.g., public action frame exchange). When the driver is
4502  *	ready on the requested channel, it must indicate this with an event
4503  *	notification by calling cfg80211_ready_on_channel().
4504  * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
4505  *	This allows the operation to be terminated prior to timeout based on
4506  *	the duration value.
4507  * @mgmt_tx: Transmit a management frame.
4508  * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
4509  *	frame on another channel
4510  *
4511  * @testmode_cmd: run a test mode command; @wdev may be %NULL
4512  * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
4513  *	used by the function, but 0 and 1 must not be touched. Additionally,
4514  *	return error codes other than -ENOBUFS and -ENOENT will terminate the
4515  *	dump and return to userspace with an error, so be careful. If any data
4516  *	was passed in from userspace then the data/len arguments will be present
4517  *	and point to the data contained in %NL80211_ATTR_TESTDATA.
4518  *
4519  * @set_bitrate_mask: set the bitrate mask configuration
4520  *
4521  * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
4522  *	devices running firmwares capable of generating the (re) association
4523  *	RSN IE. It allows for faster roaming between WPA2 BSSIDs.
4524  * @del_pmksa: Delete a cached PMKID.
4525  * @flush_pmksa: Flush all cached PMKIDs.
4526  * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
4527  *	allows the driver to adjust the dynamic ps timeout value.
4528  * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
4529  *	After configuration, the driver should (soon) send an event indicating
4530  *	the current level is above/below the configured threshold; this may
4531  *	need some care when the configuration is changed (without first being
4532  *	disabled.)
4533  * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
4534  *	connection quality monitor.  An event is to be sent only when the
4535  *	signal level is found to be outside the two values.  The driver should
4536  *	set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
4537  *	If it is provided then there's no point providing @set_cqm_rssi_config.
4538  * @set_cqm_txe_config: Configure connection quality monitor TX error
4539  *	thresholds.
4540  * @sched_scan_start: Tell the driver to start a scheduled scan.
4541  * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
4542  *	given request id. This call must stop the scheduled scan and be ready
4543  *	for starting a new one before it returns, i.e. @sched_scan_start may be
4544  *	called immediately after that again and should not fail in that case.
4545  *	The driver should not call cfg80211_sched_scan_stopped() for a requested
4546  *	stop (when this method returns 0).
4547  *
4548  * @update_mgmt_frame_registrations: Notify the driver that management frame
4549  *	registrations were updated. The callback is allowed to sleep.
4550  *
4551  * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
4552  *	Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
4553  *	reject TX/RX mask combinations they cannot support by returning -EINVAL
4554  *	(also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
4555  *
4556  * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
4557  *
4558  * @tdls_mgmt: Transmit a TDLS management frame.
4559  * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
4560  *
4561  * @probe_client: probe an associated client, must return a cookie that it
4562  *	later passes to cfg80211_probe_status().
4563  *
4564  * @set_noack_map: Set the NoAck Map for the TIDs.
4565  *
4566  * @get_channel: Get the current operating channel for the virtual interface.
4567  *	For monitor interfaces, it should return %NULL unless there's a single
4568  *	current monitoring channel.
4569  *
4570  * @start_p2p_device: Start the given P2P device.
4571  * @stop_p2p_device: Stop the given P2P device.
4572  *
4573  * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
4574  *	Parameters include ACL policy, an array of MAC address of stations
4575  *	and the number of MAC addresses. If there is already a list in driver
4576  *	this new list replaces the existing one. Driver has to clear its ACL
4577  *	when number of MAC addresses entries is passed as 0. Drivers which
4578  *	advertise the support for MAC based ACL have to implement this callback.
4579  *
4580  * @start_radar_detection: Start radar detection in the driver.
4581  *
4582  * @end_cac: End running CAC, probably because a related CAC
4583  *	was finished on another phy.
4584  *
4585  * @update_ft_ies: Provide updated Fast BSS Transition information to the
4586  *	driver. If the SME is in the driver/firmware, this information can be
4587  *	used in building Authentication and Reassociation Request frames.
4588  *
4589  * @crit_proto_start: Indicates a critical protocol needs more link reliability
4590  *	for a given duration (milliseconds). The protocol is provided so the
4591  *	driver can take the most appropriate actions.
4592  * @crit_proto_stop: Indicates critical protocol no longer needs increased link
4593  *	reliability. This operation can not fail.
4594  * @set_coalesce: Set coalesce parameters.
4595  *
4596  * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
4597  *	responsible for veryfing if the switch is possible. Since this is
4598  *	inherently tricky driver may decide to disconnect an interface later
4599  *	with cfg80211_stop_iface(). This doesn't mean driver can accept
4600  *	everything. It should do it's best to verify requests and reject them
4601  *	as soon as possible.
4602  *
4603  * @set_qos_map: Set QoS mapping information to the driver
4604  *
4605  * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
4606  *	given interface This is used e.g. for dynamic HT 20/40 MHz channel width
4607  *	changes during the lifetime of the BSS.
4608  *
4609  * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
4610  *	with the given parameters; action frame exchange has been handled by
4611  *	userspace so this just has to modify the TX path to take the TS into
4612  *	account.
4613  *	If the admitted time is 0 just validate the parameters to make sure
4614  *	the session can be created at all; it is valid to just always return
4615  *	success for that but that may result in inefficient behaviour (handshake
4616  *	with the peer followed by immediate teardown when the addition is later
4617  *	rejected)
4618  * @del_tx_ts: remove an existing TX TS
4619  *
4620  * @join_ocb: join the OCB network with the specified parameters
4621  *	(invoked with the wireless_dev mutex held)
4622  * @leave_ocb: leave the current OCB network
4623  *	(invoked with the wireless_dev mutex held)
4624  *
4625  * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
4626  *	is responsible for continually initiating channel-switching operations
4627  *	and returning to the base channel for communication with the AP.
4628  * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
4629  *	peers must be on the base channel when the call completes.
4630  * @start_nan: Start the NAN interface.
4631  * @stop_nan: Stop the NAN interface.
4632  * @add_nan_func: Add a NAN function. Returns negative value on failure.
4633  *	On success @nan_func ownership is transferred to the driver and
4634  *	it may access it outside of the scope of this function. The driver
4635  *	should free the @nan_func when no longer needed by calling
4636  *	cfg80211_free_nan_func().
4637  *	On success the driver should assign an instance_id in the
4638  *	provided @nan_func.
4639  * @del_nan_func: Delete a NAN function.
4640  * @nan_change_conf: changes NAN configuration. The changed parameters must
4641  *	be specified in @changes (using &enum cfg80211_nan_conf_changes);
4642  *	All other parameters must be ignored.
4643  *
4644  * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
4645  *
4646  * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
4647  *      function should return phy stats, and interface stats otherwise.
4648  *
4649  * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
4650  *	If not deleted through @del_pmk the PMK remains valid until disconnect
4651  *	upon which the driver should clear it.
4652  *	(invoked with the wireless_dev mutex held)
4653  * @del_pmk: delete the previously configured PMK for the given authenticator.
4654  *	(invoked with the wireless_dev mutex held)
4655  *
4656  * @external_auth: indicates result of offloaded authentication processing from
4657  *     user space
4658  *
4659  * @tx_control_port: TX a control port frame (EAPoL).  The noencrypt parameter
4660  *	tells the driver that the frame should not be encrypted.
4661  *
4662  * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
4663  *	Statistics should be cumulative, currently no way to reset is provided.
4664  * @start_pmsr: start peer measurement (e.g. FTM)
4665  * @abort_pmsr: abort peer measurement
4666  *
4667  * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
4668  *	but offloading OWE processing to the user space will get the updated
4669  *	DH IE through this interface.
4670  *
4671  * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
4672  *	and overrule HWMP path selection algorithm.
4673  * @set_tid_config: TID specific configuration, this can be peer or BSS specific
4674  *	This callback may sleep.
4675  * @reset_tid_config: Reset TID specific configuration for the peer, for the
4676  *	given TIDs. This callback may sleep.
4677  *
4678  * @set_sar_specs: Update the SAR (TX power) settings.
4679  *
4680  * @color_change: Initiate a color change.
4681  *
4682  * @set_fils_aad: Set FILS AAD data to the AP driver so that the driver can use
4683  *	those to decrypt (Re)Association Request and encrypt (Re)Association
4684  *	Response frame.
4685  *
4686  * @set_radar_background: Configure dedicated offchannel chain available for
4687  *	radar/CAC detection on some hw. This chain can't be used to transmit
4688  *	or receive frames and it is bounded to a running wdev.
4689  *	Background radar/CAC detection allows to avoid the CAC downtime
4690  *	switching to a different channel during CAC detection on the selected
4691  *	radar channel.
4692  *	The caller is expected to set chandef pointer to NULL in order to
4693  *	disable background CAC/radar detection.
4694  * @add_link_station: Add a link to a station.
4695  * @mod_link_station: Modify a link of a station.
4696  * @del_link_station: Remove a link of a station.
4697  *
4698  * @set_hw_timestamp: Enable/disable HW timestamping of TM/FTM frames.
4699  * @set_ttlm: set the TID to link mapping.
4700  * @set_epcs: Enable/Disable EPCS for station mode.
4701  * @get_radio_mask: get bitmask of radios in use.
4702  *	(invoked with the wiphy mutex held)
4703  * @assoc_ml_reconf: Request a non-AP MLO connection to perform ML
4704  *	reconfiguration, i.e., add and/or remove links to/from the
4705  *	association using ML reconfiguration action frames. Successfully added
4706  *	links will be added to the set of valid links. Successfully removed
4707  *	links will be removed from the set of valid links. The driver must
4708  *	indicate removed links by calling cfg80211_links_removed() and added
4709  *	links by calling cfg80211_mlo_reconf_add_done(). When calling
4710  *	cfg80211_mlo_reconf_add_done() the bss pointer must be given for each
4711  *	link for which MLO reconfiguration 'add' operation was requested.
4712  */
4713 struct cfg80211_ops {
4714 	int	(*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
4715 	int	(*resume)(struct wiphy *wiphy);
4716 	void	(*set_wakeup)(struct wiphy *wiphy, bool enabled);
4717 
4718 	struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
4719 						  const char *name,
4720 						  unsigned char name_assign_type,
4721 						  enum nl80211_iftype type,
4722 						  struct vif_params *params);
4723 	int	(*del_virtual_intf)(struct wiphy *wiphy,
4724 				    struct wireless_dev *wdev);
4725 	int	(*change_virtual_intf)(struct wiphy *wiphy,
4726 				       struct net_device *dev,
4727 				       enum nl80211_iftype type,
4728 				       struct vif_params *params);
4729 
4730 	int	(*add_intf_link)(struct wiphy *wiphy,
4731 				 struct wireless_dev *wdev,
4732 				 unsigned int link_id);
4733 	void	(*del_intf_link)(struct wiphy *wiphy,
4734 				 struct wireless_dev *wdev,
4735 				 unsigned int link_id);
4736 
4737 	int	(*add_key)(struct wiphy *wiphy, struct net_device *netdev,
4738 			   int link_id, u8 key_index, bool pairwise,
4739 			   const u8 *mac_addr, struct key_params *params);
4740 	int	(*get_key)(struct wiphy *wiphy, struct net_device *netdev,
4741 			   int link_id, u8 key_index, bool pairwise,
4742 			   const u8 *mac_addr, void *cookie,
4743 			   void (*callback)(void *cookie, struct key_params*));
4744 	int	(*del_key)(struct wiphy *wiphy, struct net_device *netdev,
4745 			   int link_id, u8 key_index, bool pairwise,
4746 			   const u8 *mac_addr);
4747 	int	(*set_default_key)(struct wiphy *wiphy,
4748 				   struct net_device *netdev, int link_id,
4749 				   u8 key_index, bool unicast, bool multicast);
4750 	int	(*set_default_mgmt_key)(struct wiphy *wiphy,
4751 					struct net_device *netdev, int link_id,
4752 					u8 key_index);
4753 	int	(*set_default_beacon_key)(struct wiphy *wiphy,
4754 					  struct net_device *netdev,
4755 					  int link_id,
4756 					  u8 key_index);
4757 
4758 	int	(*start_ap)(struct wiphy *wiphy, struct net_device *dev,
4759 			    struct cfg80211_ap_settings *settings);
4760 	int	(*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
4761 				 struct cfg80211_ap_update *info);
4762 	int	(*stop_ap)(struct wiphy *wiphy, struct net_device *dev,
4763 			   unsigned int link_id);
4764 
4765 
4766 	int	(*add_station)(struct wiphy *wiphy, struct net_device *dev,
4767 			       const u8 *mac,
4768 			       struct station_parameters *params);
4769 	int	(*del_station)(struct wiphy *wiphy, struct net_device *dev,
4770 			       struct station_del_parameters *params);
4771 	int	(*change_station)(struct wiphy *wiphy, struct net_device *dev,
4772 				  const u8 *mac,
4773 				  struct station_parameters *params);
4774 	int	(*get_station)(struct wiphy *wiphy, struct net_device *dev,
4775 			       const u8 *mac, struct station_info *sinfo);
4776 	int	(*dump_station)(struct wiphy *wiphy, struct net_device *dev,
4777 				int idx, u8 *mac, struct station_info *sinfo);
4778 
4779 	int	(*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
4780 			       const u8 *dst, const u8 *next_hop);
4781 	int	(*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
4782 			       const u8 *dst);
4783 	int	(*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
4784 				  const u8 *dst, const u8 *next_hop);
4785 	int	(*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
4786 			     u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
4787 	int	(*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
4788 			      int idx, u8 *dst, u8 *next_hop,
4789 			      struct mpath_info *pinfo);
4790 	int	(*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
4791 			   u8 *dst, u8 *mpp, struct mpath_info *pinfo);
4792 	int	(*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
4793 			    int idx, u8 *dst, u8 *mpp,
4794 			    struct mpath_info *pinfo);
4795 	int	(*get_mesh_config)(struct wiphy *wiphy,
4796 				struct net_device *dev,
4797 				struct mesh_config *conf);
4798 	int	(*update_mesh_config)(struct wiphy *wiphy,
4799 				      struct net_device *dev, u32 mask,
4800 				      const struct mesh_config *nconf);
4801 	int	(*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
4802 			     const struct mesh_config *conf,
4803 			     const struct mesh_setup *setup);
4804 	int	(*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
4805 
4806 	int	(*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
4807 			    struct ocb_setup *setup);
4808 	int	(*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
4809 
4810 	int	(*change_bss)(struct wiphy *wiphy, struct net_device *dev,
4811 			      struct bss_parameters *params);
4812 
4813 	void	(*inform_bss)(struct wiphy *wiphy, struct cfg80211_bss *bss,
4814 			      const struct cfg80211_bss_ies *ies, void *data);
4815 
4816 	int	(*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
4817 				  struct ieee80211_txq_params *params);
4818 
4819 	int	(*libertas_set_mesh_channel)(struct wiphy *wiphy,
4820 					     struct net_device *dev,
4821 					     struct ieee80211_channel *chan);
4822 
4823 	int	(*set_monitor_channel)(struct wiphy *wiphy,
4824 				       struct net_device *dev,
4825 				       struct cfg80211_chan_def *chandef);
4826 
4827 	int	(*scan)(struct wiphy *wiphy,
4828 			struct cfg80211_scan_request *request);
4829 	void	(*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4830 
4831 	int	(*auth)(struct wiphy *wiphy, struct net_device *dev,
4832 			struct cfg80211_auth_request *req);
4833 	int	(*assoc)(struct wiphy *wiphy, struct net_device *dev,
4834 			 struct cfg80211_assoc_request *req);
4835 	int	(*deauth)(struct wiphy *wiphy, struct net_device *dev,
4836 			  struct cfg80211_deauth_request *req);
4837 	int	(*disassoc)(struct wiphy *wiphy, struct net_device *dev,
4838 			    struct cfg80211_disassoc_request *req);
4839 
4840 	int	(*connect)(struct wiphy *wiphy, struct net_device *dev,
4841 			   struct cfg80211_connect_params *sme);
4842 	int	(*update_connect_params)(struct wiphy *wiphy,
4843 					 struct net_device *dev,
4844 					 struct cfg80211_connect_params *sme,
4845 					 u32 changed);
4846 	int	(*disconnect)(struct wiphy *wiphy, struct net_device *dev,
4847 			      u16 reason_code);
4848 
4849 	int	(*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
4850 			     struct cfg80211_ibss_params *params);
4851 	int	(*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
4852 
4853 	int	(*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
4854 				  int rate[NUM_NL80211_BANDS]);
4855 
4856 	int	(*set_wiphy_params)(struct wiphy *wiphy, int radio_idx,
4857 				    u32 changed);
4858 
4859 	int	(*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4860 				int radio_idx,
4861 				enum nl80211_tx_power_setting type, int mbm);
4862 	int	(*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4863 				int radio_idx, unsigned int link_id, int *dbm);
4864 
4865 	void	(*rfkill_poll)(struct wiphy *wiphy);
4866 
4867 #ifdef CONFIG_NL80211_TESTMODE
4868 	int	(*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
4869 				void *data, int len);
4870 	int	(*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
4871 				 struct netlink_callback *cb,
4872 				 void *data, int len);
4873 #endif
4874 
4875 	int	(*set_bitrate_mask)(struct wiphy *wiphy,
4876 				    struct net_device *dev,
4877 				    unsigned int link_id,
4878 				    const u8 *peer,
4879 				    const struct cfg80211_bitrate_mask *mask);
4880 
4881 	int	(*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
4882 			int idx, struct survey_info *info);
4883 
4884 	int	(*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4885 			     struct cfg80211_pmksa *pmksa);
4886 	int	(*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4887 			     struct cfg80211_pmksa *pmksa);
4888 	int	(*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
4889 
4890 	int	(*remain_on_channel)(struct wiphy *wiphy,
4891 				     struct wireless_dev *wdev,
4892 				     struct ieee80211_channel *chan,
4893 				     unsigned int duration,
4894 				     u64 *cookie);
4895 	int	(*cancel_remain_on_channel)(struct wiphy *wiphy,
4896 					    struct wireless_dev *wdev,
4897 					    u64 cookie);
4898 
4899 	int	(*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
4900 			   struct cfg80211_mgmt_tx_params *params,
4901 			   u64 *cookie);
4902 	int	(*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
4903 				       struct wireless_dev *wdev,
4904 				       u64 cookie);
4905 
4906 	int	(*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4907 				  bool enabled, int timeout);
4908 
4909 	int	(*set_cqm_rssi_config)(struct wiphy *wiphy,
4910 				       struct net_device *dev,
4911 				       s32 rssi_thold, u32 rssi_hyst);
4912 
4913 	int	(*set_cqm_rssi_range_config)(struct wiphy *wiphy,
4914 					     struct net_device *dev,
4915 					     s32 rssi_low, s32 rssi_high);
4916 
4917 	int	(*set_cqm_txe_config)(struct wiphy *wiphy,
4918 				      struct net_device *dev,
4919 				      u32 rate, u32 pkts, u32 intvl);
4920 
4921 	void	(*update_mgmt_frame_registrations)(struct wiphy *wiphy,
4922 						   struct wireless_dev *wdev,
4923 						   struct mgmt_frame_regs *upd);
4924 
4925 	int	(*set_antenna)(struct wiphy *wiphy, int radio_idx,
4926 			       u32 tx_ant, u32 rx_ant);
4927 	int	(*get_antenna)(struct wiphy *wiphy, int radio_idx,
4928 			       u32 *tx_ant, u32 *rx_ant);
4929 
4930 	int	(*sched_scan_start)(struct wiphy *wiphy,
4931 				struct net_device *dev,
4932 				struct cfg80211_sched_scan_request *request);
4933 	int	(*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
4934 				   u64 reqid);
4935 
4936 	int	(*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
4937 				  struct cfg80211_gtk_rekey_data *data);
4938 
4939 	int	(*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4940 			     const u8 *peer, int link_id,
4941 			     u8 action_code, u8 dialog_token, u16 status_code,
4942 			     u32 peer_capability, bool initiator,
4943 			     const u8 *buf, size_t len);
4944 	int	(*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
4945 			     const u8 *peer, enum nl80211_tdls_operation oper);
4946 
4947 	int	(*probe_client)(struct wiphy *wiphy, struct net_device *dev,
4948 				const u8 *peer, u64 *cookie);
4949 
4950 	int	(*set_noack_map)(struct wiphy *wiphy,
4951 				  struct net_device *dev,
4952 				  u16 noack_map);
4953 
4954 	int	(*get_channel)(struct wiphy *wiphy,
4955 			       struct wireless_dev *wdev,
4956 			       unsigned int link_id,
4957 			       struct cfg80211_chan_def *chandef);
4958 
4959 	int	(*start_p2p_device)(struct wiphy *wiphy,
4960 				    struct wireless_dev *wdev);
4961 	void	(*stop_p2p_device)(struct wiphy *wiphy,
4962 				   struct wireless_dev *wdev);
4963 
4964 	int	(*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
4965 			       const struct cfg80211_acl_data *params);
4966 
4967 	int	(*start_radar_detection)(struct wiphy *wiphy,
4968 					 struct net_device *dev,
4969 					 struct cfg80211_chan_def *chandef,
4970 					 u32 cac_time_ms, int link_id);
4971 	void	(*end_cac)(struct wiphy *wiphy,
4972 			   struct net_device *dev, unsigned int link_id);
4973 	int	(*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
4974 				 struct cfg80211_update_ft_ies_params *ftie);
4975 	int	(*crit_proto_start)(struct wiphy *wiphy,
4976 				    struct wireless_dev *wdev,
4977 				    enum nl80211_crit_proto_id protocol,
4978 				    u16 duration);
4979 	void	(*crit_proto_stop)(struct wiphy *wiphy,
4980 				   struct wireless_dev *wdev);
4981 	int	(*set_coalesce)(struct wiphy *wiphy,
4982 				struct cfg80211_coalesce *coalesce);
4983 
4984 	int	(*channel_switch)(struct wiphy *wiphy,
4985 				  struct net_device *dev,
4986 				  struct cfg80211_csa_settings *params);
4987 
4988 	int     (*set_qos_map)(struct wiphy *wiphy,
4989 			       struct net_device *dev,
4990 			       struct cfg80211_qos_map *qos_map);
4991 
4992 	int	(*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
4993 				    unsigned int link_id,
4994 				    struct cfg80211_chan_def *chandef);
4995 
4996 	int	(*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4997 			     u8 tsid, const u8 *peer, u8 user_prio,
4998 			     u16 admitted_time);
4999 	int	(*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
5000 			     u8 tsid, const u8 *peer);
5001 
5002 	int	(*tdls_channel_switch)(struct wiphy *wiphy,
5003 				       struct net_device *dev,
5004 				       const u8 *addr, u8 oper_class,
5005 				       struct cfg80211_chan_def *chandef);
5006 	void	(*tdls_cancel_channel_switch)(struct wiphy *wiphy,
5007 					      struct net_device *dev,
5008 					      const u8 *addr);
5009 	int	(*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
5010 			     struct cfg80211_nan_conf *conf);
5011 	void	(*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
5012 	int	(*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
5013 				struct cfg80211_nan_func *nan_func);
5014 	void	(*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
5015 			       u64 cookie);
5016 	int	(*nan_change_conf)(struct wiphy *wiphy,
5017 				   struct wireless_dev *wdev,
5018 				   struct cfg80211_nan_conf *conf,
5019 				   u32 changes);
5020 
5021 	int	(*set_multicast_to_unicast)(struct wiphy *wiphy,
5022 					    struct net_device *dev,
5023 					    const bool enabled);
5024 
5025 	int	(*get_txq_stats)(struct wiphy *wiphy,
5026 				 struct wireless_dev *wdev,
5027 				 struct cfg80211_txq_stats *txqstats);
5028 
5029 	int	(*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
5030 			   const struct cfg80211_pmk_conf *conf);
5031 	int	(*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
5032 			   const u8 *aa);
5033 	int     (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
5034 				 struct cfg80211_external_auth_params *params);
5035 
5036 	int	(*tx_control_port)(struct wiphy *wiphy,
5037 				   struct net_device *dev,
5038 				   const u8 *buf, size_t len,
5039 				   const u8 *dest, const __be16 proto,
5040 				   const bool noencrypt, int link_id,
5041 				   u64 *cookie);
5042 
5043 	int	(*get_ftm_responder_stats)(struct wiphy *wiphy,
5044 				struct net_device *dev,
5045 				struct cfg80211_ftm_responder_stats *ftm_stats);
5046 
5047 	int	(*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
5048 			      struct cfg80211_pmsr_request *request);
5049 	void	(*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
5050 			      struct cfg80211_pmsr_request *request);
5051 	int	(*update_owe_info)(struct wiphy *wiphy, struct net_device *dev,
5052 				   struct cfg80211_update_owe_info *owe_info);
5053 	int	(*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev,
5054 				   const u8 *buf, size_t len);
5055 	int     (*set_tid_config)(struct wiphy *wiphy, struct net_device *dev,
5056 				  struct cfg80211_tid_config *tid_conf);
5057 	int	(*reset_tid_config)(struct wiphy *wiphy, struct net_device *dev,
5058 				    const u8 *peer, u8 tids);
5059 	int	(*set_sar_specs)(struct wiphy *wiphy,
5060 				 struct cfg80211_sar_specs *sar);
5061 	int	(*color_change)(struct wiphy *wiphy,
5062 				struct net_device *dev,
5063 				struct cfg80211_color_change_settings *params);
5064 	int     (*set_fils_aad)(struct wiphy *wiphy, struct net_device *dev,
5065 				struct cfg80211_fils_aad *fils_aad);
5066 	int	(*set_radar_background)(struct wiphy *wiphy,
5067 					struct cfg80211_chan_def *chandef);
5068 	int	(*add_link_station)(struct wiphy *wiphy, struct net_device *dev,
5069 				    struct link_station_parameters *params);
5070 	int	(*mod_link_station)(struct wiphy *wiphy, struct net_device *dev,
5071 				    struct link_station_parameters *params);
5072 	int	(*del_link_station)(struct wiphy *wiphy, struct net_device *dev,
5073 				    struct link_station_del_parameters *params);
5074 	int	(*set_hw_timestamp)(struct wiphy *wiphy, struct net_device *dev,
5075 				    struct cfg80211_set_hw_timestamp *hwts);
5076 	int	(*set_ttlm)(struct wiphy *wiphy, struct net_device *dev,
5077 			    struct cfg80211_ttlm_params *params);
5078 	u32	(*get_radio_mask)(struct wiphy *wiphy, struct net_device *dev);
5079 	int     (*assoc_ml_reconf)(struct wiphy *wiphy, struct net_device *dev,
5080 				   struct cfg80211_ml_reconf_req *req);
5081 	int	(*set_epcs)(struct wiphy *wiphy, struct net_device *dev,
5082 			    bool val);
5083 };
5084 
5085 /*
5086  * wireless hardware and networking interfaces structures
5087  * and registration/helper functions
5088  */
5089 
5090 /**
5091  * enum wiphy_flags - wiphy capability flags
5092  *
5093  * @WIPHY_FLAG_SPLIT_SCAN_6GHZ: if set to true, the scan request will be split
5094  *	 into two, first for legacy bands and second for 6 GHz.
5095  * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
5096  *	wiphy at all
5097  * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
5098  *	by default -- this flag will be set depending on the kernel's default
5099  *	on wiphy_new(), but can be changed by the driver if it has a good
5100  *	reason to override the default
5101  * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
5102  *	on a VLAN interface). This flag also serves an extra purpose of
5103  *	supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
5104  * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
5105  * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
5106  *	control port protocol ethertype. The device also honours the
5107  *	control_port_no_encrypt flag.
5108  * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
5109  * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
5110  *	auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
5111  * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
5112  *	firmware.
5113  * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
5114  * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
5115  * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
5116  *	link setup/discovery operations internally. Setup, discovery and
5117  *	teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
5118  *	command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
5119  *	used for asking the driver/firmware to perform a TDLS operation.
5120  * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
5121  * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
5122  *	when there are virtual interfaces in AP mode by calling
5123  *	cfg80211_report_obss_beacon().
5124  * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
5125  *	responds to probe-requests in hardware.
5126  * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
5127  * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
5128  * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
5129  * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
5130  *	beaconing mode (AP, IBSS, Mesh, ...).
5131  * @WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK: The device supports bigger kek and kck keys
5132  * @WIPHY_FLAG_SUPPORTS_MLO: This is a temporary flag gating the MLO APIs,
5133  *	in order to not have them reachable in normal drivers, until we have
5134  *	complete feature/interface combinations/etc. advertisement. No driver
5135  *	should set this flag for now.
5136  * @WIPHY_FLAG_SUPPORTS_EXT_KCK_32: The device supports 32-byte KCK keys.
5137  * @WIPHY_FLAG_NOTIFY_REGDOM_BY_DRIVER: The device could handle reg notify for
5138  *	NL80211_REGDOM_SET_BY_DRIVER.
5139  * @WIPHY_FLAG_CHANNEL_CHANGE_ON_BEACON: reg_call_notifier() is called if driver
5140  *	set this flag to update channels on beacon hints.
5141  * @WIPHY_FLAG_SUPPORTS_NSTR_NONPRIMARY: support connection to non-primary link
5142  *	of an NSTR mobile AP MLD.
5143  * @WIPHY_FLAG_DISABLE_WEXT: disable wireless extensions for this device
5144  */
5145 enum wiphy_flags {
5146 	WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK		= BIT(0),
5147 	WIPHY_FLAG_SUPPORTS_MLO			= BIT(1),
5148 	WIPHY_FLAG_SPLIT_SCAN_6GHZ		= BIT(2),
5149 	WIPHY_FLAG_NETNS_OK			= BIT(3),
5150 	WIPHY_FLAG_PS_ON_BY_DEFAULT		= BIT(4),
5151 	WIPHY_FLAG_4ADDR_AP			= BIT(5),
5152 	WIPHY_FLAG_4ADDR_STATION		= BIT(6),
5153 	WIPHY_FLAG_CONTROL_PORT_PROTOCOL	= BIT(7),
5154 	WIPHY_FLAG_IBSS_RSN			= BIT(8),
5155 	WIPHY_FLAG_DISABLE_WEXT			= BIT(9),
5156 	WIPHY_FLAG_MESH_AUTH			= BIT(10),
5157 	WIPHY_FLAG_SUPPORTS_EXT_KCK_32          = BIT(11),
5158 	WIPHY_FLAG_SUPPORTS_NSTR_NONPRIMARY	= BIT(12),
5159 	WIPHY_FLAG_SUPPORTS_FW_ROAM		= BIT(13),
5160 	WIPHY_FLAG_AP_UAPSD			= BIT(14),
5161 	WIPHY_FLAG_SUPPORTS_TDLS		= BIT(15),
5162 	WIPHY_FLAG_TDLS_EXTERNAL_SETUP		= BIT(16),
5163 	WIPHY_FLAG_HAVE_AP_SME			= BIT(17),
5164 	WIPHY_FLAG_REPORTS_OBSS			= BIT(18),
5165 	WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD	= BIT(19),
5166 	WIPHY_FLAG_OFFCHAN_TX			= BIT(20),
5167 	WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL	= BIT(21),
5168 	WIPHY_FLAG_SUPPORTS_5_10_MHZ		= BIT(22),
5169 	WIPHY_FLAG_HAS_CHANNEL_SWITCH		= BIT(23),
5170 	WIPHY_FLAG_NOTIFY_REGDOM_BY_DRIVER	= BIT(24),
5171 	WIPHY_FLAG_CHANNEL_CHANGE_ON_BEACON     = BIT(25),
5172 };
5173 
5174 /**
5175  * struct ieee80211_iface_limit - limit on certain interface types
5176  * @max: maximum number of interfaces of these types
5177  * @types: interface types (bits)
5178  */
5179 struct ieee80211_iface_limit {
5180 	u16 max;
5181 	u16 types;
5182 };
5183 
5184 /**
5185  * struct ieee80211_iface_combination - possible interface combination
5186  *
5187  * With this structure the driver can describe which interface
5188  * combinations it supports concurrently. When set in a struct wiphy_radio,
5189  * the combinations refer to combinations of interfaces currently active on
5190  * that radio.
5191  *
5192  * Examples:
5193  *
5194  * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
5195  *
5196  *    .. code-block:: c
5197  *
5198  *	struct ieee80211_iface_limit limits1[] = {
5199  *		{ .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
5200  *		{ .max = 1, .types = BIT(NL80211_IFTYPE_AP), },
5201  *	};
5202  *	struct ieee80211_iface_combination combination1 = {
5203  *		.limits = limits1,
5204  *		.n_limits = ARRAY_SIZE(limits1),
5205  *		.max_interfaces = 2,
5206  *		.beacon_int_infra_match = true,
5207  *	};
5208  *
5209  *
5210  * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
5211  *
5212  *    .. code-block:: c
5213  *
5214  *	struct ieee80211_iface_limit limits2[] = {
5215  *		{ .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
5216  *				     BIT(NL80211_IFTYPE_P2P_GO), },
5217  *	};
5218  *	struct ieee80211_iface_combination combination2 = {
5219  *		.limits = limits2,
5220  *		.n_limits = ARRAY_SIZE(limits2),
5221  *		.max_interfaces = 8,
5222  *		.num_different_channels = 1,
5223  *	};
5224  *
5225  *
5226  * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
5227  *
5228  *    This allows for an infrastructure connection and three P2P connections.
5229  *
5230  *    .. code-block:: c
5231  *
5232  *	struct ieee80211_iface_limit limits3[] = {
5233  *		{ .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
5234  *		{ .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
5235  *				     BIT(NL80211_IFTYPE_P2P_CLIENT), },
5236  *	};
5237  *	struct ieee80211_iface_combination combination3 = {
5238  *		.limits = limits3,
5239  *		.n_limits = ARRAY_SIZE(limits3),
5240  *		.max_interfaces = 4,
5241  *		.num_different_channels = 2,
5242  *	};
5243  *
5244  */
5245 struct ieee80211_iface_combination {
5246 	/**
5247 	 * @limits:
5248 	 * limits for the given interface types
5249 	 */
5250 	const struct ieee80211_iface_limit *limits;
5251 
5252 	/**
5253 	 * @num_different_channels:
5254 	 * can use up to this many different channels
5255 	 */
5256 	u32 num_different_channels;
5257 
5258 	/**
5259 	 * @max_interfaces:
5260 	 * maximum number of interfaces in total allowed in this group
5261 	 */
5262 	u16 max_interfaces;
5263 
5264 	/**
5265 	 * @n_limits:
5266 	 * number of limitations
5267 	 */
5268 	u8 n_limits;
5269 
5270 	/**
5271 	 * @beacon_int_infra_match:
5272 	 * In this combination, the beacon intervals between infrastructure
5273 	 * and AP types must match. This is required only in special cases.
5274 	 */
5275 	bool beacon_int_infra_match;
5276 
5277 	/**
5278 	 * @radar_detect_widths:
5279 	 * bitmap of channel widths supported for radar detection
5280 	 */
5281 	u8 radar_detect_widths;
5282 
5283 	/**
5284 	 * @radar_detect_regions:
5285 	 * bitmap of regions supported for radar detection
5286 	 */
5287 	u8 radar_detect_regions;
5288 
5289 	/**
5290 	 * @beacon_int_min_gcd:
5291 	 * This interface combination supports different beacon intervals.
5292 	 *
5293 	 * = 0
5294 	 *   all beacon intervals for different interface must be same.
5295 	 * > 0
5296 	 *   any beacon interval for the interface part of this combination AND
5297 	 *   GCD of all beacon intervals from beaconing interfaces of this
5298 	 *   combination must be greater or equal to this value.
5299 	 */
5300 	u32 beacon_int_min_gcd;
5301 };
5302 
5303 struct ieee80211_txrx_stypes {
5304 	u16 tx, rx;
5305 };
5306 
5307 /**
5308  * enum wiphy_wowlan_support_flags - WoWLAN support flags
5309  * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
5310  *	trigger that keeps the device operating as-is and
5311  *	wakes up the host on any activity, for example a
5312  *	received packet that passed filtering; note that the
5313  *	packet should be preserved in that case
5314  * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
5315  *	(see nl80211.h)
5316  * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
5317  * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
5318  * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
5319  * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
5320  * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
5321  * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
5322  * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
5323  */
5324 enum wiphy_wowlan_support_flags {
5325 	WIPHY_WOWLAN_ANY		= BIT(0),
5326 	WIPHY_WOWLAN_MAGIC_PKT		= BIT(1),
5327 	WIPHY_WOWLAN_DISCONNECT		= BIT(2),
5328 	WIPHY_WOWLAN_SUPPORTS_GTK_REKEY	= BIT(3),
5329 	WIPHY_WOWLAN_GTK_REKEY_FAILURE	= BIT(4),
5330 	WIPHY_WOWLAN_EAP_IDENTITY_REQ	= BIT(5),
5331 	WIPHY_WOWLAN_4WAY_HANDSHAKE	= BIT(6),
5332 	WIPHY_WOWLAN_RFKILL_RELEASE	= BIT(7),
5333 	WIPHY_WOWLAN_NET_DETECT		= BIT(8),
5334 };
5335 
5336 struct wiphy_wowlan_tcp_support {
5337 	const struct nl80211_wowlan_tcp_data_token_feature *tok;
5338 	u32 data_payload_max;
5339 	u32 data_interval_max;
5340 	u32 wake_payload_max;
5341 	bool seq;
5342 };
5343 
5344 /**
5345  * struct wiphy_wowlan_support - WoWLAN support data
5346  * @flags: see &enum wiphy_wowlan_support_flags
5347  * @n_patterns: number of supported wakeup patterns
5348  *	(see nl80211.h for the pattern definition)
5349  * @pattern_max_len: maximum length of each pattern
5350  * @pattern_min_len: minimum length of each pattern
5351  * @max_pkt_offset: maximum Rx packet offset
5352  * @max_nd_match_sets: maximum number of matchsets for net-detect,
5353  *	similar, but not necessarily identical, to max_match_sets for
5354  *	scheduled scans.
5355  *	See &struct cfg80211_sched_scan_request.@match_sets for more
5356  *	details.
5357  * @tcp: TCP wakeup support information
5358  */
5359 struct wiphy_wowlan_support {
5360 	u32 flags;
5361 	int n_patterns;
5362 	int pattern_max_len;
5363 	int pattern_min_len;
5364 	int max_pkt_offset;
5365 	int max_nd_match_sets;
5366 	const struct wiphy_wowlan_tcp_support *tcp;
5367 };
5368 
5369 /**
5370  * struct wiphy_coalesce_support - coalesce support data
5371  * @n_rules: maximum number of coalesce rules
5372  * @max_delay: maximum supported coalescing delay in msecs
5373  * @n_patterns: number of supported patterns in a rule
5374  *	(see nl80211.h for the pattern definition)
5375  * @pattern_max_len: maximum length of each pattern
5376  * @pattern_min_len: minimum length of each pattern
5377  * @max_pkt_offset: maximum Rx packet offset
5378  */
5379 struct wiphy_coalesce_support {
5380 	int n_rules;
5381 	int max_delay;
5382 	int n_patterns;
5383 	int pattern_max_len;
5384 	int pattern_min_len;
5385 	int max_pkt_offset;
5386 };
5387 
5388 /**
5389  * enum wiphy_vendor_command_flags - validation flags for vendor commands
5390  * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
5391  * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
5392  * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
5393  *	(must be combined with %_WDEV or %_NETDEV)
5394  */
5395 enum wiphy_vendor_command_flags {
5396 	WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
5397 	WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
5398 	WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
5399 };
5400 
5401 /**
5402  * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
5403  *
5404  * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
5405  * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
5406  * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
5407  *
5408  */
5409 enum wiphy_opmode_flag {
5410 	STA_OPMODE_MAX_BW_CHANGED	= BIT(0),
5411 	STA_OPMODE_SMPS_MODE_CHANGED	= BIT(1),
5412 	STA_OPMODE_N_SS_CHANGED		= BIT(2),
5413 };
5414 
5415 /**
5416  * struct sta_opmode_info - Station's ht/vht operation mode information
5417  * @changed: contains value from &enum wiphy_opmode_flag
5418  * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
5419  * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
5420  * @rx_nss: new rx_nss value of a station
5421  */
5422 
5423 struct sta_opmode_info {
5424 	u32 changed;
5425 	enum nl80211_smps_mode smps_mode;
5426 	enum nl80211_chan_width bw;
5427 	u8 rx_nss;
5428 };
5429 
5430 #define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA))
5431 
5432 /**
5433  * struct wiphy_vendor_command - vendor command definition
5434  * @info: vendor command identifying information, as used in nl80211
5435  * @flags: flags, see &enum wiphy_vendor_command_flags
5436  * @doit: callback for the operation, note that wdev is %NULL if the
5437  *	flags didn't ask for a wdev and non-%NULL otherwise; the data
5438  *	pointer may be %NULL if userspace provided no data at all
5439  * @dumpit: dump callback, for transferring bigger/multiple items. The
5440  *	@storage points to cb->args[5], ie. is preserved over the multiple
5441  *	dumpit calls.
5442  * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
5443  *	Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
5444  *	attribute is just raw data (e.g. a firmware command).
5445  * @maxattr: highest attribute number in policy
5446  * It's recommended to not have the same sub command with both @doit and
5447  * @dumpit, so that userspace can assume certain ones are get and others
5448  * are used with dump requests.
5449  */
5450 struct wiphy_vendor_command {
5451 	struct nl80211_vendor_cmd_info info;
5452 	u32 flags;
5453 	int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
5454 		    const void *data, int data_len);
5455 	int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
5456 		      struct sk_buff *skb, const void *data, int data_len,
5457 		      unsigned long *storage);
5458 	const struct nla_policy *policy;
5459 	unsigned int maxattr;
5460 };
5461 
5462 /**
5463  * struct wiphy_iftype_ext_capab - extended capabilities per interface type
5464  * @iftype: interface type
5465  * @extended_capabilities: extended capabilities supported by the driver,
5466  *	additional capabilities might be supported by userspace; these are the
5467  *	802.11 extended capabilities ("Extended Capabilities element") and are
5468  *	in the same format as in the information element. See IEEE Std
5469  *	802.11-2012 8.4.2.29 for the defined fields.
5470  * @extended_capabilities_mask: mask of the valid values
5471  * @extended_capabilities_len: length of the extended capabilities
5472  * @eml_capabilities: EML capabilities (for MLO)
5473  * @mld_capa_and_ops: MLD capabilities and operations (for MLO)
5474  */
5475 struct wiphy_iftype_ext_capab {
5476 	enum nl80211_iftype iftype;
5477 	const u8 *extended_capabilities;
5478 	const u8 *extended_capabilities_mask;
5479 	u8 extended_capabilities_len;
5480 	u16 eml_capabilities;
5481 	u16 mld_capa_and_ops;
5482 };
5483 
5484 /**
5485  * cfg80211_get_iftype_ext_capa - lookup interface type extended capability
5486  * @wiphy: the wiphy to look up from
5487  * @type: the interface type to look up
5488  *
5489  * Return: The extended capability for the given interface @type, may be %NULL
5490  */
5491 const struct wiphy_iftype_ext_capab *
5492 cfg80211_get_iftype_ext_capa(struct wiphy *wiphy, enum nl80211_iftype type);
5493 
5494 /**
5495  * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
5496  * @max_peers: maximum number of peers in a single measurement
5497  * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
5498  * @randomize_mac_addr: can randomize MAC address for measurement
5499  * @ftm: FTM measurement data
5500  * @ftm.supported: FTM measurement is supported
5501  * @ftm.asap: ASAP-mode is supported
5502  * @ftm.non_asap: non-ASAP-mode is supported
5503  * @ftm.request_lci: can request LCI data
5504  * @ftm.request_civicloc: can request civic location data
5505  * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
5506  * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
5507  * @ftm.max_bursts_exponent: maximum burst exponent supported
5508  *	(set to -1 if not limited; note that setting this will necessarily
5509  *	forbid using the value 15 to let the responder pick)
5510  * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
5511  *	not limited)
5512  * @ftm.trigger_based: trigger based ranging measurement is supported
5513  * @ftm.non_trigger_based: non trigger based ranging measurement is supported
5514  */
5515 struct cfg80211_pmsr_capabilities {
5516 	unsigned int max_peers;
5517 	u8 report_ap_tsf:1,
5518 	   randomize_mac_addr:1;
5519 
5520 	struct {
5521 		u32 preambles;
5522 		u32 bandwidths;
5523 		s8 max_bursts_exponent;
5524 		u8 max_ftms_per_burst;
5525 		u8 supported:1,
5526 		   asap:1,
5527 		   non_asap:1,
5528 		   request_lci:1,
5529 		   request_civicloc:1,
5530 		   trigger_based:1,
5531 		   non_trigger_based:1;
5532 	} ftm;
5533 };
5534 
5535 /**
5536  * struct wiphy_iftype_akm_suites - This structure encapsulates supported akm
5537  * suites for interface types defined in @iftypes_mask. Each type in the
5538  * @iftypes_mask must be unique across all instances of iftype_akm_suites.
5539  *
5540  * @iftypes_mask: bitmask of interfaces types
5541  * @akm_suites: points to an array of supported akm suites
5542  * @n_akm_suites: number of supported AKM suites
5543  */
5544 struct wiphy_iftype_akm_suites {
5545 	u16 iftypes_mask;
5546 	const u32 *akm_suites;
5547 	int n_akm_suites;
5548 };
5549 
5550 /**
5551  * struct wiphy_radio_cfg - physical radio config of a wiphy
5552  * This structure describes the configurations of a physical radio in a
5553  * wiphy. It is used to denote per-radio attributes belonging to a wiphy.
5554  *
5555  * @rts_threshold: RTS threshold (dot11RTSThreshold);
5556  *	-1 (default) = RTS/CTS disabled
5557  */
5558 struct wiphy_radio_cfg {
5559 	u32 rts_threshold;
5560 };
5561 
5562 /**
5563  * struct wiphy_radio_freq_range - wiphy frequency range
5564  * @start_freq:  start range edge frequency (kHz)
5565  * @end_freq:    end range edge frequency (kHz)
5566  */
5567 struct wiphy_radio_freq_range {
5568 	u32 start_freq;
5569 	u32 end_freq;
5570 };
5571 
5572 
5573 /**
5574  * struct wiphy_radio - physical radio of a wiphy
5575  * This structure describes a physical radio belonging to a wiphy.
5576  * It is used to describe concurrent-channel capabilities. Only one channel
5577  * can be active on the radio described by struct wiphy_radio.
5578  *
5579  * @freq_range: frequency range that the radio can operate on.
5580  * @n_freq_range: number of elements in @freq_range
5581  *
5582  * @iface_combinations: Valid interface combinations array, should not
5583  *	list single interface types.
5584  * @n_iface_combinations: number of entries in @iface_combinations array.
5585  *
5586  * @antenna_mask: bitmask of antennas connected to this radio.
5587  */
5588 struct wiphy_radio {
5589 	const struct wiphy_radio_freq_range *freq_range;
5590 	int n_freq_range;
5591 
5592 	const struct ieee80211_iface_combination *iface_combinations;
5593 	int n_iface_combinations;
5594 
5595 	u32 antenna_mask;
5596 };
5597 
5598 #define CFG80211_HW_TIMESTAMP_ALL_PEERS	0xffff
5599 
5600 /**
5601  * struct wiphy - wireless hardware description
5602  * @mtx: mutex for the data (structures) of this device
5603  * @reg_notifier: the driver's regulatory notification callback,
5604  *	note that if your driver uses wiphy_apply_custom_regulatory()
5605  *	the reg_notifier's request can be passed as NULL
5606  * @regd: the driver's regulatory domain, if one was requested via
5607  *	the regulatory_hint() API. This can be used by the driver
5608  *	on the reg_notifier() if it chooses to ignore future
5609  *	regulatory domain changes caused by other drivers.
5610  * @signal_type: signal type reported in &struct cfg80211_bss.
5611  * @cipher_suites: supported cipher suites
5612  * @n_cipher_suites: number of supported cipher suites
5613  * @akm_suites: supported AKM suites. These are the default AKMs supported if
5614  *	the supported AKMs not advertized for a specific interface type in
5615  *	iftype_akm_suites.
5616  * @n_akm_suites: number of supported AKM suites
5617  * @iftype_akm_suites: array of supported akm suites info per interface type.
5618  *	Note that the bits in @iftypes_mask inside this structure cannot
5619  *	overlap (i.e. only one occurrence of each type is allowed across all
5620  *	instances of iftype_akm_suites).
5621  * @num_iftype_akm_suites: number of interface types for which supported akm
5622  *	suites are specified separately.
5623  * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
5624  * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
5625  * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
5626  *	-1 = fragmentation disabled, only odd values >= 256 used
5627  * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
5628  * @_net: the network namespace this wiphy currently lives in
5629  * @perm_addr: permanent MAC address of this device
5630  * @addr_mask: If the device supports multiple MAC addresses by masking,
5631  *	set this to a mask with variable bits set to 1, e.g. if the last
5632  *	four bits are variable then set it to 00-00-00-00-00-0f. The actual
5633  *	variable bits shall be determined by the interfaces added, with
5634  *	interfaces not matching the mask being rejected to be brought up.
5635  * @n_addresses: number of addresses in @addresses.
5636  * @addresses: If the device has more than one address, set this pointer
5637  *	to a list of addresses (6 bytes each). The first one will be used
5638  *	by default for perm_addr. In this case, the mask should be set to
5639  *	all-zeroes. In this case it is assumed that the device can handle
5640  *	the same number of arbitrary MAC addresses.
5641  * @registered: protects ->resume and ->suspend sysfs callbacks against
5642  *	unregister hardware
5643  * @debugfsdir: debugfs directory used for this wiphy (ieee80211/<wiphyname>).
5644  *	It will be renamed automatically on wiphy renames
5645  * @dev: (virtual) struct device for this wiphy. The item in
5646  *	/sys/class/ieee80211/ points to this. You need use set_wiphy_dev()
5647  *	(see below).
5648  * @wext: wireless extension handlers
5649  * @priv: driver private data (sized according to wiphy_new() parameter)
5650  * @interface_modes: bitmask of interfaces types valid for this wiphy,
5651  *	must be set by driver
5652  * @iface_combinations: Valid interface combinations array, should not
5653  *	list single interface types.
5654  * @n_iface_combinations: number of entries in @iface_combinations array.
5655  * @software_iftypes: bitmask of software interface types, these are not
5656  *	subject to any restrictions since they are purely managed in SW.
5657  * @flags: wiphy flags, see &enum wiphy_flags
5658  * @regulatory_flags: wiphy regulatory flags, see
5659  *	&enum ieee80211_regulatory_flags
5660  * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
5661  * @ext_features: extended features advertised to nl80211, see
5662  *	&enum nl80211_ext_feature_index.
5663  * @bss_priv_size: each BSS struct has private data allocated with it,
5664  *	this variable determines its size
5665  * @max_scan_ssids: maximum number of SSIDs the device can scan for in
5666  *	any given scan
5667  * @max_sched_scan_reqs: maximum number of scheduled scan requests that
5668  *	the device can run concurrently.
5669  * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
5670  *	for in any given scheduled scan
5671  * @max_match_sets: maximum number of match sets the device can handle
5672  *	when performing a scheduled scan, 0 if filtering is not
5673  *	supported.
5674  * @max_scan_ie_len: maximum length of user-controlled IEs device can
5675  *	add to probe request frames transmitted during a scan, must not
5676  *	include fixed IEs like supported rates
5677  * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
5678  *	scans
5679  * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
5680  *	of iterations) for scheduled scan supported by the device.
5681  * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
5682  *	single scan plan supported by the device.
5683  * @max_sched_scan_plan_iterations: maximum number of iterations for a single
5684  *	scan plan supported by the device.
5685  * @coverage_class: current coverage class
5686  * @fw_version: firmware version for ethtool reporting
5687  * @hw_version: hardware version for ethtool reporting
5688  * @max_num_pmkids: maximum number of PMKIDs supported by device
5689  * @privid: a pointer that drivers can use to identify if an arbitrary
5690  *	wiphy is theirs, e.g. in global notifiers
5691  * @bands: information about bands/channels supported by this device
5692  *
5693  * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
5694  *	transmitted through nl80211, points to an array indexed by interface
5695  *	type
5696  *
5697  * @available_antennas_tx: bitmap of antennas which are available to be
5698  *	configured as TX antennas. Antenna configuration commands will be
5699  *	rejected unless this or @available_antennas_rx is set.
5700  *
5701  * @available_antennas_rx: bitmap of antennas which are available to be
5702  *	configured as RX antennas. Antenna configuration commands will be
5703  *	rejected unless this or @available_antennas_tx is set.
5704  *
5705  * @probe_resp_offload:
5706  *	 Bitmap of supported protocols for probe response offloading.
5707  *	 See &enum nl80211_probe_resp_offload_support_attr. Only valid
5708  *	 when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
5709  *
5710  * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
5711  *	may request, if implemented.
5712  *
5713  * @wowlan: WoWLAN support information
5714  * @wowlan_config: current WoWLAN configuration; this should usually not be
5715  *	used since access to it is necessarily racy, use the parameter passed
5716  *	to the suspend() operation instead.
5717  *
5718  * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
5719  * @ht_capa_mod_mask:  Specify what ht_cap values can be over-ridden.
5720  *	If null, then none can be over-ridden.
5721  * @vht_capa_mod_mask:  Specify what VHT capabilities can be over-ridden.
5722  *	If null, then none can be over-ridden.
5723  *
5724  * @wdev_list: the list of associated (virtual) interfaces; this list must
5725  *	not be modified by the driver, but can be read with RTNL/RCU protection.
5726  *
5727  * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
5728  *	supports for ACL.
5729  *
5730  * @extended_capabilities: extended capabilities supported by the driver,
5731  *	additional capabilities might be supported by userspace; these are
5732  *	the 802.11 extended capabilities ("Extended Capabilities element")
5733  *	and are in the same format as in the information element. See
5734  *	802.11-2012 8.4.2.29 for the defined fields. These are the default
5735  *	extended capabilities to be used if the capabilities are not specified
5736  *	for a specific interface type in iftype_ext_capab.
5737  * @extended_capabilities_mask: mask of the valid values
5738  * @extended_capabilities_len: length of the extended capabilities
5739  * @iftype_ext_capab: array of extended capabilities per interface type
5740  * @num_iftype_ext_capab: number of interface types for which extended
5741  *	capabilities are specified separately.
5742  * @coalesce: packet coalescing support information
5743  *
5744  * @vendor_commands: array of vendor commands supported by the hardware
5745  * @n_vendor_commands: number of vendor commands
5746  * @vendor_events: array of vendor events supported by the hardware
5747  * @n_vendor_events: number of vendor events
5748  *
5749  * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
5750  *	(including P2P GO) or 0 to indicate no such limit is advertised. The
5751  *	driver is allowed to advertise a theoretical limit that it can reach in
5752  *	some cases, but may not always reach.
5753  *
5754  * @max_num_csa_counters: Number of supported csa_counters in beacons
5755  *	and probe responses.  This value should be set if the driver
5756  *	wishes to limit the number of csa counters. Default (0) means
5757  *	infinite.
5758  * @bss_select_support: bitmask indicating the BSS selection criteria supported
5759  *	by the driver in the .connect() callback. The bit position maps to the
5760  *	attribute indices defined in &enum nl80211_bss_select_attr.
5761  *
5762  * @nan_supported_bands: bands supported by the device in NAN mode, a
5763  *	bitmap of &enum nl80211_band values.  For instance, for
5764  *	NL80211_BAND_2GHZ, bit 0 would be set
5765  *	(i.e. BIT(NL80211_BAND_2GHZ)).
5766  *
5767  * @txq_limit: configuration of internal TX queue frame limit
5768  * @txq_memory_limit: configuration internal TX queue memory limit
5769  * @txq_quantum: configuration of internal TX queue scheduler quantum
5770  *
5771  * @tx_queue_len: allow setting transmit queue len for drivers not using
5772  *	wake_tx_queue
5773  *
5774  * @support_mbssid: can HW support association with nontransmitted AP
5775  * @support_only_he_mbssid: don't parse MBSSID elements if it is not
5776  *	HE AP, in order to avoid compatibility issues.
5777  *	@support_mbssid must be set for this to have any effect.
5778  *
5779  * @pmsr_capa: peer measurement capabilities
5780  *
5781  * @tid_config_support: describes the per-TID config support that the
5782  *	device has
5783  * @tid_config_support.vif: bitmap of attributes (configurations)
5784  *	supported by the driver for each vif
5785  * @tid_config_support.peer: bitmap of attributes (configurations)
5786  *	supported by the driver for each peer
5787  * @tid_config_support.max_retry: maximum supported retry count for
5788  *	long/short retry configuration
5789  *
5790  * @max_data_retry_count: maximum supported per TID retry count for
5791  *	configuration through the %NL80211_TID_CONFIG_ATTR_RETRY_SHORT and
5792  *	%NL80211_TID_CONFIG_ATTR_RETRY_LONG attributes
5793  * @sar_capa: SAR control capabilities
5794  * @rfkill: a pointer to the rfkill structure
5795  *
5796  * @mbssid_max_interfaces: maximum number of interfaces supported by the driver
5797  *	in a multiple BSSID set. This field must be set to a non-zero value
5798  *	by the driver to advertise MBSSID support.
5799  * @ema_max_profile_periodicity: maximum profile periodicity supported by
5800  *	the driver. Setting this field to a non-zero value indicates that the
5801  *	driver supports enhanced multi-BSSID advertisements (EMA AP).
5802  * @max_num_akm_suites: maximum number of AKM suites allowed for
5803  *	configuration through %NL80211_CMD_CONNECT, %NL80211_CMD_ASSOCIATE and
5804  *	%NL80211_CMD_START_AP. Set to NL80211_MAX_NR_AKM_SUITES if not set by
5805  *	driver. If set by driver minimum allowed value is
5806  *	NL80211_MAX_NR_AKM_SUITES in order to avoid compatibility issues with
5807  *	legacy userspace and maximum allowed value is
5808  *	CFG80211_MAX_NUM_AKM_SUITES.
5809  *
5810  * @hw_timestamp_max_peers: maximum number of peers that the driver supports
5811  *	enabling HW timestamping for concurrently. Setting this field to a
5812  *	non-zero value indicates that the driver supports HW timestamping.
5813  *	A value of %CFG80211_HW_TIMESTAMP_ALL_PEERS indicates the driver
5814  *	supports enabling HW timestamping for all peers (i.e. no need to
5815  *	specify a mac address).
5816  *
5817  * @radio_cfg: configuration of radios belonging to a muli-radio wiphy. This
5818  *	struct contains a list of all radio specific attributes and should be
5819  *	used only for multi-radio wiphy.
5820  *
5821  * @radio: radios belonging to this wiphy
5822  * @n_radio: number of radios
5823  */
5824 struct wiphy {
5825 	struct mutex mtx;
5826 
5827 	/* assign these fields before you register the wiphy */
5828 
5829 	u8 perm_addr[ETH_ALEN];
5830 	u8 addr_mask[ETH_ALEN];
5831 
5832 	struct mac_address *addresses;
5833 
5834 	const struct ieee80211_txrx_stypes *mgmt_stypes;
5835 
5836 	const struct ieee80211_iface_combination *iface_combinations;
5837 	int n_iface_combinations;
5838 	u16 software_iftypes;
5839 
5840 	u16 n_addresses;
5841 
5842 	/* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
5843 	u16 interface_modes;
5844 
5845 	u16 max_acl_mac_addrs;
5846 
5847 	u32 flags, regulatory_flags, features;
5848 	u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
5849 
5850 	u32 ap_sme_capa;
5851 
5852 	enum cfg80211_signal_type signal_type;
5853 
5854 	int bss_priv_size;
5855 	u8 max_scan_ssids;
5856 	u8 max_sched_scan_reqs;
5857 	u8 max_sched_scan_ssids;
5858 	u8 max_match_sets;
5859 	u16 max_scan_ie_len;
5860 	u16 max_sched_scan_ie_len;
5861 	u32 max_sched_scan_plans;
5862 	u32 max_sched_scan_plan_interval;
5863 	u32 max_sched_scan_plan_iterations;
5864 
5865 	int n_cipher_suites;
5866 	const u32 *cipher_suites;
5867 
5868 	int n_akm_suites;
5869 	const u32 *akm_suites;
5870 
5871 	const struct wiphy_iftype_akm_suites *iftype_akm_suites;
5872 	unsigned int num_iftype_akm_suites;
5873 
5874 	u8 retry_short;
5875 	u8 retry_long;
5876 	u32 frag_threshold;
5877 	u32 rts_threshold;
5878 	u8 coverage_class;
5879 
5880 	char fw_version[ETHTOOL_FWVERS_LEN];
5881 	u32 hw_version;
5882 
5883 #ifdef CONFIG_PM
5884 	const struct wiphy_wowlan_support *wowlan;
5885 	struct cfg80211_wowlan *wowlan_config;
5886 #endif
5887 
5888 	u16 max_remain_on_channel_duration;
5889 
5890 	u8 max_num_pmkids;
5891 
5892 	u32 available_antennas_tx;
5893 	u32 available_antennas_rx;
5894 
5895 	u32 probe_resp_offload;
5896 
5897 	const u8 *extended_capabilities, *extended_capabilities_mask;
5898 	u8 extended_capabilities_len;
5899 
5900 	const struct wiphy_iftype_ext_capab *iftype_ext_capab;
5901 	unsigned int num_iftype_ext_capab;
5902 
5903 	const void *privid;
5904 
5905 	struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
5906 
5907 	void (*reg_notifier)(struct wiphy *wiphy,
5908 			     struct regulatory_request *request);
5909 
5910 	struct wiphy_radio_cfg *radio_cfg;
5911 
5912 	/* fields below are read-only, assigned by cfg80211 */
5913 
5914 	const struct ieee80211_regdomain __rcu *regd;
5915 
5916 	struct device dev;
5917 
5918 	bool registered;
5919 
5920 	struct dentry *debugfsdir;
5921 
5922 	const struct ieee80211_ht_cap *ht_capa_mod_mask;
5923 	const struct ieee80211_vht_cap *vht_capa_mod_mask;
5924 
5925 	struct list_head wdev_list;
5926 
5927 	possible_net_t _net;
5928 
5929 #ifdef CONFIG_CFG80211_WEXT
5930 	const struct iw_handler_def *wext;
5931 #endif
5932 
5933 	const struct wiphy_coalesce_support *coalesce;
5934 
5935 	const struct wiphy_vendor_command *vendor_commands;
5936 	const struct nl80211_vendor_cmd_info *vendor_events;
5937 	int n_vendor_commands, n_vendor_events;
5938 
5939 	u16 max_ap_assoc_sta;
5940 
5941 	u8 max_num_csa_counters;
5942 
5943 	u32 bss_select_support;
5944 
5945 	u8 nan_supported_bands;
5946 
5947 	u32 txq_limit;
5948 	u32 txq_memory_limit;
5949 	u32 txq_quantum;
5950 
5951 	unsigned long tx_queue_len;
5952 
5953 	u8 support_mbssid:1,
5954 	   support_only_he_mbssid:1;
5955 
5956 	const struct cfg80211_pmsr_capabilities *pmsr_capa;
5957 
5958 	struct {
5959 		u64 peer, vif;
5960 		u8 max_retry;
5961 	} tid_config_support;
5962 
5963 	u8 max_data_retry_count;
5964 
5965 	const struct cfg80211_sar_capa *sar_capa;
5966 
5967 	struct rfkill *rfkill;
5968 
5969 	u8 mbssid_max_interfaces;
5970 	u8 ema_max_profile_periodicity;
5971 	u16 max_num_akm_suites;
5972 
5973 	u16 hw_timestamp_max_peers;
5974 
5975 	int n_radio;
5976 	const struct wiphy_radio *radio;
5977 
5978 	char priv[] __aligned(NETDEV_ALIGN);
5979 };
5980 
5981 static inline struct net *wiphy_net(struct wiphy *wiphy)
5982 {
5983 	return read_pnet(&wiphy->_net);
5984 }
5985 
5986 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
5987 {
5988 	write_pnet(&wiphy->_net, net);
5989 }
5990 
5991 /**
5992  * wiphy_priv - return priv from wiphy
5993  *
5994  * @wiphy: the wiphy whose priv pointer to return
5995  * Return: The priv of @wiphy.
5996  */
5997 static inline void *wiphy_priv(struct wiphy *wiphy)
5998 {
5999 	BUG_ON(!wiphy);
6000 	return &wiphy->priv;
6001 }
6002 
6003 /**
6004  * priv_to_wiphy - return the wiphy containing the priv
6005  *
6006  * @priv: a pointer previously returned by wiphy_priv
6007  * Return: The wiphy of @priv.
6008  */
6009 static inline struct wiphy *priv_to_wiphy(void *priv)
6010 {
6011 	BUG_ON(!priv);
6012 	return container_of(priv, struct wiphy, priv);
6013 }
6014 
6015 /**
6016  * set_wiphy_dev - set device pointer for wiphy
6017  *
6018  * @wiphy: The wiphy whose device to bind
6019  * @dev: The device to parent it to
6020  */
6021 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
6022 {
6023 	wiphy->dev.parent = dev;
6024 }
6025 
6026 /**
6027  * wiphy_dev - get wiphy dev pointer
6028  *
6029  * @wiphy: The wiphy whose device struct to look up
6030  * Return: The dev of @wiphy.
6031  */
6032 static inline struct device *wiphy_dev(struct wiphy *wiphy)
6033 {
6034 	return wiphy->dev.parent;
6035 }
6036 
6037 /**
6038  * wiphy_name - get wiphy name
6039  *
6040  * @wiphy: The wiphy whose name to return
6041  * Return: The name of @wiphy.
6042  */
6043 static inline const char *wiphy_name(const struct wiphy *wiphy)
6044 {
6045 	return dev_name(&wiphy->dev);
6046 }
6047 
6048 /**
6049  * wiphy_new_nm - create a new wiphy for use with cfg80211
6050  *
6051  * @ops: The configuration operations for this device
6052  * @sizeof_priv: The size of the private area to allocate
6053  * @requested_name: Request a particular name.
6054  *	NULL is valid value, and means use the default phy%d naming.
6055  *
6056  * Create a new wiphy and associate the given operations with it.
6057  * @sizeof_priv bytes are allocated for private use.
6058  *
6059  * Return: A pointer to the new wiphy. This pointer must be
6060  * assigned to each netdev's ieee80211_ptr for proper operation.
6061  */
6062 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
6063 			   const char *requested_name);
6064 
6065 /**
6066  * wiphy_new - create a new wiphy for use with cfg80211
6067  *
6068  * @ops: The configuration operations for this device
6069  * @sizeof_priv: The size of the private area to allocate
6070  *
6071  * Create a new wiphy and associate the given operations with it.
6072  * @sizeof_priv bytes are allocated for private use.
6073  *
6074  * Return: A pointer to the new wiphy. This pointer must be
6075  * assigned to each netdev's ieee80211_ptr for proper operation.
6076  */
6077 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
6078 				      int sizeof_priv)
6079 {
6080 	return wiphy_new_nm(ops, sizeof_priv, NULL);
6081 }
6082 
6083 /**
6084  * wiphy_register - register a wiphy with cfg80211
6085  *
6086  * @wiphy: The wiphy to register.
6087  *
6088  * Return: A non-negative wiphy index or a negative error code.
6089  */
6090 int wiphy_register(struct wiphy *wiphy);
6091 
6092 /* this is a define for better error reporting (file/line) */
6093 #define lockdep_assert_wiphy(wiphy) lockdep_assert_held(&(wiphy)->mtx)
6094 
6095 /**
6096  * rcu_dereference_wiphy - rcu_dereference with debug checking
6097  * @wiphy: the wiphy to check the locking on
6098  * @p: The pointer to read, prior to dereferencing
6099  *
6100  * Do an rcu_dereference(p), but check caller either holds rcu_read_lock()
6101  * or RTNL. Note: Please prefer wiphy_dereference() or rcu_dereference().
6102  */
6103 #define rcu_dereference_wiphy(wiphy, p)				\
6104         rcu_dereference_check(p, lockdep_is_held(&wiphy->mtx))
6105 
6106 /**
6107  * wiphy_dereference - fetch RCU pointer when updates are prevented by wiphy mtx
6108  * @wiphy: the wiphy to check the locking on
6109  * @p: The pointer to read, prior to dereferencing
6110  *
6111  * Return: the value of the specified RCU-protected pointer, but omit the
6112  * READ_ONCE(), because caller holds the wiphy mutex used for updates.
6113  */
6114 #define wiphy_dereference(wiphy, p)				\
6115         rcu_dereference_protected(p, lockdep_is_held(&wiphy->mtx))
6116 
6117 /**
6118  * get_wiphy_regdom - get custom regdomain for the given wiphy
6119  * @wiphy: the wiphy to get the regdomain from
6120  *
6121  * Context: Requires any of RTNL, wiphy mutex or RCU protection.
6122  *
6123  * Return: pointer to the regulatory domain associated with the wiphy
6124  */
6125 const struct ieee80211_regdomain *get_wiphy_regdom(struct wiphy *wiphy);
6126 
6127 /**
6128  * wiphy_unregister - deregister a wiphy from cfg80211
6129  *
6130  * @wiphy: The wiphy to unregister.
6131  *
6132  * After this call, no more requests can be made with this priv
6133  * pointer, but the call may sleep to wait for an outstanding
6134  * request that is being handled.
6135  */
6136 void wiphy_unregister(struct wiphy *wiphy);
6137 
6138 /**
6139  * wiphy_free - free wiphy
6140  *
6141  * @wiphy: The wiphy to free
6142  */
6143 void wiphy_free(struct wiphy *wiphy);
6144 
6145 /* internal structs */
6146 struct cfg80211_conn;
6147 struct cfg80211_internal_bss;
6148 struct cfg80211_cached_keys;
6149 struct cfg80211_cqm_config;
6150 
6151 /**
6152  * wiphy_lock - lock the wiphy
6153  * @wiphy: the wiphy to lock
6154  *
6155  * This is needed around registering and unregistering netdevs that
6156  * aren't created through cfg80211 calls, since that requires locking
6157  * in cfg80211 when the notifiers is called, but that cannot
6158  * differentiate which way it's called.
6159  *
6160  * It can also be used by drivers for their own purposes.
6161  *
6162  * When cfg80211 ops are called, the wiphy is already locked.
6163  *
6164  * Note that this makes sure that no workers that have been queued
6165  * with wiphy_queue_work() are running.
6166  */
6167 static inline void wiphy_lock(struct wiphy *wiphy)
6168 	__acquires(&wiphy->mtx)
6169 {
6170 	mutex_lock(&wiphy->mtx);
6171 	__acquire(&wiphy->mtx);
6172 }
6173 
6174 /**
6175  * wiphy_unlock - unlock the wiphy again
6176  * @wiphy: the wiphy to unlock
6177  */
6178 static inline void wiphy_unlock(struct wiphy *wiphy)
6179 	__releases(&wiphy->mtx)
6180 {
6181 	__release(&wiphy->mtx);
6182 	mutex_unlock(&wiphy->mtx);
6183 }
6184 
6185 DEFINE_GUARD(wiphy, struct wiphy *,
6186 	     mutex_lock(&_T->mtx),
6187 	     mutex_unlock(&_T->mtx))
6188 
6189 struct wiphy_work;
6190 typedef void (*wiphy_work_func_t)(struct wiphy *, struct wiphy_work *);
6191 
6192 struct wiphy_work {
6193 	struct list_head entry;
6194 	wiphy_work_func_t func;
6195 };
6196 
6197 static inline void wiphy_work_init(struct wiphy_work *work,
6198 				   wiphy_work_func_t func)
6199 {
6200 	INIT_LIST_HEAD(&work->entry);
6201 	work->func = func;
6202 }
6203 
6204 /**
6205  * wiphy_work_queue - queue work for the wiphy
6206  * @wiphy: the wiphy to queue for
6207  * @work: the work item
6208  *
6209  * This is useful for work that must be done asynchronously, and work
6210  * queued here has the special property that the wiphy mutex will be
6211  * held as if wiphy_lock() was called, and that it cannot be running
6212  * after wiphy_lock() was called. Therefore, wiphy_cancel_work() can
6213  * use just cancel_work() instead of cancel_work_sync(), it requires
6214  * being in a section protected by wiphy_lock().
6215  */
6216 void wiphy_work_queue(struct wiphy *wiphy, struct wiphy_work *work);
6217 
6218 /**
6219  * wiphy_work_cancel - cancel previously queued work
6220  * @wiphy: the wiphy, for debug purposes
6221  * @work: the work to cancel
6222  *
6223  * Cancel the work *without* waiting for it, this assumes being
6224  * called under the wiphy mutex acquired by wiphy_lock().
6225  */
6226 void wiphy_work_cancel(struct wiphy *wiphy, struct wiphy_work *work);
6227 
6228 /**
6229  * wiphy_work_flush - flush previously queued work
6230  * @wiphy: the wiphy, for debug purposes
6231  * @work: the work to flush, this can be %NULL to flush all work
6232  *
6233  * Flush the work (i.e. run it if pending). This must be called
6234  * under the wiphy mutex acquired by wiphy_lock().
6235  */
6236 void wiphy_work_flush(struct wiphy *wiphy, struct wiphy_work *work);
6237 
6238 struct wiphy_delayed_work {
6239 	struct wiphy_work work;
6240 	struct wiphy *wiphy;
6241 	struct timer_list timer;
6242 };
6243 
6244 void wiphy_delayed_work_timer(struct timer_list *t);
6245 
6246 static inline void wiphy_delayed_work_init(struct wiphy_delayed_work *dwork,
6247 					   wiphy_work_func_t func)
6248 {
6249 	timer_setup(&dwork->timer, wiphy_delayed_work_timer, 0);
6250 	wiphy_work_init(&dwork->work, func);
6251 }
6252 
6253 /**
6254  * wiphy_delayed_work_queue - queue delayed work for the wiphy
6255  * @wiphy: the wiphy to queue for
6256  * @dwork: the delayable worker
6257  * @delay: number of jiffies to wait before queueing
6258  *
6259  * This is useful for work that must be done asynchronously, and work
6260  * queued here has the special property that the wiphy mutex will be
6261  * held as if wiphy_lock() was called, and that it cannot be running
6262  * after wiphy_lock() was called. Therefore, wiphy_cancel_work() can
6263  * use just cancel_work() instead of cancel_work_sync(), it requires
6264  * being in a section protected by wiphy_lock().
6265  */
6266 void wiphy_delayed_work_queue(struct wiphy *wiphy,
6267 			      struct wiphy_delayed_work *dwork,
6268 			      unsigned long delay);
6269 
6270 /**
6271  * wiphy_delayed_work_cancel - cancel previously queued delayed work
6272  * @wiphy: the wiphy, for debug purposes
6273  * @dwork: the delayed work to cancel
6274  *
6275  * Cancel the work *without* waiting for it, this assumes being
6276  * called under the wiphy mutex acquired by wiphy_lock().
6277  */
6278 void wiphy_delayed_work_cancel(struct wiphy *wiphy,
6279 			       struct wiphy_delayed_work *dwork);
6280 
6281 /**
6282  * wiphy_delayed_work_flush - flush previously queued delayed work
6283  * @wiphy: the wiphy, for debug purposes
6284  * @dwork: the delayed work to flush
6285  *
6286  * Flush the work (i.e. run it if pending). This must be called
6287  * under the wiphy mutex acquired by wiphy_lock().
6288  */
6289 void wiphy_delayed_work_flush(struct wiphy *wiphy,
6290 			      struct wiphy_delayed_work *dwork);
6291 
6292 /**
6293  * wiphy_delayed_work_pending - Find out whether a wiphy delayable
6294  * work item is currently pending.
6295  *
6296  * @wiphy: the wiphy, for debug purposes
6297  * @dwork: the delayed work in question
6298  *
6299  * Return: true if timer is pending, false otherwise
6300  *
6301  * How wiphy_delayed_work_queue() works is by setting a timer which
6302  * when it expires calls wiphy_work_queue() to queue the wiphy work.
6303  * Because wiphy_delayed_work_queue() uses mod_timer(), if it is
6304  * called twice and the second call happens before the first call
6305  * deadline, the work will rescheduled for the second deadline and
6306  * won't run before that.
6307  *
6308  * wiphy_delayed_work_pending() can be used to detect if calling
6309  * wiphy_work_delayed_work_queue() would start a new work schedule
6310  * or delayed a previous one. As seen below it cannot be used to
6311  * detect precisely if the work has finished to execute nor if it
6312  * is currently executing.
6313  *
6314  *      CPU0                                CPU1
6315  * wiphy_delayed_work_queue(wk)
6316  *  mod_timer(wk->timer)
6317  *                                     wiphy_delayed_work_pending(wk) -> true
6318  *
6319  * [...]
6320  * expire_timers(wk->timer)
6321  *  detach_timer(wk->timer)
6322  *                                     wiphy_delayed_work_pending(wk) -> false
6323  *  wk->timer->function()                          |
6324  *   wiphy_work_queue(wk)                          | delayed work pending
6325  *    list_add_tail()                              | returns false but
6326  *    queue_work(cfg80211_wiphy_work)              | wk->func() has not
6327  *                                                 | been run yet
6328  * [...]                                           |
6329  *  cfg80211_wiphy_work()                          |
6330  *   wk->func()                                    V
6331  *
6332  */
6333 bool wiphy_delayed_work_pending(struct wiphy *wiphy,
6334 				struct wiphy_delayed_work *dwork);
6335 
6336 /**
6337  * enum ieee80211_ap_reg_power - regulatory power for an Access Point
6338  *
6339  * @IEEE80211_REG_UNSET_AP: Access Point has no regulatory power mode
6340  * @IEEE80211_REG_LPI_AP: Indoor Access Point
6341  * @IEEE80211_REG_SP_AP: Standard power Access Point
6342  * @IEEE80211_REG_VLP_AP: Very low power Access Point
6343  */
6344 enum ieee80211_ap_reg_power {
6345 	IEEE80211_REG_UNSET_AP,
6346 	IEEE80211_REG_LPI_AP,
6347 	IEEE80211_REG_SP_AP,
6348 	IEEE80211_REG_VLP_AP,
6349 };
6350 
6351 /**
6352  * struct wireless_dev - wireless device state
6353  *
6354  * For netdevs, this structure must be allocated by the driver
6355  * that uses the ieee80211_ptr field in struct net_device (this
6356  * is intentional so it can be allocated along with the netdev.)
6357  * It need not be registered then as netdev registration will
6358  * be intercepted by cfg80211 to see the new wireless device,
6359  * however, drivers must lock the wiphy before registering or
6360  * unregistering netdevs if they pre-create any netdevs (in ops
6361  * called from cfg80211, the wiphy is already locked.)
6362  *
6363  * For non-netdev uses, it must also be allocated by the driver
6364  * in response to the cfg80211 callbacks that require it, as
6365  * there's no netdev registration in that case it may not be
6366  * allocated outside of callback operations that return it.
6367  *
6368  * @wiphy: pointer to hardware description
6369  * @iftype: interface type
6370  * @registered: is this wdev already registered with cfg80211
6371  * @registering: indicates we're doing registration under wiphy lock
6372  *	for the notifier
6373  * @list: (private) Used to collect the interfaces
6374  * @netdev: (private) Used to reference back to the netdev, may be %NULL
6375  * @identifier: (private) Identifier used in nl80211 to identify this
6376  *	wireless device if it has no netdev
6377  * @u: union containing data specific to @iftype
6378  * @connected: indicates if connected or not (STA mode)
6379  * @wext: (private) Used by the internal wireless extensions compat code
6380  * @wext.ibss: (private) IBSS data part of wext handling
6381  * @wext.connect: (private) connection handling data
6382  * @wext.keys: (private) (WEP) key data
6383  * @wext.ie: (private) extra elements for association
6384  * @wext.ie_len: (private) length of extra elements
6385  * @wext.bssid: (private) selected network BSSID
6386  * @wext.ssid: (private) selected network SSID
6387  * @wext.default_key: (private) selected default key index
6388  * @wext.default_mgmt_key: (private) selected default management key index
6389  * @wext.prev_bssid: (private) previous BSSID for reassociation
6390  * @wext.prev_bssid_valid: (private) previous BSSID validity
6391  * @use_4addr: indicates 4addr mode is used on this interface, must be
6392  *	set by driver (if supported) on add_interface BEFORE registering the
6393  *	netdev and may otherwise be used by driver read-only, will be update
6394  *	by cfg80211 on change_interface
6395  * @mgmt_registrations: list of registrations for management frames
6396  * @mgmt_registrations_need_update: mgmt registrations were updated,
6397  *	need to propagate the update to the driver
6398  * @address: The address for this device, valid only if @netdev is %NULL
6399  * @is_running: true if this is a non-netdev device that has been started, e.g.
6400  *	the P2P Device.
6401  * @ps: powersave mode is enabled
6402  * @ps_timeout: dynamic powersave timeout
6403  * @ap_unexpected_nlportid: (private) netlink port ID of application
6404  *	registered for unexpected class 3 frames (AP mode)
6405  * @conn: (private) cfg80211 software SME connection state machine data
6406  * @connect_keys: (private) keys to set after connection is established
6407  * @conn_bss_type: connecting/connected BSS type
6408  * @conn_owner_nlportid: (private) connection owner socket port ID
6409  * @disconnect_wk: (private) auto-disconnect work
6410  * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
6411  * @event_list: (private) list for internal event processing
6412  * @event_lock: (private) lock for event list
6413  * @owner_nlportid: (private) owner socket port ID
6414  * @nl_owner_dead: (private) owner socket went away
6415  * @cqm_rssi_work: (private) CQM RSSI reporting work
6416  * @cqm_config: (private) nl80211 RSSI monitor state
6417  * @pmsr_list: (private) peer measurement requests
6418  * @pmsr_lock: (private) peer measurements requests/results lock
6419  * @pmsr_free_wk: (private) peer measurements cleanup work
6420  * @unprot_beacon_reported: (private) timestamp of last
6421  *	unprotected beacon report
6422  * @links: array of %IEEE80211_MLD_MAX_NUM_LINKS elements containing @addr
6423  *	@ap and @client for each link
6424  * @links.cac_started: true if DFS channel availability check has been
6425  *	started
6426  * @links.cac_start_time: timestamp (jiffies) when the dfs state was
6427  *	entered.
6428  * @links.cac_time_ms: CAC time in ms
6429  * @valid_links: bitmap describing what elements of @links are valid
6430  * @radio_mask: Bitmask of radios that this interface is allowed to operate on.
6431  */
6432 struct wireless_dev {
6433 	struct wiphy *wiphy;
6434 	enum nl80211_iftype iftype;
6435 
6436 	/* the remainder of this struct should be private to cfg80211 */
6437 	struct list_head list;
6438 	struct net_device *netdev;
6439 
6440 	u32 identifier;
6441 
6442 	struct list_head mgmt_registrations;
6443 	u8 mgmt_registrations_need_update:1;
6444 
6445 	bool use_4addr, is_running, registered, registering;
6446 
6447 	u8 address[ETH_ALEN] __aligned(sizeof(u16));
6448 
6449 	/* currently used for IBSS and SME - might be rearranged later */
6450 	struct cfg80211_conn *conn;
6451 	struct cfg80211_cached_keys *connect_keys;
6452 	enum ieee80211_bss_type conn_bss_type;
6453 	u32 conn_owner_nlportid;
6454 
6455 	struct work_struct disconnect_wk;
6456 	u8 disconnect_bssid[ETH_ALEN];
6457 
6458 	struct list_head event_list;
6459 	spinlock_t event_lock;
6460 
6461 	u8 connected:1;
6462 
6463 	bool ps;
6464 	int ps_timeout;
6465 
6466 	u32 ap_unexpected_nlportid;
6467 
6468 	u32 owner_nlportid;
6469 	bool nl_owner_dead;
6470 
6471 #ifdef CONFIG_CFG80211_WEXT
6472 	/* wext data */
6473 	struct {
6474 		struct cfg80211_ibss_params ibss;
6475 		struct cfg80211_connect_params connect;
6476 		struct cfg80211_cached_keys *keys;
6477 		const u8 *ie;
6478 		size_t ie_len;
6479 		u8 bssid[ETH_ALEN];
6480 		u8 prev_bssid[ETH_ALEN];
6481 		u8 ssid[IEEE80211_MAX_SSID_LEN];
6482 		s8 default_key, default_mgmt_key;
6483 		bool prev_bssid_valid;
6484 	} wext;
6485 #endif
6486 
6487 	struct wiphy_work cqm_rssi_work;
6488 	struct cfg80211_cqm_config __rcu *cqm_config;
6489 
6490 	struct list_head pmsr_list;
6491 	spinlock_t pmsr_lock;
6492 	struct work_struct pmsr_free_wk;
6493 
6494 	unsigned long unprot_beacon_reported;
6495 
6496 	union {
6497 		struct {
6498 			u8 connected_addr[ETH_ALEN] __aligned(2);
6499 			u8 ssid[IEEE80211_MAX_SSID_LEN];
6500 			u8 ssid_len;
6501 		} client;
6502 		struct {
6503 			int beacon_interval;
6504 			struct cfg80211_chan_def preset_chandef;
6505 			struct cfg80211_chan_def chandef;
6506 			u8 id[IEEE80211_MAX_MESH_ID_LEN];
6507 			u8 id_len, id_up_len;
6508 		} mesh;
6509 		struct {
6510 			struct cfg80211_chan_def preset_chandef;
6511 			u8 ssid[IEEE80211_MAX_SSID_LEN];
6512 			u8 ssid_len;
6513 		} ap;
6514 		struct {
6515 			struct cfg80211_internal_bss *current_bss;
6516 			struct cfg80211_chan_def chandef;
6517 			int beacon_interval;
6518 			u8 ssid[IEEE80211_MAX_SSID_LEN];
6519 			u8 ssid_len;
6520 		} ibss;
6521 		struct {
6522 			struct cfg80211_chan_def chandef;
6523 		} ocb;
6524 	} u;
6525 
6526 	struct {
6527 		u8 addr[ETH_ALEN] __aligned(2);
6528 		union {
6529 			struct {
6530 				unsigned int beacon_interval;
6531 				struct cfg80211_chan_def chandef;
6532 			} ap;
6533 			struct {
6534 				struct cfg80211_internal_bss *current_bss;
6535 			} client;
6536 		};
6537 
6538 		bool cac_started;
6539 		unsigned long cac_start_time;
6540 		unsigned int cac_time_ms;
6541 	} links[IEEE80211_MLD_MAX_NUM_LINKS];
6542 	u16 valid_links;
6543 
6544 	u32 radio_mask;
6545 };
6546 
6547 static inline const u8 *wdev_address(struct wireless_dev *wdev)
6548 {
6549 	if (wdev->netdev)
6550 		return wdev->netdev->dev_addr;
6551 	return wdev->address;
6552 }
6553 
6554 static inline bool wdev_running(struct wireless_dev *wdev)
6555 {
6556 	if (wdev->netdev)
6557 		return netif_running(wdev->netdev);
6558 	return wdev->is_running;
6559 }
6560 
6561 /**
6562  * wdev_priv - return wiphy priv from wireless_dev
6563  *
6564  * @wdev: The wireless device whose wiphy's priv pointer to return
6565  * Return: The wiphy priv of @wdev.
6566  */
6567 static inline void *wdev_priv(struct wireless_dev *wdev)
6568 {
6569 	BUG_ON(!wdev);
6570 	return wiphy_priv(wdev->wiphy);
6571 }
6572 
6573 /**
6574  * wdev_chandef - return chandef pointer from wireless_dev
6575  * @wdev: the wdev
6576  * @link_id: the link ID for MLO
6577  *
6578  * Return: The chandef depending on the mode, or %NULL.
6579  */
6580 struct cfg80211_chan_def *wdev_chandef(struct wireless_dev *wdev,
6581 				       unsigned int link_id);
6582 
6583 static inline void WARN_INVALID_LINK_ID(struct wireless_dev *wdev,
6584 					unsigned int link_id)
6585 {
6586 	WARN_ON(link_id && !wdev->valid_links);
6587 	WARN_ON(wdev->valid_links &&
6588 		!(wdev->valid_links & BIT(link_id)));
6589 }
6590 
6591 #define for_each_valid_link(link_info, link_id)			\
6592 	for (link_id = 0;					\
6593 	     link_id < ((link_info)->valid_links ?		\
6594 			ARRAY_SIZE((link_info)->links) : 1);	\
6595 	     link_id++)						\
6596 		if (!(link_info)->valid_links ||		\
6597 		    ((link_info)->valid_links & BIT(link_id)))
6598 
6599 /**
6600  * DOC: Utility functions
6601  *
6602  * cfg80211 offers a number of utility functions that can be useful.
6603  */
6604 
6605 /**
6606  * ieee80211_channel_equal - compare two struct ieee80211_channel
6607  *
6608  * @a: 1st struct ieee80211_channel
6609  * @b: 2nd struct ieee80211_channel
6610  * Return: true if center frequency of @a == @b
6611  */
6612 static inline bool
6613 ieee80211_channel_equal(struct ieee80211_channel *a,
6614 			struct ieee80211_channel *b)
6615 {
6616 	return (a->center_freq == b->center_freq &&
6617 		a->freq_offset == b->freq_offset);
6618 }
6619 
6620 /**
6621  * ieee80211_channel_to_khz - convert ieee80211_channel to frequency in KHz
6622  * @chan: struct ieee80211_channel to convert
6623  * Return: The corresponding frequency (in KHz)
6624  */
6625 static inline u32
6626 ieee80211_channel_to_khz(const struct ieee80211_channel *chan)
6627 {
6628 	return MHZ_TO_KHZ(chan->center_freq) + chan->freq_offset;
6629 }
6630 
6631 /**
6632  * ieee80211_s1g_channel_width - get allowed channel width from @chan
6633  *
6634  * Only allowed for band NL80211_BAND_S1GHZ
6635  * @chan: channel
6636  * Return: The allowed channel width for this center_freq
6637  */
6638 enum nl80211_chan_width
6639 ieee80211_s1g_channel_width(const struct ieee80211_channel *chan);
6640 
6641 /**
6642  * ieee80211_channel_to_freq_khz - convert channel number to frequency
6643  * @chan: channel number
6644  * @band: band, necessary due to channel number overlap
6645  * Return: The corresponding frequency (in KHz), or 0 if the conversion failed.
6646  */
6647 u32 ieee80211_channel_to_freq_khz(int chan, enum nl80211_band band);
6648 
6649 /**
6650  * ieee80211_channel_to_frequency - convert channel number to frequency
6651  * @chan: channel number
6652  * @band: band, necessary due to channel number overlap
6653  * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
6654  */
6655 static inline int
6656 ieee80211_channel_to_frequency(int chan, enum nl80211_band band)
6657 {
6658 	return KHZ_TO_MHZ(ieee80211_channel_to_freq_khz(chan, band));
6659 }
6660 
6661 /**
6662  * ieee80211_freq_khz_to_channel - convert frequency to channel number
6663  * @freq: center frequency in KHz
6664  * Return: The corresponding channel, or 0 if the conversion failed.
6665  */
6666 int ieee80211_freq_khz_to_channel(u32 freq);
6667 
6668 /**
6669  * ieee80211_frequency_to_channel - convert frequency to channel number
6670  * @freq: center frequency in MHz
6671  * Return: The corresponding channel, or 0 if the conversion failed.
6672  */
6673 static inline int
6674 ieee80211_frequency_to_channel(int freq)
6675 {
6676 	return ieee80211_freq_khz_to_channel(MHZ_TO_KHZ(freq));
6677 }
6678 
6679 /**
6680  * ieee80211_get_channel_khz - get channel struct from wiphy for specified
6681  * frequency
6682  * @wiphy: the struct wiphy to get the channel for
6683  * @freq: the center frequency (in KHz) of the channel
6684  * Return: The channel struct from @wiphy at @freq.
6685  */
6686 struct ieee80211_channel *
6687 ieee80211_get_channel_khz(struct wiphy *wiphy, u32 freq);
6688 
6689 /**
6690  * ieee80211_get_channel - get channel struct from wiphy for specified frequency
6691  *
6692  * @wiphy: the struct wiphy to get the channel for
6693  * @freq: the center frequency (in MHz) of the channel
6694  * Return: The channel struct from @wiphy at @freq.
6695  */
6696 static inline struct ieee80211_channel *
6697 ieee80211_get_channel(struct wiphy *wiphy, int freq)
6698 {
6699 	return ieee80211_get_channel_khz(wiphy, MHZ_TO_KHZ(freq));
6700 }
6701 
6702 /**
6703  * cfg80211_channel_is_psc - Check if the channel is a 6 GHz PSC
6704  * @chan: control channel to check
6705  *
6706  * The Preferred Scanning Channels (PSC) are defined in
6707  * Draft IEEE P802.11ax/D5.0, 26.17.2.3.3
6708  *
6709  * Return: %true if channel is a PSC, %false otherwise
6710  */
6711 static inline bool cfg80211_channel_is_psc(struct ieee80211_channel *chan)
6712 {
6713 	if (chan->band != NL80211_BAND_6GHZ)
6714 		return false;
6715 
6716 	return ieee80211_frequency_to_channel(chan->center_freq) % 16 == 5;
6717 }
6718 
6719 /**
6720  * cfg80211_radio_chandef_valid - Check if the radio supports the chandef
6721  *
6722  * @radio: wiphy radio
6723  * @chandef: chandef for current channel
6724  *
6725  * Return: whether or not the given chandef is valid for the given radio
6726  */
6727 bool cfg80211_radio_chandef_valid(const struct wiphy_radio *radio,
6728 				  const struct cfg80211_chan_def *chandef);
6729 
6730 /**
6731  * cfg80211_wdev_channel_allowed - Check if the wdev may use the channel
6732  *
6733  * @wdev: the wireless device
6734  * @chan: channel to check
6735  *
6736  * Return: whether or not the wdev may use the channel
6737  */
6738 bool cfg80211_wdev_channel_allowed(struct wireless_dev *wdev,
6739 				   struct ieee80211_channel *chan);
6740 
6741 /**
6742  * ieee80211_get_response_rate - get basic rate for a given rate
6743  *
6744  * @sband: the band to look for rates in
6745  * @basic_rates: bitmap of basic rates
6746  * @bitrate: the bitrate for which to find the basic rate
6747  *
6748  * Return: The basic rate corresponding to a given bitrate, that
6749  * is the next lower bitrate contained in the basic rate map,
6750  * which is, for this function, given as a bitmap of indices of
6751  * rates in the band's bitrate table.
6752  */
6753 const struct ieee80211_rate *
6754 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
6755 			    u32 basic_rates, int bitrate);
6756 
6757 /**
6758  * ieee80211_mandatory_rates - get mandatory rates for a given band
6759  * @sband: the band to look for rates in
6760  *
6761  * Return: a bitmap of the mandatory rates for the given band, bits
6762  * are set according to the rate position in the bitrates array.
6763  */
6764 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband);
6765 
6766 /*
6767  * Radiotap parsing functions -- for controlled injection support
6768  *
6769  * Implemented in net/wireless/radiotap.c
6770  * Documentation in Documentation/networking/radiotap-headers.rst
6771  */
6772 
6773 struct radiotap_align_size {
6774 	uint8_t align:4, size:4;
6775 };
6776 
6777 struct ieee80211_radiotap_namespace {
6778 	const struct radiotap_align_size *align_size;
6779 	int n_bits;
6780 	uint32_t oui;
6781 	uint8_t subns;
6782 };
6783 
6784 struct ieee80211_radiotap_vendor_namespaces {
6785 	const struct ieee80211_radiotap_namespace *ns;
6786 	int n_ns;
6787 };
6788 
6789 /**
6790  * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
6791  * @this_arg_index: index of current arg, valid after each successful call
6792  *	to ieee80211_radiotap_iterator_next()
6793  * @this_arg: pointer to current radiotap arg; it is valid after each
6794  *	call to ieee80211_radiotap_iterator_next() but also after
6795  *	ieee80211_radiotap_iterator_init() where it will point to
6796  *	the beginning of the actual data portion
6797  * @this_arg_size: length of the current arg, for convenience
6798  * @current_namespace: pointer to the current namespace definition
6799  *	(or internally %NULL if the current namespace is unknown)
6800  * @is_radiotap_ns: indicates whether the current namespace is the default
6801  *	radiotap namespace or not
6802  *
6803  * @_rtheader: pointer to the radiotap header we are walking through
6804  * @_max_length: length of radiotap header in cpu byte ordering
6805  * @_arg_index: next argument index
6806  * @_arg: next argument pointer
6807  * @_next_bitmap: internal pointer to next present u32
6808  * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
6809  * @_vns: vendor namespace definitions
6810  * @_next_ns_data: beginning of the next namespace's data
6811  * @_reset_on_ext: internal; reset the arg index to 0 when going to the
6812  *	next bitmap word
6813  *
6814  * Describes the radiotap parser state. Fields prefixed with an underscore
6815  * must not be used by users of the parser, only by the parser internally.
6816  */
6817 
6818 struct ieee80211_radiotap_iterator {
6819 	struct ieee80211_radiotap_header *_rtheader;
6820 	const struct ieee80211_radiotap_vendor_namespaces *_vns;
6821 	const struct ieee80211_radiotap_namespace *current_namespace;
6822 
6823 	unsigned char *_arg, *_next_ns_data;
6824 	__le32 *_next_bitmap;
6825 
6826 	unsigned char *this_arg;
6827 	int this_arg_index;
6828 	int this_arg_size;
6829 
6830 	int is_radiotap_ns;
6831 
6832 	int _max_length;
6833 	int _arg_index;
6834 	uint32_t _bitmap_shifter;
6835 	int _reset_on_ext;
6836 };
6837 
6838 int
6839 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
6840 				 struct ieee80211_radiotap_header *radiotap_header,
6841 				 int max_length,
6842 				 const struct ieee80211_radiotap_vendor_namespaces *vns);
6843 
6844 int
6845 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
6846 
6847 
6848 extern const unsigned char rfc1042_header[6];
6849 extern const unsigned char bridge_tunnel_header[6];
6850 
6851 /**
6852  * ieee80211_get_hdrlen_from_skb - get header length from data
6853  *
6854  * @skb: the frame
6855  *
6856  * Given an skb with a raw 802.11 header at the data pointer this function
6857  * returns the 802.11 header length.
6858  *
6859  * Return: The 802.11 header length in bytes (not including encryption
6860  * headers). Or 0 if the data in the sk_buff is too short to contain a valid
6861  * 802.11 header.
6862  */
6863 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
6864 
6865 /**
6866  * ieee80211_hdrlen - get header length in bytes from frame control
6867  * @fc: frame control field in little-endian format
6868  * Return: The header length in bytes.
6869  */
6870 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
6871 
6872 /**
6873  * ieee80211_get_mesh_hdrlen - get mesh extension header length
6874  * @meshhdr: the mesh extension header, only the flags field
6875  *	(first byte) will be accessed
6876  * Return: The length of the extension header, which is always at
6877  * least 6 bytes and at most 18 if address 5 and 6 are present.
6878  */
6879 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
6880 
6881 /**
6882  * DOC: Data path helpers
6883  *
6884  * In addition to generic utilities, cfg80211 also offers
6885  * functions that help implement the data path for devices
6886  * that do not do the 802.11/802.3 conversion on the device.
6887  */
6888 
6889 /**
6890  * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
6891  * @skb: the 802.11 data frame
6892  * @ehdr: pointer to a &struct ethhdr that will get the header, instead
6893  *	of it being pushed into the SKB
6894  * @addr: the device MAC address
6895  * @iftype: the virtual interface type
6896  * @data_offset: offset of payload after the 802.11 header
6897  * @is_amsdu: true if the 802.11 header is A-MSDU
6898  * Return: 0 on success. Non-zero on error.
6899  */
6900 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
6901 				  const u8 *addr, enum nl80211_iftype iftype,
6902 				  u8 data_offset, bool is_amsdu);
6903 
6904 /**
6905  * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
6906  * @skb: the 802.11 data frame
6907  * @addr: the device MAC address
6908  * @iftype: the virtual interface type
6909  * Return: 0 on success. Non-zero on error.
6910  */
6911 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
6912 					 enum nl80211_iftype iftype)
6913 {
6914 	return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0, false);
6915 }
6916 
6917 /**
6918  * ieee80211_is_valid_amsdu - check if subframe lengths of an A-MSDU are valid
6919  *
6920  * This is used to detect non-standard A-MSDU frames, e.g. the ones generated
6921  * by ath10k and ath11k, where the subframe length includes the length of the
6922  * mesh control field.
6923  *
6924  * @skb: The input A-MSDU frame without any headers.
6925  * @mesh_hdr: the type of mesh header to test
6926  *	0: non-mesh A-MSDU length field
6927  *	1: big-endian mesh A-MSDU length field
6928  *	2: little-endian mesh A-MSDU length field
6929  * Returns: true if subframe header lengths are valid for the @mesh_hdr mode
6930  */
6931 bool ieee80211_is_valid_amsdu(struct sk_buff *skb, u8 mesh_hdr);
6932 
6933 /**
6934  * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
6935  *
6936  * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
6937  * The @list will be empty if the decode fails. The @skb must be fully
6938  * header-less before being passed in here; it is freed in this function.
6939  *
6940  * @skb: The input A-MSDU frame without any headers.
6941  * @list: The output list of 802.3 frames. It must be allocated and
6942  *	initialized by the caller.
6943  * @addr: The device MAC address.
6944  * @iftype: The device interface type.
6945  * @extra_headroom: The hardware extra headroom for SKBs in the @list.
6946  * @check_da: DA to check in the inner ethernet header, or NULL
6947  * @check_sa: SA to check in the inner ethernet header, or NULL
6948  * @mesh_control: see mesh_hdr in ieee80211_is_valid_amsdu
6949  */
6950 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
6951 			      const u8 *addr, enum nl80211_iftype iftype,
6952 			      const unsigned int extra_headroom,
6953 			      const u8 *check_da, const u8 *check_sa,
6954 			      u8 mesh_control);
6955 
6956 /**
6957  * ieee80211_get_8023_tunnel_proto - get RFC1042 or bridge tunnel encap protocol
6958  *
6959  * Check for RFC1042 or bridge tunnel header and fetch the encapsulated
6960  * protocol.
6961  *
6962  * @hdr: pointer to the MSDU payload
6963  * @proto: destination pointer to store the protocol
6964  * Return: true if encapsulation was found
6965  */
6966 bool ieee80211_get_8023_tunnel_proto(const void *hdr, __be16 *proto);
6967 
6968 /**
6969  * ieee80211_strip_8023_mesh_hdr - strip mesh header from converted 802.3 frames
6970  *
6971  * Strip the mesh header, which was left in by ieee80211_data_to_8023 as part
6972  * of the MSDU data. Also move any source/destination addresses from the mesh
6973  * header to the ethernet header (if present).
6974  *
6975  * @skb: The 802.3 frame with embedded mesh header
6976  *
6977  * Return: 0 on success. Non-zero on error.
6978  */
6979 int ieee80211_strip_8023_mesh_hdr(struct sk_buff *skb);
6980 
6981 /**
6982  * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
6983  * @skb: the data frame
6984  * @qos_map: Interworking QoS mapping or %NULL if not in use
6985  * Return: The 802.1p/1d tag.
6986  */
6987 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
6988 				    struct cfg80211_qos_map *qos_map);
6989 
6990 /**
6991  * cfg80211_find_elem_match - match information element and byte array in data
6992  *
6993  * @eid: element ID
6994  * @ies: data consisting of IEs
6995  * @len: length of data
6996  * @match: byte array to match
6997  * @match_len: number of bytes in the match array
6998  * @match_offset: offset in the IE data where the byte array should match.
6999  *	Note the difference to cfg80211_find_ie_match() which considers
7000  *	the offset to start from the element ID byte, but here we take
7001  *	the data portion instead.
7002  *
7003  * Return: %NULL if the element ID could not be found or if
7004  * the element is invalid (claims to be longer than the given
7005  * data) or if the byte array doesn't match; otherwise return the
7006  * requested element struct.
7007  *
7008  * Note: There are no checks on the element length other than
7009  * having to fit into the given data and being large enough for the
7010  * byte array to match.
7011  */
7012 const struct element *
7013 cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
7014 			 const u8 *match, unsigned int match_len,
7015 			 unsigned int match_offset);
7016 
7017 /**
7018  * cfg80211_find_ie_match - match information element and byte array in data
7019  *
7020  * @eid: element ID
7021  * @ies: data consisting of IEs
7022  * @len: length of data
7023  * @match: byte array to match
7024  * @match_len: number of bytes in the match array
7025  * @match_offset: offset in the IE where the byte array should match.
7026  *	If match_len is zero, this must also be set to zero.
7027  *	Otherwise this must be set to 2 or more, because the first
7028  *	byte is the element id, which is already compared to eid, and
7029  *	the second byte is the IE length.
7030  *
7031  * Return: %NULL if the element ID could not be found or if
7032  * the element is invalid (claims to be longer than the given
7033  * data) or if the byte array doesn't match, or a pointer to the first
7034  * byte of the requested element, that is the byte containing the
7035  * element ID.
7036  *
7037  * Note: There are no checks on the element length other than
7038  * having to fit into the given data and being large enough for the
7039  * byte array to match.
7040  */
7041 static inline const u8 *
7042 cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
7043 		       const u8 *match, unsigned int match_len,
7044 		       unsigned int match_offset)
7045 {
7046 	/* match_offset can't be smaller than 2, unless match_len is
7047 	 * zero, in which case match_offset must be zero as well.
7048 	 */
7049 	if (WARN_ON((match_len && match_offset < 2) ||
7050 		    (!match_len && match_offset)))
7051 		return NULL;
7052 
7053 	return (const void *)cfg80211_find_elem_match(eid, ies, len,
7054 						      match, match_len,
7055 						      match_offset ?
7056 							match_offset - 2 : 0);
7057 }
7058 
7059 /**
7060  * cfg80211_find_elem - find information element in data
7061  *
7062  * @eid: element ID
7063  * @ies: data consisting of IEs
7064  * @len: length of data
7065  *
7066  * Return: %NULL if the element ID could not be found or if
7067  * the element is invalid (claims to be longer than the given
7068  * data) or if the byte array doesn't match; otherwise return the
7069  * requested element struct.
7070  *
7071  * Note: There are no checks on the element length other than
7072  * having to fit into the given data.
7073  */
7074 static inline const struct element *
7075 cfg80211_find_elem(u8 eid, const u8 *ies, int len)
7076 {
7077 	return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
7078 }
7079 
7080 /**
7081  * cfg80211_find_ie - find information element in data
7082  *
7083  * @eid: element ID
7084  * @ies: data consisting of IEs
7085  * @len: length of data
7086  *
7087  * Return: %NULL if the element ID could not be found or if
7088  * the element is invalid (claims to be longer than the given
7089  * data), or a pointer to the first byte of the requested
7090  * element, that is the byte containing the element ID.
7091  *
7092  * Note: There are no checks on the element length other than
7093  * having to fit into the given data.
7094  */
7095 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
7096 {
7097 	return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
7098 }
7099 
7100 /**
7101  * cfg80211_find_ext_elem - find information element with EID Extension in data
7102  *
7103  * @ext_eid: element ID Extension
7104  * @ies: data consisting of IEs
7105  * @len: length of data
7106  *
7107  * Return: %NULL if the extended element could not be found or if
7108  * the element is invalid (claims to be longer than the given
7109  * data) or if the byte array doesn't match; otherwise return the
7110  * requested element struct.
7111  *
7112  * Note: There are no checks on the element length other than
7113  * having to fit into the given data.
7114  */
7115 static inline const struct element *
7116 cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
7117 {
7118 	return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
7119 					&ext_eid, 1, 0);
7120 }
7121 
7122 /**
7123  * cfg80211_find_ext_ie - find information element with EID Extension in data
7124  *
7125  * @ext_eid: element ID Extension
7126  * @ies: data consisting of IEs
7127  * @len: length of data
7128  *
7129  * Return: %NULL if the extended element ID could not be found or if
7130  * the element is invalid (claims to be longer than the given
7131  * data), or a pointer to the first byte of the requested
7132  * element, that is the byte containing the element ID.
7133  *
7134  * Note: There are no checks on the element length other than
7135  * having to fit into the given data.
7136  */
7137 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
7138 {
7139 	return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
7140 				      &ext_eid, 1, 2);
7141 }
7142 
7143 /**
7144  * cfg80211_find_vendor_elem - find vendor specific information element in data
7145  *
7146  * @oui: vendor OUI
7147  * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
7148  * @ies: data consisting of IEs
7149  * @len: length of data
7150  *
7151  * Return: %NULL if the vendor specific element ID could not be found or if the
7152  * element is invalid (claims to be longer than the given data); otherwise
7153  * return the element structure for the requested element.
7154  *
7155  * Note: There are no checks on the element length other than having to fit into
7156  * the given data.
7157  */
7158 const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
7159 						const u8 *ies,
7160 						unsigned int len);
7161 
7162 /**
7163  * cfg80211_find_vendor_ie - find vendor specific information element in data
7164  *
7165  * @oui: vendor OUI
7166  * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
7167  * @ies: data consisting of IEs
7168  * @len: length of data
7169  *
7170  * Return: %NULL if the vendor specific element ID could not be found or if the
7171  * element is invalid (claims to be longer than the given data), or a pointer to
7172  * the first byte of the requested element, that is the byte containing the
7173  * element ID.
7174  *
7175  * Note: There are no checks on the element length other than having to fit into
7176  * the given data.
7177  */
7178 static inline const u8 *
7179 cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
7180 			const u8 *ies, unsigned int len)
7181 {
7182 	return (const void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
7183 }
7184 
7185 /**
7186  * enum cfg80211_rnr_iter_ret - reduced neighbor report iteration state
7187  * @RNR_ITER_CONTINUE: continue iterating with the next entry
7188  * @RNR_ITER_BREAK: break iteration and return success
7189  * @RNR_ITER_ERROR: break iteration and return error
7190  */
7191 enum cfg80211_rnr_iter_ret {
7192 	RNR_ITER_CONTINUE,
7193 	RNR_ITER_BREAK,
7194 	RNR_ITER_ERROR,
7195 };
7196 
7197 /**
7198  * cfg80211_iter_rnr - iterate reduced neighbor report entries
7199  * @elems: the frame elements to iterate RNR elements and then
7200  *	their entries in
7201  * @elems_len: length of the elements
7202  * @iter: iteration function, see also &enum cfg80211_rnr_iter_ret
7203  *	for the return value
7204  * @iter_data: additional data passed to the iteration function
7205  * Return: %true on success (after successfully iterating all entries
7206  *	or if the iteration function returned %RNR_ITER_BREAK),
7207  *	%false on error (iteration function returned %RNR_ITER_ERROR
7208  *	or elements were malformed.)
7209  */
7210 bool cfg80211_iter_rnr(const u8 *elems, size_t elems_len,
7211 		       enum cfg80211_rnr_iter_ret
7212 		       (*iter)(void *data, u8 type,
7213 			       const struct ieee80211_neighbor_ap_info *info,
7214 			       const u8 *tbtt_info, u8 tbtt_info_len),
7215 		       void *iter_data);
7216 
7217 /**
7218  * cfg80211_defragment_element - Defrag the given element data into a buffer
7219  *
7220  * @elem: the element to defragment
7221  * @ies: elements where @elem is contained
7222  * @ieslen: length of @ies
7223  * @data: buffer to store element data, or %NULL to just determine size
7224  * @data_len: length of @data, or 0
7225  * @frag_id: the element ID of fragments
7226  *
7227  * Return: length of @data, or -EINVAL on error
7228  *
7229  * Copy out all data from an element that may be fragmented into @data, while
7230  * skipping all headers.
7231  *
7232  * The function uses memmove() internally. It is acceptable to defragment an
7233  * element in-place.
7234  */
7235 ssize_t cfg80211_defragment_element(const struct element *elem, const u8 *ies,
7236 				    size_t ieslen, u8 *data, size_t data_len,
7237 				    u8 frag_id);
7238 
7239 /**
7240  * cfg80211_send_layer2_update - send layer 2 update frame
7241  *
7242  * @dev: network device
7243  * @addr: STA MAC address
7244  *
7245  * Wireless drivers can use this function to update forwarding tables in bridge
7246  * devices upon STA association.
7247  */
7248 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
7249 
7250 /**
7251  * DOC: Regulatory enforcement infrastructure
7252  *
7253  * TODO
7254  */
7255 
7256 /**
7257  * regulatory_hint - driver hint to the wireless core a regulatory domain
7258  * @wiphy: the wireless device giving the hint (used only for reporting
7259  *	conflicts)
7260  * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
7261  *	should be in. If @rd is set this should be NULL. Note that if you
7262  *	set this to NULL you should still set rd->alpha2 to some accepted
7263  *	alpha2.
7264  *
7265  * Wireless drivers can use this function to hint to the wireless core
7266  * what it believes should be the current regulatory domain by
7267  * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
7268  * domain should be in or by providing a completely build regulatory domain.
7269  * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
7270  * for a regulatory domain structure for the respective country.
7271  *
7272  * The wiphy must have been registered to cfg80211 prior to this call.
7273  * For cfg80211 drivers this means you must first use wiphy_register(),
7274  * for mac80211 drivers you must first use ieee80211_register_hw().
7275  *
7276  * Drivers should check the return value, its possible you can get
7277  * an -ENOMEM.
7278  *
7279  * Return: 0 on success. -ENOMEM.
7280  */
7281 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
7282 
7283 /**
7284  * regulatory_set_wiphy_regd - set regdom info for self managed drivers
7285  * @wiphy: the wireless device we want to process the regulatory domain on
7286  * @rd: the regulatory domain information to use for this wiphy
7287  *
7288  * Set the regulatory domain information for self-managed wiphys, only they
7289  * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
7290  * information.
7291  *
7292  * Return: 0 on success. -EINVAL, -EPERM
7293  */
7294 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
7295 			      struct ieee80211_regdomain *rd);
7296 
7297 /**
7298  * regulatory_set_wiphy_regd_sync - set regdom for self-managed drivers
7299  * @wiphy: the wireless device we want to process the regulatory domain on
7300  * @rd: the regulatory domain information to use for this wiphy
7301  *
7302  * This functions requires the RTNL and the wiphy mutex to be held and
7303  * applies the new regdomain synchronously to this wiphy. For more details
7304  * see regulatory_set_wiphy_regd().
7305  *
7306  * Return: 0 on success. -EINVAL, -EPERM
7307  */
7308 int regulatory_set_wiphy_regd_sync(struct wiphy *wiphy,
7309 				   struct ieee80211_regdomain *rd);
7310 
7311 /**
7312  * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
7313  * @wiphy: the wireless device we want to process the regulatory domain on
7314  * @regd: the custom regulatory domain to use for this wiphy
7315  *
7316  * Drivers can sometimes have custom regulatory domains which do not apply
7317  * to a specific country. Drivers can use this to apply such custom regulatory
7318  * domains. This routine must be called prior to wiphy registration. The
7319  * custom regulatory domain will be trusted completely and as such previous
7320  * default channel settings will be disregarded. If no rule is found for a
7321  * channel on the regulatory domain the channel will be disabled.
7322  * Drivers using this for a wiphy should also set the wiphy flag
7323  * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
7324  * that called this helper.
7325  */
7326 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
7327 				   const struct ieee80211_regdomain *regd);
7328 
7329 /**
7330  * freq_reg_info - get regulatory information for the given frequency
7331  * @wiphy: the wiphy for which we want to process this rule for
7332  * @center_freq: Frequency in KHz for which we want regulatory information for
7333  *
7334  * Use this function to get the regulatory rule for a specific frequency on
7335  * a given wireless device. If the device has a specific regulatory domain
7336  * it wants to follow we respect that unless a country IE has been received
7337  * and processed already.
7338  *
7339  * Return: A valid pointer, or, when an error occurs, for example if no rule
7340  * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
7341  * check and PTR_ERR() to obtain the numeric return value. The numeric return
7342  * value will be -ERANGE if we determine the given center_freq does not even
7343  * have a regulatory rule for a frequency range in the center_freq's band.
7344  * See freq_in_rule_band() for our current definition of a band -- this is
7345  * purely subjective and right now it's 802.11 specific.
7346  */
7347 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
7348 					       u32 center_freq);
7349 
7350 /**
7351  * reg_initiator_name - map regulatory request initiator enum to name
7352  * @initiator: the regulatory request initiator
7353  *
7354  * You can use this to map the regulatory request initiator enum to a
7355  * proper string representation.
7356  *
7357  * Return: pointer to string representation of the initiator
7358  */
7359 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
7360 
7361 /**
7362  * regulatory_pre_cac_allowed - check if pre-CAC allowed in the current regdom
7363  * @wiphy: wiphy for which pre-CAC capability is checked.
7364  *
7365  * Pre-CAC is allowed only in some regdomains (notable ETSI).
7366  *
7367  * Return: %true if allowed, %false otherwise
7368  */
7369 bool regulatory_pre_cac_allowed(struct wiphy *wiphy);
7370 
7371 /**
7372  * DOC: Internal regulatory db functions
7373  *
7374  */
7375 
7376 /**
7377  * reg_query_regdb_wmm -  Query internal regulatory db for wmm rule
7378  * Regulatory self-managed driver can use it to proactively
7379  *
7380  * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
7381  * @freq: the frequency (in MHz) to be queried.
7382  * @rule: pointer to store the wmm rule from the regulatory db.
7383  *
7384  * Self-managed wireless drivers can use this function to  query
7385  * the internal regulatory database to check whether the given
7386  * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
7387  *
7388  * Drivers should check the return value, its possible you can get
7389  * an -ENODATA.
7390  *
7391  * Return: 0 on success. -ENODATA.
7392  */
7393 int reg_query_regdb_wmm(char *alpha2, int freq,
7394 			struct ieee80211_reg_rule *rule);
7395 
7396 /*
7397  * callbacks for asynchronous cfg80211 methods, notification
7398  * functions and BSS handling helpers
7399  */
7400 
7401 /**
7402  * cfg80211_scan_done - notify that scan finished
7403  *
7404  * @request: the corresponding scan request
7405  * @info: information about the completed scan
7406  */
7407 void cfg80211_scan_done(struct cfg80211_scan_request *request,
7408 			struct cfg80211_scan_info *info);
7409 
7410 /**
7411  * cfg80211_sched_scan_results - notify that new scan results are available
7412  *
7413  * @wiphy: the wiphy which got scheduled scan results
7414  * @reqid: identifier for the related scheduled scan request
7415  */
7416 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
7417 
7418 /**
7419  * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
7420  *
7421  * @wiphy: the wiphy on which the scheduled scan stopped
7422  * @reqid: identifier for the related scheduled scan request
7423  *
7424  * The driver can call this function to inform cfg80211 that the
7425  * scheduled scan had to be stopped, for whatever reason.  The driver
7426  * is then called back via the sched_scan_stop operation when done.
7427  */
7428 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
7429 
7430 /**
7431  * cfg80211_sched_scan_stopped_locked - notify that the scheduled scan has stopped
7432  *
7433  * @wiphy: the wiphy on which the scheduled scan stopped
7434  * @reqid: identifier for the related scheduled scan request
7435  *
7436  * The driver can call this function to inform cfg80211 that the
7437  * scheduled scan had to be stopped, for whatever reason.  The driver
7438  * is then called back via the sched_scan_stop operation when done.
7439  * This function should be called with the wiphy mutex held.
7440  */
7441 void cfg80211_sched_scan_stopped_locked(struct wiphy *wiphy, u64 reqid);
7442 
7443 /**
7444  * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
7445  * @wiphy: the wiphy reporting the BSS
7446  * @data: the BSS metadata
7447  * @mgmt: the management frame (probe response or beacon)
7448  * @len: length of the management frame
7449  * @gfp: context flags
7450  *
7451  * This informs cfg80211 that BSS information was found and
7452  * the BSS should be updated/added.
7453  *
7454  * Return: A referenced struct, must be released with cfg80211_put_bss()!
7455  * Or %NULL on error.
7456  */
7457 struct cfg80211_bss * __must_check
7458 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
7459 			       struct cfg80211_inform_bss *data,
7460 			       struct ieee80211_mgmt *mgmt, size_t len,
7461 			       gfp_t gfp);
7462 
7463 static inline struct cfg80211_bss * __must_check
7464 cfg80211_inform_bss_frame(struct wiphy *wiphy,
7465 			  struct ieee80211_channel *rx_channel,
7466 			  struct ieee80211_mgmt *mgmt, size_t len,
7467 			  s32 signal, gfp_t gfp)
7468 {
7469 	struct cfg80211_inform_bss data = {
7470 		.chan = rx_channel,
7471 		.signal = signal,
7472 	};
7473 
7474 	return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
7475 }
7476 
7477 /**
7478  * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
7479  * @bssid: transmitter BSSID
7480  * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
7481  * @mbssid_index: BSSID index, taken from Multiple BSSID index element
7482  * @new_bssid: calculated nontransmitted BSSID
7483  */
7484 static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
7485 					  u8 mbssid_index, u8 *new_bssid)
7486 {
7487 	u64 bssid_u64 = ether_addr_to_u64(bssid);
7488 	u64 mask = GENMASK_ULL(max_bssid - 1, 0);
7489 	u64 new_bssid_u64;
7490 
7491 	new_bssid_u64 = bssid_u64 & ~mask;
7492 
7493 	new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
7494 
7495 	u64_to_ether_addr(new_bssid_u64, new_bssid);
7496 }
7497 
7498 /**
7499  * cfg80211_is_element_inherited - returns if element ID should be inherited
7500  * @element: element to check
7501  * @non_inherit_element: non inheritance element
7502  *
7503  * Return: %true if should be inherited, %false otherwise
7504  */
7505 bool cfg80211_is_element_inherited(const struct element *element,
7506 				   const struct element *non_inherit_element);
7507 
7508 /**
7509  * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
7510  * @ie: ies
7511  * @ielen: length of IEs
7512  * @mbssid_elem: current MBSSID element
7513  * @sub_elem: current MBSSID subelement (profile)
7514  * @merged_ie: location of the merged profile
7515  * @max_copy_len: max merged profile length
7516  *
7517  * Return: the number of bytes merged
7518  */
7519 size_t cfg80211_merge_profile(const u8 *ie, size_t ielen,
7520 			      const struct element *mbssid_elem,
7521 			      const struct element *sub_elem,
7522 			      u8 *merged_ie, size_t max_copy_len);
7523 
7524 /**
7525  * enum cfg80211_bss_frame_type - frame type that the BSS data came from
7526  * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
7527  *	from a beacon or probe response
7528  * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
7529  * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
7530  * @CFG80211_BSS_FTYPE_S1G_BEACON: data comes from an S1G beacon
7531  */
7532 enum cfg80211_bss_frame_type {
7533 	CFG80211_BSS_FTYPE_UNKNOWN,
7534 	CFG80211_BSS_FTYPE_BEACON,
7535 	CFG80211_BSS_FTYPE_PRESP,
7536 	CFG80211_BSS_FTYPE_S1G_BEACON,
7537 };
7538 
7539 /**
7540  * cfg80211_get_ies_channel_number - returns the channel number from ies
7541  * @ie: IEs
7542  * @ielen: length of IEs
7543  * @band: enum nl80211_band of the channel
7544  *
7545  * Return: the channel number, or -1 if none could be determined.
7546  */
7547 int cfg80211_get_ies_channel_number(const u8 *ie, size_t ielen,
7548 				    enum nl80211_band band);
7549 
7550 /**
7551  * cfg80211_ssid_eq - compare two SSIDs
7552  * @a: first SSID
7553  * @b: second SSID
7554  *
7555  * Return: %true if SSIDs are equal, %false otherwise.
7556  */
7557 static inline bool
7558 cfg80211_ssid_eq(struct cfg80211_ssid *a, struct cfg80211_ssid *b)
7559 {
7560 	if (WARN_ON(!a || !b))
7561 		return false;
7562 	if (a->ssid_len != b->ssid_len)
7563 		return false;
7564 	return memcmp(a->ssid, b->ssid, a->ssid_len) ? false : true;
7565 }
7566 
7567 /**
7568  * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
7569  *
7570  * @wiphy: the wiphy reporting the BSS
7571  * @data: the BSS metadata
7572  * @ftype: frame type (if known)
7573  * @bssid: the BSSID of the BSS
7574  * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
7575  * @capability: the capability field sent by the peer
7576  * @beacon_interval: the beacon interval announced by the peer
7577  * @ie: additional IEs sent by the peer
7578  * @ielen: length of the additional IEs
7579  * @gfp: context flags
7580  *
7581  * This informs cfg80211 that BSS information was found and
7582  * the BSS should be updated/added.
7583  *
7584  * Return: A referenced struct, must be released with cfg80211_put_bss()!
7585  * Or %NULL on error.
7586  */
7587 struct cfg80211_bss * __must_check
7588 cfg80211_inform_bss_data(struct wiphy *wiphy,
7589 			 struct cfg80211_inform_bss *data,
7590 			 enum cfg80211_bss_frame_type ftype,
7591 			 const u8 *bssid, u64 tsf, u16 capability,
7592 			 u16 beacon_interval, const u8 *ie, size_t ielen,
7593 			 gfp_t gfp);
7594 
7595 static inline struct cfg80211_bss * __must_check
7596 cfg80211_inform_bss(struct wiphy *wiphy,
7597 		    struct ieee80211_channel *rx_channel,
7598 		    enum cfg80211_bss_frame_type ftype,
7599 		    const u8 *bssid, u64 tsf, u16 capability,
7600 		    u16 beacon_interval, const u8 *ie, size_t ielen,
7601 		    s32 signal, gfp_t gfp)
7602 {
7603 	struct cfg80211_inform_bss data = {
7604 		.chan = rx_channel,
7605 		.signal = signal,
7606 	};
7607 
7608 	return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
7609 					capability, beacon_interval, ie, ielen,
7610 					gfp);
7611 }
7612 
7613 /**
7614  * __cfg80211_get_bss - get a BSS reference
7615  * @wiphy: the wiphy this BSS struct belongs to
7616  * @channel: the channel to search on (or %NULL)
7617  * @bssid: the desired BSSID (or %NULL)
7618  * @ssid: the desired SSID (or %NULL)
7619  * @ssid_len: length of the SSID (or 0)
7620  * @bss_type: type of BSS, see &enum ieee80211_bss_type
7621  * @privacy: privacy filter, see &enum ieee80211_privacy
7622  * @use_for: indicates which use is intended
7623  *
7624  * Return: Reference-counted BSS on success. %NULL on error.
7625  */
7626 struct cfg80211_bss *__cfg80211_get_bss(struct wiphy *wiphy,
7627 					struct ieee80211_channel *channel,
7628 					const u8 *bssid,
7629 					const u8 *ssid, size_t ssid_len,
7630 					enum ieee80211_bss_type bss_type,
7631 					enum ieee80211_privacy privacy,
7632 					u32 use_for);
7633 
7634 /**
7635  * cfg80211_get_bss - get a BSS reference
7636  * @wiphy: the wiphy this BSS struct belongs to
7637  * @channel: the channel to search on (or %NULL)
7638  * @bssid: the desired BSSID (or %NULL)
7639  * @ssid: the desired SSID (or %NULL)
7640  * @ssid_len: length of the SSID (or 0)
7641  * @bss_type: type of BSS, see &enum ieee80211_bss_type
7642  * @privacy: privacy filter, see &enum ieee80211_privacy
7643  *
7644  * This version implies regular usage, %NL80211_BSS_USE_FOR_NORMAL.
7645  *
7646  * Return: Reference-counted BSS on success. %NULL on error.
7647  */
7648 static inline struct cfg80211_bss *
7649 cfg80211_get_bss(struct wiphy *wiphy, struct ieee80211_channel *channel,
7650 		 const u8 *bssid, const u8 *ssid, size_t ssid_len,
7651 		 enum ieee80211_bss_type bss_type,
7652 		 enum ieee80211_privacy privacy)
7653 {
7654 	return __cfg80211_get_bss(wiphy, channel, bssid, ssid, ssid_len,
7655 				  bss_type, privacy,
7656 				  NL80211_BSS_USE_FOR_NORMAL);
7657 }
7658 
7659 static inline struct cfg80211_bss *
7660 cfg80211_get_ibss(struct wiphy *wiphy,
7661 		  struct ieee80211_channel *channel,
7662 		  const u8 *ssid, size_t ssid_len)
7663 {
7664 	return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
7665 				IEEE80211_BSS_TYPE_IBSS,
7666 				IEEE80211_PRIVACY_ANY);
7667 }
7668 
7669 /**
7670  * cfg80211_ref_bss - reference BSS struct
7671  * @wiphy: the wiphy this BSS struct belongs to
7672  * @bss: the BSS struct to reference
7673  *
7674  * Increments the refcount of the given BSS struct.
7675  */
7676 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
7677 
7678 /**
7679  * cfg80211_put_bss - unref BSS struct
7680  * @wiphy: the wiphy this BSS struct belongs to
7681  * @bss: the BSS struct
7682  *
7683  * Decrements the refcount of the given BSS struct.
7684  */
7685 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
7686 
7687 /**
7688  * cfg80211_unlink_bss - unlink BSS from internal data structures
7689  * @wiphy: the wiphy
7690  * @bss: the bss to remove
7691  *
7692  * This function removes the given BSS from the internal data structures
7693  * thereby making it no longer show up in scan results etc. Use this
7694  * function when you detect a BSS is gone. Normally BSSes will also time
7695  * out, so it is not necessary to use this function at all.
7696  */
7697 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
7698 
7699 /**
7700  * cfg80211_bss_iter - iterate all BSS entries
7701  *
7702  * This function iterates over the BSS entries associated with the given wiphy
7703  * and calls the callback for the iterated BSS. The iterator function is not
7704  * allowed to call functions that might modify the internal state of the BSS DB.
7705  *
7706  * @wiphy: the wiphy
7707  * @chandef: if given, the iterator function will be called only if the channel
7708  *     of the currently iterated BSS is a subset of the given channel.
7709  * @iter: the iterator function to call
7710  * @iter_data: an argument to the iterator function
7711  */
7712 void cfg80211_bss_iter(struct wiphy *wiphy,
7713 		       struct cfg80211_chan_def *chandef,
7714 		       void (*iter)(struct wiphy *wiphy,
7715 				    struct cfg80211_bss *bss,
7716 				    void *data),
7717 		       void *iter_data);
7718 
7719 /**
7720  * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
7721  * @dev: network device
7722  * @buf: authentication frame (header + body)
7723  * @len: length of the frame data
7724  *
7725  * This function is called whenever an authentication, disassociation or
7726  * deauthentication frame has been received and processed in station mode.
7727  * After being asked to authenticate via cfg80211_ops::auth() the driver must
7728  * call either this function or cfg80211_auth_timeout().
7729  * After being asked to associate via cfg80211_ops::assoc() the driver must
7730  * call either this function or cfg80211_auth_timeout().
7731  * While connected, the driver must calls this for received and processed
7732  * disassociation and deauthentication frames. If the frame couldn't be used
7733  * because it was unprotected, the driver must call the function
7734  * cfg80211_rx_unprot_mlme_mgmt() instead.
7735  *
7736  * This function may sleep. The caller must hold the corresponding wdev's mutex.
7737  */
7738 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
7739 
7740 /**
7741  * cfg80211_auth_timeout - notification of timed out authentication
7742  * @dev: network device
7743  * @addr: The MAC address of the device with which the authentication timed out
7744  *
7745  * This function may sleep. The caller must hold the corresponding wdev's
7746  * mutex.
7747  */
7748 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
7749 
7750 /**
7751  * struct cfg80211_rx_assoc_resp_data - association response data
7752  * @buf: (Re)Association Response frame (header + body)
7753  * @len: length of the frame data
7754  * @uapsd_queues: bitmap of queues configured for uapsd. Same format
7755  *	as the AC bitmap in the QoS info field
7756  * @req_ies: information elements from the (Re)Association Request frame
7757  * @req_ies_len: length of req_ies data
7758  * @ap_mld_addr: AP MLD address (in case of MLO)
7759  * @links: per-link information indexed by link ID, use links[0] for
7760  *	non-MLO connections
7761  * @links.bss: the BSS that association was requested with, ownership of the
7762  *      pointer moves to cfg80211 in the call to cfg80211_rx_assoc_resp()
7763  * @links.status: Set this (along with a BSS pointer) for links that
7764  *	were rejected by the AP.
7765  */
7766 struct cfg80211_rx_assoc_resp_data {
7767 	const u8 *buf;
7768 	size_t len;
7769 	const u8 *req_ies;
7770 	size_t req_ies_len;
7771 	int uapsd_queues;
7772 	const u8 *ap_mld_addr;
7773 	struct {
7774 		u8 addr[ETH_ALEN] __aligned(2);
7775 		struct cfg80211_bss *bss;
7776 		u16 status;
7777 	} links[IEEE80211_MLD_MAX_NUM_LINKS];
7778 };
7779 
7780 /**
7781  * cfg80211_rx_assoc_resp - notification of processed association response
7782  * @dev: network device
7783  * @data: association response data, &struct cfg80211_rx_assoc_resp_data
7784  *
7785  * After being asked to associate via cfg80211_ops::assoc() the driver must
7786  * call either this function or cfg80211_auth_timeout().
7787  *
7788  * This function may sleep. The caller must hold the corresponding wdev's mutex.
7789  */
7790 void cfg80211_rx_assoc_resp(struct net_device *dev,
7791 			    const struct cfg80211_rx_assoc_resp_data *data);
7792 
7793 /**
7794  * struct cfg80211_assoc_failure - association failure data
7795  * @ap_mld_addr: AP MLD address, or %NULL
7796  * @bss: list of BSSes, must use entry 0 for non-MLO connections
7797  *	(@ap_mld_addr is %NULL)
7798  * @timeout: indicates the association failed due to timeout, otherwise
7799  *	the association was abandoned for a reason reported through some
7800  *	other API (e.g. deauth RX)
7801  */
7802 struct cfg80211_assoc_failure {
7803 	const u8 *ap_mld_addr;
7804 	struct cfg80211_bss *bss[IEEE80211_MLD_MAX_NUM_LINKS];
7805 	bool timeout;
7806 };
7807 
7808 /**
7809  * cfg80211_assoc_failure - notification of association failure
7810  * @dev: network device
7811  * @data: data describing the association failure
7812  *
7813  * This function may sleep. The caller must hold the corresponding wdev's mutex.
7814  */
7815 void cfg80211_assoc_failure(struct net_device *dev,
7816 			    struct cfg80211_assoc_failure *data);
7817 
7818 /**
7819  * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
7820  * @dev: network device
7821  * @buf: 802.11 frame (header + body)
7822  * @len: length of the frame data
7823  * @reconnect: immediate reconnect is desired (include the nl80211 attribute)
7824  *
7825  * This function is called whenever deauthentication has been processed in
7826  * station mode. This includes both received deauthentication frames and
7827  * locally generated ones. This function may sleep. The caller must hold the
7828  * corresponding wdev's mutex.
7829  */
7830 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len,
7831 			   bool reconnect);
7832 
7833 /**
7834  * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
7835  * @dev: network device
7836  * @buf: received management frame (header + body)
7837  * @len: length of the frame data
7838  *
7839  * This function is called whenever a received deauthentication or dissassoc
7840  * frame has been dropped in station mode because of MFP being used but the
7841  * frame was not protected. This is also used to notify reception of a Beacon
7842  * frame that was dropped because it did not include a valid MME MIC while
7843  * beacon protection was enabled (BIGTK configured in station mode).
7844  *
7845  * This function may sleep.
7846  */
7847 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
7848 				  const u8 *buf, size_t len);
7849 
7850 /**
7851  * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
7852  * @dev: network device
7853  * @addr: The source MAC address of the frame
7854  * @key_type: The key type that the received frame used
7855  * @key_id: Key identifier (0..3). Can be -1 if missing.
7856  * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
7857  * @gfp: allocation flags
7858  *
7859  * This function is called whenever the local MAC detects a MIC failure in a
7860  * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
7861  * primitive.
7862  */
7863 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
7864 				  enum nl80211_key_type key_type, int key_id,
7865 				  const u8 *tsc, gfp_t gfp);
7866 
7867 /**
7868  * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
7869  *
7870  * @dev: network device
7871  * @bssid: the BSSID of the IBSS joined
7872  * @channel: the channel of the IBSS joined
7873  * @gfp: allocation flags
7874  *
7875  * This function notifies cfg80211 that the device joined an IBSS or
7876  * switched to a different BSSID. Before this function can be called,
7877  * either a beacon has to have been received from the IBSS, or one of
7878  * the cfg80211_inform_bss{,_frame} functions must have been called
7879  * with the locally generated beacon -- this guarantees that there is
7880  * always a scan result for this IBSS. cfg80211 will handle the rest.
7881  */
7882 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
7883 			  struct ieee80211_channel *channel, gfp_t gfp);
7884 
7885 /**
7886  * cfg80211_notify_new_peer_candidate - notify cfg80211 of a new mesh peer
7887  * 					candidate
7888  *
7889  * @dev: network device
7890  * @macaddr: the MAC address of the new candidate
7891  * @ie: information elements advertised by the peer candidate
7892  * @ie_len: length of the information elements buffer
7893  * @sig_dbm: signal level in dBm
7894  * @gfp: allocation flags
7895  *
7896  * This function notifies cfg80211 that the mesh peer candidate has been
7897  * detected, most likely via a beacon or, less likely, via a probe response.
7898  * cfg80211 then sends a notification to userspace.
7899  */
7900 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
7901 		const u8 *macaddr, const u8 *ie, u8 ie_len,
7902 		int sig_dbm, gfp_t gfp);
7903 
7904 /**
7905  * DOC: RFkill integration
7906  *
7907  * RFkill integration in cfg80211 is almost invisible to drivers,
7908  * as cfg80211 automatically registers an rfkill instance for each
7909  * wireless device it knows about. Soft kill is also translated
7910  * into disconnecting and turning all interfaces off. Drivers are
7911  * expected to turn off the device when all interfaces are down.
7912  *
7913  * However, devices may have a hard RFkill line, in which case they
7914  * also need to interact with the rfkill subsystem, via cfg80211.
7915  * They can do this with a few helper functions documented here.
7916  */
7917 
7918 /**
7919  * wiphy_rfkill_set_hw_state_reason - notify cfg80211 about hw block state
7920  * @wiphy: the wiphy
7921  * @blocked: block status
7922  * @reason: one of reasons in &enum rfkill_hard_block_reasons
7923  */
7924 void wiphy_rfkill_set_hw_state_reason(struct wiphy *wiphy, bool blocked,
7925 				      enum rfkill_hard_block_reasons reason);
7926 
7927 static inline void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked)
7928 {
7929 	wiphy_rfkill_set_hw_state_reason(wiphy, blocked,
7930 					 RFKILL_HARD_BLOCK_SIGNAL);
7931 }
7932 
7933 /**
7934  * wiphy_rfkill_start_polling - start polling rfkill
7935  * @wiphy: the wiphy
7936  */
7937 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
7938 
7939 /**
7940  * wiphy_rfkill_stop_polling - stop polling rfkill
7941  * @wiphy: the wiphy
7942  */
7943 static inline void wiphy_rfkill_stop_polling(struct wiphy *wiphy)
7944 {
7945 	rfkill_pause_polling(wiphy->rfkill);
7946 }
7947 
7948 /**
7949  * DOC: Vendor commands
7950  *
7951  * Occasionally, there are special protocol or firmware features that
7952  * can't be implemented very openly. For this and similar cases, the
7953  * vendor command functionality allows implementing the features with
7954  * (typically closed-source) userspace and firmware, using nl80211 as
7955  * the configuration mechanism.
7956  *
7957  * A driver supporting vendor commands must register them as an array
7958  * in struct wiphy, with handlers for each one. Each command has an
7959  * OUI and sub command ID to identify it.
7960  *
7961  * Note that this feature should not be (ab)used to implement protocol
7962  * features that could openly be shared across drivers. In particular,
7963  * it must never be required to use vendor commands to implement any
7964  * "normal" functionality that higher-level userspace like connection
7965  * managers etc. need.
7966  */
7967 
7968 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
7969 					   enum nl80211_commands cmd,
7970 					   enum nl80211_attrs attr,
7971 					   int approxlen);
7972 
7973 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
7974 					   struct wireless_dev *wdev,
7975 					   enum nl80211_commands cmd,
7976 					   enum nl80211_attrs attr,
7977 					   unsigned int portid,
7978 					   int vendor_event_idx,
7979 					   int approxlen, gfp_t gfp);
7980 
7981 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
7982 
7983 /**
7984  * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
7985  * @wiphy: the wiphy
7986  * @approxlen: an upper bound of the length of the data that will
7987  *	be put into the skb
7988  *
7989  * This function allocates and pre-fills an skb for a reply to
7990  * a vendor command. Since it is intended for a reply, calling
7991  * it outside of a vendor command's doit() operation is invalid.
7992  *
7993  * The returned skb is pre-filled with some identifying data in
7994  * a way that any data that is put into the skb (with skb_put(),
7995  * nla_put() or similar) will end up being within the
7996  * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
7997  * with the skb is adding data for the corresponding userspace tool
7998  * which can then read that data out of the vendor data attribute.
7999  * You must not modify the skb in any other way.
8000  *
8001  * When done, call cfg80211_vendor_cmd_reply() with the skb and return
8002  * its error code as the result of the doit() operation.
8003  *
8004  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
8005  */
8006 static inline struct sk_buff *
8007 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
8008 {
8009 	return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
8010 					  NL80211_ATTR_VENDOR_DATA, approxlen);
8011 }
8012 
8013 /**
8014  * cfg80211_vendor_cmd_reply - send the reply skb
8015  * @skb: The skb, must have been allocated with
8016  *	cfg80211_vendor_cmd_alloc_reply_skb()
8017  *
8018  * Since calling this function will usually be the last thing
8019  * before returning from the vendor command doit() you should
8020  * return the error code.  Note that this function consumes the
8021  * skb regardless of the return value.
8022  *
8023  * Return: An error code or 0 on success.
8024  */
8025 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
8026 
8027 /**
8028  * cfg80211_vendor_cmd_get_sender - get the current sender netlink ID
8029  * @wiphy: the wiphy
8030  *
8031  * Return: the current netlink port ID in a vendor command handler.
8032  *
8033  * Context: May only be called from a vendor command handler
8034  */
8035 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
8036 
8037 /**
8038  * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
8039  * @wiphy: the wiphy
8040  * @wdev: the wireless device
8041  * @event_idx: index of the vendor event in the wiphy's vendor_events
8042  * @approxlen: an upper bound of the length of the data that will
8043  *	be put into the skb
8044  * @gfp: allocation flags
8045  *
8046  * This function allocates and pre-fills an skb for an event on the
8047  * vendor-specific multicast group.
8048  *
8049  * If wdev != NULL, both the ifindex and identifier of the specified
8050  * wireless device are added to the event message before the vendor data
8051  * attribute.
8052  *
8053  * When done filling the skb, call cfg80211_vendor_event() with the
8054  * skb to send the event.
8055  *
8056  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
8057  */
8058 static inline struct sk_buff *
8059 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
8060 			     int approxlen, int event_idx, gfp_t gfp)
8061 {
8062 	return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
8063 					  NL80211_ATTR_VENDOR_DATA,
8064 					  0, event_idx, approxlen, gfp);
8065 }
8066 
8067 /**
8068  * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
8069  * @wiphy: the wiphy
8070  * @wdev: the wireless device
8071  * @event_idx: index of the vendor event in the wiphy's vendor_events
8072  * @portid: port ID of the receiver
8073  * @approxlen: an upper bound of the length of the data that will
8074  *	be put into the skb
8075  * @gfp: allocation flags
8076  *
8077  * This function allocates and pre-fills an skb for an event to send to
8078  * a specific (userland) socket. This socket would previously have been
8079  * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
8080  * care to register a netlink notifier to see when the socket closes.
8081  *
8082  * If wdev != NULL, both the ifindex and identifier of the specified
8083  * wireless device are added to the event message before the vendor data
8084  * attribute.
8085  *
8086  * When done filling the skb, call cfg80211_vendor_event() with the
8087  * skb to send the event.
8088  *
8089  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
8090  */
8091 static inline struct sk_buff *
8092 cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
8093 				  struct wireless_dev *wdev,
8094 				  unsigned int portid, int approxlen,
8095 				  int event_idx, gfp_t gfp)
8096 {
8097 	return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
8098 					  NL80211_ATTR_VENDOR_DATA,
8099 					  portid, event_idx, approxlen, gfp);
8100 }
8101 
8102 /**
8103  * cfg80211_vendor_event - send the event
8104  * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
8105  * @gfp: allocation flags
8106  *
8107  * This function sends the given @skb, which must have been allocated
8108  * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
8109  */
8110 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
8111 {
8112 	__cfg80211_send_event_skb(skb, gfp);
8113 }
8114 
8115 #ifdef CONFIG_NL80211_TESTMODE
8116 /**
8117  * DOC: Test mode
8118  *
8119  * Test mode is a set of utility functions to allow drivers to
8120  * interact with driver-specific tools to aid, for instance,
8121  * factory programming.
8122  *
8123  * This chapter describes how drivers interact with it. For more
8124  * information see the nl80211 book's chapter on it.
8125  */
8126 
8127 /**
8128  * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
8129  * @wiphy: the wiphy
8130  * @approxlen: an upper bound of the length of the data that will
8131  *	be put into the skb
8132  *
8133  * This function allocates and pre-fills an skb for a reply to
8134  * the testmode command. Since it is intended for a reply, calling
8135  * it outside of the @testmode_cmd operation is invalid.
8136  *
8137  * The returned skb is pre-filled with the wiphy index and set up in
8138  * a way that any data that is put into the skb (with skb_put(),
8139  * nla_put() or similar) will end up being within the
8140  * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
8141  * with the skb is adding data for the corresponding userspace tool
8142  * which can then read that data out of the testdata attribute. You
8143  * must not modify the skb in any other way.
8144  *
8145  * When done, call cfg80211_testmode_reply() with the skb and return
8146  * its error code as the result of the @testmode_cmd operation.
8147  *
8148  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
8149  */
8150 static inline struct sk_buff *
8151 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
8152 {
8153 	return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
8154 					  NL80211_ATTR_TESTDATA, approxlen);
8155 }
8156 
8157 /**
8158  * cfg80211_testmode_reply - send the reply skb
8159  * @skb: The skb, must have been allocated with
8160  *	cfg80211_testmode_alloc_reply_skb()
8161  *
8162  * Since calling this function will usually be the last thing
8163  * before returning from the @testmode_cmd you should return
8164  * the error code.  Note that this function consumes the skb
8165  * regardless of the return value.
8166  *
8167  * Return: An error code or 0 on success.
8168  */
8169 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
8170 {
8171 	return cfg80211_vendor_cmd_reply(skb);
8172 }
8173 
8174 /**
8175  * cfg80211_testmode_alloc_event_skb - allocate testmode event
8176  * @wiphy: the wiphy
8177  * @approxlen: an upper bound of the length of the data that will
8178  *	be put into the skb
8179  * @gfp: allocation flags
8180  *
8181  * This function allocates and pre-fills an skb for an event on the
8182  * testmode multicast group.
8183  *
8184  * The returned skb is set up in the same way as with
8185  * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
8186  * there, you should simply add data to it that will then end up in the
8187  * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
8188  * in any other way.
8189  *
8190  * When done filling the skb, call cfg80211_testmode_event() with the
8191  * skb to send the event.
8192  *
8193  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
8194  */
8195 static inline struct sk_buff *
8196 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
8197 {
8198 	return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
8199 					  NL80211_ATTR_TESTDATA, 0, -1,
8200 					  approxlen, gfp);
8201 }
8202 
8203 /**
8204  * cfg80211_testmode_event - send the event
8205  * @skb: The skb, must have been allocated with
8206  *	cfg80211_testmode_alloc_event_skb()
8207  * @gfp: allocation flags
8208  *
8209  * This function sends the given @skb, which must have been allocated
8210  * by cfg80211_testmode_alloc_event_skb(), as an event. It always
8211  * consumes it.
8212  */
8213 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
8214 {
8215 	__cfg80211_send_event_skb(skb, gfp);
8216 }
8217 
8218 #define CFG80211_TESTMODE_CMD(cmd)	.testmode_cmd = (cmd),
8219 #define CFG80211_TESTMODE_DUMP(cmd)	.testmode_dump = (cmd),
8220 #else
8221 #define CFG80211_TESTMODE_CMD(cmd)
8222 #define CFG80211_TESTMODE_DUMP(cmd)
8223 #endif
8224 
8225 /**
8226  * struct cfg80211_fils_resp_params - FILS connection response params
8227  * @kek: KEK derived from a successful FILS connection (may be %NULL)
8228  * @kek_len: Length of @fils_kek in octets
8229  * @update_erp_next_seq_num: Boolean value to specify whether the value in
8230  *	@erp_next_seq_num is valid.
8231  * @erp_next_seq_num: The next sequence number to use in ERP message in
8232  *	FILS Authentication. This value should be specified irrespective of the
8233  *	status for a FILS connection.
8234  * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
8235  * @pmk_len: Length of @pmk in octets
8236  * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
8237  *	used for this FILS connection (may be %NULL).
8238  */
8239 struct cfg80211_fils_resp_params {
8240 	const u8 *kek;
8241 	size_t kek_len;
8242 	bool update_erp_next_seq_num;
8243 	u16 erp_next_seq_num;
8244 	const u8 *pmk;
8245 	size_t pmk_len;
8246 	const u8 *pmkid;
8247 };
8248 
8249 /**
8250  * struct cfg80211_connect_resp_params - Connection response params
8251  * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
8252  *	%WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
8253  *	the real status code for failures. If this call is used to report a
8254  *	failure due to a timeout (e.g., not receiving an Authentication frame
8255  *	from the AP) instead of an explicit rejection by the AP, -1 is used to
8256  *	indicate that this is a failure, but without a status code.
8257  *	@timeout_reason is used to report the reason for the timeout in that
8258  *	case.
8259  * @req_ie: Association request IEs (may be %NULL)
8260  * @req_ie_len: Association request IEs length
8261  * @resp_ie: Association response IEs (may be %NULL)
8262  * @resp_ie_len: Association response IEs length
8263  * @fils: FILS connection response parameters.
8264  * @timeout_reason: Reason for connection timeout. This is used when the
8265  *	connection fails due to a timeout instead of an explicit rejection from
8266  *	the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
8267  *	not known. This value is used only if @status < 0 to indicate that the
8268  *	failure is due to a timeout and not due to explicit rejection by the AP.
8269  *	This value is ignored in other cases (@status >= 0).
8270  * @valid_links: For MLO connection, BIT mask of the valid link ids. Otherwise
8271  *	zero.
8272  * @ap_mld_addr: For MLO connection, MLD address of the AP. Otherwise %NULL.
8273  * @links : For MLO connection, contains link info for the valid links indicated
8274  *	using @valid_links. For non-MLO connection, links[0] contains the
8275  *	connected AP info.
8276  * @links.addr: For MLO connection, MAC address of the STA link. Otherwise
8277  *	%NULL.
8278  * @links.bssid: For MLO connection, MAC address of the AP link. For non-MLO
8279  *	connection, links[0].bssid points to the BSSID of the AP (may be %NULL).
8280  * @links.bss: For MLO connection, entry of bss to which STA link is connected.
8281  *	For non-MLO connection, links[0].bss points to entry of bss to which STA
8282  *	is connected. It can be obtained through cfg80211_get_bss() (may be
8283  *	%NULL). It is recommended to store the bss from the connect_request and
8284  *	hold a reference to it and return through this param to avoid a warning
8285  *	if the bss is expired during the connection, esp. for those drivers
8286  *	implementing connect op. Only one parameter among @bssid and @bss needs
8287  *	to be specified.
8288  * @links.status: per-link status code, to report a status code that's not
8289  *	%WLAN_STATUS_SUCCESS for a given link, it must also be in the
8290  *	@valid_links bitmap and may have a BSS pointer (which is then released)
8291  */
8292 struct cfg80211_connect_resp_params {
8293 	int status;
8294 	const u8 *req_ie;
8295 	size_t req_ie_len;
8296 	const u8 *resp_ie;
8297 	size_t resp_ie_len;
8298 	struct cfg80211_fils_resp_params fils;
8299 	enum nl80211_timeout_reason timeout_reason;
8300 
8301 	const u8 *ap_mld_addr;
8302 	u16 valid_links;
8303 	struct {
8304 		const u8 *addr;
8305 		const u8 *bssid;
8306 		struct cfg80211_bss *bss;
8307 		u16 status;
8308 	} links[IEEE80211_MLD_MAX_NUM_LINKS];
8309 };
8310 
8311 /**
8312  * cfg80211_connect_done - notify cfg80211 of connection result
8313  *
8314  * @dev: network device
8315  * @params: connection response parameters
8316  * @gfp: allocation flags
8317  *
8318  * It should be called by the underlying driver once execution of the connection
8319  * request from connect() has been completed. This is similar to
8320  * cfg80211_connect_bss(), but takes a structure pointer for connection response
8321  * parameters. Only one of the functions among cfg80211_connect_bss(),
8322  * cfg80211_connect_result(), cfg80211_connect_timeout(),
8323  * and cfg80211_connect_done() should be called.
8324  */
8325 void cfg80211_connect_done(struct net_device *dev,
8326 			   struct cfg80211_connect_resp_params *params,
8327 			   gfp_t gfp);
8328 
8329 /**
8330  * cfg80211_connect_bss - notify cfg80211 of connection result
8331  *
8332  * @dev: network device
8333  * @bssid: the BSSID of the AP
8334  * @bss: Entry of bss to which STA got connected to, can be obtained through
8335  *	cfg80211_get_bss() (may be %NULL). But it is recommended to store the
8336  *	bss from the connect_request and hold a reference to it and return
8337  *	through this param to avoid a warning if the bss is expired during the
8338  *	connection, esp. for those drivers implementing connect op.
8339  *	Only one parameter among @bssid and @bss needs to be specified.
8340  * @req_ie: association request IEs (maybe be %NULL)
8341  * @req_ie_len: association request IEs length
8342  * @resp_ie: association response IEs (may be %NULL)
8343  * @resp_ie_len: assoc response IEs length
8344  * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
8345  *	%WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
8346  *	the real status code for failures. If this call is used to report a
8347  *	failure due to a timeout (e.g., not receiving an Authentication frame
8348  *	from the AP) instead of an explicit rejection by the AP, -1 is used to
8349  *	indicate that this is a failure, but without a status code.
8350  *	@timeout_reason is used to report the reason for the timeout in that
8351  *	case.
8352  * @gfp: allocation flags
8353  * @timeout_reason: reason for connection timeout. This is used when the
8354  *	connection fails due to a timeout instead of an explicit rejection from
8355  *	the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
8356  *	not known. This value is used only if @status < 0 to indicate that the
8357  *	failure is due to a timeout and not due to explicit rejection by the AP.
8358  *	This value is ignored in other cases (@status >= 0).
8359  *
8360  * It should be called by the underlying driver once execution of the connection
8361  * request from connect() has been completed. This is similar to
8362  * cfg80211_connect_result(), but with the option of identifying the exact bss
8363  * entry for the connection. Only one of the functions among
8364  * cfg80211_connect_bss(), cfg80211_connect_result(),
8365  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
8366  */
8367 static inline void
8368 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
8369 		     struct cfg80211_bss *bss, const u8 *req_ie,
8370 		     size_t req_ie_len, const u8 *resp_ie,
8371 		     size_t resp_ie_len, int status, gfp_t gfp,
8372 		     enum nl80211_timeout_reason timeout_reason)
8373 {
8374 	struct cfg80211_connect_resp_params params;
8375 
8376 	memset(&params, 0, sizeof(params));
8377 	params.status = status;
8378 	params.links[0].bssid = bssid;
8379 	params.links[0].bss = bss;
8380 	params.req_ie = req_ie;
8381 	params.req_ie_len = req_ie_len;
8382 	params.resp_ie = resp_ie;
8383 	params.resp_ie_len = resp_ie_len;
8384 	params.timeout_reason = timeout_reason;
8385 
8386 	cfg80211_connect_done(dev, &params, gfp);
8387 }
8388 
8389 /**
8390  * cfg80211_connect_result - notify cfg80211 of connection result
8391  *
8392  * @dev: network device
8393  * @bssid: the BSSID of the AP
8394  * @req_ie: association request IEs (maybe be %NULL)
8395  * @req_ie_len: association request IEs length
8396  * @resp_ie: association response IEs (may be %NULL)
8397  * @resp_ie_len: assoc response IEs length
8398  * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
8399  *	%WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
8400  *	the real status code for failures.
8401  * @gfp: allocation flags
8402  *
8403  * It should be called by the underlying driver once execution of the connection
8404  * request from connect() has been completed. This is similar to
8405  * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
8406  * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
8407  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
8408  */
8409 static inline void
8410 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
8411 			const u8 *req_ie, size_t req_ie_len,
8412 			const u8 *resp_ie, size_t resp_ie_len,
8413 			u16 status, gfp_t gfp)
8414 {
8415 	cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
8416 			     resp_ie_len, status, gfp,
8417 			     NL80211_TIMEOUT_UNSPECIFIED);
8418 }
8419 
8420 /**
8421  * cfg80211_connect_timeout - notify cfg80211 of connection timeout
8422  *
8423  * @dev: network device
8424  * @bssid: the BSSID of the AP
8425  * @req_ie: association request IEs (maybe be %NULL)
8426  * @req_ie_len: association request IEs length
8427  * @gfp: allocation flags
8428  * @timeout_reason: reason for connection timeout.
8429  *
8430  * It should be called by the underlying driver whenever connect() has failed
8431  * in a sequence where no explicit authentication/association rejection was
8432  * received from the AP. This could happen, e.g., due to not being able to send
8433  * out the Authentication or Association Request frame or timing out while
8434  * waiting for the response. Only one of the functions among
8435  * cfg80211_connect_bss(), cfg80211_connect_result(),
8436  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
8437  */
8438 static inline void
8439 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
8440 			 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
8441 			 enum nl80211_timeout_reason timeout_reason)
8442 {
8443 	cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
8444 			     gfp, timeout_reason);
8445 }
8446 
8447 /**
8448  * struct cfg80211_roam_info - driver initiated roaming information
8449  *
8450  * @req_ie: association request IEs (maybe be %NULL)
8451  * @req_ie_len: association request IEs length
8452  * @resp_ie: association response IEs (may be %NULL)
8453  * @resp_ie_len: assoc response IEs length
8454  * @fils: FILS related roaming information.
8455  * @valid_links: For MLO roaming, BIT mask of the new valid links is set.
8456  *	Otherwise zero.
8457  * @ap_mld_addr: For MLO roaming, MLD address of the new AP. Otherwise %NULL.
8458  * @links : For MLO roaming, contains new link info for the valid links set in
8459  *	@valid_links. For non-MLO roaming, links[0] contains the new AP info.
8460  * @links.addr: For MLO roaming, MAC address of the STA link. Otherwise %NULL.
8461  * @links.bssid: For MLO roaming, MAC address of the new AP link. For non-MLO
8462  *	roaming, links[0].bssid points to the BSSID of the new AP. May be
8463  *	%NULL if %links.bss is set.
8464  * @links.channel: the channel of the new AP.
8465  * @links.bss: For MLO roaming, entry of new bss to which STA link got
8466  *	roamed. For non-MLO roaming, links[0].bss points to entry of bss to
8467  *	which STA got roamed (may be %NULL if %links.bssid is set)
8468  */
8469 struct cfg80211_roam_info {
8470 	const u8 *req_ie;
8471 	size_t req_ie_len;
8472 	const u8 *resp_ie;
8473 	size_t resp_ie_len;
8474 	struct cfg80211_fils_resp_params fils;
8475 
8476 	const u8 *ap_mld_addr;
8477 	u16 valid_links;
8478 	struct {
8479 		const u8 *addr;
8480 		const u8 *bssid;
8481 		struct ieee80211_channel *channel;
8482 		struct cfg80211_bss *bss;
8483 	} links[IEEE80211_MLD_MAX_NUM_LINKS];
8484 };
8485 
8486 /**
8487  * cfg80211_roamed - notify cfg80211 of roaming
8488  *
8489  * @dev: network device
8490  * @info: information about the new BSS. struct &cfg80211_roam_info.
8491  * @gfp: allocation flags
8492  *
8493  * This function may be called with the driver passing either the BSSID of the
8494  * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
8495  * It should be called by the underlying driver whenever it roamed from one AP
8496  * to another while connected. Drivers which have roaming implemented in
8497  * firmware should pass the bss entry to avoid a race in bss entry timeout where
8498  * the bss entry of the new AP is seen in the driver, but gets timed out by the
8499  * time it is accessed in __cfg80211_roamed() due to delay in scheduling
8500  * rdev->event_work. In case of any failures, the reference is released
8501  * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
8502  * released while disconnecting from the current bss.
8503  */
8504 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
8505 		     gfp_t gfp);
8506 
8507 /**
8508  * cfg80211_port_authorized - notify cfg80211 of successful security association
8509  *
8510  * @dev: network device
8511  * @peer_addr: BSSID of the AP/P2P GO in case of STA/GC or STA/GC MAC address
8512  *	in case of AP/P2P GO
8513  * @td_bitmap: transition disable policy
8514  * @td_bitmap_len: Length of transition disable policy
8515  * @gfp: allocation flags
8516  *
8517  * This function should be called by a driver that supports 4 way handshake
8518  * offload after a security association was successfully established (i.e.,
8519  * the 4 way handshake was completed successfully). The call to this function
8520  * should be preceded with a call to cfg80211_connect_result(),
8521  * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
8522  * indicate the 802.11 association.
8523  * This function can also be called by AP/P2P GO driver that supports
8524  * authentication offload. In this case the peer_mac passed is that of
8525  * associated STA/GC.
8526  */
8527 void cfg80211_port_authorized(struct net_device *dev, const u8 *peer_addr,
8528 			      const u8* td_bitmap, u8 td_bitmap_len, gfp_t gfp);
8529 
8530 /**
8531  * cfg80211_disconnected - notify cfg80211 that connection was dropped
8532  *
8533  * @dev: network device
8534  * @ie: information elements of the deauth/disassoc frame (may be %NULL)
8535  * @ie_len: length of IEs
8536  * @reason: reason code for the disconnection, set it to 0 if unknown
8537  * @locally_generated: disconnection was requested locally
8538  * @gfp: allocation flags
8539  *
8540  * After it calls this function, the driver should enter an idle state
8541  * and not try to connect to any AP any more.
8542  */
8543 void cfg80211_disconnected(struct net_device *dev, u16 reason,
8544 			   const u8 *ie, size_t ie_len,
8545 			   bool locally_generated, gfp_t gfp);
8546 
8547 /**
8548  * cfg80211_ready_on_channel - notification of remain_on_channel start
8549  * @wdev: wireless device
8550  * @cookie: the request cookie
8551  * @chan: The current channel (from remain_on_channel request)
8552  * @duration: Duration in milliseconds that the driver intents to remain on the
8553  *	channel
8554  * @gfp: allocation flags
8555  */
8556 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
8557 			       struct ieee80211_channel *chan,
8558 			       unsigned int duration, gfp_t gfp);
8559 
8560 /**
8561  * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
8562  * @wdev: wireless device
8563  * @cookie: the request cookie
8564  * @chan: The current channel (from remain_on_channel request)
8565  * @gfp: allocation flags
8566  */
8567 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
8568 					struct ieee80211_channel *chan,
8569 					gfp_t gfp);
8570 
8571 /**
8572  * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
8573  * @wdev: wireless device
8574  * @cookie: the requested cookie
8575  * @chan: The current channel (from tx_mgmt request)
8576  * @gfp: allocation flags
8577  */
8578 void cfg80211_tx_mgmt_expired(struct wireless_dev *wdev, u64 cookie,
8579 			      struct ieee80211_channel *chan, gfp_t gfp);
8580 
8581 /**
8582  * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
8583  *
8584  * @sinfo: the station information
8585  * @gfp: allocation flags
8586  *
8587  * Return: 0 on success. Non-zero on error.
8588  */
8589 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
8590 
8591 /**
8592  * cfg80211_link_sinfo_alloc_tid_stats - allocate per-tid statistics.
8593  *
8594  * @link_sinfo: the link station information
8595  * @gfp: allocation flags
8596  *
8597  * Return: 0 on success. Non-zero on error.
8598  */
8599 int cfg80211_link_sinfo_alloc_tid_stats(struct link_station_info *link_sinfo,
8600 					gfp_t gfp);
8601 
8602 /**
8603  * cfg80211_sinfo_release_content - release contents of station info
8604  * @sinfo: the station information
8605  *
8606  * Releases any potentially allocated sub-information of the station
8607  * information, but not the struct itself (since it's typically on
8608  * the stack.)
8609  */
8610 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
8611 {
8612 	kfree(sinfo->pertid);
8613 
8614 	for (int link_id = 0; link_id < ARRAY_SIZE(sinfo->links); link_id++) {
8615 		if (sinfo->links[link_id]) {
8616 			kfree(sinfo->links[link_id]->pertid);
8617 			kfree(sinfo->links[link_id]);
8618 		}
8619 	}
8620 }
8621 
8622 /**
8623  * cfg80211_new_sta - notify userspace about station
8624  *
8625  * @dev: the netdev
8626  * @mac_addr: the station's address
8627  * @sinfo: the station information
8628  * @gfp: allocation flags
8629  */
8630 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
8631 		      struct station_info *sinfo, gfp_t gfp);
8632 
8633 /**
8634  * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
8635  * @dev: the netdev
8636  * @mac_addr: the station's address. For MLD station, MLD address is used.
8637  * @sinfo: the station information/statistics
8638  * @gfp: allocation flags
8639  */
8640 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
8641 			    struct station_info *sinfo, gfp_t gfp);
8642 
8643 /**
8644  * cfg80211_del_sta - notify userspace about deletion of a station
8645  *
8646  * @dev: the netdev
8647  * @mac_addr: the station's address. For MLD station, MLD address is used.
8648  * @gfp: allocation flags
8649  */
8650 static inline void cfg80211_del_sta(struct net_device *dev,
8651 				    const u8 *mac_addr, gfp_t gfp)
8652 {
8653 	cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
8654 }
8655 
8656 /**
8657  * cfg80211_conn_failed - connection request failed notification
8658  *
8659  * @dev: the netdev
8660  * @mac_addr: the station's address
8661  * @reason: the reason for connection failure
8662  * @gfp: allocation flags
8663  *
8664  * Whenever a station tries to connect to an AP and if the station
8665  * could not connect to the AP as the AP has rejected the connection
8666  * for some reasons, this function is called.
8667  *
8668  * The reason for connection failure can be any of the value from
8669  * nl80211_connect_failed_reason enum
8670  */
8671 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
8672 			  enum nl80211_connect_failed_reason reason,
8673 			  gfp_t gfp);
8674 
8675 /**
8676  * struct cfg80211_rx_info - received management frame info
8677  *
8678  * @freq: Frequency on which the frame was received in kHz
8679  * @sig_dbm: signal strength in dBm, or 0 if unknown
8680  * @have_link_id: indicates the frame was received on a link of
8681  *	an MLD, i.e. the @link_id field is valid
8682  * @link_id: the ID of the link the frame was received	on
8683  * @buf: Management frame (header + body)
8684  * @len: length of the frame data
8685  * @flags: flags, as defined in &enum nl80211_rxmgmt_flags
8686  * @rx_tstamp: Hardware timestamp of frame RX in nanoseconds
8687  * @ack_tstamp: Hardware timestamp of ack TX in nanoseconds
8688  */
8689 struct cfg80211_rx_info {
8690 	int freq;
8691 	int sig_dbm;
8692 	bool have_link_id;
8693 	u8 link_id;
8694 	const u8 *buf;
8695 	size_t len;
8696 	u32 flags;
8697 	u64 rx_tstamp;
8698 	u64 ack_tstamp;
8699 };
8700 
8701 /**
8702  * cfg80211_rx_mgmt_ext - management frame notification with extended info
8703  * @wdev: wireless device receiving the frame
8704  * @info: RX info as defined in struct cfg80211_rx_info
8705  *
8706  * This function is called whenever an Action frame is received for a station
8707  * mode interface, but is not processed in kernel.
8708  *
8709  * Return: %true if a user space application has registered for this frame.
8710  * For action frames, that makes it responsible for rejecting unrecognized
8711  * action frames; %false otherwise, in which case for action frames the
8712  * driver is responsible for rejecting the frame.
8713  */
8714 bool cfg80211_rx_mgmt_ext(struct wireless_dev *wdev,
8715 			  struct cfg80211_rx_info *info);
8716 
8717 /**
8718  * cfg80211_rx_mgmt_khz - notification of received, unprocessed management frame
8719  * @wdev: wireless device receiving the frame
8720  * @freq: Frequency on which the frame was received in KHz
8721  * @sig_dbm: signal strength in dBm, or 0 if unknown
8722  * @buf: Management frame (header + body)
8723  * @len: length of the frame data
8724  * @flags: flags, as defined in enum nl80211_rxmgmt_flags
8725  *
8726  * This function is called whenever an Action frame is received for a station
8727  * mode interface, but is not processed in kernel.
8728  *
8729  * Return: %true if a user space application has registered for this frame.
8730  * For action frames, that makes it responsible for rejecting unrecognized
8731  * action frames; %false otherwise, in which case for action frames the
8732  * driver is responsible for rejecting the frame.
8733  */
8734 static inline bool cfg80211_rx_mgmt_khz(struct wireless_dev *wdev, int freq,
8735 					int sig_dbm, const u8 *buf, size_t len,
8736 					u32 flags)
8737 {
8738 	struct cfg80211_rx_info info = {
8739 		.freq = freq,
8740 		.sig_dbm = sig_dbm,
8741 		.buf = buf,
8742 		.len = len,
8743 		.flags = flags
8744 	};
8745 
8746 	return cfg80211_rx_mgmt_ext(wdev, &info);
8747 }
8748 
8749 /**
8750  * cfg80211_rx_mgmt - notification of received, unprocessed management frame
8751  * @wdev: wireless device receiving the frame
8752  * @freq: Frequency on which the frame was received in MHz
8753  * @sig_dbm: signal strength in dBm, or 0 if unknown
8754  * @buf: Management frame (header + body)
8755  * @len: length of the frame data
8756  * @flags: flags, as defined in enum nl80211_rxmgmt_flags
8757  *
8758  * This function is called whenever an Action frame is received for a station
8759  * mode interface, but is not processed in kernel.
8760  *
8761  * Return: %true if a user space application has registered for this frame.
8762  * For action frames, that makes it responsible for rejecting unrecognized
8763  * action frames; %false otherwise, in which case for action frames the
8764  * driver is responsible for rejecting the frame.
8765  */
8766 static inline bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq,
8767 				    int sig_dbm, const u8 *buf, size_t len,
8768 				    u32 flags)
8769 {
8770 	struct cfg80211_rx_info info = {
8771 		.freq = MHZ_TO_KHZ(freq),
8772 		.sig_dbm = sig_dbm,
8773 		.buf = buf,
8774 		.len = len,
8775 		.flags = flags
8776 	};
8777 
8778 	return cfg80211_rx_mgmt_ext(wdev, &info);
8779 }
8780 
8781 /**
8782  * struct cfg80211_tx_status - TX status for management frame information
8783  *
8784  * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
8785  * @tx_tstamp: hardware TX timestamp in nanoseconds
8786  * @ack_tstamp: hardware ack RX timestamp in nanoseconds
8787  * @buf: Management frame (header + body)
8788  * @len: length of the frame data
8789  * @ack: Whether frame was acknowledged
8790  */
8791 struct cfg80211_tx_status {
8792 	u64 cookie;
8793 	u64 tx_tstamp;
8794 	u64 ack_tstamp;
8795 	const u8 *buf;
8796 	size_t len;
8797 	bool ack;
8798 };
8799 
8800 /**
8801  * cfg80211_mgmt_tx_status_ext - TX status notification with extended info
8802  * @wdev: wireless device receiving the frame
8803  * @status: TX status data
8804  * @gfp: context flags
8805  *
8806  * This function is called whenever a management frame was requested to be
8807  * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
8808  * transmission attempt with extended info.
8809  */
8810 void cfg80211_mgmt_tx_status_ext(struct wireless_dev *wdev,
8811 				 struct cfg80211_tx_status *status, gfp_t gfp);
8812 
8813 /**
8814  * cfg80211_mgmt_tx_status - notification of TX status for management frame
8815  * @wdev: wireless device receiving the frame
8816  * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
8817  * @buf: Management frame (header + body)
8818  * @len: length of the frame data
8819  * @ack: Whether frame was acknowledged
8820  * @gfp: context flags
8821  *
8822  * This function is called whenever a management frame was requested to be
8823  * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
8824  * transmission attempt.
8825  */
8826 static inline void cfg80211_mgmt_tx_status(struct wireless_dev *wdev,
8827 					   u64 cookie, const u8 *buf,
8828 					   size_t len, bool ack, gfp_t gfp)
8829 {
8830 	struct cfg80211_tx_status status = {
8831 		.cookie = cookie,
8832 		.buf = buf,
8833 		.len = len,
8834 		.ack = ack
8835 	};
8836 
8837 	cfg80211_mgmt_tx_status_ext(wdev, &status, gfp);
8838 }
8839 
8840 /**
8841  * cfg80211_control_port_tx_status - notification of TX status for control
8842  *                                   port frames
8843  * @wdev: wireless device receiving the frame
8844  * @cookie: Cookie returned by cfg80211_ops::tx_control_port()
8845  * @buf: Data frame (header + body)
8846  * @len: length of the frame data
8847  * @ack: Whether frame was acknowledged
8848  * @gfp: context flags
8849  *
8850  * This function is called whenever a control port frame was requested to be
8851  * transmitted with cfg80211_ops::tx_control_port() to report the TX status of
8852  * the transmission attempt.
8853  */
8854 void cfg80211_control_port_tx_status(struct wireless_dev *wdev, u64 cookie,
8855 				     const u8 *buf, size_t len, bool ack,
8856 				     gfp_t gfp);
8857 
8858 /**
8859  * cfg80211_rx_control_port - notification about a received control port frame
8860  * @dev: The device the frame matched to
8861  * @skb: The skbuf with the control port frame.  It is assumed that the skbuf
8862  *	is 802.3 formatted (with 802.3 header).  The skb can be non-linear.
8863  *	This function does not take ownership of the skb, so the caller is
8864  *	responsible for any cleanup.  The caller must also ensure that
8865  *	skb->protocol is set appropriately.
8866  * @unencrypted: Whether the frame was received unencrypted
8867  * @link_id: the link the frame was received on, -1 if not applicable or unknown
8868  *
8869  * This function is used to inform userspace about a received control port
8870  * frame.  It should only be used if userspace indicated it wants to receive
8871  * control port frames over nl80211.
8872  *
8873  * The frame is the data portion of the 802.3 or 802.11 data frame with all
8874  * network layer headers removed (e.g. the raw EAPoL frame).
8875  *
8876  * Return: %true if the frame was passed to userspace
8877  */
8878 bool cfg80211_rx_control_port(struct net_device *dev, struct sk_buff *skb,
8879 			      bool unencrypted, int link_id);
8880 
8881 /**
8882  * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
8883  * @dev: network device
8884  * @rssi_event: the triggered RSSI event
8885  * @rssi_level: new RSSI level value or 0 if not available
8886  * @gfp: context flags
8887  *
8888  * This function is called when a configured connection quality monitoring
8889  * rssi threshold reached event occurs.
8890  */
8891 void cfg80211_cqm_rssi_notify(struct net_device *dev,
8892 			      enum nl80211_cqm_rssi_threshold_event rssi_event,
8893 			      s32 rssi_level, gfp_t gfp);
8894 
8895 /**
8896  * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
8897  * @dev: network device
8898  * @peer: peer's MAC address
8899  * @num_packets: how many packets were lost -- should be a fixed threshold
8900  *	but probably no less than maybe 50, or maybe a throughput dependent
8901  *	threshold (to account for temporary interference)
8902  * @gfp: context flags
8903  */
8904 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
8905 				 const u8 *peer, u32 num_packets, gfp_t gfp);
8906 
8907 /**
8908  * cfg80211_cqm_txe_notify - TX error rate event
8909  * @dev: network device
8910  * @peer: peer's MAC address
8911  * @num_packets: how many packets were lost
8912  * @rate: % of packets which failed transmission
8913  * @intvl: interval (in s) over which the TX failure threshold was breached.
8914  * @gfp: context flags
8915  *
8916  * Notify userspace when configured % TX failures over number of packets in a
8917  * given interval is exceeded.
8918  */
8919 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
8920 			     u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
8921 
8922 /**
8923  * cfg80211_cqm_beacon_loss_notify - beacon loss event
8924  * @dev: network device
8925  * @gfp: context flags
8926  *
8927  * Notify userspace about beacon loss from the connected AP.
8928  */
8929 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
8930 
8931 /**
8932  * __cfg80211_radar_event - radar detection event
8933  * @wiphy: the wiphy
8934  * @chandef: chandef for the current channel
8935  * @offchan: the radar has been detected on the offchannel chain
8936  * @gfp: context flags
8937  *
8938  * This function is called when a radar is detected on the current chanenl.
8939  */
8940 void __cfg80211_radar_event(struct wiphy *wiphy,
8941 			    struct cfg80211_chan_def *chandef,
8942 			    bool offchan, gfp_t gfp);
8943 
8944 static inline void
8945 cfg80211_radar_event(struct wiphy *wiphy,
8946 		     struct cfg80211_chan_def *chandef,
8947 		     gfp_t gfp)
8948 {
8949 	__cfg80211_radar_event(wiphy, chandef, false, gfp);
8950 }
8951 
8952 static inline void
8953 cfg80211_background_radar_event(struct wiphy *wiphy,
8954 				struct cfg80211_chan_def *chandef,
8955 				gfp_t gfp)
8956 {
8957 	__cfg80211_radar_event(wiphy, chandef, true, gfp);
8958 }
8959 
8960 /**
8961  * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
8962  * @dev: network device
8963  * @mac: MAC address of a station which opmode got modified
8964  * @sta_opmode: station's current opmode value
8965  * @gfp: context flags
8966  *
8967  * Driver should call this function when station's opmode modified via action
8968  * frame.
8969  */
8970 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
8971 				       struct sta_opmode_info *sta_opmode,
8972 				       gfp_t gfp);
8973 
8974 /**
8975  * cfg80211_cac_event - Channel availability check (CAC) event
8976  * @netdev: network device
8977  * @chandef: chandef for the current channel
8978  * @event: type of event
8979  * @gfp: context flags
8980  * @link_id: valid link_id for MLO operation or 0 otherwise.
8981  *
8982  * This function is called when a Channel availability check (CAC) is finished
8983  * or aborted. This must be called to notify the completion of a CAC process,
8984  * also by full-MAC drivers.
8985  */
8986 void cfg80211_cac_event(struct net_device *netdev,
8987 			const struct cfg80211_chan_def *chandef,
8988 			enum nl80211_radar_event event, gfp_t gfp,
8989 			unsigned int link_id);
8990 
8991 /**
8992  * cfg80211_background_cac_abort - Channel Availability Check offchan abort event
8993  * @wiphy: the wiphy
8994  *
8995  * This function is called by the driver when a Channel Availability Check
8996  * (CAC) is aborted by a offchannel dedicated chain.
8997  */
8998 void cfg80211_background_cac_abort(struct wiphy *wiphy);
8999 
9000 /**
9001  * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
9002  * @dev: network device
9003  * @bssid: BSSID of AP (to avoid races)
9004  * @replay_ctr: new replay counter
9005  * @gfp: allocation flags
9006  */
9007 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
9008 			       const u8 *replay_ctr, gfp_t gfp);
9009 
9010 /**
9011  * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
9012  * @dev: network device
9013  * @index: candidate index (the smaller the index, the higher the priority)
9014  * @bssid: BSSID of AP
9015  * @preauth: Whether AP advertises support for RSN pre-authentication
9016  * @gfp: allocation flags
9017  */
9018 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
9019 				     const u8 *bssid, bool preauth, gfp_t gfp);
9020 
9021 /**
9022  * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
9023  * @dev: The device the frame matched to
9024  * @addr: the transmitter address
9025  * @gfp: context flags
9026  *
9027  * This function is used in AP mode (only!) to inform userspace that
9028  * a spurious class 3 frame was received, to be able to deauth the
9029  * sender.
9030  * Return: %true if the frame was passed to userspace (or this failed
9031  * for a reason other than not having a subscription.)
9032  */
9033 bool cfg80211_rx_spurious_frame(struct net_device *dev,
9034 				const u8 *addr, gfp_t gfp);
9035 
9036 /**
9037  * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
9038  * @dev: The device the frame matched to
9039  * @addr: the transmitter address
9040  * @gfp: context flags
9041  *
9042  * This function is used in AP mode (only!) to inform userspace that
9043  * an associated station sent a 4addr frame but that wasn't expected.
9044  * It is allowed and desirable to send this event only once for each
9045  * station to avoid event flooding.
9046  * Return: %true if the frame was passed to userspace (or this failed
9047  * for a reason other than not having a subscription.)
9048  */
9049 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
9050 					const u8 *addr, gfp_t gfp);
9051 
9052 /**
9053  * cfg80211_probe_status - notify userspace about probe status
9054  * @dev: the device the probe was sent on
9055  * @addr: the address of the peer
9056  * @cookie: the cookie filled in @probe_client previously
9057  * @acked: indicates whether probe was acked or not
9058  * @ack_signal: signal strength (in dBm) of the ACK frame.
9059  * @is_valid_ack_signal: indicates the ack_signal is valid or not.
9060  * @gfp: allocation flags
9061  */
9062 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
9063 			   u64 cookie, bool acked, s32 ack_signal,
9064 			   bool is_valid_ack_signal, gfp_t gfp);
9065 
9066 /**
9067  * cfg80211_report_obss_beacon_khz - report beacon from other APs
9068  * @wiphy: The wiphy that received the beacon
9069  * @frame: the frame
9070  * @len: length of the frame
9071  * @freq: frequency the frame was received on in KHz
9072  * @sig_dbm: signal strength in dBm, or 0 if unknown
9073  *
9074  * Use this function to report to userspace when a beacon was
9075  * received. It is not useful to call this when there is no
9076  * netdev that is in AP/GO mode.
9077  */
9078 void cfg80211_report_obss_beacon_khz(struct wiphy *wiphy, const u8 *frame,
9079 				     size_t len, int freq, int sig_dbm);
9080 
9081 /**
9082  * cfg80211_report_obss_beacon - report beacon from other APs
9083  * @wiphy: The wiphy that received the beacon
9084  * @frame: the frame
9085  * @len: length of the frame
9086  * @freq: frequency the frame was received on
9087  * @sig_dbm: signal strength in dBm, or 0 if unknown
9088  *
9089  * Use this function to report to userspace when a beacon was
9090  * received. It is not useful to call this when there is no
9091  * netdev that is in AP/GO mode.
9092  */
9093 static inline void cfg80211_report_obss_beacon(struct wiphy *wiphy,
9094 					       const u8 *frame, size_t len,
9095 					       int freq, int sig_dbm)
9096 {
9097 	cfg80211_report_obss_beacon_khz(wiphy, frame, len, MHZ_TO_KHZ(freq),
9098 					sig_dbm);
9099 }
9100 
9101 /**
9102  * struct cfg80211_beaconing_check_config - beacon check configuration
9103  * @iftype: the interface type to check for
9104  * @relax: allow IR-relaxation conditions to apply (e.g. another
9105  *	interface connected already on the same channel)
9106  *	NOTE: If this is set, wiphy mutex must be held.
9107  * @reg_power: &enum ieee80211_ap_reg_power value indicating the
9108  *	advertised/used 6 GHz regulatory power setting
9109  */
9110 struct cfg80211_beaconing_check_config {
9111 	enum nl80211_iftype iftype;
9112 	enum ieee80211_ap_reg_power reg_power;
9113 	bool relax;
9114 };
9115 
9116 /**
9117  * cfg80211_reg_check_beaconing - check if beaconing is allowed
9118  * @wiphy: the wiphy
9119  * @chandef: the channel definition
9120  * @cfg: additional parameters for the checking
9121  *
9122  * Return: %true if there is no secondary channel or the secondary channel(s)
9123  * can be used for beaconing (i.e. is not a radar channel etc.)
9124  */
9125 bool cfg80211_reg_check_beaconing(struct wiphy *wiphy,
9126 				  struct cfg80211_chan_def *chandef,
9127 				  struct cfg80211_beaconing_check_config *cfg);
9128 
9129 /**
9130  * cfg80211_reg_can_beacon - check if beaconing is allowed
9131  * @wiphy: the wiphy
9132  * @chandef: the channel definition
9133  * @iftype: interface type
9134  *
9135  * Return: %true if there is no secondary channel or the secondary channel(s)
9136  * can be used for beaconing (i.e. is not a radar channel etc.)
9137  */
9138 static inline bool
9139 cfg80211_reg_can_beacon(struct wiphy *wiphy,
9140 			struct cfg80211_chan_def *chandef,
9141 			enum nl80211_iftype iftype)
9142 {
9143 	struct cfg80211_beaconing_check_config config = {
9144 		.iftype = iftype,
9145 	};
9146 
9147 	return cfg80211_reg_check_beaconing(wiphy, chandef, &config);
9148 }
9149 
9150 /**
9151  * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
9152  * @wiphy: the wiphy
9153  * @chandef: the channel definition
9154  * @iftype: interface type
9155  *
9156  * Return: %true if there is no secondary channel or the secondary channel(s)
9157  * can be used for beaconing (i.e. is not a radar channel etc.). This version
9158  * also checks if IR-relaxation conditions apply, to allow beaconing under
9159  * more permissive conditions.
9160  *
9161  * Context: Requires the wiphy mutex to be held.
9162  */
9163 static inline bool
9164 cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
9165 			      struct cfg80211_chan_def *chandef,
9166 			      enum nl80211_iftype iftype)
9167 {
9168 	struct cfg80211_beaconing_check_config config = {
9169 		.iftype = iftype,
9170 		.relax = true,
9171 	};
9172 
9173 	return cfg80211_reg_check_beaconing(wiphy, chandef, &config);
9174 }
9175 
9176 /**
9177  * cfg80211_ch_switch_notify - update wdev channel and notify userspace
9178  * @dev: the device which switched channels
9179  * @chandef: the new channel definition
9180  * @link_id: the link ID for MLO, must be 0 for non-MLO
9181  *
9182  * Caller must hold wiphy mutex, therefore must only be called from sleepable
9183  * driver context!
9184  */
9185 void cfg80211_ch_switch_notify(struct net_device *dev,
9186 			       struct cfg80211_chan_def *chandef,
9187 			       unsigned int link_id);
9188 
9189 /**
9190  * cfg80211_ch_switch_started_notify - notify channel switch start
9191  * @dev: the device on which the channel switch started
9192  * @chandef: the future channel definition
9193  * @link_id: the link ID for MLO, must be 0 for non-MLO
9194  * @count: the number of TBTTs until the channel switch happens
9195  * @quiet: whether or not immediate quiet was requested by the AP
9196  *
9197  * Inform the userspace about the channel switch that has just
9198  * started, so that it can take appropriate actions (eg. starting
9199  * channel switch on other vifs), if necessary.
9200  */
9201 void cfg80211_ch_switch_started_notify(struct net_device *dev,
9202 				       struct cfg80211_chan_def *chandef,
9203 				       unsigned int link_id, u8 count,
9204 				       bool quiet);
9205 
9206 /**
9207  * ieee80211_operating_class_to_band - convert operating class to band
9208  *
9209  * @operating_class: the operating class to convert
9210  * @band: band pointer to fill
9211  *
9212  * Return: %true if the conversion was successful, %false otherwise.
9213  */
9214 bool ieee80211_operating_class_to_band(u8 operating_class,
9215 				       enum nl80211_band *band);
9216 
9217 /**
9218  * ieee80211_operating_class_to_chandef - convert operating class to chandef
9219  *
9220  * @operating_class: the operating class to convert
9221  * @chan: the ieee80211_channel to convert
9222  * @chandef: a pointer to the resulting chandef
9223  *
9224  * Return: %true if the conversion was successful, %false otherwise.
9225  */
9226 bool ieee80211_operating_class_to_chandef(u8 operating_class,
9227 					  struct ieee80211_channel *chan,
9228 					  struct cfg80211_chan_def *chandef);
9229 
9230 /**
9231  * ieee80211_chandef_to_operating_class - convert chandef to operation class
9232  *
9233  * @chandef: the chandef to convert
9234  * @op_class: a pointer to the resulting operating class
9235  *
9236  * Return: %true if the conversion was successful, %false otherwise.
9237  */
9238 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
9239 					  u8 *op_class);
9240 
9241 /**
9242  * ieee80211_chandef_to_khz - convert chandef to frequency in KHz
9243  *
9244  * @chandef: the chandef to convert
9245  *
9246  * Return: the center frequency of chandef (1st segment) in KHz.
9247  */
9248 static inline u32
9249 ieee80211_chandef_to_khz(const struct cfg80211_chan_def *chandef)
9250 {
9251 	return MHZ_TO_KHZ(chandef->center_freq1) + chandef->freq1_offset;
9252 }
9253 
9254 /**
9255  * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
9256  * @dev: the device on which the operation is requested
9257  * @peer: the MAC address of the peer device
9258  * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
9259  *	NL80211_TDLS_TEARDOWN)
9260  * @reason_code: the reason code for teardown request
9261  * @gfp: allocation flags
9262  *
9263  * This function is used to request userspace to perform TDLS operation that
9264  * requires knowledge of keys, i.e., link setup or teardown when the AP
9265  * connection uses encryption. This is optional mechanism for the driver to use
9266  * if it can automatically determine when a TDLS link could be useful (e.g.,
9267  * based on traffic and signal strength for a peer).
9268  */
9269 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
9270 				enum nl80211_tdls_operation oper,
9271 				u16 reason_code, gfp_t gfp);
9272 
9273 /**
9274  * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
9275  * @rate: given rate_info to calculate bitrate from
9276  *
9277  * Return: calculated bitrate
9278  */
9279 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
9280 
9281 /**
9282  * cfg80211_unregister_wdev - remove the given wdev
9283  * @wdev: struct wireless_dev to remove
9284  *
9285  * This function removes the device so it can no longer be used. It is necessary
9286  * to call this function even when cfg80211 requests the removal of the device
9287  * by calling the del_virtual_intf() callback. The function must also be called
9288  * when the driver wishes to unregister the wdev, e.g. when the hardware device
9289  * is unbound from the driver.
9290  *
9291  * Context: Requires the RTNL and wiphy mutex to be held.
9292  */
9293 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
9294 
9295 /**
9296  * cfg80211_register_netdevice - register the given netdev
9297  * @dev: the netdev to register
9298  *
9299  * Note: In contexts coming from cfg80211 callbacks, you must call this rather
9300  * than register_netdevice(), unregister_netdev() is impossible as the RTNL is
9301  * held. Otherwise, both register_netdevice() and register_netdev() are usable
9302  * instead as well.
9303  *
9304  * Context: Requires the RTNL and wiphy mutex to be held.
9305  *
9306  * Return: 0 on success. Non-zero on error.
9307  */
9308 int cfg80211_register_netdevice(struct net_device *dev);
9309 
9310 /**
9311  * cfg80211_unregister_netdevice - unregister the given netdev
9312  * @dev: the netdev to register
9313  *
9314  * Note: In contexts coming from cfg80211 callbacks, you must call this rather
9315  * than unregister_netdevice(), unregister_netdev() is impossible as the RTNL
9316  * is held. Otherwise, both unregister_netdevice() and unregister_netdev() are
9317  * usable instead as well.
9318  *
9319  * Context: Requires the RTNL and wiphy mutex to be held.
9320  */
9321 static inline void cfg80211_unregister_netdevice(struct net_device *dev)
9322 {
9323 #if IS_ENABLED(CONFIG_CFG80211)
9324 	cfg80211_unregister_wdev(dev->ieee80211_ptr);
9325 #endif
9326 }
9327 
9328 /**
9329  * struct cfg80211_ft_event_params - FT Information Elements
9330  * @ies: FT IEs
9331  * @ies_len: length of the FT IE in bytes
9332  * @target_ap: target AP's MAC address
9333  * @ric_ies: RIC IE
9334  * @ric_ies_len: length of the RIC IE in bytes
9335  */
9336 struct cfg80211_ft_event_params {
9337 	const u8 *ies;
9338 	size_t ies_len;
9339 	const u8 *target_ap;
9340 	const u8 *ric_ies;
9341 	size_t ric_ies_len;
9342 };
9343 
9344 /**
9345  * cfg80211_ft_event - notify userspace about FT IE and RIC IE
9346  * @netdev: network device
9347  * @ft_event: IE information
9348  */
9349 void cfg80211_ft_event(struct net_device *netdev,
9350 		       struct cfg80211_ft_event_params *ft_event);
9351 
9352 /**
9353  * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
9354  * @ies: the input IE buffer
9355  * @len: the input length
9356  * @attr: the attribute ID to find
9357  * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
9358  *	if the function is only called to get the needed buffer size
9359  * @bufsize: size of the output buffer
9360  *
9361  * The function finds a given P2P attribute in the (vendor) IEs and
9362  * copies its contents to the given buffer.
9363  *
9364  * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
9365  * malformed or the attribute can't be found (respectively), or the
9366  * length of the found attribute (which can be zero).
9367  */
9368 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
9369 			  enum ieee80211_p2p_attr_id attr,
9370 			  u8 *buf, unsigned int bufsize);
9371 
9372 /**
9373  * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
9374  * @ies: the IE buffer
9375  * @ielen: the length of the IE buffer
9376  * @ids: an array with element IDs that are allowed before
9377  *	the split. A WLAN_EID_EXTENSION value means that the next
9378  *	EID in the list is a sub-element of the EXTENSION IE.
9379  * @n_ids: the size of the element ID array
9380  * @after_ric: array IE types that come after the RIC element
9381  * @n_after_ric: size of the @after_ric array
9382  * @offset: offset where to start splitting in the buffer
9383  *
9384  * This function splits an IE buffer by updating the @offset
9385  * variable to point to the location where the buffer should be
9386  * split.
9387  *
9388  * It assumes that the given IE buffer is well-formed, this
9389  * has to be guaranteed by the caller!
9390  *
9391  * It also assumes that the IEs in the buffer are ordered
9392  * correctly, if not the result of using this function will not
9393  * be ordered correctly either, i.e. it does no reordering.
9394  *
9395  * Return: The offset where the next part of the buffer starts, which
9396  * may be @ielen if the entire (remainder) of the buffer should be
9397  * used.
9398  */
9399 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
9400 			      const u8 *ids, int n_ids,
9401 			      const u8 *after_ric, int n_after_ric,
9402 			      size_t offset);
9403 
9404 /**
9405  * ieee80211_ie_split - split an IE buffer according to ordering
9406  * @ies: the IE buffer
9407  * @ielen: the length of the IE buffer
9408  * @ids: an array with element IDs that are allowed before
9409  *	the split. A WLAN_EID_EXTENSION value means that the next
9410  *	EID in the list is a sub-element of the EXTENSION IE.
9411  * @n_ids: the size of the element ID array
9412  * @offset: offset where to start splitting in the buffer
9413  *
9414  * This function splits an IE buffer by updating the @offset
9415  * variable to point to the location where the buffer should be
9416  * split.
9417  *
9418  * It assumes that the given IE buffer is well-formed, this
9419  * has to be guaranteed by the caller!
9420  *
9421  * It also assumes that the IEs in the buffer are ordered
9422  * correctly, if not the result of using this function will not
9423  * be ordered correctly either, i.e. it does no reordering.
9424  *
9425  * Return: The offset where the next part of the buffer starts, which
9426  * may be @ielen if the entire (remainder) of the buffer should be
9427  * used.
9428  */
9429 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
9430 					const u8 *ids, int n_ids, size_t offset)
9431 {
9432 	return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
9433 }
9434 
9435 /**
9436  * ieee80211_fragment_element - fragment the last element in skb
9437  * @skb: The skbuf that the element was added to
9438  * @len_pos: Pointer to length of the element to fragment
9439  * @frag_id: The element ID to use for fragments
9440  *
9441  * This function fragments all data after @len_pos, adding fragmentation
9442  * elements with the given ID as appropriate. The SKB will grow in size
9443  * accordingly.
9444  */
9445 void ieee80211_fragment_element(struct sk_buff *skb, u8 *len_pos, u8 frag_id);
9446 
9447 /**
9448  * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
9449  * @wdev: the wireless device reporting the wakeup
9450  * @wakeup: the wakeup report
9451  * @gfp: allocation flags
9452  *
9453  * This function reports that the given device woke up. If it
9454  * caused the wakeup, report the reason(s), otherwise you may
9455  * pass %NULL as the @wakeup parameter to advertise that something
9456  * else caused the wakeup.
9457  */
9458 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
9459 				   struct cfg80211_wowlan_wakeup *wakeup,
9460 				   gfp_t gfp);
9461 
9462 /**
9463  * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
9464  *
9465  * @wdev: the wireless device for which critical protocol is stopped.
9466  * @gfp: allocation flags
9467  *
9468  * This function can be called by the driver to indicate it has reverted
9469  * operation back to normal. One reason could be that the duration given
9470  * by .crit_proto_start() has expired.
9471  */
9472 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
9473 
9474 /**
9475  * ieee80211_get_num_supported_channels - get number of channels device has
9476  * @wiphy: the wiphy
9477  *
9478  * Return: the number of channels supported by the device.
9479  */
9480 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
9481 
9482 /**
9483  * cfg80211_check_combinations - check interface combinations
9484  *
9485  * @wiphy: the wiphy
9486  * @params: the interface combinations parameter
9487  *
9488  * This function can be called by the driver to check whether a
9489  * combination of interfaces and their types are allowed according to
9490  * the interface combinations.
9491  *
9492  * Return: 0 if combinations are allowed. Non-zero on error.
9493  */
9494 int cfg80211_check_combinations(struct wiphy *wiphy,
9495 				struct iface_combination_params *params);
9496 
9497 /**
9498  * cfg80211_iter_combinations - iterate over matching combinations
9499  *
9500  * @wiphy: the wiphy
9501  * @params: the interface combinations parameter
9502  * @iter: function to call for each matching combination
9503  * @data: pointer to pass to iter function
9504  *
9505  * This function can be called by the driver to check what possible
9506  * combinations it fits in at a given moment, e.g. for channel switching
9507  * purposes.
9508  *
9509  * Return: 0 on success. Non-zero on error.
9510  */
9511 int cfg80211_iter_combinations(struct wiphy *wiphy,
9512 			       struct iface_combination_params *params,
9513 			       void (*iter)(const struct ieee80211_iface_combination *c,
9514 					    void *data),
9515 			       void *data);
9516 /**
9517  * cfg80211_get_radio_idx_by_chan - get the radio index by the channel
9518  *
9519  * @wiphy: the wiphy
9520  * @chan: channel for which the supported radio index is required
9521  *
9522  * Return: radio index on success or a negative error code
9523  */
9524 int cfg80211_get_radio_idx_by_chan(struct wiphy *wiphy,
9525 				   const struct ieee80211_channel *chan);
9526 
9527 
9528 /**
9529  * cfg80211_stop_iface - trigger interface disconnection
9530  *
9531  * @wiphy: the wiphy
9532  * @wdev: wireless device
9533  * @gfp: context flags
9534  *
9535  * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
9536  * disconnected.
9537  *
9538  * Note: This doesn't need any locks and is asynchronous.
9539  */
9540 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
9541 			 gfp_t gfp);
9542 
9543 /**
9544  * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
9545  * @wiphy: the wiphy to shut down
9546  *
9547  * This function shuts down all interfaces belonging to this wiphy by
9548  * calling dev_close() (and treating non-netdev interfaces as needed).
9549  * It shouldn't really be used unless there are some fatal device errors
9550  * that really can't be recovered in any other way.
9551  *
9552  * Callers must hold the RTNL and be able to deal with callbacks into
9553  * the driver while the function is running.
9554  */
9555 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
9556 
9557 /**
9558  * wiphy_ext_feature_set - set the extended feature flag
9559  *
9560  * @wiphy: the wiphy to modify.
9561  * @ftidx: extended feature bit index.
9562  *
9563  * The extended features are flagged in multiple bytes (see
9564  * &struct wiphy.@ext_features)
9565  */
9566 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
9567 					 enum nl80211_ext_feature_index ftidx)
9568 {
9569 	u8 *ft_byte;
9570 
9571 	ft_byte = &wiphy->ext_features[ftidx / 8];
9572 	*ft_byte |= BIT(ftidx % 8);
9573 }
9574 
9575 /**
9576  * wiphy_ext_feature_isset - check the extended feature flag
9577  *
9578  * @wiphy: the wiphy to modify.
9579  * @ftidx: extended feature bit index.
9580  *
9581  * The extended features are flagged in multiple bytes (see
9582  * &struct wiphy.@ext_features)
9583  *
9584  * Return: %true if extended feature flag is set, %false otherwise
9585  */
9586 static inline bool
9587 wiphy_ext_feature_isset(struct wiphy *wiphy,
9588 			enum nl80211_ext_feature_index ftidx)
9589 {
9590 	u8 ft_byte;
9591 
9592 	ft_byte = wiphy->ext_features[ftidx / 8];
9593 	return (ft_byte & BIT(ftidx % 8)) != 0;
9594 }
9595 
9596 /**
9597  * cfg80211_free_nan_func - free NAN function
9598  * @f: NAN function that should be freed
9599  *
9600  * Frees all the NAN function and all it's allocated members.
9601  */
9602 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
9603 
9604 /**
9605  * struct cfg80211_nan_match_params - NAN match parameters
9606  * @type: the type of the function that triggered a match. If it is
9607  *	 %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
9608  *	 If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
9609  *	 result.
9610  *	 If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
9611  * @inst_id: the local instance id
9612  * @peer_inst_id: the instance id of the peer's function
9613  * @addr: the MAC address of the peer
9614  * @info_len: the length of the &info
9615  * @info: the Service Specific Info from the peer (if any)
9616  * @cookie: unique identifier of the corresponding function
9617  */
9618 struct cfg80211_nan_match_params {
9619 	enum nl80211_nan_function_type type;
9620 	u8 inst_id;
9621 	u8 peer_inst_id;
9622 	const u8 *addr;
9623 	u8 info_len;
9624 	const u8 *info;
9625 	u64 cookie;
9626 };
9627 
9628 /**
9629  * cfg80211_nan_match - report a match for a NAN function.
9630  * @wdev: the wireless device reporting the match
9631  * @match: match notification parameters
9632  * @gfp: allocation flags
9633  *
9634  * This function reports that the a NAN function had a match. This
9635  * can be a subscribe that had a match or a solicited publish that
9636  * was sent. It can also be a follow up that was received.
9637  */
9638 void cfg80211_nan_match(struct wireless_dev *wdev,
9639 			struct cfg80211_nan_match_params *match, gfp_t gfp);
9640 
9641 /**
9642  * cfg80211_nan_func_terminated - notify about NAN function termination.
9643  *
9644  * @wdev: the wireless device reporting the match
9645  * @inst_id: the local instance id
9646  * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
9647  * @cookie: unique NAN function identifier
9648  * @gfp: allocation flags
9649  *
9650  * This function reports that the a NAN function is terminated.
9651  */
9652 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
9653 				  u8 inst_id,
9654 				  enum nl80211_nan_func_term_reason reason,
9655 				  u64 cookie, gfp_t gfp);
9656 
9657 /* ethtool helper */
9658 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
9659 
9660 /**
9661  * cfg80211_external_auth_request - userspace request for authentication
9662  * @netdev: network device
9663  * @params: External authentication parameters
9664  * @gfp: allocation flags
9665  * Returns: 0 on success, < 0 on error
9666  */
9667 int cfg80211_external_auth_request(struct net_device *netdev,
9668 				   struct cfg80211_external_auth_params *params,
9669 				   gfp_t gfp);
9670 
9671 /**
9672  * cfg80211_pmsr_report - report peer measurement result data
9673  * @wdev: the wireless device reporting the measurement
9674  * @req: the original measurement request
9675  * @result: the result data
9676  * @gfp: allocation flags
9677  */
9678 void cfg80211_pmsr_report(struct wireless_dev *wdev,
9679 			  struct cfg80211_pmsr_request *req,
9680 			  struct cfg80211_pmsr_result *result,
9681 			  gfp_t gfp);
9682 
9683 /**
9684  * cfg80211_pmsr_complete - report peer measurement completed
9685  * @wdev: the wireless device reporting the measurement
9686  * @req: the original measurement request
9687  * @gfp: allocation flags
9688  *
9689  * Report that the entire measurement completed, after this
9690  * the request pointer will no longer be valid.
9691  */
9692 void cfg80211_pmsr_complete(struct wireless_dev *wdev,
9693 			    struct cfg80211_pmsr_request *req,
9694 			    gfp_t gfp);
9695 
9696 /**
9697  * cfg80211_iftype_allowed - check whether the interface can be allowed
9698  * @wiphy: the wiphy
9699  * @iftype: interface type
9700  * @is_4addr: use_4addr flag, must be '0' when check_swif is '1'
9701  * @check_swif: check iftype against software interfaces
9702  *
9703  * Check whether the interface is allowed to operate; additionally, this API
9704  * can be used to check iftype against the software interfaces when
9705  * check_swif is '1'.
9706  *
9707  * Return: %true if allowed, %false otherwise
9708  */
9709 bool cfg80211_iftype_allowed(struct wiphy *wiphy, enum nl80211_iftype iftype,
9710 			     bool is_4addr, u8 check_swif);
9711 
9712 
9713 /**
9714  * cfg80211_assoc_comeback - notification of association that was
9715  * temporarily rejected with a comeback
9716  * @netdev: network device
9717  * @ap_addr: AP (MLD) address that rejected the association
9718  * @timeout: timeout interval value TUs.
9719  *
9720  * this function may sleep. the caller must hold the corresponding wdev's mutex.
9721  */
9722 void cfg80211_assoc_comeback(struct net_device *netdev,
9723 			     const u8 *ap_addr, u32 timeout);
9724 
9725 /* Logging, debugging and troubleshooting/diagnostic helpers. */
9726 
9727 /* wiphy_printk helpers, similar to dev_printk */
9728 
9729 #define wiphy_printk(level, wiphy, format, args...)		\
9730 	dev_printk(level, &(wiphy)->dev, format, ##args)
9731 #define wiphy_emerg(wiphy, format, args...)			\
9732 	dev_emerg(&(wiphy)->dev, format, ##args)
9733 #define wiphy_alert(wiphy, format, args...)			\
9734 	dev_alert(&(wiphy)->dev, format, ##args)
9735 #define wiphy_crit(wiphy, format, args...)			\
9736 	dev_crit(&(wiphy)->dev, format, ##args)
9737 #define wiphy_err(wiphy, format, args...)			\
9738 	dev_err(&(wiphy)->dev, format, ##args)
9739 #define wiphy_warn(wiphy, format, args...)			\
9740 	dev_warn(&(wiphy)->dev, format, ##args)
9741 #define wiphy_notice(wiphy, format, args...)			\
9742 	dev_notice(&(wiphy)->dev, format, ##args)
9743 #define wiphy_info(wiphy, format, args...)			\
9744 	dev_info(&(wiphy)->dev, format, ##args)
9745 #define wiphy_info_once(wiphy, format, args...)			\
9746 	dev_info_once(&(wiphy)->dev, format, ##args)
9747 
9748 #define wiphy_err_ratelimited(wiphy, format, args...)		\
9749 	dev_err_ratelimited(&(wiphy)->dev, format, ##args)
9750 #define wiphy_warn_ratelimited(wiphy, format, args...)		\
9751 	dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
9752 
9753 #define wiphy_debug(wiphy, format, args...)			\
9754 	wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
9755 
9756 #define wiphy_dbg(wiphy, format, args...)			\
9757 	dev_dbg(&(wiphy)->dev, format, ##args)
9758 
9759 #if defined(VERBOSE_DEBUG)
9760 #define wiphy_vdbg	wiphy_dbg
9761 #else
9762 #define wiphy_vdbg(wiphy, format, args...)				\
9763 ({									\
9764 	if (0)								\
9765 		wiphy_printk(KERN_DEBUG, wiphy, format, ##args);	\
9766 	0;								\
9767 })
9768 #endif
9769 
9770 /*
9771  * wiphy_WARN() acts like wiphy_printk(), but with the key difference
9772  * of using a WARN/WARN_ON to get the message out, including the
9773  * file/line information and a backtrace.
9774  */
9775 #define wiphy_WARN(wiphy, format, args...)			\
9776 	WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
9777 
9778 /**
9779  * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
9780  * @netdev: network device
9781  * @owe_info: peer's owe info
9782  * @gfp: allocation flags
9783  */
9784 void cfg80211_update_owe_info_event(struct net_device *netdev,
9785 				    struct cfg80211_update_owe_info *owe_info,
9786 				    gfp_t gfp);
9787 
9788 /**
9789  * cfg80211_bss_flush - resets all the scan entries
9790  * @wiphy: the wiphy
9791  */
9792 void cfg80211_bss_flush(struct wiphy *wiphy);
9793 
9794 /**
9795  * cfg80211_bss_color_notify - notify about bss color event
9796  * @dev: network device
9797  * @cmd: the actual event we want to notify
9798  * @count: the number of TBTTs until the color change happens
9799  * @color_bitmap: representations of the colors that the local BSS is aware of
9800  * @link_id: valid link_id in case of MLO or 0 for non-MLO.
9801  *
9802  * Return: 0 on success. Non-zero on error.
9803  */
9804 int cfg80211_bss_color_notify(struct net_device *dev,
9805 			      enum nl80211_commands cmd, u8 count,
9806 			      u64 color_bitmap, u8 link_id);
9807 
9808 /**
9809  * cfg80211_obss_color_collision_notify - notify about bss color collision
9810  * @dev: network device
9811  * @color_bitmap: representations of the colors that the local BSS is aware of
9812  * @link_id: valid link_id in case of MLO or 0 for non-MLO.
9813  *
9814  * Return: 0 on success. Non-zero on error.
9815  */
9816 static inline int cfg80211_obss_color_collision_notify(struct net_device *dev,
9817 						       u64 color_bitmap,
9818 						       u8 link_id)
9819 {
9820 	return cfg80211_bss_color_notify(dev, NL80211_CMD_OBSS_COLOR_COLLISION,
9821 					 0, color_bitmap, link_id);
9822 }
9823 
9824 /**
9825  * cfg80211_color_change_started_notify - notify color change start
9826  * @dev: the device on which the color is switched
9827  * @count: the number of TBTTs until the color change happens
9828  * @link_id: valid link_id in case of MLO or 0 for non-MLO.
9829  *
9830  * Inform the userspace about the color change that has started.
9831  *
9832  * Return: 0 on success. Non-zero on error.
9833  */
9834 static inline int cfg80211_color_change_started_notify(struct net_device *dev,
9835 						       u8 count, u8 link_id)
9836 {
9837 	return cfg80211_bss_color_notify(dev, NL80211_CMD_COLOR_CHANGE_STARTED,
9838 					 count, 0, link_id);
9839 }
9840 
9841 /**
9842  * cfg80211_color_change_aborted_notify - notify color change abort
9843  * @dev: the device on which the color is switched
9844  * @link_id: valid link_id in case of MLO or 0 for non-MLO.
9845  *
9846  * Inform the userspace about the color change that has aborted.
9847  *
9848  * Return: 0 on success. Non-zero on error.
9849  */
9850 static inline int cfg80211_color_change_aborted_notify(struct net_device *dev,
9851 						       u8 link_id)
9852 {
9853 	return cfg80211_bss_color_notify(dev, NL80211_CMD_COLOR_CHANGE_ABORTED,
9854 					 0, 0, link_id);
9855 }
9856 
9857 /**
9858  * cfg80211_color_change_notify - notify color change completion
9859  * @dev: the device on which the color was switched
9860  * @link_id: valid link_id in case of MLO or 0 for non-MLO.
9861  *
9862  * Inform the userspace about the color change that has completed.
9863  *
9864  * Return: 0 on success. Non-zero on error.
9865  */
9866 static inline int cfg80211_color_change_notify(struct net_device *dev,
9867 					       u8 link_id)
9868 {
9869 	return cfg80211_bss_color_notify(dev,
9870 					 NL80211_CMD_COLOR_CHANGE_COMPLETED,
9871 					 0, 0, link_id);
9872 }
9873 
9874 /**
9875  * cfg80211_links_removed - Notify about removed STA MLD setup links.
9876  * @dev: network device.
9877  * @link_mask: BIT mask of removed STA MLD setup link IDs.
9878  *
9879  * Inform cfg80211 and the userspace about removed STA MLD setup links due to
9880  * AP MLD removing the corresponding affiliated APs with Multi-Link
9881  * reconfiguration. Note that it's not valid to remove all links, in this
9882  * case disconnect instead.
9883  * Also note that the wdev mutex must be held.
9884  */
9885 void cfg80211_links_removed(struct net_device *dev, u16 link_mask);
9886 
9887 /**
9888  * struct cfg80211_mlo_reconf_done_data - MLO reconfiguration data
9889  * @buf: MLO Reconfiguration Response frame (header + body)
9890  * @len: length of the frame data
9891  * @driver_initiated: Indicates whether the add links request is initiated by
9892  *	driver. This is set to true when the link reconfiguration request
9893  *	initiated by driver due to AP link recommendation requests
9894  *	(Ex: BTM (BSS Transition Management) request) handling offloaded to
9895  *	driver.
9896  * @added_links: BIT mask of links successfully added to the association
9897  * @links: per-link information indexed by link ID
9898  * @links.bss: the BSS that MLO reconfiguration was requested for, ownership of
9899  *      the pointer moves to cfg80211 in the call to
9900  *      cfg80211_mlo_reconf_add_done().
9901  *
9902  * The BSS pointer must be set for each link for which 'add' operation was
9903  * requested in the assoc_ml_reconf callback.
9904  */
9905 struct cfg80211_mlo_reconf_done_data {
9906 	const u8 *buf;
9907 	size_t len;
9908 	bool driver_initiated;
9909 	u16 added_links;
9910 	struct {
9911 		struct cfg80211_bss *bss;
9912 		u8 *addr;
9913 	} links[IEEE80211_MLD_MAX_NUM_LINKS];
9914 };
9915 
9916 /**
9917  * cfg80211_mlo_reconf_add_done - Notify about MLO reconfiguration result
9918  * @dev: network device.
9919  * @data: MLO reconfiguration done data, &struct cfg80211_mlo_reconf_done_data
9920  *
9921  * Inform cfg80211 and the userspace that processing of ML reconfiguration
9922  * request to add links to the association is done.
9923  */
9924 void cfg80211_mlo_reconf_add_done(struct net_device *dev,
9925 				  struct cfg80211_mlo_reconf_done_data *data);
9926 
9927 /**
9928  * cfg80211_schedule_channels_check - schedule regulatory check if needed
9929  * @wdev: the wireless device to check
9930  *
9931  * In case the device supports NO_IR or DFS relaxations, schedule regulatory
9932  * channels check, as previous concurrent operation conditions may not
9933  * hold anymore.
9934  */
9935 void cfg80211_schedule_channels_check(struct wireless_dev *wdev);
9936 
9937 /**
9938  * cfg80211_epcs_changed - Notify about a change in EPCS state
9939  * @netdev: the wireless device whose EPCS state changed
9940  * @enabled: set to true if EPCS was enabled, otherwise set to false.
9941  */
9942 void cfg80211_epcs_changed(struct net_device *netdev, bool enabled);
9943 
9944 #ifdef CONFIG_CFG80211_DEBUGFS
9945 /**
9946  * wiphy_locked_debugfs_read - do a locked read in debugfs
9947  * @wiphy: the wiphy to use
9948  * @file: the file being read
9949  * @buf: the buffer to fill and then read from
9950  * @bufsize: size of the buffer
9951  * @userbuf: the user buffer to copy to
9952  * @count: read count
9953  * @ppos: read position
9954  * @handler: the read handler to call (under wiphy lock)
9955  * @data: additional data to pass to the read handler
9956  *
9957  * Return: the number of characters read, or a negative errno
9958  */
9959 ssize_t wiphy_locked_debugfs_read(struct wiphy *wiphy, struct file *file,
9960 				  char *buf, size_t bufsize,
9961 				  char __user *userbuf, size_t count,
9962 				  loff_t *ppos,
9963 				  ssize_t (*handler)(struct wiphy *wiphy,
9964 						     struct file *file,
9965 						     char *buf,
9966 						     size_t bufsize,
9967 						     void *data),
9968 				  void *data);
9969 
9970 /**
9971  * wiphy_locked_debugfs_write - do a locked write in debugfs
9972  * @wiphy: the wiphy to use
9973  * @file: the file being written to
9974  * @buf: the buffer to copy the user data to
9975  * @bufsize: size of the buffer
9976  * @userbuf: the user buffer to copy from
9977  * @count: read count
9978  * @handler: the write handler to call (under wiphy lock)
9979  * @data: additional data to pass to the write handler
9980  *
9981  * Return: the number of characters written, or a negative errno
9982  */
9983 ssize_t wiphy_locked_debugfs_write(struct wiphy *wiphy, struct file *file,
9984 				   char *buf, size_t bufsize,
9985 				   const char __user *userbuf, size_t count,
9986 				   ssize_t (*handler)(struct wiphy *wiphy,
9987 						      struct file *file,
9988 						      char *buf,
9989 						      size_t count,
9990 						      void *data),
9991 				   void *data);
9992 #endif
9993 
9994 #endif /* __NET_CFG80211_H */
9995