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