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