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