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