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