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