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