xref: /linux/include/net/cfg80211.h (revision 566e8f108fc7847f2a8676ec6a101d37b7dd0fb4)
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  * @info: (internal) information about completed scan
2752  * @notified: (internal) scan request was notified as done or aborted
2753  * @no_cck: used to send probe requests at non CCK rate in 2GHz band
2754  * @mac_addr: MAC address used with randomisation
2755  * @mac_addr_mask: MAC address mask used with randomisation, bits that
2756  *	are 0 in the mask should be randomised, bits that are 1 should
2757  *	be taken from the @mac_addr
2758  * @scan_6ghz: relevant for split scan request only,
2759  *	true if this is the second scan request
2760  * @n_6ghz_params: number of 6 GHz params
2761  * @scan_6ghz_params: 6 GHz params
2762  * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
2763  * @tsf_report_link_id: for MLO, indicates the link ID of the BSS that should be
2764  *      used for TSF reporting. Can be set to -1 to indicate no preference.
2765  */
2766 struct cfg80211_scan_request {
2767 	struct cfg80211_ssid *ssids;
2768 	int n_ssids;
2769 	u32 n_channels;
2770 	const u8 *ie;
2771 	size_t ie_len;
2772 	u16 duration;
2773 	bool duration_mandatory;
2774 	u32 flags;
2775 
2776 	u32 rates[NUM_NL80211_BANDS];
2777 
2778 	struct wireless_dev *wdev;
2779 
2780 	u8 mac_addr[ETH_ALEN] __aligned(2);
2781 	u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2782 	u8 bssid[ETH_ALEN] __aligned(2);
2783 
2784 	/* internal */
2785 	struct wiphy *wiphy;
2786 	unsigned long scan_start;
2787 	struct cfg80211_scan_info info;
2788 	bool notified;
2789 	bool no_cck;
2790 	bool scan_6ghz;
2791 	u32 n_6ghz_params;
2792 	struct cfg80211_scan_6ghz_params *scan_6ghz_params;
2793 	s8 tsf_report_link_id;
2794 
2795 	/* keep last */
2796 	struct ieee80211_channel *channels[] __counted_by(n_channels);
2797 };
2798 
2799 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
2800 {
2801 	int i;
2802 
2803 	get_random_bytes(buf, ETH_ALEN);
2804 	for (i = 0; i < ETH_ALEN; i++) {
2805 		buf[i] &= ~mask[i];
2806 		buf[i] |= addr[i] & mask[i];
2807 	}
2808 }
2809 
2810 /**
2811  * struct cfg80211_match_set - sets of attributes to match
2812  *
2813  * @ssid: SSID to be matched; may be zero-length in case of BSSID match
2814  *	or no match (RSSI only)
2815  * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
2816  *	or no match (RSSI only)
2817  * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
2818  */
2819 struct cfg80211_match_set {
2820 	struct cfg80211_ssid ssid;
2821 	u8 bssid[ETH_ALEN];
2822 	s32 rssi_thold;
2823 };
2824 
2825 /**
2826  * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
2827  *
2828  * @interval: interval between scheduled scan iterations. In seconds.
2829  * @iterations: number of scan iterations in this scan plan. Zero means
2830  *	infinite loop.
2831  *	The last scan plan will always have this parameter set to zero,
2832  *	all other scan plans will have a finite number of iterations.
2833  */
2834 struct cfg80211_sched_scan_plan {
2835 	u32 interval;
2836 	u32 iterations;
2837 };
2838 
2839 /**
2840  * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
2841  *
2842  * @band: band of BSS which should match for RSSI level adjustment.
2843  * @delta: value of RSSI level adjustment.
2844  */
2845 struct cfg80211_bss_select_adjust {
2846 	enum nl80211_band band;
2847 	s8 delta;
2848 };
2849 
2850 /**
2851  * struct cfg80211_sched_scan_request - scheduled scan request description
2852  *
2853  * @reqid: identifies this request.
2854  * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
2855  * @n_ssids: number of SSIDs
2856  * @n_channels: total number of channels to scan
2857  * @ie: optional information element(s) to add into Probe Request or %NULL
2858  * @ie_len: length of ie in octets
2859  * @flags: control flags from &enum nl80211_scan_flags
2860  * @match_sets: sets of parameters to be matched for a scan result
2861  *	entry to be considered valid and to be passed to the host
2862  *	(others are filtered out).
2863  *	If omitted, all results are passed.
2864  * @n_match_sets: number of match sets
2865  * @report_results: indicates that results were reported for this request
2866  * @wiphy: the wiphy this was for
2867  * @dev: the interface
2868  * @scan_start: start time of the scheduled scan
2869  * @channels: channels to scan
2870  * @min_rssi_thold: for drivers only supporting a single threshold, this
2871  *	contains the minimum over all matchsets
2872  * @mac_addr: MAC address used with randomisation
2873  * @mac_addr_mask: MAC address mask used with randomisation, bits that
2874  *	are 0 in the mask should be randomised, bits that are 1 should
2875  *	be taken from the @mac_addr
2876  * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
2877  *	index must be executed first.
2878  * @n_scan_plans: number of scan plans, at least 1.
2879  * @rcu_head: RCU callback used to free the struct
2880  * @owner_nlportid: netlink portid of owner (if this should is a request
2881  *	owned by a particular socket)
2882  * @nl_owner_dead: netlink owner socket was closed - this request be freed
2883  * @list: for keeping list of requests.
2884  * @delay: delay in seconds to use before starting the first scan
2885  *	cycle.  The driver may ignore this parameter and start
2886  *	immediately (or at any other time), if this feature is not
2887  *	supported.
2888  * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
2889  * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
2890  *	reporting in connected state to cases where a matching BSS is determined
2891  *	to have better or slightly worse RSSI than the current connected BSS.
2892  *	The relative RSSI threshold values are ignored in disconnected state.
2893  * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
2894  *	to the specified band while deciding whether a better BSS is reported
2895  *	using @relative_rssi. If delta is a negative number, the BSSs that
2896  *	belong to the specified band will be penalized by delta dB in relative
2897  *	comparisons.
2898  */
2899 struct cfg80211_sched_scan_request {
2900 	u64 reqid;
2901 	struct cfg80211_ssid *ssids;
2902 	int n_ssids;
2903 	u32 n_channels;
2904 	const u8 *ie;
2905 	size_t ie_len;
2906 	u32 flags;
2907 	struct cfg80211_match_set *match_sets;
2908 	int n_match_sets;
2909 	s32 min_rssi_thold;
2910 	u32 delay;
2911 	struct cfg80211_sched_scan_plan *scan_plans;
2912 	int n_scan_plans;
2913 
2914 	u8 mac_addr[ETH_ALEN] __aligned(2);
2915 	u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2916 
2917 	bool relative_rssi_set;
2918 	s8 relative_rssi;
2919 	struct cfg80211_bss_select_adjust rssi_adjust;
2920 
2921 	/* internal */
2922 	struct wiphy *wiphy;
2923 	struct net_device *dev;
2924 	unsigned long scan_start;
2925 	bool report_results;
2926 	struct rcu_head rcu_head;
2927 	u32 owner_nlportid;
2928 	bool nl_owner_dead;
2929 	struct list_head list;
2930 
2931 	/* keep last */
2932 	struct ieee80211_channel *channels[] __counted_by(n_channels);
2933 };
2934 
2935 /**
2936  * enum cfg80211_signal_type - signal type
2937  *
2938  * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2939  * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2940  * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2941  */
2942 enum cfg80211_signal_type {
2943 	CFG80211_SIGNAL_TYPE_NONE,
2944 	CFG80211_SIGNAL_TYPE_MBM,
2945 	CFG80211_SIGNAL_TYPE_UNSPEC,
2946 };
2947 
2948 /**
2949  * struct cfg80211_inform_bss - BSS inform data
2950  * @chan: channel the frame was received on
2951  * @signal: signal strength value, according to the wiphy's
2952  *	signal type
2953  * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2954  *	received; should match the time when the frame was actually
2955  *	received by the device (not just by the host, in case it was
2956  *	buffered on the device) and be accurate to about 10ms.
2957  *	If the frame isn't buffered, just passing the return value of
2958  *	ktime_get_boottime_ns() is likely appropriate.
2959  * @parent_tsf: the time at the start of reception of the first octet of the
2960  *	timestamp field of the frame. The time is the TSF of the BSS specified
2961  *	by %parent_bssid.
2962  * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2963  *	the BSS that requested the scan in which the beacon/probe was received.
2964  * @chains: bitmask for filled values in @chain_signal.
2965  * @chain_signal: per-chain signal strength of last received BSS in dBm.
2966  * @restrict_use: restrict usage, if not set, assume @use_for is
2967  *	%NL80211_BSS_USE_FOR_NORMAL.
2968  * @use_for: bitmap of possible usage for this BSS, see
2969  *	&enum nl80211_bss_use_for
2970  * @cannot_use_reasons: the reasons (bitmap) for not being able to connect,
2971  *	if @restrict_use is set and @use_for is zero (empty); may be 0 for
2972  *	unspecified reasons; see &enum nl80211_bss_cannot_use_reasons
2973  * @drv_data: Data to be passed through to @inform_bss
2974  */
2975 struct cfg80211_inform_bss {
2976 	struct ieee80211_channel *chan;
2977 	s32 signal;
2978 	u64 boottime_ns;
2979 	u64 parent_tsf;
2980 	u8 parent_bssid[ETH_ALEN] __aligned(2);
2981 	u8 chains;
2982 	s8 chain_signal[IEEE80211_MAX_CHAINS];
2983 
2984 	u8 restrict_use:1, use_for:7;
2985 	u8 cannot_use_reasons;
2986 
2987 	void *drv_data;
2988 };
2989 
2990 /**
2991  * struct cfg80211_bss_ies - BSS entry IE data
2992  * @tsf: TSF contained in the frame that carried these IEs
2993  * @rcu_head: internal use, for freeing
2994  * @len: length of the IEs
2995  * @from_beacon: these IEs are known to come from a beacon
2996  * @data: IE data
2997  */
2998 struct cfg80211_bss_ies {
2999 	u64 tsf;
3000 	struct rcu_head rcu_head;
3001 	int len;
3002 	bool from_beacon;
3003 	u8 data[];
3004 };
3005 
3006 /**
3007  * struct cfg80211_bss - BSS description
3008  *
3009  * This structure describes a BSS (which may also be a mesh network)
3010  * for use in scan results and similar.
3011  *
3012  * @channel: channel this BSS is on
3013  * @bssid: BSSID of the BSS
3014  * @beacon_interval: the beacon interval as from the frame
3015  * @capability: the capability field in host byte order
3016  * @ies: the information elements (Note that there is no guarantee that these
3017  *	are well-formed!); this is a pointer to either the beacon_ies or
3018  *	proberesp_ies depending on whether Probe Response frame has been
3019  *	received. It is always non-%NULL.
3020  * @beacon_ies: the information elements from the last Beacon frame
3021  *	(implementation note: if @hidden_beacon_bss is set this struct doesn't
3022  *	own the beacon_ies, but they're just pointers to the ones from the
3023  *	@hidden_beacon_bss struct)
3024  * @proberesp_ies: the information elements from the last Probe Response frame
3025  * @proberesp_ecsa_stuck: ECSA element is stuck in the Probe Response frame,
3026  *	cannot rely on it having valid data
3027  * @hidden_beacon_bss: in case this BSS struct represents a probe response from
3028  *	a BSS that hides the SSID in its beacon, this points to the BSS struct
3029  *	that holds the beacon data. @beacon_ies is still valid, of course, and
3030  *	points to the same data as hidden_beacon_bss->beacon_ies in that case.
3031  * @transmitted_bss: pointer to the transmitted BSS, if this is a
3032  *	non-transmitted one (multi-BSSID support)
3033  * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
3034  *	(multi-BSSID support)
3035  * @signal: signal strength value (type depends on the wiphy's signal_type)
3036  * @ts_boottime: timestamp of the last BSS update in nanoseconds since boot
3037  * @chains: bitmask for filled values in @chain_signal.
3038  * @chain_signal: per-chain signal strength of last received BSS in dBm.
3039  * @bssid_index: index in the multiple BSS set
3040  * @max_bssid_indicator: max number of members in the BSS set
3041  * @use_for: bitmap of possible usage for this BSS, see
3042  *	&enum nl80211_bss_use_for
3043  * @cannot_use_reasons: the reasons (bitmap) for not being able to connect,
3044  *	if @restrict_use is set and @use_for is zero (empty); may be 0 for
3045  *	unspecified reasons; see &enum nl80211_bss_cannot_use_reasons
3046  * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
3047  */
3048 struct cfg80211_bss {
3049 	struct ieee80211_channel *channel;
3050 
3051 	const struct cfg80211_bss_ies __rcu *ies;
3052 	const struct cfg80211_bss_ies __rcu *beacon_ies;
3053 	const struct cfg80211_bss_ies __rcu *proberesp_ies;
3054 
3055 	struct cfg80211_bss *hidden_beacon_bss;
3056 	struct cfg80211_bss *transmitted_bss;
3057 	struct list_head nontrans_list;
3058 
3059 	s32 signal;
3060 
3061 	u64 ts_boottime;
3062 
3063 	u16 beacon_interval;
3064 	u16 capability;
3065 
3066 	u8 bssid[ETH_ALEN];
3067 	u8 chains;
3068 	s8 chain_signal[IEEE80211_MAX_CHAINS];
3069 
3070 	u8 proberesp_ecsa_stuck:1;
3071 
3072 	u8 bssid_index;
3073 	u8 max_bssid_indicator;
3074 
3075 	u8 use_for;
3076 	u8 cannot_use_reasons;
3077 
3078 	u8 priv[] __aligned(sizeof(void *));
3079 };
3080 
3081 /**
3082  * ieee80211_bss_get_elem - find element with given ID
3083  * @bss: the bss to search
3084  * @id: the element ID
3085  *
3086  * Note that the return value is an RCU-protected pointer, so
3087  * rcu_read_lock() must be held when calling this function.
3088  * Return: %NULL if not found.
3089  */
3090 const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
3091 
3092 /**
3093  * ieee80211_bss_get_ie - find IE with given ID
3094  * @bss: the bss to search
3095  * @id: the element ID
3096  *
3097  * Note that the return value is an RCU-protected pointer, so
3098  * rcu_read_lock() must be held when calling this function.
3099  * Return: %NULL if not found.
3100  */
3101 static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
3102 {
3103 	return (const void *)ieee80211_bss_get_elem(bss, id);
3104 }
3105 
3106 
3107 /**
3108  * struct cfg80211_auth_request - Authentication request data
3109  *
3110  * This structure provides information needed to complete IEEE 802.11
3111  * authentication.
3112  *
3113  * @bss: The BSS to authenticate with, the callee must obtain a reference
3114  *	to it if it needs to keep it.
3115  * @supported_selectors: List of selectors that should be assumed to be
3116  *	supported by the station.
3117  *	SAE_H2E must be assumed supported if set to %NULL.
3118  * @supported_selectors_len: Length of supported_selectors in octets.
3119  * @auth_type: Authentication type (algorithm)
3120  * @ie: Extra IEs to add to Authentication frame or %NULL
3121  * @ie_len: Length of ie buffer in octets
3122  * @key_len: length of WEP key for shared key authentication
3123  * @key_idx: index of WEP key for shared key authentication
3124  * @key: WEP key for shared key authentication
3125  * @auth_data: Fields and elements in Authentication frames. This contains
3126  *	the authentication frame body (non-IE and IE data), excluding the
3127  *	Authentication algorithm number, i.e., starting at the Authentication
3128  *	transaction sequence number field.
3129  * @auth_data_len: Length of auth_data buffer in octets
3130  * @link_id: if >= 0, indicates authentication should be done as an MLD,
3131  *	the interface address is included as the MLD address and the
3132  *	necessary link (with the given link_id) will be created (and
3133  *	given an MLD address) by the driver
3134  * @ap_mld_addr: AP MLD address in case of authentication request with
3135  *	an AP MLD, valid iff @link_id >= 0
3136  */
3137 struct cfg80211_auth_request {
3138 	struct cfg80211_bss *bss;
3139 	const u8 *ie;
3140 	size_t ie_len;
3141 	const u8 *supported_selectors;
3142 	u8 supported_selectors_len;
3143 	enum nl80211_auth_type auth_type;
3144 	const u8 *key;
3145 	u8 key_len;
3146 	s8 key_idx;
3147 	const u8 *auth_data;
3148 	size_t auth_data_len;
3149 	s8 link_id;
3150 	const u8 *ap_mld_addr;
3151 };
3152 
3153 /**
3154  * struct cfg80211_assoc_link - per-link information for MLO association
3155  * @bss: the BSS pointer, see also &struct cfg80211_assoc_request::bss;
3156  *	if this is %NULL for a link, that link is not requested
3157  * @elems: extra elements for the per-STA profile for this link
3158  * @elems_len: length of the elements
3159  * @disabled: If set this link should be included during association etc. but it
3160  *	should not be used until enabled by the AP MLD.
3161  * @error: per-link error code, must be <= 0. If there is an error, then the
3162  *	operation as a whole must fail.
3163  */
3164 struct cfg80211_assoc_link {
3165 	struct cfg80211_bss *bss;
3166 	const u8 *elems;
3167 	size_t elems_len;
3168 	bool disabled;
3169 	int error;
3170 };
3171 
3172 /**
3173  * struct cfg80211_ml_reconf_req - MLO link reconfiguration request
3174  * @add_links: data for links to add, see &struct cfg80211_assoc_link
3175  * @rem_links: bitmap of links to remove
3176  * @ext_mld_capa_ops: extended MLD capabilities and operations set by
3177  *	userspace for the ML reconfiguration action frame
3178  */
3179 struct cfg80211_ml_reconf_req {
3180 	struct cfg80211_assoc_link add_links[IEEE80211_MLD_MAX_NUM_LINKS];
3181 	u16 rem_links;
3182 	u16 ext_mld_capa_ops;
3183 };
3184 
3185 /**
3186  * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
3187  *
3188  * @ASSOC_REQ_DISABLE_HT:  Disable HT (802.11n)
3189  * @ASSOC_REQ_DISABLE_VHT:  Disable VHT
3190  * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
3191  * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
3192  *	authentication capability. Drivers can offload authentication to
3193  *	userspace if this flag is set. Only applicable for cfg80211_connect()
3194  *	request (connect callback).
3195  * @ASSOC_REQ_DISABLE_HE:  Disable HE
3196  * @ASSOC_REQ_DISABLE_EHT:  Disable EHT
3197  * @CONNECT_REQ_MLO_SUPPORT: Userspace indicates support for handling MLD links.
3198  *	Drivers shall disable MLO features for the current association if this
3199  *	flag is not set.
3200  * @ASSOC_REQ_SPP_AMSDU: SPP A-MSDUs will be used on this connection (if any)
3201  */
3202 enum cfg80211_assoc_req_flags {
3203 	ASSOC_REQ_DISABLE_HT			= BIT(0),
3204 	ASSOC_REQ_DISABLE_VHT			= BIT(1),
3205 	ASSOC_REQ_USE_RRM			= BIT(2),
3206 	CONNECT_REQ_EXTERNAL_AUTH_SUPPORT	= BIT(3),
3207 	ASSOC_REQ_DISABLE_HE			= BIT(4),
3208 	ASSOC_REQ_DISABLE_EHT			= BIT(5),
3209 	CONNECT_REQ_MLO_SUPPORT			= BIT(6),
3210 	ASSOC_REQ_SPP_AMSDU			= BIT(7),
3211 };
3212 
3213 /**
3214  * struct cfg80211_assoc_request - (Re)Association request data
3215  *
3216  * This structure provides information needed to complete IEEE 802.11
3217  * (re)association.
3218  * @bss: The BSS to associate with. If the call is successful the driver is
3219  *	given a reference that it must give back to cfg80211_send_rx_assoc()
3220  *	or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
3221  *	association requests while already associating must be rejected.
3222  *	This also applies to the @links.bss parameter, which is used instead
3223  *	of this one (it is %NULL) for MLO associations.
3224  * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
3225  * @ie_len: Length of ie buffer in octets
3226  * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
3227  * @crypto: crypto settings
3228  * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
3229  *	to indicate a request to reassociate within the ESS instead of a request
3230  *	do the initial association with the ESS. When included, this is set to
3231  *	the BSSID of the current association, i.e., to the value that is
3232  *	included in the Current AP address field of the Reassociation Request
3233  *	frame.
3234  * @flags:  See &enum cfg80211_assoc_req_flags
3235  * @supported_selectors: supported BSS selectors in IEEE 802.11 format
3236  *	(or %NULL for no change).
3237  *	If %NULL, then support for SAE_H2E should be assumed.
3238  * @supported_selectors_len: number of supported BSS selectors
3239  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
3240  *	will be used in ht_capa.  Un-supported values will be ignored.
3241  * @ht_capa_mask:  The bits of ht_capa which are to be used.
3242  * @vht_capa: VHT capability override
3243  * @vht_capa_mask: VHT capability mask indicating which fields to use
3244  * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
3245  *	%NULL if FILS is not used.
3246  * @fils_kek_len: Length of fils_kek in octets
3247  * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
3248  *	Request/Response frame or %NULL if FILS is not used. This field starts
3249  *	with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
3250  * @s1g_capa: S1G capability override
3251  * @s1g_capa_mask: S1G capability override mask
3252  * @links: per-link information for MLO connections
3253  * @link_id: >= 0 for MLO connections, where links are given, and indicates
3254  *	the link on which the association request should be sent
3255  * @ap_mld_addr: AP MLD address in case of MLO association request,
3256  *	valid iff @link_id >= 0
3257  * @ext_mld_capa_ops: extended MLD capabilities and operations set by
3258  *	userspace for the association
3259  */
3260 struct cfg80211_assoc_request {
3261 	struct cfg80211_bss *bss;
3262 	const u8 *ie, *prev_bssid;
3263 	size_t ie_len;
3264 	struct cfg80211_crypto_settings crypto;
3265 	bool use_mfp;
3266 	u32 flags;
3267 	const u8 *supported_selectors;
3268 	u8 supported_selectors_len;
3269 	struct ieee80211_ht_cap ht_capa;
3270 	struct ieee80211_ht_cap ht_capa_mask;
3271 	struct ieee80211_vht_cap vht_capa, vht_capa_mask;
3272 	const u8 *fils_kek;
3273 	size_t fils_kek_len;
3274 	const u8 *fils_nonces;
3275 	struct ieee80211_s1g_cap s1g_capa, s1g_capa_mask;
3276 	struct cfg80211_assoc_link links[IEEE80211_MLD_MAX_NUM_LINKS];
3277 	const u8 *ap_mld_addr;
3278 	s8 link_id;
3279 	u16 ext_mld_capa_ops;
3280 };
3281 
3282 /**
3283  * struct cfg80211_deauth_request - Deauthentication request data
3284  *
3285  * This structure provides information needed to complete IEEE 802.11
3286  * deauthentication.
3287  *
3288  * @bssid: the BSSID or AP MLD address to deauthenticate from
3289  * @ie: Extra IEs to add to Deauthentication frame or %NULL
3290  * @ie_len: Length of ie buffer in octets
3291  * @reason_code: The reason code for the deauthentication
3292  * @local_state_change: if set, change local state only and
3293  *	do not set a deauth frame
3294  */
3295 struct cfg80211_deauth_request {
3296 	const u8 *bssid;
3297 	const u8 *ie;
3298 	size_t ie_len;
3299 	u16 reason_code;
3300 	bool local_state_change;
3301 };
3302 
3303 /**
3304  * struct cfg80211_disassoc_request - Disassociation request data
3305  *
3306  * This structure provides information needed to complete IEEE 802.11
3307  * disassociation.
3308  *
3309  * @ap_addr: the BSSID or AP MLD address to disassociate from
3310  * @ie: Extra IEs to add to Disassociation frame or %NULL
3311  * @ie_len: Length of ie buffer in octets
3312  * @reason_code: The reason code for the disassociation
3313  * @local_state_change: This is a request for a local state only, i.e., no
3314  *	Disassociation frame is to be transmitted.
3315  */
3316 struct cfg80211_disassoc_request {
3317 	const u8 *ap_addr;
3318 	const u8 *ie;
3319 	size_t ie_len;
3320 	u16 reason_code;
3321 	bool local_state_change;
3322 };
3323 
3324 /**
3325  * struct cfg80211_ibss_params - IBSS parameters
3326  *
3327  * This structure defines the IBSS parameters for the join_ibss()
3328  * method.
3329  *
3330  * @ssid: The SSID, will always be non-null.
3331  * @ssid_len: The length of the SSID, will always be non-zero.
3332  * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
3333  *	search for IBSSs with a different BSSID.
3334  * @chandef: defines the channel to use if no other IBSS to join can be found
3335  * @channel_fixed: The channel should be fixed -- do not search for
3336  *	IBSSs to join on other channels.
3337  * @ie: information element(s) to include in the beacon
3338  * @ie_len: length of that
3339  * @beacon_interval: beacon interval to use
3340  * @privacy: this is a protected network, keys will be configured
3341  *	after joining
3342  * @control_port: whether user space controls IEEE 802.1X port, i.e.,
3343  *	sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
3344  *	required to assume that the port is unauthorized until authorized by
3345  *	user space. Otherwise, port is marked authorized by default.
3346  * @control_port_over_nl80211: TRUE if userspace expects to exchange control
3347  *	port frames over NL80211 instead of the network interface.
3348  * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
3349  *	changes the channel when a radar is detected. This is required
3350  *	to operate on DFS channels.
3351  * @basic_rates: bitmap of basic rates to use when creating the IBSS
3352  * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
3353  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
3354  *	will be used in ht_capa.  Un-supported values will be ignored.
3355  * @ht_capa_mask:  The bits of ht_capa which are to be used.
3356  * @wep_keys: static WEP keys, if not NULL points to an array of
3357  *	CFG80211_MAX_WEP_KEYS WEP keys
3358  * @wep_tx_key: key index (0..3) of the default TX static WEP key
3359  */
3360 struct cfg80211_ibss_params {
3361 	const u8 *ssid;
3362 	const u8 *bssid;
3363 	struct cfg80211_chan_def chandef;
3364 	const u8 *ie;
3365 	u8 ssid_len, ie_len;
3366 	u16 beacon_interval;
3367 	u32 basic_rates;
3368 	bool channel_fixed;
3369 	bool privacy;
3370 	bool control_port;
3371 	bool control_port_over_nl80211;
3372 	bool userspace_handles_dfs;
3373 	int mcast_rate[NUM_NL80211_BANDS];
3374 	struct ieee80211_ht_cap ht_capa;
3375 	struct ieee80211_ht_cap ht_capa_mask;
3376 	struct key_params *wep_keys;
3377 	int wep_tx_key;
3378 };
3379 
3380 /**
3381  * struct cfg80211_bss_selection - connection parameters for BSS selection.
3382  *
3383  * @behaviour: requested BSS selection behaviour.
3384  * @param: parameters for requestion behaviour.
3385  * @param.band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
3386  * @param.adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
3387  */
3388 struct cfg80211_bss_selection {
3389 	enum nl80211_bss_select_attr behaviour;
3390 	union {
3391 		enum nl80211_band band_pref;
3392 		struct cfg80211_bss_select_adjust adjust;
3393 	} param;
3394 };
3395 
3396 /**
3397  * struct cfg80211_connect_params - Connection parameters
3398  *
3399  * This structure provides information needed to complete IEEE 802.11
3400  * authentication and association.
3401  *
3402  * @channel: The channel to use or %NULL if not specified (auto-select based
3403  *	on scan results)
3404  * @channel_hint: The channel of the recommended BSS for initial connection or
3405  *	%NULL if not specified
3406  * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
3407  *	results)
3408  * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
3409  *	%NULL if not specified. Unlike the @bssid parameter, the driver is
3410  *	allowed to ignore this @bssid_hint if it has knowledge of a better BSS
3411  *	to use.
3412  * @ssid: SSID
3413  * @ssid_len: Length of ssid in octets
3414  * @auth_type: Authentication type (algorithm)
3415  * @ie: IEs for association request
3416  * @ie_len: Length of assoc_ie in octets
3417  * @privacy: indicates whether privacy-enabled APs should be used
3418  * @mfp: indicate whether management frame protection is used
3419  * @crypto: crypto settings
3420  * @key_len: length of WEP key for shared key authentication
3421  * @key_idx: index of WEP key for shared key authentication
3422  * @key: WEP key for shared key authentication
3423  * @flags:  See &enum cfg80211_assoc_req_flags
3424  * @bg_scan_period:  Background scan period in seconds
3425  *	or -1 to indicate that default value is to be used.
3426  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
3427  *	will be used in ht_capa.  Un-supported values will be ignored.
3428  * @ht_capa_mask:  The bits of ht_capa which are to be used.
3429  * @vht_capa:  VHT Capability overrides
3430  * @vht_capa_mask: The bits of vht_capa which are to be used.
3431  * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
3432  *	networks.
3433  * @bss_select: criteria to be used for BSS selection.
3434  * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
3435  *	to indicate a request to reassociate within the ESS instead of a request
3436  *	do the initial association with the ESS. When included, this is set to
3437  *	the BSSID of the current association, i.e., to the value that is
3438  *	included in the Current AP address field of the Reassociation Request
3439  *	frame.
3440  * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
3441  *	NAI or %NULL if not specified. This is used to construct FILS wrapped
3442  *	data IE.
3443  * @fils_erp_username_len: Length of @fils_erp_username in octets.
3444  * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
3445  *	%NULL if not specified. This specifies the domain name of ER server and
3446  *	is used to construct FILS wrapped data IE.
3447  * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
3448  * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
3449  *	messages. This is also used to construct FILS wrapped data IE.
3450  * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
3451  *	keys in FILS or %NULL if not specified.
3452  * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
3453  * @want_1x: indicates user-space supports and wants to use 802.1X driver
3454  *	offload of 4-way handshake.
3455  * @edmg: define the EDMG channels.
3456  *	This may specify multiple channels and bonding options for the driver
3457  *	to choose from, based on BSS configuration.
3458  */
3459 struct cfg80211_connect_params {
3460 	struct ieee80211_channel *channel;
3461 	struct ieee80211_channel *channel_hint;
3462 	const u8 *bssid;
3463 	const u8 *bssid_hint;
3464 	const u8 *ssid;
3465 	size_t ssid_len;
3466 	enum nl80211_auth_type auth_type;
3467 	const u8 *ie;
3468 	size_t ie_len;
3469 	bool privacy;
3470 	enum nl80211_mfp mfp;
3471 	struct cfg80211_crypto_settings crypto;
3472 	const u8 *key;
3473 	u8 key_len, key_idx;
3474 	u32 flags;
3475 	int bg_scan_period;
3476 	struct ieee80211_ht_cap ht_capa;
3477 	struct ieee80211_ht_cap ht_capa_mask;
3478 	struct ieee80211_vht_cap vht_capa;
3479 	struct ieee80211_vht_cap vht_capa_mask;
3480 	bool pbss;
3481 	struct cfg80211_bss_selection bss_select;
3482 	const u8 *prev_bssid;
3483 	const u8 *fils_erp_username;
3484 	size_t fils_erp_username_len;
3485 	const u8 *fils_erp_realm;
3486 	size_t fils_erp_realm_len;
3487 	u16 fils_erp_next_seq_num;
3488 	const u8 *fils_erp_rrk;
3489 	size_t fils_erp_rrk_len;
3490 	bool want_1x;
3491 	struct ieee80211_edmg edmg;
3492 };
3493 
3494 /**
3495  * enum cfg80211_connect_params_changed - Connection parameters being updated
3496  *
3497  * This enum provides information of all connect parameters that
3498  * have to be updated as part of update_connect_params() call.
3499  *
3500  * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
3501  * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
3502  *	username, erp sequence number and rrk) are updated
3503  * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
3504  */
3505 enum cfg80211_connect_params_changed {
3506 	UPDATE_ASSOC_IES		= BIT(0),
3507 	UPDATE_FILS_ERP_INFO		= BIT(1),
3508 	UPDATE_AUTH_TYPE		= BIT(2),
3509 };
3510 
3511 /**
3512  * enum wiphy_params_flags - set_wiphy_params bitfield values
3513  * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
3514  * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
3515  * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
3516  * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
3517  * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
3518  * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
3519  * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
3520  * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
3521  * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
3522  */
3523 enum wiphy_params_flags {
3524 	WIPHY_PARAM_RETRY_SHORT		= BIT(0),
3525 	WIPHY_PARAM_RETRY_LONG		= BIT(1),
3526 	WIPHY_PARAM_FRAG_THRESHOLD	= BIT(2),
3527 	WIPHY_PARAM_RTS_THRESHOLD	= BIT(3),
3528 	WIPHY_PARAM_COVERAGE_CLASS	= BIT(4),
3529 	WIPHY_PARAM_DYN_ACK		= BIT(5),
3530 	WIPHY_PARAM_TXQ_LIMIT		= BIT(6),
3531 	WIPHY_PARAM_TXQ_MEMORY_LIMIT	= BIT(7),
3532 	WIPHY_PARAM_TXQ_QUANTUM		= BIT(8),
3533 };
3534 
3535 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT	256
3536 
3537 /* The per TXQ device queue limit in airtime */
3538 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_L	5000
3539 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_H	12000
3540 
3541 /* The per interface airtime threshold to switch to lower queue limit */
3542 #define IEEE80211_AQL_THRESHOLD			24000
3543 
3544 /**
3545  * struct cfg80211_pmksa - PMK Security Association
3546  *
3547  * This structure is passed to the set/del_pmksa() method for PMKSA
3548  * caching.
3549  *
3550  * @bssid: The AP's BSSID (may be %NULL).
3551  * @pmkid: The identifier to refer a PMKSA.
3552  * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
3553  *	derivation by a FILS STA. Otherwise, %NULL.
3554  * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
3555  *	the hash algorithm used to generate this.
3556  * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
3557  *	cache identifier (may be %NULL).
3558  * @ssid_len: Length of the @ssid in octets.
3559  * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
3560  *	scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
3561  *	%NULL).
3562  * @pmk_lifetime: Maximum lifetime for PMKSA in seconds
3563  *	(dot11RSNAConfigPMKLifetime) or 0 if not specified.
3564  *	The configured PMKSA must not be used for PMKSA caching after
3565  *	expiration and any keys derived from this PMK become invalid on
3566  *	expiration, i.e., the current association must be dropped if the PMK
3567  *	used for it expires.
3568  * @pmk_reauth_threshold: Threshold time for reauthentication (percentage of
3569  *	PMK lifetime, dot11RSNAConfigPMKReauthThreshold) or 0 if not specified.
3570  *	Drivers are expected to trigger a full authentication instead of using
3571  *	this PMKSA for caching when reassociating to a new BSS after this
3572  *	threshold to generate a new PMK before the current one expires.
3573  */
3574 struct cfg80211_pmksa {
3575 	const u8 *bssid;
3576 	const u8 *pmkid;
3577 	const u8 *pmk;
3578 	size_t pmk_len;
3579 	const u8 *ssid;
3580 	size_t ssid_len;
3581 	const u8 *cache_id;
3582 	u32 pmk_lifetime;
3583 	u8 pmk_reauth_threshold;
3584 };
3585 
3586 /**
3587  * struct cfg80211_pkt_pattern - packet pattern
3588  * @mask: bitmask where to match pattern and where to ignore bytes,
3589  *	one bit per byte, in same format as nl80211
3590  * @pattern: bytes to match where bitmask is 1
3591  * @pattern_len: length of pattern (in bytes)
3592  * @pkt_offset: packet offset (in bytes)
3593  *
3594  * Internal note: @mask and @pattern are allocated in one chunk of
3595  * memory, free @mask only!
3596  */
3597 struct cfg80211_pkt_pattern {
3598 	const u8 *mask, *pattern;
3599 	int pattern_len;
3600 	int pkt_offset;
3601 };
3602 
3603 /**
3604  * struct cfg80211_wowlan_tcp - TCP connection parameters
3605  *
3606  * @sock: (internal) socket for source port allocation
3607  * @src: source IP address
3608  * @dst: destination IP address
3609  * @dst_mac: destination MAC address
3610  * @src_port: source port
3611  * @dst_port: destination port
3612  * @payload_len: data payload length
3613  * @payload: data payload buffer
3614  * @payload_seq: payload sequence stamping configuration
3615  * @data_interval: interval at which to send data packets
3616  * @wake_len: wakeup payload match length
3617  * @wake_data: wakeup payload match data
3618  * @wake_mask: wakeup payload match mask
3619  * @tokens_size: length of the tokens buffer
3620  * @payload_tok: payload token usage configuration
3621  */
3622 struct cfg80211_wowlan_tcp {
3623 	struct socket *sock;
3624 	__be32 src, dst;
3625 	u16 src_port, dst_port;
3626 	u8 dst_mac[ETH_ALEN];
3627 	int payload_len;
3628 	const u8 *payload;
3629 	struct nl80211_wowlan_tcp_data_seq payload_seq;
3630 	u32 data_interval;
3631 	u32 wake_len;
3632 	const u8 *wake_data, *wake_mask;
3633 	u32 tokens_size;
3634 	/* must be last, variable member */
3635 	struct nl80211_wowlan_tcp_data_token payload_tok;
3636 };
3637 
3638 /**
3639  * struct cfg80211_wowlan - Wake on Wireless-LAN support info
3640  *
3641  * This structure defines the enabled WoWLAN triggers for the device.
3642  * @any: wake up on any activity -- special trigger if device continues
3643  *	operating as normal during suspend
3644  * @disconnect: wake up if getting disconnected
3645  * @magic_pkt: wake up on receiving magic packet
3646  * @patterns: wake up on receiving packet matching a pattern
3647  * @n_patterns: number of patterns
3648  * @gtk_rekey_failure: wake up on GTK rekey failure
3649  * @eap_identity_req: wake up on EAP identity request packet
3650  * @four_way_handshake: wake up on 4-way handshake
3651  * @rfkill_release: wake up when rfkill is released
3652  * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
3653  *	NULL if not configured.
3654  * @nd_config: configuration for the scan to be used for net detect wake.
3655  */
3656 struct cfg80211_wowlan {
3657 	bool any, disconnect, magic_pkt, gtk_rekey_failure,
3658 	     eap_identity_req, four_way_handshake,
3659 	     rfkill_release;
3660 	struct cfg80211_pkt_pattern *patterns;
3661 	struct cfg80211_wowlan_tcp *tcp;
3662 	int n_patterns;
3663 	struct cfg80211_sched_scan_request *nd_config;
3664 };
3665 
3666 /**
3667  * struct cfg80211_coalesce_rules - Coalesce rule parameters
3668  *
3669  * This structure defines coalesce rule for the device.
3670  * @delay: maximum coalescing delay in msecs.
3671  * @condition: condition for packet coalescence.
3672  *	see &enum nl80211_coalesce_condition.
3673  * @patterns: array of packet patterns
3674  * @n_patterns: number of patterns
3675  */
3676 struct cfg80211_coalesce_rules {
3677 	int delay;
3678 	enum nl80211_coalesce_condition condition;
3679 	struct cfg80211_pkt_pattern *patterns;
3680 	int n_patterns;
3681 };
3682 
3683 /**
3684  * struct cfg80211_coalesce - Packet coalescing settings
3685  *
3686  * This structure defines coalescing settings.
3687  * @rules: array of coalesce rules
3688  * @n_rules: number of rules
3689  */
3690 struct cfg80211_coalesce {
3691 	int n_rules;
3692 	struct cfg80211_coalesce_rules rules[] __counted_by(n_rules);
3693 };
3694 
3695 /**
3696  * struct cfg80211_wowlan_nd_match - information about the match
3697  *
3698  * @ssid: SSID of the match that triggered the wake up
3699  * @n_channels: Number of channels where the match occurred.  This
3700  *	value may be zero if the driver can't report the channels.
3701  * @channels: center frequencies of the channels where a match
3702  *	occurred (in MHz)
3703  */
3704 struct cfg80211_wowlan_nd_match {
3705 	struct cfg80211_ssid ssid;
3706 	int n_channels;
3707 	u32 channels[] __counted_by(n_channels);
3708 };
3709 
3710 /**
3711  * struct cfg80211_wowlan_nd_info - net detect wake up information
3712  *
3713  * @n_matches: Number of match information instances provided in
3714  *	@matches.  This value may be zero if the driver can't provide
3715  *	match information.
3716  * @matches: Array of pointers to matches containing information about
3717  *	the matches that triggered the wake up.
3718  */
3719 struct cfg80211_wowlan_nd_info {
3720 	int n_matches;
3721 	struct cfg80211_wowlan_nd_match *matches[] __counted_by(n_matches);
3722 };
3723 
3724 /**
3725  * struct cfg80211_wowlan_wakeup - wakeup report
3726  * @disconnect: woke up by getting disconnected
3727  * @magic_pkt: woke up by receiving magic packet
3728  * @gtk_rekey_failure: woke up by GTK rekey failure
3729  * @eap_identity_req: woke up by EAP identity request packet
3730  * @four_way_handshake: woke up by 4-way handshake
3731  * @rfkill_release: woke up by rfkill being released
3732  * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
3733  * @packet_present_len: copied wakeup packet data
3734  * @packet_len: original wakeup packet length
3735  * @packet: The packet causing the wakeup, if any.
3736  * @packet_80211:  For pattern match, magic packet and other data
3737  *	frame triggers an 802.3 frame should be reported, for
3738  *	disconnect due to deauth 802.11 frame. This indicates which
3739  *	it is.
3740  * @tcp_match: TCP wakeup packet received
3741  * @tcp_connlost: TCP connection lost or failed to establish
3742  * @tcp_nomoretokens: TCP data ran out of tokens
3743  * @net_detect: if not %NULL, woke up because of net detect
3744  * @unprot_deauth_disassoc: woke up due to unprotected deauth or
3745  *	disassoc frame (in MFP).
3746  */
3747 struct cfg80211_wowlan_wakeup {
3748 	bool disconnect, magic_pkt, gtk_rekey_failure,
3749 	     eap_identity_req, four_way_handshake,
3750 	     rfkill_release, packet_80211,
3751 	     tcp_match, tcp_connlost, tcp_nomoretokens,
3752 	     unprot_deauth_disassoc;
3753 	s32 pattern_idx;
3754 	u32 packet_present_len, packet_len;
3755 	const void *packet;
3756 	struct cfg80211_wowlan_nd_info *net_detect;
3757 };
3758 
3759 /**
3760  * struct cfg80211_gtk_rekey_data - rekey data
3761  * @kek: key encryption key (@kek_len bytes)
3762  * @kck: key confirmation key (@kck_len bytes)
3763  * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
3764  * @kek_len: length of kek
3765  * @kck_len: length of kck
3766  * @akm: akm (oui, id)
3767  */
3768 struct cfg80211_gtk_rekey_data {
3769 	const u8 *kek, *kck, *replay_ctr;
3770 	u32 akm;
3771 	u8 kek_len, kck_len;
3772 };
3773 
3774 /**
3775  * struct cfg80211_update_ft_ies_params - FT IE Information
3776  *
3777  * This structure provides information needed to update the fast transition IE
3778  *
3779  * @md: The Mobility Domain ID, 2 Octet value
3780  * @ie: Fast Transition IEs
3781  * @ie_len: Length of ft_ie in octets
3782  */
3783 struct cfg80211_update_ft_ies_params {
3784 	u16 md;
3785 	const u8 *ie;
3786 	size_t ie_len;
3787 };
3788 
3789 /**
3790  * struct cfg80211_mgmt_tx_params - mgmt tx parameters
3791  *
3792  * This structure provides information needed to transmit a mgmt frame
3793  *
3794  * @chan: channel to use
3795  * @offchan: indicates whether off channel operation is required
3796  * @wait: duration for ROC
3797  * @buf: buffer to transmit
3798  * @len: buffer length
3799  * @no_cck: don't use cck rates for this frame
3800  * @dont_wait_for_ack: tells the low level not to wait for an ack
3801  * @n_csa_offsets: length of csa_offsets array
3802  * @csa_offsets: array of all the csa offsets in the frame
3803  * @link_id: for MLO, the link ID to transmit on, -1 if not given; note
3804  *	that the link ID isn't validated (much), it's in range but the
3805  *	link might not exist (or be used by the receiver STA)
3806  */
3807 struct cfg80211_mgmt_tx_params {
3808 	struct ieee80211_channel *chan;
3809 	bool offchan;
3810 	unsigned int wait;
3811 	const u8 *buf;
3812 	size_t len;
3813 	bool no_cck;
3814 	bool dont_wait_for_ack;
3815 	int n_csa_offsets;
3816 	const u16 *csa_offsets;
3817 	int link_id;
3818 };
3819 
3820 /**
3821  * struct cfg80211_dscp_exception - DSCP exception
3822  *
3823  * @dscp: DSCP value that does not adhere to the user priority range definition
3824  * @up: user priority value to which the corresponding DSCP value belongs
3825  */
3826 struct cfg80211_dscp_exception {
3827 	u8 dscp;
3828 	u8 up;
3829 };
3830 
3831 /**
3832  * struct cfg80211_dscp_range - DSCP range definition for user priority
3833  *
3834  * @low: lowest DSCP value of this user priority range, inclusive
3835  * @high: highest DSCP value of this user priority range, inclusive
3836  */
3837 struct cfg80211_dscp_range {
3838 	u8 low;
3839 	u8 high;
3840 };
3841 
3842 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
3843 #define IEEE80211_QOS_MAP_MAX_EX	21
3844 #define IEEE80211_QOS_MAP_LEN_MIN	16
3845 #define IEEE80211_QOS_MAP_LEN_MAX \
3846 	(IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
3847 
3848 /**
3849  * struct cfg80211_qos_map - QoS Map Information
3850  *
3851  * This struct defines the Interworking QoS map setting for DSCP values
3852  *
3853  * @num_des: number of DSCP exceptions (0..21)
3854  * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
3855  *	the user priority DSCP range definition
3856  * @up: DSCP range definition for a particular user priority
3857  */
3858 struct cfg80211_qos_map {
3859 	u8 num_des;
3860 	struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
3861 	struct cfg80211_dscp_range up[8];
3862 };
3863 
3864 /**
3865  * struct cfg80211_nan_conf - NAN configuration
3866  *
3867  * This struct defines NAN configuration parameters
3868  *
3869  * @master_pref: master preference (1 - 255)
3870  * @bands: operating bands, a bitmap of &enum nl80211_band values.
3871  *	For instance, for NL80211_BAND_2GHZ, bit 0 would be set
3872  *	(i.e. BIT(NL80211_BAND_2GHZ)).
3873  */
3874 struct cfg80211_nan_conf {
3875 	u8 master_pref;
3876 	u8 bands;
3877 };
3878 
3879 /**
3880  * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
3881  * configuration
3882  *
3883  * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
3884  * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
3885  */
3886 enum cfg80211_nan_conf_changes {
3887 	CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
3888 	CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
3889 };
3890 
3891 /**
3892  * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
3893  *
3894  * @filter: the content of the filter
3895  * @len: the length of the filter
3896  */
3897 struct cfg80211_nan_func_filter {
3898 	const u8 *filter;
3899 	u8 len;
3900 };
3901 
3902 /**
3903  * struct cfg80211_nan_func - a NAN function
3904  *
3905  * @type: &enum nl80211_nan_function_type
3906  * @service_id: the service ID of the function
3907  * @publish_type: &nl80211_nan_publish_type
3908  * @close_range: if true, the range should be limited. Threshold is
3909  *	implementation specific.
3910  * @publish_bcast: if true, the solicited publish should be broadcasted
3911  * @subscribe_active: if true, the subscribe is active
3912  * @followup_id: the instance ID for follow up
3913  * @followup_reqid: the requester instance ID for follow up
3914  * @followup_dest: MAC address of the recipient of the follow up
3915  * @ttl: time to live counter in DW.
3916  * @serv_spec_info: Service Specific Info
3917  * @serv_spec_info_len: Service Specific Info length
3918  * @srf_include: if true, SRF is inclusive
3919  * @srf_bf: Bloom Filter
3920  * @srf_bf_len: Bloom Filter length
3921  * @srf_bf_idx: Bloom Filter index
3922  * @srf_macs: SRF MAC addresses
3923  * @srf_num_macs: number of MAC addresses in SRF
3924  * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
3925  * @tx_filters: filters that should be transmitted in the SDF.
3926  * @num_rx_filters: length of &rx_filters.
3927  * @num_tx_filters: length of &tx_filters.
3928  * @instance_id: driver allocated id of the function.
3929  * @cookie: unique NAN function identifier.
3930  */
3931 struct cfg80211_nan_func {
3932 	enum nl80211_nan_function_type type;
3933 	u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
3934 	u8 publish_type;
3935 	bool close_range;
3936 	bool publish_bcast;
3937 	bool subscribe_active;
3938 	u8 followup_id;
3939 	u8 followup_reqid;
3940 	struct mac_address followup_dest;
3941 	u32 ttl;
3942 	const u8 *serv_spec_info;
3943 	u8 serv_spec_info_len;
3944 	bool srf_include;
3945 	const u8 *srf_bf;
3946 	u8 srf_bf_len;
3947 	u8 srf_bf_idx;
3948 	struct mac_address *srf_macs;
3949 	int srf_num_macs;
3950 	struct cfg80211_nan_func_filter *rx_filters;
3951 	struct cfg80211_nan_func_filter *tx_filters;
3952 	u8 num_tx_filters;
3953 	u8 num_rx_filters;
3954 	u8 instance_id;
3955 	u64 cookie;
3956 };
3957 
3958 /**
3959  * struct cfg80211_pmk_conf - PMK configuration
3960  *
3961  * @aa: authenticator address
3962  * @pmk_len: PMK length in bytes.
3963  * @pmk: the PMK material
3964  * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
3965  *	is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
3966  *	holds PMK-R0.
3967  */
3968 struct cfg80211_pmk_conf {
3969 	const u8 *aa;
3970 	u8 pmk_len;
3971 	const u8 *pmk;
3972 	const u8 *pmk_r0_name;
3973 };
3974 
3975 /**
3976  * struct cfg80211_external_auth_params - Trigger External authentication.
3977  *
3978  * Commonly used across the external auth request and event interfaces.
3979  *
3980  * @action: action type / trigger for external authentication. Only significant
3981  *	for the authentication request event interface (driver to user space).
3982  * @bssid: BSSID of the peer with which the authentication has
3983  *	to happen. Used by both the authentication request event and
3984  *	authentication response command interface.
3985  * @ssid: SSID of the AP.  Used by both the authentication request event and
3986  *	authentication response command interface.
3987  * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
3988  *	authentication request event interface.
3989  * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
3990  *	use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
3991  *	the real status code for failures. Used only for the authentication
3992  *	response command interface (user space to driver).
3993  * @pmkid: The identifier to refer a PMKSA.
3994  * @mld_addr: MLD address of the peer. Used by the authentication request event
3995  *	interface. Driver indicates this to enable MLO during the authentication
3996  *	offload to user space. Driver shall look at %NL80211_ATTR_MLO_SUPPORT
3997  *	flag capability in NL80211_CMD_CONNECT to know whether the user space
3998  *	supports enabling MLO during the authentication offload.
3999  *	User space should use the address of the interface (on which the
4000  *	authentication request event reported) as self MLD address. User space
4001  *	and driver should use MLD addresses in RA, TA and BSSID fields of
4002  *	authentication frames sent or received via cfg80211. The driver
4003  *	translates the MLD addresses to/from link addresses based on the link
4004  *	chosen for the authentication.
4005  */
4006 struct cfg80211_external_auth_params {
4007 	enum nl80211_external_auth_action action;
4008 	u8 bssid[ETH_ALEN] __aligned(2);
4009 	struct cfg80211_ssid ssid;
4010 	unsigned int key_mgmt_suite;
4011 	u16 status;
4012 	const u8 *pmkid;
4013 	u8 mld_addr[ETH_ALEN] __aligned(2);
4014 };
4015 
4016 /**
4017  * struct cfg80211_ftm_responder_stats - FTM responder statistics
4018  *
4019  * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
4020  *	indicate the relevant values in this struct for them
4021  * @success_num: number of FTM sessions in which all frames were successfully
4022  *	answered
4023  * @partial_num: number of FTM sessions in which part of frames were
4024  *	successfully answered
4025  * @failed_num: number of failed FTM sessions
4026  * @asap_num: number of ASAP FTM sessions
4027  * @non_asap_num: number of  non-ASAP FTM sessions
4028  * @total_duration_ms: total sessions durations - gives an indication
4029  *	of how much time the responder was busy
4030  * @unknown_triggers_num: number of unknown FTM triggers - triggers from
4031  *	initiators that didn't finish successfully the negotiation phase with
4032  *	the responder
4033  * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
4034  *	for a new scheduling although it already has scheduled FTM slot
4035  * @out_of_window_triggers_num: total FTM triggers out of scheduled window
4036  */
4037 struct cfg80211_ftm_responder_stats {
4038 	u32 filled;
4039 	u32 success_num;
4040 	u32 partial_num;
4041 	u32 failed_num;
4042 	u32 asap_num;
4043 	u32 non_asap_num;
4044 	u64 total_duration_ms;
4045 	u32 unknown_triggers_num;
4046 	u32 reschedule_requests_num;
4047 	u32 out_of_window_triggers_num;
4048 };
4049 
4050 /**
4051  * struct cfg80211_pmsr_ftm_result - FTM result
4052  * @failure_reason: if this measurement failed (PMSR status is
4053  *	%NL80211_PMSR_STATUS_FAILURE), this gives a more precise
4054  *	reason than just "failure"
4055  * @burst_index: if reporting partial results, this is the index
4056  *	in [0 .. num_bursts-1] of the burst that's being reported
4057  * @num_ftmr_attempts: number of FTM request frames transmitted
4058  * @num_ftmr_successes: number of FTM request frames acked
4059  * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
4060  *	fill this to indicate in how many seconds a retry is deemed possible
4061  *	by the responder
4062  * @num_bursts_exp: actual number of bursts exponent negotiated
4063  * @burst_duration: actual burst duration negotiated
4064  * @ftms_per_burst: actual FTMs per burst negotiated
4065  * @lci_len: length of LCI information (if present)
4066  * @civicloc_len: length of civic location information (if present)
4067  * @lci: LCI data (may be %NULL)
4068  * @civicloc: civic location data (may be %NULL)
4069  * @rssi_avg: average RSSI over FTM action frames reported
4070  * @rssi_spread: spread of the RSSI over FTM action frames reported
4071  * @tx_rate: bitrate for transmitted FTM action frame response
4072  * @rx_rate: bitrate of received FTM action frame
4073  * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
4074  * @rtt_variance: variance of RTTs measured (note that standard deviation is
4075  *	the square root of the variance)
4076  * @rtt_spread: spread of the RTTs measured
4077  * @dist_avg: average of distances (mm) measured
4078  *	(must have either this or @rtt_avg)
4079  * @dist_variance: variance of distances measured (see also @rtt_variance)
4080  * @dist_spread: spread of distances measured (see also @rtt_spread)
4081  * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
4082  * @num_ftmr_successes_valid: @num_ftmr_successes is valid
4083  * @rssi_avg_valid: @rssi_avg is valid
4084  * @rssi_spread_valid: @rssi_spread is valid
4085  * @tx_rate_valid: @tx_rate is valid
4086  * @rx_rate_valid: @rx_rate is valid
4087  * @rtt_avg_valid: @rtt_avg is valid
4088  * @rtt_variance_valid: @rtt_variance is valid
4089  * @rtt_spread_valid: @rtt_spread is valid
4090  * @dist_avg_valid: @dist_avg is valid
4091  * @dist_variance_valid: @dist_variance is valid
4092  * @dist_spread_valid: @dist_spread is valid
4093  */
4094 struct cfg80211_pmsr_ftm_result {
4095 	const u8 *lci;
4096 	const u8 *civicloc;
4097 	unsigned int lci_len;
4098 	unsigned int civicloc_len;
4099 	enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
4100 	u32 num_ftmr_attempts, num_ftmr_successes;
4101 	s16 burst_index;
4102 	u8 busy_retry_time;
4103 	u8 num_bursts_exp;
4104 	u8 burst_duration;
4105 	u8 ftms_per_burst;
4106 	s32 rssi_avg;
4107 	s32 rssi_spread;
4108 	struct rate_info tx_rate, rx_rate;
4109 	s64 rtt_avg;
4110 	s64 rtt_variance;
4111 	s64 rtt_spread;
4112 	s64 dist_avg;
4113 	s64 dist_variance;
4114 	s64 dist_spread;
4115 
4116 	u16 num_ftmr_attempts_valid:1,
4117 	    num_ftmr_successes_valid:1,
4118 	    rssi_avg_valid:1,
4119 	    rssi_spread_valid:1,
4120 	    tx_rate_valid:1,
4121 	    rx_rate_valid:1,
4122 	    rtt_avg_valid:1,
4123 	    rtt_variance_valid:1,
4124 	    rtt_spread_valid:1,
4125 	    dist_avg_valid:1,
4126 	    dist_variance_valid:1,
4127 	    dist_spread_valid:1;
4128 };
4129 
4130 /**
4131  * struct cfg80211_pmsr_result - peer measurement result
4132  * @addr: address of the peer
4133  * @host_time: host time (use ktime_get_boottime() adjust to the time when the
4134  *	measurement was made)
4135  * @ap_tsf: AP's TSF at measurement time
4136  * @status: status of the measurement
4137  * @final: if reporting partial results, mark this as the last one; if not
4138  *	reporting partial results always set this flag
4139  * @ap_tsf_valid: indicates the @ap_tsf value is valid
4140  * @type: type of the measurement reported, note that we only support reporting
4141  *	one type at a time, but you can report multiple results separately and
4142  *	they're all aggregated for userspace.
4143  * @ftm: FTM result
4144  */
4145 struct cfg80211_pmsr_result {
4146 	u64 host_time, ap_tsf;
4147 	enum nl80211_peer_measurement_status status;
4148 
4149 	u8 addr[ETH_ALEN];
4150 
4151 	u8 final:1,
4152 	   ap_tsf_valid:1;
4153 
4154 	enum nl80211_peer_measurement_type type;
4155 
4156 	union {
4157 		struct cfg80211_pmsr_ftm_result ftm;
4158 	};
4159 };
4160 
4161 /**
4162  * struct cfg80211_pmsr_ftm_request_peer - FTM request data
4163  * @requested: indicates FTM is requested
4164  * @preamble: frame preamble to use
4165  * @burst_period: burst period to use
4166  * @asap: indicates to use ASAP mode
4167  * @num_bursts_exp: number of bursts exponent
4168  * @burst_duration: burst duration
4169  * @ftms_per_burst: number of FTMs per burst
4170  * @ftmr_retries: number of retries for FTM request
4171  * @request_lci: request LCI information
4172  * @request_civicloc: request civic location information
4173  * @trigger_based: use trigger based ranging for the measurement
4174  *		 If neither @trigger_based nor @non_trigger_based is set,
4175  *		 EDCA based ranging will be used.
4176  * @non_trigger_based: use non trigger based ranging for the measurement
4177  *		 If neither @trigger_based nor @non_trigger_based is set,
4178  *		 EDCA based ranging will be used.
4179  * @lmr_feedback: negotiate for I2R LMR feedback. Only valid if either
4180  *		 @trigger_based or @non_trigger_based is set.
4181  * @bss_color: the bss color of the responder. Optional. Set to zero to
4182  *	indicate the driver should set the BSS color. Only valid if
4183  *	@non_trigger_based or @trigger_based is set.
4184  *
4185  * See also nl80211 for the respective attribute documentation.
4186  */
4187 struct cfg80211_pmsr_ftm_request_peer {
4188 	enum nl80211_preamble preamble;
4189 	u16 burst_period;
4190 	u8 requested:1,
4191 	   asap:1,
4192 	   request_lci:1,
4193 	   request_civicloc:1,
4194 	   trigger_based:1,
4195 	   non_trigger_based:1,
4196 	   lmr_feedback:1;
4197 	u8 num_bursts_exp;
4198 	u8 burst_duration;
4199 	u8 ftms_per_burst;
4200 	u8 ftmr_retries;
4201 	u8 bss_color;
4202 };
4203 
4204 /**
4205  * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
4206  * @addr: MAC address
4207  * @chandef: channel to use
4208  * @report_ap_tsf: report the associated AP's TSF
4209  * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
4210  */
4211 struct cfg80211_pmsr_request_peer {
4212 	u8 addr[ETH_ALEN];
4213 	struct cfg80211_chan_def chandef;
4214 	u8 report_ap_tsf:1;
4215 	struct cfg80211_pmsr_ftm_request_peer ftm;
4216 };
4217 
4218 /**
4219  * struct cfg80211_pmsr_request - peer measurement request
4220  * @cookie: cookie, set by cfg80211
4221  * @nl_portid: netlink portid - used by cfg80211
4222  * @drv_data: driver data for this request, if required for aborting,
4223  *	not otherwise freed or anything by cfg80211
4224  * @mac_addr: MAC address used for (randomised) request
4225  * @mac_addr_mask: MAC address mask used for randomisation, bits that
4226  *	are 0 in the mask should be randomised, bits that are 1 should
4227  *	be taken from the @mac_addr
4228  * @list: used by cfg80211 to hold on to the request
4229  * @timeout: timeout (in milliseconds) for the whole operation, if
4230  *	zero it means there's no timeout
4231  * @n_peers: number of peers to do measurements with
4232  * @peers: per-peer measurement request data
4233  */
4234 struct cfg80211_pmsr_request {
4235 	u64 cookie;
4236 	void *drv_data;
4237 	u32 n_peers;
4238 	u32 nl_portid;
4239 
4240 	u32 timeout;
4241 
4242 	u8 mac_addr[ETH_ALEN] __aligned(2);
4243 	u8 mac_addr_mask[ETH_ALEN] __aligned(2);
4244 
4245 	struct list_head list;
4246 
4247 	struct cfg80211_pmsr_request_peer peers[] __counted_by(n_peers);
4248 };
4249 
4250 /**
4251  * struct cfg80211_update_owe_info - OWE Information
4252  *
4253  * This structure provides information needed for the drivers to offload OWE
4254  * (Opportunistic Wireless Encryption) processing to the user space.
4255  *
4256  * Commonly used across update_owe_info request and event interfaces.
4257  *
4258  * @peer: MAC address of the peer device for which the OWE processing
4259  *	has to be done.
4260  * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
4261  *	processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
4262  *	cannot give you the real status code for failures. Used only for
4263  *	OWE update request command interface (user space to driver).
4264  * @ie: IEs obtained from the peer or constructed by the user space. These are
4265  *	the IEs of the remote peer in the event from the host driver and
4266  *	the constructed IEs by the user space in the request interface.
4267  * @ie_len: Length of IEs in octets.
4268  * @assoc_link_id: MLO link ID of the AP, with which (re)association requested
4269  *	by peer. This will be filled by driver for both MLO and non-MLO station
4270  *	connections when the AP affiliated with an MLD. For non-MLD AP mode, it
4271  *	will be -1. Used only with OWE update event (driver to user space).
4272  * @peer_mld_addr: For MLO connection, MLD address of the peer. For non-MLO
4273  *	connection, it will be all zeros. This is applicable only when
4274  *	@assoc_link_id is not -1, i.e., the AP affiliated with an MLD. Used only
4275  *	with OWE update event (driver to user space).
4276  */
4277 struct cfg80211_update_owe_info {
4278 	u8 peer[ETH_ALEN] __aligned(2);
4279 	u16 status;
4280 	const u8 *ie;
4281 	size_t ie_len;
4282 	int assoc_link_id;
4283 	u8 peer_mld_addr[ETH_ALEN] __aligned(2);
4284 };
4285 
4286 /**
4287  * struct mgmt_frame_regs - management frame registrations data
4288  * @global_stypes: bitmap of management frame subtypes registered
4289  *	for the entire device
4290  * @interface_stypes: bitmap of management frame subtypes registered
4291  *	for the given interface
4292  * @global_mcast_stypes: mcast RX is needed globally for these subtypes
4293  * @interface_mcast_stypes: mcast RX is needed on this interface
4294  *	for these subtypes
4295  */
4296 struct mgmt_frame_regs {
4297 	u32 global_stypes, interface_stypes;
4298 	u32 global_mcast_stypes, interface_mcast_stypes;
4299 };
4300 
4301 /**
4302  * struct cfg80211_ops - backend description for wireless configuration
4303  *
4304  * This struct is registered by fullmac card drivers and/or wireless stacks
4305  * in order to handle configuration requests on their interfaces.
4306  *
4307  * All callbacks except where otherwise noted should return 0
4308  * on success or a negative error code.
4309  *
4310  * All operations are invoked with the wiphy mutex held. The RTNL may be
4311  * held in addition (due to wireless extensions) but this cannot be relied
4312  * upon except in cases where documented below. Note that due to ordering,
4313  * the RTNL also cannot be acquired in any handlers.
4314  *
4315  * @suspend: wiphy device needs to be suspended. The variable @wow will
4316  *	be %NULL or contain the enabled Wake-on-Wireless triggers that are
4317  *	configured for the device.
4318  * @resume: wiphy device needs to be resumed
4319  * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
4320  *	to call device_set_wakeup_enable() to enable/disable wakeup from
4321  *	the device.
4322  *
4323  * @add_virtual_intf: create a new virtual interface with the given name,
4324  *	must set the struct wireless_dev's iftype. Beware: You must create
4325  *	the new netdev in the wiphy's network namespace! Returns the struct
4326  *	wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
4327  *	also set the address member in the wdev.
4328  *	This additionally holds the RTNL to be able to do netdev changes.
4329  *
4330  * @del_virtual_intf: remove the virtual interface
4331  *	This additionally holds the RTNL to be able to do netdev changes.
4332  *
4333  * @change_virtual_intf: change type/configuration of virtual interface,
4334  *	keep the struct wireless_dev's iftype updated.
4335  *	This additionally holds the RTNL to be able to do netdev changes.
4336  *
4337  * @add_intf_link: Add a new MLO link to the given interface. Note that
4338  *	the wdev->link[] data structure has been updated, so the new link
4339  *	address is available.
4340  * @del_intf_link: Remove an MLO link from the given interface.
4341  *
4342  * @add_key: add a key with the given parameters. @mac_addr will be %NULL
4343  *	when adding a group key. @link_id will be -1 for non-MLO connection.
4344  *	For MLO connection, @link_id will be >= 0 for group key and -1 for
4345  *	pairwise key, @mac_addr will be peer's MLD address for MLO pairwise key.
4346  *
4347  * @get_key: get information about the key with the given parameters.
4348  *	@mac_addr will be %NULL when requesting information for a group
4349  *	key. All pointers given to the @callback function need not be valid
4350  *	after it returns. This function should return an error if it is
4351  *	not possible to retrieve the key, -ENOENT if it doesn't exist.
4352  *	@link_id will be -1 for non-MLO connection. For MLO connection,
4353  *	@link_id will be >= 0 for group key and -1 for pairwise key, @mac_addr
4354  *	will be peer's MLD address for MLO pairwise key.
4355  *
4356  * @del_key: remove a key given the @mac_addr (%NULL for a group key)
4357  *	and @key_index, return -ENOENT if the key doesn't exist. @link_id will
4358  *	be -1 for non-MLO connection. For MLO connection, @link_id will be >= 0
4359  *	for group key and -1 for pairwise key, @mac_addr will be peer's MLD
4360  *	address for MLO pairwise key.
4361  *
4362  * @set_default_key: set the default key on an interface. @link_id will be >= 0
4363  *	for MLO connection and -1 for non-MLO connection.
4364  *
4365  * @set_default_mgmt_key: set the default management frame key on an interface.
4366  *	@link_id will be >= 0 for MLO connection and -1 for non-MLO connection.
4367  *
4368  * @set_default_beacon_key: set the default Beacon frame key on an interface.
4369  *	@link_id will be >= 0 for MLO connection and -1 for non-MLO connection.
4370  *
4371  * @set_rekey_data: give the data necessary for GTK rekeying to the driver
4372  *
4373  * @start_ap: Start acting in AP mode defined by the parameters.
4374  * @change_beacon: Change the beacon parameters for an access point mode
4375  *	interface. This should reject the call when AP mode wasn't started.
4376  * @stop_ap: Stop being an AP, including stopping beaconing.
4377  *
4378  * @add_station: Add a new station.
4379  * @del_station: Remove a station
4380  * @change_station: Modify a given station. Note that flags changes are not much
4381  *	validated in cfg80211, in particular the auth/assoc/authorized flags
4382  *	might come to the driver in invalid combinations -- make sure to check
4383  *	them, also against the existing state! Drivers must call
4384  *	cfg80211_check_station_change() to validate the information.
4385  * @get_station: get station information for the station identified by @mac
4386  * @dump_station: dump station callback -- resume dump at index @idx
4387  *
4388  * @add_mpath: add a fixed mesh path
4389  * @del_mpath: delete a given mesh path
4390  * @change_mpath: change a given mesh path
4391  * @get_mpath: get a mesh path for the given parameters
4392  * @dump_mpath: dump mesh path callback -- resume dump at index @idx
4393  * @get_mpp: get a mesh proxy path for the given parameters
4394  * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
4395  * @join_mesh: join the mesh network with the specified parameters
4396  *	(invoked with the wireless_dev mutex held)
4397  * @leave_mesh: leave the current mesh network
4398  *	(invoked with the wireless_dev mutex held)
4399  *
4400  * @get_mesh_config: Get the current mesh configuration
4401  *
4402  * @update_mesh_config: Update mesh parameters on a running mesh.
4403  *	The mask is a bitfield which tells us which parameters to
4404  *	set, and which to leave alone.
4405  *
4406  * @change_bss: Modify parameters for a given BSS.
4407  *
4408  * @inform_bss: Called by cfg80211 while being informed about new BSS data
4409  *	for every BSS found within the reported data or frame. This is called
4410  *	from within the cfg8011 inform_bss handlers while holding the bss_lock.
4411  *	The data parameter is passed through from drv_data inside
4412  *	struct cfg80211_inform_bss.
4413  *	The new IE data for the BSS is explicitly passed.
4414  *
4415  * @set_txq_params: Set TX queue parameters
4416  *
4417  * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
4418  *	as it doesn't implement join_mesh and needs to set the channel to
4419  *	join the mesh instead.
4420  *
4421  * @set_monitor_channel: Set the monitor mode channel for the device. If other
4422  *	interfaces are active this callback should reject the configuration.
4423  *	If no interfaces are active or the device is down, the channel should
4424  *	be stored for when a monitor interface becomes active.
4425  *
4426  * @scan: Request to do a scan. If returning zero, the scan request is given
4427  *	the driver, and will be valid until passed to cfg80211_scan_done().
4428  *	For scan results, call cfg80211_inform_bss(); you can call this outside
4429  *	the scan/scan_done bracket too.
4430  * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
4431  *	indicate the status of the scan through cfg80211_scan_done().
4432  *
4433  * @auth: Request to authenticate with the specified peer
4434  *	(invoked with the wireless_dev mutex held)
4435  * @assoc: Request to (re)associate with the specified peer
4436  *	(invoked with the wireless_dev mutex held)
4437  * @deauth: Request to deauthenticate from the specified peer
4438  *	(invoked with the wireless_dev mutex held)
4439  * @disassoc: Request to disassociate from the specified peer
4440  *	(invoked with the wireless_dev mutex held)
4441  *
4442  * @connect: Connect to the ESS with the specified parameters. When connected,
4443  *	call cfg80211_connect_result()/cfg80211_connect_bss() with status code
4444  *	%WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
4445  *	cfg80211_connect_result()/cfg80211_connect_bss() with the status code
4446  *	from the AP or cfg80211_connect_timeout() if no frame with status code
4447  *	was received.
4448  *	The driver is allowed to roam to other BSSes within the ESS when the
4449  *	other BSS matches the connect parameters. When such roaming is initiated
4450  *	by the driver, the driver is expected to verify that the target matches
4451  *	the configured security parameters and to use Reassociation Request
4452  *	frame instead of Association Request frame.
4453  *	The connect function can also be used to request the driver to perform a
4454  *	specific roam when connected to an ESS. In that case, the prev_bssid
4455  *	parameter is set to the BSSID of the currently associated BSS as an
4456  *	indication of requesting reassociation.
4457  *	In both the driver-initiated and new connect() call initiated roaming
4458  *	cases, the result of roaming is indicated with a call to
4459  *	cfg80211_roamed(). (invoked with the wireless_dev mutex held)
4460  * @update_connect_params: Update the connect parameters while connected to a
4461  *	BSS. The updated parameters can be used by driver/firmware for
4462  *	subsequent BSS selection (roaming) decisions and to form the
4463  *	Authentication/(Re)Association Request frames. This call does not
4464  *	request an immediate disassociation or reassociation with the current
4465  *	BSS, i.e., this impacts only subsequent (re)associations. The bits in
4466  *	changed are defined in &enum cfg80211_connect_params_changed.
4467  *	(invoked with the wireless_dev mutex held)
4468  * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
4469  *      connection is in progress. Once done, call cfg80211_disconnected() in
4470  *      case connection was already established (invoked with the
4471  *      wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
4472  *
4473  * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
4474  *	cfg80211_ibss_joined(), also call that function when changing BSSID due
4475  *	to a merge.
4476  *	(invoked with the wireless_dev mutex held)
4477  * @leave_ibss: Leave the IBSS.
4478  *	(invoked with the wireless_dev mutex held)
4479  *
4480  * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
4481  *	MESH mode)
4482  *
4483  * @set_wiphy_params: Notify that wiphy parameters have changed;
4484  *	@changed bitfield (see &enum wiphy_params_flags) describes which values
4485  *	have changed. The actual parameter values are available in
4486  *	struct wiphy. If returning an error, no value should be changed.
4487  *
4488  * @set_tx_power: set the transmit power according to the parameters,
4489  *	the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
4490  *	wdev may be %NULL if power was set for the wiphy, and will
4491  *	always be %NULL unless the driver supports per-vif TX power
4492  *	(as advertised by the nl80211 feature flag.)
4493  * @get_tx_power: store the current TX power into the dbm variable;
4494  *	return 0 if successful
4495  *
4496  * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
4497  *	functions to adjust rfkill hw state
4498  *
4499  * @dump_survey: get site survey information.
4500  *
4501  * @remain_on_channel: Request the driver to remain awake on the specified
4502  *	channel for the specified duration to complete an off-channel
4503  *	operation (e.g., public action frame exchange). When the driver is
4504  *	ready on the requested channel, it must indicate this with an event
4505  *	notification by calling cfg80211_ready_on_channel().
4506  * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
4507  *	This allows the operation to be terminated prior to timeout based on
4508  *	the duration value.
4509  * @mgmt_tx: Transmit a management frame.
4510  * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
4511  *	frame on another channel
4512  *
4513  * @testmode_cmd: run a test mode command; @wdev may be %NULL
4514  * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
4515  *	used by the function, but 0 and 1 must not be touched. Additionally,
4516  *	return error codes other than -ENOBUFS and -ENOENT will terminate the
4517  *	dump and return to userspace with an error, so be careful. If any data
4518  *	was passed in from userspace then the data/len arguments will be present
4519  *	and point to the data contained in %NL80211_ATTR_TESTDATA.
4520  *
4521  * @set_bitrate_mask: set the bitrate mask configuration
4522  *
4523  * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
4524  *	devices running firmwares capable of generating the (re) association
4525  *	RSN IE. It allows for faster roaming between WPA2 BSSIDs.
4526  * @del_pmksa: Delete a cached PMKID.
4527  * @flush_pmksa: Flush all cached PMKIDs.
4528  * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
4529  *	allows the driver to adjust the dynamic ps timeout value.
4530  * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
4531  *	After configuration, the driver should (soon) send an event indicating
4532  *	the current level is above/below the configured threshold; this may
4533  *	need some care when the configuration is changed (without first being
4534  *	disabled.)
4535  * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
4536  *	connection quality monitor.  An event is to be sent only when the
4537  *	signal level is found to be outside the two values.  The driver should
4538  *	set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
4539  *	If it is provided then there's no point providing @set_cqm_rssi_config.
4540  * @set_cqm_txe_config: Configure connection quality monitor TX error
4541  *	thresholds.
4542  * @sched_scan_start: Tell the driver to start a scheduled scan.
4543  * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
4544  *	given request id. This call must stop the scheduled scan and be ready
4545  *	for starting a new one before it returns, i.e. @sched_scan_start may be
4546  *	called immediately after that again and should not fail in that case.
4547  *	The driver should not call cfg80211_sched_scan_stopped() for a requested
4548  *	stop (when this method returns 0).
4549  *
4550  * @update_mgmt_frame_registrations: Notify the driver that management frame
4551  *	registrations were updated. The callback is allowed to sleep.
4552  *
4553  * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
4554  *	Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
4555  *	reject TX/RX mask combinations they cannot support by returning -EINVAL
4556  *	(also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
4557  *
4558  * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
4559  *
4560  * @tdls_mgmt: Transmit a TDLS management frame.
4561  * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
4562  *
4563  * @probe_client: probe an associated client, must return a cookie that it
4564  *	later passes to cfg80211_probe_status().
4565  *
4566  * @set_noack_map: Set the NoAck Map for the TIDs.
4567  *
4568  * @get_channel: Get the current operating channel for the virtual interface.
4569  *	For monitor interfaces, it should return %NULL unless there's a single
4570  *	current monitoring channel.
4571  *
4572  * @start_p2p_device: Start the given P2P device.
4573  * @stop_p2p_device: Stop the given P2P device.
4574  *
4575  * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
4576  *	Parameters include ACL policy, an array of MAC address of stations
4577  *	and the number of MAC addresses. If there is already a list in driver
4578  *	this new list replaces the existing one. Driver has to clear its ACL
4579  *	when number of MAC addresses entries is passed as 0. Drivers which
4580  *	advertise the support for MAC based ACL have to implement this callback.
4581  *
4582  * @start_radar_detection: Start radar detection in the driver.
4583  *
4584  * @end_cac: End running CAC, probably because a related CAC
4585  *	was finished on another phy.
4586  *
4587  * @update_ft_ies: Provide updated Fast BSS Transition information to the
4588  *	driver. If the SME is in the driver/firmware, this information can be
4589  *	used in building Authentication and Reassociation Request frames.
4590  *
4591  * @crit_proto_start: Indicates a critical protocol needs more link reliability
4592  *	for a given duration (milliseconds). The protocol is provided so the
4593  *	driver can take the most appropriate actions.
4594  * @crit_proto_stop: Indicates critical protocol no longer needs increased link
4595  *	reliability. This operation can not fail.
4596  * @set_coalesce: Set coalesce parameters.
4597  *
4598  * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
4599  *	responsible for veryfing if the switch is possible. Since this is
4600  *	inherently tricky driver may decide to disconnect an interface later
4601  *	with cfg80211_stop_iface(). This doesn't mean driver can accept
4602  *	everything. It should do it's best to verify requests and reject them
4603  *	as soon as possible.
4604  *
4605  * @set_qos_map: Set QoS mapping information to the driver
4606  *
4607  * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
4608  *	given interface This is used e.g. for dynamic HT 20/40 MHz channel width
4609  *	changes during the lifetime of the BSS.
4610  *
4611  * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
4612  *	with the given parameters; action frame exchange has been handled by
4613  *	userspace so this just has to modify the TX path to take the TS into
4614  *	account.
4615  *	If the admitted time is 0 just validate the parameters to make sure
4616  *	the session can be created at all; it is valid to just always return
4617  *	success for that but that may result in inefficient behaviour (handshake
4618  *	with the peer followed by immediate teardown when the addition is later
4619  *	rejected)
4620  * @del_tx_ts: remove an existing TX TS
4621  *
4622  * @join_ocb: join the OCB network with the specified parameters
4623  *	(invoked with the wireless_dev mutex held)
4624  * @leave_ocb: leave the current OCB network
4625  *	(invoked with the wireless_dev mutex held)
4626  *
4627  * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
4628  *	is responsible for continually initiating channel-switching operations
4629  *	and returning to the base channel for communication with the AP.
4630  * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
4631  *	peers must be on the base channel when the call completes.
4632  * @start_nan: Start the NAN interface.
4633  * @stop_nan: Stop the NAN interface.
4634  * @add_nan_func: Add a NAN function. Returns negative value on failure.
4635  *	On success @nan_func ownership is transferred to the driver and
4636  *	it may access it outside of the scope of this function. The driver
4637  *	should free the @nan_func when no longer needed by calling
4638  *	cfg80211_free_nan_func().
4639  *	On success the driver should assign an instance_id in the
4640  *	provided @nan_func.
4641  * @del_nan_func: Delete a NAN function.
4642  * @nan_change_conf: changes NAN configuration. The changed parameters must
4643  *	be specified in @changes (using &enum cfg80211_nan_conf_changes);
4644  *	All other parameters must be ignored.
4645  *
4646  * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
4647  *
4648  * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
4649  *      function should return phy stats, and interface stats otherwise.
4650  *
4651  * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
4652  *	If not deleted through @del_pmk the PMK remains valid until disconnect
4653  *	upon which the driver should clear it.
4654  *	(invoked with the wireless_dev mutex held)
4655  * @del_pmk: delete the previously configured PMK for the given authenticator.
4656  *	(invoked with the wireless_dev mutex held)
4657  *
4658  * @external_auth: indicates result of offloaded authentication processing from
4659  *     user space
4660  *
4661  * @tx_control_port: TX a control port frame (EAPoL).  The noencrypt parameter
4662  *	tells the driver that the frame should not be encrypted.
4663  *
4664  * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
4665  *	Statistics should be cumulative, currently no way to reset is provided.
4666  * @start_pmsr: start peer measurement (e.g. FTM)
4667  * @abort_pmsr: abort peer measurement
4668  *
4669  * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
4670  *	but offloading OWE processing to the user space will get the updated
4671  *	DH IE through this interface.
4672  *
4673  * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
4674  *	and overrule HWMP path selection algorithm.
4675  * @set_tid_config: TID specific configuration, this can be peer or BSS specific
4676  *	This callback may sleep.
4677  * @reset_tid_config: Reset TID specific configuration for the peer, for the
4678  *	given TIDs. This callback may sleep.
4679  *
4680  * @set_sar_specs: Update the SAR (TX power) settings.
4681  *
4682  * @color_change: Initiate a color change.
4683  *
4684  * @set_fils_aad: Set FILS AAD data to the AP driver so that the driver can use
4685  *	those to decrypt (Re)Association Request and encrypt (Re)Association
4686  *	Response frame.
4687  *
4688  * @set_radar_background: Configure dedicated offchannel chain available for
4689  *	radar/CAC detection on some hw. This chain can't be used to transmit
4690  *	or receive frames and it is bounded to a running wdev.
4691  *	Background radar/CAC detection allows to avoid the CAC downtime
4692  *	switching to a different channel during CAC detection on the selected
4693  *	radar channel.
4694  *	The caller is expected to set chandef pointer to NULL in order to
4695  *	disable background CAC/radar detection.
4696  * @add_link_station: Add a link to a station.
4697  * @mod_link_station: Modify a link of a station.
4698  * @del_link_station: Remove a link of a station.
4699  *
4700  * @set_hw_timestamp: Enable/disable HW timestamping of TM/FTM frames.
4701  * @set_ttlm: set the TID to link mapping.
4702  * @set_epcs: Enable/Disable EPCS for station mode.
4703  * @get_radio_mask: get bitmask of radios in use.
4704  *	(invoked with the wiphy mutex held)
4705  * @assoc_ml_reconf: Request a non-AP MLO connection to perform ML
4706  *	reconfiguration, i.e., add and/or remove links to/from the
4707  *	association using ML reconfiguration action frames. Successfully added
4708  *	links will be added to the set of valid links. Successfully removed
4709  *	links will be removed from the set of valid links. The driver must
4710  *	indicate removed links by calling cfg80211_links_removed() and added
4711  *	links by calling cfg80211_mlo_reconf_add_done(). When calling
4712  *	cfg80211_mlo_reconf_add_done() the bss pointer must be given for each
4713  *	link for which MLO reconfiguration 'add' operation was requested.
4714  */
4715 struct cfg80211_ops {
4716 	int	(*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
4717 	int	(*resume)(struct wiphy *wiphy);
4718 	void	(*set_wakeup)(struct wiphy *wiphy, bool enabled);
4719 
4720 	struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
4721 						  const char *name,
4722 						  unsigned char name_assign_type,
4723 						  enum nl80211_iftype type,
4724 						  struct vif_params *params);
4725 	int	(*del_virtual_intf)(struct wiphy *wiphy,
4726 				    struct wireless_dev *wdev);
4727 	int	(*change_virtual_intf)(struct wiphy *wiphy,
4728 				       struct net_device *dev,
4729 				       enum nl80211_iftype type,
4730 				       struct vif_params *params);
4731 
4732 	int	(*add_intf_link)(struct wiphy *wiphy,
4733 				 struct wireless_dev *wdev,
4734 				 unsigned int link_id);
4735 	void	(*del_intf_link)(struct wiphy *wiphy,
4736 				 struct wireless_dev *wdev,
4737 				 unsigned int link_id);
4738 
4739 	int	(*add_key)(struct wiphy *wiphy, struct net_device *netdev,
4740 			   int link_id, u8 key_index, bool pairwise,
4741 			   const u8 *mac_addr, struct key_params *params);
4742 	int	(*get_key)(struct wiphy *wiphy, struct net_device *netdev,
4743 			   int link_id, u8 key_index, bool pairwise,
4744 			   const u8 *mac_addr, void *cookie,
4745 			   void (*callback)(void *cookie, struct key_params*));
4746 	int	(*del_key)(struct wiphy *wiphy, struct net_device *netdev,
4747 			   int link_id, u8 key_index, bool pairwise,
4748 			   const u8 *mac_addr);
4749 	int	(*set_default_key)(struct wiphy *wiphy,
4750 				   struct net_device *netdev, int link_id,
4751 				   u8 key_index, bool unicast, bool multicast);
4752 	int	(*set_default_mgmt_key)(struct wiphy *wiphy,
4753 					struct net_device *netdev, int link_id,
4754 					u8 key_index);
4755 	int	(*set_default_beacon_key)(struct wiphy *wiphy,
4756 					  struct net_device *netdev,
4757 					  int link_id,
4758 					  u8 key_index);
4759 
4760 	int	(*start_ap)(struct wiphy *wiphy, struct net_device *dev,
4761 			    struct cfg80211_ap_settings *settings);
4762 	int	(*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
4763 				 struct cfg80211_ap_update *info);
4764 	int	(*stop_ap)(struct wiphy *wiphy, struct net_device *dev,
4765 			   unsigned int link_id);
4766 
4767 
4768 	int	(*add_station)(struct wiphy *wiphy, struct net_device *dev,
4769 			       const u8 *mac,
4770 			       struct station_parameters *params);
4771 	int	(*del_station)(struct wiphy *wiphy, struct net_device *dev,
4772 			       struct station_del_parameters *params);
4773 	int	(*change_station)(struct wiphy *wiphy, struct net_device *dev,
4774 				  const u8 *mac,
4775 				  struct station_parameters *params);
4776 	int	(*get_station)(struct wiphy *wiphy, struct net_device *dev,
4777 			       const u8 *mac, struct station_info *sinfo);
4778 	int	(*dump_station)(struct wiphy *wiphy, struct net_device *dev,
4779 				int idx, u8 *mac, struct station_info *sinfo);
4780 
4781 	int	(*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
4782 			       const u8 *dst, const u8 *next_hop);
4783 	int	(*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
4784 			       const u8 *dst);
4785 	int	(*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
4786 				  const u8 *dst, const u8 *next_hop);
4787 	int	(*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
4788 			     u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
4789 	int	(*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
4790 			      int idx, u8 *dst, u8 *next_hop,
4791 			      struct mpath_info *pinfo);
4792 	int	(*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
4793 			   u8 *dst, u8 *mpp, struct mpath_info *pinfo);
4794 	int	(*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
4795 			    int idx, u8 *dst, u8 *mpp,
4796 			    struct mpath_info *pinfo);
4797 	int	(*get_mesh_config)(struct wiphy *wiphy,
4798 				struct net_device *dev,
4799 				struct mesh_config *conf);
4800 	int	(*update_mesh_config)(struct wiphy *wiphy,
4801 				      struct net_device *dev, u32 mask,
4802 				      const struct mesh_config *nconf);
4803 	int	(*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
4804 			     const struct mesh_config *conf,
4805 			     const struct mesh_setup *setup);
4806 	int	(*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
4807 
4808 	int	(*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
4809 			    struct ocb_setup *setup);
4810 	int	(*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
4811 
4812 	int	(*change_bss)(struct wiphy *wiphy, struct net_device *dev,
4813 			      struct bss_parameters *params);
4814 
4815 	void	(*inform_bss)(struct wiphy *wiphy, struct cfg80211_bss *bss,
4816 			      const struct cfg80211_bss_ies *ies, void *data);
4817 
4818 	int	(*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
4819 				  struct ieee80211_txq_params *params);
4820 
4821 	int	(*libertas_set_mesh_channel)(struct wiphy *wiphy,
4822 					     struct net_device *dev,
4823 					     struct ieee80211_channel *chan);
4824 
4825 	int	(*set_monitor_channel)(struct wiphy *wiphy,
4826 				       struct net_device *dev,
4827 				       struct cfg80211_chan_def *chandef);
4828 
4829 	int	(*scan)(struct wiphy *wiphy,
4830 			struct cfg80211_scan_request *request);
4831 	void	(*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4832 
4833 	int	(*auth)(struct wiphy *wiphy, struct net_device *dev,
4834 			struct cfg80211_auth_request *req);
4835 	int	(*assoc)(struct wiphy *wiphy, struct net_device *dev,
4836 			 struct cfg80211_assoc_request *req);
4837 	int	(*deauth)(struct wiphy *wiphy, struct net_device *dev,
4838 			  struct cfg80211_deauth_request *req);
4839 	int	(*disassoc)(struct wiphy *wiphy, struct net_device *dev,
4840 			    struct cfg80211_disassoc_request *req);
4841 
4842 	int	(*connect)(struct wiphy *wiphy, struct net_device *dev,
4843 			   struct cfg80211_connect_params *sme);
4844 	int	(*update_connect_params)(struct wiphy *wiphy,
4845 					 struct net_device *dev,
4846 					 struct cfg80211_connect_params *sme,
4847 					 u32 changed);
4848 	int	(*disconnect)(struct wiphy *wiphy, struct net_device *dev,
4849 			      u16 reason_code);
4850 
4851 	int	(*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
4852 			     struct cfg80211_ibss_params *params);
4853 	int	(*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
4854 
4855 	int	(*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
4856 				  int rate[NUM_NL80211_BANDS]);
4857 
4858 	int	(*set_wiphy_params)(struct wiphy *wiphy, int radio_idx,
4859 				    u32 changed);
4860 
4861 	int	(*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4862 				int radio_idx,
4863 				enum nl80211_tx_power_setting type, int mbm);
4864 	int	(*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4865 				int radio_idx, unsigned int link_id, int *dbm);
4866 
4867 	void	(*rfkill_poll)(struct wiphy *wiphy);
4868 
4869 #ifdef CONFIG_NL80211_TESTMODE
4870 	int	(*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
4871 				void *data, int len);
4872 	int	(*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
4873 				 struct netlink_callback *cb,
4874 				 void *data, int len);
4875 #endif
4876 
4877 	int	(*set_bitrate_mask)(struct wiphy *wiphy,
4878 				    struct net_device *dev,
4879 				    unsigned int link_id,
4880 				    const u8 *peer,
4881 				    const struct cfg80211_bitrate_mask *mask);
4882 
4883 	int	(*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
4884 			int idx, struct survey_info *info);
4885 
4886 	int	(*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4887 			     struct cfg80211_pmksa *pmksa);
4888 	int	(*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4889 			     struct cfg80211_pmksa *pmksa);
4890 	int	(*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
4891 
4892 	int	(*remain_on_channel)(struct wiphy *wiphy,
4893 				     struct wireless_dev *wdev,
4894 				     struct ieee80211_channel *chan,
4895 				     unsigned int duration,
4896 				     u64 *cookie);
4897 	int	(*cancel_remain_on_channel)(struct wiphy *wiphy,
4898 					    struct wireless_dev *wdev,
4899 					    u64 cookie);
4900 
4901 	int	(*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
4902 			   struct cfg80211_mgmt_tx_params *params,
4903 			   u64 *cookie);
4904 	int	(*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
4905 				       struct wireless_dev *wdev,
4906 				       u64 cookie);
4907 
4908 	int	(*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4909 				  bool enabled, int timeout);
4910 
4911 	int	(*set_cqm_rssi_config)(struct wiphy *wiphy,
4912 				       struct net_device *dev,
4913 				       s32 rssi_thold, u32 rssi_hyst);
4914 
4915 	int	(*set_cqm_rssi_range_config)(struct wiphy *wiphy,
4916 					     struct net_device *dev,
4917 					     s32 rssi_low, s32 rssi_high);
4918 
4919 	int	(*set_cqm_txe_config)(struct wiphy *wiphy,
4920 				      struct net_device *dev,
4921 				      u32 rate, u32 pkts, u32 intvl);
4922 
4923 	void	(*update_mgmt_frame_registrations)(struct wiphy *wiphy,
4924 						   struct wireless_dev *wdev,
4925 						   struct mgmt_frame_regs *upd);
4926 
4927 	int	(*set_antenna)(struct wiphy *wiphy, int radio_idx,
4928 			       u32 tx_ant, u32 rx_ant);
4929 	int	(*get_antenna)(struct wiphy *wiphy, int radio_idx,
4930 			       u32 *tx_ant, u32 *rx_ant);
4931 
4932 	int	(*sched_scan_start)(struct wiphy *wiphy,
4933 				struct net_device *dev,
4934 				struct cfg80211_sched_scan_request *request);
4935 	int	(*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
4936 				   u64 reqid);
4937 
4938 	int	(*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
4939 				  struct cfg80211_gtk_rekey_data *data);
4940 
4941 	int	(*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4942 			     const u8 *peer, int link_id,
4943 			     u8 action_code, u8 dialog_token, u16 status_code,
4944 			     u32 peer_capability, bool initiator,
4945 			     const u8 *buf, size_t len);
4946 	int	(*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
4947 			     const u8 *peer, enum nl80211_tdls_operation oper);
4948 
4949 	int	(*probe_client)(struct wiphy *wiphy, struct net_device *dev,
4950 				const u8 *peer, u64 *cookie);
4951 
4952 	int	(*set_noack_map)(struct wiphy *wiphy,
4953 				  struct net_device *dev,
4954 				  u16 noack_map);
4955 
4956 	int	(*get_channel)(struct wiphy *wiphy,
4957 			       struct wireless_dev *wdev,
4958 			       unsigned int link_id,
4959 			       struct cfg80211_chan_def *chandef);
4960 
4961 	int	(*start_p2p_device)(struct wiphy *wiphy,
4962 				    struct wireless_dev *wdev);
4963 	void	(*stop_p2p_device)(struct wiphy *wiphy,
4964 				   struct wireless_dev *wdev);
4965 
4966 	int	(*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
4967 			       const struct cfg80211_acl_data *params);
4968 
4969 	int	(*start_radar_detection)(struct wiphy *wiphy,
4970 					 struct net_device *dev,
4971 					 struct cfg80211_chan_def *chandef,
4972 					 u32 cac_time_ms, int link_id);
4973 	void	(*end_cac)(struct wiphy *wiphy,
4974 			   struct net_device *dev, unsigned int link_id);
4975 	int	(*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
4976 				 struct cfg80211_update_ft_ies_params *ftie);
4977 	int	(*crit_proto_start)(struct wiphy *wiphy,
4978 				    struct wireless_dev *wdev,
4979 				    enum nl80211_crit_proto_id protocol,
4980 				    u16 duration);
4981 	void	(*crit_proto_stop)(struct wiphy *wiphy,
4982 				   struct wireless_dev *wdev);
4983 	int	(*set_coalesce)(struct wiphy *wiphy,
4984 				struct cfg80211_coalesce *coalesce);
4985 
4986 	int	(*channel_switch)(struct wiphy *wiphy,
4987 				  struct net_device *dev,
4988 				  struct cfg80211_csa_settings *params);
4989 
4990 	int     (*set_qos_map)(struct wiphy *wiphy,
4991 			       struct net_device *dev,
4992 			       struct cfg80211_qos_map *qos_map);
4993 
4994 	int	(*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
4995 				    unsigned int link_id,
4996 				    struct cfg80211_chan_def *chandef);
4997 
4998 	int	(*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4999 			     u8 tsid, const u8 *peer, u8 user_prio,
5000 			     u16 admitted_time);
5001 	int	(*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
5002 			     u8 tsid, const u8 *peer);
5003 
5004 	int	(*tdls_channel_switch)(struct wiphy *wiphy,
5005 				       struct net_device *dev,
5006 				       const u8 *addr, u8 oper_class,
5007 				       struct cfg80211_chan_def *chandef);
5008 	void	(*tdls_cancel_channel_switch)(struct wiphy *wiphy,
5009 					      struct net_device *dev,
5010 					      const u8 *addr);
5011 	int	(*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
5012 			     struct cfg80211_nan_conf *conf);
5013 	void	(*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
5014 	int	(*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
5015 				struct cfg80211_nan_func *nan_func);
5016 	void	(*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
5017 			       u64 cookie);
5018 	int	(*nan_change_conf)(struct wiphy *wiphy,
5019 				   struct wireless_dev *wdev,
5020 				   struct cfg80211_nan_conf *conf,
5021 				   u32 changes);
5022 
5023 	int	(*set_multicast_to_unicast)(struct wiphy *wiphy,
5024 					    struct net_device *dev,
5025 					    const bool enabled);
5026 
5027 	int	(*get_txq_stats)(struct wiphy *wiphy,
5028 				 struct wireless_dev *wdev,
5029 				 struct cfg80211_txq_stats *txqstats);
5030 
5031 	int	(*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
5032 			   const struct cfg80211_pmk_conf *conf);
5033 	int	(*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
5034 			   const u8 *aa);
5035 	int     (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
5036 				 struct cfg80211_external_auth_params *params);
5037 
5038 	int	(*tx_control_port)(struct wiphy *wiphy,
5039 				   struct net_device *dev,
5040 				   const u8 *buf, size_t len,
5041 				   const u8 *dest, const __be16 proto,
5042 				   const bool noencrypt, int link_id,
5043 				   u64 *cookie);
5044 
5045 	int	(*get_ftm_responder_stats)(struct wiphy *wiphy,
5046 				struct net_device *dev,
5047 				struct cfg80211_ftm_responder_stats *ftm_stats);
5048 
5049 	int	(*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
5050 			      struct cfg80211_pmsr_request *request);
5051 	void	(*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
5052 			      struct cfg80211_pmsr_request *request);
5053 	int	(*update_owe_info)(struct wiphy *wiphy, struct net_device *dev,
5054 				   struct cfg80211_update_owe_info *owe_info);
5055 	int	(*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev,
5056 				   const u8 *buf, size_t len);
5057 	int     (*set_tid_config)(struct wiphy *wiphy, struct net_device *dev,
5058 				  struct cfg80211_tid_config *tid_conf);
5059 	int	(*reset_tid_config)(struct wiphy *wiphy, struct net_device *dev,
5060 				    const u8 *peer, u8 tids);
5061 	int	(*set_sar_specs)(struct wiphy *wiphy,
5062 				 struct cfg80211_sar_specs *sar);
5063 	int	(*color_change)(struct wiphy *wiphy,
5064 				struct net_device *dev,
5065 				struct cfg80211_color_change_settings *params);
5066 	int     (*set_fils_aad)(struct wiphy *wiphy, struct net_device *dev,
5067 				struct cfg80211_fils_aad *fils_aad);
5068 	int	(*set_radar_background)(struct wiphy *wiphy,
5069 					struct cfg80211_chan_def *chandef);
5070 	int	(*add_link_station)(struct wiphy *wiphy, struct net_device *dev,
5071 				    struct link_station_parameters *params);
5072 	int	(*mod_link_station)(struct wiphy *wiphy, struct net_device *dev,
5073 				    struct link_station_parameters *params);
5074 	int	(*del_link_station)(struct wiphy *wiphy, struct net_device *dev,
5075 				    struct link_station_del_parameters *params);
5076 	int	(*set_hw_timestamp)(struct wiphy *wiphy, struct net_device *dev,
5077 				    struct cfg80211_set_hw_timestamp *hwts);
5078 	int	(*set_ttlm)(struct wiphy *wiphy, struct net_device *dev,
5079 			    struct cfg80211_ttlm_params *params);
5080 	u32	(*get_radio_mask)(struct wiphy *wiphy, struct net_device *dev);
5081 	int     (*assoc_ml_reconf)(struct wiphy *wiphy, struct net_device *dev,
5082 				   struct cfg80211_ml_reconf_req *req);
5083 	int	(*set_epcs)(struct wiphy *wiphy, struct net_device *dev,
5084 			    bool val);
5085 };
5086 
5087 /*
5088  * wireless hardware and networking interfaces structures
5089  * and registration/helper functions
5090  */
5091 
5092 /**
5093  * enum wiphy_flags - wiphy capability flags
5094  *
5095  * @WIPHY_FLAG_SPLIT_SCAN_6GHZ: if set to true, the scan request will be split
5096  *	 into two, first for legacy bands and second for 6 GHz.
5097  * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
5098  *	wiphy at all
5099  * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
5100  *	by default -- this flag will be set depending on the kernel's default
5101  *	on wiphy_new(), but can be changed by the driver if it has a good
5102  *	reason to override the default
5103  * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
5104  *	on a VLAN interface). This flag also serves an extra purpose of
5105  *	supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
5106  * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
5107  * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
5108  *	control port protocol ethertype. The device also honours the
5109  *	control_port_no_encrypt flag.
5110  * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
5111  * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
5112  *	auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
5113  * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
5114  *	firmware.
5115  * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
5116  * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
5117  * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
5118  *	link setup/discovery operations internally. Setup, discovery and
5119  *	teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
5120  *	command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
5121  *	used for asking the driver/firmware to perform a TDLS operation.
5122  * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
5123  * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
5124  *	when there are virtual interfaces in AP mode by calling
5125  *	cfg80211_report_obss_beacon().
5126  * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
5127  *	responds to probe-requests in hardware.
5128  * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
5129  * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
5130  * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
5131  * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
5132  *	beaconing mode (AP, IBSS, Mesh, ...).
5133  * @WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK: The device supports bigger kek and kck keys
5134  * @WIPHY_FLAG_SUPPORTS_MLO: This is a temporary flag gating the MLO APIs,
5135  *	in order to not have them reachable in normal drivers, until we have
5136  *	complete feature/interface combinations/etc. advertisement. No driver
5137  *	should set this flag for now.
5138  * @WIPHY_FLAG_SUPPORTS_EXT_KCK_32: The device supports 32-byte KCK keys.
5139  * @WIPHY_FLAG_NOTIFY_REGDOM_BY_DRIVER: The device could handle reg notify for
5140  *	NL80211_REGDOM_SET_BY_DRIVER.
5141  * @WIPHY_FLAG_CHANNEL_CHANGE_ON_BEACON: reg_call_notifier() is called if driver
5142  *	set this flag to update channels on beacon hints.
5143  * @WIPHY_FLAG_SUPPORTS_NSTR_NONPRIMARY: support connection to non-primary link
5144  *	of an NSTR mobile AP MLD.
5145  * @WIPHY_FLAG_DISABLE_WEXT: disable wireless extensions for this device
5146  */
5147 enum wiphy_flags {
5148 	WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK		= BIT(0),
5149 	WIPHY_FLAG_SUPPORTS_MLO			= BIT(1),
5150 	WIPHY_FLAG_SPLIT_SCAN_6GHZ		= BIT(2),
5151 	WIPHY_FLAG_NETNS_OK			= BIT(3),
5152 	WIPHY_FLAG_PS_ON_BY_DEFAULT		= BIT(4),
5153 	WIPHY_FLAG_4ADDR_AP			= BIT(5),
5154 	WIPHY_FLAG_4ADDR_STATION		= BIT(6),
5155 	WIPHY_FLAG_CONTROL_PORT_PROTOCOL	= BIT(7),
5156 	WIPHY_FLAG_IBSS_RSN			= BIT(8),
5157 	WIPHY_FLAG_DISABLE_WEXT			= BIT(9),
5158 	WIPHY_FLAG_MESH_AUTH			= BIT(10),
5159 	WIPHY_FLAG_SUPPORTS_EXT_KCK_32          = BIT(11),
5160 	WIPHY_FLAG_SUPPORTS_NSTR_NONPRIMARY	= BIT(12),
5161 	WIPHY_FLAG_SUPPORTS_FW_ROAM		= BIT(13),
5162 	WIPHY_FLAG_AP_UAPSD			= BIT(14),
5163 	WIPHY_FLAG_SUPPORTS_TDLS		= BIT(15),
5164 	WIPHY_FLAG_TDLS_EXTERNAL_SETUP		= BIT(16),
5165 	WIPHY_FLAG_HAVE_AP_SME			= BIT(17),
5166 	WIPHY_FLAG_REPORTS_OBSS			= BIT(18),
5167 	WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD	= BIT(19),
5168 	WIPHY_FLAG_OFFCHAN_TX			= BIT(20),
5169 	WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL	= BIT(21),
5170 	WIPHY_FLAG_SUPPORTS_5_10_MHZ		= BIT(22),
5171 	WIPHY_FLAG_HAS_CHANNEL_SWITCH		= BIT(23),
5172 	WIPHY_FLAG_NOTIFY_REGDOM_BY_DRIVER	= BIT(24),
5173 	WIPHY_FLAG_CHANNEL_CHANGE_ON_BEACON     = BIT(25),
5174 };
5175 
5176 /**
5177  * struct ieee80211_iface_limit - limit on certain interface types
5178  * @max: maximum number of interfaces of these types
5179  * @types: interface types (bits)
5180  */
5181 struct ieee80211_iface_limit {
5182 	u16 max;
5183 	u16 types;
5184 };
5185 
5186 /**
5187  * struct ieee80211_iface_combination - possible interface combination
5188  *
5189  * With this structure the driver can describe which interface
5190  * combinations it supports concurrently. When set in a struct wiphy_radio,
5191  * the combinations refer to combinations of interfaces currently active on
5192  * that radio.
5193  *
5194  * Examples:
5195  *
5196  * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
5197  *
5198  *    .. code-block:: c
5199  *
5200  *	struct ieee80211_iface_limit limits1[] = {
5201  *		{ .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
5202  *		{ .max = 1, .types = BIT(NL80211_IFTYPE_AP), },
5203  *	};
5204  *	struct ieee80211_iface_combination combination1 = {
5205  *		.limits = limits1,
5206  *		.n_limits = ARRAY_SIZE(limits1),
5207  *		.max_interfaces = 2,
5208  *		.beacon_int_infra_match = true,
5209  *	};
5210  *
5211  *
5212  * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
5213  *
5214  *    .. code-block:: c
5215  *
5216  *	struct ieee80211_iface_limit limits2[] = {
5217  *		{ .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
5218  *				     BIT(NL80211_IFTYPE_P2P_GO), },
5219  *	};
5220  *	struct ieee80211_iface_combination combination2 = {
5221  *		.limits = limits2,
5222  *		.n_limits = ARRAY_SIZE(limits2),
5223  *		.max_interfaces = 8,
5224  *		.num_different_channels = 1,
5225  *	};
5226  *
5227  *
5228  * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
5229  *
5230  *    This allows for an infrastructure connection and three P2P connections.
5231  *
5232  *    .. code-block:: c
5233  *
5234  *	struct ieee80211_iface_limit limits3[] = {
5235  *		{ .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
5236  *		{ .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
5237  *				     BIT(NL80211_IFTYPE_P2P_CLIENT), },
5238  *	};
5239  *	struct ieee80211_iface_combination combination3 = {
5240  *		.limits = limits3,
5241  *		.n_limits = ARRAY_SIZE(limits3),
5242  *		.max_interfaces = 4,
5243  *		.num_different_channels = 2,
5244  *	};
5245  *
5246  */
5247 struct ieee80211_iface_combination {
5248 	/**
5249 	 * @limits:
5250 	 * limits for the given interface types
5251 	 */
5252 	const struct ieee80211_iface_limit *limits;
5253 
5254 	/**
5255 	 * @num_different_channels:
5256 	 * can use up to this many different channels
5257 	 */
5258 	u32 num_different_channels;
5259 
5260 	/**
5261 	 * @max_interfaces:
5262 	 * maximum number of interfaces in total allowed in this group
5263 	 */
5264 	u16 max_interfaces;
5265 
5266 	/**
5267 	 * @n_limits:
5268 	 * number of limitations
5269 	 */
5270 	u8 n_limits;
5271 
5272 	/**
5273 	 * @beacon_int_infra_match:
5274 	 * In this combination, the beacon intervals between infrastructure
5275 	 * and AP types must match. This is required only in special cases.
5276 	 */
5277 	bool beacon_int_infra_match;
5278 
5279 	/**
5280 	 * @radar_detect_widths:
5281 	 * bitmap of channel widths supported for radar detection
5282 	 */
5283 	u8 radar_detect_widths;
5284 
5285 	/**
5286 	 * @radar_detect_regions:
5287 	 * bitmap of regions supported for radar detection
5288 	 */
5289 	u8 radar_detect_regions;
5290 
5291 	/**
5292 	 * @beacon_int_min_gcd:
5293 	 * This interface combination supports different beacon intervals.
5294 	 *
5295 	 * = 0
5296 	 *   all beacon intervals for different interface must be same.
5297 	 * > 0
5298 	 *   any beacon interval for the interface part of this combination AND
5299 	 *   GCD of all beacon intervals from beaconing interfaces of this
5300 	 *   combination must be greater or equal to this value.
5301 	 */
5302 	u32 beacon_int_min_gcd;
5303 };
5304 
5305 struct ieee80211_txrx_stypes {
5306 	u16 tx, rx;
5307 };
5308 
5309 /**
5310  * enum wiphy_wowlan_support_flags - WoWLAN support flags
5311  * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
5312  *	trigger that keeps the device operating as-is and
5313  *	wakes up the host on any activity, for example a
5314  *	received packet that passed filtering; note that the
5315  *	packet should be preserved in that case
5316  * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
5317  *	(see nl80211.h)
5318  * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
5319  * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
5320  * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
5321  * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
5322  * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
5323  * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
5324  * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
5325  */
5326 enum wiphy_wowlan_support_flags {
5327 	WIPHY_WOWLAN_ANY		= BIT(0),
5328 	WIPHY_WOWLAN_MAGIC_PKT		= BIT(1),
5329 	WIPHY_WOWLAN_DISCONNECT		= BIT(2),
5330 	WIPHY_WOWLAN_SUPPORTS_GTK_REKEY	= BIT(3),
5331 	WIPHY_WOWLAN_GTK_REKEY_FAILURE	= BIT(4),
5332 	WIPHY_WOWLAN_EAP_IDENTITY_REQ	= BIT(5),
5333 	WIPHY_WOWLAN_4WAY_HANDSHAKE	= BIT(6),
5334 	WIPHY_WOWLAN_RFKILL_RELEASE	= BIT(7),
5335 	WIPHY_WOWLAN_NET_DETECT		= BIT(8),
5336 };
5337 
5338 struct wiphy_wowlan_tcp_support {
5339 	const struct nl80211_wowlan_tcp_data_token_feature *tok;
5340 	u32 data_payload_max;
5341 	u32 data_interval_max;
5342 	u32 wake_payload_max;
5343 	bool seq;
5344 };
5345 
5346 /**
5347  * struct wiphy_wowlan_support - WoWLAN support data
5348  * @flags: see &enum wiphy_wowlan_support_flags
5349  * @n_patterns: number of supported wakeup patterns
5350  *	(see nl80211.h for the pattern definition)
5351  * @pattern_max_len: maximum length of each pattern
5352  * @pattern_min_len: minimum length of each pattern
5353  * @max_pkt_offset: maximum Rx packet offset
5354  * @max_nd_match_sets: maximum number of matchsets for net-detect,
5355  *	similar, but not necessarily identical, to max_match_sets for
5356  *	scheduled scans.
5357  *	See &struct cfg80211_sched_scan_request.@match_sets for more
5358  *	details.
5359  * @tcp: TCP wakeup support information
5360  */
5361 struct wiphy_wowlan_support {
5362 	u32 flags;
5363 	int n_patterns;
5364 	int pattern_max_len;
5365 	int pattern_min_len;
5366 	int max_pkt_offset;
5367 	int max_nd_match_sets;
5368 	const struct wiphy_wowlan_tcp_support *tcp;
5369 };
5370 
5371 /**
5372  * struct wiphy_coalesce_support - coalesce support data
5373  * @n_rules: maximum number of coalesce rules
5374  * @max_delay: maximum supported coalescing delay in msecs
5375  * @n_patterns: number of supported patterns in a rule
5376  *	(see nl80211.h for the pattern definition)
5377  * @pattern_max_len: maximum length of each pattern
5378  * @pattern_min_len: minimum length of each pattern
5379  * @max_pkt_offset: maximum Rx packet offset
5380  */
5381 struct wiphy_coalesce_support {
5382 	int n_rules;
5383 	int max_delay;
5384 	int n_patterns;
5385 	int pattern_max_len;
5386 	int pattern_min_len;
5387 	int max_pkt_offset;
5388 };
5389 
5390 /**
5391  * enum wiphy_vendor_command_flags - validation flags for vendor commands
5392  * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
5393  * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
5394  * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
5395  *	(must be combined with %_WDEV or %_NETDEV)
5396  */
5397 enum wiphy_vendor_command_flags {
5398 	WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
5399 	WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
5400 	WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
5401 };
5402 
5403 /**
5404  * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
5405  *
5406  * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
5407  * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
5408  * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
5409  *
5410  */
5411 enum wiphy_opmode_flag {
5412 	STA_OPMODE_MAX_BW_CHANGED	= BIT(0),
5413 	STA_OPMODE_SMPS_MODE_CHANGED	= BIT(1),
5414 	STA_OPMODE_N_SS_CHANGED		= BIT(2),
5415 };
5416 
5417 /**
5418  * struct sta_opmode_info - Station's ht/vht operation mode information
5419  * @changed: contains value from &enum wiphy_opmode_flag
5420  * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
5421  * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
5422  * @rx_nss: new rx_nss value of a station
5423  */
5424 
5425 struct sta_opmode_info {
5426 	u32 changed;
5427 	enum nl80211_smps_mode smps_mode;
5428 	enum nl80211_chan_width bw;
5429 	u8 rx_nss;
5430 };
5431 
5432 #define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA))
5433 
5434 /**
5435  * struct wiphy_vendor_command - vendor command definition
5436  * @info: vendor command identifying information, as used in nl80211
5437  * @flags: flags, see &enum wiphy_vendor_command_flags
5438  * @doit: callback for the operation, note that wdev is %NULL if the
5439  *	flags didn't ask for a wdev and non-%NULL otherwise; the data
5440  *	pointer may be %NULL if userspace provided no data at all
5441  * @dumpit: dump callback, for transferring bigger/multiple items. The
5442  *	@storage points to cb->args[5], ie. is preserved over the multiple
5443  *	dumpit calls.
5444  * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
5445  *	Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
5446  *	attribute is just raw data (e.g. a firmware command).
5447  * @maxattr: highest attribute number in policy
5448  * It's recommended to not have the same sub command with both @doit and
5449  * @dumpit, so that userspace can assume certain ones are get and others
5450  * are used with dump requests.
5451  */
5452 struct wiphy_vendor_command {
5453 	struct nl80211_vendor_cmd_info info;
5454 	u32 flags;
5455 	int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
5456 		    const void *data, int data_len);
5457 	int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
5458 		      struct sk_buff *skb, const void *data, int data_len,
5459 		      unsigned long *storage);
5460 	const struct nla_policy *policy;
5461 	unsigned int maxattr;
5462 };
5463 
5464 /**
5465  * struct wiphy_iftype_ext_capab - extended capabilities per interface type
5466  * @iftype: interface type
5467  * @extended_capabilities: extended capabilities supported by the driver,
5468  *	additional capabilities might be supported by userspace; these are the
5469  *	802.11 extended capabilities ("Extended Capabilities element") and are
5470  *	in the same format as in the information element. See IEEE Std
5471  *	802.11-2012 8.4.2.29 for the defined fields.
5472  * @extended_capabilities_mask: mask of the valid values
5473  * @extended_capabilities_len: length of the extended capabilities
5474  * @eml_capabilities: EML capabilities (for MLO)
5475  * @mld_capa_and_ops: MLD capabilities and operations (for MLO)
5476  */
5477 struct wiphy_iftype_ext_capab {
5478 	enum nl80211_iftype iftype;
5479 	const u8 *extended_capabilities;
5480 	const u8 *extended_capabilities_mask;
5481 	u8 extended_capabilities_len;
5482 	u16 eml_capabilities;
5483 	u16 mld_capa_and_ops;
5484 };
5485 
5486 /**
5487  * cfg80211_get_iftype_ext_capa - lookup interface type extended capability
5488  * @wiphy: the wiphy to look up from
5489  * @type: the interface type to look up
5490  *
5491  * Return: The extended capability for the given interface @type, may be %NULL
5492  */
5493 const struct wiphy_iftype_ext_capab *
5494 cfg80211_get_iftype_ext_capa(struct wiphy *wiphy, enum nl80211_iftype type);
5495 
5496 /**
5497  * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
5498  * @max_peers: maximum number of peers in a single measurement
5499  * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
5500  * @randomize_mac_addr: can randomize MAC address for measurement
5501  * @ftm: FTM measurement data
5502  * @ftm.supported: FTM measurement is supported
5503  * @ftm.asap: ASAP-mode is supported
5504  * @ftm.non_asap: non-ASAP-mode is supported
5505  * @ftm.request_lci: can request LCI data
5506  * @ftm.request_civicloc: can request civic location data
5507  * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
5508  * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
5509  * @ftm.max_bursts_exponent: maximum burst exponent supported
5510  *	(set to -1 if not limited; note that setting this will necessarily
5511  *	forbid using the value 15 to let the responder pick)
5512  * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
5513  *	not limited)
5514  * @ftm.trigger_based: trigger based ranging measurement is supported
5515  * @ftm.non_trigger_based: non trigger based ranging measurement is supported
5516  */
5517 struct cfg80211_pmsr_capabilities {
5518 	unsigned int max_peers;
5519 	u8 report_ap_tsf:1,
5520 	   randomize_mac_addr:1;
5521 
5522 	struct {
5523 		u32 preambles;
5524 		u32 bandwidths;
5525 		s8 max_bursts_exponent;
5526 		u8 max_ftms_per_burst;
5527 		u8 supported:1,
5528 		   asap:1,
5529 		   non_asap:1,
5530 		   request_lci:1,
5531 		   request_civicloc:1,
5532 		   trigger_based:1,
5533 		   non_trigger_based:1;
5534 	} ftm;
5535 };
5536 
5537 /**
5538  * struct wiphy_iftype_akm_suites - This structure encapsulates supported akm
5539  * suites for interface types defined in @iftypes_mask. Each type in the
5540  * @iftypes_mask must be unique across all instances of iftype_akm_suites.
5541  *
5542  * @iftypes_mask: bitmask of interfaces types
5543  * @akm_suites: points to an array of supported akm suites
5544  * @n_akm_suites: number of supported AKM suites
5545  */
5546 struct wiphy_iftype_akm_suites {
5547 	u16 iftypes_mask;
5548 	const u32 *akm_suites;
5549 	int n_akm_suites;
5550 };
5551 
5552 /**
5553  * struct wiphy_radio_cfg - physical radio config of a wiphy
5554  * This structure describes the configurations of a physical radio in a
5555  * wiphy. It is used to denote per-radio attributes belonging to a wiphy.
5556  *
5557  * @rts_threshold: RTS threshold (dot11RTSThreshold);
5558  *	-1 (default) = RTS/CTS disabled
5559  */
5560 struct wiphy_radio_cfg {
5561 	u32 rts_threshold;
5562 };
5563 
5564 /**
5565  * struct wiphy_radio_freq_range - wiphy frequency range
5566  * @start_freq:  start range edge frequency (kHz)
5567  * @end_freq:    end range edge frequency (kHz)
5568  */
5569 struct wiphy_radio_freq_range {
5570 	u32 start_freq;
5571 	u32 end_freq;
5572 };
5573 
5574 
5575 /**
5576  * struct wiphy_radio - physical radio of a wiphy
5577  * This structure describes a physical radio belonging to a wiphy.
5578  * It is used to describe concurrent-channel capabilities. Only one channel
5579  * can be active on the radio described by struct wiphy_radio.
5580  *
5581  * @freq_range: frequency range that the radio can operate on.
5582  * @n_freq_range: number of elements in @freq_range
5583  *
5584  * @iface_combinations: Valid interface combinations array, should not
5585  *	list single interface types.
5586  * @n_iface_combinations: number of entries in @iface_combinations array.
5587  *
5588  * @antenna_mask: bitmask of antennas connected to this radio.
5589  */
5590 struct wiphy_radio {
5591 	const struct wiphy_radio_freq_range *freq_range;
5592 	int n_freq_range;
5593 
5594 	const struct ieee80211_iface_combination *iface_combinations;
5595 	int n_iface_combinations;
5596 
5597 	u32 antenna_mask;
5598 };
5599 
5600 #define CFG80211_HW_TIMESTAMP_ALL_PEERS	0xffff
5601 
5602 /**
5603  * struct wiphy - wireless hardware description
5604  * @mtx: mutex for the data (structures) of this device
5605  * @reg_notifier: the driver's regulatory notification callback,
5606  *	note that if your driver uses wiphy_apply_custom_regulatory()
5607  *	the reg_notifier's request can be passed as NULL
5608  * @regd: the driver's regulatory domain, if one was requested via
5609  *	the regulatory_hint() API. This can be used by the driver
5610  *	on the reg_notifier() if it chooses to ignore future
5611  *	regulatory domain changes caused by other drivers.
5612  * @signal_type: signal type reported in &struct cfg80211_bss.
5613  * @cipher_suites: supported cipher suites
5614  * @n_cipher_suites: number of supported cipher suites
5615  * @akm_suites: supported AKM suites. These are the default AKMs supported if
5616  *	the supported AKMs not advertized for a specific interface type in
5617  *	iftype_akm_suites.
5618  * @n_akm_suites: number of supported AKM suites
5619  * @iftype_akm_suites: array of supported akm suites info per interface type.
5620  *	Note that the bits in @iftypes_mask inside this structure cannot
5621  *	overlap (i.e. only one occurrence of each type is allowed across all
5622  *	instances of iftype_akm_suites).
5623  * @num_iftype_akm_suites: number of interface types for which supported akm
5624  *	suites are specified separately.
5625  * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
5626  * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
5627  * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
5628  *	-1 = fragmentation disabled, only odd values >= 256 used
5629  * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
5630  * @_net: the network namespace this wiphy currently lives in
5631  * @perm_addr: permanent MAC address of this device
5632  * @addr_mask: If the device supports multiple MAC addresses by masking,
5633  *	set this to a mask with variable bits set to 1, e.g. if the last
5634  *	four bits are variable then set it to 00-00-00-00-00-0f. The actual
5635  *	variable bits shall be determined by the interfaces added, with
5636  *	interfaces not matching the mask being rejected to be brought up.
5637  * @n_addresses: number of addresses in @addresses.
5638  * @addresses: If the device has more than one address, set this pointer
5639  *	to a list of addresses (6 bytes each). The first one will be used
5640  *	by default for perm_addr. In this case, the mask should be set to
5641  *	all-zeroes. In this case it is assumed that the device can handle
5642  *	the same number of arbitrary MAC addresses.
5643  * @registered: protects ->resume and ->suspend sysfs callbacks against
5644  *	unregister hardware
5645  * @debugfsdir: debugfs directory used for this wiphy (ieee80211/<wiphyname>).
5646  *	It will be renamed automatically on wiphy renames
5647  * @dev: (virtual) struct device for this wiphy. The item in
5648  *	/sys/class/ieee80211/ points to this. You need use set_wiphy_dev()
5649  *	(see below).
5650  * @wext: wireless extension handlers
5651  * @priv: driver private data (sized according to wiphy_new() parameter)
5652  * @interface_modes: bitmask of interfaces types valid for this wiphy,
5653  *	must be set by driver
5654  * @iface_combinations: Valid interface combinations array, should not
5655  *	list single interface types.
5656  * @n_iface_combinations: number of entries in @iface_combinations array.
5657  * @software_iftypes: bitmask of software interface types, these are not
5658  *	subject to any restrictions since they are purely managed in SW.
5659  * @flags: wiphy flags, see &enum wiphy_flags
5660  * @regulatory_flags: wiphy regulatory flags, see
5661  *	&enum ieee80211_regulatory_flags
5662  * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
5663  * @ext_features: extended features advertised to nl80211, see
5664  *	&enum nl80211_ext_feature_index.
5665  * @bss_priv_size: each BSS struct has private data allocated with it,
5666  *	this variable determines its size
5667  * @max_scan_ssids: maximum number of SSIDs the device can scan for in
5668  *	any given scan
5669  * @max_sched_scan_reqs: maximum number of scheduled scan requests that
5670  *	the device can run concurrently.
5671  * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
5672  *	for in any given scheduled scan
5673  * @max_match_sets: maximum number of match sets the device can handle
5674  *	when performing a scheduled scan, 0 if filtering is not
5675  *	supported.
5676  * @max_scan_ie_len: maximum length of user-controlled IEs device can
5677  *	add to probe request frames transmitted during a scan, must not
5678  *	include fixed IEs like supported rates
5679  * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
5680  *	scans
5681  * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
5682  *	of iterations) for scheduled scan supported by the device.
5683  * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
5684  *	single scan plan supported by the device.
5685  * @max_sched_scan_plan_iterations: maximum number of iterations for a single
5686  *	scan plan supported by the device.
5687  * @coverage_class: current coverage class
5688  * @fw_version: firmware version for ethtool reporting
5689  * @hw_version: hardware version for ethtool reporting
5690  * @max_num_pmkids: maximum number of PMKIDs supported by device
5691  * @privid: a pointer that drivers can use to identify if an arbitrary
5692  *	wiphy is theirs, e.g. in global notifiers
5693  * @bands: information about bands/channels supported by this device
5694  *
5695  * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
5696  *	transmitted through nl80211, points to an array indexed by interface
5697  *	type
5698  *
5699  * @available_antennas_tx: bitmap of antennas which are available to be
5700  *	configured as TX antennas. Antenna configuration commands will be
5701  *	rejected unless this or @available_antennas_rx is set.
5702  *
5703  * @available_antennas_rx: bitmap of antennas which are available to be
5704  *	configured as RX antennas. Antenna configuration commands will be
5705  *	rejected unless this or @available_antennas_tx is set.
5706  *
5707  * @probe_resp_offload:
5708  *	 Bitmap of supported protocols for probe response offloading.
5709  *	 See &enum nl80211_probe_resp_offload_support_attr. Only valid
5710  *	 when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
5711  *
5712  * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
5713  *	may request, if implemented.
5714  *
5715  * @wowlan: WoWLAN support information
5716  * @wowlan_config: current WoWLAN configuration; this should usually not be
5717  *	used since access to it is necessarily racy, use the parameter passed
5718  *	to the suspend() operation instead.
5719  *
5720  * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
5721  * @ht_capa_mod_mask:  Specify what ht_cap values can be over-ridden.
5722  *	If null, then none can be over-ridden.
5723  * @vht_capa_mod_mask:  Specify what VHT capabilities can be over-ridden.
5724  *	If null, then none can be over-ridden.
5725  *
5726  * @wdev_list: the list of associated (virtual) interfaces; this list must
5727  *	not be modified by the driver, but can be read with RTNL/RCU protection.
5728  *
5729  * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
5730  *	supports for ACL.
5731  *
5732  * @extended_capabilities: extended capabilities supported by the driver,
5733  *	additional capabilities might be supported by userspace; these are
5734  *	the 802.11 extended capabilities ("Extended Capabilities element")
5735  *	and are in the same format as in the information element. See
5736  *	802.11-2012 8.4.2.29 for the defined fields. These are the default
5737  *	extended capabilities to be used if the capabilities are not specified
5738  *	for a specific interface type in iftype_ext_capab.
5739  * @extended_capabilities_mask: mask of the valid values
5740  * @extended_capabilities_len: length of the extended capabilities
5741  * @iftype_ext_capab: array of extended capabilities per interface type
5742  * @num_iftype_ext_capab: number of interface types for which extended
5743  *	capabilities are specified separately.
5744  * @coalesce: packet coalescing support information
5745  *
5746  * @vendor_commands: array of vendor commands supported by the hardware
5747  * @n_vendor_commands: number of vendor commands
5748  * @vendor_events: array of vendor events supported by the hardware
5749  * @n_vendor_events: number of vendor events
5750  *
5751  * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
5752  *	(including P2P GO) or 0 to indicate no such limit is advertised. The
5753  *	driver is allowed to advertise a theoretical limit that it can reach in
5754  *	some cases, but may not always reach.
5755  *
5756  * @max_num_csa_counters: Number of supported csa_counters in beacons
5757  *	and probe responses.  This value should be set if the driver
5758  *	wishes to limit the number of csa counters. Default (0) means
5759  *	infinite.
5760  * @bss_select_support: bitmask indicating the BSS selection criteria supported
5761  *	by the driver in the .connect() callback. The bit position maps to the
5762  *	attribute indices defined in &enum nl80211_bss_select_attr.
5763  *
5764  * @nan_supported_bands: bands supported by the device in NAN mode, a
5765  *	bitmap of &enum nl80211_band values.  For instance, for
5766  *	NL80211_BAND_2GHZ, bit 0 would be set
5767  *	(i.e. BIT(NL80211_BAND_2GHZ)).
5768  *
5769  * @txq_limit: configuration of internal TX queue frame limit
5770  * @txq_memory_limit: configuration internal TX queue memory limit
5771  * @txq_quantum: configuration of internal TX queue scheduler quantum
5772  *
5773  * @tx_queue_len: allow setting transmit queue len for drivers not using
5774  *	wake_tx_queue
5775  *
5776  * @support_mbssid: can HW support association with nontransmitted AP
5777  * @support_only_he_mbssid: don't parse MBSSID elements if it is not
5778  *	HE AP, in order to avoid compatibility issues.
5779  *	@support_mbssid must be set for this to have any effect.
5780  *
5781  * @pmsr_capa: peer measurement capabilities
5782  *
5783  * @tid_config_support: describes the per-TID config support that the
5784  *	device has
5785  * @tid_config_support.vif: bitmap of attributes (configurations)
5786  *	supported by the driver for each vif
5787  * @tid_config_support.peer: bitmap of attributes (configurations)
5788  *	supported by the driver for each peer
5789  * @tid_config_support.max_retry: maximum supported retry count for
5790  *	long/short retry configuration
5791  *
5792  * @max_data_retry_count: maximum supported per TID retry count for
5793  *	configuration through the %NL80211_TID_CONFIG_ATTR_RETRY_SHORT and
5794  *	%NL80211_TID_CONFIG_ATTR_RETRY_LONG attributes
5795  * @sar_capa: SAR control capabilities
5796  * @rfkill: a pointer to the rfkill structure
5797  *
5798  * @mbssid_max_interfaces: maximum number of interfaces supported by the driver
5799  *	in a multiple BSSID set. This field must be set to a non-zero value
5800  *	by the driver to advertise MBSSID support.
5801  * @ema_max_profile_periodicity: maximum profile periodicity supported by
5802  *	the driver. Setting this field to a non-zero value indicates that the
5803  *	driver supports enhanced multi-BSSID advertisements (EMA AP).
5804  * @max_num_akm_suites: maximum number of AKM suites allowed for
5805  *	configuration through %NL80211_CMD_CONNECT, %NL80211_CMD_ASSOCIATE and
5806  *	%NL80211_CMD_START_AP. Set to NL80211_MAX_NR_AKM_SUITES if not set by
5807  *	driver. If set by driver minimum allowed value is
5808  *	NL80211_MAX_NR_AKM_SUITES in order to avoid compatibility issues with
5809  *	legacy userspace and maximum allowed value is
5810  *	CFG80211_MAX_NUM_AKM_SUITES.
5811  *
5812  * @hw_timestamp_max_peers: maximum number of peers that the driver supports
5813  *	enabling HW timestamping for concurrently. Setting this field to a
5814  *	non-zero value indicates that the driver supports HW timestamping.
5815  *	A value of %CFG80211_HW_TIMESTAMP_ALL_PEERS indicates the driver
5816  *	supports enabling HW timestamping for all peers (i.e. no need to
5817  *	specify a mac address).
5818  *
5819  * @radio_cfg: configuration of radios belonging to a muli-radio wiphy. This
5820  *	struct contains a list of all radio specific attributes and should be
5821  *	used only for multi-radio wiphy.
5822  *
5823  * @radio: radios belonging to this wiphy
5824  * @n_radio: number of radios
5825  */
5826 struct wiphy {
5827 	struct mutex mtx;
5828 
5829 	/* assign these fields before you register the wiphy */
5830 
5831 	u8 perm_addr[ETH_ALEN];
5832 	u8 addr_mask[ETH_ALEN];
5833 
5834 	struct mac_address *addresses;
5835 
5836 	const struct ieee80211_txrx_stypes *mgmt_stypes;
5837 
5838 	const struct ieee80211_iface_combination *iface_combinations;
5839 	int n_iface_combinations;
5840 	u16 software_iftypes;
5841 
5842 	u16 n_addresses;
5843 
5844 	/* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
5845 	u16 interface_modes;
5846 
5847 	u16 max_acl_mac_addrs;
5848 
5849 	u32 flags, regulatory_flags, features;
5850 	u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
5851 
5852 	u32 ap_sme_capa;
5853 
5854 	enum cfg80211_signal_type signal_type;
5855 
5856 	int bss_priv_size;
5857 	u8 max_scan_ssids;
5858 	u8 max_sched_scan_reqs;
5859 	u8 max_sched_scan_ssids;
5860 	u8 max_match_sets;
5861 	u16 max_scan_ie_len;
5862 	u16 max_sched_scan_ie_len;
5863 	u32 max_sched_scan_plans;
5864 	u32 max_sched_scan_plan_interval;
5865 	u32 max_sched_scan_plan_iterations;
5866 
5867 	int n_cipher_suites;
5868 	const u32 *cipher_suites;
5869 
5870 	int n_akm_suites;
5871 	const u32 *akm_suites;
5872 
5873 	const struct wiphy_iftype_akm_suites *iftype_akm_suites;
5874 	unsigned int num_iftype_akm_suites;
5875 
5876 	u8 retry_short;
5877 	u8 retry_long;
5878 	u32 frag_threshold;
5879 	u32 rts_threshold;
5880 	u8 coverage_class;
5881 
5882 	char fw_version[ETHTOOL_FWVERS_LEN];
5883 	u32 hw_version;
5884 
5885 #ifdef CONFIG_PM
5886 	const struct wiphy_wowlan_support *wowlan;
5887 	struct cfg80211_wowlan *wowlan_config;
5888 #endif
5889 
5890 	u16 max_remain_on_channel_duration;
5891 
5892 	u8 max_num_pmkids;
5893 
5894 	u32 available_antennas_tx;
5895 	u32 available_antennas_rx;
5896 
5897 	u32 probe_resp_offload;
5898 
5899 	const u8 *extended_capabilities, *extended_capabilities_mask;
5900 	u8 extended_capabilities_len;
5901 
5902 	const struct wiphy_iftype_ext_capab *iftype_ext_capab;
5903 	unsigned int num_iftype_ext_capab;
5904 
5905 	const void *privid;
5906 
5907 	struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
5908 
5909 	void (*reg_notifier)(struct wiphy *wiphy,
5910 			     struct regulatory_request *request);
5911 
5912 	struct wiphy_radio_cfg *radio_cfg;
5913 
5914 	/* fields below are read-only, assigned by cfg80211 */
5915 
5916 	const struct ieee80211_regdomain __rcu *regd;
5917 
5918 	struct device dev;
5919 
5920 	bool registered;
5921 
5922 	struct dentry *debugfsdir;
5923 
5924 	const struct ieee80211_ht_cap *ht_capa_mod_mask;
5925 	const struct ieee80211_vht_cap *vht_capa_mod_mask;
5926 
5927 	struct list_head wdev_list;
5928 
5929 	possible_net_t _net;
5930 
5931 #ifdef CONFIG_CFG80211_WEXT
5932 	const struct iw_handler_def *wext;
5933 #endif
5934 
5935 	const struct wiphy_coalesce_support *coalesce;
5936 
5937 	const struct wiphy_vendor_command *vendor_commands;
5938 	const struct nl80211_vendor_cmd_info *vendor_events;
5939 	int n_vendor_commands, n_vendor_events;
5940 
5941 	u16 max_ap_assoc_sta;
5942 
5943 	u8 max_num_csa_counters;
5944 
5945 	u32 bss_select_support;
5946 
5947 	u8 nan_supported_bands;
5948 
5949 	u32 txq_limit;
5950 	u32 txq_memory_limit;
5951 	u32 txq_quantum;
5952 
5953 	unsigned long tx_queue_len;
5954 
5955 	u8 support_mbssid:1,
5956 	   support_only_he_mbssid:1;
5957 
5958 	const struct cfg80211_pmsr_capabilities *pmsr_capa;
5959 
5960 	struct {
5961 		u64 peer, vif;
5962 		u8 max_retry;
5963 	} tid_config_support;
5964 
5965 	u8 max_data_retry_count;
5966 
5967 	const struct cfg80211_sar_capa *sar_capa;
5968 
5969 	struct rfkill *rfkill;
5970 
5971 	u8 mbssid_max_interfaces;
5972 	u8 ema_max_profile_periodicity;
5973 	u16 max_num_akm_suites;
5974 
5975 	u16 hw_timestamp_max_peers;
5976 
5977 	int n_radio;
5978 	const struct wiphy_radio *radio;
5979 
5980 	char priv[] __aligned(NETDEV_ALIGN);
5981 };
5982 
5983 static inline struct net *wiphy_net(struct wiphy *wiphy)
5984 {
5985 	return read_pnet(&wiphy->_net);
5986 }
5987 
5988 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
5989 {
5990 	write_pnet(&wiphy->_net, net);
5991 }
5992 
5993 /**
5994  * wiphy_priv - return priv from wiphy
5995  *
5996  * @wiphy: the wiphy whose priv pointer to return
5997  * Return: The priv of @wiphy.
5998  */
5999 static inline void *wiphy_priv(struct wiphy *wiphy)
6000 {
6001 	BUG_ON(!wiphy);
6002 	return &wiphy->priv;
6003 }
6004 
6005 /**
6006  * priv_to_wiphy - return the wiphy containing the priv
6007  *
6008  * @priv: a pointer previously returned by wiphy_priv
6009  * Return: The wiphy of @priv.
6010  */
6011 static inline struct wiphy *priv_to_wiphy(void *priv)
6012 {
6013 	BUG_ON(!priv);
6014 	return container_of(priv, struct wiphy, priv);
6015 }
6016 
6017 /**
6018  * set_wiphy_dev - set device pointer for wiphy
6019  *
6020  * @wiphy: The wiphy whose device to bind
6021  * @dev: The device to parent it to
6022  */
6023 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
6024 {
6025 	wiphy->dev.parent = dev;
6026 }
6027 
6028 /**
6029  * wiphy_dev - get wiphy dev pointer
6030  *
6031  * @wiphy: The wiphy whose device struct to look up
6032  * Return: The dev of @wiphy.
6033  */
6034 static inline struct device *wiphy_dev(struct wiphy *wiphy)
6035 {
6036 	return wiphy->dev.parent;
6037 }
6038 
6039 /**
6040  * wiphy_name - get wiphy name
6041  *
6042  * @wiphy: The wiphy whose name to return
6043  * Return: The name of @wiphy.
6044  */
6045 static inline const char *wiphy_name(const struct wiphy *wiphy)
6046 {
6047 	return dev_name(&wiphy->dev);
6048 }
6049 
6050 /**
6051  * wiphy_new_nm - create a new wiphy for use with cfg80211
6052  *
6053  * @ops: The configuration operations for this device
6054  * @sizeof_priv: The size of the private area to allocate
6055  * @requested_name: Request a particular name.
6056  *	NULL is valid value, and means use the default phy%d naming.
6057  *
6058  * Create a new wiphy and associate the given operations with it.
6059  * @sizeof_priv bytes are allocated for private use.
6060  *
6061  * Return: A pointer to the new wiphy. This pointer must be
6062  * assigned to each netdev's ieee80211_ptr for proper operation.
6063  */
6064 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
6065 			   const char *requested_name);
6066 
6067 /**
6068  * wiphy_new - create a new wiphy for use with cfg80211
6069  *
6070  * @ops: The configuration operations for this device
6071  * @sizeof_priv: The size of the private area to allocate
6072  *
6073  * Create a new wiphy and associate the given operations with it.
6074  * @sizeof_priv bytes are allocated for private use.
6075  *
6076  * Return: A pointer to the new wiphy. This pointer must be
6077  * assigned to each netdev's ieee80211_ptr for proper operation.
6078  */
6079 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
6080 				      int sizeof_priv)
6081 {
6082 	return wiphy_new_nm(ops, sizeof_priv, NULL);
6083 }
6084 
6085 /**
6086  * wiphy_register - register a wiphy with cfg80211
6087  *
6088  * @wiphy: The wiphy to register.
6089  *
6090  * Return: A non-negative wiphy index or a negative error code.
6091  */
6092 int wiphy_register(struct wiphy *wiphy);
6093 
6094 /* this is a define for better error reporting (file/line) */
6095 #define lockdep_assert_wiphy(wiphy) lockdep_assert_held(&(wiphy)->mtx)
6096 
6097 /**
6098  * rcu_dereference_wiphy - rcu_dereference with debug checking
6099  * @wiphy: the wiphy to check the locking on
6100  * @p: The pointer to read, prior to dereferencing
6101  *
6102  * Do an rcu_dereference(p), but check caller either holds rcu_read_lock()
6103  * or RTNL. Note: Please prefer wiphy_dereference() or rcu_dereference().
6104  */
6105 #define rcu_dereference_wiphy(wiphy, p)				\
6106         rcu_dereference_check(p, lockdep_is_held(&wiphy->mtx))
6107 
6108 /**
6109  * wiphy_dereference - fetch RCU pointer when updates are prevented by wiphy mtx
6110  * @wiphy: the wiphy to check the locking on
6111  * @p: The pointer to read, prior to dereferencing
6112  *
6113  * Return: the value of the specified RCU-protected pointer, but omit the
6114  * READ_ONCE(), because caller holds the wiphy mutex used for updates.
6115  */
6116 #define wiphy_dereference(wiphy, p)				\
6117         rcu_dereference_protected(p, lockdep_is_held(&wiphy->mtx))
6118 
6119 /**
6120  * get_wiphy_regdom - get custom regdomain for the given wiphy
6121  * @wiphy: the wiphy to get the regdomain from
6122  *
6123  * Context: Requires any of RTNL, wiphy mutex or RCU protection.
6124  *
6125  * Return: pointer to the regulatory domain associated with the wiphy
6126  */
6127 const struct ieee80211_regdomain *get_wiphy_regdom(struct wiphy *wiphy);
6128 
6129 /**
6130  * wiphy_unregister - deregister a wiphy from cfg80211
6131  *
6132  * @wiphy: The wiphy to unregister.
6133  *
6134  * After this call, no more requests can be made with this priv
6135  * pointer, but the call may sleep to wait for an outstanding
6136  * request that is being handled.
6137  */
6138 void wiphy_unregister(struct wiphy *wiphy);
6139 
6140 /**
6141  * wiphy_free - free wiphy
6142  *
6143  * @wiphy: The wiphy to free
6144  */
6145 void wiphy_free(struct wiphy *wiphy);
6146 
6147 /* internal structs */
6148 struct cfg80211_conn;
6149 struct cfg80211_internal_bss;
6150 struct cfg80211_cached_keys;
6151 struct cfg80211_cqm_config;
6152 
6153 /**
6154  * wiphy_lock - lock the wiphy
6155  * @wiphy: the wiphy to lock
6156  *
6157  * This is needed around registering and unregistering netdevs that
6158  * aren't created through cfg80211 calls, since that requires locking
6159  * in cfg80211 when the notifiers is called, but that cannot
6160  * differentiate which way it's called.
6161  *
6162  * It can also be used by drivers for their own purposes.
6163  *
6164  * When cfg80211 ops are called, the wiphy is already locked.
6165  *
6166  * Note that this makes sure that no workers that have been queued
6167  * with wiphy_queue_work() are running.
6168  */
6169 static inline void wiphy_lock(struct wiphy *wiphy)
6170 	__acquires(&wiphy->mtx)
6171 {
6172 	mutex_lock(&wiphy->mtx);
6173 	__acquire(&wiphy->mtx);
6174 }
6175 
6176 /**
6177  * wiphy_unlock - unlock the wiphy again
6178  * @wiphy: the wiphy to unlock
6179  */
6180 static inline void wiphy_unlock(struct wiphy *wiphy)
6181 	__releases(&wiphy->mtx)
6182 {
6183 	__release(&wiphy->mtx);
6184 	mutex_unlock(&wiphy->mtx);
6185 }
6186 
6187 DEFINE_GUARD(wiphy, struct wiphy *,
6188 	     mutex_lock(&_T->mtx),
6189 	     mutex_unlock(&_T->mtx))
6190 
6191 struct wiphy_work;
6192 typedef void (*wiphy_work_func_t)(struct wiphy *, struct wiphy_work *);
6193 
6194 struct wiphy_work {
6195 	struct list_head entry;
6196 	wiphy_work_func_t func;
6197 };
6198 
6199 static inline void wiphy_work_init(struct wiphy_work *work,
6200 				   wiphy_work_func_t func)
6201 {
6202 	INIT_LIST_HEAD(&work->entry);
6203 	work->func = func;
6204 }
6205 
6206 /**
6207  * wiphy_work_queue - queue work for the wiphy
6208  * @wiphy: the wiphy to queue for
6209  * @work: the work item
6210  *
6211  * This is useful for work that must be done asynchronously, and work
6212  * queued here has the special property that the wiphy mutex will be
6213  * held as if wiphy_lock() was called, and that it cannot be running
6214  * after wiphy_lock() was called. Therefore, wiphy_cancel_work() can
6215  * use just cancel_work() instead of cancel_work_sync(), it requires
6216  * being in a section protected by wiphy_lock().
6217  */
6218 void wiphy_work_queue(struct wiphy *wiphy, struct wiphy_work *work);
6219 
6220 /**
6221  * wiphy_work_cancel - cancel previously queued work
6222  * @wiphy: the wiphy, for debug purposes
6223  * @work: the work to cancel
6224  *
6225  * Cancel the work *without* waiting for it, this assumes being
6226  * called under the wiphy mutex acquired by wiphy_lock().
6227  */
6228 void wiphy_work_cancel(struct wiphy *wiphy, struct wiphy_work *work);
6229 
6230 /**
6231  * wiphy_work_flush - flush previously queued work
6232  * @wiphy: the wiphy, for debug purposes
6233  * @work: the work to flush, this can be %NULL to flush all work
6234  *
6235  * Flush the work (i.e. run it if pending). This must be called
6236  * under the wiphy mutex acquired by wiphy_lock().
6237  */
6238 void wiphy_work_flush(struct wiphy *wiphy, struct wiphy_work *work);
6239 
6240 struct wiphy_delayed_work {
6241 	struct wiphy_work work;
6242 	struct wiphy *wiphy;
6243 	struct timer_list timer;
6244 };
6245 
6246 void wiphy_delayed_work_timer(struct timer_list *t);
6247 
6248 static inline void wiphy_delayed_work_init(struct wiphy_delayed_work *dwork,
6249 					   wiphy_work_func_t func)
6250 {
6251 	timer_setup(&dwork->timer, wiphy_delayed_work_timer, 0);
6252 	wiphy_work_init(&dwork->work, func);
6253 }
6254 
6255 /**
6256  * wiphy_delayed_work_queue - queue delayed work for the wiphy
6257  * @wiphy: the wiphy to queue for
6258  * @dwork: the delayable worker
6259  * @delay: number of jiffies to wait before queueing
6260  *
6261  * This is useful for work that must be done asynchronously, and work
6262  * queued here has the special property that the wiphy mutex will be
6263  * held as if wiphy_lock() was called, and that it cannot be running
6264  * after wiphy_lock() was called. Therefore, wiphy_cancel_work() can
6265  * use just cancel_work() instead of cancel_work_sync(), it requires
6266  * being in a section protected by wiphy_lock().
6267  */
6268 void wiphy_delayed_work_queue(struct wiphy *wiphy,
6269 			      struct wiphy_delayed_work *dwork,
6270 			      unsigned long delay);
6271 
6272 /**
6273  * wiphy_delayed_work_cancel - cancel previously queued delayed work
6274  * @wiphy: the wiphy, for debug purposes
6275  * @dwork: the delayed work to cancel
6276  *
6277  * Cancel the work *without* waiting for it, this assumes being
6278  * called under the wiphy mutex acquired by wiphy_lock().
6279  */
6280 void wiphy_delayed_work_cancel(struct wiphy *wiphy,
6281 			       struct wiphy_delayed_work *dwork);
6282 
6283 /**
6284  * wiphy_delayed_work_flush - flush previously queued delayed work
6285  * @wiphy: the wiphy, for debug purposes
6286  * @dwork: the delayed work to flush
6287  *
6288  * Flush the work (i.e. run it if pending). This must be called
6289  * under the wiphy mutex acquired by wiphy_lock().
6290  */
6291 void wiphy_delayed_work_flush(struct wiphy *wiphy,
6292 			      struct wiphy_delayed_work *dwork);
6293 
6294 /**
6295  * wiphy_delayed_work_pending - Find out whether a wiphy delayable
6296  * work item is currently pending.
6297  *
6298  * @wiphy: the wiphy, for debug purposes
6299  * @dwork: the delayed work in question
6300  *
6301  * Return: true if timer is pending, false otherwise
6302  *
6303  * How wiphy_delayed_work_queue() works is by setting a timer which
6304  * when it expires calls wiphy_work_queue() to queue the wiphy work.
6305  * Because wiphy_delayed_work_queue() uses mod_timer(), if it is
6306  * called twice and the second call happens before the first call
6307  * deadline, the work will rescheduled for the second deadline and
6308  * won't run before that.
6309  *
6310  * wiphy_delayed_work_pending() can be used to detect if calling
6311  * wiphy_work_delayed_work_queue() would start a new work schedule
6312  * or delayed a previous one. As seen below it cannot be used to
6313  * detect precisely if the work has finished to execute nor if it
6314  * is currently executing.
6315  *
6316  *      CPU0                                CPU1
6317  * wiphy_delayed_work_queue(wk)
6318  *  mod_timer(wk->timer)
6319  *                                     wiphy_delayed_work_pending(wk) -> true
6320  *
6321  * [...]
6322  * expire_timers(wk->timer)
6323  *  detach_timer(wk->timer)
6324  *                                     wiphy_delayed_work_pending(wk) -> false
6325  *  wk->timer->function()                          |
6326  *   wiphy_work_queue(wk)                          | delayed work pending
6327  *    list_add_tail()                              | returns false but
6328  *    queue_work(cfg80211_wiphy_work)              | wk->func() has not
6329  *                                                 | been run yet
6330  * [...]                                           |
6331  *  cfg80211_wiphy_work()                          |
6332  *   wk->func()                                    V
6333  *
6334  */
6335 bool wiphy_delayed_work_pending(struct wiphy *wiphy,
6336 				struct wiphy_delayed_work *dwork);
6337 
6338 /**
6339  * enum ieee80211_ap_reg_power - regulatory power for an Access Point
6340  *
6341  * @IEEE80211_REG_UNSET_AP: Access Point has no regulatory power mode
6342  * @IEEE80211_REG_LPI_AP: Indoor Access Point
6343  * @IEEE80211_REG_SP_AP: Standard power Access Point
6344  * @IEEE80211_REG_VLP_AP: Very low power Access Point
6345  */
6346 enum ieee80211_ap_reg_power {
6347 	IEEE80211_REG_UNSET_AP,
6348 	IEEE80211_REG_LPI_AP,
6349 	IEEE80211_REG_SP_AP,
6350 	IEEE80211_REG_VLP_AP,
6351 };
6352 
6353 /**
6354  * struct wireless_dev - wireless device state
6355  *
6356  * For netdevs, this structure must be allocated by the driver
6357  * that uses the ieee80211_ptr field in struct net_device (this
6358  * is intentional so it can be allocated along with the netdev.)
6359  * It need not be registered then as netdev registration will
6360  * be intercepted by cfg80211 to see the new wireless device,
6361  * however, drivers must lock the wiphy before registering or
6362  * unregistering netdevs if they pre-create any netdevs (in ops
6363  * called from cfg80211, the wiphy is already locked.)
6364  *
6365  * For non-netdev uses, it must also be allocated by the driver
6366  * in response to the cfg80211 callbacks that require it, as
6367  * there's no netdev registration in that case it may not be
6368  * allocated outside of callback operations that return it.
6369  *
6370  * @wiphy: pointer to hardware description
6371  * @iftype: interface type
6372  * @registered: is this wdev already registered with cfg80211
6373  * @registering: indicates we're doing registration under wiphy lock
6374  *	for the notifier
6375  * @list: (private) Used to collect the interfaces
6376  * @netdev: (private) Used to reference back to the netdev, may be %NULL
6377  * @identifier: (private) Identifier used in nl80211 to identify this
6378  *	wireless device if it has no netdev
6379  * @u: union containing data specific to @iftype
6380  * @connected: indicates if connected or not (STA mode)
6381  * @wext: (private) Used by the internal wireless extensions compat code
6382  * @wext.ibss: (private) IBSS data part of wext handling
6383  * @wext.connect: (private) connection handling data
6384  * @wext.keys: (private) (WEP) key data
6385  * @wext.ie: (private) extra elements for association
6386  * @wext.ie_len: (private) length of extra elements
6387  * @wext.bssid: (private) selected network BSSID
6388  * @wext.ssid: (private) selected network SSID
6389  * @wext.default_key: (private) selected default key index
6390  * @wext.default_mgmt_key: (private) selected default management key index
6391  * @wext.prev_bssid: (private) previous BSSID for reassociation
6392  * @wext.prev_bssid_valid: (private) previous BSSID validity
6393  * @use_4addr: indicates 4addr mode is used on this interface, must be
6394  *	set by driver (if supported) on add_interface BEFORE registering the
6395  *	netdev and may otherwise be used by driver read-only, will be update
6396  *	by cfg80211 on change_interface
6397  * @mgmt_registrations: list of registrations for management frames
6398  * @mgmt_registrations_need_update: mgmt registrations were updated,
6399  *	need to propagate the update to the driver
6400  * @address: The address for this device, valid only if @netdev is %NULL
6401  * @is_running: true if this is a non-netdev device that has been started, e.g.
6402  *	the P2P Device.
6403  * @ps: powersave mode is enabled
6404  * @ps_timeout: dynamic powersave timeout
6405  * @ap_unexpected_nlportid: (private) netlink port ID of application
6406  *	registered for unexpected class 3 frames (AP mode)
6407  * @conn: (private) cfg80211 software SME connection state machine data
6408  * @connect_keys: (private) keys to set after connection is established
6409  * @conn_bss_type: connecting/connected BSS type
6410  * @conn_owner_nlportid: (private) connection owner socket port ID
6411  * @disconnect_wk: (private) auto-disconnect work
6412  * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
6413  * @event_list: (private) list for internal event processing
6414  * @event_lock: (private) lock for event list
6415  * @owner_nlportid: (private) owner socket port ID
6416  * @nl_owner_dead: (private) owner socket went away
6417  * @cqm_rssi_work: (private) CQM RSSI reporting work
6418  * @cqm_config: (private) nl80211 RSSI monitor state
6419  * @pmsr_list: (private) peer measurement requests
6420  * @pmsr_lock: (private) peer measurements requests/results lock
6421  * @pmsr_free_wk: (private) peer measurements cleanup work
6422  * @unprot_beacon_reported: (private) timestamp of last
6423  *	unprotected beacon report
6424  * @links: array of %IEEE80211_MLD_MAX_NUM_LINKS elements containing @addr
6425  *	@ap and @client for each link
6426  * @links.cac_started: true if DFS channel availability check has been
6427  *	started
6428  * @links.cac_start_time: timestamp (jiffies) when the dfs state was
6429  *	entered.
6430  * @links.cac_time_ms: CAC time in ms
6431  * @valid_links: bitmap describing what elements of @links are valid
6432  * @radio_mask: Bitmask of radios that this interface is allowed to operate on.
6433  */
6434 struct wireless_dev {
6435 	struct wiphy *wiphy;
6436 	enum nl80211_iftype iftype;
6437 
6438 	/* the remainder of this struct should be private to cfg80211 */
6439 	struct list_head list;
6440 	struct net_device *netdev;
6441 
6442 	u32 identifier;
6443 
6444 	struct list_head mgmt_registrations;
6445 	u8 mgmt_registrations_need_update:1;
6446 
6447 	bool use_4addr, is_running, registered, registering;
6448 
6449 	u8 address[ETH_ALEN] __aligned(sizeof(u16));
6450 
6451 	/* currently used for IBSS and SME - might be rearranged later */
6452 	struct cfg80211_conn *conn;
6453 	struct cfg80211_cached_keys *connect_keys;
6454 	enum ieee80211_bss_type conn_bss_type;
6455 	u32 conn_owner_nlportid;
6456 
6457 	struct work_struct disconnect_wk;
6458 	u8 disconnect_bssid[ETH_ALEN];
6459 
6460 	struct list_head event_list;
6461 	spinlock_t event_lock;
6462 
6463 	u8 connected:1;
6464 
6465 	bool ps;
6466 	int ps_timeout;
6467 
6468 	u32 ap_unexpected_nlportid;
6469 
6470 	u32 owner_nlportid;
6471 	bool nl_owner_dead;
6472 
6473 #ifdef CONFIG_CFG80211_WEXT
6474 	/* wext data */
6475 	struct {
6476 		struct cfg80211_ibss_params ibss;
6477 		struct cfg80211_connect_params connect;
6478 		struct cfg80211_cached_keys *keys;
6479 		const u8 *ie;
6480 		size_t ie_len;
6481 		u8 bssid[ETH_ALEN];
6482 		u8 prev_bssid[ETH_ALEN];
6483 		u8 ssid[IEEE80211_MAX_SSID_LEN];
6484 		s8 default_key, default_mgmt_key;
6485 		bool prev_bssid_valid;
6486 	} wext;
6487 #endif
6488 
6489 	struct wiphy_work cqm_rssi_work;
6490 	struct cfg80211_cqm_config __rcu *cqm_config;
6491 
6492 	struct list_head pmsr_list;
6493 	spinlock_t pmsr_lock;
6494 	struct work_struct pmsr_free_wk;
6495 
6496 	unsigned long unprot_beacon_reported;
6497 
6498 	union {
6499 		struct {
6500 			u8 connected_addr[ETH_ALEN] __aligned(2);
6501 			u8 ssid[IEEE80211_MAX_SSID_LEN];
6502 			u8 ssid_len;
6503 		} client;
6504 		struct {
6505 			int beacon_interval;
6506 			struct cfg80211_chan_def preset_chandef;
6507 			struct cfg80211_chan_def chandef;
6508 			u8 id[IEEE80211_MAX_MESH_ID_LEN];
6509 			u8 id_len, id_up_len;
6510 		} mesh;
6511 		struct {
6512 			struct cfg80211_chan_def preset_chandef;
6513 			u8 ssid[IEEE80211_MAX_SSID_LEN];
6514 			u8 ssid_len;
6515 		} ap;
6516 		struct {
6517 			struct cfg80211_internal_bss *current_bss;
6518 			struct cfg80211_chan_def chandef;
6519 			int beacon_interval;
6520 			u8 ssid[IEEE80211_MAX_SSID_LEN];
6521 			u8 ssid_len;
6522 		} ibss;
6523 		struct {
6524 			struct cfg80211_chan_def chandef;
6525 		} ocb;
6526 	} u;
6527 
6528 	struct {
6529 		u8 addr[ETH_ALEN] __aligned(2);
6530 		union {
6531 			struct {
6532 				unsigned int beacon_interval;
6533 				struct cfg80211_chan_def chandef;
6534 			} ap;
6535 			struct {
6536 				struct cfg80211_internal_bss *current_bss;
6537 			} client;
6538 		};
6539 
6540 		bool cac_started;
6541 		unsigned long cac_start_time;
6542 		unsigned int cac_time_ms;
6543 	} links[IEEE80211_MLD_MAX_NUM_LINKS];
6544 	u16 valid_links;
6545 
6546 	u32 radio_mask;
6547 };
6548 
6549 static inline const u8 *wdev_address(struct wireless_dev *wdev)
6550 {
6551 	if (wdev->netdev)
6552 		return wdev->netdev->dev_addr;
6553 	return wdev->address;
6554 }
6555 
6556 static inline bool wdev_running(struct wireless_dev *wdev)
6557 {
6558 	if (wdev->netdev)
6559 		return netif_running(wdev->netdev);
6560 	return wdev->is_running;
6561 }
6562 
6563 /**
6564  * wdev_priv - return wiphy priv from wireless_dev
6565  *
6566  * @wdev: The wireless device whose wiphy's priv pointer to return
6567  * Return: The wiphy priv of @wdev.
6568  */
6569 static inline void *wdev_priv(struct wireless_dev *wdev)
6570 {
6571 	BUG_ON(!wdev);
6572 	return wiphy_priv(wdev->wiphy);
6573 }
6574 
6575 /**
6576  * wdev_chandef - return chandef pointer from wireless_dev
6577  * @wdev: the wdev
6578  * @link_id: the link ID for MLO
6579  *
6580  * Return: The chandef depending on the mode, or %NULL.
6581  */
6582 struct cfg80211_chan_def *wdev_chandef(struct wireless_dev *wdev,
6583 				       unsigned int link_id);
6584 
6585 static inline void WARN_INVALID_LINK_ID(struct wireless_dev *wdev,
6586 					unsigned int link_id)
6587 {
6588 	WARN_ON(link_id && !wdev->valid_links);
6589 	WARN_ON(wdev->valid_links &&
6590 		!(wdev->valid_links & BIT(link_id)));
6591 }
6592 
6593 #define for_each_valid_link(link_info, link_id)			\
6594 	for (link_id = 0;					\
6595 	     link_id < ((link_info)->valid_links ?		\
6596 			ARRAY_SIZE((link_info)->links) : 1);	\
6597 	     link_id++)						\
6598 		if (!(link_info)->valid_links ||		\
6599 		    ((link_info)->valid_links & BIT(link_id)))
6600 
6601 /**
6602  * DOC: Utility functions
6603  *
6604  * cfg80211 offers a number of utility functions that can be useful.
6605  */
6606 
6607 /**
6608  * ieee80211_channel_equal - compare two struct ieee80211_channel
6609  *
6610  * @a: 1st struct ieee80211_channel
6611  * @b: 2nd struct ieee80211_channel
6612  * Return: true if center frequency of @a == @b
6613  */
6614 static inline bool
6615 ieee80211_channel_equal(struct ieee80211_channel *a,
6616 			struct ieee80211_channel *b)
6617 {
6618 	return (a->center_freq == b->center_freq &&
6619 		a->freq_offset == b->freq_offset);
6620 }
6621 
6622 /**
6623  * ieee80211_channel_to_khz - convert ieee80211_channel to frequency in KHz
6624  * @chan: struct ieee80211_channel to convert
6625  * Return: The corresponding frequency (in KHz)
6626  */
6627 static inline u32
6628 ieee80211_channel_to_khz(const struct ieee80211_channel *chan)
6629 {
6630 	return MHZ_TO_KHZ(chan->center_freq) + chan->freq_offset;
6631 }
6632 
6633 /**
6634  * ieee80211_s1g_channel_width - get allowed channel width from @chan
6635  *
6636  * Only allowed for band NL80211_BAND_S1GHZ
6637  * @chan: channel
6638  * Return: The allowed channel width for this center_freq
6639  */
6640 enum nl80211_chan_width
6641 ieee80211_s1g_channel_width(const struct ieee80211_channel *chan);
6642 
6643 /**
6644  * ieee80211_channel_to_freq_khz - convert channel number to frequency
6645  * @chan: channel number
6646  * @band: band, necessary due to channel number overlap
6647  * Return: The corresponding frequency (in KHz), or 0 if the conversion failed.
6648  */
6649 u32 ieee80211_channel_to_freq_khz(int chan, enum nl80211_band band);
6650 
6651 /**
6652  * ieee80211_channel_to_frequency - convert channel number to frequency
6653  * @chan: channel number
6654  * @band: band, necessary due to channel number overlap
6655  * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
6656  */
6657 static inline int
6658 ieee80211_channel_to_frequency(int chan, enum nl80211_band band)
6659 {
6660 	return KHZ_TO_MHZ(ieee80211_channel_to_freq_khz(chan, band));
6661 }
6662 
6663 /**
6664  * ieee80211_freq_khz_to_channel - convert frequency to channel number
6665  * @freq: center frequency in KHz
6666  * Return: The corresponding channel, or 0 if the conversion failed.
6667  */
6668 int ieee80211_freq_khz_to_channel(u32 freq);
6669 
6670 /**
6671  * ieee80211_frequency_to_channel - convert frequency to channel number
6672  * @freq: center frequency in MHz
6673  * Return: The corresponding channel, or 0 if the conversion failed.
6674  */
6675 static inline int
6676 ieee80211_frequency_to_channel(int freq)
6677 {
6678 	return ieee80211_freq_khz_to_channel(MHZ_TO_KHZ(freq));
6679 }
6680 
6681 /**
6682  * ieee80211_get_channel_khz - get channel struct from wiphy for specified
6683  * frequency
6684  * @wiphy: the struct wiphy to get the channel for
6685  * @freq: the center frequency (in KHz) of the channel
6686  * Return: The channel struct from @wiphy at @freq.
6687  */
6688 struct ieee80211_channel *
6689 ieee80211_get_channel_khz(struct wiphy *wiphy, u32 freq);
6690 
6691 /**
6692  * ieee80211_get_channel - get channel struct from wiphy for specified frequency
6693  *
6694  * @wiphy: the struct wiphy to get the channel for
6695  * @freq: the center frequency (in MHz) of the channel
6696  * Return: The channel struct from @wiphy at @freq.
6697  */
6698 static inline struct ieee80211_channel *
6699 ieee80211_get_channel(struct wiphy *wiphy, int freq)
6700 {
6701 	return ieee80211_get_channel_khz(wiphy, MHZ_TO_KHZ(freq));
6702 }
6703 
6704 /**
6705  * cfg80211_channel_is_psc - Check if the channel is a 6 GHz PSC
6706  * @chan: control channel to check
6707  *
6708  * The Preferred Scanning Channels (PSC) are defined in
6709  * Draft IEEE P802.11ax/D5.0, 26.17.2.3.3
6710  *
6711  * Return: %true if channel is a PSC, %false otherwise
6712  */
6713 static inline bool cfg80211_channel_is_psc(struct ieee80211_channel *chan)
6714 {
6715 	if (chan->band != NL80211_BAND_6GHZ)
6716 		return false;
6717 
6718 	return ieee80211_frequency_to_channel(chan->center_freq) % 16 == 5;
6719 }
6720 
6721 /**
6722  * cfg80211_radio_chandef_valid - Check if the radio supports the chandef
6723  *
6724  * @radio: wiphy radio
6725  * @chandef: chandef for current channel
6726  *
6727  * Return: whether or not the given chandef is valid for the given radio
6728  */
6729 bool cfg80211_radio_chandef_valid(const struct wiphy_radio *radio,
6730 				  const struct cfg80211_chan_def *chandef);
6731 
6732 /**
6733  * cfg80211_wdev_channel_allowed - Check if the wdev may use the channel
6734  *
6735  * @wdev: the wireless device
6736  * @chan: channel to check
6737  *
6738  * Return: whether or not the wdev may use the channel
6739  */
6740 bool cfg80211_wdev_channel_allowed(struct wireless_dev *wdev,
6741 				   struct ieee80211_channel *chan);
6742 
6743 /**
6744  * ieee80211_get_response_rate - get basic rate for a given rate
6745  *
6746  * @sband: the band to look for rates in
6747  * @basic_rates: bitmap of basic rates
6748  * @bitrate: the bitrate for which to find the basic rate
6749  *
6750  * Return: The basic rate corresponding to a given bitrate, that
6751  * is the next lower bitrate contained in the basic rate map,
6752  * which is, for this function, given as a bitmap of indices of
6753  * rates in the band's bitrate table.
6754  */
6755 const struct ieee80211_rate *
6756 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
6757 			    u32 basic_rates, int bitrate);
6758 
6759 /**
6760  * ieee80211_mandatory_rates - get mandatory rates for a given band
6761  * @sband: the band to look for rates in
6762  *
6763  * Return: a bitmap of the mandatory rates for the given band, bits
6764  * are set according to the rate position in the bitrates array.
6765  */
6766 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband);
6767 
6768 /*
6769  * Radiotap parsing functions -- for controlled injection support
6770  *
6771  * Implemented in net/wireless/radiotap.c
6772  * Documentation in Documentation/networking/radiotap-headers.rst
6773  */
6774 
6775 struct radiotap_align_size {
6776 	uint8_t align:4, size:4;
6777 };
6778 
6779 struct ieee80211_radiotap_namespace {
6780 	const struct radiotap_align_size *align_size;
6781 	int n_bits;
6782 	uint32_t oui;
6783 	uint8_t subns;
6784 };
6785 
6786 struct ieee80211_radiotap_vendor_namespaces {
6787 	const struct ieee80211_radiotap_namespace *ns;
6788 	int n_ns;
6789 };
6790 
6791 /**
6792  * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
6793  * @this_arg_index: index of current arg, valid after each successful call
6794  *	to ieee80211_radiotap_iterator_next()
6795  * @this_arg: pointer to current radiotap arg; it is valid after each
6796  *	call to ieee80211_radiotap_iterator_next() but also after
6797  *	ieee80211_radiotap_iterator_init() where it will point to
6798  *	the beginning of the actual data portion
6799  * @this_arg_size: length of the current arg, for convenience
6800  * @current_namespace: pointer to the current namespace definition
6801  *	(or internally %NULL if the current namespace is unknown)
6802  * @is_radiotap_ns: indicates whether the current namespace is the default
6803  *	radiotap namespace or not
6804  *
6805  * @_rtheader: pointer to the radiotap header we are walking through
6806  * @_max_length: length of radiotap header in cpu byte ordering
6807  * @_arg_index: next argument index
6808  * @_arg: next argument pointer
6809  * @_next_bitmap: internal pointer to next present u32
6810  * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
6811  * @_vns: vendor namespace definitions
6812  * @_next_ns_data: beginning of the next namespace's data
6813  * @_reset_on_ext: internal; reset the arg index to 0 when going to the
6814  *	next bitmap word
6815  *
6816  * Describes the radiotap parser state. Fields prefixed with an underscore
6817  * must not be used by users of the parser, only by the parser internally.
6818  */
6819 
6820 struct ieee80211_radiotap_iterator {
6821 	struct ieee80211_radiotap_header *_rtheader;
6822 	const struct ieee80211_radiotap_vendor_namespaces *_vns;
6823 	const struct ieee80211_radiotap_namespace *current_namespace;
6824 
6825 	unsigned char *_arg, *_next_ns_data;
6826 	__le32 *_next_bitmap;
6827 
6828 	unsigned char *this_arg;
6829 	int this_arg_index;
6830 	int this_arg_size;
6831 
6832 	int is_radiotap_ns;
6833 
6834 	int _max_length;
6835 	int _arg_index;
6836 	uint32_t _bitmap_shifter;
6837 	int _reset_on_ext;
6838 };
6839 
6840 int
6841 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
6842 				 struct ieee80211_radiotap_header *radiotap_header,
6843 				 int max_length,
6844 				 const struct ieee80211_radiotap_vendor_namespaces *vns);
6845 
6846 int
6847 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
6848 
6849 
6850 extern const unsigned char rfc1042_header[6];
6851 extern const unsigned char bridge_tunnel_header[6];
6852 
6853 /**
6854  * ieee80211_get_hdrlen_from_skb - get header length from data
6855  *
6856  * @skb: the frame
6857  *
6858  * Given an skb with a raw 802.11 header at the data pointer this function
6859  * returns the 802.11 header length.
6860  *
6861  * Return: The 802.11 header length in bytes (not including encryption
6862  * headers). Or 0 if the data in the sk_buff is too short to contain a valid
6863  * 802.11 header.
6864  */
6865 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
6866 
6867 /**
6868  * ieee80211_hdrlen - get header length in bytes from frame control
6869  * @fc: frame control field in little-endian format
6870  * Return: The header length in bytes.
6871  */
6872 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
6873 
6874 /**
6875  * ieee80211_get_mesh_hdrlen - get mesh extension header length
6876  * @meshhdr: the mesh extension header, only the flags field
6877  *	(first byte) will be accessed
6878  * Return: The length of the extension header, which is always at
6879  * least 6 bytes and at most 18 if address 5 and 6 are present.
6880  */
6881 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
6882 
6883 /**
6884  * DOC: Data path helpers
6885  *
6886  * In addition to generic utilities, cfg80211 also offers
6887  * functions that help implement the data path for devices
6888  * that do not do the 802.11/802.3 conversion on the device.
6889  */
6890 
6891 /**
6892  * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
6893  * @skb: the 802.11 data frame
6894  * @ehdr: pointer to a &struct ethhdr that will get the header, instead
6895  *	of it being pushed into the SKB
6896  * @addr: the device MAC address
6897  * @iftype: the virtual interface type
6898  * @data_offset: offset of payload after the 802.11 header
6899  * @is_amsdu: true if the 802.11 header is A-MSDU
6900  * Return: 0 on success. Non-zero on error.
6901  */
6902 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
6903 				  const u8 *addr, enum nl80211_iftype iftype,
6904 				  u8 data_offset, bool is_amsdu);
6905 
6906 /**
6907  * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
6908  * @skb: the 802.11 data frame
6909  * @addr: the device MAC address
6910  * @iftype: the virtual interface type
6911  * Return: 0 on success. Non-zero on error.
6912  */
6913 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
6914 					 enum nl80211_iftype iftype)
6915 {
6916 	return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0, false);
6917 }
6918 
6919 /**
6920  * ieee80211_is_valid_amsdu - check if subframe lengths of an A-MSDU are valid
6921  *
6922  * This is used to detect non-standard A-MSDU frames, e.g. the ones generated
6923  * by ath10k and ath11k, where the subframe length includes the length of the
6924  * mesh control field.
6925  *
6926  * @skb: The input A-MSDU frame without any headers.
6927  * @mesh_hdr: the type of mesh header to test
6928  *	0: non-mesh A-MSDU length field
6929  *	1: big-endian mesh A-MSDU length field
6930  *	2: little-endian mesh A-MSDU length field
6931  * Returns: true if subframe header lengths are valid for the @mesh_hdr mode
6932  */
6933 bool ieee80211_is_valid_amsdu(struct sk_buff *skb, u8 mesh_hdr);
6934 
6935 /**
6936  * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
6937  *
6938  * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
6939  * The @list will be empty if the decode fails. The @skb must be fully
6940  * header-less before being passed in here; it is freed in this function.
6941  *
6942  * @skb: The input A-MSDU frame without any headers.
6943  * @list: The output list of 802.3 frames. It must be allocated and
6944  *	initialized by the caller.
6945  * @addr: The device MAC address.
6946  * @iftype: The device interface type.
6947  * @extra_headroom: The hardware extra headroom for SKBs in the @list.
6948  * @check_da: DA to check in the inner ethernet header, or NULL
6949  * @check_sa: SA to check in the inner ethernet header, or NULL
6950  * @mesh_control: see mesh_hdr in ieee80211_is_valid_amsdu
6951  */
6952 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
6953 			      const u8 *addr, enum nl80211_iftype iftype,
6954 			      const unsigned int extra_headroom,
6955 			      const u8 *check_da, const u8 *check_sa,
6956 			      u8 mesh_control);
6957 
6958 /**
6959  * ieee80211_get_8023_tunnel_proto - get RFC1042 or bridge tunnel encap protocol
6960  *
6961  * Check for RFC1042 or bridge tunnel header and fetch the encapsulated
6962  * protocol.
6963  *
6964  * @hdr: pointer to the MSDU payload
6965  * @proto: destination pointer to store the protocol
6966  * Return: true if encapsulation was found
6967  */
6968 bool ieee80211_get_8023_tunnel_proto(const void *hdr, __be16 *proto);
6969 
6970 /**
6971  * ieee80211_strip_8023_mesh_hdr - strip mesh header from converted 802.3 frames
6972  *
6973  * Strip the mesh header, which was left in by ieee80211_data_to_8023 as part
6974  * of the MSDU data. Also move any source/destination addresses from the mesh
6975  * header to the ethernet header (if present).
6976  *
6977  * @skb: The 802.3 frame with embedded mesh header
6978  *
6979  * Return: 0 on success. Non-zero on error.
6980  */
6981 int ieee80211_strip_8023_mesh_hdr(struct sk_buff *skb);
6982 
6983 /**
6984  * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
6985  * @skb: the data frame
6986  * @qos_map: Interworking QoS mapping or %NULL if not in use
6987  * Return: The 802.1p/1d tag.
6988  */
6989 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
6990 				    struct cfg80211_qos_map *qos_map);
6991 
6992 /**
6993  * cfg80211_find_elem_match - match information element and byte array in data
6994  *
6995  * @eid: element ID
6996  * @ies: data consisting of IEs
6997  * @len: length of data
6998  * @match: byte array to match
6999  * @match_len: number of bytes in the match array
7000  * @match_offset: offset in the IE data where the byte array should match.
7001  *	Note the difference to cfg80211_find_ie_match() which considers
7002  *	the offset to start from the element ID byte, but here we take
7003  *	the data portion instead.
7004  *
7005  * Return: %NULL if the element ID could not be found or if
7006  * the element is invalid (claims to be longer than the given
7007  * data) or if the byte array doesn't match; otherwise return the
7008  * requested element struct.
7009  *
7010  * Note: There are no checks on the element length other than
7011  * having to fit into the given data and being large enough for the
7012  * byte array to match.
7013  */
7014 const struct element *
7015 cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
7016 			 const u8 *match, unsigned int match_len,
7017 			 unsigned int match_offset);
7018 
7019 /**
7020  * cfg80211_find_ie_match - match information element and byte array in data
7021  *
7022  * @eid: element ID
7023  * @ies: data consisting of IEs
7024  * @len: length of data
7025  * @match: byte array to match
7026  * @match_len: number of bytes in the match array
7027  * @match_offset: offset in the IE where the byte array should match.
7028  *	If match_len is zero, this must also be set to zero.
7029  *	Otherwise this must be set to 2 or more, because the first
7030  *	byte is the element id, which is already compared to eid, and
7031  *	the second byte is the IE length.
7032  *
7033  * Return: %NULL if the element ID could not be found or if
7034  * the element is invalid (claims to be longer than the given
7035  * data) or if the byte array doesn't match, or a pointer to the first
7036  * byte of the requested element, that is the byte containing the
7037  * element ID.
7038  *
7039  * Note: There are no checks on the element length other than
7040  * having to fit into the given data and being large enough for the
7041  * byte array to match.
7042  */
7043 static inline const u8 *
7044 cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
7045 		       const u8 *match, unsigned int match_len,
7046 		       unsigned int match_offset)
7047 {
7048 	/* match_offset can't be smaller than 2, unless match_len is
7049 	 * zero, in which case match_offset must be zero as well.
7050 	 */
7051 	if (WARN_ON((match_len && match_offset < 2) ||
7052 		    (!match_len && match_offset)))
7053 		return NULL;
7054 
7055 	return (const void *)cfg80211_find_elem_match(eid, ies, len,
7056 						      match, match_len,
7057 						      match_offset ?
7058 							match_offset - 2 : 0);
7059 }
7060 
7061 /**
7062  * cfg80211_find_elem - find information element in data
7063  *
7064  * @eid: element ID
7065  * @ies: data consisting of IEs
7066  * @len: length of data
7067  *
7068  * Return: %NULL if the element ID could not be found or if
7069  * the element is invalid (claims to be longer than the given
7070  * data) or if the byte array doesn't match; otherwise return the
7071  * requested element struct.
7072  *
7073  * Note: There are no checks on the element length other than
7074  * having to fit into the given data.
7075  */
7076 static inline const struct element *
7077 cfg80211_find_elem(u8 eid, const u8 *ies, int len)
7078 {
7079 	return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
7080 }
7081 
7082 /**
7083  * cfg80211_find_ie - find information element in data
7084  *
7085  * @eid: element ID
7086  * @ies: data consisting of IEs
7087  * @len: length of data
7088  *
7089  * Return: %NULL if the element ID could not be found or if
7090  * the element is invalid (claims to be longer than the given
7091  * data), or a pointer to the first byte of the requested
7092  * element, that is the byte containing the element ID.
7093  *
7094  * Note: There are no checks on the element length other than
7095  * having to fit into the given data.
7096  */
7097 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
7098 {
7099 	return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
7100 }
7101 
7102 /**
7103  * cfg80211_find_ext_elem - find information element with EID Extension in data
7104  *
7105  * @ext_eid: element ID Extension
7106  * @ies: data consisting of IEs
7107  * @len: length of data
7108  *
7109  * Return: %NULL if the extended element could not be found or if
7110  * the element is invalid (claims to be longer than the given
7111  * data) or if the byte array doesn't match; otherwise return the
7112  * requested element struct.
7113  *
7114  * Note: There are no checks on the element length other than
7115  * having to fit into the given data.
7116  */
7117 static inline const struct element *
7118 cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
7119 {
7120 	return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
7121 					&ext_eid, 1, 0);
7122 }
7123 
7124 /**
7125  * cfg80211_find_ext_ie - find information element with EID Extension in data
7126  *
7127  * @ext_eid: element ID Extension
7128  * @ies: data consisting of IEs
7129  * @len: length of data
7130  *
7131  * Return: %NULL if the extended element ID could not be found or if
7132  * the element is invalid (claims to be longer than the given
7133  * data), or a pointer to the first byte of the requested
7134  * element, that is the byte containing the element ID.
7135  *
7136  * Note: There are no checks on the element length other than
7137  * having to fit into the given data.
7138  */
7139 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
7140 {
7141 	return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
7142 				      &ext_eid, 1, 2);
7143 }
7144 
7145 /**
7146  * cfg80211_find_vendor_elem - find vendor specific information element in data
7147  *
7148  * @oui: vendor OUI
7149  * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
7150  * @ies: data consisting of IEs
7151  * @len: length of data
7152  *
7153  * Return: %NULL if the vendor specific element ID could not be found or if the
7154  * element is invalid (claims to be longer than the given data); otherwise
7155  * return the element structure for the requested element.
7156  *
7157  * Note: There are no checks on the element length other than having to fit into
7158  * the given data.
7159  */
7160 const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
7161 						const u8 *ies,
7162 						unsigned int len);
7163 
7164 /**
7165  * cfg80211_find_vendor_ie - find vendor specific information element in data
7166  *
7167  * @oui: vendor OUI
7168  * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
7169  * @ies: data consisting of IEs
7170  * @len: length of data
7171  *
7172  * Return: %NULL if the vendor specific element ID could not be found or if the
7173  * element is invalid (claims to be longer than the given data), or a pointer to
7174  * the first byte of the requested element, that is the byte containing the
7175  * element ID.
7176  *
7177  * Note: There are no checks on the element length other than having to fit into
7178  * the given data.
7179  */
7180 static inline const u8 *
7181 cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
7182 			const u8 *ies, unsigned int len)
7183 {
7184 	return (const void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
7185 }
7186 
7187 /**
7188  * enum cfg80211_rnr_iter_ret - reduced neighbor report iteration state
7189  * @RNR_ITER_CONTINUE: continue iterating with the next entry
7190  * @RNR_ITER_BREAK: break iteration and return success
7191  * @RNR_ITER_ERROR: break iteration and return error
7192  */
7193 enum cfg80211_rnr_iter_ret {
7194 	RNR_ITER_CONTINUE,
7195 	RNR_ITER_BREAK,
7196 	RNR_ITER_ERROR,
7197 };
7198 
7199 /**
7200  * cfg80211_iter_rnr - iterate reduced neighbor report entries
7201  * @elems: the frame elements to iterate RNR elements and then
7202  *	their entries in
7203  * @elems_len: length of the elements
7204  * @iter: iteration function, see also &enum cfg80211_rnr_iter_ret
7205  *	for the return value
7206  * @iter_data: additional data passed to the iteration function
7207  * Return: %true on success (after successfully iterating all entries
7208  *	or if the iteration function returned %RNR_ITER_BREAK),
7209  *	%false on error (iteration function returned %RNR_ITER_ERROR
7210  *	or elements were malformed.)
7211  */
7212 bool cfg80211_iter_rnr(const u8 *elems, size_t elems_len,
7213 		       enum cfg80211_rnr_iter_ret
7214 		       (*iter)(void *data, u8 type,
7215 			       const struct ieee80211_neighbor_ap_info *info,
7216 			       const u8 *tbtt_info, u8 tbtt_info_len),
7217 		       void *iter_data);
7218 
7219 /**
7220  * cfg80211_defragment_element - Defrag the given element data into a buffer
7221  *
7222  * @elem: the element to defragment
7223  * @ies: elements where @elem is contained
7224  * @ieslen: length of @ies
7225  * @data: buffer to store element data, or %NULL to just determine size
7226  * @data_len: length of @data, or 0
7227  * @frag_id: the element ID of fragments
7228  *
7229  * Return: length of @data, or -EINVAL on error
7230  *
7231  * Copy out all data from an element that may be fragmented into @data, while
7232  * skipping all headers.
7233  *
7234  * The function uses memmove() internally. It is acceptable to defragment an
7235  * element in-place.
7236  */
7237 ssize_t cfg80211_defragment_element(const struct element *elem, const u8 *ies,
7238 				    size_t ieslen, u8 *data, size_t data_len,
7239 				    u8 frag_id);
7240 
7241 /**
7242  * cfg80211_send_layer2_update - send layer 2 update frame
7243  *
7244  * @dev: network device
7245  * @addr: STA MAC address
7246  *
7247  * Wireless drivers can use this function to update forwarding tables in bridge
7248  * devices upon STA association.
7249  */
7250 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
7251 
7252 /**
7253  * DOC: Regulatory enforcement infrastructure
7254  *
7255  * TODO
7256  */
7257 
7258 /**
7259  * regulatory_hint - driver hint to the wireless core a regulatory domain
7260  * @wiphy: the wireless device giving the hint (used only for reporting
7261  *	conflicts)
7262  * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
7263  *	should be in. If @rd is set this should be NULL. Note that if you
7264  *	set this to NULL you should still set rd->alpha2 to some accepted
7265  *	alpha2.
7266  *
7267  * Wireless drivers can use this function to hint to the wireless core
7268  * what it believes should be the current regulatory domain by
7269  * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
7270  * domain should be in or by providing a completely build regulatory domain.
7271  * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
7272  * for a regulatory domain structure for the respective country.
7273  *
7274  * The wiphy must have been registered to cfg80211 prior to this call.
7275  * For cfg80211 drivers this means you must first use wiphy_register(),
7276  * for mac80211 drivers you must first use ieee80211_register_hw().
7277  *
7278  * Drivers should check the return value, its possible you can get
7279  * an -ENOMEM.
7280  *
7281  * Return: 0 on success. -ENOMEM.
7282  */
7283 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
7284 
7285 /**
7286  * regulatory_set_wiphy_regd - set regdom info for self managed drivers
7287  * @wiphy: the wireless device we want to process the regulatory domain on
7288  * @rd: the regulatory domain information to use for this wiphy
7289  *
7290  * Set the regulatory domain information for self-managed wiphys, only they
7291  * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
7292  * information.
7293  *
7294  * Return: 0 on success. -EINVAL, -EPERM
7295  */
7296 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
7297 			      struct ieee80211_regdomain *rd);
7298 
7299 /**
7300  * regulatory_set_wiphy_regd_sync - set regdom for self-managed drivers
7301  * @wiphy: the wireless device we want to process the regulatory domain on
7302  * @rd: the regulatory domain information to use for this wiphy
7303  *
7304  * This functions requires the RTNL and the wiphy mutex to be held and
7305  * applies the new regdomain synchronously to this wiphy. For more details
7306  * see regulatory_set_wiphy_regd().
7307  *
7308  * Return: 0 on success. -EINVAL, -EPERM
7309  */
7310 int regulatory_set_wiphy_regd_sync(struct wiphy *wiphy,
7311 				   struct ieee80211_regdomain *rd);
7312 
7313 /**
7314  * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
7315  * @wiphy: the wireless device we want to process the regulatory domain on
7316  * @regd: the custom regulatory domain to use for this wiphy
7317  *
7318  * Drivers can sometimes have custom regulatory domains which do not apply
7319  * to a specific country. Drivers can use this to apply such custom regulatory
7320  * domains. This routine must be called prior to wiphy registration. The
7321  * custom regulatory domain will be trusted completely and as such previous
7322  * default channel settings will be disregarded. If no rule is found for a
7323  * channel on the regulatory domain the channel will be disabled.
7324  * Drivers using this for a wiphy should also set the wiphy flag
7325  * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
7326  * that called this helper.
7327  */
7328 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
7329 				   const struct ieee80211_regdomain *regd);
7330 
7331 /**
7332  * freq_reg_info - get regulatory information for the given frequency
7333  * @wiphy: the wiphy for which we want to process this rule for
7334  * @center_freq: Frequency in KHz for which we want regulatory information for
7335  *
7336  * Use this function to get the regulatory rule for a specific frequency on
7337  * a given wireless device. If the device has a specific regulatory domain
7338  * it wants to follow we respect that unless a country IE has been received
7339  * and processed already.
7340  *
7341  * Return: A valid pointer, or, when an error occurs, for example if no rule
7342  * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
7343  * check and PTR_ERR() to obtain the numeric return value. The numeric return
7344  * value will be -ERANGE if we determine the given center_freq does not even
7345  * have a regulatory rule for a frequency range in the center_freq's band.
7346  * See freq_in_rule_band() for our current definition of a band -- this is
7347  * purely subjective and right now it's 802.11 specific.
7348  */
7349 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
7350 					       u32 center_freq);
7351 
7352 /**
7353  * reg_initiator_name - map regulatory request initiator enum to name
7354  * @initiator: the regulatory request initiator
7355  *
7356  * You can use this to map the regulatory request initiator enum to a
7357  * proper string representation.
7358  *
7359  * Return: pointer to string representation of the initiator
7360  */
7361 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
7362 
7363 /**
7364  * regulatory_pre_cac_allowed - check if pre-CAC allowed in the current regdom
7365  * @wiphy: wiphy for which pre-CAC capability is checked.
7366  *
7367  * Pre-CAC is allowed only in some regdomains (notable ETSI).
7368  *
7369  * Return: %true if allowed, %false otherwise
7370  */
7371 bool regulatory_pre_cac_allowed(struct wiphy *wiphy);
7372 
7373 /**
7374  * DOC: Internal regulatory db functions
7375  *
7376  */
7377 
7378 /**
7379  * reg_query_regdb_wmm -  Query internal regulatory db for wmm rule
7380  * Regulatory self-managed driver can use it to proactively
7381  *
7382  * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
7383  * @freq: the frequency (in MHz) to be queried.
7384  * @rule: pointer to store the wmm rule from the regulatory db.
7385  *
7386  * Self-managed wireless drivers can use this function to  query
7387  * the internal regulatory database to check whether the given
7388  * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
7389  *
7390  * Drivers should check the return value, its possible you can get
7391  * an -ENODATA.
7392  *
7393  * Return: 0 on success. -ENODATA.
7394  */
7395 int reg_query_regdb_wmm(char *alpha2, int freq,
7396 			struct ieee80211_reg_rule *rule);
7397 
7398 /*
7399  * callbacks for asynchronous cfg80211 methods, notification
7400  * functions and BSS handling helpers
7401  */
7402 
7403 /**
7404  * cfg80211_scan_done - notify that scan finished
7405  *
7406  * @request: the corresponding scan request
7407  * @info: information about the completed scan
7408  */
7409 void cfg80211_scan_done(struct cfg80211_scan_request *request,
7410 			struct cfg80211_scan_info *info);
7411 
7412 /**
7413  * cfg80211_sched_scan_results - notify that new scan results are available
7414  *
7415  * @wiphy: the wiphy which got scheduled scan results
7416  * @reqid: identifier for the related scheduled scan request
7417  */
7418 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
7419 
7420 /**
7421  * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
7422  *
7423  * @wiphy: the wiphy on which the scheduled scan stopped
7424  * @reqid: identifier for the related scheduled scan request
7425  *
7426  * The driver can call this function to inform cfg80211 that the
7427  * scheduled scan had to be stopped, for whatever reason.  The driver
7428  * is then called back via the sched_scan_stop operation when done.
7429  */
7430 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
7431 
7432 /**
7433  * cfg80211_sched_scan_stopped_locked - notify that the scheduled scan has stopped
7434  *
7435  * @wiphy: the wiphy on which the scheduled scan stopped
7436  * @reqid: identifier for the related scheduled scan request
7437  *
7438  * The driver can call this function to inform cfg80211 that the
7439  * scheduled scan had to be stopped, for whatever reason.  The driver
7440  * is then called back via the sched_scan_stop operation when done.
7441  * This function should be called with the wiphy mutex held.
7442  */
7443 void cfg80211_sched_scan_stopped_locked(struct wiphy *wiphy, u64 reqid);
7444 
7445 /**
7446  * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
7447  * @wiphy: the wiphy reporting the BSS
7448  * @data: the BSS metadata
7449  * @mgmt: the management frame (probe response or beacon)
7450  * @len: length of the management frame
7451  * @gfp: context flags
7452  *
7453  * This informs cfg80211 that BSS information was found and
7454  * the BSS should be updated/added.
7455  *
7456  * Return: A referenced struct, must be released with cfg80211_put_bss()!
7457  * Or %NULL on error.
7458  */
7459 struct cfg80211_bss * __must_check
7460 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
7461 			       struct cfg80211_inform_bss *data,
7462 			       struct ieee80211_mgmt *mgmt, size_t len,
7463 			       gfp_t gfp);
7464 
7465 static inline struct cfg80211_bss * __must_check
7466 cfg80211_inform_bss_frame(struct wiphy *wiphy,
7467 			  struct ieee80211_channel *rx_channel,
7468 			  struct ieee80211_mgmt *mgmt, size_t len,
7469 			  s32 signal, gfp_t gfp)
7470 {
7471 	struct cfg80211_inform_bss data = {
7472 		.chan = rx_channel,
7473 		.signal = signal,
7474 	};
7475 
7476 	return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
7477 }
7478 
7479 /**
7480  * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
7481  * @bssid: transmitter BSSID
7482  * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
7483  * @mbssid_index: BSSID index, taken from Multiple BSSID index element
7484  * @new_bssid: calculated nontransmitted BSSID
7485  */
7486 static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
7487 					  u8 mbssid_index, u8 *new_bssid)
7488 {
7489 	u64 bssid_u64 = ether_addr_to_u64(bssid);
7490 	u64 mask = GENMASK_ULL(max_bssid - 1, 0);
7491 	u64 new_bssid_u64;
7492 
7493 	new_bssid_u64 = bssid_u64 & ~mask;
7494 
7495 	new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
7496 
7497 	u64_to_ether_addr(new_bssid_u64, new_bssid);
7498 }
7499 
7500 /**
7501  * cfg80211_is_element_inherited - returns if element ID should be inherited
7502  * @element: element to check
7503  * @non_inherit_element: non inheritance element
7504  *
7505  * Return: %true if should be inherited, %false otherwise
7506  */
7507 bool cfg80211_is_element_inherited(const struct element *element,
7508 				   const struct element *non_inherit_element);
7509 
7510 /**
7511  * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
7512  * @ie: ies
7513  * @ielen: length of IEs
7514  * @mbssid_elem: current MBSSID element
7515  * @sub_elem: current MBSSID subelement (profile)
7516  * @merged_ie: location of the merged profile
7517  * @max_copy_len: max merged profile length
7518  *
7519  * Return: the number of bytes merged
7520  */
7521 size_t cfg80211_merge_profile(const u8 *ie, size_t ielen,
7522 			      const struct element *mbssid_elem,
7523 			      const struct element *sub_elem,
7524 			      u8 *merged_ie, size_t max_copy_len);
7525 
7526 /**
7527  * enum cfg80211_bss_frame_type - frame type that the BSS data came from
7528  * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
7529  *	from a beacon or probe response
7530  * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
7531  * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
7532  * @CFG80211_BSS_FTYPE_S1G_BEACON: data comes from an S1G beacon
7533  */
7534 enum cfg80211_bss_frame_type {
7535 	CFG80211_BSS_FTYPE_UNKNOWN,
7536 	CFG80211_BSS_FTYPE_BEACON,
7537 	CFG80211_BSS_FTYPE_PRESP,
7538 	CFG80211_BSS_FTYPE_S1G_BEACON,
7539 };
7540 
7541 /**
7542  * cfg80211_get_ies_channel_number - returns the channel number from ies
7543  * @ie: IEs
7544  * @ielen: length of IEs
7545  * @band: enum nl80211_band of the channel
7546  *
7547  * Return: the channel number, or -1 if none could be determined.
7548  */
7549 int cfg80211_get_ies_channel_number(const u8 *ie, size_t ielen,
7550 				    enum nl80211_band band);
7551 
7552 /**
7553  * cfg80211_ssid_eq - compare two SSIDs
7554  * @a: first SSID
7555  * @b: second SSID
7556  *
7557  * Return: %true if SSIDs are equal, %false otherwise.
7558  */
7559 static inline bool
7560 cfg80211_ssid_eq(struct cfg80211_ssid *a, struct cfg80211_ssid *b)
7561 {
7562 	if (WARN_ON(!a || !b))
7563 		return false;
7564 	if (a->ssid_len != b->ssid_len)
7565 		return false;
7566 	return memcmp(a->ssid, b->ssid, a->ssid_len) ? false : true;
7567 }
7568 
7569 /**
7570  * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
7571  *
7572  * @wiphy: the wiphy reporting the BSS
7573  * @data: the BSS metadata
7574  * @ftype: frame type (if known)
7575  * @bssid: the BSSID of the BSS
7576  * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
7577  * @capability: the capability field sent by the peer
7578  * @beacon_interval: the beacon interval announced by the peer
7579  * @ie: additional IEs sent by the peer
7580  * @ielen: length of the additional IEs
7581  * @gfp: context flags
7582  *
7583  * This informs cfg80211 that BSS information was found and
7584  * the BSS should be updated/added.
7585  *
7586  * Return: A referenced struct, must be released with cfg80211_put_bss()!
7587  * Or %NULL on error.
7588  */
7589 struct cfg80211_bss * __must_check
7590 cfg80211_inform_bss_data(struct wiphy *wiphy,
7591 			 struct cfg80211_inform_bss *data,
7592 			 enum cfg80211_bss_frame_type ftype,
7593 			 const u8 *bssid, u64 tsf, u16 capability,
7594 			 u16 beacon_interval, const u8 *ie, size_t ielen,
7595 			 gfp_t gfp);
7596 
7597 static inline struct cfg80211_bss * __must_check
7598 cfg80211_inform_bss(struct wiphy *wiphy,
7599 		    struct ieee80211_channel *rx_channel,
7600 		    enum cfg80211_bss_frame_type ftype,
7601 		    const u8 *bssid, u64 tsf, u16 capability,
7602 		    u16 beacon_interval, const u8 *ie, size_t ielen,
7603 		    s32 signal, gfp_t gfp)
7604 {
7605 	struct cfg80211_inform_bss data = {
7606 		.chan = rx_channel,
7607 		.signal = signal,
7608 	};
7609 
7610 	return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
7611 					capability, beacon_interval, ie, ielen,
7612 					gfp);
7613 }
7614 
7615 /**
7616  * __cfg80211_get_bss - get a BSS reference
7617  * @wiphy: the wiphy this BSS struct belongs to
7618  * @channel: the channel to search on (or %NULL)
7619  * @bssid: the desired BSSID (or %NULL)
7620  * @ssid: the desired SSID (or %NULL)
7621  * @ssid_len: length of the SSID (or 0)
7622  * @bss_type: type of BSS, see &enum ieee80211_bss_type
7623  * @privacy: privacy filter, see &enum ieee80211_privacy
7624  * @use_for: indicates which use is intended
7625  *
7626  * Return: Reference-counted BSS on success. %NULL on error.
7627  */
7628 struct cfg80211_bss *__cfg80211_get_bss(struct wiphy *wiphy,
7629 					struct ieee80211_channel *channel,
7630 					const u8 *bssid,
7631 					const u8 *ssid, size_t ssid_len,
7632 					enum ieee80211_bss_type bss_type,
7633 					enum ieee80211_privacy privacy,
7634 					u32 use_for);
7635 
7636 /**
7637  * cfg80211_get_bss - get a BSS reference
7638  * @wiphy: the wiphy this BSS struct belongs to
7639  * @channel: the channel to search on (or %NULL)
7640  * @bssid: the desired BSSID (or %NULL)
7641  * @ssid: the desired SSID (or %NULL)
7642  * @ssid_len: length of the SSID (or 0)
7643  * @bss_type: type of BSS, see &enum ieee80211_bss_type
7644  * @privacy: privacy filter, see &enum ieee80211_privacy
7645  *
7646  * This version implies regular usage, %NL80211_BSS_USE_FOR_NORMAL.
7647  *
7648  * Return: Reference-counted BSS on success. %NULL on error.
7649  */
7650 static inline struct cfg80211_bss *
7651 cfg80211_get_bss(struct wiphy *wiphy, struct ieee80211_channel *channel,
7652 		 const u8 *bssid, const u8 *ssid, size_t ssid_len,
7653 		 enum ieee80211_bss_type bss_type,
7654 		 enum ieee80211_privacy privacy)
7655 {
7656 	return __cfg80211_get_bss(wiphy, channel, bssid, ssid, ssid_len,
7657 				  bss_type, privacy,
7658 				  NL80211_BSS_USE_FOR_NORMAL);
7659 }
7660 
7661 static inline struct cfg80211_bss *
7662 cfg80211_get_ibss(struct wiphy *wiphy,
7663 		  struct ieee80211_channel *channel,
7664 		  const u8 *ssid, size_t ssid_len)
7665 {
7666 	return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
7667 				IEEE80211_BSS_TYPE_IBSS,
7668 				IEEE80211_PRIVACY_ANY);
7669 }
7670 
7671 /**
7672  * cfg80211_ref_bss - reference BSS struct
7673  * @wiphy: the wiphy this BSS struct belongs to
7674  * @bss: the BSS struct to reference
7675  *
7676  * Increments the refcount of the given BSS struct.
7677  */
7678 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
7679 
7680 /**
7681  * cfg80211_put_bss - unref BSS struct
7682  * @wiphy: the wiphy this BSS struct belongs to
7683  * @bss: the BSS struct
7684  *
7685  * Decrements the refcount of the given BSS struct.
7686  */
7687 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
7688 
7689 /**
7690  * cfg80211_unlink_bss - unlink BSS from internal data structures
7691  * @wiphy: the wiphy
7692  * @bss: the bss to remove
7693  *
7694  * This function removes the given BSS from the internal data structures
7695  * thereby making it no longer show up in scan results etc. Use this
7696  * function when you detect a BSS is gone. Normally BSSes will also time
7697  * out, so it is not necessary to use this function at all.
7698  */
7699 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
7700 
7701 /**
7702  * cfg80211_bss_iter - iterate all BSS entries
7703  *
7704  * This function iterates over the BSS entries associated with the given wiphy
7705  * and calls the callback for the iterated BSS. The iterator function is not
7706  * allowed to call functions that might modify the internal state of the BSS DB.
7707  *
7708  * @wiphy: the wiphy
7709  * @chandef: if given, the iterator function will be called only if the channel
7710  *     of the currently iterated BSS is a subset of the given channel.
7711  * @iter: the iterator function to call
7712  * @iter_data: an argument to the iterator function
7713  */
7714 void cfg80211_bss_iter(struct wiphy *wiphy,
7715 		       struct cfg80211_chan_def *chandef,
7716 		       void (*iter)(struct wiphy *wiphy,
7717 				    struct cfg80211_bss *bss,
7718 				    void *data),
7719 		       void *iter_data);
7720 
7721 /**
7722  * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
7723  * @dev: network device
7724  * @buf: authentication frame (header + body)
7725  * @len: length of the frame data
7726  *
7727  * This function is called whenever an authentication, disassociation or
7728  * deauthentication frame has been received and processed in station mode.
7729  * After being asked to authenticate via cfg80211_ops::auth() the driver must
7730  * call either this function or cfg80211_auth_timeout().
7731  * After being asked to associate via cfg80211_ops::assoc() the driver must
7732  * call either this function or cfg80211_auth_timeout().
7733  * While connected, the driver must calls this for received and processed
7734  * disassociation and deauthentication frames. If the frame couldn't be used
7735  * because it was unprotected, the driver must call the function
7736  * cfg80211_rx_unprot_mlme_mgmt() instead.
7737  *
7738  * This function may sleep. The caller must hold the corresponding wdev's mutex.
7739  */
7740 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
7741 
7742 /**
7743  * cfg80211_auth_timeout - notification of timed out authentication
7744  * @dev: network device
7745  * @addr: The MAC address of the device with which the authentication timed out
7746  *
7747  * This function may sleep. The caller must hold the corresponding wdev's
7748  * mutex.
7749  */
7750 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
7751 
7752 /**
7753  * struct cfg80211_rx_assoc_resp_data - association response data
7754  * @buf: (Re)Association Response frame (header + body)
7755  * @len: length of the frame data
7756  * @uapsd_queues: bitmap of queues configured for uapsd. Same format
7757  *	as the AC bitmap in the QoS info field
7758  * @req_ies: information elements from the (Re)Association Request frame
7759  * @req_ies_len: length of req_ies data
7760  * @ap_mld_addr: AP MLD address (in case of MLO)
7761  * @links: per-link information indexed by link ID, use links[0] for
7762  *	non-MLO connections
7763  * @links.bss: the BSS that association was requested with, ownership of the
7764  *      pointer moves to cfg80211 in the call to cfg80211_rx_assoc_resp()
7765  * @links.status: Set this (along with a BSS pointer) for links that
7766  *	were rejected by the AP.
7767  */
7768 struct cfg80211_rx_assoc_resp_data {
7769 	const u8 *buf;
7770 	size_t len;
7771 	const u8 *req_ies;
7772 	size_t req_ies_len;
7773 	int uapsd_queues;
7774 	const u8 *ap_mld_addr;
7775 	struct {
7776 		u8 addr[ETH_ALEN] __aligned(2);
7777 		struct cfg80211_bss *bss;
7778 		u16 status;
7779 	} links[IEEE80211_MLD_MAX_NUM_LINKS];
7780 };
7781 
7782 /**
7783  * cfg80211_rx_assoc_resp - notification of processed association response
7784  * @dev: network device
7785  * @data: association response data, &struct cfg80211_rx_assoc_resp_data
7786  *
7787  * After being asked to associate via cfg80211_ops::assoc() the driver must
7788  * call either this function or cfg80211_auth_timeout().
7789  *
7790  * This function may sleep. The caller must hold the corresponding wdev's mutex.
7791  */
7792 void cfg80211_rx_assoc_resp(struct net_device *dev,
7793 			    const struct cfg80211_rx_assoc_resp_data *data);
7794 
7795 /**
7796  * struct cfg80211_assoc_failure - association failure data
7797  * @ap_mld_addr: AP MLD address, or %NULL
7798  * @bss: list of BSSes, must use entry 0 for non-MLO connections
7799  *	(@ap_mld_addr is %NULL)
7800  * @timeout: indicates the association failed due to timeout, otherwise
7801  *	the association was abandoned for a reason reported through some
7802  *	other API (e.g. deauth RX)
7803  */
7804 struct cfg80211_assoc_failure {
7805 	const u8 *ap_mld_addr;
7806 	struct cfg80211_bss *bss[IEEE80211_MLD_MAX_NUM_LINKS];
7807 	bool timeout;
7808 };
7809 
7810 /**
7811  * cfg80211_assoc_failure - notification of association failure
7812  * @dev: network device
7813  * @data: data describing the association failure
7814  *
7815  * This function may sleep. The caller must hold the corresponding wdev's mutex.
7816  */
7817 void cfg80211_assoc_failure(struct net_device *dev,
7818 			    struct cfg80211_assoc_failure *data);
7819 
7820 /**
7821  * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
7822  * @dev: network device
7823  * @buf: 802.11 frame (header + body)
7824  * @len: length of the frame data
7825  * @reconnect: immediate reconnect is desired (include the nl80211 attribute)
7826  *
7827  * This function is called whenever deauthentication has been processed in
7828  * station mode. This includes both received deauthentication frames and
7829  * locally generated ones. This function may sleep. The caller must hold the
7830  * corresponding wdev's mutex.
7831  */
7832 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len,
7833 			   bool reconnect);
7834 
7835 /**
7836  * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
7837  * @dev: network device
7838  * @buf: received management frame (header + body)
7839  * @len: length of the frame data
7840  *
7841  * This function is called whenever a received deauthentication or dissassoc
7842  * frame has been dropped in station mode because of MFP being used but the
7843  * frame was not protected. This is also used to notify reception of a Beacon
7844  * frame that was dropped because it did not include a valid MME MIC while
7845  * beacon protection was enabled (BIGTK configured in station mode).
7846  *
7847  * This function may sleep.
7848  */
7849 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
7850 				  const u8 *buf, size_t len);
7851 
7852 /**
7853  * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
7854  * @dev: network device
7855  * @addr: The source MAC address of the frame
7856  * @key_type: The key type that the received frame used
7857  * @key_id: Key identifier (0..3). Can be -1 if missing.
7858  * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
7859  * @gfp: allocation flags
7860  *
7861  * This function is called whenever the local MAC detects a MIC failure in a
7862  * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
7863  * primitive.
7864  */
7865 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
7866 				  enum nl80211_key_type key_type, int key_id,
7867 				  const u8 *tsc, gfp_t gfp);
7868 
7869 /**
7870  * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
7871  *
7872  * @dev: network device
7873  * @bssid: the BSSID of the IBSS joined
7874  * @channel: the channel of the IBSS joined
7875  * @gfp: allocation flags
7876  *
7877  * This function notifies cfg80211 that the device joined an IBSS or
7878  * switched to a different BSSID. Before this function can be called,
7879  * either a beacon has to have been received from the IBSS, or one of
7880  * the cfg80211_inform_bss{,_frame} functions must have been called
7881  * with the locally generated beacon -- this guarantees that there is
7882  * always a scan result for this IBSS. cfg80211 will handle the rest.
7883  */
7884 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
7885 			  struct ieee80211_channel *channel, gfp_t gfp);
7886 
7887 /**
7888  * cfg80211_notify_new_peer_candidate - notify cfg80211 of a new mesh peer
7889  * 					candidate
7890  *
7891  * @dev: network device
7892  * @macaddr: the MAC address of the new candidate
7893  * @ie: information elements advertised by the peer candidate
7894  * @ie_len: length of the information elements buffer
7895  * @sig_dbm: signal level in dBm
7896  * @gfp: allocation flags
7897  *
7898  * This function notifies cfg80211 that the mesh peer candidate has been
7899  * detected, most likely via a beacon or, less likely, via a probe response.
7900  * cfg80211 then sends a notification to userspace.
7901  */
7902 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
7903 		const u8 *macaddr, const u8 *ie, u8 ie_len,
7904 		int sig_dbm, gfp_t gfp);
7905 
7906 /**
7907  * DOC: RFkill integration
7908  *
7909  * RFkill integration in cfg80211 is almost invisible to drivers,
7910  * as cfg80211 automatically registers an rfkill instance for each
7911  * wireless device it knows about. Soft kill is also translated
7912  * into disconnecting and turning all interfaces off. Drivers are
7913  * expected to turn off the device when all interfaces are down.
7914  *
7915  * However, devices may have a hard RFkill line, in which case they
7916  * also need to interact with the rfkill subsystem, via cfg80211.
7917  * They can do this with a few helper functions documented here.
7918  */
7919 
7920 /**
7921  * wiphy_rfkill_set_hw_state_reason - notify cfg80211 about hw block state
7922  * @wiphy: the wiphy
7923  * @blocked: block status
7924  * @reason: one of reasons in &enum rfkill_hard_block_reasons
7925  */
7926 void wiphy_rfkill_set_hw_state_reason(struct wiphy *wiphy, bool blocked,
7927 				      enum rfkill_hard_block_reasons reason);
7928 
7929 static inline void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked)
7930 {
7931 	wiphy_rfkill_set_hw_state_reason(wiphy, blocked,
7932 					 RFKILL_HARD_BLOCK_SIGNAL);
7933 }
7934 
7935 /**
7936  * wiphy_rfkill_start_polling - start polling rfkill
7937  * @wiphy: the wiphy
7938  */
7939 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
7940 
7941 /**
7942  * wiphy_rfkill_stop_polling - stop polling rfkill
7943  * @wiphy: the wiphy
7944  */
7945 static inline void wiphy_rfkill_stop_polling(struct wiphy *wiphy)
7946 {
7947 	rfkill_pause_polling(wiphy->rfkill);
7948 }
7949 
7950 /**
7951  * DOC: Vendor commands
7952  *
7953  * Occasionally, there are special protocol or firmware features that
7954  * can't be implemented very openly. For this and similar cases, the
7955  * vendor command functionality allows implementing the features with
7956  * (typically closed-source) userspace and firmware, using nl80211 as
7957  * the configuration mechanism.
7958  *
7959  * A driver supporting vendor commands must register them as an array
7960  * in struct wiphy, with handlers for each one. Each command has an
7961  * OUI and sub command ID to identify it.
7962  *
7963  * Note that this feature should not be (ab)used to implement protocol
7964  * features that could openly be shared across drivers. In particular,
7965  * it must never be required to use vendor commands to implement any
7966  * "normal" functionality that higher-level userspace like connection
7967  * managers etc. need.
7968  */
7969 
7970 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
7971 					   enum nl80211_commands cmd,
7972 					   enum nl80211_attrs attr,
7973 					   int approxlen);
7974 
7975 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
7976 					   struct wireless_dev *wdev,
7977 					   enum nl80211_commands cmd,
7978 					   enum nl80211_attrs attr,
7979 					   unsigned int portid,
7980 					   int vendor_event_idx,
7981 					   int approxlen, gfp_t gfp);
7982 
7983 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
7984 
7985 /**
7986  * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
7987  * @wiphy: the wiphy
7988  * @approxlen: an upper bound of the length of the data that will
7989  *	be put into the skb
7990  *
7991  * This function allocates and pre-fills an skb for a reply to
7992  * a vendor command. Since it is intended for a reply, calling
7993  * it outside of a vendor command's doit() operation is invalid.
7994  *
7995  * The returned skb is pre-filled with some identifying data in
7996  * a way that any data that is put into the skb (with skb_put(),
7997  * nla_put() or similar) will end up being within the
7998  * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
7999  * with the skb is adding data for the corresponding userspace tool
8000  * which can then read that data out of the vendor data attribute.
8001  * You must not modify the skb in any other way.
8002  *
8003  * When done, call cfg80211_vendor_cmd_reply() with the skb and return
8004  * its error code as the result of the doit() operation.
8005  *
8006  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
8007  */
8008 static inline struct sk_buff *
8009 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
8010 {
8011 	return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
8012 					  NL80211_ATTR_VENDOR_DATA, approxlen);
8013 }
8014 
8015 /**
8016  * cfg80211_vendor_cmd_reply - send the reply skb
8017  * @skb: The skb, must have been allocated with
8018  *	cfg80211_vendor_cmd_alloc_reply_skb()
8019  *
8020  * Since calling this function will usually be the last thing
8021  * before returning from the vendor command doit() you should
8022  * return the error code.  Note that this function consumes the
8023  * skb regardless of the return value.
8024  *
8025  * Return: An error code or 0 on success.
8026  */
8027 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
8028 
8029 /**
8030  * cfg80211_vendor_cmd_get_sender - get the current sender netlink ID
8031  * @wiphy: the wiphy
8032  *
8033  * Return: the current netlink port ID in a vendor command handler.
8034  *
8035  * Context: May only be called from a vendor command handler
8036  */
8037 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
8038 
8039 /**
8040  * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
8041  * @wiphy: the wiphy
8042  * @wdev: the wireless device
8043  * @event_idx: index of the vendor event in the wiphy's vendor_events
8044  * @approxlen: an upper bound of the length of the data that will
8045  *	be put into the skb
8046  * @gfp: allocation flags
8047  *
8048  * This function allocates and pre-fills an skb for an event on the
8049  * vendor-specific multicast group.
8050  *
8051  * If wdev != NULL, both the ifindex and identifier of the specified
8052  * wireless device are added to the event message before the vendor data
8053  * attribute.
8054  *
8055  * When done filling the skb, call cfg80211_vendor_event() with the
8056  * skb to send the event.
8057  *
8058  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
8059  */
8060 static inline struct sk_buff *
8061 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
8062 			     int approxlen, int event_idx, gfp_t gfp)
8063 {
8064 	return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
8065 					  NL80211_ATTR_VENDOR_DATA,
8066 					  0, event_idx, approxlen, gfp);
8067 }
8068 
8069 /**
8070  * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
8071  * @wiphy: the wiphy
8072  * @wdev: the wireless device
8073  * @event_idx: index of the vendor event in the wiphy's vendor_events
8074  * @portid: port ID of the receiver
8075  * @approxlen: an upper bound of the length of the data that will
8076  *	be put into the skb
8077  * @gfp: allocation flags
8078  *
8079  * This function allocates and pre-fills an skb for an event to send to
8080  * a specific (userland) socket. This socket would previously have been
8081  * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
8082  * care to register a netlink notifier to see when the socket closes.
8083  *
8084  * If wdev != NULL, both the ifindex and identifier of the specified
8085  * wireless device are added to the event message before the vendor data
8086  * attribute.
8087  *
8088  * When done filling the skb, call cfg80211_vendor_event() with the
8089  * skb to send the event.
8090  *
8091  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
8092  */
8093 static inline struct sk_buff *
8094 cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
8095 				  struct wireless_dev *wdev,
8096 				  unsigned int portid, int approxlen,
8097 				  int event_idx, gfp_t gfp)
8098 {
8099 	return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
8100 					  NL80211_ATTR_VENDOR_DATA,
8101 					  portid, event_idx, approxlen, gfp);
8102 }
8103 
8104 /**
8105  * cfg80211_vendor_event - send the event
8106  * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
8107  * @gfp: allocation flags
8108  *
8109  * This function sends the given @skb, which must have been allocated
8110  * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
8111  */
8112 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
8113 {
8114 	__cfg80211_send_event_skb(skb, gfp);
8115 }
8116 
8117 #ifdef CONFIG_NL80211_TESTMODE
8118 /**
8119  * DOC: Test mode
8120  *
8121  * Test mode is a set of utility functions to allow drivers to
8122  * interact with driver-specific tools to aid, for instance,
8123  * factory programming.
8124  *
8125  * This chapter describes how drivers interact with it. For more
8126  * information see the nl80211 book's chapter on it.
8127  */
8128 
8129 /**
8130  * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
8131  * @wiphy: the wiphy
8132  * @approxlen: an upper bound of the length of the data that will
8133  *	be put into the skb
8134  *
8135  * This function allocates and pre-fills an skb for a reply to
8136  * the testmode command. Since it is intended for a reply, calling
8137  * it outside of the @testmode_cmd operation is invalid.
8138  *
8139  * The returned skb is pre-filled with the wiphy index and set up in
8140  * a way that any data that is put into the skb (with skb_put(),
8141  * nla_put() or similar) will end up being within the
8142  * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
8143  * with the skb is adding data for the corresponding userspace tool
8144  * which can then read that data out of the testdata attribute. You
8145  * must not modify the skb in any other way.
8146  *
8147  * When done, call cfg80211_testmode_reply() with the skb and return
8148  * its error code as the result of the @testmode_cmd operation.
8149  *
8150  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
8151  */
8152 static inline struct sk_buff *
8153 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
8154 {
8155 	return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
8156 					  NL80211_ATTR_TESTDATA, approxlen);
8157 }
8158 
8159 /**
8160  * cfg80211_testmode_reply - send the reply skb
8161  * @skb: The skb, must have been allocated with
8162  *	cfg80211_testmode_alloc_reply_skb()
8163  *
8164  * Since calling this function will usually be the last thing
8165  * before returning from the @testmode_cmd you should return
8166  * the error code.  Note that this function consumes the skb
8167  * regardless of the return value.
8168  *
8169  * Return: An error code or 0 on success.
8170  */
8171 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
8172 {
8173 	return cfg80211_vendor_cmd_reply(skb);
8174 }
8175 
8176 /**
8177  * cfg80211_testmode_alloc_event_skb - allocate testmode event
8178  * @wiphy: the wiphy
8179  * @approxlen: an upper bound of the length of the data that will
8180  *	be put into the skb
8181  * @gfp: allocation flags
8182  *
8183  * This function allocates and pre-fills an skb for an event on the
8184  * testmode multicast group.
8185  *
8186  * The returned skb is set up in the same way as with
8187  * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
8188  * there, you should simply add data to it that will then end up in the
8189  * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
8190  * in any other way.
8191  *
8192  * When done filling the skb, call cfg80211_testmode_event() with the
8193  * skb to send the event.
8194  *
8195  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
8196  */
8197 static inline struct sk_buff *
8198 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
8199 {
8200 	return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
8201 					  NL80211_ATTR_TESTDATA, 0, -1,
8202 					  approxlen, gfp);
8203 }
8204 
8205 /**
8206  * cfg80211_testmode_event - send the event
8207  * @skb: The skb, must have been allocated with
8208  *	cfg80211_testmode_alloc_event_skb()
8209  * @gfp: allocation flags
8210  *
8211  * This function sends the given @skb, which must have been allocated
8212  * by cfg80211_testmode_alloc_event_skb(), as an event. It always
8213  * consumes it.
8214  */
8215 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
8216 {
8217 	__cfg80211_send_event_skb(skb, gfp);
8218 }
8219 
8220 #define CFG80211_TESTMODE_CMD(cmd)	.testmode_cmd = (cmd),
8221 #define CFG80211_TESTMODE_DUMP(cmd)	.testmode_dump = (cmd),
8222 #else
8223 #define CFG80211_TESTMODE_CMD(cmd)
8224 #define CFG80211_TESTMODE_DUMP(cmd)
8225 #endif
8226 
8227 /**
8228  * struct cfg80211_fils_resp_params - FILS connection response params
8229  * @kek: KEK derived from a successful FILS connection (may be %NULL)
8230  * @kek_len: Length of @fils_kek in octets
8231  * @update_erp_next_seq_num: Boolean value to specify whether the value in
8232  *	@erp_next_seq_num is valid.
8233  * @erp_next_seq_num: The next sequence number to use in ERP message in
8234  *	FILS Authentication. This value should be specified irrespective of the
8235  *	status for a FILS connection.
8236  * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
8237  * @pmk_len: Length of @pmk in octets
8238  * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
8239  *	used for this FILS connection (may be %NULL).
8240  */
8241 struct cfg80211_fils_resp_params {
8242 	const u8 *kek;
8243 	size_t kek_len;
8244 	bool update_erp_next_seq_num;
8245 	u16 erp_next_seq_num;
8246 	const u8 *pmk;
8247 	size_t pmk_len;
8248 	const u8 *pmkid;
8249 };
8250 
8251 /**
8252  * struct cfg80211_connect_resp_params - Connection response params
8253  * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
8254  *	%WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
8255  *	the real status code for failures. If this call is used to report a
8256  *	failure due to a timeout (e.g., not receiving an Authentication frame
8257  *	from the AP) instead of an explicit rejection by the AP, -1 is used to
8258  *	indicate that this is a failure, but without a status code.
8259  *	@timeout_reason is used to report the reason for the timeout in that
8260  *	case.
8261  * @req_ie: Association request IEs (may be %NULL)
8262  * @req_ie_len: Association request IEs length
8263  * @resp_ie: Association response IEs (may be %NULL)
8264  * @resp_ie_len: Association response IEs length
8265  * @fils: FILS connection response parameters.
8266  * @timeout_reason: Reason for connection timeout. This is used when the
8267  *	connection fails due to a timeout instead of an explicit rejection from
8268  *	the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
8269  *	not known. This value is used only if @status < 0 to indicate that the
8270  *	failure is due to a timeout and not due to explicit rejection by the AP.
8271  *	This value is ignored in other cases (@status >= 0).
8272  * @valid_links: For MLO connection, BIT mask of the valid link ids. Otherwise
8273  *	zero.
8274  * @ap_mld_addr: For MLO connection, MLD address of the AP. Otherwise %NULL.
8275  * @links : For MLO connection, contains link info for the valid links indicated
8276  *	using @valid_links. For non-MLO connection, links[0] contains the
8277  *	connected AP info.
8278  * @links.addr: For MLO connection, MAC address of the STA link. Otherwise
8279  *	%NULL.
8280  * @links.bssid: For MLO connection, MAC address of the AP link. For non-MLO
8281  *	connection, links[0].bssid points to the BSSID of the AP (may be %NULL).
8282  * @links.bss: For MLO connection, entry of bss to which STA link is connected.
8283  *	For non-MLO connection, links[0].bss points to entry of bss to which STA
8284  *	is connected. It can be obtained through cfg80211_get_bss() (may be
8285  *	%NULL). It is recommended to store the bss from the connect_request and
8286  *	hold a reference to it and return through this param to avoid a warning
8287  *	if the bss is expired during the connection, esp. for those drivers
8288  *	implementing connect op. Only one parameter among @bssid and @bss needs
8289  *	to be specified.
8290  * @links.status: per-link status code, to report a status code that's not
8291  *	%WLAN_STATUS_SUCCESS for a given link, it must also be in the
8292  *	@valid_links bitmap and may have a BSS pointer (which is then released)
8293  */
8294 struct cfg80211_connect_resp_params {
8295 	int status;
8296 	const u8 *req_ie;
8297 	size_t req_ie_len;
8298 	const u8 *resp_ie;
8299 	size_t resp_ie_len;
8300 	struct cfg80211_fils_resp_params fils;
8301 	enum nl80211_timeout_reason timeout_reason;
8302 
8303 	const u8 *ap_mld_addr;
8304 	u16 valid_links;
8305 	struct {
8306 		const u8 *addr;
8307 		const u8 *bssid;
8308 		struct cfg80211_bss *bss;
8309 		u16 status;
8310 	} links[IEEE80211_MLD_MAX_NUM_LINKS];
8311 };
8312 
8313 /**
8314  * cfg80211_connect_done - notify cfg80211 of connection result
8315  *
8316  * @dev: network device
8317  * @params: connection response parameters
8318  * @gfp: allocation flags
8319  *
8320  * It should be called by the underlying driver once execution of the connection
8321  * request from connect() has been completed. This is similar to
8322  * cfg80211_connect_bss(), but takes a structure pointer for connection response
8323  * parameters. Only one of the functions among cfg80211_connect_bss(),
8324  * cfg80211_connect_result(), cfg80211_connect_timeout(),
8325  * and cfg80211_connect_done() should be called.
8326  */
8327 void cfg80211_connect_done(struct net_device *dev,
8328 			   struct cfg80211_connect_resp_params *params,
8329 			   gfp_t gfp);
8330 
8331 /**
8332  * cfg80211_connect_bss - notify cfg80211 of connection result
8333  *
8334  * @dev: network device
8335  * @bssid: the BSSID of the AP
8336  * @bss: Entry of bss to which STA got connected to, can be obtained through
8337  *	cfg80211_get_bss() (may be %NULL). But it is recommended to store the
8338  *	bss from the connect_request and hold a reference to it and return
8339  *	through this param to avoid a warning if the bss is expired during the
8340  *	connection, esp. for those drivers implementing connect op.
8341  *	Only one parameter among @bssid and @bss needs to be specified.
8342  * @req_ie: association request IEs (maybe be %NULL)
8343  * @req_ie_len: association request IEs length
8344  * @resp_ie: association response IEs (may be %NULL)
8345  * @resp_ie_len: assoc response IEs length
8346  * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
8347  *	%WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
8348  *	the real status code for failures. If this call is used to report a
8349  *	failure due to a timeout (e.g., not receiving an Authentication frame
8350  *	from the AP) instead of an explicit rejection by the AP, -1 is used to
8351  *	indicate that this is a failure, but without a status code.
8352  *	@timeout_reason is used to report the reason for the timeout in that
8353  *	case.
8354  * @gfp: allocation flags
8355  * @timeout_reason: reason for connection timeout. This is used when the
8356  *	connection fails due to a timeout instead of an explicit rejection from
8357  *	the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
8358  *	not known. This value is used only if @status < 0 to indicate that the
8359  *	failure is due to a timeout and not due to explicit rejection by the AP.
8360  *	This value is ignored in other cases (@status >= 0).
8361  *
8362  * It should be called by the underlying driver once execution of the connection
8363  * request from connect() has been completed. This is similar to
8364  * cfg80211_connect_result(), but with the option of identifying the exact bss
8365  * entry for the connection. Only one of the functions among
8366  * cfg80211_connect_bss(), cfg80211_connect_result(),
8367  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
8368  */
8369 static inline void
8370 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
8371 		     struct cfg80211_bss *bss, const u8 *req_ie,
8372 		     size_t req_ie_len, const u8 *resp_ie,
8373 		     size_t resp_ie_len, int status, gfp_t gfp,
8374 		     enum nl80211_timeout_reason timeout_reason)
8375 {
8376 	struct cfg80211_connect_resp_params params;
8377 
8378 	memset(&params, 0, sizeof(params));
8379 	params.status = status;
8380 	params.links[0].bssid = bssid;
8381 	params.links[0].bss = bss;
8382 	params.req_ie = req_ie;
8383 	params.req_ie_len = req_ie_len;
8384 	params.resp_ie = resp_ie;
8385 	params.resp_ie_len = resp_ie_len;
8386 	params.timeout_reason = timeout_reason;
8387 
8388 	cfg80211_connect_done(dev, &params, gfp);
8389 }
8390 
8391 /**
8392  * cfg80211_connect_result - notify cfg80211 of connection result
8393  *
8394  * @dev: network device
8395  * @bssid: the BSSID of the AP
8396  * @req_ie: association request IEs (maybe be %NULL)
8397  * @req_ie_len: association request IEs length
8398  * @resp_ie: association response IEs (may be %NULL)
8399  * @resp_ie_len: assoc response IEs length
8400  * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
8401  *	%WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
8402  *	the real status code for failures.
8403  * @gfp: allocation flags
8404  *
8405  * It should be called by the underlying driver once execution of the connection
8406  * request from connect() has been completed. This is similar to
8407  * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
8408  * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
8409  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
8410  */
8411 static inline void
8412 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
8413 			const u8 *req_ie, size_t req_ie_len,
8414 			const u8 *resp_ie, size_t resp_ie_len,
8415 			u16 status, gfp_t gfp)
8416 {
8417 	cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
8418 			     resp_ie_len, status, gfp,
8419 			     NL80211_TIMEOUT_UNSPECIFIED);
8420 }
8421 
8422 /**
8423  * cfg80211_connect_timeout - notify cfg80211 of connection timeout
8424  *
8425  * @dev: network device
8426  * @bssid: the BSSID of the AP
8427  * @req_ie: association request IEs (maybe be %NULL)
8428  * @req_ie_len: association request IEs length
8429  * @gfp: allocation flags
8430  * @timeout_reason: reason for connection timeout.
8431  *
8432  * It should be called by the underlying driver whenever connect() has failed
8433  * in a sequence where no explicit authentication/association rejection was
8434  * received from the AP. This could happen, e.g., due to not being able to send
8435  * out the Authentication or Association Request frame or timing out while
8436  * waiting for the response. Only one of the functions among
8437  * cfg80211_connect_bss(), cfg80211_connect_result(),
8438  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
8439  */
8440 static inline void
8441 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
8442 			 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
8443 			 enum nl80211_timeout_reason timeout_reason)
8444 {
8445 	cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
8446 			     gfp, timeout_reason);
8447 }
8448 
8449 /**
8450  * struct cfg80211_roam_info - driver initiated roaming information
8451  *
8452  * @req_ie: association request IEs (maybe be %NULL)
8453  * @req_ie_len: association request IEs length
8454  * @resp_ie: association response IEs (may be %NULL)
8455  * @resp_ie_len: assoc response IEs length
8456  * @fils: FILS related roaming information.
8457  * @valid_links: For MLO roaming, BIT mask of the new valid links is set.
8458  *	Otherwise zero.
8459  * @ap_mld_addr: For MLO roaming, MLD address of the new AP. Otherwise %NULL.
8460  * @links : For MLO roaming, contains new link info for the valid links set in
8461  *	@valid_links. For non-MLO roaming, links[0] contains the new AP info.
8462  * @links.addr: For MLO roaming, MAC address of the STA link. Otherwise %NULL.
8463  * @links.bssid: For MLO roaming, MAC address of the new AP link. For non-MLO
8464  *	roaming, links[0].bssid points to the BSSID of the new AP. May be
8465  *	%NULL if %links.bss is set.
8466  * @links.channel: the channel of the new AP.
8467  * @links.bss: For MLO roaming, entry of new bss to which STA link got
8468  *	roamed. For non-MLO roaming, links[0].bss points to entry of bss to
8469  *	which STA got roamed (may be %NULL if %links.bssid is set)
8470  */
8471 struct cfg80211_roam_info {
8472 	const u8 *req_ie;
8473 	size_t req_ie_len;
8474 	const u8 *resp_ie;
8475 	size_t resp_ie_len;
8476 	struct cfg80211_fils_resp_params fils;
8477 
8478 	const u8 *ap_mld_addr;
8479 	u16 valid_links;
8480 	struct {
8481 		const u8 *addr;
8482 		const u8 *bssid;
8483 		struct ieee80211_channel *channel;
8484 		struct cfg80211_bss *bss;
8485 	} links[IEEE80211_MLD_MAX_NUM_LINKS];
8486 };
8487 
8488 /**
8489  * cfg80211_roamed - notify cfg80211 of roaming
8490  *
8491  * @dev: network device
8492  * @info: information about the new BSS. struct &cfg80211_roam_info.
8493  * @gfp: allocation flags
8494  *
8495  * This function may be called with the driver passing either the BSSID of the
8496  * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
8497  * It should be called by the underlying driver whenever it roamed from one AP
8498  * to another while connected. Drivers which have roaming implemented in
8499  * firmware should pass the bss entry to avoid a race in bss entry timeout where
8500  * the bss entry of the new AP is seen in the driver, but gets timed out by the
8501  * time it is accessed in __cfg80211_roamed() due to delay in scheduling
8502  * rdev->event_work. In case of any failures, the reference is released
8503  * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
8504  * released while disconnecting from the current bss.
8505  */
8506 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
8507 		     gfp_t gfp);
8508 
8509 /**
8510  * cfg80211_port_authorized - notify cfg80211 of successful security association
8511  *
8512  * @dev: network device
8513  * @peer_addr: BSSID of the AP/P2P GO in case of STA/GC or STA/GC MAC address
8514  *	in case of AP/P2P GO
8515  * @td_bitmap: transition disable policy
8516  * @td_bitmap_len: Length of transition disable policy
8517  * @gfp: allocation flags
8518  *
8519  * This function should be called by a driver that supports 4 way handshake
8520  * offload after a security association was successfully established (i.e.,
8521  * the 4 way handshake was completed successfully). The call to this function
8522  * should be preceded with a call to cfg80211_connect_result(),
8523  * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
8524  * indicate the 802.11 association.
8525  * This function can also be called by AP/P2P GO driver that supports
8526  * authentication offload. In this case the peer_mac passed is that of
8527  * associated STA/GC.
8528  */
8529 void cfg80211_port_authorized(struct net_device *dev, const u8 *peer_addr,
8530 			      const u8* td_bitmap, u8 td_bitmap_len, gfp_t gfp);
8531 
8532 /**
8533  * cfg80211_disconnected - notify cfg80211 that connection was dropped
8534  *
8535  * @dev: network device
8536  * @ie: information elements of the deauth/disassoc frame (may be %NULL)
8537  * @ie_len: length of IEs
8538  * @reason: reason code for the disconnection, set it to 0 if unknown
8539  * @locally_generated: disconnection was requested locally
8540  * @gfp: allocation flags
8541  *
8542  * After it calls this function, the driver should enter an idle state
8543  * and not try to connect to any AP any more.
8544  */
8545 void cfg80211_disconnected(struct net_device *dev, u16 reason,
8546 			   const u8 *ie, size_t ie_len,
8547 			   bool locally_generated, gfp_t gfp);
8548 
8549 /**
8550  * cfg80211_ready_on_channel - notification of remain_on_channel start
8551  * @wdev: wireless device
8552  * @cookie: the request cookie
8553  * @chan: The current channel (from remain_on_channel request)
8554  * @duration: Duration in milliseconds that the driver intents to remain on the
8555  *	channel
8556  * @gfp: allocation flags
8557  */
8558 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
8559 			       struct ieee80211_channel *chan,
8560 			       unsigned int duration, gfp_t gfp);
8561 
8562 /**
8563  * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
8564  * @wdev: wireless device
8565  * @cookie: the request cookie
8566  * @chan: The current channel (from remain_on_channel request)
8567  * @gfp: allocation flags
8568  */
8569 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
8570 					struct ieee80211_channel *chan,
8571 					gfp_t gfp);
8572 
8573 /**
8574  * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
8575  * @wdev: wireless device
8576  * @cookie: the requested cookie
8577  * @chan: The current channel (from tx_mgmt request)
8578  * @gfp: allocation flags
8579  */
8580 void cfg80211_tx_mgmt_expired(struct wireless_dev *wdev, u64 cookie,
8581 			      struct ieee80211_channel *chan, gfp_t gfp);
8582 
8583 /**
8584  * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
8585  *
8586  * @sinfo: the station information
8587  * @gfp: allocation flags
8588  *
8589  * Return: 0 on success. Non-zero on error.
8590  */
8591 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
8592 
8593 /**
8594  * cfg80211_link_sinfo_alloc_tid_stats - allocate per-tid statistics.
8595  *
8596  * @link_sinfo: the link station information
8597  * @gfp: allocation flags
8598  *
8599  * Return: 0 on success. Non-zero on error.
8600  */
8601 int cfg80211_link_sinfo_alloc_tid_stats(struct link_station_info *link_sinfo,
8602 					gfp_t gfp);
8603 
8604 /**
8605  * cfg80211_sinfo_release_content - release contents of station info
8606  * @sinfo: the station information
8607  *
8608  * Releases any potentially allocated sub-information of the station
8609  * information, but not the struct itself (since it's typically on
8610  * the stack.)
8611  */
8612 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
8613 {
8614 	kfree(sinfo->pertid);
8615 
8616 	for (int link_id = 0; link_id < ARRAY_SIZE(sinfo->links); link_id++) {
8617 		if (sinfo->links[link_id]) {
8618 			kfree(sinfo->links[link_id]->pertid);
8619 			kfree(sinfo->links[link_id]);
8620 		}
8621 	}
8622 }
8623 
8624 /**
8625  * cfg80211_new_sta - notify userspace about station
8626  *
8627  * @dev: the netdev
8628  * @mac_addr: the station's address
8629  * @sinfo: the station information
8630  * @gfp: allocation flags
8631  */
8632 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
8633 		      struct station_info *sinfo, gfp_t gfp);
8634 
8635 /**
8636  * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
8637  * @dev: the netdev
8638  * @mac_addr: the station's address. For MLD station, MLD address is used.
8639  * @sinfo: the station information/statistics
8640  * @gfp: allocation flags
8641  */
8642 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
8643 			    struct station_info *sinfo, gfp_t gfp);
8644 
8645 /**
8646  * cfg80211_del_sta - notify userspace about deletion of a station
8647  *
8648  * @dev: the netdev
8649  * @mac_addr: the station's address. For MLD station, MLD address is used.
8650  * @gfp: allocation flags
8651  */
8652 static inline void cfg80211_del_sta(struct net_device *dev,
8653 				    const u8 *mac_addr, gfp_t gfp)
8654 {
8655 	cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
8656 }
8657 
8658 /**
8659  * cfg80211_conn_failed - connection request failed notification
8660  *
8661  * @dev: the netdev
8662  * @mac_addr: the station's address
8663  * @reason: the reason for connection failure
8664  * @gfp: allocation flags
8665  *
8666  * Whenever a station tries to connect to an AP and if the station
8667  * could not connect to the AP as the AP has rejected the connection
8668  * for some reasons, this function is called.
8669  *
8670  * The reason for connection failure can be any of the value from
8671  * nl80211_connect_failed_reason enum
8672  */
8673 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
8674 			  enum nl80211_connect_failed_reason reason,
8675 			  gfp_t gfp);
8676 
8677 /**
8678  * struct cfg80211_rx_info - received management frame info
8679  *
8680  * @freq: Frequency on which the frame was received in kHz
8681  * @sig_dbm: signal strength in dBm, or 0 if unknown
8682  * @have_link_id: indicates the frame was received on a link of
8683  *	an MLD, i.e. the @link_id field is valid
8684  * @link_id: the ID of the link the frame was received	on
8685  * @buf: Management frame (header + body)
8686  * @len: length of the frame data
8687  * @flags: flags, as defined in &enum nl80211_rxmgmt_flags
8688  * @rx_tstamp: Hardware timestamp of frame RX in nanoseconds
8689  * @ack_tstamp: Hardware timestamp of ack TX in nanoseconds
8690  */
8691 struct cfg80211_rx_info {
8692 	int freq;
8693 	int sig_dbm;
8694 	bool have_link_id;
8695 	u8 link_id;
8696 	const u8 *buf;
8697 	size_t len;
8698 	u32 flags;
8699 	u64 rx_tstamp;
8700 	u64 ack_tstamp;
8701 };
8702 
8703 /**
8704  * cfg80211_rx_mgmt_ext - management frame notification with extended info
8705  * @wdev: wireless device receiving the frame
8706  * @info: RX info as defined in struct cfg80211_rx_info
8707  *
8708  * This function is called whenever an Action frame is received for a station
8709  * mode interface, but is not processed in kernel.
8710  *
8711  * Return: %true if a user space application has registered for this frame.
8712  * For action frames, that makes it responsible for rejecting unrecognized
8713  * action frames; %false otherwise, in which case for action frames the
8714  * driver is responsible for rejecting the frame.
8715  */
8716 bool cfg80211_rx_mgmt_ext(struct wireless_dev *wdev,
8717 			  struct cfg80211_rx_info *info);
8718 
8719 /**
8720  * cfg80211_rx_mgmt_khz - notification of received, unprocessed management frame
8721  * @wdev: wireless device receiving the frame
8722  * @freq: Frequency on which the frame was received in KHz
8723  * @sig_dbm: signal strength in dBm, or 0 if unknown
8724  * @buf: Management frame (header + body)
8725  * @len: length of the frame data
8726  * @flags: flags, as defined in enum nl80211_rxmgmt_flags
8727  *
8728  * This function is called whenever an Action frame is received for a station
8729  * mode interface, but is not processed in kernel.
8730  *
8731  * Return: %true if a user space application has registered for this frame.
8732  * For action frames, that makes it responsible for rejecting unrecognized
8733  * action frames; %false otherwise, in which case for action frames the
8734  * driver is responsible for rejecting the frame.
8735  */
8736 static inline bool cfg80211_rx_mgmt_khz(struct wireless_dev *wdev, int freq,
8737 					int sig_dbm, const u8 *buf, size_t len,
8738 					u32 flags)
8739 {
8740 	struct cfg80211_rx_info info = {
8741 		.freq = freq,
8742 		.sig_dbm = sig_dbm,
8743 		.buf = buf,
8744 		.len = len,
8745 		.flags = flags
8746 	};
8747 
8748 	return cfg80211_rx_mgmt_ext(wdev, &info);
8749 }
8750 
8751 /**
8752  * cfg80211_rx_mgmt - notification of received, unprocessed management frame
8753  * @wdev: wireless device receiving the frame
8754  * @freq: Frequency on which the frame was received in MHz
8755  * @sig_dbm: signal strength in dBm, or 0 if unknown
8756  * @buf: Management frame (header + body)
8757  * @len: length of the frame data
8758  * @flags: flags, as defined in enum nl80211_rxmgmt_flags
8759  *
8760  * This function is called whenever an Action frame is received for a station
8761  * mode interface, but is not processed in kernel.
8762  *
8763  * Return: %true if a user space application has registered for this frame.
8764  * For action frames, that makes it responsible for rejecting unrecognized
8765  * action frames; %false otherwise, in which case for action frames the
8766  * driver is responsible for rejecting the frame.
8767  */
8768 static inline bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq,
8769 				    int sig_dbm, const u8 *buf, size_t len,
8770 				    u32 flags)
8771 {
8772 	struct cfg80211_rx_info info = {
8773 		.freq = MHZ_TO_KHZ(freq),
8774 		.sig_dbm = sig_dbm,
8775 		.buf = buf,
8776 		.len = len,
8777 		.flags = flags
8778 	};
8779 
8780 	return cfg80211_rx_mgmt_ext(wdev, &info);
8781 }
8782 
8783 /**
8784  * struct cfg80211_tx_status - TX status for management frame information
8785  *
8786  * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
8787  * @tx_tstamp: hardware TX timestamp in nanoseconds
8788  * @ack_tstamp: hardware ack RX timestamp in nanoseconds
8789  * @buf: Management frame (header + body)
8790  * @len: length of the frame data
8791  * @ack: Whether frame was acknowledged
8792  */
8793 struct cfg80211_tx_status {
8794 	u64 cookie;
8795 	u64 tx_tstamp;
8796 	u64 ack_tstamp;
8797 	const u8 *buf;
8798 	size_t len;
8799 	bool ack;
8800 };
8801 
8802 /**
8803  * cfg80211_mgmt_tx_status_ext - TX status notification with extended info
8804  * @wdev: wireless device receiving the frame
8805  * @status: TX status data
8806  * @gfp: context flags
8807  *
8808  * This function is called whenever a management frame was requested to be
8809  * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
8810  * transmission attempt with extended info.
8811  */
8812 void cfg80211_mgmt_tx_status_ext(struct wireless_dev *wdev,
8813 				 struct cfg80211_tx_status *status, gfp_t gfp);
8814 
8815 /**
8816  * cfg80211_mgmt_tx_status - notification of TX status for management frame
8817  * @wdev: wireless device receiving the frame
8818  * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
8819  * @buf: Management frame (header + body)
8820  * @len: length of the frame data
8821  * @ack: Whether frame was acknowledged
8822  * @gfp: context flags
8823  *
8824  * This function is called whenever a management frame was requested to be
8825  * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
8826  * transmission attempt.
8827  */
8828 static inline void cfg80211_mgmt_tx_status(struct wireless_dev *wdev,
8829 					   u64 cookie, const u8 *buf,
8830 					   size_t len, bool ack, gfp_t gfp)
8831 {
8832 	struct cfg80211_tx_status status = {
8833 		.cookie = cookie,
8834 		.buf = buf,
8835 		.len = len,
8836 		.ack = ack
8837 	};
8838 
8839 	cfg80211_mgmt_tx_status_ext(wdev, &status, gfp);
8840 }
8841 
8842 /**
8843  * cfg80211_control_port_tx_status - notification of TX status for control
8844  *                                   port frames
8845  * @wdev: wireless device receiving the frame
8846  * @cookie: Cookie returned by cfg80211_ops::tx_control_port()
8847  * @buf: Data frame (header + body)
8848  * @len: length of the frame data
8849  * @ack: Whether frame was acknowledged
8850  * @gfp: context flags
8851  *
8852  * This function is called whenever a control port frame was requested to be
8853  * transmitted with cfg80211_ops::tx_control_port() to report the TX status of
8854  * the transmission attempt.
8855  */
8856 void cfg80211_control_port_tx_status(struct wireless_dev *wdev, u64 cookie,
8857 				     const u8 *buf, size_t len, bool ack,
8858 				     gfp_t gfp);
8859 
8860 /**
8861  * cfg80211_rx_control_port - notification about a received control port frame
8862  * @dev: The device the frame matched to
8863  * @skb: The skbuf with the control port frame.  It is assumed that the skbuf
8864  *	is 802.3 formatted (with 802.3 header).  The skb can be non-linear.
8865  *	This function does not take ownership of the skb, so the caller is
8866  *	responsible for any cleanup.  The caller must also ensure that
8867  *	skb->protocol is set appropriately.
8868  * @unencrypted: Whether the frame was received unencrypted
8869  * @link_id: the link the frame was received on, -1 if not applicable or unknown
8870  *
8871  * This function is used to inform userspace about a received control port
8872  * frame.  It should only be used if userspace indicated it wants to receive
8873  * control port frames over nl80211.
8874  *
8875  * The frame is the data portion of the 802.3 or 802.11 data frame with all
8876  * network layer headers removed (e.g. the raw EAPoL frame).
8877  *
8878  * Return: %true if the frame was passed to userspace
8879  */
8880 bool cfg80211_rx_control_port(struct net_device *dev, struct sk_buff *skb,
8881 			      bool unencrypted, int link_id);
8882 
8883 /**
8884  * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
8885  * @dev: network device
8886  * @rssi_event: the triggered RSSI event
8887  * @rssi_level: new RSSI level value or 0 if not available
8888  * @gfp: context flags
8889  *
8890  * This function is called when a configured connection quality monitoring
8891  * rssi threshold reached event occurs.
8892  */
8893 void cfg80211_cqm_rssi_notify(struct net_device *dev,
8894 			      enum nl80211_cqm_rssi_threshold_event rssi_event,
8895 			      s32 rssi_level, gfp_t gfp);
8896 
8897 /**
8898  * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
8899  * @dev: network device
8900  * @peer: peer's MAC address
8901  * @num_packets: how many packets were lost -- should be a fixed threshold
8902  *	but probably no less than maybe 50, or maybe a throughput dependent
8903  *	threshold (to account for temporary interference)
8904  * @gfp: context flags
8905  */
8906 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
8907 				 const u8 *peer, u32 num_packets, gfp_t gfp);
8908 
8909 /**
8910  * cfg80211_cqm_txe_notify - TX error rate event
8911  * @dev: network device
8912  * @peer: peer's MAC address
8913  * @num_packets: how many packets were lost
8914  * @rate: % of packets which failed transmission
8915  * @intvl: interval (in s) over which the TX failure threshold was breached.
8916  * @gfp: context flags
8917  *
8918  * Notify userspace when configured % TX failures over number of packets in a
8919  * given interval is exceeded.
8920  */
8921 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
8922 			     u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
8923 
8924 /**
8925  * cfg80211_cqm_beacon_loss_notify - beacon loss event
8926  * @dev: network device
8927  * @gfp: context flags
8928  *
8929  * Notify userspace about beacon loss from the connected AP.
8930  */
8931 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
8932 
8933 /**
8934  * __cfg80211_radar_event - radar detection event
8935  * @wiphy: the wiphy
8936  * @chandef: chandef for the current channel
8937  * @offchan: the radar has been detected on the offchannel chain
8938  * @gfp: context flags
8939  *
8940  * This function is called when a radar is detected on the current chanenl.
8941  */
8942 void __cfg80211_radar_event(struct wiphy *wiphy,
8943 			    struct cfg80211_chan_def *chandef,
8944 			    bool offchan, gfp_t gfp);
8945 
8946 static inline void
8947 cfg80211_radar_event(struct wiphy *wiphy,
8948 		     struct cfg80211_chan_def *chandef,
8949 		     gfp_t gfp)
8950 {
8951 	__cfg80211_radar_event(wiphy, chandef, false, gfp);
8952 }
8953 
8954 static inline void
8955 cfg80211_background_radar_event(struct wiphy *wiphy,
8956 				struct cfg80211_chan_def *chandef,
8957 				gfp_t gfp)
8958 {
8959 	__cfg80211_radar_event(wiphy, chandef, true, gfp);
8960 }
8961 
8962 /**
8963  * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
8964  * @dev: network device
8965  * @mac: MAC address of a station which opmode got modified
8966  * @sta_opmode: station's current opmode value
8967  * @gfp: context flags
8968  *
8969  * Driver should call this function when station's opmode modified via action
8970  * frame.
8971  */
8972 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
8973 				       struct sta_opmode_info *sta_opmode,
8974 				       gfp_t gfp);
8975 
8976 /**
8977  * cfg80211_cac_event - Channel availability check (CAC) event
8978  * @netdev: network device
8979  * @chandef: chandef for the current channel
8980  * @event: type of event
8981  * @gfp: context flags
8982  * @link_id: valid link_id for MLO operation or 0 otherwise.
8983  *
8984  * This function is called when a Channel availability check (CAC) is finished
8985  * or aborted. This must be called to notify the completion of a CAC process,
8986  * also by full-MAC drivers.
8987  */
8988 void cfg80211_cac_event(struct net_device *netdev,
8989 			const struct cfg80211_chan_def *chandef,
8990 			enum nl80211_radar_event event, gfp_t gfp,
8991 			unsigned int link_id);
8992 
8993 /**
8994  * cfg80211_background_cac_abort - Channel Availability Check offchan abort event
8995  * @wiphy: the wiphy
8996  *
8997  * This function is called by the driver when a Channel Availability Check
8998  * (CAC) is aborted by a offchannel dedicated chain.
8999  */
9000 void cfg80211_background_cac_abort(struct wiphy *wiphy);
9001 
9002 /**
9003  * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
9004  * @dev: network device
9005  * @bssid: BSSID of AP (to avoid races)
9006  * @replay_ctr: new replay counter
9007  * @gfp: allocation flags
9008  */
9009 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
9010 			       const u8 *replay_ctr, gfp_t gfp);
9011 
9012 /**
9013  * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
9014  * @dev: network device
9015  * @index: candidate index (the smaller the index, the higher the priority)
9016  * @bssid: BSSID of AP
9017  * @preauth: Whether AP advertises support for RSN pre-authentication
9018  * @gfp: allocation flags
9019  */
9020 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
9021 				     const u8 *bssid, bool preauth, gfp_t gfp);
9022 
9023 /**
9024  * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
9025  * @dev: The device the frame matched to
9026  * @addr: the transmitter address
9027  * @gfp: context flags
9028  *
9029  * This function is used in AP mode (only!) to inform userspace that
9030  * a spurious class 3 frame was received, to be able to deauth the
9031  * sender.
9032  * Return: %true if the frame was passed to userspace (or this failed
9033  * for a reason other than not having a subscription.)
9034  */
9035 bool cfg80211_rx_spurious_frame(struct net_device *dev,
9036 				const u8 *addr, gfp_t gfp);
9037 
9038 /**
9039  * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
9040  * @dev: The device the frame matched to
9041  * @addr: the transmitter address
9042  * @gfp: context flags
9043  *
9044  * This function is used in AP mode (only!) to inform userspace that
9045  * an associated station sent a 4addr frame but that wasn't expected.
9046  * It is allowed and desirable to send this event only once for each
9047  * station to avoid event flooding.
9048  * Return: %true if the frame was passed to userspace (or this failed
9049  * for a reason other than not having a subscription.)
9050  */
9051 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
9052 					const u8 *addr, gfp_t gfp);
9053 
9054 /**
9055  * cfg80211_probe_status - notify userspace about probe status
9056  * @dev: the device the probe was sent on
9057  * @addr: the address of the peer
9058  * @cookie: the cookie filled in @probe_client previously
9059  * @acked: indicates whether probe was acked or not
9060  * @ack_signal: signal strength (in dBm) of the ACK frame.
9061  * @is_valid_ack_signal: indicates the ack_signal is valid or not.
9062  * @gfp: allocation flags
9063  */
9064 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
9065 			   u64 cookie, bool acked, s32 ack_signal,
9066 			   bool is_valid_ack_signal, gfp_t gfp);
9067 
9068 /**
9069  * cfg80211_report_obss_beacon_khz - report beacon from other APs
9070  * @wiphy: The wiphy that received the beacon
9071  * @frame: the frame
9072  * @len: length of the frame
9073  * @freq: frequency the frame was received on in KHz
9074  * @sig_dbm: signal strength in dBm, or 0 if unknown
9075  *
9076  * Use this function to report to userspace when a beacon was
9077  * received. It is not useful to call this when there is no
9078  * netdev that is in AP/GO mode.
9079  */
9080 void cfg80211_report_obss_beacon_khz(struct wiphy *wiphy, const u8 *frame,
9081 				     size_t len, int freq, int sig_dbm);
9082 
9083 /**
9084  * cfg80211_report_obss_beacon - report beacon from other APs
9085  * @wiphy: The wiphy that received the beacon
9086  * @frame: the frame
9087  * @len: length of the frame
9088  * @freq: frequency the frame was received on
9089  * @sig_dbm: signal strength in dBm, or 0 if unknown
9090  *
9091  * Use this function to report to userspace when a beacon was
9092  * received. It is not useful to call this when there is no
9093  * netdev that is in AP/GO mode.
9094  */
9095 static inline void cfg80211_report_obss_beacon(struct wiphy *wiphy,
9096 					       const u8 *frame, size_t len,
9097 					       int freq, int sig_dbm)
9098 {
9099 	cfg80211_report_obss_beacon_khz(wiphy, frame, len, MHZ_TO_KHZ(freq),
9100 					sig_dbm);
9101 }
9102 
9103 /**
9104  * struct cfg80211_beaconing_check_config - beacon check configuration
9105  * @iftype: the interface type to check for
9106  * @relax: allow IR-relaxation conditions to apply (e.g. another
9107  *	interface connected already on the same channel)
9108  *	NOTE: If this is set, wiphy mutex must be held.
9109  * @reg_power: &enum ieee80211_ap_reg_power value indicating the
9110  *	advertised/used 6 GHz regulatory power setting
9111  */
9112 struct cfg80211_beaconing_check_config {
9113 	enum nl80211_iftype iftype;
9114 	enum ieee80211_ap_reg_power reg_power;
9115 	bool relax;
9116 };
9117 
9118 /**
9119  * cfg80211_reg_check_beaconing - check if beaconing is allowed
9120  * @wiphy: the wiphy
9121  * @chandef: the channel definition
9122  * @cfg: additional parameters for the checking
9123  *
9124  * Return: %true if there is no secondary channel or the secondary channel(s)
9125  * can be used for beaconing (i.e. is not a radar channel etc.)
9126  */
9127 bool cfg80211_reg_check_beaconing(struct wiphy *wiphy,
9128 				  struct cfg80211_chan_def *chandef,
9129 				  struct cfg80211_beaconing_check_config *cfg);
9130 
9131 /**
9132  * cfg80211_reg_can_beacon - check if beaconing is allowed
9133  * @wiphy: the wiphy
9134  * @chandef: the channel definition
9135  * @iftype: interface type
9136  *
9137  * Return: %true if there is no secondary channel or the secondary channel(s)
9138  * can be used for beaconing (i.e. is not a radar channel etc.)
9139  */
9140 static inline bool
9141 cfg80211_reg_can_beacon(struct wiphy *wiphy,
9142 			struct cfg80211_chan_def *chandef,
9143 			enum nl80211_iftype iftype)
9144 {
9145 	struct cfg80211_beaconing_check_config config = {
9146 		.iftype = iftype,
9147 	};
9148 
9149 	return cfg80211_reg_check_beaconing(wiphy, chandef, &config);
9150 }
9151 
9152 /**
9153  * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
9154  * @wiphy: the wiphy
9155  * @chandef: the channel definition
9156  * @iftype: interface type
9157  *
9158  * Return: %true if there is no secondary channel or the secondary channel(s)
9159  * can be used for beaconing (i.e. is not a radar channel etc.). This version
9160  * also checks if IR-relaxation conditions apply, to allow beaconing under
9161  * more permissive conditions.
9162  *
9163  * Context: Requires the wiphy mutex to be held.
9164  */
9165 static inline bool
9166 cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
9167 			      struct cfg80211_chan_def *chandef,
9168 			      enum nl80211_iftype iftype)
9169 {
9170 	struct cfg80211_beaconing_check_config config = {
9171 		.iftype = iftype,
9172 		.relax = true,
9173 	};
9174 
9175 	return cfg80211_reg_check_beaconing(wiphy, chandef, &config);
9176 }
9177 
9178 /**
9179  * cfg80211_ch_switch_notify - update wdev channel and notify userspace
9180  * @dev: the device which switched channels
9181  * @chandef: the new channel definition
9182  * @link_id: the link ID for MLO, must be 0 for non-MLO
9183  *
9184  * Caller must hold wiphy mutex, therefore must only be called from sleepable
9185  * driver context!
9186  */
9187 void cfg80211_ch_switch_notify(struct net_device *dev,
9188 			       struct cfg80211_chan_def *chandef,
9189 			       unsigned int link_id);
9190 
9191 /**
9192  * cfg80211_ch_switch_started_notify - notify channel switch start
9193  * @dev: the device on which the channel switch started
9194  * @chandef: the future channel definition
9195  * @link_id: the link ID for MLO, must be 0 for non-MLO
9196  * @count: the number of TBTTs until the channel switch happens
9197  * @quiet: whether or not immediate quiet was requested by the AP
9198  *
9199  * Inform the userspace about the channel switch that has just
9200  * started, so that it can take appropriate actions (eg. starting
9201  * channel switch on other vifs), if necessary.
9202  */
9203 void cfg80211_ch_switch_started_notify(struct net_device *dev,
9204 				       struct cfg80211_chan_def *chandef,
9205 				       unsigned int link_id, u8 count,
9206 				       bool quiet);
9207 
9208 /**
9209  * ieee80211_operating_class_to_band - convert operating class to band
9210  *
9211  * @operating_class: the operating class to convert
9212  * @band: band pointer to fill
9213  *
9214  * Return: %true if the conversion was successful, %false otherwise.
9215  */
9216 bool ieee80211_operating_class_to_band(u8 operating_class,
9217 				       enum nl80211_band *band);
9218 
9219 /**
9220  * ieee80211_operating_class_to_chandef - convert operating class to chandef
9221  *
9222  * @operating_class: the operating class to convert
9223  * @chan: the ieee80211_channel to convert
9224  * @chandef: a pointer to the resulting chandef
9225  *
9226  * Return: %true if the conversion was successful, %false otherwise.
9227  */
9228 bool ieee80211_operating_class_to_chandef(u8 operating_class,
9229 					  struct ieee80211_channel *chan,
9230 					  struct cfg80211_chan_def *chandef);
9231 
9232 /**
9233  * ieee80211_chandef_to_operating_class - convert chandef to operation class
9234  *
9235  * @chandef: the chandef to convert
9236  * @op_class: a pointer to the resulting operating class
9237  *
9238  * Return: %true if the conversion was successful, %false otherwise.
9239  */
9240 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
9241 					  u8 *op_class);
9242 
9243 /**
9244  * ieee80211_chandef_to_khz - convert chandef to frequency in KHz
9245  *
9246  * @chandef: the chandef to convert
9247  *
9248  * Return: the center frequency of chandef (1st segment) in KHz.
9249  */
9250 static inline u32
9251 ieee80211_chandef_to_khz(const struct cfg80211_chan_def *chandef)
9252 {
9253 	return MHZ_TO_KHZ(chandef->center_freq1) + chandef->freq1_offset;
9254 }
9255 
9256 /**
9257  * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
9258  * @dev: the device on which the operation is requested
9259  * @peer: the MAC address of the peer device
9260  * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
9261  *	NL80211_TDLS_TEARDOWN)
9262  * @reason_code: the reason code for teardown request
9263  * @gfp: allocation flags
9264  *
9265  * This function is used to request userspace to perform TDLS operation that
9266  * requires knowledge of keys, i.e., link setup or teardown when the AP
9267  * connection uses encryption. This is optional mechanism for the driver to use
9268  * if it can automatically determine when a TDLS link could be useful (e.g.,
9269  * based on traffic and signal strength for a peer).
9270  */
9271 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
9272 				enum nl80211_tdls_operation oper,
9273 				u16 reason_code, gfp_t gfp);
9274 
9275 /**
9276  * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
9277  * @rate: given rate_info to calculate bitrate from
9278  *
9279  * Return: calculated bitrate
9280  */
9281 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
9282 
9283 /**
9284  * cfg80211_unregister_wdev - remove the given wdev
9285  * @wdev: struct wireless_dev to remove
9286  *
9287  * This function removes the device so it can no longer be used. It is necessary
9288  * to call this function even when cfg80211 requests the removal of the device
9289  * by calling the del_virtual_intf() callback. The function must also be called
9290  * when the driver wishes to unregister the wdev, e.g. when the hardware device
9291  * is unbound from the driver.
9292  *
9293  * Context: Requires the RTNL and wiphy mutex to be held.
9294  */
9295 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
9296 
9297 /**
9298  * cfg80211_register_netdevice - register the given netdev
9299  * @dev: the netdev to register
9300  *
9301  * Note: In contexts coming from cfg80211 callbacks, you must call this rather
9302  * than register_netdevice(), unregister_netdev() is impossible as the RTNL is
9303  * held. Otherwise, both register_netdevice() and register_netdev() are usable
9304  * instead as well.
9305  *
9306  * Context: Requires the RTNL and wiphy mutex to be held.
9307  *
9308  * Return: 0 on success. Non-zero on error.
9309  */
9310 int cfg80211_register_netdevice(struct net_device *dev);
9311 
9312 /**
9313  * cfg80211_unregister_netdevice - unregister the given netdev
9314  * @dev: the netdev to register
9315  *
9316  * Note: In contexts coming from cfg80211 callbacks, you must call this rather
9317  * than unregister_netdevice(), unregister_netdev() is impossible as the RTNL
9318  * is held. Otherwise, both unregister_netdevice() and unregister_netdev() are
9319  * usable instead as well.
9320  *
9321  * Context: Requires the RTNL and wiphy mutex to be held.
9322  */
9323 static inline void cfg80211_unregister_netdevice(struct net_device *dev)
9324 {
9325 #if IS_ENABLED(CONFIG_CFG80211)
9326 	cfg80211_unregister_wdev(dev->ieee80211_ptr);
9327 #endif
9328 }
9329 
9330 /**
9331  * struct cfg80211_ft_event_params - FT Information Elements
9332  * @ies: FT IEs
9333  * @ies_len: length of the FT IE in bytes
9334  * @target_ap: target AP's MAC address
9335  * @ric_ies: RIC IE
9336  * @ric_ies_len: length of the RIC IE in bytes
9337  */
9338 struct cfg80211_ft_event_params {
9339 	const u8 *ies;
9340 	size_t ies_len;
9341 	const u8 *target_ap;
9342 	const u8 *ric_ies;
9343 	size_t ric_ies_len;
9344 };
9345 
9346 /**
9347  * cfg80211_ft_event - notify userspace about FT IE and RIC IE
9348  * @netdev: network device
9349  * @ft_event: IE information
9350  */
9351 void cfg80211_ft_event(struct net_device *netdev,
9352 		       struct cfg80211_ft_event_params *ft_event);
9353 
9354 /**
9355  * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
9356  * @ies: the input IE buffer
9357  * @len: the input length
9358  * @attr: the attribute ID to find
9359  * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
9360  *	if the function is only called to get the needed buffer size
9361  * @bufsize: size of the output buffer
9362  *
9363  * The function finds a given P2P attribute in the (vendor) IEs and
9364  * copies its contents to the given buffer.
9365  *
9366  * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
9367  * malformed or the attribute can't be found (respectively), or the
9368  * length of the found attribute (which can be zero).
9369  */
9370 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
9371 			  enum ieee80211_p2p_attr_id attr,
9372 			  u8 *buf, unsigned int bufsize);
9373 
9374 /**
9375  * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
9376  * @ies: the IE buffer
9377  * @ielen: the length of the IE buffer
9378  * @ids: an array with element IDs that are allowed before
9379  *	the split. A WLAN_EID_EXTENSION value means that the next
9380  *	EID in the list is a sub-element of the EXTENSION IE.
9381  * @n_ids: the size of the element ID array
9382  * @after_ric: array IE types that come after the RIC element
9383  * @n_after_ric: size of the @after_ric array
9384  * @offset: offset where to start splitting in the buffer
9385  *
9386  * This function splits an IE buffer by updating the @offset
9387  * variable to point to the location where the buffer should be
9388  * split.
9389  *
9390  * It assumes that the given IE buffer is well-formed, this
9391  * has to be guaranteed by the caller!
9392  *
9393  * It also assumes that the IEs in the buffer are ordered
9394  * correctly, if not the result of using this function will not
9395  * be ordered correctly either, i.e. it does no reordering.
9396  *
9397  * Return: The offset where the next part of the buffer starts, which
9398  * may be @ielen if the entire (remainder) of the buffer should be
9399  * used.
9400  */
9401 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
9402 			      const u8 *ids, int n_ids,
9403 			      const u8 *after_ric, int n_after_ric,
9404 			      size_t offset);
9405 
9406 /**
9407  * ieee80211_ie_split - split an IE buffer according to ordering
9408  * @ies: the IE buffer
9409  * @ielen: the length of the IE buffer
9410  * @ids: an array with element IDs that are allowed before
9411  *	the split. A WLAN_EID_EXTENSION value means that the next
9412  *	EID in the list is a sub-element of the EXTENSION IE.
9413  * @n_ids: the size of the element ID array
9414  * @offset: offset where to start splitting in the buffer
9415  *
9416  * This function splits an IE buffer by updating the @offset
9417  * variable to point to the location where the buffer should be
9418  * split.
9419  *
9420  * It assumes that the given IE buffer is well-formed, this
9421  * has to be guaranteed by the caller!
9422  *
9423  * It also assumes that the IEs in the buffer are ordered
9424  * correctly, if not the result of using this function will not
9425  * be ordered correctly either, i.e. it does no reordering.
9426  *
9427  * Return: The offset where the next part of the buffer starts, which
9428  * may be @ielen if the entire (remainder) of the buffer should be
9429  * used.
9430  */
9431 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
9432 					const u8 *ids, int n_ids, size_t offset)
9433 {
9434 	return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
9435 }
9436 
9437 /**
9438  * ieee80211_fragment_element - fragment the last element in skb
9439  * @skb: The skbuf that the element was added to
9440  * @len_pos: Pointer to length of the element to fragment
9441  * @frag_id: The element ID to use for fragments
9442  *
9443  * This function fragments all data after @len_pos, adding fragmentation
9444  * elements with the given ID as appropriate. The SKB will grow in size
9445  * accordingly.
9446  */
9447 void ieee80211_fragment_element(struct sk_buff *skb, u8 *len_pos, u8 frag_id);
9448 
9449 /**
9450  * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
9451  * @wdev: the wireless device reporting the wakeup
9452  * @wakeup: the wakeup report
9453  * @gfp: allocation flags
9454  *
9455  * This function reports that the given device woke up. If it
9456  * caused the wakeup, report the reason(s), otherwise you may
9457  * pass %NULL as the @wakeup parameter to advertise that something
9458  * else caused the wakeup.
9459  */
9460 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
9461 				   struct cfg80211_wowlan_wakeup *wakeup,
9462 				   gfp_t gfp);
9463 
9464 /**
9465  * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
9466  *
9467  * @wdev: the wireless device for which critical protocol is stopped.
9468  * @gfp: allocation flags
9469  *
9470  * This function can be called by the driver to indicate it has reverted
9471  * operation back to normal. One reason could be that the duration given
9472  * by .crit_proto_start() has expired.
9473  */
9474 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
9475 
9476 /**
9477  * ieee80211_get_num_supported_channels - get number of channels device has
9478  * @wiphy: the wiphy
9479  *
9480  * Return: the number of channels supported by the device.
9481  */
9482 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
9483 
9484 /**
9485  * cfg80211_check_combinations - check interface combinations
9486  *
9487  * @wiphy: the wiphy
9488  * @params: the interface combinations parameter
9489  *
9490  * This function can be called by the driver to check whether a
9491  * combination of interfaces and their types are allowed according to
9492  * the interface combinations.
9493  *
9494  * Return: 0 if combinations are allowed. Non-zero on error.
9495  */
9496 int cfg80211_check_combinations(struct wiphy *wiphy,
9497 				struct iface_combination_params *params);
9498 
9499 /**
9500  * cfg80211_iter_combinations - iterate over matching combinations
9501  *
9502  * @wiphy: the wiphy
9503  * @params: the interface combinations parameter
9504  * @iter: function to call for each matching combination
9505  * @data: pointer to pass to iter function
9506  *
9507  * This function can be called by the driver to check what possible
9508  * combinations it fits in at a given moment, e.g. for channel switching
9509  * purposes.
9510  *
9511  * Return: 0 on success. Non-zero on error.
9512  */
9513 int cfg80211_iter_combinations(struct wiphy *wiphy,
9514 			       struct iface_combination_params *params,
9515 			       void (*iter)(const struct ieee80211_iface_combination *c,
9516 					    void *data),
9517 			       void *data);
9518 /**
9519  * cfg80211_get_radio_idx_by_chan - get the radio index by the channel
9520  *
9521  * @wiphy: the wiphy
9522  * @chan: channel for which the supported radio index is required
9523  *
9524  * Return: radio index on success or a negative error code
9525  */
9526 int cfg80211_get_radio_idx_by_chan(struct wiphy *wiphy,
9527 				   const struct ieee80211_channel *chan);
9528 
9529 
9530 /**
9531  * cfg80211_stop_iface - trigger interface disconnection
9532  *
9533  * @wiphy: the wiphy
9534  * @wdev: wireless device
9535  * @gfp: context flags
9536  *
9537  * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
9538  * disconnected.
9539  *
9540  * Note: This doesn't need any locks and is asynchronous.
9541  */
9542 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
9543 			 gfp_t gfp);
9544 
9545 /**
9546  * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
9547  * @wiphy: the wiphy to shut down
9548  *
9549  * This function shuts down all interfaces belonging to this wiphy by
9550  * calling dev_close() (and treating non-netdev interfaces as needed).
9551  * It shouldn't really be used unless there are some fatal device errors
9552  * that really can't be recovered in any other way.
9553  *
9554  * Callers must hold the RTNL and be able to deal with callbacks into
9555  * the driver while the function is running.
9556  */
9557 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
9558 
9559 /**
9560  * wiphy_ext_feature_set - set the extended feature flag
9561  *
9562  * @wiphy: the wiphy to modify.
9563  * @ftidx: extended feature bit index.
9564  *
9565  * The extended features are flagged in multiple bytes (see
9566  * &struct wiphy.@ext_features)
9567  */
9568 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
9569 					 enum nl80211_ext_feature_index ftidx)
9570 {
9571 	u8 *ft_byte;
9572 
9573 	ft_byte = &wiphy->ext_features[ftidx / 8];
9574 	*ft_byte |= BIT(ftidx % 8);
9575 }
9576 
9577 /**
9578  * wiphy_ext_feature_isset - check the extended feature flag
9579  *
9580  * @wiphy: the wiphy to modify.
9581  * @ftidx: extended feature bit index.
9582  *
9583  * The extended features are flagged in multiple bytes (see
9584  * &struct wiphy.@ext_features)
9585  *
9586  * Return: %true if extended feature flag is set, %false otherwise
9587  */
9588 static inline bool
9589 wiphy_ext_feature_isset(struct wiphy *wiphy,
9590 			enum nl80211_ext_feature_index ftidx)
9591 {
9592 	u8 ft_byte;
9593 
9594 	ft_byte = wiphy->ext_features[ftidx / 8];
9595 	return (ft_byte & BIT(ftidx % 8)) != 0;
9596 }
9597 
9598 /**
9599  * cfg80211_free_nan_func - free NAN function
9600  * @f: NAN function that should be freed
9601  *
9602  * Frees all the NAN function and all it's allocated members.
9603  */
9604 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
9605 
9606 /**
9607  * struct cfg80211_nan_match_params - NAN match parameters
9608  * @type: the type of the function that triggered a match. If it is
9609  *	 %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
9610  *	 If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
9611  *	 result.
9612  *	 If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
9613  * @inst_id: the local instance id
9614  * @peer_inst_id: the instance id of the peer's function
9615  * @addr: the MAC address of the peer
9616  * @info_len: the length of the &info
9617  * @info: the Service Specific Info from the peer (if any)
9618  * @cookie: unique identifier of the corresponding function
9619  */
9620 struct cfg80211_nan_match_params {
9621 	enum nl80211_nan_function_type type;
9622 	u8 inst_id;
9623 	u8 peer_inst_id;
9624 	const u8 *addr;
9625 	u8 info_len;
9626 	const u8 *info;
9627 	u64 cookie;
9628 };
9629 
9630 /**
9631  * cfg80211_nan_match - report a match for a NAN function.
9632  * @wdev: the wireless device reporting the match
9633  * @match: match notification parameters
9634  * @gfp: allocation flags
9635  *
9636  * This function reports that the a NAN function had a match. This
9637  * can be a subscribe that had a match or a solicited publish that
9638  * was sent. It can also be a follow up that was received.
9639  */
9640 void cfg80211_nan_match(struct wireless_dev *wdev,
9641 			struct cfg80211_nan_match_params *match, gfp_t gfp);
9642 
9643 /**
9644  * cfg80211_nan_func_terminated - notify about NAN function termination.
9645  *
9646  * @wdev: the wireless device reporting the match
9647  * @inst_id: the local instance id
9648  * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
9649  * @cookie: unique NAN function identifier
9650  * @gfp: allocation flags
9651  *
9652  * This function reports that the a NAN function is terminated.
9653  */
9654 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
9655 				  u8 inst_id,
9656 				  enum nl80211_nan_func_term_reason reason,
9657 				  u64 cookie, gfp_t gfp);
9658 
9659 /* ethtool helper */
9660 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
9661 
9662 /**
9663  * cfg80211_external_auth_request - userspace request for authentication
9664  * @netdev: network device
9665  * @params: External authentication parameters
9666  * @gfp: allocation flags
9667  * Returns: 0 on success, < 0 on error
9668  */
9669 int cfg80211_external_auth_request(struct net_device *netdev,
9670 				   struct cfg80211_external_auth_params *params,
9671 				   gfp_t gfp);
9672 
9673 /**
9674  * cfg80211_pmsr_report - report peer measurement result data
9675  * @wdev: the wireless device reporting the measurement
9676  * @req: the original measurement request
9677  * @result: the result data
9678  * @gfp: allocation flags
9679  */
9680 void cfg80211_pmsr_report(struct wireless_dev *wdev,
9681 			  struct cfg80211_pmsr_request *req,
9682 			  struct cfg80211_pmsr_result *result,
9683 			  gfp_t gfp);
9684 
9685 /**
9686  * cfg80211_pmsr_complete - report peer measurement completed
9687  * @wdev: the wireless device reporting the measurement
9688  * @req: the original measurement request
9689  * @gfp: allocation flags
9690  *
9691  * Report that the entire measurement completed, after this
9692  * the request pointer will no longer be valid.
9693  */
9694 void cfg80211_pmsr_complete(struct wireless_dev *wdev,
9695 			    struct cfg80211_pmsr_request *req,
9696 			    gfp_t gfp);
9697 
9698 /**
9699  * cfg80211_iftype_allowed - check whether the interface can be allowed
9700  * @wiphy: the wiphy
9701  * @iftype: interface type
9702  * @is_4addr: use_4addr flag, must be '0' when check_swif is '1'
9703  * @check_swif: check iftype against software interfaces
9704  *
9705  * Check whether the interface is allowed to operate; additionally, this API
9706  * can be used to check iftype against the software interfaces when
9707  * check_swif is '1'.
9708  *
9709  * Return: %true if allowed, %false otherwise
9710  */
9711 bool cfg80211_iftype_allowed(struct wiphy *wiphy, enum nl80211_iftype iftype,
9712 			     bool is_4addr, u8 check_swif);
9713 
9714 
9715 /**
9716  * cfg80211_assoc_comeback - notification of association that was
9717  * temporarily rejected with a comeback
9718  * @netdev: network device
9719  * @ap_addr: AP (MLD) address that rejected the association
9720  * @timeout: timeout interval value TUs.
9721  *
9722  * this function may sleep. the caller must hold the corresponding wdev's mutex.
9723  */
9724 void cfg80211_assoc_comeback(struct net_device *netdev,
9725 			     const u8 *ap_addr, u32 timeout);
9726 
9727 /* Logging, debugging and troubleshooting/diagnostic helpers. */
9728 
9729 /* wiphy_printk helpers, similar to dev_printk */
9730 
9731 #define wiphy_printk(level, wiphy, format, args...)		\
9732 	dev_printk(level, &(wiphy)->dev, format, ##args)
9733 #define wiphy_emerg(wiphy, format, args...)			\
9734 	dev_emerg(&(wiphy)->dev, format, ##args)
9735 #define wiphy_alert(wiphy, format, args...)			\
9736 	dev_alert(&(wiphy)->dev, format, ##args)
9737 #define wiphy_crit(wiphy, format, args...)			\
9738 	dev_crit(&(wiphy)->dev, format, ##args)
9739 #define wiphy_err(wiphy, format, args...)			\
9740 	dev_err(&(wiphy)->dev, format, ##args)
9741 #define wiphy_warn(wiphy, format, args...)			\
9742 	dev_warn(&(wiphy)->dev, format, ##args)
9743 #define wiphy_notice(wiphy, format, args...)			\
9744 	dev_notice(&(wiphy)->dev, format, ##args)
9745 #define wiphy_info(wiphy, format, args...)			\
9746 	dev_info(&(wiphy)->dev, format, ##args)
9747 #define wiphy_info_once(wiphy, format, args...)			\
9748 	dev_info_once(&(wiphy)->dev, format, ##args)
9749 
9750 #define wiphy_err_ratelimited(wiphy, format, args...)		\
9751 	dev_err_ratelimited(&(wiphy)->dev, format, ##args)
9752 #define wiphy_warn_ratelimited(wiphy, format, args...)		\
9753 	dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
9754 
9755 #define wiphy_debug(wiphy, format, args...)			\
9756 	wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
9757 
9758 #define wiphy_dbg(wiphy, format, args...)			\
9759 	dev_dbg(&(wiphy)->dev, format, ##args)
9760 
9761 #if defined(VERBOSE_DEBUG)
9762 #define wiphy_vdbg	wiphy_dbg
9763 #else
9764 #define wiphy_vdbg(wiphy, format, args...)				\
9765 ({									\
9766 	if (0)								\
9767 		wiphy_printk(KERN_DEBUG, wiphy, format, ##args);	\
9768 	0;								\
9769 })
9770 #endif
9771 
9772 /*
9773  * wiphy_WARN() acts like wiphy_printk(), but with the key difference
9774  * of using a WARN/WARN_ON to get the message out, including the
9775  * file/line information and a backtrace.
9776  */
9777 #define wiphy_WARN(wiphy, format, args...)			\
9778 	WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
9779 
9780 /**
9781  * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
9782  * @netdev: network device
9783  * @owe_info: peer's owe info
9784  * @gfp: allocation flags
9785  */
9786 void cfg80211_update_owe_info_event(struct net_device *netdev,
9787 				    struct cfg80211_update_owe_info *owe_info,
9788 				    gfp_t gfp);
9789 
9790 /**
9791  * cfg80211_bss_flush - resets all the scan entries
9792  * @wiphy: the wiphy
9793  */
9794 void cfg80211_bss_flush(struct wiphy *wiphy);
9795 
9796 /**
9797  * cfg80211_bss_color_notify - notify about bss color event
9798  * @dev: network device
9799  * @cmd: the actual event we want to notify
9800  * @count: the number of TBTTs until the color change happens
9801  * @color_bitmap: representations of the colors that the local BSS is aware of
9802  * @link_id: valid link_id in case of MLO or 0 for non-MLO.
9803  *
9804  * Return: 0 on success. Non-zero on error.
9805  */
9806 int cfg80211_bss_color_notify(struct net_device *dev,
9807 			      enum nl80211_commands cmd, u8 count,
9808 			      u64 color_bitmap, u8 link_id);
9809 
9810 /**
9811  * cfg80211_obss_color_collision_notify - notify about bss color collision
9812  * @dev: network device
9813  * @color_bitmap: representations of the colors that the local BSS is aware of
9814  * @link_id: valid link_id in case of MLO or 0 for non-MLO.
9815  *
9816  * Return: 0 on success. Non-zero on error.
9817  */
9818 static inline int cfg80211_obss_color_collision_notify(struct net_device *dev,
9819 						       u64 color_bitmap,
9820 						       u8 link_id)
9821 {
9822 	return cfg80211_bss_color_notify(dev, NL80211_CMD_OBSS_COLOR_COLLISION,
9823 					 0, color_bitmap, link_id);
9824 }
9825 
9826 /**
9827  * cfg80211_color_change_started_notify - notify color change start
9828  * @dev: the device on which the color is switched
9829  * @count: the number of TBTTs until the color change happens
9830  * @link_id: valid link_id in case of MLO or 0 for non-MLO.
9831  *
9832  * Inform the userspace about the color change that has started.
9833  *
9834  * Return: 0 on success. Non-zero on error.
9835  */
9836 static inline int cfg80211_color_change_started_notify(struct net_device *dev,
9837 						       u8 count, u8 link_id)
9838 {
9839 	return cfg80211_bss_color_notify(dev, NL80211_CMD_COLOR_CHANGE_STARTED,
9840 					 count, 0, link_id);
9841 }
9842 
9843 /**
9844  * cfg80211_color_change_aborted_notify - notify color change abort
9845  * @dev: the device on which the color is switched
9846  * @link_id: valid link_id in case of MLO or 0 for non-MLO.
9847  *
9848  * Inform the userspace about the color change that has aborted.
9849  *
9850  * Return: 0 on success. Non-zero on error.
9851  */
9852 static inline int cfg80211_color_change_aborted_notify(struct net_device *dev,
9853 						       u8 link_id)
9854 {
9855 	return cfg80211_bss_color_notify(dev, NL80211_CMD_COLOR_CHANGE_ABORTED,
9856 					 0, 0, link_id);
9857 }
9858 
9859 /**
9860  * cfg80211_color_change_notify - notify color change completion
9861  * @dev: the device on which the color was switched
9862  * @link_id: valid link_id in case of MLO or 0 for non-MLO.
9863  *
9864  * Inform the userspace about the color change that has completed.
9865  *
9866  * Return: 0 on success. Non-zero on error.
9867  */
9868 static inline int cfg80211_color_change_notify(struct net_device *dev,
9869 					       u8 link_id)
9870 {
9871 	return cfg80211_bss_color_notify(dev,
9872 					 NL80211_CMD_COLOR_CHANGE_COMPLETED,
9873 					 0, 0, link_id);
9874 }
9875 
9876 /**
9877  * cfg80211_links_removed - Notify about removed STA MLD setup links.
9878  * @dev: network device.
9879  * @link_mask: BIT mask of removed STA MLD setup link IDs.
9880  *
9881  * Inform cfg80211 and the userspace about removed STA MLD setup links due to
9882  * AP MLD removing the corresponding affiliated APs with Multi-Link
9883  * reconfiguration. Note that it's not valid to remove all links, in this
9884  * case disconnect instead.
9885  * Also note that the wdev mutex must be held.
9886  */
9887 void cfg80211_links_removed(struct net_device *dev, u16 link_mask);
9888 
9889 /**
9890  * struct cfg80211_mlo_reconf_done_data - MLO reconfiguration data
9891  * @buf: MLO Reconfiguration Response frame (header + body)
9892  * @len: length of the frame data
9893  * @driver_initiated: Indicates whether the add links request is initiated by
9894  *	driver. This is set to true when the link reconfiguration request
9895  *	initiated by driver due to AP link recommendation requests
9896  *	(Ex: BTM (BSS Transition Management) request) handling offloaded to
9897  *	driver.
9898  * @added_links: BIT mask of links successfully added to the association
9899  * @links: per-link information indexed by link ID
9900  * @links.bss: the BSS that MLO reconfiguration was requested for, ownership of
9901  *      the pointer moves to cfg80211 in the call to
9902  *      cfg80211_mlo_reconf_add_done().
9903  *
9904  * The BSS pointer must be set for each link for which 'add' operation was
9905  * requested in the assoc_ml_reconf callback.
9906  */
9907 struct cfg80211_mlo_reconf_done_data {
9908 	const u8 *buf;
9909 	size_t len;
9910 	bool driver_initiated;
9911 	u16 added_links;
9912 	struct {
9913 		struct cfg80211_bss *bss;
9914 		u8 *addr;
9915 	} links[IEEE80211_MLD_MAX_NUM_LINKS];
9916 };
9917 
9918 /**
9919  * cfg80211_mlo_reconf_add_done - Notify about MLO reconfiguration result
9920  * @dev: network device.
9921  * @data: MLO reconfiguration done data, &struct cfg80211_mlo_reconf_done_data
9922  *
9923  * Inform cfg80211 and the userspace that processing of ML reconfiguration
9924  * request to add links to the association is done.
9925  */
9926 void cfg80211_mlo_reconf_add_done(struct net_device *dev,
9927 				  struct cfg80211_mlo_reconf_done_data *data);
9928 
9929 /**
9930  * cfg80211_schedule_channels_check - schedule regulatory check if needed
9931  * @wdev: the wireless device to check
9932  *
9933  * In case the device supports NO_IR or DFS relaxations, schedule regulatory
9934  * channels check, as previous concurrent operation conditions may not
9935  * hold anymore.
9936  */
9937 void cfg80211_schedule_channels_check(struct wireless_dev *wdev);
9938 
9939 /**
9940  * cfg80211_epcs_changed - Notify about a change in EPCS state
9941  * @netdev: the wireless device whose EPCS state changed
9942  * @enabled: set to true if EPCS was enabled, otherwise set to false.
9943  */
9944 void cfg80211_epcs_changed(struct net_device *netdev, bool enabled);
9945 
9946 #ifdef CONFIG_CFG80211_DEBUGFS
9947 /**
9948  * wiphy_locked_debugfs_read - do a locked read in debugfs
9949  * @wiphy: the wiphy to use
9950  * @file: the file being read
9951  * @buf: the buffer to fill and then read from
9952  * @bufsize: size of the buffer
9953  * @userbuf: the user buffer to copy to
9954  * @count: read count
9955  * @ppos: read position
9956  * @handler: the read handler to call (under wiphy lock)
9957  * @data: additional data to pass to the read handler
9958  *
9959  * Return: the number of characters read, or a negative errno
9960  */
9961 ssize_t wiphy_locked_debugfs_read(struct wiphy *wiphy, struct file *file,
9962 				  char *buf, size_t bufsize,
9963 				  char __user *userbuf, size_t count,
9964 				  loff_t *ppos,
9965 				  ssize_t (*handler)(struct wiphy *wiphy,
9966 						     struct file *file,
9967 						     char *buf,
9968 						     size_t bufsize,
9969 						     void *data),
9970 				  void *data);
9971 
9972 /**
9973  * wiphy_locked_debugfs_write - do a locked write in debugfs
9974  * @wiphy: the wiphy to use
9975  * @file: the file being written to
9976  * @buf: the buffer to copy the user data to
9977  * @bufsize: size of the buffer
9978  * @userbuf: the user buffer to copy from
9979  * @count: read count
9980  * @handler: the write handler to call (under wiphy lock)
9981  * @data: additional data to pass to the write handler
9982  *
9983  * Return: the number of characters written, or a negative errno
9984  */
9985 ssize_t wiphy_locked_debugfs_write(struct wiphy *wiphy, struct file *file,
9986 				   char *buf, size_t bufsize,
9987 				   const char __user *userbuf, size_t count,
9988 				   ssize_t (*handler)(struct wiphy *wiphy,
9989 						      struct file *file,
9990 						      char *buf,
9991 						      size_t count,
9992 						      void *data),
9993 				   void *data);
9994 #endif
9995 
9996 #endif /* __NET_CFG80211_H */
9997