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