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