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