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