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