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