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