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