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