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