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