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