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