Merge tag 'powerpc-4.18-1' of git://git.kernel.org/pub/scm/linux/kernel/git/powerpc...
[linux-2.6-microblaze.git] / include / net / cfg80211.h
1 #ifndef __NET_CFG80211_H
2 #define __NET_CFG80211_H
3 /*
4  * 802.11 device and configuration interface
5  *
6  * Copyright 2006-2010  Johannes Berg <johannes@sipsolutions.net>
7  * Copyright 2013-2014 Intel Mobile Communications GmbH
8  * Copyright 2015-2017  Intel Deutschland GmbH
9  * Copyright (C) 2018 Intel Corporation
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License version 2 as
13  * published by the Free Software Foundation.
14  */
15
16 #include <linux/netdevice.h>
17 #include <linux/debugfs.h>
18 #include <linux/list.h>
19 #include <linux/bug.h>
20 #include <linux/netlink.h>
21 #include <linux/skbuff.h>
22 #include <linux/nl80211.h>
23 #include <linux/if_ether.h>
24 #include <linux/ieee80211.h>
25 #include <linux/net.h>
26 #include <net/regulatory.h>
27
28 /**
29  * DOC: Introduction
30  *
31  * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
32  * userspace and drivers, and offers some utility functionality associated
33  * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
34  * by all modern wireless drivers in Linux, so that they offer a consistent
35  * API through nl80211. For backward compatibility, cfg80211 also offers
36  * wireless extensions to userspace, but hides them from drivers completely.
37  *
38  * Additionally, cfg80211 contains code to help enforce regulatory spectrum
39  * use restrictions.
40  */
41
42
43 /**
44  * DOC: Device registration
45  *
46  * In order for a driver to use cfg80211, it must register the hardware device
47  * with cfg80211. This happens through a number of hardware capability structs
48  * described below.
49  *
50  * The fundamental structure for each device is the 'wiphy', of which each
51  * instance describes a physical wireless device connected to the system. Each
52  * such wiphy can have zero, one, or many virtual interfaces associated with
53  * it, which need to be identified as such by pointing the network interface's
54  * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
55  * the wireless part of the interface, normally this struct is embedded in the
56  * network interface's private data area. Drivers can optionally allow creating
57  * or destroying virtual interfaces on the fly, but without at least one or the
58  * ability to create some the wireless device isn't useful.
59  *
60  * Each wiphy structure contains device capability information, and also has
61  * a pointer to the various operations the driver offers. The definitions and
62  * structures here describe these capabilities in detail.
63  */
64
65 struct wiphy;
66
67 /*
68  * wireless hardware capability structures
69  */
70
71 /**
72  * enum ieee80211_channel_flags - channel flags
73  *
74  * Channel flags set by the regulatory control code.
75  *
76  * @IEEE80211_CHAN_DISABLED: This channel is disabled.
77  * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
78  *      sending probe requests or beaconing.
79  * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
80  * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
81  *      is not permitted.
82  * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
83  *      is not permitted.
84  * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
85  * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
86  *      this flag indicates that an 80 MHz channel cannot use this
87  *      channel as the control or any of the secondary channels.
88  *      This may be due to the driver or due to regulatory bandwidth
89  *      restrictions.
90  * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
91  *      this flag indicates that an 160 MHz channel cannot use this
92  *      channel as the control or any of the secondary channels.
93  *      This may be due to the driver or due to regulatory bandwidth
94  *      restrictions.
95  * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
96  * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
97  * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
98  *      on this channel.
99  * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
100  *      on this channel.
101  *
102  */
103 enum ieee80211_channel_flags {
104         IEEE80211_CHAN_DISABLED         = 1<<0,
105         IEEE80211_CHAN_NO_IR            = 1<<1,
106         /* hole at 1<<2 */
107         IEEE80211_CHAN_RADAR            = 1<<3,
108         IEEE80211_CHAN_NO_HT40PLUS      = 1<<4,
109         IEEE80211_CHAN_NO_HT40MINUS     = 1<<5,
110         IEEE80211_CHAN_NO_OFDM          = 1<<6,
111         IEEE80211_CHAN_NO_80MHZ         = 1<<7,
112         IEEE80211_CHAN_NO_160MHZ        = 1<<8,
113         IEEE80211_CHAN_INDOOR_ONLY      = 1<<9,
114         IEEE80211_CHAN_IR_CONCURRENT    = 1<<10,
115         IEEE80211_CHAN_NO_20MHZ         = 1<<11,
116         IEEE80211_CHAN_NO_10MHZ         = 1<<12,
117 };
118
119 #define IEEE80211_CHAN_NO_HT40 \
120         (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
121
122 #define IEEE80211_DFS_MIN_CAC_TIME_MS           60000
123 #define IEEE80211_DFS_MIN_NOP_TIME_MS           (30 * 60 * 1000)
124
125 /**
126  * struct ieee80211_channel - channel definition
127  *
128  * This structure describes a single channel for use
129  * with cfg80211.
130  *
131  * @center_freq: center frequency in MHz
132  * @hw_value: hardware-specific value for the channel
133  * @flags: channel flags from &enum ieee80211_channel_flags.
134  * @orig_flags: channel flags at registration time, used by regulatory
135  *      code to support devices with additional restrictions
136  * @band: band this channel belongs to.
137  * @max_antenna_gain: maximum antenna gain in dBi
138  * @max_power: maximum transmission power (in dBm)
139  * @max_reg_power: maximum regulatory transmission power (in dBm)
140  * @beacon_found: helper to regulatory code to indicate when a beacon
141  *      has been found on this channel. Use regulatory_hint_found_beacon()
142  *      to enable this, this is useful only on 5 GHz band.
143  * @orig_mag: internal use
144  * @orig_mpwr: internal use
145  * @dfs_state: current state of this channel. Only relevant if radar is required
146  *      on this channel.
147  * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
148  * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
149  */
150 struct ieee80211_channel {
151         enum nl80211_band band;
152         u16 center_freq;
153         u16 hw_value;
154         u32 flags;
155         int max_antenna_gain;
156         int max_power;
157         int max_reg_power;
158         bool beacon_found;
159         u32 orig_flags;
160         int orig_mag, orig_mpwr;
161         enum nl80211_dfs_state dfs_state;
162         unsigned long dfs_state_entered;
163         unsigned int dfs_cac_ms;
164 };
165
166 /**
167  * enum ieee80211_rate_flags - rate flags
168  *
169  * Hardware/specification flags for rates. These are structured
170  * in a way that allows using the same bitrate structure for
171  * different bands/PHY modes.
172  *
173  * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
174  *      preamble on this bitrate; only relevant in 2.4GHz band and
175  *      with CCK rates.
176  * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
177  *      when used with 802.11a (on the 5 GHz band); filled by the
178  *      core code when registering the wiphy.
179  * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
180  *      when used with 802.11b (on the 2.4 GHz band); filled by the
181  *      core code when registering the wiphy.
182  * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
183  *      when used with 802.11g (on the 2.4 GHz band); filled by the
184  *      core code when registering the wiphy.
185  * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
186  * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
187  * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
188  */
189 enum ieee80211_rate_flags {
190         IEEE80211_RATE_SHORT_PREAMBLE   = 1<<0,
191         IEEE80211_RATE_MANDATORY_A      = 1<<1,
192         IEEE80211_RATE_MANDATORY_B      = 1<<2,
193         IEEE80211_RATE_MANDATORY_G      = 1<<3,
194         IEEE80211_RATE_ERP_G            = 1<<4,
195         IEEE80211_RATE_SUPPORTS_5MHZ    = 1<<5,
196         IEEE80211_RATE_SUPPORTS_10MHZ   = 1<<6,
197 };
198
199 /**
200  * enum ieee80211_bss_type - BSS type filter
201  *
202  * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
203  * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
204  * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
205  * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
206  * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
207  */
208 enum ieee80211_bss_type {
209         IEEE80211_BSS_TYPE_ESS,
210         IEEE80211_BSS_TYPE_PBSS,
211         IEEE80211_BSS_TYPE_IBSS,
212         IEEE80211_BSS_TYPE_MBSS,
213         IEEE80211_BSS_TYPE_ANY
214 };
215
216 /**
217  * enum ieee80211_privacy - BSS privacy filter
218  *
219  * @IEEE80211_PRIVACY_ON: privacy bit set
220  * @IEEE80211_PRIVACY_OFF: privacy bit clear
221  * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
222  */
223 enum ieee80211_privacy {
224         IEEE80211_PRIVACY_ON,
225         IEEE80211_PRIVACY_OFF,
226         IEEE80211_PRIVACY_ANY
227 };
228
229 #define IEEE80211_PRIVACY(x)    \
230         ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
231
232 /**
233  * struct ieee80211_rate - bitrate definition
234  *
235  * This structure describes a bitrate that an 802.11 PHY can
236  * operate with. The two values @hw_value and @hw_value_short
237  * are only for driver use when pointers to this structure are
238  * passed around.
239  *
240  * @flags: rate-specific flags
241  * @bitrate: bitrate in units of 100 Kbps
242  * @hw_value: driver/hardware value for this rate
243  * @hw_value_short: driver/hardware value for this rate when
244  *      short preamble is used
245  */
246 struct ieee80211_rate {
247         u32 flags;
248         u16 bitrate;
249         u16 hw_value, hw_value_short;
250 };
251
252 /**
253  * struct ieee80211_sta_ht_cap - STA's HT capabilities
254  *
255  * This structure describes most essential parameters needed
256  * to describe 802.11n HT capabilities for an STA.
257  *
258  * @ht_supported: is HT supported by the STA
259  * @cap: HT capabilities map as described in 802.11n spec
260  * @ampdu_factor: Maximum A-MPDU length factor
261  * @ampdu_density: Minimum A-MPDU spacing
262  * @mcs: Supported MCS rates
263  */
264 struct ieee80211_sta_ht_cap {
265         u16 cap; /* use IEEE80211_HT_CAP_ */
266         bool ht_supported;
267         u8 ampdu_factor;
268         u8 ampdu_density;
269         struct ieee80211_mcs_info mcs;
270 };
271
272 /**
273  * struct ieee80211_sta_vht_cap - STA's VHT capabilities
274  *
275  * This structure describes most essential parameters needed
276  * to describe 802.11ac VHT capabilities for an STA.
277  *
278  * @vht_supported: is VHT supported by the STA
279  * @cap: VHT capabilities map as described in 802.11ac spec
280  * @vht_mcs: Supported VHT MCS rates
281  */
282 struct ieee80211_sta_vht_cap {
283         bool vht_supported;
284         u32 cap; /* use IEEE80211_VHT_CAP_ */
285         struct ieee80211_vht_mcs_info vht_mcs;
286 };
287
288 /**
289  * struct ieee80211_supported_band - frequency band definition
290  *
291  * This structure describes a frequency band a wiphy
292  * is able to operate in.
293  *
294  * @channels: Array of channels the hardware can operate in
295  *      in this band.
296  * @band: the band this structure represents
297  * @n_channels: Number of channels in @channels
298  * @bitrates: Array of bitrates the hardware can operate with
299  *      in this band. Must be sorted to give a valid "supported
300  *      rates" IE, i.e. CCK rates first, then OFDM.
301  * @n_bitrates: Number of bitrates in @bitrates
302  * @ht_cap: HT capabilities in this band
303  * @vht_cap: VHT capabilities in this band
304  */
305 struct ieee80211_supported_band {
306         struct ieee80211_channel *channels;
307         struct ieee80211_rate *bitrates;
308         enum nl80211_band band;
309         int n_channels;
310         int n_bitrates;
311         struct ieee80211_sta_ht_cap ht_cap;
312         struct ieee80211_sta_vht_cap vht_cap;
313 };
314
315 /**
316  * wiphy_read_of_freq_limits - read frequency limits from device tree
317  *
318  * @wiphy: the wireless device to get extra limits for
319  *
320  * Some devices may have extra limitations specified in DT. This may be useful
321  * for chipsets that normally support more bands but are limited due to board
322  * design (e.g. by antennas or external power amplifier).
323  *
324  * This function reads info from DT and uses it to *modify* channels (disable
325  * unavailable ones). It's usually a *bad* idea to use it in drivers with
326  * shared channel data as DT limitations are device specific. You should make
327  * sure to call it only if channels in wiphy are copied and can be modified
328  * without affecting other devices.
329  *
330  * As this function access device node it has to be called after set_wiphy_dev.
331  * It also modifies channels so they have to be set first.
332  * If using this helper, call it before wiphy_register().
333  */
334 #ifdef CONFIG_OF
335 void wiphy_read_of_freq_limits(struct wiphy *wiphy);
336 #else /* CONFIG_OF */
337 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
338 {
339 }
340 #endif /* !CONFIG_OF */
341
342
343 /*
344  * Wireless hardware/device configuration structures and methods
345  */
346
347 /**
348  * DOC: Actions and configuration
349  *
350  * Each wireless device and each virtual interface offer a set of configuration
351  * operations and other actions that are invoked by userspace. Each of these
352  * actions is described in the operations structure, and the parameters these
353  * operations use are described separately.
354  *
355  * Additionally, some operations are asynchronous and expect to get status
356  * information via some functions that drivers need to call.
357  *
358  * Scanning and BSS list handling with its associated functionality is described
359  * in a separate chapter.
360  */
361
362 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
363                                     WLAN_USER_POSITION_LEN)
364
365 /**
366  * struct vif_params - describes virtual interface parameters
367  * @flags: monitor interface flags, unchanged if 0, otherwise
368  *      %MONITOR_FLAG_CHANGED will be set
369  * @use_4addr: use 4-address frames
370  * @macaddr: address to use for this virtual interface.
371  *      If this parameter is set to zero address the driver may
372  *      determine the address as needed.
373  *      This feature is only fully supported by drivers that enable the
374  *      %NL80211_FEATURE_MAC_ON_CREATE flag.  Others may support creating
375  **     only p2p devices with specified MAC.
376  * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
377  *      belonging to that MU-MIMO groupID; %NULL if not changed
378  * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
379  *      MU-MIMO packets going to the specified station; %NULL if not changed
380  */
381 struct vif_params {
382         u32 flags;
383         int use_4addr;
384         u8 macaddr[ETH_ALEN];
385         const u8 *vht_mumimo_groups;
386         const u8 *vht_mumimo_follow_addr;
387 };
388
389 /**
390  * struct key_params - key information
391  *
392  * Information about a key
393  *
394  * @key: key material
395  * @key_len: length of key material
396  * @cipher: cipher suite selector
397  * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
398  *      with the get_key() callback, must be in little endian,
399  *      length given by @seq_len.
400  * @seq_len: length of @seq.
401  */
402 struct key_params {
403         const u8 *key;
404         const u8 *seq;
405         int key_len;
406         int seq_len;
407         u32 cipher;
408 };
409
410 /**
411  * struct cfg80211_chan_def - channel definition
412  * @chan: the (control) channel
413  * @width: channel width
414  * @center_freq1: center frequency of first segment
415  * @center_freq2: center frequency of second segment
416  *      (only with 80+80 MHz)
417  */
418 struct cfg80211_chan_def {
419         struct ieee80211_channel *chan;
420         enum nl80211_chan_width width;
421         u32 center_freq1;
422         u32 center_freq2;
423 };
424
425 /**
426  * cfg80211_get_chandef_type - return old channel type from chandef
427  * @chandef: the channel definition
428  *
429  * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
430  * chandef, which must have a bandwidth allowing this conversion.
431  */
432 static inline enum nl80211_channel_type
433 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
434 {
435         switch (chandef->width) {
436         case NL80211_CHAN_WIDTH_20_NOHT:
437                 return NL80211_CHAN_NO_HT;
438         case NL80211_CHAN_WIDTH_20:
439                 return NL80211_CHAN_HT20;
440         case NL80211_CHAN_WIDTH_40:
441                 if (chandef->center_freq1 > chandef->chan->center_freq)
442                         return NL80211_CHAN_HT40PLUS;
443                 return NL80211_CHAN_HT40MINUS;
444         default:
445                 WARN_ON(1);
446                 return NL80211_CHAN_NO_HT;
447         }
448 }
449
450 /**
451  * cfg80211_chandef_create - create channel definition using channel type
452  * @chandef: the channel definition struct to fill
453  * @channel: the control channel
454  * @chantype: the channel type
455  *
456  * Given a channel type, create a channel definition.
457  */
458 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
459                              struct ieee80211_channel *channel,
460                              enum nl80211_channel_type chantype);
461
462 /**
463  * cfg80211_chandef_identical - check if two channel definitions are identical
464  * @chandef1: first channel definition
465  * @chandef2: second channel definition
466  *
467  * Return: %true if the channels defined by the channel definitions are
468  * identical, %false otherwise.
469  */
470 static inline bool
471 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
472                            const struct cfg80211_chan_def *chandef2)
473 {
474         return (chandef1->chan == chandef2->chan &&
475                 chandef1->width == chandef2->width &&
476                 chandef1->center_freq1 == chandef2->center_freq1 &&
477                 chandef1->center_freq2 == chandef2->center_freq2);
478 }
479
480 /**
481  * cfg80211_chandef_compatible - check if two channel definitions are compatible
482  * @chandef1: first channel definition
483  * @chandef2: second channel definition
484  *
485  * Return: %NULL if the given channel definitions are incompatible,
486  * chandef1 or chandef2 otherwise.
487  */
488 const struct cfg80211_chan_def *
489 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
490                             const struct cfg80211_chan_def *chandef2);
491
492 /**
493  * cfg80211_chandef_valid - check if a channel definition is valid
494  * @chandef: the channel definition to check
495  * Return: %true if the channel definition is valid. %false otherwise.
496  */
497 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
498
499 /**
500  * cfg80211_chandef_usable - check if secondary channels can be used
501  * @wiphy: the wiphy to validate against
502  * @chandef: the channel definition to check
503  * @prohibited_flags: the regulatory channel flags that must not be set
504  * Return: %true if secondary channels are usable. %false otherwise.
505  */
506 bool cfg80211_chandef_usable(struct wiphy *wiphy,
507                              const struct cfg80211_chan_def *chandef,
508                              u32 prohibited_flags);
509
510 /**
511  * cfg80211_chandef_dfs_required - checks if radar detection is required
512  * @wiphy: the wiphy to validate against
513  * @chandef: the channel definition to check
514  * @iftype: the interface type as specified in &enum nl80211_iftype
515  * Returns:
516  *      1 if radar detection is required, 0 if it is not, < 0 on error
517  */
518 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
519                                   const struct cfg80211_chan_def *chandef,
520                                   enum nl80211_iftype iftype);
521
522 /**
523  * ieee80211_chandef_rate_flags - returns rate flags for a channel
524  *
525  * In some channel types, not all rates may be used - for example CCK
526  * rates may not be used in 5/10 MHz channels.
527  *
528  * @chandef: channel definition for the channel
529  *
530  * Returns: rate flags which apply for this channel
531  */
532 static inline enum ieee80211_rate_flags
533 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
534 {
535         switch (chandef->width) {
536         case NL80211_CHAN_WIDTH_5:
537                 return IEEE80211_RATE_SUPPORTS_5MHZ;
538         case NL80211_CHAN_WIDTH_10:
539                 return IEEE80211_RATE_SUPPORTS_10MHZ;
540         default:
541                 break;
542         }
543         return 0;
544 }
545
546 /**
547  * ieee80211_chandef_max_power - maximum transmission power for the chandef
548  *
549  * In some regulations, the transmit power may depend on the configured channel
550  * bandwidth which may be defined as dBm/MHz. This function returns the actual
551  * max_power for non-standard (20 MHz) channels.
552  *
553  * @chandef: channel definition for the channel
554  *
555  * Returns: maximum allowed transmission power in dBm for the chandef
556  */
557 static inline int
558 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
559 {
560         switch (chandef->width) {
561         case NL80211_CHAN_WIDTH_5:
562                 return min(chandef->chan->max_reg_power - 6,
563                            chandef->chan->max_power);
564         case NL80211_CHAN_WIDTH_10:
565                 return min(chandef->chan->max_reg_power - 3,
566                            chandef->chan->max_power);
567         default:
568                 break;
569         }
570         return chandef->chan->max_power;
571 }
572
573 /**
574  * enum survey_info_flags - survey information flags
575  *
576  * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
577  * @SURVEY_INFO_IN_USE: channel is currently being used
578  * @SURVEY_INFO_TIME: active time (in ms) was filled in
579  * @SURVEY_INFO_TIME_BUSY: busy time was filled in
580  * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
581  * @SURVEY_INFO_TIME_RX: receive time was filled in
582  * @SURVEY_INFO_TIME_TX: transmit time was filled in
583  * @SURVEY_INFO_TIME_SCAN: scan time was filled in
584  *
585  * Used by the driver to indicate which info in &struct survey_info
586  * it has filled in during the get_survey().
587  */
588 enum survey_info_flags {
589         SURVEY_INFO_NOISE_DBM           = BIT(0),
590         SURVEY_INFO_IN_USE              = BIT(1),
591         SURVEY_INFO_TIME                = BIT(2),
592         SURVEY_INFO_TIME_BUSY           = BIT(3),
593         SURVEY_INFO_TIME_EXT_BUSY       = BIT(4),
594         SURVEY_INFO_TIME_RX             = BIT(5),
595         SURVEY_INFO_TIME_TX             = BIT(6),
596         SURVEY_INFO_TIME_SCAN           = BIT(7),
597 };
598
599 /**
600  * struct survey_info - channel survey response
601  *
602  * @channel: the channel this survey record reports, may be %NULL for a single
603  *      record to report global statistics
604  * @filled: bitflag of flags from &enum survey_info_flags
605  * @noise: channel noise in dBm. This and all following fields are
606  *      optional
607  * @time: amount of time in ms the radio was turn on (on the channel)
608  * @time_busy: amount of time the primary channel was sensed busy
609  * @time_ext_busy: amount of time the extension channel was sensed busy
610  * @time_rx: amount of time the radio spent receiving data
611  * @time_tx: amount of time the radio spent transmitting data
612  * @time_scan: amount of time the radio spent for scanning
613  *
614  * Used by dump_survey() to report back per-channel survey information.
615  *
616  * This structure can later be expanded with things like
617  * channel duty cycle etc.
618  */
619 struct survey_info {
620         struct ieee80211_channel *channel;
621         u64 time;
622         u64 time_busy;
623         u64 time_ext_busy;
624         u64 time_rx;
625         u64 time_tx;
626         u64 time_scan;
627         u32 filled;
628         s8 noise;
629 };
630
631 #define CFG80211_MAX_WEP_KEYS   4
632
633 /**
634  * struct cfg80211_crypto_settings - Crypto settings
635  * @wpa_versions: indicates which, if any, WPA versions are enabled
636  *      (from enum nl80211_wpa_versions)
637  * @cipher_group: group key cipher suite (or 0 if unset)
638  * @n_ciphers_pairwise: number of AP supported unicast ciphers
639  * @ciphers_pairwise: unicast key cipher suites
640  * @n_akm_suites: number of AKM suites
641  * @akm_suites: AKM suites
642  * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
643  *      sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
644  *      required to assume that the port is unauthorized until authorized by
645  *      user space. Otherwise, port is marked authorized by default.
646  * @control_port_ethertype: the control port protocol that should be
647  *      allowed through even on unauthorized ports
648  * @control_port_no_encrypt: TRUE to prevent encryption of control port
649  *      protocol frames.
650  * @control_port_over_nl80211: TRUE if userspace expects to exchange control
651  *      port frames over NL80211 instead of the network interface.
652  * @wep_keys: static WEP keys, if not NULL points to an array of
653  *      CFG80211_MAX_WEP_KEYS WEP keys
654  * @wep_tx_key: key index (0..3) of the default TX static WEP key
655  * @psk: PSK (for devices supporting 4-way-handshake offload)
656  */
657 struct cfg80211_crypto_settings {
658         u32 wpa_versions;
659         u32 cipher_group;
660         int n_ciphers_pairwise;
661         u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
662         int n_akm_suites;
663         u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
664         bool control_port;
665         __be16 control_port_ethertype;
666         bool control_port_no_encrypt;
667         bool control_port_over_nl80211;
668         struct key_params *wep_keys;
669         int wep_tx_key;
670         const u8 *psk;
671 };
672
673 /**
674  * struct cfg80211_beacon_data - beacon data
675  * @head: head portion of beacon (before TIM IE)
676  *      or %NULL if not changed
677  * @tail: tail portion of beacon (after TIM IE)
678  *      or %NULL if not changed
679  * @head_len: length of @head
680  * @tail_len: length of @tail
681  * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
682  * @beacon_ies_len: length of beacon_ies in octets
683  * @proberesp_ies: extra information element(s) to add into Probe Response
684  *      frames or %NULL
685  * @proberesp_ies_len: length of proberesp_ies in octets
686  * @assocresp_ies: extra information element(s) to add into (Re)Association
687  *      Response frames or %NULL
688  * @assocresp_ies_len: length of assocresp_ies in octets
689  * @probe_resp_len: length of probe response template (@probe_resp)
690  * @probe_resp: probe response template (AP mode only)
691  */
692 struct cfg80211_beacon_data {
693         const u8 *head, *tail;
694         const u8 *beacon_ies;
695         const u8 *proberesp_ies;
696         const u8 *assocresp_ies;
697         const u8 *probe_resp;
698
699         size_t head_len, tail_len;
700         size_t beacon_ies_len;
701         size_t proberesp_ies_len;
702         size_t assocresp_ies_len;
703         size_t probe_resp_len;
704 };
705
706 struct mac_address {
707         u8 addr[ETH_ALEN];
708 };
709
710 /**
711  * struct cfg80211_acl_data - Access control list data
712  *
713  * @acl_policy: ACL policy to be applied on the station's
714  *      entry specified by mac_addr
715  * @n_acl_entries: Number of MAC address entries passed
716  * @mac_addrs: List of MAC addresses of stations to be used for ACL
717  */
718 struct cfg80211_acl_data {
719         enum nl80211_acl_policy acl_policy;
720         int n_acl_entries;
721
722         /* Keep it last */
723         struct mac_address mac_addrs[];
724 };
725
726 /*
727  * cfg80211_bitrate_mask - masks for bitrate control
728  */
729 struct cfg80211_bitrate_mask {
730         struct {
731                 u32 legacy;
732                 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
733                 u16 vht_mcs[NL80211_VHT_NSS_MAX];
734                 enum nl80211_txrate_gi gi;
735         } control[NUM_NL80211_BANDS];
736 };
737
738 /**
739  * struct cfg80211_ap_settings - AP configuration
740  *
741  * Used to configure an AP interface.
742  *
743  * @chandef: defines the channel to use
744  * @beacon: beacon data
745  * @beacon_interval: beacon interval
746  * @dtim_period: DTIM period
747  * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
748  *      user space)
749  * @ssid_len: length of @ssid
750  * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
751  * @crypto: crypto settings
752  * @privacy: the BSS uses privacy
753  * @auth_type: Authentication type (algorithm)
754  * @smps_mode: SMPS mode
755  * @inactivity_timeout: time in seconds to determine station's inactivity.
756  * @p2p_ctwindow: P2P CT Window
757  * @p2p_opp_ps: P2P opportunistic PS
758  * @acl: ACL configuration used by the drivers which has support for
759  *      MAC address based access control
760  * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
761  *      networks.
762  * @beacon_rate: bitrate to be used for beacons
763  * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
764  * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
765  * @ht_required: stations must support HT
766  * @vht_required: stations must support VHT
767  */
768 struct cfg80211_ap_settings {
769         struct cfg80211_chan_def chandef;
770
771         struct cfg80211_beacon_data beacon;
772
773         int beacon_interval, dtim_period;
774         const u8 *ssid;
775         size_t ssid_len;
776         enum nl80211_hidden_ssid hidden_ssid;
777         struct cfg80211_crypto_settings crypto;
778         bool privacy;
779         enum nl80211_auth_type auth_type;
780         enum nl80211_smps_mode smps_mode;
781         int inactivity_timeout;
782         u8 p2p_ctwindow;
783         bool p2p_opp_ps;
784         const struct cfg80211_acl_data *acl;
785         bool pbss;
786         struct cfg80211_bitrate_mask beacon_rate;
787
788         const struct ieee80211_ht_cap *ht_cap;
789         const struct ieee80211_vht_cap *vht_cap;
790         bool ht_required, vht_required;
791 };
792
793 /**
794  * struct cfg80211_csa_settings - channel switch settings
795  *
796  * Used for channel switch
797  *
798  * @chandef: defines the channel to use after the switch
799  * @beacon_csa: beacon data while performing the switch
800  * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
801  * @counter_offsets_presp: offsets of the counters within the probe response
802  * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
803  * @n_counter_offsets_presp: number of csa counters in the probe response
804  * @beacon_after: beacon data to be used on the new channel
805  * @radar_required: whether radar detection is required on the new channel
806  * @block_tx: whether transmissions should be blocked while changing
807  * @count: number of beacons until switch
808  */
809 struct cfg80211_csa_settings {
810         struct cfg80211_chan_def chandef;
811         struct cfg80211_beacon_data beacon_csa;
812         const u16 *counter_offsets_beacon;
813         const u16 *counter_offsets_presp;
814         unsigned int n_counter_offsets_beacon;
815         unsigned int n_counter_offsets_presp;
816         struct cfg80211_beacon_data beacon_after;
817         bool radar_required;
818         bool block_tx;
819         u8 count;
820 };
821
822 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
823
824 /**
825  * struct iface_combination_params - input parameters for interface combinations
826  *
827  * Used to pass interface combination parameters
828  *
829  * @num_different_channels: the number of different channels we want
830  *      to use for verification
831  * @radar_detect: a bitmap where each bit corresponds to a channel
832  *      width where radar detection is needed, as in the definition of
833  *      &struct ieee80211_iface_combination.@radar_detect_widths
834  * @iftype_num: array with the number of interfaces of each interface
835  *      type.  The index is the interface type as specified in &enum
836  *      nl80211_iftype.
837  * @new_beacon_int: set this to the beacon interval of a new interface
838  *      that's not operating yet, if such is to be checked as part of
839  *      the verification
840  */
841 struct iface_combination_params {
842         int num_different_channels;
843         u8 radar_detect;
844         int iftype_num[NUM_NL80211_IFTYPES];
845         u32 new_beacon_int;
846 };
847
848 /**
849  * enum station_parameters_apply_mask - station parameter values to apply
850  * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
851  * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
852  * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
853  *
854  * Not all station parameters have in-band "no change" signalling,
855  * for those that don't these flags will are used.
856  */
857 enum station_parameters_apply_mask {
858         STATION_PARAM_APPLY_UAPSD = BIT(0),
859         STATION_PARAM_APPLY_CAPABILITY = BIT(1),
860         STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
861 };
862
863 /**
864  * struct station_parameters - station parameters
865  *
866  * Used to change and create a new station.
867  *
868  * @vlan: vlan interface station should belong to
869  * @supported_rates: supported rates in IEEE 802.11 format
870  *      (or NULL for no change)
871  * @supported_rates_len: number of supported rates
872  * @sta_flags_mask: station flags that changed
873  *      (bitmask of BIT(%NL80211_STA_FLAG_...))
874  * @sta_flags_set: station flags values
875  *      (bitmask of BIT(%NL80211_STA_FLAG_...))
876  * @listen_interval: listen interval or -1 for no change
877  * @aid: AID or zero for no change
878  * @peer_aid: mesh peer AID or zero for no change
879  * @plink_action: plink action to take
880  * @plink_state: set the peer link state for a station
881  * @ht_capa: HT capabilities of station
882  * @vht_capa: VHT capabilities of station
883  * @uapsd_queues: bitmap of queues configured for uapsd. same format
884  *      as the AC bitmap in the QoS info field
885  * @max_sp: max Service Period. same format as the MAX_SP in the
886  *      QoS info field (but already shifted down)
887  * @sta_modify_mask: bitmap indicating which parameters changed
888  *      (for those that don't have a natural "no change" value),
889  *      see &enum station_parameters_apply_mask
890  * @local_pm: local link-specific mesh power save mode (no change when set
891  *      to unknown)
892  * @capability: station capability
893  * @ext_capab: extended capabilities of the station
894  * @ext_capab_len: number of extended capabilities
895  * @supported_channels: supported channels in IEEE 802.11 format
896  * @supported_channels_len: number of supported channels
897  * @supported_oper_classes: supported oper classes in IEEE 802.11 format
898  * @supported_oper_classes_len: number of supported operating classes
899  * @opmode_notif: operating mode field from Operating Mode Notification
900  * @opmode_notif_used: information if operating mode field is used
901  * @support_p2p_ps: information if station supports P2P PS mechanism
902  */
903 struct station_parameters {
904         const u8 *supported_rates;
905         struct net_device *vlan;
906         u32 sta_flags_mask, sta_flags_set;
907         u32 sta_modify_mask;
908         int listen_interval;
909         u16 aid;
910         u16 peer_aid;
911         u8 supported_rates_len;
912         u8 plink_action;
913         u8 plink_state;
914         const struct ieee80211_ht_cap *ht_capa;
915         const struct ieee80211_vht_cap *vht_capa;
916         u8 uapsd_queues;
917         u8 max_sp;
918         enum nl80211_mesh_power_mode local_pm;
919         u16 capability;
920         const u8 *ext_capab;
921         u8 ext_capab_len;
922         const u8 *supported_channels;
923         u8 supported_channels_len;
924         const u8 *supported_oper_classes;
925         u8 supported_oper_classes_len;
926         u8 opmode_notif;
927         bool opmode_notif_used;
928         int support_p2p_ps;
929 };
930
931 /**
932  * struct station_del_parameters - station deletion parameters
933  *
934  * Used to delete a station entry (or all stations).
935  *
936  * @mac: MAC address of the station to remove or NULL to remove all stations
937  * @subtype: Management frame subtype to use for indicating removal
938  *      (10 = Disassociation, 12 = Deauthentication)
939  * @reason_code: Reason code for the Disassociation/Deauthentication frame
940  */
941 struct station_del_parameters {
942         const u8 *mac;
943         u8 subtype;
944         u16 reason_code;
945 };
946
947 /**
948  * enum cfg80211_station_type - the type of station being modified
949  * @CFG80211_STA_AP_CLIENT: client of an AP interface
950  * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
951  *      unassociated (update properties for this type of client is permitted)
952  * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
953  *      the AP MLME in the device
954  * @CFG80211_STA_AP_STA: AP station on managed interface
955  * @CFG80211_STA_IBSS: IBSS station
956  * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
957  *      while TDLS setup is in progress, it moves out of this state when
958  *      being marked authorized; use this only if TDLS with external setup is
959  *      supported/used)
960  * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
961  *      entry that is operating, has been marked authorized by userspace)
962  * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
963  * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
964  */
965 enum cfg80211_station_type {
966         CFG80211_STA_AP_CLIENT,
967         CFG80211_STA_AP_CLIENT_UNASSOC,
968         CFG80211_STA_AP_MLME_CLIENT,
969         CFG80211_STA_AP_STA,
970         CFG80211_STA_IBSS,
971         CFG80211_STA_TDLS_PEER_SETUP,
972         CFG80211_STA_TDLS_PEER_ACTIVE,
973         CFG80211_STA_MESH_PEER_KERNEL,
974         CFG80211_STA_MESH_PEER_USER,
975 };
976
977 /**
978  * cfg80211_check_station_change - validate parameter changes
979  * @wiphy: the wiphy this operates on
980  * @params: the new parameters for a station
981  * @statype: the type of station being modified
982  *
983  * Utility function for the @change_station driver method. Call this function
984  * with the appropriate station type looking up the station (and checking that
985  * it exists). It will verify whether the station change is acceptable, and if
986  * not will return an error code. Note that it may modify the parameters for
987  * backward compatibility reasons, so don't use them before calling this.
988  */
989 int cfg80211_check_station_change(struct wiphy *wiphy,
990                                   struct station_parameters *params,
991                                   enum cfg80211_station_type statype);
992
993 /**
994  * enum station_info_rate_flags - bitrate info flags
995  *
996  * Used by the driver to indicate the specific rate transmission
997  * type for 802.11n transmissions.
998  *
999  * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1000  * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1001  * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1002  * @RATE_INFO_FLAGS_60G: 60GHz MCS
1003  */
1004 enum rate_info_flags {
1005         RATE_INFO_FLAGS_MCS                     = BIT(0),
1006         RATE_INFO_FLAGS_VHT_MCS                 = BIT(1),
1007         RATE_INFO_FLAGS_SHORT_GI                = BIT(2),
1008         RATE_INFO_FLAGS_60G                     = BIT(3),
1009 };
1010
1011 /**
1012  * enum rate_info_bw - rate bandwidth information
1013  *
1014  * Used by the driver to indicate the rate bandwidth.
1015  *
1016  * @RATE_INFO_BW_5: 5 MHz bandwidth
1017  * @RATE_INFO_BW_10: 10 MHz bandwidth
1018  * @RATE_INFO_BW_20: 20 MHz bandwidth
1019  * @RATE_INFO_BW_40: 40 MHz bandwidth
1020  * @RATE_INFO_BW_80: 80 MHz bandwidth
1021  * @RATE_INFO_BW_160: 160 MHz bandwidth
1022  */
1023 enum rate_info_bw {
1024         RATE_INFO_BW_20 = 0,
1025         RATE_INFO_BW_5,
1026         RATE_INFO_BW_10,
1027         RATE_INFO_BW_40,
1028         RATE_INFO_BW_80,
1029         RATE_INFO_BW_160,
1030 };
1031
1032 /**
1033  * struct rate_info - bitrate information
1034  *
1035  * Information about a receiving or transmitting bitrate
1036  *
1037  * @flags: bitflag of flags from &enum rate_info_flags
1038  * @mcs: mcs index if struct describes a 802.11n bitrate
1039  * @legacy: bitrate in 100kbit/s for 802.11abg
1040  * @nss: number of streams (VHT only)
1041  * @bw: bandwidth (from &enum rate_info_bw)
1042  */
1043 struct rate_info {
1044         u8 flags;
1045         u8 mcs;
1046         u16 legacy;
1047         u8 nss;
1048         u8 bw;
1049 };
1050
1051 /**
1052  * enum station_info_rate_flags - bitrate info flags
1053  *
1054  * Used by the driver to indicate the specific rate transmission
1055  * type for 802.11n transmissions.
1056  *
1057  * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1058  * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1059  * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1060  */
1061 enum bss_param_flags {
1062         BSS_PARAM_FLAGS_CTS_PROT        = 1<<0,
1063         BSS_PARAM_FLAGS_SHORT_PREAMBLE  = 1<<1,
1064         BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1065 };
1066
1067 /**
1068  * struct sta_bss_parameters - BSS parameters for the attached station
1069  *
1070  * Information about the currently associated BSS
1071  *
1072  * @flags: bitflag of flags from &enum bss_param_flags
1073  * @dtim_period: DTIM period for the BSS
1074  * @beacon_interval: beacon interval
1075  */
1076 struct sta_bss_parameters {
1077         u8 flags;
1078         u8 dtim_period;
1079         u16 beacon_interval;
1080 };
1081
1082 /**
1083  * struct cfg80211_txq_stats - TXQ statistics for this TID
1084  * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1085  *      indicate the relevant values in this struct are filled
1086  * @backlog_bytes: total number of bytes currently backlogged
1087  * @backlog_packets: total number of packets currently backlogged
1088  * @flows: number of new flows seen
1089  * @drops: total number of packets dropped
1090  * @ecn_marks: total number of packets marked with ECN CE
1091  * @overlimit: number of drops due to queue space overflow
1092  * @overmemory: number of drops due to memory limit overflow
1093  * @collisions: number of hash collisions
1094  * @tx_bytes: total number of bytes dequeued
1095  * @tx_packets: total number of packets dequeued
1096  * @max_flows: maximum number of flows supported
1097  */
1098 struct cfg80211_txq_stats {
1099         u32 filled;
1100         u32 backlog_bytes;
1101         u32 backlog_packets;
1102         u32 flows;
1103         u32 drops;
1104         u32 ecn_marks;
1105         u32 overlimit;
1106         u32 overmemory;
1107         u32 collisions;
1108         u32 tx_bytes;
1109         u32 tx_packets;
1110         u32 max_flows;
1111 };
1112
1113 /**
1114  * struct cfg80211_tid_stats - per-TID statistics
1115  * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1116  *      indicate the relevant values in this struct are filled
1117  * @rx_msdu: number of received MSDUs
1118  * @tx_msdu: number of (attempted) transmitted MSDUs
1119  * @tx_msdu_retries: number of retries (not counting the first) for
1120  *      transmitted MSDUs
1121  * @tx_msdu_failed: number of failed transmitted MSDUs
1122  * @txq_stats: TXQ statistics
1123  */
1124 struct cfg80211_tid_stats {
1125         u32 filled;
1126         u64 rx_msdu;
1127         u64 tx_msdu;
1128         u64 tx_msdu_retries;
1129         u64 tx_msdu_failed;
1130         struct cfg80211_txq_stats txq_stats;
1131 };
1132
1133 #define IEEE80211_MAX_CHAINS    4
1134
1135 /**
1136  * struct station_info - station information
1137  *
1138  * Station information filled by driver for get_station() and dump_station.
1139  *
1140  * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1141  *      indicate the relevant values in this struct for them
1142  * @connected_time: time(in secs) since a station is last connected
1143  * @inactive_time: time since last station activity (tx/rx) in milliseconds
1144  * @rx_bytes: bytes (size of MPDUs) received from this station
1145  * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1146  * @llid: mesh local link id
1147  * @plid: mesh peer link id
1148  * @plink_state: mesh peer link state
1149  * @signal: The signal strength, type depends on the wiphy's signal_type.
1150  *      For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1151  * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1152  *      For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1153  * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1154  * @chain_signal: per-chain signal strength of last received packet in dBm
1155  * @chain_signal_avg: per-chain signal strength average in dBm
1156  * @txrate: current unicast bitrate from this station
1157  * @rxrate: current unicast bitrate to this station
1158  * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1159  * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1160  * @tx_retries: cumulative retry counts (MPDUs)
1161  * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1162  * @rx_dropped_misc:  Dropped for un-specified reason.
1163  * @bss_param: current BSS parameters
1164  * @generation: generation number for nl80211 dumps.
1165  *      This number should increase every time the list of stations
1166  *      changes, i.e. when a station is added or removed, so that
1167  *      userspace can tell whether it got a consistent snapshot.
1168  * @assoc_req_ies: IEs from (Re)Association Request.
1169  *      This is used only when in AP mode with drivers that do not use
1170  *      user space MLME/SME implementation. The information is provided for
1171  *      the cfg80211_new_sta() calls to notify user space of the IEs.
1172  * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1173  * @sta_flags: station flags mask & values
1174  * @beacon_loss_count: Number of times beacon loss event has triggered.
1175  * @t_offset: Time offset of the station relative to this host.
1176  * @local_pm: local mesh STA power save mode
1177  * @peer_pm: peer mesh STA power save mode
1178  * @nonpeer_pm: non-peer mesh STA power save mode
1179  * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1180  *      towards this station.
1181  * @rx_beacon: number of beacons received from this peer
1182  * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1183  *      from this peer
1184  * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1185  * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1186  *      (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1187  *      Note that this doesn't use the @filled bit, but is used if non-NULL.
1188  * @ack_signal: signal strength (in dBm) of the last ACK frame.
1189  * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1190  *      been sent.
1191  */
1192 struct station_info {
1193         u64 filled;
1194         u32 connected_time;
1195         u32 inactive_time;
1196         u64 rx_bytes;
1197         u64 tx_bytes;
1198         u16 llid;
1199         u16 plid;
1200         u8 plink_state;
1201         s8 signal;
1202         s8 signal_avg;
1203
1204         u8 chains;
1205         s8 chain_signal[IEEE80211_MAX_CHAINS];
1206         s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1207
1208         struct rate_info txrate;
1209         struct rate_info rxrate;
1210         u32 rx_packets;
1211         u32 tx_packets;
1212         u32 tx_retries;
1213         u32 tx_failed;
1214         u32 rx_dropped_misc;
1215         struct sta_bss_parameters bss_param;
1216         struct nl80211_sta_flag_update sta_flags;
1217
1218         int generation;
1219
1220         const u8 *assoc_req_ies;
1221         size_t assoc_req_ies_len;
1222
1223         u32 beacon_loss_count;
1224         s64 t_offset;
1225         enum nl80211_mesh_power_mode local_pm;
1226         enum nl80211_mesh_power_mode peer_pm;
1227         enum nl80211_mesh_power_mode nonpeer_pm;
1228
1229         u32 expected_throughput;
1230
1231         u64 rx_beacon;
1232         u64 rx_duration;
1233         u8 rx_beacon_signal_avg;
1234         struct cfg80211_tid_stats *pertid;
1235         s8 ack_signal;
1236         s8 avg_ack_signal;
1237 };
1238
1239 #if IS_ENABLED(CONFIG_CFG80211)
1240 /**
1241  * cfg80211_get_station - retrieve information about a given station
1242  * @dev: the device where the station is supposed to be connected to
1243  * @mac_addr: the mac address of the station of interest
1244  * @sinfo: pointer to the structure to fill with the information
1245  *
1246  * Returns 0 on success and sinfo is filled with the available information
1247  * otherwise returns a negative error code and the content of sinfo has to be
1248  * considered undefined.
1249  */
1250 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1251                          struct station_info *sinfo);
1252 #else
1253 static inline int cfg80211_get_station(struct net_device *dev,
1254                                        const u8 *mac_addr,
1255                                        struct station_info *sinfo)
1256 {
1257         return -ENOENT;
1258 }
1259 #endif
1260
1261 /**
1262  * enum monitor_flags - monitor flags
1263  *
1264  * Monitor interface configuration flags. Note that these must be the bits
1265  * according to the nl80211 flags.
1266  *
1267  * @MONITOR_FLAG_CHANGED: set if the flags were changed
1268  * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1269  * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1270  * @MONITOR_FLAG_CONTROL: pass control frames
1271  * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1272  * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1273  * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1274  */
1275 enum monitor_flags {
1276         MONITOR_FLAG_CHANGED            = 1<<__NL80211_MNTR_FLAG_INVALID,
1277         MONITOR_FLAG_FCSFAIL            = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1278         MONITOR_FLAG_PLCPFAIL           = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1279         MONITOR_FLAG_CONTROL            = 1<<NL80211_MNTR_FLAG_CONTROL,
1280         MONITOR_FLAG_OTHER_BSS          = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1281         MONITOR_FLAG_COOK_FRAMES        = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1282         MONITOR_FLAG_ACTIVE             = 1<<NL80211_MNTR_FLAG_ACTIVE,
1283 };
1284
1285 /**
1286  * enum mpath_info_flags -  mesh path information flags
1287  *
1288  * Used by the driver to indicate which info in &struct mpath_info it has filled
1289  * in during get_station() or dump_station().
1290  *
1291  * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1292  * @MPATH_INFO_SN: @sn filled
1293  * @MPATH_INFO_METRIC: @metric filled
1294  * @MPATH_INFO_EXPTIME: @exptime filled
1295  * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1296  * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1297  * @MPATH_INFO_FLAGS: @flags filled
1298  */
1299 enum mpath_info_flags {
1300         MPATH_INFO_FRAME_QLEN           = BIT(0),
1301         MPATH_INFO_SN                   = BIT(1),
1302         MPATH_INFO_METRIC               = BIT(2),
1303         MPATH_INFO_EXPTIME              = BIT(3),
1304         MPATH_INFO_DISCOVERY_TIMEOUT    = BIT(4),
1305         MPATH_INFO_DISCOVERY_RETRIES    = BIT(5),
1306         MPATH_INFO_FLAGS                = BIT(6),
1307 };
1308
1309 /**
1310  * struct mpath_info - mesh path information
1311  *
1312  * Mesh path information filled by driver for get_mpath() and dump_mpath().
1313  *
1314  * @filled: bitfield of flags from &enum mpath_info_flags
1315  * @frame_qlen: number of queued frames for this destination
1316  * @sn: target sequence number
1317  * @metric: metric (cost) of this mesh path
1318  * @exptime: expiration time for the mesh path from now, in msecs
1319  * @flags: mesh path flags
1320  * @discovery_timeout: total mesh path discovery timeout, in msecs
1321  * @discovery_retries: mesh path discovery retries
1322  * @generation: generation number for nl80211 dumps.
1323  *      This number should increase every time the list of mesh paths
1324  *      changes, i.e. when a station is added or removed, so that
1325  *      userspace can tell whether it got a consistent snapshot.
1326  */
1327 struct mpath_info {
1328         u32 filled;
1329         u32 frame_qlen;
1330         u32 sn;
1331         u32 metric;
1332         u32 exptime;
1333         u32 discovery_timeout;
1334         u8 discovery_retries;
1335         u8 flags;
1336
1337         int generation;
1338 };
1339
1340 /**
1341  * struct bss_parameters - BSS parameters
1342  *
1343  * Used to change BSS parameters (mainly for AP mode).
1344  *
1345  * @use_cts_prot: Whether to use CTS protection
1346  *      (0 = no, 1 = yes, -1 = do not change)
1347  * @use_short_preamble: Whether the use of short preambles is allowed
1348  *      (0 = no, 1 = yes, -1 = do not change)
1349  * @use_short_slot_time: Whether the use of short slot time is allowed
1350  *      (0 = no, 1 = yes, -1 = do not change)
1351  * @basic_rates: basic rates in IEEE 802.11 format
1352  *      (or NULL for no change)
1353  * @basic_rates_len: number of basic rates
1354  * @ap_isolate: do not forward packets between connected stations
1355  * @ht_opmode: HT Operation mode
1356  *      (u16 = opmode, -1 = do not change)
1357  * @p2p_ctwindow: P2P CT Window (-1 = no change)
1358  * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1359  */
1360 struct bss_parameters {
1361         int use_cts_prot;
1362         int use_short_preamble;
1363         int use_short_slot_time;
1364         const u8 *basic_rates;
1365         u8 basic_rates_len;
1366         int ap_isolate;
1367         int ht_opmode;
1368         s8 p2p_ctwindow, p2p_opp_ps;
1369 };
1370
1371 /**
1372  * struct mesh_config - 802.11s mesh configuration
1373  *
1374  * These parameters can be changed while the mesh is active.
1375  *
1376  * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1377  *      by the Mesh Peering Open message
1378  * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1379  *      used by the Mesh Peering Open message
1380  * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1381  *      the mesh peering management to close a mesh peering
1382  * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1383  *      mesh interface
1384  * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1385  *      be sent to establish a new peer link instance in a mesh
1386  * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1387  * @element_ttl: the value of TTL field set at a mesh STA for path selection
1388  *      elements
1389  * @auto_open_plinks: whether we should automatically open peer links when we
1390  *      detect compatible mesh peers
1391  * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1392  *      synchronize to for 11s default synchronization method
1393  * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1394  *      that an originator mesh STA can send to a particular path target
1395  * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1396  * @min_discovery_timeout: the minimum length of time to wait until giving up on
1397  *      a path discovery in milliseconds
1398  * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1399  *      receiving a PREQ shall consider the forwarding information from the
1400  *      root to be valid. (TU = time unit)
1401  * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1402  *      which a mesh STA can send only one action frame containing a PREQ
1403  *      element
1404  * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1405  *      which a mesh STA can send only one Action frame containing a PERR
1406  *      element
1407  * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1408  *      it takes for an HWMP information element to propagate across the mesh
1409  * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1410  * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1411  *      announcements are transmitted
1412  * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1413  *      station has access to a broader network beyond the MBSS. (This is
1414  *      missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1415  *      only means that the station will announce others it's a mesh gate, but
1416  *      not necessarily using the gate announcement protocol. Still keeping the
1417  *      same nomenclature to be in sync with the spec)
1418  * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1419  *      entity (default is TRUE - forwarding entity)
1420  * @rssi_threshold: the threshold for average signal strength of candidate
1421  *      station to establish a peer link
1422  * @ht_opmode: mesh HT protection mode
1423  *
1424  * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1425  *      receiving a proactive PREQ shall consider the forwarding information to
1426  *      the root mesh STA to be valid.
1427  *
1428  * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1429  *      PREQs are transmitted.
1430  * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1431  *      during which a mesh STA can send only one Action frame containing
1432  *      a PREQ element for root path confirmation.
1433  * @power_mode: The default mesh power save mode which will be the initial
1434  *      setting for new peer links.
1435  * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1436  *      after transmitting its beacon.
1437  * @plink_timeout: If no tx activity is seen from a STA we've established
1438  *      peering with for longer than this time (in seconds), then remove it
1439  *      from the STA's list of peers.  Default is 30 minutes.
1440  */
1441 struct mesh_config {
1442         u16 dot11MeshRetryTimeout;
1443         u16 dot11MeshConfirmTimeout;
1444         u16 dot11MeshHoldingTimeout;
1445         u16 dot11MeshMaxPeerLinks;
1446         u8 dot11MeshMaxRetries;
1447         u8 dot11MeshTTL;
1448         u8 element_ttl;
1449         bool auto_open_plinks;
1450         u32 dot11MeshNbrOffsetMaxNeighbor;
1451         u8 dot11MeshHWMPmaxPREQretries;
1452         u32 path_refresh_time;
1453         u16 min_discovery_timeout;
1454         u32 dot11MeshHWMPactivePathTimeout;
1455         u16 dot11MeshHWMPpreqMinInterval;
1456         u16 dot11MeshHWMPperrMinInterval;
1457         u16 dot11MeshHWMPnetDiameterTraversalTime;
1458         u8 dot11MeshHWMPRootMode;
1459         u16 dot11MeshHWMPRannInterval;
1460         bool dot11MeshGateAnnouncementProtocol;
1461         bool dot11MeshForwarding;
1462         s32 rssi_threshold;
1463         u16 ht_opmode;
1464         u32 dot11MeshHWMPactivePathToRootTimeout;
1465         u16 dot11MeshHWMProotInterval;
1466         u16 dot11MeshHWMPconfirmationInterval;
1467         enum nl80211_mesh_power_mode power_mode;
1468         u16 dot11MeshAwakeWindowDuration;
1469         u32 plink_timeout;
1470 };
1471
1472 /**
1473  * struct mesh_setup - 802.11s mesh setup configuration
1474  * @chandef: defines the channel to use
1475  * @mesh_id: the mesh ID
1476  * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1477  * @sync_method: which synchronization method to use
1478  * @path_sel_proto: which path selection protocol to use
1479  * @path_metric: which metric to use
1480  * @auth_id: which authentication method this mesh is using
1481  * @ie: vendor information elements (optional)
1482  * @ie_len: length of vendor information elements
1483  * @is_authenticated: this mesh requires authentication
1484  * @is_secure: this mesh uses security
1485  * @user_mpm: userspace handles all MPM functions
1486  * @dtim_period: DTIM period to use
1487  * @beacon_interval: beacon interval to use
1488  * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1489  * @basic_rates: basic rates to use when creating the mesh
1490  * @beacon_rate: bitrate to be used for beacons
1491  * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1492  *      changes the channel when a radar is detected. This is required
1493  *      to operate on DFS channels.
1494  * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1495  *      port frames over NL80211 instead of the network interface.
1496  *
1497  * These parameters are fixed when the mesh is created.
1498  */
1499 struct mesh_setup {
1500         struct cfg80211_chan_def chandef;
1501         const u8 *mesh_id;
1502         u8 mesh_id_len;
1503         u8 sync_method;
1504         u8 path_sel_proto;
1505         u8 path_metric;
1506         u8 auth_id;
1507         const u8 *ie;
1508         u8 ie_len;
1509         bool is_authenticated;
1510         bool is_secure;
1511         bool user_mpm;
1512         u8 dtim_period;
1513         u16 beacon_interval;
1514         int mcast_rate[NUM_NL80211_BANDS];
1515         u32 basic_rates;
1516         struct cfg80211_bitrate_mask beacon_rate;
1517         bool userspace_handles_dfs;
1518         bool control_port_over_nl80211;
1519 };
1520
1521 /**
1522  * struct ocb_setup - 802.11p OCB mode setup configuration
1523  * @chandef: defines the channel to use
1524  *
1525  * These parameters are fixed when connecting to the network
1526  */
1527 struct ocb_setup {
1528         struct cfg80211_chan_def chandef;
1529 };
1530
1531 /**
1532  * struct ieee80211_txq_params - TX queue parameters
1533  * @ac: AC identifier
1534  * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1535  * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1536  *      1..32767]
1537  * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1538  *      1..32767]
1539  * @aifs: Arbitration interframe space [0..255]
1540  */
1541 struct ieee80211_txq_params {
1542         enum nl80211_ac ac;
1543         u16 txop;
1544         u16 cwmin;
1545         u16 cwmax;
1546         u8 aifs;
1547 };
1548
1549 /**
1550  * DOC: Scanning and BSS list handling
1551  *
1552  * The scanning process itself is fairly simple, but cfg80211 offers quite
1553  * a bit of helper functionality. To start a scan, the scan operation will
1554  * be invoked with a scan definition. This scan definition contains the
1555  * channels to scan, and the SSIDs to send probe requests for (including the
1556  * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1557  * probe. Additionally, a scan request may contain extra information elements
1558  * that should be added to the probe request. The IEs are guaranteed to be
1559  * well-formed, and will not exceed the maximum length the driver advertised
1560  * in the wiphy structure.
1561  *
1562  * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1563  * it is responsible for maintaining the BSS list; the driver should not
1564  * maintain a list itself. For this notification, various functions exist.
1565  *
1566  * Since drivers do not maintain a BSS list, there are also a number of
1567  * functions to search for a BSS and obtain information about it from the
1568  * BSS structure cfg80211 maintains. The BSS list is also made available
1569  * to userspace.
1570  */
1571
1572 /**
1573  * struct cfg80211_ssid - SSID description
1574  * @ssid: the SSID
1575  * @ssid_len: length of the ssid
1576  */
1577 struct cfg80211_ssid {
1578         u8 ssid[IEEE80211_MAX_SSID_LEN];
1579         u8 ssid_len;
1580 };
1581
1582 /**
1583  * struct cfg80211_scan_info - information about completed scan
1584  * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1585  *      wireless device that requested the scan is connected to. If this
1586  *      information is not available, this field is left zero.
1587  * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1588  * @aborted: set to true if the scan was aborted for any reason,
1589  *      userspace will be notified of that
1590  */
1591 struct cfg80211_scan_info {
1592         u64 scan_start_tsf;
1593         u8 tsf_bssid[ETH_ALEN] __aligned(2);
1594         bool aborted;
1595 };
1596
1597 /**
1598  * struct cfg80211_scan_request - scan request description
1599  *
1600  * @ssids: SSIDs to scan for (active scan only)
1601  * @n_ssids: number of SSIDs
1602  * @channels: channels to scan on.
1603  * @n_channels: total number of channels to scan
1604  * @scan_width: channel width for scanning
1605  * @ie: optional information element(s) to add into Probe Request or %NULL
1606  * @ie_len: length of ie in octets
1607  * @duration: how long to listen on each channel, in TUs. If
1608  *      %duration_mandatory is not set, this is the maximum dwell time and
1609  *      the actual dwell time may be shorter.
1610  * @duration_mandatory: if set, the scan duration must be as specified by the
1611  *      %duration field.
1612  * @flags: bit field of flags controlling operation
1613  * @rates: bitmap of rates to advertise for each band
1614  * @wiphy: the wiphy this was for
1615  * @scan_start: time (in jiffies) when the scan started
1616  * @wdev: the wireless device to scan for
1617  * @info: (internal) information about completed scan
1618  * @notified: (internal) scan request was notified as done or aborted
1619  * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1620  * @mac_addr: MAC address used with randomisation
1621  * @mac_addr_mask: MAC address mask used with randomisation, bits that
1622  *      are 0 in the mask should be randomised, bits that are 1 should
1623  *      be taken from the @mac_addr
1624  * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
1625  */
1626 struct cfg80211_scan_request {
1627         struct cfg80211_ssid *ssids;
1628         int n_ssids;
1629         u32 n_channels;
1630         enum nl80211_bss_scan_width scan_width;
1631         const u8 *ie;
1632         size_t ie_len;
1633         u16 duration;
1634         bool duration_mandatory;
1635         u32 flags;
1636
1637         u32 rates[NUM_NL80211_BANDS];
1638
1639         struct wireless_dev *wdev;
1640
1641         u8 mac_addr[ETH_ALEN] __aligned(2);
1642         u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1643         u8 bssid[ETH_ALEN] __aligned(2);
1644
1645         /* internal */
1646         struct wiphy *wiphy;
1647         unsigned long scan_start;
1648         struct cfg80211_scan_info info;
1649         bool notified;
1650         bool no_cck;
1651
1652         /* keep last */
1653         struct ieee80211_channel *channels[0];
1654 };
1655
1656 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1657 {
1658         int i;
1659
1660         get_random_bytes(buf, ETH_ALEN);
1661         for (i = 0; i < ETH_ALEN; i++) {
1662                 buf[i] &= ~mask[i];
1663                 buf[i] |= addr[i] & mask[i];
1664         }
1665 }
1666
1667 /**
1668  * struct cfg80211_match_set - sets of attributes to match
1669  *
1670  * @ssid: SSID to be matched; may be zero-length in case of BSSID match
1671  *      or no match (RSSI only)
1672  * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
1673  *      or no match (RSSI only)
1674  * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1675  */
1676 struct cfg80211_match_set {
1677         struct cfg80211_ssid ssid;
1678         u8 bssid[ETH_ALEN];
1679         s32 rssi_thold;
1680 };
1681
1682 /**
1683  * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1684  *
1685  * @interval: interval between scheduled scan iterations. In seconds.
1686  * @iterations: number of scan iterations in this scan plan. Zero means
1687  *      infinite loop.
1688  *      The last scan plan will always have this parameter set to zero,
1689  *      all other scan plans will have a finite number of iterations.
1690  */
1691 struct cfg80211_sched_scan_plan {
1692         u32 interval;
1693         u32 iterations;
1694 };
1695
1696 /**
1697  * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
1698  *
1699  * @band: band of BSS which should match for RSSI level adjustment.
1700  * @delta: value of RSSI level adjustment.
1701  */
1702 struct cfg80211_bss_select_adjust {
1703         enum nl80211_band band;
1704         s8 delta;
1705 };
1706
1707 /**
1708  * struct cfg80211_sched_scan_request - scheduled scan request description
1709  *
1710  * @reqid: identifies this request.
1711  * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1712  * @n_ssids: number of SSIDs
1713  * @n_channels: total number of channels to scan
1714  * @scan_width: channel width for scanning
1715  * @ie: optional information element(s) to add into Probe Request or %NULL
1716  * @ie_len: length of ie in octets
1717  * @flags: bit field of flags controlling operation
1718  * @match_sets: sets of parameters to be matched for a scan result
1719  *      entry to be considered valid and to be passed to the host
1720  *      (others are filtered out).
1721  *      If ommited, all results are passed.
1722  * @n_match_sets: number of match sets
1723  * @report_results: indicates that results were reported for this request
1724  * @wiphy: the wiphy this was for
1725  * @dev: the interface
1726  * @scan_start: start time of the scheduled scan
1727  * @channels: channels to scan
1728  * @min_rssi_thold: for drivers only supporting a single threshold, this
1729  *      contains the minimum over all matchsets
1730  * @mac_addr: MAC address used with randomisation
1731  * @mac_addr_mask: MAC address mask used with randomisation, bits that
1732  *      are 0 in the mask should be randomised, bits that are 1 should
1733  *      be taken from the @mac_addr
1734  * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
1735  *      index must be executed first.
1736  * @n_scan_plans: number of scan plans, at least 1.
1737  * @rcu_head: RCU callback used to free the struct
1738  * @owner_nlportid: netlink portid of owner (if this should is a request
1739  *      owned by a particular socket)
1740  * @nl_owner_dead: netlink owner socket was closed - this request be freed
1741  * @list: for keeping list of requests.
1742  * @delay: delay in seconds to use before starting the first scan
1743  *      cycle.  The driver may ignore this parameter and start
1744  *      immediately (or at any other time), if this feature is not
1745  *      supported.
1746  * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
1747  * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
1748  *      reporting in connected state to cases where a matching BSS is determined
1749  *      to have better or slightly worse RSSI than the current connected BSS.
1750  *      The relative RSSI threshold values are ignored in disconnected state.
1751  * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
1752  *      to the specified band while deciding whether a better BSS is reported
1753  *      using @relative_rssi. If delta is a negative number, the BSSs that
1754  *      belong to the specified band will be penalized by delta dB in relative
1755  *      comparisions.
1756  */
1757 struct cfg80211_sched_scan_request {
1758         u64 reqid;
1759         struct cfg80211_ssid *ssids;
1760         int n_ssids;
1761         u32 n_channels;
1762         enum nl80211_bss_scan_width scan_width;
1763         const u8 *ie;
1764         size_t ie_len;
1765         u32 flags;
1766         struct cfg80211_match_set *match_sets;
1767         int n_match_sets;
1768         s32 min_rssi_thold;
1769         u32 delay;
1770         struct cfg80211_sched_scan_plan *scan_plans;
1771         int n_scan_plans;
1772
1773         u8 mac_addr[ETH_ALEN] __aligned(2);
1774         u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1775
1776         bool relative_rssi_set;
1777         s8 relative_rssi;
1778         struct cfg80211_bss_select_adjust rssi_adjust;
1779
1780         /* internal */
1781         struct wiphy *wiphy;
1782         struct net_device *dev;
1783         unsigned long scan_start;
1784         bool report_results;
1785         struct rcu_head rcu_head;
1786         u32 owner_nlportid;
1787         bool nl_owner_dead;
1788         struct list_head list;
1789
1790         /* keep last */
1791         struct ieee80211_channel *channels[0];
1792 };
1793
1794 /**
1795  * enum cfg80211_signal_type - signal type
1796  *
1797  * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1798  * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1799  * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1800  */
1801 enum cfg80211_signal_type {
1802         CFG80211_SIGNAL_TYPE_NONE,
1803         CFG80211_SIGNAL_TYPE_MBM,
1804         CFG80211_SIGNAL_TYPE_UNSPEC,
1805 };
1806
1807 /**
1808  * struct cfg80211_inform_bss - BSS inform data
1809  * @chan: channel the frame was received on
1810  * @scan_width: scan width that was used
1811  * @signal: signal strength value, according to the wiphy's
1812  *      signal type
1813  * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
1814  *      received; should match the time when the frame was actually
1815  *      received by the device (not just by the host, in case it was
1816  *      buffered on the device) and be accurate to about 10ms.
1817  *      If the frame isn't buffered, just passing the return value of
1818  *      ktime_get_boot_ns() is likely appropriate.
1819  * @parent_tsf: the time at the start of reception of the first octet of the
1820  *      timestamp field of the frame. The time is the TSF of the BSS specified
1821  *      by %parent_bssid.
1822  * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
1823  *      the BSS that requested the scan in which the beacon/probe was received.
1824  * @chains: bitmask for filled values in @chain_signal.
1825  * @chain_signal: per-chain signal strength of last received BSS in dBm.
1826  */
1827 struct cfg80211_inform_bss {
1828         struct ieee80211_channel *chan;
1829         enum nl80211_bss_scan_width scan_width;
1830         s32 signal;
1831         u64 boottime_ns;
1832         u64 parent_tsf;
1833         u8 parent_bssid[ETH_ALEN] __aligned(2);
1834         u8 chains;
1835         s8 chain_signal[IEEE80211_MAX_CHAINS];
1836 };
1837
1838 /**
1839  * struct cfg80211_bss_ies - BSS entry IE data
1840  * @tsf: TSF contained in the frame that carried these IEs
1841  * @rcu_head: internal use, for freeing
1842  * @len: length of the IEs
1843  * @from_beacon: these IEs are known to come from a beacon
1844  * @data: IE data
1845  */
1846 struct cfg80211_bss_ies {
1847         u64 tsf;
1848         struct rcu_head rcu_head;
1849         int len;
1850         bool from_beacon;
1851         u8 data[];
1852 };
1853
1854 /**
1855  * struct cfg80211_bss - BSS description
1856  *
1857  * This structure describes a BSS (which may also be a mesh network)
1858  * for use in scan results and similar.
1859  *
1860  * @channel: channel this BSS is on
1861  * @scan_width: width of the control channel
1862  * @bssid: BSSID of the BSS
1863  * @beacon_interval: the beacon interval as from the frame
1864  * @capability: the capability field in host byte order
1865  * @ies: the information elements (Note that there is no guarantee that these
1866  *      are well-formed!); this is a pointer to either the beacon_ies or
1867  *      proberesp_ies depending on whether Probe Response frame has been
1868  *      received. It is always non-%NULL.
1869  * @beacon_ies: the information elements from the last Beacon frame
1870  *      (implementation note: if @hidden_beacon_bss is set this struct doesn't
1871  *      own the beacon_ies, but they're just pointers to the ones from the
1872  *      @hidden_beacon_bss struct)
1873  * @proberesp_ies: the information elements from the last Probe Response frame
1874  * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1875  *      a BSS that hides the SSID in its beacon, this points to the BSS struct
1876  *      that holds the beacon data. @beacon_ies is still valid, of course, and
1877  *      points to the same data as hidden_beacon_bss->beacon_ies in that case.
1878  * @signal: signal strength value (type depends on the wiphy's signal_type)
1879  * @chains: bitmask for filled values in @chain_signal.
1880  * @chain_signal: per-chain signal strength of last received BSS in dBm.
1881  * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1882  */
1883 struct cfg80211_bss {
1884         struct ieee80211_channel *channel;
1885         enum nl80211_bss_scan_width scan_width;
1886
1887         const struct cfg80211_bss_ies __rcu *ies;
1888         const struct cfg80211_bss_ies __rcu *beacon_ies;
1889         const struct cfg80211_bss_ies __rcu *proberesp_ies;
1890
1891         struct cfg80211_bss *hidden_beacon_bss;
1892
1893         s32 signal;
1894
1895         u16 beacon_interval;
1896         u16 capability;
1897
1898         u8 bssid[ETH_ALEN];
1899         u8 chains;
1900         s8 chain_signal[IEEE80211_MAX_CHAINS];
1901
1902         u8 priv[0] __aligned(sizeof(void *));
1903 };
1904
1905 /**
1906  * ieee80211_bss_get_ie - find IE with given ID
1907  * @bss: the bss to search
1908  * @ie: the IE ID
1909  *
1910  * Note that the return value is an RCU-protected pointer, so
1911  * rcu_read_lock() must be held when calling this function.
1912  * Return: %NULL if not found.
1913  */
1914 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1915
1916
1917 /**
1918  * struct cfg80211_auth_request - Authentication request data
1919  *
1920  * This structure provides information needed to complete IEEE 802.11
1921  * authentication.
1922  *
1923  * @bss: The BSS to authenticate with, the callee must obtain a reference
1924  *      to it if it needs to keep it.
1925  * @auth_type: Authentication type (algorithm)
1926  * @ie: Extra IEs to add to Authentication frame or %NULL
1927  * @ie_len: Length of ie buffer in octets
1928  * @key_len: length of WEP key for shared key authentication
1929  * @key_idx: index of WEP key for shared key authentication
1930  * @key: WEP key for shared key authentication
1931  * @auth_data: Fields and elements in Authentication frames. This contains
1932  *      the authentication frame body (non-IE and IE data), excluding the
1933  *      Authentication algorithm number, i.e., starting at the Authentication
1934  *      transaction sequence number field.
1935  * @auth_data_len: Length of auth_data buffer in octets
1936  */
1937 struct cfg80211_auth_request {
1938         struct cfg80211_bss *bss;
1939         const u8 *ie;
1940         size_t ie_len;
1941         enum nl80211_auth_type auth_type;
1942         const u8 *key;
1943         u8 key_len, key_idx;
1944         const u8 *auth_data;
1945         size_t auth_data_len;
1946 };
1947
1948 /**
1949  * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1950  *
1951  * @ASSOC_REQ_DISABLE_HT:  Disable HT (802.11n)
1952  * @ASSOC_REQ_DISABLE_VHT:  Disable VHT
1953  * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
1954  * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
1955  *      authentication capability. Drivers can offload authentication to
1956  *      userspace if this flag is set. Only applicable for cfg80211_connect()
1957  *      request (connect callback).
1958  */
1959 enum cfg80211_assoc_req_flags {
1960         ASSOC_REQ_DISABLE_HT                    = BIT(0),
1961         ASSOC_REQ_DISABLE_VHT                   = BIT(1),
1962         ASSOC_REQ_USE_RRM                       = BIT(2),
1963         CONNECT_REQ_EXTERNAL_AUTH_SUPPORT       = BIT(3),
1964 };
1965
1966 /**
1967  * struct cfg80211_assoc_request - (Re)Association request data
1968  *
1969  * This structure provides information needed to complete IEEE 802.11
1970  * (re)association.
1971  * @bss: The BSS to associate with. If the call is successful the driver is
1972  *      given a reference that it must give back to cfg80211_send_rx_assoc()
1973  *      or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1974  *      association requests while already associating must be rejected.
1975  * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1976  * @ie_len: Length of ie buffer in octets
1977  * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1978  * @crypto: crypto settings
1979  * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
1980  *      to indicate a request to reassociate within the ESS instead of a request
1981  *      do the initial association with the ESS. When included, this is set to
1982  *      the BSSID of the current association, i.e., to the value that is
1983  *      included in the Current AP address field of the Reassociation Request
1984  *      frame.
1985  * @flags:  See &enum cfg80211_assoc_req_flags
1986  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
1987  *      will be used in ht_capa.  Un-supported values will be ignored.
1988  * @ht_capa_mask:  The bits of ht_capa which are to be used.
1989  * @vht_capa: VHT capability override
1990  * @vht_capa_mask: VHT capability mask indicating which fields to use
1991  * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
1992  *      %NULL if FILS is not used.
1993  * @fils_kek_len: Length of fils_kek in octets
1994  * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
1995  *      Request/Response frame or %NULL if FILS is not used. This field starts
1996  *      with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
1997  */
1998 struct cfg80211_assoc_request {
1999         struct cfg80211_bss *bss;
2000         const u8 *ie, *prev_bssid;
2001         size_t ie_len;
2002         struct cfg80211_crypto_settings crypto;
2003         bool use_mfp;
2004         u32 flags;
2005         struct ieee80211_ht_cap ht_capa;
2006         struct ieee80211_ht_cap ht_capa_mask;
2007         struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2008         const u8 *fils_kek;
2009         size_t fils_kek_len;
2010         const u8 *fils_nonces;
2011 };
2012
2013 /**
2014  * struct cfg80211_deauth_request - Deauthentication request data
2015  *
2016  * This structure provides information needed to complete IEEE 802.11
2017  * deauthentication.
2018  *
2019  * @bssid: the BSSID of the BSS to deauthenticate from
2020  * @ie: Extra IEs to add to Deauthentication frame or %NULL
2021  * @ie_len: Length of ie buffer in octets
2022  * @reason_code: The reason code for the deauthentication
2023  * @local_state_change: if set, change local state only and
2024  *      do not set a deauth frame
2025  */
2026 struct cfg80211_deauth_request {
2027         const u8 *bssid;
2028         const u8 *ie;
2029         size_t ie_len;
2030         u16 reason_code;
2031         bool local_state_change;
2032 };
2033
2034 /**
2035  * struct cfg80211_disassoc_request - Disassociation request data
2036  *
2037  * This structure provides information needed to complete IEEE 802.11
2038  * disassociation.
2039  *
2040  * @bss: the BSS to disassociate from
2041  * @ie: Extra IEs to add to Disassociation frame or %NULL
2042  * @ie_len: Length of ie buffer in octets
2043  * @reason_code: The reason code for the disassociation
2044  * @local_state_change: This is a request for a local state only, i.e., no
2045  *      Disassociation frame is to be transmitted.
2046  */
2047 struct cfg80211_disassoc_request {
2048         struct cfg80211_bss *bss;
2049         const u8 *ie;
2050         size_t ie_len;
2051         u16 reason_code;
2052         bool local_state_change;
2053 };
2054
2055 /**
2056  * struct cfg80211_ibss_params - IBSS parameters
2057  *
2058  * This structure defines the IBSS parameters for the join_ibss()
2059  * method.
2060  *
2061  * @ssid: The SSID, will always be non-null.
2062  * @ssid_len: The length of the SSID, will always be non-zero.
2063  * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2064  *      search for IBSSs with a different BSSID.
2065  * @chandef: defines the channel to use if no other IBSS to join can be found
2066  * @channel_fixed: The channel should be fixed -- do not search for
2067  *      IBSSs to join on other channels.
2068  * @ie: information element(s) to include in the beacon
2069  * @ie_len: length of that
2070  * @beacon_interval: beacon interval to use
2071  * @privacy: this is a protected network, keys will be configured
2072  *      after joining
2073  * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2074  *      sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2075  *      required to assume that the port is unauthorized until authorized by
2076  *      user space. Otherwise, port is marked authorized by default.
2077  * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2078  *      port frames over NL80211 instead of the network interface.
2079  * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2080  *      changes the channel when a radar is detected. This is required
2081  *      to operate on DFS channels.
2082  * @basic_rates: bitmap of basic rates to use when creating the IBSS
2083  * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2084  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
2085  *      will be used in ht_capa.  Un-supported values will be ignored.
2086  * @ht_capa_mask:  The bits of ht_capa which are to be used.
2087  * @wep_keys: static WEP keys, if not NULL points to an array of
2088  *      CFG80211_MAX_WEP_KEYS WEP keys
2089  * @wep_tx_key: key index (0..3) of the default TX static WEP key
2090  */
2091 struct cfg80211_ibss_params {
2092         const u8 *ssid;
2093         const u8 *bssid;
2094         struct cfg80211_chan_def chandef;
2095         const u8 *ie;
2096         u8 ssid_len, ie_len;
2097         u16 beacon_interval;
2098         u32 basic_rates;
2099         bool channel_fixed;
2100         bool privacy;
2101         bool control_port;
2102         bool control_port_over_nl80211;
2103         bool userspace_handles_dfs;
2104         int mcast_rate[NUM_NL80211_BANDS];
2105         struct ieee80211_ht_cap ht_capa;
2106         struct ieee80211_ht_cap ht_capa_mask;
2107         struct key_params *wep_keys;
2108         int wep_tx_key;
2109 };
2110
2111 /**
2112  * struct cfg80211_bss_selection - connection parameters for BSS selection.
2113  *
2114  * @behaviour: requested BSS selection behaviour.
2115  * @param: parameters for requestion behaviour.
2116  * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2117  * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2118  */
2119 struct cfg80211_bss_selection {
2120         enum nl80211_bss_select_attr behaviour;
2121         union {
2122                 enum nl80211_band band_pref;
2123                 struct cfg80211_bss_select_adjust adjust;
2124         } param;
2125 };
2126
2127 /**
2128  * struct cfg80211_connect_params - Connection parameters
2129  *
2130  * This structure provides information needed to complete IEEE 802.11
2131  * authentication and association.
2132  *
2133  * @channel: The channel to use or %NULL if not specified (auto-select based
2134  *      on scan results)
2135  * @channel_hint: The channel of the recommended BSS for initial connection or
2136  *      %NULL if not specified
2137  * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2138  *      results)
2139  * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2140  *      %NULL if not specified. Unlike the @bssid parameter, the driver is
2141  *      allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2142  *      to use.
2143  * @ssid: SSID
2144  * @ssid_len: Length of ssid in octets
2145  * @auth_type: Authentication type (algorithm)
2146  * @ie: IEs for association request
2147  * @ie_len: Length of assoc_ie in octets
2148  * @privacy: indicates whether privacy-enabled APs should be used
2149  * @mfp: indicate whether management frame protection is used
2150  * @crypto: crypto settings
2151  * @key_len: length of WEP key for shared key authentication
2152  * @key_idx: index of WEP key for shared key authentication
2153  * @key: WEP key for shared key authentication
2154  * @flags:  See &enum cfg80211_assoc_req_flags
2155  * @bg_scan_period:  Background scan period in seconds
2156  *      or -1 to indicate that default value is to be used.
2157  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
2158  *      will be used in ht_capa.  Un-supported values will be ignored.
2159  * @ht_capa_mask:  The bits of ht_capa which are to be used.
2160  * @vht_capa:  VHT Capability overrides
2161  * @vht_capa_mask: The bits of vht_capa which are to be used.
2162  * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2163  *      networks.
2164  * @bss_select: criteria to be used for BSS selection.
2165  * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2166  *      to indicate a request to reassociate within the ESS instead of a request
2167  *      do the initial association with the ESS. When included, this is set to
2168  *      the BSSID of the current association, i.e., to the value that is
2169  *      included in the Current AP address field of the Reassociation Request
2170  *      frame.
2171  * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2172  *      NAI or %NULL if not specified. This is used to construct FILS wrapped
2173  *      data IE.
2174  * @fils_erp_username_len: Length of @fils_erp_username in octets.
2175  * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2176  *      %NULL if not specified. This specifies the domain name of ER server and
2177  *      is used to construct FILS wrapped data IE.
2178  * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2179  * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2180  *      messages. This is also used to construct FILS wrapped data IE.
2181  * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2182  *      keys in FILS or %NULL if not specified.
2183  * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2184  * @want_1x: indicates user-space supports and wants to use 802.1X driver
2185  *      offload of 4-way handshake.
2186  */
2187 struct cfg80211_connect_params {
2188         struct ieee80211_channel *channel;
2189         struct ieee80211_channel *channel_hint;
2190         const u8 *bssid;
2191         const u8 *bssid_hint;
2192         const u8 *ssid;
2193         size_t ssid_len;
2194         enum nl80211_auth_type auth_type;
2195         const u8 *ie;
2196         size_t ie_len;
2197         bool privacy;
2198         enum nl80211_mfp mfp;
2199         struct cfg80211_crypto_settings crypto;
2200         const u8 *key;
2201         u8 key_len, key_idx;
2202         u32 flags;
2203         int bg_scan_period;
2204         struct ieee80211_ht_cap ht_capa;
2205         struct ieee80211_ht_cap ht_capa_mask;
2206         struct ieee80211_vht_cap vht_capa;
2207         struct ieee80211_vht_cap vht_capa_mask;
2208         bool pbss;
2209         struct cfg80211_bss_selection bss_select;
2210         const u8 *prev_bssid;
2211         const u8 *fils_erp_username;
2212         size_t fils_erp_username_len;
2213         const u8 *fils_erp_realm;
2214         size_t fils_erp_realm_len;
2215         u16 fils_erp_next_seq_num;
2216         const u8 *fils_erp_rrk;
2217         size_t fils_erp_rrk_len;
2218         bool want_1x;
2219 };
2220
2221 /**
2222  * enum cfg80211_connect_params_changed - Connection parameters being updated
2223  *
2224  * This enum provides information of all connect parameters that
2225  * have to be updated as part of update_connect_params() call.
2226  *
2227  * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2228  * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
2229  *      username, erp sequence number and rrk) are updated
2230  * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
2231  */
2232 enum cfg80211_connect_params_changed {
2233         UPDATE_ASSOC_IES                = BIT(0),
2234         UPDATE_FILS_ERP_INFO            = BIT(1),
2235         UPDATE_AUTH_TYPE                = BIT(2),
2236 };
2237
2238 /**
2239  * enum wiphy_params_flags - set_wiphy_params bitfield values
2240  * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2241  * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2242  * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2243  * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2244  * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2245  * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2246  * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
2247  * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
2248  * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
2249  */
2250 enum wiphy_params_flags {
2251         WIPHY_PARAM_RETRY_SHORT         = 1 << 0,
2252         WIPHY_PARAM_RETRY_LONG          = 1 << 1,
2253         WIPHY_PARAM_FRAG_THRESHOLD      = 1 << 2,
2254         WIPHY_PARAM_RTS_THRESHOLD       = 1 << 3,
2255         WIPHY_PARAM_COVERAGE_CLASS      = 1 << 4,
2256         WIPHY_PARAM_DYN_ACK             = 1 << 5,
2257         WIPHY_PARAM_TXQ_LIMIT           = 1 << 6,
2258         WIPHY_PARAM_TXQ_MEMORY_LIMIT    = 1 << 7,
2259         WIPHY_PARAM_TXQ_QUANTUM         = 1 << 8,
2260 };
2261
2262 /**
2263  * struct cfg80211_pmksa - PMK Security Association
2264  *
2265  * This structure is passed to the set/del_pmksa() method for PMKSA
2266  * caching.
2267  *
2268  * @bssid: The AP's BSSID (may be %NULL).
2269  * @pmkid: The identifier to refer a PMKSA.
2270  * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2271  *      derivation by a FILS STA. Otherwise, %NULL.
2272  * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2273  *      the hash algorithm used to generate this.
2274  * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2275  *      cache identifier (may be %NULL).
2276  * @ssid_len: Length of the @ssid in octets.
2277  * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2278  *      scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2279  *      %NULL).
2280  */
2281 struct cfg80211_pmksa {
2282         const u8 *bssid;
2283         const u8 *pmkid;
2284         const u8 *pmk;
2285         size_t pmk_len;
2286         const u8 *ssid;
2287         size_t ssid_len;
2288         const u8 *cache_id;
2289 };
2290
2291 /**
2292  * struct cfg80211_pkt_pattern - packet pattern
2293  * @mask: bitmask where to match pattern and where to ignore bytes,
2294  *      one bit per byte, in same format as nl80211
2295  * @pattern: bytes to match where bitmask is 1
2296  * @pattern_len: length of pattern (in bytes)
2297  * @pkt_offset: packet offset (in bytes)
2298  *
2299  * Internal note: @mask and @pattern are allocated in one chunk of
2300  * memory, free @mask only!
2301  */
2302 struct cfg80211_pkt_pattern {
2303         const u8 *mask, *pattern;
2304         int pattern_len;
2305         int pkt_offset;
2306 };
2307
2308 /**
2309  * struct cfg80211_wowlan_tcp - TCP connection parameters
2310  *
2311  * @sock: (internal) socket for source port allocation
2312  * @src: source IP address
2313  * @dst: destination IP address
2314  * @dst_mac: destination MAC address
2315  * @src_port: source port
2316  * @dst_port: destination port
2317  * @payload_len: data payload length
2318  * @payload: data payload buffer
2319  * @payload_seq: payload sequence stamping configuration
2320  * @data_interval: interval at which to send data packets
2321  * @wake_len: wakeup payload match length
2322  * @wake_data: wakeup payload match data
2323  * @wake_mask: wakeup payload match mask
2324  * @tokens_size: length of the tokens buffer
2325  * @payload_tok: payload token usage configuration
2326  */
2327 struct cfg80211_wowlan_tcp {
2328         struct socket *sock;
2329         __be32 src, dst;
2330         u16 src_port, dst_port;
2331         u8 dst_mac[ETH_ALEN];
2332         int payload_len;
2333         const u8 *payload;
2334         struct nl80211_wowlan_tcp_data_seq payload_seq;
2335         u32 data_interval;
2336         u32 wake_len;
2337         const u8 *wake_data, *wake_mask;
2338         u32 tokens_size;
2339         /* must be last, variable member */
2340         struct nl80211_wowlan_tcp_data_token payload_tok;
2341 };
2342
2343 /**
2344  * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2345  *
2346  * This structure defines the enabled WoWLAN triggers for the device.
2347  * @any: wake up on any activity -- special trigger if device continues
2348  *      operating as normal during suspend
2349  * @disconnect: wake up if getting disconnected
2350  * @magic_pkt: wake up on receiving magic packet
2351  * @patterns: wake up on receiving packet matching a pattern
2352  * @n_patterns: number of patterns
2353  * @gtk_rekey_failure: wake up on GTK rekey failure
2354  * @eap_identity_req: wake up on EAP identity request packet
2355  * @four_way_handshake: wake up on 4-way handshake
2356  * @rfkill_release: wake up when rfkill is released
2357  * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2358  *      NULL if not configured.
2359  * @nd_config: configuration for the scan to be used for net detect wake.
2360  */
2361 struct cfg80211_wowlan {
2362         bool any, disconnect, magic_pkt, gtk_rekey_failure,
2363              eap_identity_req, four_way_handshake,
2364              rfkill_release;
2365         struct cfg80211_pkt_pattern *patterns;
2366         struct cfg80211_wowlan_tcp *tcp;
2367         int n_patterns;
2368         struct cfg80211_sched_scan_request *nd_config;
2369 };
2370
2371 /**
2372  * struct cfg80211_coalesce_rules - Coalesce rule parameters
2373  *
2374  * This structure defines coalesce rule for the device.
2375  * @delay: maximum coalescing delay in msecs.
2376  * @condition: condition for packet coalescence.
2377  *      see &enum nl80211_coalesce_condition.
2378  * @patterns: array of packet patterns
2379  * @n_patterns: number of patterns
2380  */
2381 struct cfg80211_coalesce_rules {
2382         int delay;
2383         enum nl80211_coalesce_condition condition;
2384         struct cfg80211_pkt_pattern *patterns;
2385         int n_patterns;
2386 };
2387
2388 /**
2389  * struct cfg80211_coalesce - Packet coalescing settings
2390  *
2391  * This structure defines coalescing settings.
2392  * @rules: array of coalesce rules
2393  * @n_rules: number of rules
2394  */
2395 struct cfg80211_coalesce {
2396         struct cfg80211_coalesce_rules *rules;
2397         int n_rules;
2398 };
2399
2400 /**
2401  * struct cfg80211_wowlan_nd_match - information about the match
2402  *
2403  * @ssid: SSID of the match that triggered the wake up
2404  * @n_channels: Number of channels where the match occurred.  This
2405  *      value may be zero if the driver can't report the channels.
2406  * @channels: center frequencies of the channels where a match
2407  *      occurred (in MHz)
2408  */
2409 struct cfg80211_wowlan_nd_match {
2410         struct cfg80211_ssid ssid;
2411         int n_channels;
2412         u32 channels[];
2413 };
2414
2415 /**
2416  * struct cfg80211_wowlan_nd_info - net detect wake up information
2417  *
2418  * @n_matches: Number of match information instances provided in
2419  *      @matches.  This value may be zero if the driver can't provide
2420  *      match information.
2421  * @matches: Array of pointers to matches containing information about
2422  *      the matches that triggered the wake up.
2423  */
2424 struct cfg80211_wowlan_nd_info {
2425         int n_matches;
2426         struct cfg80211_wowlan_nd_match *matches[];
2427 };
2428
2429 /**
2430  * struct cfg80211_wowlan_wakeup - wakeup report
2431  * @disconnect: woke up by getting disconnected
2432  * @magic_pkt: woke up by receiving magic packet
2433  * @gtk_rekey_failure: woke up by GTK rekey failure
2434  * @eap_identity_req: woke up by EAP identity request packet
2435  * @four_way_handshake: woke up by 4-way handshake
2436  * @rfkill_release: woke up by rfkill being released
2437  * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2438  * @packet_present_len: copied wakeup packet data
2439  * @packet_len: original wakeup packet length
2440  * @packet: The packet causing the wakeup, if any.
2441  * @packet_80211:  For pattern match, magic packet and other data
2442  *      frame triggers an 802.3 frame should be reported, for
2443  *      disconnect due to deauth 802.11 frame. This indicates which
2444  *      it is.
2445  * @tcp_match: TCP wakeup packet received
2446  * @tcp_connlost: TCP connection lost or failed to establish
2447  * @tcp_nomoretokens: TCP data ran out of tokens
2448  * @net_detect: if not %NULL, woke up because of net detect
2449  */
2450 struct cfg80211_wowlan_wakeup {
2451         bool disconnect, magic_pkt, gtk_rekey_failure,
2452              eap_identity_req, four_way_handshake,
2453              rfkill_release, packet_80211,
2454              tcp_match, tcp_connlost, tcp_nomoretokens;
2455         s32 pattern_idx;
2456         u32 packet_present_len, packet_len;
2457         const void *packet;
2458         struct cfg80211_wowlan_nd_info *net_detect;
2459 };
2460
2461 /**
2462  * struct cfg80211_gtk_rekey_data - rekey data
2463  * @kek: key encryption key (NL80211_KEK_LEN bytes)
2464  * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2465  * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2466  */
2467 struct cfg80211_gtk_rekey_data {
2468         const u8 *kek, *kck, *replay_ctr;
2469 };
2470
2471 /**
2472  * struct cfg80211_update_ft_ies_params - FT IE Information
2473  *
2474  * This structure provides information needed to update the fast transition IE
2475  *
2476  * @md: The Mobility Domain ID, 2 Octet value
2477  * @ie: Fast Transition IEs
2478  * @ie_len: Length of ft_ie in octets
2479  */
2480 struct cfg80211_update_ft_ies_params {
2481         u16 md;
2482         const u8 *ie;
2483         size_t ie_len;
2484 };
2485
2486 /**
2487  * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2488  *
2489  * This structure provides information needed to transmit a mgmt frame
2490  *
2491  * @chan: channel to use
2492  * @offchan: indicates wether off channel operation is required
2493  * @wait: duration for ROC
2494  * @buf: buffer to transmit
2495  * @len: buffer length
2496  * @no_cck: don't use cck rates for this frame
2497  * @dont_wait_for_ack: tells the low level not to wait for an ack
2498  * @n_csa_offsets: length of csa_offsets array
2499  * @csa_offsets: array of all the csa offsets in the frame
2500  */
2501 struct cfg80211_mgmt_tx_params {
2502         struct ieee80211_channel *chan;
2503         bool offchan;
2504         unsigned int wait;
2505         const u8 *buf;
2506         size_t len;
2507         bool no_cck;
2508         bool dont_wait_for_ack;
2509         int n_csa_offsets;
2510         const u16 *csa_offsets;
2511 };
2512
2513 /**
2514  * struct cfg80211_dscp_exception - DSCP exception
2515  *
2516  * @dscp: DSCP value that does not adhere to the user priority range definition
2517  * @up: user priority value to which the corresponding DSCP value belongs
2518  */
2519 struct cfg80211_dscp_exception {
2520         u8 dscp;
2521         u8 up;
2522 };
2523
2524 /**
2525  * struct cfg80211_dscp_range - DSCP range definition for user priority
2526  *
2527  * @low: lowest DSCP value of this user priority range, inclusive
2528  * @high: highest DSCP value of this user priority range, inclusive
2529  */
2530 struct cfg80211_dscp_range {
2531         u8 low;
2532         u8 high;
2533 };
2534
2535 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2536 #define IEEE80211_QOS_MAP_MAX_EX        21
2537 #define IEEE80211_QOS_MAP_LEN_MIN       16
2538 #define IEEE80211_QOS_MAP_LEN_MAX \
2539         (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2540
2541 /**
2542  * struct cfg80211_qos_map - QoS Map Information
2543  *
2544  * This struct defines the Interworking QoS map setting for DSCP values
2545  *
2546  * @num_des: number of DSCP exceptions (0..21)
2547  * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2548  *      the user priority DSCP range definition
2549  * @up: DSCP range definition for a particular user priority
2550  */
2551 struct cfg80211_qos_map {
2552         u8 num_des;
2553         struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2554         struct cfg80211_dscp_range up[8];
2555 };
2556
2557 /**
2558  * struct cfg80211_nan_conf - NAN configuration
2559  *
2560  * This struct defines NAN configuration parameters
2561  *
2562  * @master_pref: master preference (1 - 255)
2563  * @bands: operating bands, a bitmap of &enum nl80211_band values.
2564  *      For instance, for NL80211_BAND_2GHZ, bit 0 would be set
2565  *      (i.e. BIT(NL80211_BAND_2GHZ)).
2566  */
2567 struct cfg80211_nan_conf {
2568         u8 master_pref;
2569         u8 bands;
2570 };
2571
2572 /**
2573  * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
2574  * configuration
2575  *
2576  * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
2577  * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
2578  */
2579 enum cfg80211_nan_conf_changes {
2580         CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
2581         CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
2582 };
2583
2584 /**
2585  * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
2586  *
2587  * @filter: the content of the filter
2588  * @len: the length of the filter
2589  */
2590 struct cfg80211_nan_func_filter {
2591         const u8 *filter;
2592         u8 len;
2593 };
2594
2595 /**
2596  * struct cfg80211_nan_func - a NAN function
2597  *
2598  * @type: &enum nl80211_nan_function_type
2599  * @service_id: the service ID of the function
2600  * @publish_type: &nl80211_nan_publish_type
2601  * @close_range: if true, the range should be limited. Threshold is
2602  *      implementation specific.
2603  * @publish_bcast: if true, the solicited publish should be broadcasted
2604  * @subscribe_active: if true, the subscribe is active
2605  * @followup_id: the instance ID for follow up
2606  * @followup_reqid: the requestor instance ID for follow up
2607  * @followup_dest: MAC address of the recipient of the follow up
2608  * @ttl: time to live counter in DW.
2609  * @serv_spec_info: Service Specific Info
2610  * @serv_spec_info_len: Service Specific Info length
2611  * @srf_include: if true, SRF is inclusive
2612  * @srf_bf: Bloom Filter
2613  * @srf_bf_len: Bloom Filter length
2614  * @srf_bf_idx: Bloom Filter index
2615  * @srf_macs: SRF MAC addresses
2616  * @srf_num_macs: number of MAC addresses in SRF
2617  * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
2618  * @tx_filters: filters that should be transmitted in the SDF.
2619  * @num_rx_filters: length of &rx_filters.
2620  * @num_tx_filters: length of &tx_filters.
2621  * @instance_id: driver allocated id of the function.
2622  * @cookie: unique NAN function identifier.
2623  */
2624 struct cfg80211_nan_func {
2625         enum nl80211_nan_function_type type;
2626         u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
2627         u8 publish_type;
2628         bool close_range;
2629         bool publish_bcast;
2630         bool subscribe_active;
2631         u8 followup_id;
2632         u8 followup_reqid;
2633         struct mac_address followup_dest;
2634         u32 ttl;
2635         const u8 *serv_spec_info;
2636         u8 serv_spec_info_len;
2637         bool srf_include;
2638         const u8 *srf_bf;
2639         u8 srf_bf_len;
2640         u8 srf_bf_idx;
2641         struct mac_address *srf_macs;
2642         int srf_num_macs;
2643         struct cfg80211_nan_func_filter *rx_filters;
2644         struct cfg80211_nan_func_filter *tx_filters;
2645         u8 num_tx_filters;
2646         u8 num_rx_filters;
2647         u8 instance_id;
2648         u64 cookie;
2649 };
2650
2651 /**
2652  * struct cfg80211_pmk_conf - PMK configuration
2653  *
2654  * @aa: authenticator address
2655  * @pmk_len: PMK length in bytes.
2656  * @pmk: the PMK material
2657  * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
2658  *      is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
2659  *      holds PMK-R0.
2660  */
2661 struct cfg80211_pmk_conf {
2662         const u8 *aa;
2663         u8 pmk_len;
2664         const u8 *pmk;
2665         const u8 *pmk_r0_name;
2666 };
2667
2668 /**
2669  * struct cfg80211_external_auth_params - Trigger External authentication.
2670  *
2671  * Commonly used across the external auth request and event interfaces.
2672  *
2673  * @action: action type / trigger for external authentication. Only significant
2674  *      for the authentication request event interface (driver to user space).
2675  * @bssid: BSSID of the peer with which the authentication has
2676  *      to happen. Used by both the authentication request event and
2677  *      authentication response command interface.
2678  * @ssid: SSID of the AP.  Used by both the authentication request event and
2679  *      authentication response command interface.
2680  * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
2681  *      authentication request event interface.
2682  * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
2683  *      use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
2684  *      the real status code for failures. Used only for the authentication
2685  *      response command interface (user space to driver).
2686  */
2687 struct cfg80211_external_auth_params {
2688         enum nl80211_external_auth_action action;
2689         u8 bssid[ETH_ALEN] __aligned(2);
2690         struct cfg80211_ssid ssid;
2691         unsigned int key_mgmt_suite;
2692         u16 status;
2693 };
2694
2695 /**
2696  * struct cfg80211_ops - backend description for wireless configuration
2697  *
2698  * This struct is registered by fullmac card drivers and/or wireless stacks
2699  * in order to handle configuration requests on their interfaces.
2700  *
2701  * All callbacks except where otherwise noted should return 0
2702  * on success or a negative error code.
2703  *
2704  * All operations are currently invoked under rtnl for consistency with the
2705  * wireless extensions but this is subject to reevaluation as soon as this
2706  * code is used more widely and we have a first user without wext.
2707  *
2708  * @suspend: wiphy device needs to be suspended. The variable @wow will
2709  *      be %NULL or contain the enabled Wake-on-Wireless triggers that are
2710  *      configured for the device.
2711  * @resume: wiphy device needs to be resumed
2712  * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2713  *      to call device_set_wakeup_enable() to enable/disable wakeup from
2714  *      the device.
2715  *
2716  * @add_virtual_intf: create a new virtual interface with the given name,
2717  *      must set the struct wireless_dev's iftype. Beware: You must create
2718  *      the new netdev in the wiphy's network namespace! Returns the struct
2719  *      wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2720  *      also set the address member in the wdev.
2721  *
2722  * @del_virtual_intf: remove the virtual interface
2723  *
2724  * @change_virtual_intf: change type/configuration of virtual interface,
2725  *      keep the struct wireless_dev's iftype updated.
2726  *
2727  * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2728  *      when adding a group key.
2729  *
2730  * @get_key: get information about the key with the given parameters.
2731  *      @mac_addr will be %NULL when requesting information for a group
2732  *      key. All pointers given to the @callback function need not be valid
2733  *      after it returns. This function should return an error if it is
2734  *      not possible to retrieve the key, -ENOENT if it doesn't exist.
2735  *
2736  * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2737  *      and @key_index, return -ENOENT if the key doesn't exist.
2738  *
2739  * @set_default_key: set the default key on an interface
2740  *
2741  * @set_default_mgmt_key: set the default management frame key on an interface
2742  *
2743  * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2744  *
2745  * @start_ap: Start acting in AP mode defined by the parameters.
2746  * @change_beacon: Change the beacon parameters for an access point mode
2747  *      interface. This should reject the call when AP mode wasn't started.
2748  * @stop_ap: Stop being an AP, including stopping beaconing.
2749  *
2750  * @add_station: Add a new station.
2751  * @del_station: Remove a station
2752  * @change_station: Modify a given station. Note that flags changes are not much
2753  *      validated in cfg80211, in particular the auth/assoc/authorized flags
2754  *      might come to the driver in invalid combinations -- make sure to check
2755  *      them, also against the existing state! Drivers must call
2756  *      cfg80211_check_station_change() to validate the information.
2757  * @get_station: get station information for the station identified by @mac
2758  * @dump_station: dump station callback -- resume dump at index @idx
2759  *
2760  * @add_mpath: add a fixed mesh path
2761  * @del_mpath: delete a given mesh path
2762  * @change_mpath: change a given mesh path
2763  * @get_mpath: get a mesh path for the given parameters
2764  * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2765  * @get_mpp: get a mesh proxy path for the given parameters
2766  * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
2767  * @join_mesh: join the mesh network with the specified parameters
2768  *      (invoked with the wireless_dev mutex held)
2769  * @leave_mesh: leave the current mesh network
2770  *      (invoked with the wireless_dev mutex held)
2771  *
2772  * @get_mesh_config: Get the current mesh configuration
2773  *
2774  * @update_mesh_config: Update mesh parameters on a running mesh.
2775  *      The mask is a bitfield which tells us which parameters to
2776  *      set, and which to leave alone.
2777  *
2778  * @change_bss: Modify parameters for a given BSS.
2779  *
2780  * @set_txq_params: Set TX queue parameters
2781  *
2782  * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2783  *      as it doesn't implement join_mesh and needs to set the channel to
2784  *      join the mesh instead.
2785  *
2786  * @set_monitor_channel: Set the monitor mode channel for the device. If other
2787  *      interfaces are active this callback should reject the configuration.
2788  *      If no interfaces are active or the device is down, the channel should
2789  *      be stored for when a monitor interface becomes active.
2790  *
2791  * @scan: Request to do a scan. If returning zero, the scan request is given
2792  *      the driver, and will be valid until passed to cfg80211_scan_done().
2793  *      For scan results, call cfg80211_inform_bss(); you can call this outside
2794  *      the scan/scan_done bracket too.
2795  * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
2796  *      indicate the status of the scan through cfg80211_scan_done().
2797  *
2798  * @auth: Request to authenticate with the specified peer
2799  *      (invoked with the wireless_dev mutex held)
2800  * @assoc: Request to (re)associate with the specified peer
2801  *      (invoked with the wireless_dev mutex held)
2802  * @deauth: Request to deauthenticate from the specified peer
2803  *      (invoked with the wireless_dev mutex held)
2804  * @disassoc: Request to disassociate from the specified peer
2805  *      (invoked with the wireless_dev mutex held)
2806  *
2807  * @connect: Connect to the ESS with the specified parameters. When connected,
2808  *      call cfg80211_connect_result()/cfg80211_connect_bss() with status code
2809  *      %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
2810  *      cfg80211_connect_result()/cfg80211_connect_bss() with the status code
2811  *      from the AP or cfg80211_connect_timeout() if no frame with status code
2812  *      was received.
2813  *      The driver is allowed to roam to other BSSes within the ESS when the
2814  *      other BSS matches the connect parameters. When such roaming is initiated
2815  *      by the driver, the driver is expected to verify that the target matches
2816  *      the configured security parameters and to use Reassociation Request
2817  *      frame instead of Association Request frame.
2818  *      The connect function can also be used to request the driver to perform a
2819  *      specific roam when connected to an ESS. In that case, the prev_bssid
2820  *      parameter is set to the BSSID of the currently associated BSS as an
2821  *      indication of requesting reassociation.
2822  *      In both the driver-initiated and new connect() call initiated roaming
2823  *      cases, the result of roaming is indicated with a call to
2824  *      cfg80211_roamed(). (invoked with the wireless_dev mutex held)
2825  * @update_connect_params: Update the connect parameters while connected to a
2826  *      BSS. The updated parameters can be used by driver/firmware for
2827  *      subsequent BSS selection (roaming) decisions and to form the
2828  *      Authentication/(Re)Association Request frames. This call does not
2829  *      request an immediate disassociation or reassociation with the current
2830  *      BSS, i.e., this impacts only subsequent (re)associations. The bits in
2831  *      changed are defined in &enum cfg80211_connect_params_changed.
2832  *      (invoked with the wireless_dev mutex held)
2833  * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
2834  *      connection is in progress. Once done, call cfg80211_disconnected() in
2835  *      case connection was already established (invoked with the
2836  *      wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
2837  *
2838  * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2839  *      cfg80211_ibss_joined(), also call that function when changing BSSID due
2840  *      to a merge.
2841  *      (invoked with the wireless_dev mutex held)
2842  * @leave_ibss: Leave the IBSS.
2843  *      (invoked with the wireless_dev mutex held)
2844  *
2845  * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2846  *      MESH mode)
2847  *
2848  * @set_wiphy_params: Notify that wiphy parameters have changed;
2849  *      @changed bitfield (see &enum wiphy_params_flags) describes which values
2850  *      have changed. The actual parameter values are available in
2851  *      struct wiphy. If returning an error, no value should be changed.
2852  *
2853  * @set_tx_power: set the transmit power according to the parameters,
2854  *      the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2855  *      wdev may be %NULL if power was set for the wiphy, and will
2856  *      always be %NULL unless the driver supports per-vif TX power
2857  *      (as advertised by the nl80211 feature flag.)
2858  * @get_tx_power: store the current TX power into the dbm variable;
2859  *      return 0 if successful
2860  *
2861  * @set_wds_peer: set the WDS peer for a WDS interface
2862  *
2863  * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2864  *      functions to adjust rfkill hw state
2865  *
2866  * @dump_survey: get site survey information.
2867  *
2868  * @remain_on_channel: Request the driver to remain awake on the specified
2869  *      channel for the specified duration to complete an off-channel
2870  *      operation (e.g., public action frame exchange). When the driver is
2871  *      ready on the requested channel, it must indicate this with an event
2872  *      notification by calling cfg80211_ready_on_channel().
2873  * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2874  *      This allows the operation to be terminated prior to timeout based on
2875  *      the duration value.
2876  * @mgmt_tx: Transmit a management frame.
2877  * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2878  *      frame on another channel
2879  *
2880  * @testmode_cmd: run a test mode command; @wdev may be %NULL
2881  * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2882  *      used by the function, but 0 and 1 must not be touched. Additionally,
2883  *      return error codes other than -ENOBUFS and -ENOENT will terminate the
2884  *      dump and return to userspace with an error, so be careful. If any data
2885  *      was passed in from userspace then the data/len arguments will be present
2886  *      and point to the data contained in %NL80211_ATTR_TESTDATA.
2887  *
2888  * @set_bitrate_mask: set the bitrate mask configuration
2889  *
2890  * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2891  *      devices running firmwares capable of generating the (re) association
2892  *      RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2893  * @del_pmksa: Delete a cached PMKID.
2894  * @flush_pmksa: Flush all cached PMKIDs.
2895  * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2896  *      allows the driver to adjust the dynamic ps timeout value.
2897  * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2898  *      After configuration, the driver should (soon) send an event indicating
2899  *      the current level is above/below the configured threshold; this may
2900  *      need some care when the configuration is changed (without first being
2901  *      disabled.)
2902  * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
2903  *      connection quality monitor.  An event is to be sent only when the
2904  *      signal level is found to be outside the two values.  The driver should
2905  *      set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
2906  *      If it is provided then there's no point providing @set_cqm_rssi_config.
2907  * @set_cqm_txe_config: Configure connection quality monitor TX error
2908  *      thresholds.
2909  * @sched_scan_start: Tell the driver to start a scheduled scan.
2910  * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
2911  *      given request id. This call must stop the scheduled scan and be ready
2912  *      for starting a new one before it returns, i.e. @sched_scan_start may be
2913  *      called immediately after that again and should not fail in that case.
2914  *      The driver should not call cfg80211_sched_scan_stopped() for a requested
2915  *      stop (when this method returns 0).
2916  *
2917  * @mgmt_frame_register: Notify driver that a management frame type was
2918  *      registered. The callback is allowed to sleep.
2919  *
2920  * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2921  *      Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2922  *      reject TX/RX mask combinations they cannot support by returning -EINVAL
2923  *      (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2924  *
2925  * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2926  *
2927  * @tdls_mgmt: Transmit a TDLS management frame.
2928  * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2929  *
2930  * @probe_client: probe an associated client, must return a cookie that it
2931  *      later passes to cfg80211_probe_status().
2932  *
2933  * @set_noack_map: Set the NoAck Map for the TIDs.
2934  *
2935  * @get_channel: Get the current operating channel for the virtual interface.
2936  *      For monitor interfaces, it should return %NULL unless there's a single
2937  *      current monitoring channel.
2938  *
2939  * @start_p2p_device: Start the given P2P device.
2940  * @stop_p2p_device: Stop the given P2P device.
2941  *
2942  * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2943  *      Parameters include ACL policy, an array of MAC address of stations
2944  *      and the number of MAC addresses. If there is already a list in driver
2945  *      this new list replaces the existing one. Driver has to clear its ACL
2946  *      when number of MAC addresses entries is passed as 0. Drivers which
2947  *      advertise the support for MAC based ACL have to implement this callback.
2948  *
2949  * @start_radar_detection: Start radar detection in the driver.
2950  *
2951  * @update_ft_ies: Provide updated Fast BSS Transition information to the
2952  *      driver. If the SME is in the driver/firmware, this information can be
2953  *      used in building Authentication and Reassociation Request frames.
2954  *
2955  * @crit_proto_start: Indicates a critical protocol needs more link reliability
2956  *      for a given duration (milliseconds). The protocol is provided so the
2957  *      driver can take the most appropriate actions.
2958  * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2959  *      reliability. This operation can not fail.
2960  * @set_coalesce: Set coalesce parameters.
2961  *
2962  * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
2963  *      responsible for veryfing if the switch is possible. Since this is
2964  *      inherently tricky driver may decide to disconnect an interface later
2965  *      with cfg80211_stop_iface(). This doesn't mean driver can accept
2966  *      everything. It should do it's best to verify requests and reject them
2967  *      as soon as possible.
2968  *
2969  * @set_qos_map: Set QoS mapping information to the driver
2970  *
2971  * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
2972  *      given interface This is used e.g. for dynamic HT 20/40 MHz channel width
2973  *      changes during the lifetime of the BSS.
2974  *
2975  * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
2976  *      with the given parameters; action frame exchange has been handled by
2977  *      userspace so this just has to modify the TX path to take the TS into
2978  *      account.
2979  *      If the admitted time is 0 just validate the parameters to make sure
2980  *      the session can be created at all; it is valid to just always return
2981  *      success for that but that may result in inefficient behaviour (handshake
2982  *      with the peer followed by immediate teardown when the addition is later
2983  *      rejected)
2984  * @del_tx_ts: remove an existing TX TS
2985  *
2986  * @join_ocb: join the OCB network with the specified parameters
2987  *      (invoked with the wireless_dev mutex held)
2988  * @leave_ocb: leave the current OCB network
2989  *      (invoked with the wireless_dev mutex held)
2990  *
2991  * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2992  *      is responsible for continually initiating channel-switching operations
2993  *      and returning to the base channel for communication with the AP.
2994  * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2995  *      peers must be on the base channel when the call completes.
2996  * @start_nan: Start the NAN interface.
2997  * @stop_nan: Stop the NAN interface.
2998  * @add_nan_func: Add a NAN function. Returns negative value on failure.
2999  *      On success @nan_func ownership is transferred to the driver and
3000  *      it may access it outside of the scope of this function. The driver
3001  *      should free the @nan_func when no longer needed by calling
3002  *      cfg80211_free_nan_func().
3003  *      On success the driver should assign an instance_id in the
3004  *      provided @nan_func.
3005  * @del_nan_func: Delete a NAN function.
3006  * @nan_change_conf: changes NAN configuration. The changed parameters must
3007  *      be specified in @changes (using &enum cfg80211_nan_conf_changes);
3008  *      All other parameters must be ignored.
3009  *
3010  * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
3011  *
3012  * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
3013  *      function should return phy stats, and interface stats otherwise.
3014  *
3015  * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
3016  *      If not deleted through @del_pmk the PMK remains valid until disconnect
3017  *      upon which the driver should clear it.
3018  *      (invoked with the wireless_dev mutex held)
3019  * @del_pmk: delete the previously configured PMK for the given authenticator.
3020  *      (invoked with the wireless_dev mutex held)
3021  *
3022  * @external_auth: indicates result of offloaded authentication processing from
3023  *     user space
3024  *
3025  * @tx_control_port: TX a control port frame (EAPoL).  The noencrypt parameter
3026  *      tells the driver that the frame should not be encrypted.
3027  */
3028 struct cfg80211_ops {
3029         int     (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
3030         int     (*resume)(struct wiphy *wiphy);
3031         void    (*set_wakeup)(struct wiphy *wiphy, bool enabled);
3032
3033         struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
3034                                                   const char *name,
3035                                                   unsigned char name_assign_type,
3036                                                   enum nl80211_iftype type,
3037                                                   struct vif_params *params);
3038         int     (*del_virtual_intf)(struct wiphy *wiphy,
3039                                     struct wireless_dev *wdev);
3040         int     (*change_virtual_intf)(struct wiphy *wiphy,
3041                                        struct net_device *dev,
3042                                        enum nl80211_iftype type,
3043                                        struct vif_params *params);
3044
3045         int     (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
3046                            u8 key_index, bool pairwise, const u8 *mac_addr,
3047                            struct key_params *params);
3048         int     (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
3049                            u8 key_index, bool pairwise, const u8 *mac_addr,
3050                            void *cookie,
3051                            void (*callback)(void *cookie, struct key_params*));
3052         int     (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
3053                            u8 key_index, bool pairwise, const u8 *mac_addr);
3054         int     (*set_default_key)(struct wiphy *wiphy,
3055                                    struct net_device *netdev,
3056                                    u8 key_index, bool unicast, bool multicast);
3057         int     (*set_default_mgmt_key)(struct wiphy *wiphy,
3058                                         struct net_device *netdev,
3059                                         u8 key_index);
3060
3061         int     (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
3062                             struct cfg80211_ap_settings *settings);
3063         int     (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
3064                                  struct cfg80211_beacon_data *info);
3065         int     (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
3066
3067
3068         int     (*add_station)(struct wiphy *wiphy, struct net_device *dev,
3069                                const u8 *mac,
3070                                struct station_parameters *params);
3071         int     (*del_station)(struct wiphy *wiphy, struct net_device *dev,
3072                                struct station_del_parameters *params);
3073         int     (*change_station)(struct wiphy *wiphy, struct net_device *dev,
3074                                   const u8 *mac,
3075                                   struct station_parameters *params);
3076         int     (*get_station)(struct wiphy *wiphy, struct net_device *dev,
3077                                const u8 *mac, struct station_info *sinfo);
3078         int     (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
3079                                 int idx, u8 *mac, struct station_info *sinfo);
3080
3081         int     (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
3082                                const u8 *dst, const u8 *next_hop);
3083         int     (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
3084                                const u8 *dst);
3085         int     (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
3086                                   const u8 *dst, const u8 *next_hop);
3087         int     (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
3088                              u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
3089         int     (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
3090                               int idx, u8 *dst, u8 *next_hop,
3091                               struct mpath_info *pinfo);
3092         int     (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
3093                            u8 *dst, u8 *mpp, struct mpath_info *pinfo);
3094         int     (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
3095                             int idx, u8 *dst, u8 *mpp,
3096                             struct mpath_info *pinfo);
3097         int     (*get_mesh_config)(struct wiphy *wiphy,
3098                                 struct net_device *dev,
3099                                 struct mesh_config *conf);
3100         int     (*update_mesh_config)(struct wiphy *wiphy,
3101                                       struct net_device *dev, u32 mask,
3102                                       const struct mesh_config *nconf);
3103         int     (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
3104                              const struct mesh_config *conf,
3105                              const struct mesh_setup *setup);
3106         int     (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
3107
3108         int     (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
3109                             struct ocb_setup *setup);
3110         int     (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
3111
3112         int     (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
3113                               struct bss_parameters *params);
3114
3115         int     (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
3116                                   struct ieee80211_txq_params *params);
3117
3118         int     (*libertas_set_mesh_channel)(struct wiphy *wiphy,
3119                                              struct net_device *dev,
3120                                              struct ieee80211_channel *chan);
3121
3122         int     (*set_monitor_channel)(struct wiphy *wiphy,
3123                                        struct cfg80211_chan_def *chandef);
3124
3125         int     (*scan)(struct wiphy *wiphy,
3126                         struct cfg80211_scan_request *request);
3127         void    (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3128
3129         int     (*auth)(struct wiphy *wiphy, struct net_device *dev,
3130                         struct cfg80211_auth_request *req);
3131         int     (*assoc)(struct wiphy *wiphy, struct net_device *dev,
3132                          struct cfg80211_assoc_request *req);
3133         int     (*deauth)(struct wiphy *wiphy, struct net_device *dev,
3134                           struct cfg80211_deauth_request *req);
3135         int     (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
3136                             struct cfg80211_disassoc_request *req);
3137
3138         int     (*connect)(struct wiphy *wiphy, struct net_device *dev,
3139                            struct cfg80211_connect_params *sme);
3140         int     (*update_connect_params)(struct wiphy *wiphy,
3141                                          struct net_device *dev,
3142                                          struct cfg80211_connect_params *sme,
3143                                          u32 changed);
3144         int     (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
3145                               u16 reason_code);
3146
3147         int     (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
3148                              struct cfg80211_ibss_params *params);
3149         int     (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
3150
3151         int     (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
3152                                   int rate[NUM_NL80211_BANDS]);
3153
3154         int     (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
3155
3156         int     (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3157                                 enum nl80211_tx_power_setting type, int mbm);
3158         int     (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3159                                 int *dbm);
3160
3161         int     (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
3162                                 const u8 *addr);
3163
3164         void    (*rfkill_poll)(struct wiphy *wiphy);
3165
3166 #ifdef CONFIG_NL80211_TESTMODE
3167         int     (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
3168                                 void *data, int len);
3169         int     (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
3170                                  struct netlink_callback *cb,
3171                                  void *data, int len);
3172 #endif
3173
3174         int     (*set_bitrate_mask)(struct wiphy *wiphy,
3175                                     struct net_device *dev,
3176                                     const u8 *peer,
3177                                     const struct cfg80211_bitrate_mask *mask);
3178
3179         int     (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
3180                         int idx, struct survey_info *info);
3181
3182         int     (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3183                              struct cfg80211_pmksa *pmksa);
3184         int     (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3185                              struct cfg80211_pmksa *pmksa);
3186         int     (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
3187
3188         int     (*remain_on_channel)(struct wiphy *wiphy,
3189                                      struct wireless_dev *wdev,
3190                                      struct ieee80211_channel *chan,
3191                                      unsigned int duration,
3192                                      u64 *cookie);
3193         int     (*cancel_remain_on_channel)(struct wiphy *wiphy,
3194                                             struct wireless_dev *wdev,
3195                                             u64 cookie);
3196
3197         int     (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
3198                            struct cfg80211_mgmt_tx_params *params,
3199                            u64 *cookie);
3200         int     (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
3201                                        struct wireless_dev *wdev,
3202                                        u64 cookie);
3203
3204         int     (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3205                                   bool enabled, int timeout);
3206
3207         int     (*set_cqm_rssi_config)(struct wiphy *wiphy,
3208                                        struct net_device *dev,
3209                                        s32 rssi_thold, u32 rssi_hyst);
3210
3211         int     (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
3212                                              struct net_device *dev,
3213                                              s32 rssi_low, s32 rssi_high);
3214
3215         int     (*set_cqm_txe_config)(struct wiphy *wiphy,
3216                                       struct net_device *dev,
3217                                       u32 rate, u32 pkts, u32 intvl);
3218
3219         void    (*mgmt_frame_register)(struct wiphy *wiphy,
3220                                        struct wireless_dev *wdev,
3221                                        u16 frame_type, bool reg);
3222
3223         int     (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
3224         int     (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
3225
3226         int     (*sched_scan_start)(struct wiphy *wiphy,
3227                                 struct net_device *dev,
3228                                 struct cfg80211_sched_scan_request *request);
3229         int     (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
3230                                    u64 reqid);
3231
3232         int     (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
3233                                   struct cfg80211_gtk_rekey_data *data);
3234
3235         int     (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3236                              const u8 *peer, u8 action_code,  u8 dialog_token,
3237                              u16 status_code, u32 peer_capability,
3238                              bool initiator, const u8 *buf, size_t len);
3239         int     (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
3240                              const u8 *peer, enum nl80211_tdls_operation oper);
3241
3242         int     (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
3243                                 const u8 *peer, u64 *cookie);
3244
3245         int     (*set_noack_map)(struct wiphy *wiphy,
3246                                   struct net_device *dev,
3247                                   u16 noack_map);
3248
3249         int     (*get_channel)(struct wiphy *wiphy,
3250                                struct wireless_dev *wdev,
3251                                struct cfg80211_chan_def *chandef);
3252
3253         int     (*start_p2p_device)(struct wiphy *wiphy,
3254                                     struct wireless_dev *wdev);
3255         void    (*stop_p2p_device)(struct wiphy *wiphy,
3256                                    struct wireless_dev *wdev);
3257
3258         int     (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
3259                                const struct cfg80211_acl_data *params);
3260
3261         int     (*start_radar_detection)(struct wiphy *wiphy,
3262                                          struct net_device *dev,
3263                                          struct cfg80211_chan_def *chandef,
3264                                          u32 cac_time_ms);
3265         int     (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
3266                                  struct cfg80211_update_ft_ies_params *ftie);
3267         int     (*crit_proto_start)(struct wiphy *wiphy,
3268                                     struct wireless_dev *wdev,
3269                                     enum nl80211_crit_proto_id protocol,
3270                                     u16 duration);
3271         void    (*crit_proto_stop)(struct wiphy *wiphy,
3272                                    struct wireless_dev *wdev);
3273         int     (*set_coalesce)(struct wiphy *wiphy,
3274                                 struct cfg80211_coalesce *coalesce);
3275
3276         int     (*channel_switch)(struct wiphy *wiphy,
3277                                   struct net_device *dev,
3278                                   struct cfg80211_csa_settings *params);
3279
3280         int     (*set_qos_map)(struct wiphy *wiphy,
3281                                struct net_device *dev,
3282                                struct cfg80211_qos_map *qos_map);
3283
3284         int     (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
3285                                     struct cfg80211_chan_def *chandef);
3286
3287         int     (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3288                              u8 tsid, const u8 *peer, u8 user_prio,
3289                              u16 admitted_time);
3290         int     (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3291                              u8 tsid, const u8 *peer);
3292
3293         int     (*tdls_channel_switch)(struct wiphy *wiphy,
3294                                        struct net_device *dev,
3295                                        const u8 *addr, u8 oper_class,
3296                                        struct cfg80211_chan_def *chandef);
3297         void    (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
3298                                               struct net_device *dev,
3299                                               const u8 *addr);
3300         int     (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
3301                              struct cfg80211_nan_conf *conf);
3302         void    (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3303         int     (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3304                                 struct cfg80211_nan_func *nan_func);
3305         void    (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3306                                u64 cookie);
3307         int     (*nan_change_conf)(struct wiphy *wiphy,
3308                                    struct wireless_dev *wdev,
3309                                    struct cfg80211_nan_conf *conf,
3310                                    u32 changes);
3311
3312         int     (*set_multicast_to_unicast)(struct wiphy *wiphy,
3313                                             struct net_device *dev,
3314                                             const bool enabled);
3315
3316         int     (*get_txq_stats)(struct wiphy *wiphy,
3317                                  struct wireless_dev *wdev,
3318                                  struct cfg80211_txq_stats *txqstats);
3319
3320         int     (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
3321                            const struct cfg80211_pmk_conf *conf);
3322         int     (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
3323                            const u8 *aa);
3324         int     (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
3325                                  struct cfg80211_external_auth_params *params);
3326
3327         int     (*tx_control_port)(struct wiphy *wiphy,
3328                                    struct net_device *dev,
3329                                    const u8 *buf, size_t len,
3330                                    const u8 *dest, const __be16 proto,
3331                                    const bool noencrypt);
3332 };
3333
3334 /*
3335  * wireless hardware and networking interfaces structures
3336  * and registration/helper functions
3337  */
3338
3339 /**
3340  * enum wiphy_flags - wiphy capability flags
3341  *
3342  * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
3343  *      wiphy at all
3344  * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
3345  *      by default -- this flag will be set depending on the kernel's default
3346  *      on wiphy_new(), but can be changed by the driver if it has a good
3347  *      reason to override the default
3348  * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
3349  *      on a VLAN interface)
3350  * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
3351  * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
3352  *      control port protocol ethertype. The device also honours the
3353  *      control_port_no_encrypt flag.
3354  * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
3355  * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
3356  *      auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
3357  * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
3358  *      firmware.
3359  * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
3360  * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
3361  * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
3362  *      link setup/discovery operations internally. Setup, discovery and
3363  *      teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
3364  *      command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
3365  *      used for asking the driver/firmware to perform a TDLS operation.
3366  * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
3367  * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
3368  *      when there are virtual interfaces in AP mode by calling
3369  *      cfg80211_report_obss_beacon().
3370  * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
3371  *      responds to probe-requests in hardware.
3372  * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
3373  * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
3374  * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
3375  * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
3376  *      beaconing mode (AP, IBSS, Mesh, ...).
3377  * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
3378  *      before connection.
3379  */
3380 enum wiphy_flags {
3381         /* use hole at 0 */
3382         /* use hole at 1 */
3383         /* use hole at 2 */
3384         WIPHY_FLAG_NETNS_OK                     = BIT(3),
3385         WIPHY_FLAG_PS_ON_BY_DEFAULT             = BIT(4),
3386         WIPHY_FLAG_4ADDR_AP                     = BIT(5),
3387         WIPHY_FLAG_4ADDR_STATION                = BIT(6),
3388         WIPHY_FLAG_CONTROL_PORT_PROTOCOL        = BIT(7),
3389         WIPHY_FLAG_IBSS_RSN                     = BIT(8),
3390         WIPHY_FLAG_MESH_AUTH                    = BIT(10),
3391         /* use hole at 11 */
3392         /* use hole at 12 */
3393         WIPHY_FLAG_SUPPORTS_FW_ROAM             = BIT(13),
3394         WIPHY_FLAG_AP_UAPSD                     = BIT(14),
3395         WIPHY_FLAG_SUPPORTS_TDLS                = BIT(15),
3396         WIPHY_FLAG_TDLS_EXTERNAL_SETUP          = BIT(16),
3397         WIPHY_FLAG_HAVE_AP_SME                  = BIT(17),
3398         WIPHY_FLAG_REPORTS_OBSS                 = BIT(18),
3399         WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD        = BIT(19),
3400         WIPHY_FLAG_OFFCHAN_TX                   = BIT(20),
3401         WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL        = BIT(21),
3402         WIPHY_FLAG_SUPPORTS_5_10_MHZ            = BIT(22),
3403         WIPHY_FLAG_HAS_CHANNEL_SWITCH           = BIT(23),
3404         WIPHY_FLAG_HAS_STATIC_WEP               = BIT(24),
3405 };
3406
3407 /**
3408  * struct ieee80211_iface_limit - limit on certain interface types
3409  * @max: maximum number of interfaces of these types
3410  * @types: interface types (bits)
3411  */
3412 struct ieee80211_iface_limit {
3413         u16 max;
3414         u16 types;
3415 };
3416
3417 /**
3418  * struct ieee80211_iface_combination - possible interface combination
3419  *
3420  * With this structure the driver can describe which interface
3421  * combinations it supports concurrently.
3422  *
3423  * Examples:
3424  *
3425  * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
3426  *
3427  *    .. code-block:: c
3428  *
3429  *      struct ieee80211_iface_limit limits1[] = {
3430  *              { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3431  *              { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
3432  *      };
3433  *      struct ieee80211_iface_combination combination1 = {
3434  *              .limits = limits1,
3435  *              .n_limits = ARRAY_SIZE(limits1),
3436  *              .max_interfaces = 2,
3437  *              .beacon_int_infra_match = true,
3438  *      };
3439  *
3440  *
3441  * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
3442  *
3443  *    .. code-block:: c
3444  *
3445  *      struct ieee80211_iface_limit limits2[] = {
3446  *              { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
3447  *                                   BIT(NL80211_IFTYPE_P2P_GO), },
3448  *      };
3449  *      struct ieee80211_iface_combination combination2 = {
3450  *              .limits = limits2,
3451  *              .n_limits = ARRAY_SIZE(limits2),
3452  *              .max_interfaces = 8,
3453  *              .num_different_channels = 1,
3454  *      };
3455  *
3456  *
3457  * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
3458  *
3459  *    This allows for an infrastructure connection and three P2P connections.
3460  *
3461  *    .. code-block:: c
3462  *
3463  *      struct ieee80211_iface_limit limits3[] = {
3464  *              { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3465  *              { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
3466  *                                   BIT(NL80211_IFTYPE_P2P_CLIENT), },
3467  *      };
3468  *      struct ieee80211_iface_combination combination3 = {
3469  *              .limits = limits3,
3470  *              .n_limits = ARRAY_SIZE(limits3),
3471  *              .max_interfaces = 4,
3472  *              .num_different_channels = 2,
3473  *      };
3474  *
3475  */
3476 struct ieee80211_iface_combination {
3477         /**
3478          * @limits:
3479          * limits for the given interface types
3480          */
3481         const struct ieee80211_iface_limit *limits;
3482
3483         /**
3484          * @num_different_channels:
3485          * can use up to this many different channels
3486          */
3487         u32 num_different_channels;
3488
3489         /**
3490          * @max_interfaces:
3491          * maximum number of interfaces in total allowed in this group
3492          */
3493         u16 max_interfaces;
3494
3495         /**
3496          * @n_limits:
3497          * number of limitations
3498          */
3499         u8 n_limits;
3500
3501         /**
3502          * @beacon_int_infra_match:
3503          * In this combination, the beacon intervals between infrastructure
3504          * and AP types must match. This is required only in special cases.
3505          */
3506         bool beacon_int_infra_match;
3507
3508         /**
3509          * @radar_detect_widths:
3510          * bitmap of channel widths supported for radar detection
3511          */
3512         u8 radar_detect_widths;
3513
3514         /**
3515          * @radar_detect_regions:
3516          * bitmap of regions supported for radar detection
3517          */
3518         u8 radar_detect_regions;
3519
3520         /**
3521          * @beacon_int_min_gcd:
3522          * This interface combination supports different beacon intervals.
3523          *
3524          * = 0
3525          *   all beacon intervals for different interface must be same.
3526          * > 0
3527          *   any beacon interval for the interface part of this combination AND
3528          *   GCD of all beacon intervals from beaconing interfaces of this
3529          *   combination must be greater or equal to this value.
3530          */
3531         u32 beacon_int_min_gcd;
3532 };
3533
3534 struct ieee80211_txrx_stypes {
3535         u16 tx, rx;
3536 };
3537
3538 /**
3539  * enum wiphy_wowlan_support_flags - WoWLAN support flags
3540  * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
3541  *      trigger that keeps the device operating as-is and
3542  *      wakes up the host on any activity, for example a
3543  *      received packet that passed filtering; note that the
3544  *      packet should be preserved in that case
3545  * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
3546  *      (see nl80211.h)
3547  * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
3548  * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
3549  * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
3550  * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
3551  * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
3552  * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
3553  * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
3554  */
3555 enum wiphy_wowlan_support_flags {
3556         WIPHY_WOWLAN_ANY                = BIT(0),
3557         WIPHY_WOWLAN_MAGIC_PKT          = BIT(1),
3558         WIPHY_WOWLAN_DISCONNECT         = BIT(2),
3559         WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
3560         WIPHY_WOWLAN_GTK_REKEY_FAILURE  = BIT(4),
3561         WIPHY_WOWLAN_EAP_IDENTITY_REQ   = BIT(5),
3562         WIPHY_WOWLAN_4WAY_HANDSHAKE     = BIT(6),
3563         WIPHY_WOWLAN_RFKILL_RELEASE     = BIT(7),
3564         WIPHY_WOWLAN_NET_DETECT         = BIT(8),
3565 };
3566
3567 struct wiphy_wowlan_tcp_support {
3568         const struct nl80211_wowlan_tcp_data_token_feature *tok;
3569         u32 data_payload_max;
3570         u32 data_interval_max;
3571         u32 wake_payload_max;
3572         bool seq;
3573 };
3574
3575 /**
3576  * struct wiphy_wowlan_support - WoWLAN support data
3577  * @flags: see &enum wiphy_wowlan_support_flags
3578  * @n_patterns: number of supported wakeup patterns
3579  *      (see nl80211.h for the pattern definition)
3580  * @pattern_max_len: maximum length of each pattern
3581  * @pattern_min_len: minimum length of each pattern
3582  * @max_pkt_offset: maximum Rx packet offset
3583  * @max_nd_match_sets: maximum number of matchsets for net-detect,
3584  *      similar, but not necessarily identical, to max_match_sets for
3585  *      scheduled scans.
3586  *      See &struct cfg80211_sched_scan_request.@match_sets for more
3587  *      details.
3588  * @tcp: TCP wakeup support information
3589  */
3590 struct wiphy_wowlan_support {
3591         u32 flags;
3592         int n_patterns;
3593         int pattern_max_len;
3594         int pattern_min_len;
3595         int max_pkt_offset;
3596         int max_nd_match_sets;
3597         const struct wiphy_wowlan_tcp_support *tcp;
3598 };
3599
3600 /**
3601  * struct wiphy_coalesce_support - coalesce support data
3602  * @n_rules: maximum number of coalesce rules
3603  * @max_delay: maximum supported coalescing delay in msecs
3604  * @n_patterns: number of supported patterns in a rule
3605  *      (see nl80211.h for the pattern definition)
3606  * @pattern_max_len: maximum length of each pattern
3607  * @pattern_min_len: minimum length of each pattern
3608  * @max_pkt_offset: maximum Rx packet offset
3609  */
3610 struct wiphy_coalesce_support {
3611         int n_rules;
3612         int max_delay;
3613         int n_patterns;
3614         int pattern_max_len;
3615         int pattern_min_len;
3616         int max_pkt_offset;
3617 };
3618
3619 /**
3620  * enum wiphy_vendor_command_flags - validation flags for vendor commands
3621  * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
3622  * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
3623  * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
3624  *      (must be combined with %_WDEV or %_NETDEV)
3625  */
3626 enum wiphy_vendor_command_flags {
3627         WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
3628         WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
3629         WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
3630 };
3631
3632 /**
3633  * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
3634  *
3635  * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
3636  * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
3637  * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
3638  *
3639  */
3640 enum wiphy_opmode_flag {
3641         STA_OPMODE_MAX_BW_CHANGED       = BIT(0),
3642         STA_OPMODE_SMPS_MODE_CHANGED    = BIT(1),
3643         STA_OPMODE_N_SS_CHANGED         = BIT(2),
3644 };
3645
3646 /**
3647  * struct sta_opmode_info - Station's ht/vht operation mode information
3648  * @changed: contains value from &enum wiphy_opmode_flag
3649  * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
3650  * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
3651  * @rx_nss: new rx_nss value of a station
3652  */
3653
3654 struct sta_opmode_info {
3655         u32 changed;
3656         enum nl80211_smps_mode smps_mode;
3657         enum nl80211_chan_width bw;
3658         u8 rx_nss;
3659 };
3660
3661 /**
3662  * struct wiphy_vendor_command - vendor command definition
3663  * @info: vendor command identifying information, as used in nl80211
3664  * @flags: flags, see &enum wiphy_vendor_command_flags
3665  * @doit: callback for the operation, note that wdev is %NULL if the
3666  *      flags didn't ask for a wdev and non-%NULL otherwise; the data
3667  *      pointer may be %NULL if userspace provided no data at all
3668  * @dumpit: dump callback, for transferring bigger/multiple items. The
3669  *      @storage points to cb->args[5], ie. is preserved over the multiple
3670  *      dumpit calls.
3671  * It's recommended to not have the same sub command with both @doit and
3672  * @dumpit, so that userspace can assume certain ones are get and others
3673  * are used with dump requests.
3674  */
3675 struct wiphy_vendor_command {
3676         struct nl80211_vendor_cmd_info info;
3677         u32 flags;
3678         int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3679                     const void *data, int data_len);
3680         int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3681                       struct sk_buff *skb, const void *data, int data_len,
3682                       unsigned long *storage);
3683 };
3684
3685 /**
3686  * struct wiphy_iftype_ext_capab - extended capabilities per interface type
3687  * @iftype: interface type
3688  * @extended_capabilities: extended capabilities supported by the driver,
3689  *      additional capabilities might be supported by userspace; these are the
3690  *      802.11 extended capabilities ("Extended Capabilities element") and are
3691  *      in the same format as in the information element. See IEEE Std
3692  *      802.11-2012 8.4.2.29 for the defined fields.
3693  * @extended_capabilities_mask: mask of the valid values
3694  * @extended_capabilities_len: length of the extended capabilities
3695  */
3696 struct wiphy_iftype_ext_capab {
3697         enum nl80211_iftype iftype;
3698         const u8 *extended_capabilities;
3699         const u8 *extended_capabilities_mask;
3700         u8 extended_capabilities_len;
3701 };
3702
3703 /**
3704  * struct wiphy - wireless hardware description
3705  * @reg_notifier: the driver's regulatory notification callback,
3706  *      note that if your driver uses wiphy_apply_custom_regulatory()
3707  *      the reg_notifier's request can be passed as NULL
3708  * @regd: the driver's regulatory domain, if one was requested via
3709  *      the regulatory_hint() API. This can be used by the driver
3710  *      on the reg_notifier() if it chooses to ignore future
3711  *      regulatory domain changes caused by other drivers.
3712  * @signal_type: signal type reported in &struct cfg80211_bss.
3713  * @cipher_suites: supported cipher suites
3714  * @n_cipher_suites: number of supported cipher suites
3715  * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
3716  * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
3717  * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
3718  *      -1 = fragmentation disabled, only odd values >= 256 used
3719  * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
3720  * @_net: the network namespace this wiphy currently lives in
3721  * @perm_addr: permanent MAC address of this device
3722  * @addr_mask: If the device supports multiple MAC addresses by masking,
3723  *      set this to a mask with variable bits set to 1, e.g. if the last
3724  *      four bits are variable then set it to 00-00-00-00-00-0f. The actual
3725  *      variable bits shall be determined by the interfaces added, with
3726  *      interfaces not matching the mask being rejected to be brought up.
3727  * @n_addresses: number of addresses in @addresses.
3728  * @addresses: If the device has more than one address, set this pointer
3729  *      to a list of addresses (6 bytes each). The first one will be used
3730  *      by default for perm_addr. In this case, the mask should be set to
3731  *      all-zeroes. In this case it is assumed that the device can handle
3732  *      the same number of arbitrary MAC addresses.
3733  * @registered: protects ->resume and ->suspend sysfs callbacks against
3734  *      unregister hardware
3735  * @debugfsdir: debugfs directory used for this wiphy, will be renamed
3736  *      automatically on wiphy renames
3737  * @dev: (virtual) struct device for this wiphy
3738  * @registered: helps synchronize suspend/resume with wiphy unregister
3739  * @wext: wireless extension handlers
3740  * @priv: driver private data (sized according to wiphy_new() parameter)
3741  * @interface_modes: bitmask of interfaces types valid for this wiphy,
3742  *      must be set by driver
3743  * @iface_combinations: Valid interface combinations array, should not
3744  *      list single interface types.
3745  * @n_iface_combinations: number of entries in @iface_combinations array.
3746  * @software_iftypes: bitmask of software interface types, these are not
3747  *      subject to any restrictions since they are purely managed in SW.
3748  * @flags: wiphy flags, see &enum wiphy_flags
3749  * @regulatory_flags: wiphy regulatory flags, see
3750  *      &enum ieee80211_regulatory_flags
3751  * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
3752  * @ext_features: extended features advertised to nl80211, see
3753  *      &enum nl80211_ext_feature_index.
3754  * @bss_priv_size: each BSS struct has private data allocated with it,
3755  *      this variable determines its size
3756  * @max_scan_ssids: maximum number of SSIDs the device can scan for in
3757  *      any given scan
3758  * @max_sched_scan_reqs: maximum number of scheduled scan requests that
3759  *      the device can run concurrently.
3760  * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
3761  *      for in any given scheduled scan
3762  * @max_match_sets: maximum number of match sets the device can handle
3763  *      when performing a scheduled scan, 0 if filtering is not
3764  *      supported.
3765  * @max_scan_ie_len: maximum length of user-controlled IEs device can
3766  *      add to probe request frames transmitted during a scan, must not
3767  *      include fixed IEs like supported rates
3768  * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
3769  *      scans
3770  * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
3771  *      of iterations) for scheduled scan supported by the device.
3772  * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
3773  *      single scan plan supported by the device.
3774  * @max_sched_scan_plan_iterations: maximum number of iterations for a single
3775  *      scan plan supported by the device.
3776  * @coverage_class: current coverage class
3777  * @fw_version: firmware version for ethtool reporting
3778  * @hw_version: hardware version for ethtool reporting
3779  * @max_num_pmkids: maximum number of PMKIDs supported by device
3780  * @privid: a pointer that drivers can use to identify if an arbitrary
3781  *      wiphy is theirs, e.g. in global notifiers
3782  * @bands: information about bands/channels supported by this device
3783  *
3784  * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
3785  *      transmitted through nl80211, points to an array indexed by interface
3786  *      type
3787  *
3788  * @available_antennas_tx: bitmap of antennas which are available to be
3789  *      configured as TX antennas. Antenna configuration commands will be
3790  *      rejected unless this or @available_antennas_rx is set.
3791  *
3792  * @available_antennas_rx: bitmap of antennas which are available to be
3793  *      configured as RX antennas. Antenna configuration commands will be
3794  *      rejected unless this or @available_antennas_tx is set.
3795  *
3796  * @probe_resp_offload:
3797  *       Bitmap of supported protocols for probe response offloading.
3798  *       See &enum nl80211_probe_resp_offload_support_attr. Only valid
3799  *       when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3800  *
3801  * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
3802  *      may request, if implemented.
3803  *
3804  * @wowlan: WoWLAN support information
3805  * @wowlan_config: current WoWLAN configuration; this should usually not be
3806  *      used since access to it is necessarily racy, use the parameter passed
3807  *      to the suspend() operation instead.
3808  *
3809  * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
3810  * @ht_capa_mod_mask:  Specify what ht_cap values can be over-ridden.
3811  *      If null, then none can be over-ridden.
3812  * @vht_capa_mod_mask:  Specify what VHT capabilities can be over-ridden.
3813  *      If null, then none can be over-ridden.
3814  *
3815  * @wdev_list: the list of associated (virtual) interfaces; this list must
3816  *      not be modified by the driver, but can be read with RTNL/RCU protection.
3817  *
3818  * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
3819  *      supports for ACL.
3820  *
3821  * @extended_capabilities: extended capabilities supported by the driver,
3822  *      additional capabilities might be supported by userspace; these are
3823  *      the 802.11 extended capabilities ("Extended Capabilities element")
3824  *      and are in the same format as in the information element. See
3825  *      802.11-2012 8.4.2.29 for the defined fields. These are the default
3826  *      extended capabilities to be used if the capabilities are not specified
3827  *      for a specific interface type in iftype_ext_capab.
3828  * @extended_capabilities_mask: mask of the valid values
3829  * @extended_capabilities_len: length of the extended capabilities
3830  * @iftype_ext_capab: array of extended capabilities per interface type
3831  * @num_iftype_ext_capab: number of interface types for which extended
3832  *      capabilities are specified separately.
3833  * @coalesce: packet coalescing support information
3834  *
3835  * @vendor_commands: array of vendor commands supported by the hardware
3836  * @n_vendor_commands: number of vendor commands
3837  * @vendor_events: array of vendor events supported by the hardware
3838  * @n_vendor_events: number of vendor events
3839  *
3840  * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
3841  *      (including P2P GO) or 0 to indicate no such limit is advertised. The
3842  *      driver is allowed to advertise a theoretical limit that it can reach in
3843  *      some cases, but may not always reach.
3844  *
3845  * @max_num_csa_counters: Number of supported csa_counters in beacons
3846  *      and probe responses.  This value should be set if the driver
3847  *      wishes to limit the number of csa counters. Default (0) means
3848  *      infinite.
3849  * @max_adj_channel_rssi_comp: max offset of between the channel on which the
3850  *      frame was sent and the channel on which the frame was heard for which
3851  *      the reported rssi is still valid. If a driver is able to compensate the
3852  *      low rssi when a frame is heard on different channel, then it should set
3853  *      this variable to the maximal offset for which it can compensate.
3854  *      This value should be set in MHz.
3855  * @bss_select_support: bitmask indicating the BSS selection criteria supported
3856  *      by the driver in the .connect() callback. The bit position maps to the
3857  *      attribute indices defined in &enum nl80211_bss_select_attr.
3858  *
3859  * @cookie_counter: unique generic cookie counter, used to identify objects.
3860  * @nan_supported_bands: bands supported by the device in NAN mode, a
3861  *      bitmap of &enum nl80211_band values.  For instance, for
3862  *      NL80211_BAND_2GHZ, bit 0 would be set
3863  *      (i.e. BIT(NL80211_BAND_2GHZ)).
3864  *
3865  * @txq_limit: configuration of internal TX queue frame limit
3866  * @txq_memory_limit: configuration internal TX queue memory limit
3867  * @txq_quantum: configuration of internal TX queue scheduler quantum
3868  */
3869 struct wiphy {
3870         /* assign these fields before you register the wiphy */
3871
3872         /* permanent MAC address(es) */
3873         u8 perm_addr[ETH_ALEN];
3874         u8 addr_mask[ETH_ALEN];
3875
3876         struct mac_address *addresses;
3877
3878         const struct ieee80211_txrx_stypes *mgmt_stypes;
3879
3880         const struct ieee80211_iface_combination *iface_combinations;
3881         int n_iface_combinations;
3882         u16 software_iftypes;
3883
3884         u16 n_addresses;
3885
3886         /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
3887         u16 interface_modes;
3888
3889         u16 max_acl_mac_addrs;
3890
3891         u32 flags, regulatory_flags, features;
3892         u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
3893
3894         u32 ap_sme_capa;
3895
3896         enum cfg80211_signal_type signal_type;
3897
3898         int bss_priv_size;
3899         u8 max_scan_ssids;
3900         u8 max_sched_scan_reqs;
3901         u8 max_sched_scan_ssids;
3902         u8 max_match_sets;
3903         u16 max_scan_ie_len;
3904         u16 max_sched_scan_ie_len;
3905         u32 max_sched_scan_plans;
3906         u32 max_sched_scan_plan_interval;
3907         u32 max_sched_scan_plan_iterations;
3908
3909         int n_cipher_suites;
3910         const u32 *cipher_suites;
3911
3912         u8 retry_short;
3913         u8 retry_long;
3914         u32 frag_threshold;
3915         u32 rts_threshold;
3916         u8 coverage_class;
3917
3918         char fw_version[ETHTOOL_FWVERS_LEN];
3919         u32 hw_version;
3920
3921 #ifdef CONFIG_PM
3922         const struct wiphy_wowlan_support *wowlan;
3923         struct cfg80211_wowlan *wowlan_config;
3924 #endif
3925
3926         u16 max_remain_on_channel_duration;
3927
3928         u8 max_num_pmkids;
3929
3930         u32 available_antennas_tx;
3931         u32 available_antennas_rx;
3932
3933         /*
3934          * Bitmap of supported protocols for probe response offloading
3935          * see &enum nl80211_probe_resp_offload_support_attr. Only valid
3936          * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3937          */
3938         u32 probe_resp_offload;
3939
3940         const u8 *extended_capabilities, *extended_capabilities_mask;
3941         u8 extended_capabilities_len;
3942
3943         const struct wiphy_iftype_ext_capab *iftype_ext_capab;
3944         unsigned int num_iftype_ext_capab;
3945
3946         /* If multiple wiphys are registered and you're handed e.g.
3947          * a regular netdev with assigned ieee80211_ptr, you won't
3948          * know whether it points to a wiphy your driver has registered
3949          * or not. Assign this to something global to your driver to
3950          * help determine whether you own this wiphy or not. */
3951         const void *privid;
3952
3953         struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
3954
3955         /* Lets us get back the wiphy on the callback */
3956         void (*reg_notifier)(struct wiphy *wiphy,
3957                              struct regulatory_request *request);
3958
3959         /* fields below are read-only, assigned by cfg80211 */
3960
3961         const struct ieee80211_regdomain __rcu *regd;
3962
3963         /* the item in /sys/class/ieee80211/ points to this,
3964          * you need use set_wiphy_dev() (see below) */
3965         struct device dev;
3966
3967         /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3968         bool registered;
3969
3970         /* dir in debugfs: ieee80211/<wiphyname> */
3971         struct dentry *debugfsdir;
3972
3973         const struct ieee80211_ht_cap *ht_capa_mod_mask;
3974         const struct ieee80211_vht_cap *vht_capa_mod_mask;
3975
3976         struct list_head wdev_list;
3977
3978         /* the network namespace this phy lives in currently */
3979         possible_net_t _net;
3980
3981 #ifdef CONFIG_CFG80211_WEXT
3982         const struct iw_handler_def *wext;
3983 #endif
3984
3985         const struct wiphy_coalesce_support *coalesce;
3986
3987         const struct wiphy_vendor_command *vendor_commands;
3988         const struct nl80211_vendor_cmd_info *vendor_events;
3989         int n_vendor_commands, n_vendor_events;
3990
3991         u16 max_ap_assoc_sta;
3992
3993         u8 max_num_csa_counters;
3994         u8 max_adj_channel_rssi_comp;
3995
3996         u32 bss_select_support;
3997
3998         u64 cookie_counter;
3999
4000         u8 nan_supported_bands;
4001
4002         u32 txq_limit;
4003         u32 txq_memory_limit;
4004         u32 txq_quantum;
4005
4006         char priv[0] __aligned(NETDEV_ALIGN);
4007 };
4008
4009 static inline struct net *wiphy_net(struct wiphy *wiphy)
4010 {
4011         return read_pnet(&wiphy->_net);
4012 }
4013
4014 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
4015 {
4016         write_pnet(&wiphy->_net, net);
4017 }
4018
4019 /**
4020  * wiphy_priv - return priv from wiphy
4021  *
4022  * @wiphy: the wiphy whose priv pointer to return
4023  * Return: The priv of @wiphy.
4024  */
4025 static inline void *wiphy_priv(struct wiphy *wiphy)
4026 {
4027         BUG_ON(!wiphy);
4028         return &wiphy->priv;
4029 }
4030
4031 /**
4032  * priv_to_wiphy - return the wiphy containing the priv
4033  *
4034  * @priv: a pointer previously returned by wiphy_priv
4035  * Return: The wiphy of @priv.
4036  */
4037 static inline struct wiphy *priv_to_wiphy(void *priv)
4038 {
4039         BUG_ON(!priv);
4040         return container_of(priv, struct wiphy, priv);
4041 }
4042
4043 /**
4044  * set_wiphy_dev - set device pointer for wiphy
4045  *
4046  * @wiphy: The wiphy whose device to bind
4047  * @dev: The device to parent it to
4048  */
4049 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
4050 {
4051         wiphy->dev.parent = dev;
4052 }
4053
4054 /**
4055  * wiphy_dev - get wiphy dev pointer
4056  *
4057  * @wiphy: The wiphy whose device struct to look up
4058  * Return: The dev of @wiphy.
4059  */
4060 static inline struct device *wiphy_dev(struct wiphy *wiphy)
4061 {
4062         return wiphy->dev.parent;
4063 }
4064
4065 /**
4066  * wiphy_name - get wiphy name
4067  *
4068  * @wiphy: The wiphy whose name to return
4069  * Return: The name of @wiphy.
4070  */
4071 static inline const char *wiphy_name(const struct wiphy *wiphy)
4072 {
4073         return dev_name(&wiphy->dev);
4074 }
4075
4076 /**
4077  * wiphy_new_nm - create a new wiphy for use with cfg80211
4078  *
4079  * @ops: The configuration operations for this device
4080  * @sizeof_priv: The size of the private area to allocate
4081  * @requested_name: Request a particular name.
4082  *      NULL is valid value, and means use the default phy%d naming.
4083  *
4084  * Create a new wiphy and associate the given operations with it.
4085  * @sizeof_priv bytes are allocated for private use.
4086  *
4087  * Return: A pointer to the new wiphy. This pointer must be
4088  * assigned to each netdev's ieee80211_ptr for proper operation.
4089  */
4090 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
4091                            const char *requested_name);
4092
4093 /**
4094  * wiphy_new - create a new wiphy for use with cfg80211
4095  *
4096  * @ops: The configuration operations for this device
4097  * @sizeof_priv: The size of the private area to allocate
4098  *
4099  * Create a new wiphy and associate the given operations with it.
4100  * @sizeof_priv bytes are allocated for private use.
4101  *
4102  * Return: A pointer to the new wiphy. This pointer must be
4103  * assigned to each netdev's ieee80211_ptr for proper operation.
4104  */
4105 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
4106                                       int sizeof_priv)
4107 {
4108         return wiphy_new_nm(ops, sizeof_priv, NULL);
4109 }
4110
4111 /**
4112  * wiphy_register - register a wiphy with cfg80211
4113  *
4114  * @wiphy: The wiphy to register.
4115  *
4116  * Return: A non-negative wiphy index or a negative error code.
4117  */
4118 int wiphy_register(struct wiphy *wiphy);
4119
4120 /**
4121  * wiphy_unregister - deregister a wiphy from cfg80211
4122  *
4123  * @wiphy: The wiphy to unregister.
4124  *
4125  * After this call, no more requests can be made with this priv
4126  * pointer, but the call may sleep to wait for an outstanding
4127  * request that is being handled.
4128  */
4129 void wiphy_unregister(struct wiphy *wiphy);
4130
4131 /**
4132  * wiphy_free - free wiphy
4133  *
4134  * @wiphy: The wiphy to free
4135  */
4136 void wiphy_free(struct wiphy *wiphy);
4137
4138 /* internal structs */
4139 struct cfg80211_conn;
4140 struct cfg80211_internal_bss;
4141 struct cfg80211_cached_keys;
4142 struct cfg80211_cqm_config;
4143
4144 /**
4145  * struct wireless_dev - wireless device state
4146  *
4147  * For netdevs, this structure must be allocated by the driver
4148  * that uses the ieee80211_ptr field in struct net_device (this
4149  * is intentional so it can be allocated along with the netdev.)
4150  * It need not be registered then as netdev registration will
4151  * be intercepted by cfg80211 to see the new wireless device.
4152  *
4153  * For non-netdev uses, it must also be allocated by the driver
4154  * in response to the cfg80211 callbacks that require it, as
4155  * there's no netdev registration in that case it may not be
4156  * allocated outside of callback operations that return it.
4157  *
4158  * @wiphy: pointer to hardware description
4159  * @iftype: interface type
4160  * @list: (private) Used to collect the interfaces
4161  * @netdev: (private) Used to reference back to the netdev, may be %NULL
4162  * @identifier: (private) Identifier used in nl80211 to identify this
4163  *      wireless device if it has no netdev
4164  * @current_bss: (private) Used by the internal configuration code
4165  * @chandef: (private) Used by the internal configuration code to track
4166  *      the user-set channel definition.
4167  * @preset_chandef: (private) Used by the internal configuration code to
4168  *      track the channel to be used for AP later
4169  * @bssid: (private) Used by the internal configuration code
4170  * @ssid: (private) Used by the internal configuration code
4171  * @ssid_len: (private) Used by the internal configuration code
4172  * @mesh_id_len: (private) Used by the internal configuration code
4173  * @mesh_id_up_len: (private) Used by the internal configuration code
4174  * @wext: (private) Used by the internal wireless extensions compat code
4175  * @use_4addr: indicates 4addr mode is used on this interface, must be
4176  *      set by driver (if supported) on add_interface BEFORE registering the
4177  *      netdev and may otherwise be used by driver read-only, will be update
4178  *      by cfg80211 on change_interface
4179  * @mgmt_registrations: list of registrations for management frames
4180  * @mgmt_registrations_lock: lock for the list
4181  * @mtx: mutex used to lock data in this struct, may be used by drivers
4182  *      and some API functions require it held
4183  * @beacon_interval: beacon interval used on this device for transmitting
4184  *      beacons, 0 when not valid
4185  * @address: The address for this device, valid only if @netdev is %NULL
4186  * @is_running: true if this is a non-netdev device that has been started, e.g.
4187  *      the P2P Device.
4188  * @cac_started: true if DFS channel availability check has been started
4189  * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
4190  * @cac_time_ms: CAC time in ms
4191  * @ps: powersave mode is enabled
4192  * @ps_timeout: dynamic powersave timeout
4193  * @ap_unexpected_nlportid: (private) netlink port ID of application
4194  *      registered for unexpected class 3 frames (AP mode)
4195  * @conn: (private) cfg80211 software SME connection state machine data
4196  * @connect_keys: (private) keys to set after connection is established
4197  * @conn_bss_type: connecting/connected BSS type
4198  * @conn_owner_nlportid: (private) connection owner socket port ID
4199  * @disconnect_wk: (private) auto-disconnect work
4200  * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
4201  * @ibss_fixed: (private) IBSS is using fixed BSSID
4202  * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
4203  * @event_list: (private) list for internal event processing
4204  * @event_lock: (private) lock for event list
4205  * @owner_nlportid: (private) owner socket port ID
4206  * @nl_owner_dead: (private) owner socket went away
4207  * @cqm_config: (private) nl80211 RSSI monitor state
4208  */
4209 struct wireless_dev {
4210         struct wiphy *wiphy;
4211         enum nl80211_iftype iftype;
4212
4213         /* the remainder of this struct should be private to cfg80211 */
4214         struct list_head list;
4215         struct net_device *netdev;
4216
4217         u32 identifier;
4218
4219         struct list_head mgmt_registrations;
4220         spinlock_t mgmt_registrations_lock;
4221
4222         struct mutex mtx;
4223
4224         bool use_4addr, is_running;
4225
4226         u8 address[ETH_ALEN] __aligned(sizeof(u16));
4227
4228         /* currently used for IBSS and SME - might be rearranged later */
4229         u8 ssid[IEEE80211_MAX_SSID_LEN];
4230         u8 ssid_len, mesh_id_len, mesh_id_up_len;
4231         struct cfg80211_conn *conn;
4232         struct cfg80211_cached_keys *connect_keys;
4233         enum ieee80211_bss_type conn_bss_type;
4234         u32 conn_owner_nlportid;
4235
4236         struct work_struct disconnect_wk;
4237         u8 disconnect_bssid[ETH_ALEN];
4238
4239         struct list_head event_list;
4240         spinlock_t event_lock;
4241
4242         struct cfg80211_internal_bss *current_bss; /* associated / joined */
4243         struct cfg80211_chan_def preset_chandef;
4244         struct cfg80211_chan_def chandef;
4245
4246         bool ibss_fixed;
4247         bool ibss_dfs_possible;
4248
4249         bool ps;
4250         int ps_timeout;
4251
4252         int beacon_interval;
4253
4254         u32 ap_unexpected_nlportid;
4255
4256         u32 owner_nlportid;
4257         bool nl_owner_dead;
4258
4259         bool cac_started;
4260         unsigned long cac_start_time;
4261         unsigned int cac_time_ms;
4262
4263 #ifdef CONFIG_CFG80211_WEXT
4264         /* wext data */
4265         struct {
4266                 struct cfg80211_ibss_params ibss;
4267                 struct cfg80211_connect_params connect;
4268                 struct cfg80211_cached_keys *keys;
4269                 const u8 *ie;
4270                 size_t ie_len;
4271                 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
4272                 u8 ssid[IEEE80211_MAX_SSID_LEN];
4273                 s8 default_key, default_mgmt_key;
4274                 bool prev_bssid_valid;
4275         } wext;
4276 #endif
4277
4278         struct cfg80211_cqm_config *cqm_config;
4279 };
4280
4281 static inline u8 *wdev_address(struct wireless_dev *wdev)
4282 {
4283         if (wdev->netdev)
4284                 return wdev->netdev->dev_addr;
4285         return wdev->address;
4286 }
4287
4288 static inline bool wdev_running(struct wireless_dev *wdev)
4289 {
4290         if (wdev->netdev)
4291                 return netif_running(wdev->netdev);
4292         return wdev->is_running;
4293 }
4294
4295 /**
4296  * wdev_priv - return wiphy priv from wireless_dev
4297  *
4298  * @wdev: The wireless device whose wiphy's priv pointer to return
4299  * Return: The wiphy priv of @wdev.
4300  */
4301 static inline void *wdev_priv(struct wireless_dev *wdev)
4302 {
4303         BUG_ON(!wdev);
4304         return wiphy_priv(wdev->wiphy);
4305 }
4306
4307 /**
4308  * DOC: Utility functions
4309  *
4310  * cfg80211 offers a number of utility functions that can be useful.
4311  */
4312
4313 /**
4314  * ieee80211_channel_to_frequency - convert channel number to frequency
4315  * @chan: channel number
4316  * @band: band, necessary due to channel number overlap
4317  * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
4318  */
4319 int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
4320
4321 /**
4322  * ieee80211_frequency_to_channel - convert frequency to channel number
4323  * @freq: center frequency
4324  * Return: The corresponding channel, or 0 if the conversion failed.
4325  */
4326 int ieee80211_frequency_to_channel(int freq);
4327
4328 /**
4329  * ieee80211_get_channel - get channel struct from wiphy for specified frequency
4330  *
4331  * @wiphy: the struct wiphy to get the channel for
4332  * @freq: the center frequency of the channel
4333  *
4334  * Return: The channel struct from @wiphy at @freq.
4335  */
4336 struct ieee80211_channel *ieee80211_get_channel(struct wiphy *wiphy, int freq);
4337
4338 /**
4339  * ieee80211_get_response_rate - get basic rate for a given rate
4340  *
4341  * @sband: the band to look for rates in
4342  * @basic_rates: bitmap of basic rates
4343  * @bitrate: the bitrate for which to find the basic rate
4344  *
4345  * Return: The basic rate corresponding to a given bitrate, that
4346  * is the next lower bitrate contained in the basic rate map,
4347  * which is, for this function, given as a bitmap of indices of
4348  * rates in the band's bitrate table.
4349  */
4350 struct ieee80211_rate *
4351 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
4352                             u32 basic_rates, int bitrate);
4353
4354 /**
4355  * ieee80211_mandatory_rates - get mandatory rates for a given band
4356  * @sband: the band to look for rates in
4357  * @scan_width: width of the control channel
4358  *
4359  * This function returns a bitmap of the mandatory rates for the given
4360  * band, bits are set according to the rate position in the bitrates array.
4361  */
4362 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
4363                               enum nl80211_bss_scan_width scan_width);
4364
4365 /*
4366  * Radiotap parsing functions -- for controlled injection support
4367  *
4368  * Implemented in net/wireless/radiotap.c
4369  * Documentation in Documentation/networking/radiotap-headers.txt
4370  */
4371
4372 struct radiotap_align_size {
4373         uint8_t align:4, size:4;
4374 };
4375
4376 struct ieee80211_radiotap_namespace {
4377         const struct radiotap_align_size *align_size;
4378         int n_bits;
4379         uint32_t oui;
4380         uint8_t subns;
4381 };
4382
4383 struct ieee80211_radiotap_vendor_namespaces {
4384         const struct ieee80211_radiotap_namespace *ns;
4385         int n_ns;
4386 };
4387
4388 /**
4389  * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
4390  * @this_arg_index: index of current arg, valid after each successful call
4391  *      to ieee80211_radiotap_iterator_next()
4392  * @this_arg: pointer to current radiotap arg; it is valid after each
4393  *      call to ieee80211_radiotap_iterator_next() but also after
4394  *      ieee80211_radiotap_iterator_init() where it will point to
4395  *      the beginning of the actual data portion
4396  * @this_arg_size: length of the current arg, for convenience
4397  * @current_namespace: pointer to the current namespace definition
4398  *      (or internally %NULL if the current namespace is unknown)
4399  * @is_radiotap_ns: indicates whether the current namespace is the default
4400  *      radiotap namespace or not
4401  *
4402  * @_rtheader: pointer to the radiotap header we are walking through
4403  * @_max_length: length of radiotap header in cpu byte ordering
4404  * @_arg_index: next argument index
4405  * @_arg: next argument pointer
4406  * @_next_bitmap: internal pointer to next present u32
4407  * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
4408  * @_vns: vendor namespace definitions
4409  * @_next_ns_data: beginning of the next namespace's data
4410  * @_reset_on_ext: internal; reset the arg index to 0 when going to the
4411  *      next bitmap word
4412  *
4413  * Describes the radiotap parser state. Fields prefixed with an underscore
4414  * must not be used by users of the parser, only by the parser internally.
4415  */
4416
4417 struct ieee80211_radiotap_iterator {
4418         struct ieee80211_radiotap_header *_rtheader;
4419         const struct ieee80211_radiotap_vendor_namespaces *_vns;
4420         const struct ieee80211_radiotap_namespace *current_namespace;
4421
4422         unsigned char *_arg, *_next_ns_data;
4423         __le32 *_next_bitmap;
4424
4425         unsigned char *this_arg;
4426         int this_arg_index;
4427         int this_arg_size;
4428
4429         int is_radiotap_ns;
4430
4431         int _max_length;
4432         int _arg_index;
4433         uint32_t _bitmap_shifter;
4434         int _reset_on_ext;
4435 };
4436
4437 int
4438 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
4439                                  struct ieee80211_radiotap_header *radiotap_header,
4440                                  int max_length,
4441                                  const struct ieee80211_radiotap_vendor_namespaces *vns);
4442
4443 int
4444 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
4445
4446
4447 extern const unsigned char rfc1042_header[6];
4448 extern const unsigned char bridge_tunnel_header[6];
4449
4450 /**
4451  * ieee80211_get_hdrlen_from_skb - get header length from data
4452  *
4453  * @skb: the frame
4454  *
4455  * Given an skb with a raw 802.11 header at the data pointer this function
4456  * returns the 802.11 header length.
4457  *
4458  * Return: The 802.11 header length in bytes (not including encryption
4459  * headers). Or 0 if the data in the sk_buff is too short to contain a valid
4460  * 802.11 header.
4461  */
4462 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
4463
4464 /**
4465  * ieee80211_hdrlen - get header length in bytes from frame control
4466  * @fc: frame control field in little-endian format
4467  * Return: The header length in bytes.
4468  */
4469 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
4470
4471 /**
4472  * ieee80211_get_mesh_hdrlen - get mesh extension header length
4473  * @meshhdr: the mesh extension header, only the flags field
4474  *      (first byte) will be accessed
4475  * Return: The length of the extension header, which is always at
4476  * least 6 bytes and at most 18 if address 5 and 6 are present.
4477  */
4478 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
4479
4480 /**
4481  * DOC: Data path helpers
4482  *
4483  * In addition to generic utilities, cfg80211 also offers
4484  * functions that help implement the data path for devices
4485  * that do not do the 802.11/802.3 conversion on the device.
4486  */
4487
4488 /**
4489  * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
4490  * @skb: the 802.11 data frame
4491  * @ehdr: pointer to a &struct ethhdr that will get the header, instead
4492  *      of it being pushed into the SKB
4493  * @addr: the device MAC address
4494  * @iftype: the virtual interface type
4495  * @data_offset: offset of payload after the 802.11 header
4496  * Return: 0 on success. Non-zero on error.
4497  */
4498 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
4499                                   const u8 *addr, enum nl80211_iftype iftype,
4500                                   u8 data_offset);
4501
4502 /**
4503  * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
4504  * @skb: the 802.11 data frame
4505  * @addr: the device MAC address
4506  * @iftype: the virtual interface type
4507  * Return: 0 on success. Non-zero on error.
4508  */
4509 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
4510                                          enum nl80211_iftype iftype)
4511 {
4512         return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0);
4513 }
4514
4515 /**
4516  * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
4517  *
4518  * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
4519  * The @list will be empty if the decode fails. The @skb must be fully
4520  * header-less before being passed in here; it is freed in this function.
4521  *
4522  * @skb: The input A-MSDU frame without any headers.
4523  * @list: The output list of 802.3 frames. It must be allocated and
4524  *      initialized by by the caller.
4525  * @addr: The device MAC address.
4526  * @iftype: The device interface type.
4527  * @extra_headroom: The hardware extra headroom for SKBs in the @list.
4528  * @check_da: DA to check in the inner ethernet header, or NULL
4529  * @check_sa: SA to check in the inner ethernet header, or NULL
4530  */
4531 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
4532                               const u8 *addr, enum nl80211_iftype iftype,
4533                               const unsigned int extra_headroom,
4534                               const u8 *check_da, const u8 *check_sa);
4535
4536 /**
4537  * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
4538  * @skb: the data frame
4539  * @qos_map: Interworking QoS mapping or %NULL if not in use
4540  * Return: The 802.1p/1d tag.
4541  */
4542 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
4543                                     struct cfg80211_qos_map *qos_map);
4544
4545 /**
4546  * cfg80211_find_ie_match - match information element and byte array in data
4547  *
4548  * @eid: element ID
4549  * @ies: data consisting of IEs
4550  * @len: length of data
4551  * @match: byte array to match
4552  * @match_len: number of bytes in the match array
4553  * @match_offset: offset in the IE where the byte array should match.
4554  *      If match_len is zero, this must also be set to zero.
4555  *      Otherwise this must be set to 2 or more, because the first
4556  *      byte is the element id, which is already compared to eid, and
4557  *      the second byte is the IE length.
4558  *
4559  * Return: %NULL if the element ID could not be found or if
4560  * the element is invalid (claims to be longer than the given
4561  * data) or if the byte array doesn't match, or a pointer to the first
4562  * byte of the requested element, that is the byte containing the
4563  * element ID.
4564  *
4565  * Note: There are no checks on the element length other than
4566  * having to fit into the given data and being large enough for the
4567  * byte array to match.
4568  */
4569 const u8 *cfg80211_find_ie_match(u8 eid, const u8 *ies, int len,
4570                                  const u8 *match, int match_len,
4571                                  int match_offset);
4572
4573 /**
4574  * cfg80211_find_ie - find information element in data
4575  *
4576  * @eid: element ID
4577  * @ies: data consisting of IEs
4578  * @len: length of data
4579  *
4580  * Return: %NULL if the element ID could not be found or if
4581  * the element is invalid (claims to be longer than the given
4582  * data), or a pointer to the first byte of the requested
4583  * element, that is the byte containing the element ID.
4584  *
4585  * Note: There are no checks on the element length other than
4586  * having to fit into the given data.
4587  */
4588 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
4589 {
4590         return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
4591 }
4592
4593 /**
4594  * cfg80211_find_ext_ie - find information element with EID Extension in data
4595  *
4596  * @ext_eid: element ID Extension
4597  * @ies: data consisting of IEs
4598  * @len: length of data
4599  *
4600  * Return: %NULL if the extended element ID could not be found or if
4601  * the element is invalid (claims to be longer than the given
4602  * data), or a pointer to the first byte of the requested
4603  * element, that is the byte containing the element ID.
4604  *
4605  * Note: There are no checks on the element length other than
4606  * having to fit into the given data.
4607  */
4608 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
4609 {
4610         return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
4611                                       &ext_eid, 1, 2);
4612 }
4613
4614 /**
4615  * cfg80211_find_vendor_ie - find vendor specific information element in data
4616  *
4617  * @oui: vendor OUI
4618  * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
4619  * @ies: data consisting of IEs
4620  * @len: length of data
4621  *
4622  * Return: %NULL if the vendor specific element ID could not be found or if the
4623  * element is invalid (claims to be longer than the given data), or a pointer to
4624  * the first byte of the requested element, that is the byte containing the
4625  * element ID.
4626  *
4627  * Note: There are no checks on the element length other than having to fit into
4628  * the given data.
4629  */
4630 const u8 *cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
4631                                   const u8 *ies, int len);
4632
4633 /**
4634  * DOC: Regulatory enforcement infrastructure
4635  *
4636  * TODO
4637  */
4638
4639 /**
4640  * regulatory_hint - driver hint to the wireless core a regulatory domain
4641  * @wiphy: the wireless device giving the hint (used only for reporting
4642  *      conflicts)
4643  * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
4644  *      should be in. If @rd is set this should be NULL. Note that if you
4645  *      set this to NULL you should still set rd->alpha2 to some accepted
4646  *      alpha2.
4647  *
4648  * Wireless drivers can use this function to hint to the wireless core
4649  * what it believes should be the current regulatory domain by
4650  * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
4651  * domain should be in or by providing a completely build regulatory domain.
4652  * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
4653  * for a regulatory domain structure for the respective country.
4654  *
4655  * The wiphy must have been registered to cfg80211 prior to this call.
4656  * For cfg80211 drivers this means you must first use wiphy_register(),
4657  * for mac80211 drivers you must first use ieee80211_register_hw().
4658  *
4659  * Drivers should check the return value, its possible you can get
4660  * an -ENOMEM.
4661  *
4662  * Return: 0 on success. -ENOMEM.
4663  */
4664 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
4665
4666 /**
4667  * regulatory_set_wiphy_regd - set regdom info for self managed drivers
4668  * @wiphy: the wireless device we want to process the regulatory domain on
4669  * @rd: the regulatory domain informatoin to use for this wiphy
4670  *
4671  * Set the regulatory domain information for self-managed wiphys, only they
4672  * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
4673  * information.
4674  *
4675  * Return: 0 on success. -EINVAL, -EPERM
4676  */
4677 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
4678                               struct ieee80211_regdomain *rd);
4679
4680 /**
4681  * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
4682  * @wiphy: the wireless device we want to process the regulatory domain on
4683  * @rd: the regulatory domain information to use for this wiphy
4684  *
4685  * This functions requires the RTNL to be held and applies the new regdomain
4686  * synchronously to this wiphy. For more details see
4687  * regulatory_set_wiphy_regd().
4688  *
4689  * Return: 0 on success. -EINVAL, -EPERM
4690  */
4691 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
4692                                         struct ieee80211_regdomain *rd);
4693
4694 /**
4695  * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
4696  * @wiphy: the wireless device we want to process the regulatory domain on
4697  * @regd: the custom regulatory domain to use for this wiphy
4698  *
4699  * Drivers can sometimes have custom regulatory domains which do not apply
4700  * to a specific country. Drivers can use this to apply such custom regulatory
4701  * domains. This routine must be called prior to wiphy registration. The
4702  * custom regulatory domain will be trusted completely and as such previous
4703  * default channel settings will be disregarded. If no rule is found for a
4704  * channel on the regulatory domain the channel will be disabled.
4705  * Drivers using this for a wiphy should also set the wiphy flag
4706  * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
4707  * that called this helper.
4708  */
4709 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
4710                                    const struct ieee80211_regdomain *regd);
4711
4712 /**
4713  * freq_reg_info - get regulatory information for the given frequency
4714  * @wiphy: the wiphy for which we want to process this rule for
4715  * @center_freq: Frequency in KHz for which we want regulatory information for
4716  *
4717  * Use this function to get the regulatory rule for a specific frequency on
4718  * a given wireless device. If the device has a specific regulatory domain
4719  * it wants to follow we respect that unless a country IE has been received
4720  * and processed already.
4721  *
4722  * Return: A valid pointer, or, when an error occurs, for example if no rule
4723  * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
4724  * check and PTR_ERR() to obtain the numeric return value. The numeric return
4725  * value will be -ERANGE if we determine the given center_freq does not even
4726  * have a regulatory rule for a frequency range in the center_freq's band.
4727  * See freq_in_rule_band() for our current definition of a band -- this is
4728  * purely subjective and right now it's 802.11 specific.
4729  */
4730 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
4731                                                u32 center_freq);
4732
4733 /**
4734  * reg_initiator_name - map regulatory request initiator enum to name
4735  * @initiator: the regulatory request initiator
4736  *
4737  * You can use this to map the regulatory request initiator enum to a
4738  * proper string representation.
4739  */
4740 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
4741
4742 /**
4743  * DOC: Internal regulatory db functions
4744  *
4745  */
4746
4747 /**
4748  * reg_query_regdb_wmm -  Query internal regulatory db for wmm rule
4749  * Regulatory self-managed driver can use it to proactively
4750  *
4751  * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
4752  * @freq: the freqency(in MHz) to be queried.
4753  * @ptr: pointer where the regdb wmm data is to be stored (or %NULL if
4754  *      irrelevant). This can be used later for deduplication.
4755  * @rule: pointer to store the wmm rule from the regulatory db.
4756  *
4757  * Self-managed wireless drivers can use this function to  query
4758  * the internal regulatory database to check whether the given
4759  * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
4760  *
4761  * Drivers should check the return value, its possible you can get
4762  * an -ENODATA.
4763  *
4764  * Return: 0 on success. -ENODATA.
4765  */
4766 int reg_query_regdb_wmm(char *alpha2, int freq, u32 *ptr,
4767                         struct ieee80211_wmm_rule *rule);
4768
4769 /*
4770  * callbacks for asynchronous cfg80211 methods, notification
4771  * functions and BSS handling helpers
4772  */
4773
4774 /**
4775  * cfg80211_scan_done - notify that scan finished
4776  *
4777  * @request: the corresponding scan request
4778  * @info: information about the completed scan
4779  */
4780 void cfg80211_scan_done(struct cfg80211_scan_request *request,
4781                         struct cfg80211_scan_info *info);
4782
4783 /**
4784  * cfg80211_sched_scan_results - notify that new scan results are available
4785  *
4786  * @wiphy: the wiphy which got scheduled scan results
4787  * @reqid: identifier for the related scheduled scan request
4788  */
4789 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
4790
4791 /**
4792  * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
4793  *
4794  * @wiphy: the wiphy on which the scheduled scan stopped
4795  * @reqid: identifier for the related scheduled scan request
4796  *
4797  * The driver can call this function to inform cfg80211 that the
4798  * scheduled scan had to be stopped, for whatever reason.  The driver
4799  * is then called back via the sched_scan_stop operation when done.
4800  */
4801 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
4802
4803 /**
4804  * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
4805  *
4806  * @wiphy: the wiphy on which the scheduled scan stopped
4807  * @reqid: identifier for the related scheduled scan request
4808  *
4809  * The driver can call this function to inform cfg80211 that the
4810  * scheduled scan had to be stopped, for whatever reason.  The driver
4811  * is then called back via the sched_scan_stop operation when done.
4812  * This function should be called with rtnl locked.
4813  */
4814 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy, u64 reqid);
4815
4816 /**
4817  * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
4818  * @wiphy: the wiphy reporting the BSS
4819  * @data: the BSS metadata
4820  * @mgmt: the management frame (probe response or beacon)
4821  * @len: length of the management frame
4822  * @gfp: context flags
4823  *
4824  * This informs cfg80211 that BSS information was found and
4825  * the BSS should be updated/added.
4826  *
4827  * Return: A referenced struct, must be released with cfg80211_put_bss()!
4828  * Or %NULL on error.
4829  */
4830 struct cfg80211_bss * __must_check
4831 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
4832                                struct cfg80211_inform_bss *data,
4833                                struct ieee80211_mgmt *mgmt, size_t len,
4834                                gfp_t gfp);
4835
4836 static inline struct cfg80211_bss * __must_check
4837 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
4838                                 struct ieee80211_channel *rx_channel,
4839                                 enum nl80211_bss_scan_width scan_width,
4840                                 struct ieee80211_mgmt *mgmt, size_t len,
4841                                 s32 signal, gfp_t gfp)
4842 {
4843         struct cfg80211_inform_bss data = {
4844                 .chan = rx_channel,
4845                 .scan_width = scan_width,
4846                 .signal = signal,
4847         };
4848
4849         return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4850 }
4851
4852 static inline struct cfg80211_bss * __must_check
4853 cfg80211_inform_bss_frame(struct wiphy *wiphy,
4854                           struct ieee80211_channel *rx_channel,
4855                           struct ieee80211_mgmt *mgmt, size_t len,
4856                           s32 signal, gfp_t gfp)
4857 {
4858         struct cfg80211_inform_bss data = {
4859                 .chan = rx_channel,
4860                 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4861                 .signal = signal,
4862         };
4863
4864         return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4865 }
4866
4867 /**
4868  * enum cfg80211_bss_frame_type - frame type that the BSS data came from
4869  * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
4870  *      from a beacon or probe response
4871  * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
4872  * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
4873  */
4874 enum cfg80211_bss_frame_type {
4875         CFG80211_BSS_FTYPE_UNKNOWN,
4876         CFG80211_BSS_FTYPE_BEACON,
4877         CFG80211_BSS_FTYPE_PRESP,
4878 };
4879
4880 /**
4881  * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
4882  *
4883  * @wiphy: the wiphy reporting the BSS
4884  * @data: the BSS metadata
4885  * @ftype: frame type (if known)
4886  * @bssid: the BSSID of the BSS
4887  * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
4888  * @capability: the capability field sent by the peer
4889  * @beacon_interval: the beacon interval announced by the peer
4890  * @ie: additional IEs sent by the peer
4891  * @ielen: length of the additional IEs
4892  * @gfp: context flags
4893  *
4894  * This informs cfg80211 that BSS information was found and
4895  * the BSS should be updated/added.
4896  *
4897  * Return: A referenced struct, must be released with cfg80211_put_bss()!
4898  * Or %NULL on error.
4899  */
4900 struct cfg80211_bss * __must_check
4901 cfg80211_inform_bss_data(struct wiphy *wiphy,
4902                          struct cfg80211_inform_bss *data,
4903                          enum cfg80211_bss_frame_type ftype,
4904                          const u8 *bssid, u64 tsf, u16 capability,
4905                          u16 beacon_interval, const u8 *ie, size_t ielen,
4906                          gfp_t gfp);
4907
4908 static inline struct cfg80211_bss * __must_check
4909 cfg80211_inform_bss_width(struct wiphy *wiphy,
4910                           struct ieee80211_channel *rx_channel,
4911                           enum nl80211_bss_scan_width scan_width,
4912                           enum cfg80211_bss_frame_type ftype,
4913                           const u8 *bssid, u64 tsf, u16 capability,
4914                           u16 beacon_interval, const u8 *ie, size_t ielen,
4915                           s32 signal, gfp_t gfp)
4916 {
4917         struct cfg80211_inform_bss data = {
4918                 .chan = rx_channel,
4919                 .scan_width = scan_width,
4920                 .signal = signal,
4921         };
4922
4923         return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4924                                         capability, beacon_interval, ie, ielen,
4925                                         gfp);
4926 }
4927
4928 static inline struct cfg80211_bss * __must_check
4929 cfg80211_inform_bss(struct wiphy *wiphy,
4930                     struct ieee80211_channel *rx_channel,
4931                     enum cfg80211_bss_frame_type ftype,
4932                     const u8 *bssid, u64 tsf, u16 capability,
4933                     u16 beacon_interval, const u8 *ie, size_t ielen,
4934                     s32 signal, gfp_t gfp)
4935 {
4936         struct cfg80211_inform_bss data = {
4937                 .chan = rx_channel,
4938                 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4939                 .signal = signal,
4940         };
4941
4942         return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4943                                         capability, beacon_interval, ie, ielen,
4944                                         gfp);
4945 }
4946
4947 /**
4948  * cfg80211_get_bss - get a BSS reference
4949  * @wiphy: the wiphy this BSS struct belongs to
4950  * @channel: the channel to search on (or %NULL)
4951  * @bssid: the desired BSSID (or %NULL)
4952  * @ssid: the desired SSID (or %NULL)
4953  * @ssid_len: length of the SSID (or 0)
4954  * @bss_type: type of BSS, see &enum ieee80211_bss_type
4955  * @privacy: privacy filter, see &enum ieee80211_privacy
4956  */
4957 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
4958                                       struct ieee80211_channel *channel,
4959                                       const u8 *bssid,
4960                                       const u8 *ssid, size_t ssid_len,
4961                                       enum ieee80211_bss_type bss_type,
4962                                       enum ieee80211_privacy privacy);
4963 static inline struct cfg80211_bss *
4964 cfg80211_get_ibss(struct wiphy *wiphy,
4965                   struct ieee80211_channel *channel,
4966                   const u8 *ssid, size_t ssid_len)
4967 {
4968         return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
4969                                 IEEE80211_BSS_TYPE_IBSS,
4970                                 IEEE80211_PRIVACY_ANY);
4971 }
4972
4973 /**
4974  * cfg80211_ref_bss - reference BSS struct
4975  * @wiphy: the wiphy this BSS struct belongs to
4976  * @bss: the BSS struct to reference
4977  *
4978  * Increments the refcount of the given BSS struct.
4979  */
4980 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4981
4982 /**
4983  * cfg80211_put_bss - unref BSS struct
4984  * @wiphy: the wiphy this BSS struct belongs to
4985  * @bss: the BSS struct
4986  *
4987  * Decrements the refcount of the given BSS struct.
4988  */
4989 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4990
4991 /**
4992  * cfg80211_unlink_bss - unlink BSS from internal data structures
4993  * @wiphy: the wiphy
4994  * @bss: the bss to remove
4995  *
4996  * This function removes the given BSS from the internal data structures
4997  * thereby making it no longer show up in scan results etc. Use this
4998  * function when you detect a BSS is gone. Normally BSSes will also time
4999  * out, so it is not necessary to use this function at all.
5000  */
5001 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5002
5003 static inline enum nl80211_bss_scan_width
5004 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
5005 {
5006         switch (chandef->width) {
5007         case NL80211_CHAN_WIDTH_5:
5008                 return NL80211_BSS_CHAN_WIDTH_5;
5009         case NL80211_CHAN_WIDTH_10:
5010                 return NL80211_BSS_CHAN_WIDTH_10;
5011         default:
5012                 return NL80211_BSS_CHAN_WIDTH_20;
5013         }
5014 }
5015
5016 /**
5017  * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
5018  * @dev: network device
5019  * @buf: authentication frame (header + body)
5020  * @len: length of the frame data
5021  *
5022  * This function is called whenever an authentication, disassociation or
5023  * deauthentication frame has been received and processed in station mode.
5024  * After being asked to authenticate via cfg80211_ops::auth() the driver must
5025  * call either this function or cfg80211_auth_timeout().
5026  * After being asked to associate via cfg80211_ops::assoc() the driver must
5027  * call either this function or cfg80211_auth_timeout().
5028  * While connected, the driver must calls this for received and processed
5029  * disassociation and deauthentication frames. If the frame couldn't be used
5030  * because it was unprotected, the driver must call the function
5031  * cfg80211_rx_unprot_mlme_mgmt() instead.
5032  *
5033  * This function may sleep. The caller must hold the corresponding wdev's mutex.
5034  */
5035 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
5036
5037 /**
5038  * cfg80211_auth_timeout - notification of timed out authentication
5039  * @dev: network device
5040  * @addr: The MAC address of the device with which the authentication timed out
5041  *
5042  * This function may sleep. The caller must hold the corresponding wdev's
5043  * mutex.
5044  */
5045 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
5046
5047 /**
5048  * cfg80211_rx_assoc_resp - notification of processed association response
5049  * @dev: network device
5050  * @bss: the BSS that association was requested with, ownership of the pointer
5051  *      moves to cfg80211 in this call
5052  * @buf: authentication frame (header + body)
5053  * @len: length of the frame data
5054  * @uapsd_queues: bitmap of queues configured for uapsd. Same format
5055  *      as the AC bitmap in the QoS info field
5056  *
5057  * After being asked to associate via cfg80211_ops::assoc() the driver must
5058  * call either this function or cfg80211_auth_timeout().
5059  *
5060  * This function may sleep. The caller must hold the corresponding wdev's mutex.
5061  */
5062 void cfg80211_rx_assoc_resp(struct net_device *dev,
5063                             struct cfg80211_bss *bss,
5064                             const u8 *buf, size_t len,
5065                             int uapsd_queues);
5066
5067 /**
5068  * cfg80211_assoc_timeout - notification of timed out association
5069  * @dev: network device
5070  * @bss: The BSS entry with which association timed out.
5071  *
5072  * This function may sleep. The caller must hold the corresponding wdev's mutex.
5073  */
5074 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
5075
5076 /**
5077  * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
5078  * @dev: network device
5079  * @bss: The BSS entry with which association was abandoned.
5080  *
5081  * Call this whenever - for reasons reported through other API, like deauth RX,
5082  * an association attempt was abandoned.
5083  * This function may sleep. The caller must hold the corresponding wdev's mutex.
5084  */
5085 void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
5086
5087 /**
5088  * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
5089  * @dev: network device
5090  * @buf: 802.11 frame (header + body)
5091  * @len: length of the frame data
5092  *
5093  * This function is called whenever deauthentication has been processed in
5094  * station mode. This includes both received deauthentication frames and
5095  * locally generated ones. This function may sleep. The caller must hold the
5096  * corresponding wdev's mutex.
5097  */
5098 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
5099
5100 /**
5101  * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
5102  * @dev: network device
5103  * @buf: deauthentication frame (header + body)
5104  * @len: length of the frame data
5105  *
5106  * This function is called whenever a received deauthentication or dissassoc
5107  * frame has been dropped in station mode because of MFP being used but the
5108  * frame was not protected. This function may sleep.
5109  */
5110 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
5111                                   const u8 *buf, size_t len);
5112
5113 /**
5114  * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
5115  * @dev: network device
5116  * @addr: The source MAC address of the frame
5117  * @key_type: The key type that the received frame used
5118  * @key_id: Key identifier (0..3). Can be -1 if missing.
5119  * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
5120  * @gfp: allocation flags
5121  *
5122  * This function is called whenever the local MAC detects a MIC failure in a
5123  * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
5124  * primitive.
5125  */
5126 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
5127                                   enum nl80211_key_type key_type, int key_id,
5128                                   const u8 *tsc, gfp_t gfp);
5129
5130 /**
5131  * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
5132  *
5133  * @dev: network device
5134  * @bssid: the BSSID of the IBSS joined
5135  * @channel: the channel of the IBSS joined
5136  * @gfp: allocation flags
5137  *
5138  * This function notifies cfg80211 that the device joined an IBSS or
5139  * switched to a different BSSID. Before this function can be called,
5140  * either a beacon has to have been received from the IBSS, or one of
5141  * the cfg80211_inform_bss{,_frame} functions must have been called
5142  * with the locally generated beacon -- this guarantees that there is
5143  * always a scan result for this IBSS. cfg80211 will handle the rest.
5144  */
5145 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
5146                           struct ieee80211_channel *channel, gfp_t gfp);
5147
5148 /**
5149  * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
5150  *
5151  * @dev: network device
5152  * @macaddr: the MAC address of the new candidate
5153  * @ie: information elements advertised by the peer candidate
5154  * @ie_len: lenght of the information elements buffer
5155  * @gfp: allocation flags
5156  *
5157  * This function notifies cfg80211 that the mesh peer candidate has been
5158  * detected, most likely via a beacon or, less likely, via a probe response.
5159  * cfg80211 then sends a notification to userspace.
5160  */
5161 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
5162                 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
5163
5164 /**
5165  * DOC: RFkill integration
5166  *
5167  * RFkill integration in cfg80211 is almost invisible to drivers,
5168  * as cfg80211 automatically registers an rfkill instance for each
5169  * wireless device it knows about. Soft kill is also translated
5170  * into disconnecting and turning all interfaces off, drivers are
5171  * expected to turn off the device when all interfaces are down.
5172  *
5173  * However, devices may have a hard RFkill line, in which case they
5174  * also need to interact with the rfkill subsystem, via cfg80211.
5175  * They can do this with a few helper functions documented here.
5176  */
5177
5178 /**
5179  * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
5180  * @wiphy: the wiphy
5181  * @blocked: block status
5182  */
5183 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
5184
5185 /**
5186  * wiphy_rfkill_start_polling - start polling rfkill
5187  * @wiphy: the wiphy
5188  */
5189 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
5190
5191 /**
5192  * wiphy_rfkill_stop_polling - stop polling rfkill
5193  * @wiphy: the wiphy
5194  */
5195 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
5196
5197 /**
5198  * DOC: Vendor commands
5199  *
5200  * Occasionally, there are special protocol or firmware features that
5201  * can't be implemented very openly. For this and similar cases, the
5202  * vendor command functionality allows implementing the features with
5203  * (typically closed-source) userspace and firmware, using nl80211 as
5204  * the configuration mechanism.
5205  *
5206  * A driver supporting vendor commands must register them as an array
5207  * in struct wiphy, with handlers for each one, each command has an
5208  * OUI and sub command ID to identify it.
5209  *
5210  * Note that this feature should not be (ab)used to implement protocol
5211  * features that could openly be shared across drivers. In particular,
5212  * it must never be required to use vendor commands to implement any
5213  * "normal" functionality that higher-level userspace like connection
5214  * managers etc. need.
5215  */
5216
5217 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
5218                                            enum nl80211_commands cmd,
5219                                            enum nl80211_attrs attr,
5220                                            int approxlen);
5221
5222 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
5223                                            struct wireless_dev *wdev,
5224                                            enum nl80211_commands cmd,
5225                                            enum nl80211_attrs attr,
5226                                            int vendor_event_idx,
5227                                            int approxlen, gfp_t gfp);
5228
5229 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
5230
5231 /**
5232  * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
5233  * @wiphy: the wiphy
5234  * @approxlen: an upper bound of the length of the data that will
5235  *      be put into the skb
5236  *
5237  * This function allocates and pre-fills an skb for a reply to
5238  * a vendor command. Since it is intended for a reply, calling
5239  * it outside of a vendor command's doit() operation is invalid.
5240  *
5241  * The returned skb is pre-filled with some identifying data in
5242  * a way that any data that is put into the skb (with skb_put(),
5243  * nla_put() or similar) will end up being within the
5244  * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
5245  * with the skb is adding data for the corresponding userspace tool
5246  * which can then read that data out of the vendor data attribute.
5247  * You must not modify the skb in any other way.
5248  *
5249  * When done, call cfg80211_vendor_cmd_reply() with the skb and return
5250  * its error code as the result of the doit() operation.
5251  *
5252  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5253  */
5254 static inline struct sk_buff *
5255 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
5256 {
5257         return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
5258                                           NL80211_ATTR_VENDOR_DATA, approxlen);
5259 }
5260
5261 /**
5262  * cfg80211_vendor_cmd_reply - send the reply skb
5263  * @skb: The skb, must have been allocated with
5264  *      cfg80211_vendor_cmd_alloc_reply_skb()
5265  *
5266  * Since calling this function will usually be the last thing
5267  * before returning from the vendor command doit() you should
5268  * return the error code.  Note that this function consumes the
5269  * skb regardless of the return value.
5270  *
5271  * Return: An error code or 0 on success.
5272  */
5273 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
5274
5275 /**
5276  * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
5277  * @wiphy: the wiphy
5278  * @wdev: the wireless device
5279  * @event_idx: index of the vendor event in the wiphy's vendor_events
5280  * @approxlen: an upper bound of the length of the data that will
5281  *      be put into the skb
5282  * @gfp: allocation flags
5283  *
5284  * This function allocates and pre-fills an skb for an event on the
5285  * vendor-specific multicast group.
5286  *
5287  * If wdev != NULL, both the ifindex and identifier of the specified
5288  * wireless device are added to the event message before the vendor data
5289  * attribute.
5290  *
5291  * When done filling the skb, call cfg80211_vendor_event() with the
5292  * skb to send the event.
5293  *
5294  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5295  */
5296 static inline struct sk_buff *
5297 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
5298                              int approxlen, int event_idx, gfp_t gfp)
5299 {
5300         return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
5301                                           NL80211_ATTR_VENDOR_DATA,
5302                                           event_idx, approxlen, gfp);
5303 }
5304
5305 /**
5306  * cfg80211_vendor_event - send the event
5307  * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
5308  * @gfp: allocation flags
5309  *
5310  * This function sends the given @skb, which must have been allocated
5311  * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
5312  */
5313 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
5314 {
5315         __cfg80211_send_event_skb(skb, gfp);
5316 }
5317
5318 #ifdef CONFIG_NL80211_TESTMODE
5319 /**
5320  * DOC: Test mode
5321  *
5322  * Test mode is a set of utility functions to allow drivers to
5323  * interact with driver-specific tools to aid, for instance,
5324  * factory programming.
5325  *
5326  * This chapter describes how drivers interact with it, for more
5327  * information see the nl80211 book's chapter on it.
5328  */
5329
5330 /**
5331  * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
5332  * @wiphy: the wiphy
5333  * @approxlen: an upper bound of the length of the data that will
5334  *      be put into the skb
5335  *
5336  * This function allocates and pre-fills an skb for a reply to
5337  * the testmode command. Since it is intended for a reply, calling
5338  * it outside of the @testmode_cmd operation is invalid.
5339  *
5340  * The returned skb is pre-filled with the wiphy index and set up in
5341  * a way that any data that is put into the skb (with skb_put(),
5342  * nla_put() or similar) will end up being within the
5343  * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
5344  * with the skb is adding data for the corresponding userspace tool
5345  * which can then read that data out of the testdata attribute. You
5346  * must not modify the skb in any other way.
5347  *
5348  * When done, call cfg80211_testmode_reply() with the skb and return
5349  * its error code as the result of the @testmode_cmd operation.
5350  *
5351  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5352  */
5353 static inline struct sk_buff *
5354 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
5355 {
5356         return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
5357                                           NL80211_ATTR_TESTDATA, approxlen);
5358 }
5359
5360 /**
5361  * cfg80211_testmode_reply - send the reply skb
5362  * @skb: The skb, must have been allocated with
5363  *      cfg80211_testmode_alloc_reply_skb()
5364  *
5365  * Since calling this function will usually be the last thing
5366  * before returning from the @testmode_cmd you should return
5367  * the error code.  Note that this function consumes the skb
5368  * regardless of the return value.
5369  *
5370  * Return: An error code or 0 on success.
5371  */
5372 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
5373 {
5374         return cfg80211_vendor_cmd_reply(skb);
5375 }
5376
5377 /**
5378  * cfg80211_testmode_alloc_event_skb - allocate testmode event
5379  * @wiphy: the wiphy
5380  * @approxlen: an upper bound of the length of the data that will
5381  *      be put into the skb
5382  * @gfp: allocation flags
5383  *
5384  * This function allocates and pre-fills an skb for an event on the
5385  * testmode multicast group.
5386  *
5387  * The returned skb is set up in the same way as with
5388  * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
5389  * there, you should simply add data to it that will then end up in the
5390  * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
5391  * in any other way.
5392  *
5393  * When done filling the skb, call cfg80211_testmode_event() with the
5394  * skb to send the event.
5395  *
5396  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5397  */
5398 static inline struct sk_buff *
5399 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
5400 {
5401         return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
5402                                           NL80211_ATTR_TESTDATA, -1,
5403                                           approxlen, gfp);
5404 }
5405
5406 /**
5407  * cfg80211_testmode_event - send the event
5408  * @skb: The skb, must have been allocated with
5409  *      cfg80211_testmode_alloc_event_skb()
5410  * @gfp: allocation flags
5411  *
5412  * This function sends the given @skb, which must have been allocated
5413  * by cfg80211_testmode_alloc_event_skb(), as an event. It always
5414  * consumes it.
5415  */
5416 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
5417 {
5418         __cfg80211_send_event_skb(skb, gfp);
5419 }
5420
5421 #define CFG80211_TESTMODE_CMD(cmd)      .testmode_cmd = (cmd),
5422 #define CFG80211_TESTMODE_DUMP(cmd)     .testmode_dump = (cmd),
5423 #else
5424 #define CFG80211_TESTMODE_CMD(cmd)
5425 #define CFG80211_TESTMODE_DUMP(cmd)
5426 #endif
5427
5428 /**
5429  * struct cfg80211_fils_resp_params - FILS connection response params
5430  * @kek: KEK derived from a successful FILS connection (may be %NULL)
5431  * @kek_len: Length of @fils_kek in octets
5432  * @update_erp_next_seq_num: Boolean value to specify whether the value in
5433  *      @erp_next_seq_num is valid.
5434  * @erp_next_seq_num: The next sequence number to use in ERP message in
5435  *      FILS Authentication. This value should be specified irrespective of the
5436  *      status for a FILS connection.
5437  * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
5438  * @pmk_len: Length of @pmk in octets
5439  * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
5440  *      used for this FILS connection (may be %NULL).
5441  */
5442 struct cfg80211_fils_resp_params {
5443         const u8 *kek;
5444         size_t kek_len;
5445         bool update_erp_next_seq_num;
5446         u16 erp_next_seq_num;
5447         const u8 *pmk;
5448         size_t pmk_len;
5449         const u8 *pmkid;
5450 };
5451
5452 /**
5453  * struct cfg80211_connect_resp_params - Connection response params
5454  * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
5455  *      %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5456  *      the real status code for failures. If this call is used to report a
5457  *      failure due to a timeout (e.g., not receiving an Authentication frame
5458  *      from the AP) instead of an explicit rejection by the AP, -1 is used to
5459  *      indicate that this is a failure, but without a status code.
5460  *      @timeout_reason is used to report the reason for the timeout in that
5461  *      case.
5462  * @bssid: The BSSID of the AP (may be %NULL)
5463  * @bss: Entry of bss to which STA got connected to, can be obtained through
5464  *      cfg80211_get_bss() (may be %NULL). Only one parameter among @bssid and
5465  *      @bss needs to be specified.
5466  * @req_ie: Association request IEs (may be %NULL)
5467  * @req_ie_len: Association request IEs length
5468  * @resp_ie: Association response IEs (may be %NULL)
5469  * @resp_ie_len: Association response IEs length
5470  * @fils: FILS connection response parameters.
5471  * @timeout_reason: Reason for connection timeout. This is used when the
5472  *      connection fails due to a timeout instead of an explicit rejection from
5473  *      the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
5474  *      not known. This value is used only if @status < 0 to indicate that the
5475  *      failure is due to a timeout and not due to explicit rejection by the AP.
5476  *      This value is ignored in other cases (@status >= 0).
5477  */
5478 struct cfg80211_connect_resp_params {
5479         int status;
5480         const u8 *bssid;
5481         struct cfg80211_bss *bss;
5482         const u8 *req_ie;
5483         size_t req_ie_len;
5484         const u8 *resp_ie;
5485         size_t resp_ie_len;
5486         struct cfg80211_fils_resp_params fils;
5487         enum nl80211_timeout_reason timeout_reason;
5488 };
5489
5490 /**
5491  * cfg80211_connect_done - notify cfg80211 of connection result
5492  *
5493  * @dev: network device
5494  * @params: connection response parameters
5495  * @gfp: allocation flags
5496  *
5497  * It should be called by the underlying driver once execution of the connection
5498  * request from connect() has been completed. This is similar to
5499  * cfg80211_connect_bss(), but takes a structure pointer for connection response
5500  * parameters. Only one of the functions among cfg80211_connect_bss(),
5501  * cfg80211_connect_result(), cfg80211_connect_timeout(),
5502  * and cfg80211_connect_done() should be called.
5503  */
5504 void cfg80211_connect_done(struct net_device *dev,
5505                            struct cfg80211_connect_resp_params *params,
5506                            gfp_t gfp);
5507
5508 /**
5509  * cfg80211_connect_bss - notify cfg80211 of connection result
5510  *
5511  * @dev: network device
5512  * @bssid: the BSSID of the AP
5513  * @bss: entry of bss to which STA got connected to, can be obtained
5514  *      through cfg80211_get_bss (may be %NULL)
5515  * @req_ie: association request IEs (maybe be %NULL)
5516  * @req_ie_len: association request IEs length
5517  * @resp_ie: association response IEs (may be %NULL)
5518  * @resp_ie_len: assoc response IEs length
5519  * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
5520  *      %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5521  *      the real status code for failures. If this call is used to report a
5522  *      failure due to a timeout (e.g., not receiving an Authentication frame
5523  *      from the AP) instead of an explicit rejection by the AP, -1 is used to
5524  *      indicate that this is a failure, but without a status code.
5525  *      @timeout_reason is used to report the reason for the timeout in that
5526  *      case.
5527  * @gfp: allocation flags
5528  * @timeout_reason: reason for connection timeout. This is used when the
5529  *      connection fails due to a timeout instead of an explicit rejection from
5530  *      the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
5531  *      not known. This value is used only if @status < 0 to indicate that the
5532  *      failure is due to a timeout and not due to explicit rejection by the AP.
5533  *      This value is ignored in other cases (@status >= 0).
5534  *
5535  * It should be called by the underlying driver once execution of the connection
5536  * request from connect() has been completed. This is similar to
5537  * cfg80211_connect_result(), but with the option of identifying the exact bss
5538  * entry for the connection. Only one of the functions among
5539  * cfg80211_connect_bss(), cfg80211_connect_result(),
5540  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
5541  */
5542 static inline void
5543 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
5544                      struct cfg80211_bss *bss, const u8 *req_ie,
5545                      size_t req_ie_len, const u8 *resp_ie,
5546                      size_t resp_ie_len, int status, gfp_t gfp,
5547                      enum nl80211_timeout_reason timeout_reason)
5548 {
5549         struct cfg80211_connect_resp_params params;
5550
5551         memset(&params, 0, sizeof(params));
5552         params.status = status;
5553         params.bssid = bssid;
5554         params.bss = bss;
5555         params.req_ie = req_ie;
5556         params.req_ie_len = req_ie_len;
5557         params.resp_ie = resp_ie;
5558         params.resp_ie_len = resp_ie_len;
5559         params.timeout_reason = timeout_reason;
5560
5561         cfg80211_connect_done(dev, &params, gfp);
5562 }
5563
5564 /**
5565  * cfg80211_connect_result - notify cfg80211 of connection result
5566  *
5567  * @dev: network device
5568  * @bssid: the BSSID of the AP
5569  * @req_ie: association request IEs (maybe be %NULL)
5570  * @req_ie_len: association request IEs length
5571  * @resp_ie: association response IEs (may be %NULL)
5572  * @resp_ie_len: assoc response IEs length
5573  * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
5574  *      %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5575  *      the real status code for failures.
5576  * @gfp: allocation flags
5577  *
5578  * It should be called by the underlying driver once execution of the connection
5579  * request from connect() has been completed. This is similar to
5580  * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
5581  * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
5582  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
5583  */
5584 static inline void
5585 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
5586                         const u8 *req_ie, size_t req_ie_len,
5587                         const u8 *resp_ie, size_t resp_ie_len,
5588                         u16 status, gfp_t gfp)
5589 {
5590         cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
5591                              resp_ie_len, status, gfp,
5592                              NL80211_TIMEOUT_UNSPECIFIED);
5593 }
5594
5595 /**
5596  * cfg80211_connect_timeout - notify cfg80211 of connection timeout
5597  *
5598  * @dev: network device
5599  * @bssid: the BSSID of the AP
5600  * @req_ie: association request IEs (maybe be %NULL)
5601  * @req_ie_len: association request IEs length
5602  * @gfp: allocation flags
5603  * @timeout_reason: reason for connection timeout.
5604  *
5605  * It should be called by the underlying driver whenever connect() has failed
5606  * in a sequence where no explicit authentication/association rejection was
5607  * received from the AP. This could happen, e.g., due to not being able to send
5608  * out the Authentication or Association Request frame or timing out while
5609  * waiting for the response. Only one of the functions among
5610  * cfg80211_connect_bss(), cfg80211_connect_result(),
5611  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
5612  */
5613 static inline void
5614 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
5615                          const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
5616                          enum nl80211_timeout_reason timeout_reason)
5617 {
5618         cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
5619                              gfp, timeout_reason);
5620 }
5621
5622 /**
5623  * struct cfg80211_roam_info - driver initiated roaming information
5624  *
5625  * @channel: the channel of the new AP
5626  * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
5627  * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
5628  * @req_ie: association request IEs (maybe be %NULL)
5629  * @req_ie_len: association request IEs length
5630  * @resp_ie: association response IEs (may be %NULL)
5631  * @resp_ie_len: assoc response IEs length
5632  * @fils: FILS related roaming information.
5633  */
5634 struct cfg80211_roam_info {
5635         struct ieee80211_channel *channel;
5636         struct cfg80211_bss *bss;
5637         const u8 *bssid;
5638         const u8 *req_ie;
5639         size_t req_ie_len;
5640         const u8 *resp_ie;
5641         size_t resp_ie_len;
5642         struct cfg80211_fils_resp_params fils;
5643 };
5644
5645 /**
5646  * cfg80211_roamed - notify cfg80211 of roaming
5647  *
5648  * @dev: network device
5649  * @info: information about the new BSS. struct &cfg80211_roam_info.
5650  * @gfp: allocation flags
5651  *
5652  * This function may be called with the driver passing either the BSSID of the
5653  * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
5654  * It should be called by the underlying driver whenever it roamed from one AP
5655  * to another while connected. Drivers which have roaming implemented in
5656  * firmware should pass the bss entry to avoid a race in bss entry timeout where
5657  * the bss entry of the new AP is seen in the driver, but gets timed out by the
5658  * time it is accessed in __cfg80211_roamed() due to delay in scheduling
5659  * rdev->event_work. In case of any failures, the reference is released
5660  * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
5661  * released while diconneting from the current bss.
5662  */
5663 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
5664                      gfp_t gfp);
5665
5666 /**
5667  * cfg80211_port_authorized - notify cfg80211 of successful security association
5668  *
5669  * @dev: network device
5670  * @bssid: the BSSID of the AP
5671  * @gfp: allocation flags
5672  *
5673  * This function should be called by a driver that supports 4 way handshake
5674  * offload after a security association was successfully established (i.e.,
5675  * the 4 way handshake was completed successfully). The call to this function
5676  * should be preceded with a call to cfg80211_connect_result(),
5677  * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
5678  * indicate the 802.11 association.
5679  */
5680 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
5681                               gfp_t gfp);
5682
5683 /**
5684  * cfg80211_disconnected - notify cfg80211 that connection was dropped
5685  *
5686  * @dev: network device
5687  * @ie: information elements of the deauth/disassoc frame (may be %NULL)
5688  * @ie_len: length of IEs
5689  * @reason: reason code for the disconnection, set it to 0 if unknown
5690  * @locally_generated: disconnection was requested locally
5691  * @gfp: allocation flags
5692  *
5693  * After it calls this function, the driver should enter an idle state
5694  * and not try to connect to any AP any more.
5695  */
5696 void cfg80211_disconnected(struct net_device *dev, u16 reason,
5697                            const u8 *ie, size_t ie_len,
5698                            bool locally_generated, gfp_t gfp);
5699
5700 /**
5701  * cfg80211_ready_on_channel - notification of remain_on_channel start
5702  * @wdev: wireless device
5703  * @cookie: the request cookie
5704  * @chan: The current channel (from remain_on_channel request)
5705  * @duration: Duration in milliseconds that the driver intents to remain on the
5706  *      channel
5707  * @gfp: allocation flags
5708  */
5709 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
5710                                struct ieee80211_channel *chan,
5711                                unsigned int duration, gfp_t gfp);
5712
5713 /**
5714  * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
5715  * @wdev: wireless device
5716  * @cookie: the request cookie
5717  * @chan: The current channel (from remain_on_channel request)
5718  * @gfp: allocation flags
5719  */
5720 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
5721                                         struct ieee80211_channel *chan,
5722                                         gfp_t gfp);
5723
5724 /**
5725  * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
5726  *
5727  * @sinfo: the station information
5728  * @gfp: allocation flags
5729  */
5730 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
5731
5732 /**
5733  * cfg80211_sinfo_release_content - release contents of station info
5734  * @sinfo: the station information
5735  *
5736  * Releases any potentially allocated sub-information of the station
5737  * information, but not the struct itself (since it's typically on
5738  * the stack.)
5739  */
5740 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
5741 {
5742         kfree(sinfo->pertid);
5743 }
5744
5745 /**
5746  * cfg80211_new_sta - notify userspace about station
5747  *
5748  * @dev: the netdev
5749  * @mac_addr: the station's address
5750  * @sinfo: the station information
5751  * @gfp: allocation flags
5752  */
5753 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
5754                       struct station_info *sinfo, gfp_t gfp);
5755
5756 /**
5757  * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
5758  * @dev: the netdev
5759  * @mac_addr: the station's address
5760  * @sinfo: the station information/statistics
5761  * @gfp: allocation flags
5762  */
5763 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
5764                             struct station_info *sinfo, gfp_t gfp);
5765
5766 /**
5767  * cfg80211_del_sta - notify userspace about deletion of a station
5768  *
5769  * @dev: the netdev
5770  * @mac_addr: the station's address
5771  * @gfp: allocation flags
5772  */
5773 static inline void cfg80211_del_sta(struct net_device *dev,
5774                                     const u8 *mac_addr, gfp_t gfp)
5775 {
5776         cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
5777 }
5778
5779 /**
5780  * cfg80211_conn_failed - connection request failed notification
5781  *
5782  * @dev: the netdev
5783  * @mac_addr: the station's address
5784  * @reason: the reason for connection failure
5785  * @gfp: allocation flags
5786  *
5787  * Whenever a station tries to connect to an AP and if the station
5788  * could not connect to the AP as the AP has rejected the connection
5789  * for some reasons, this function is called.
5790  *
5791  * The reason for connection failure can be any of the value from
5792  * nl80211_connect_failed_reason enum
5793  */
5794 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
5795                           enum nl80211_connect_failed_reason reason,
5796                           gfp_t gfp);
5797
5798 /**
5799  * cfg80211_rx_mgmt - notification of received, unprocessed management frame
5800  * @wdev: wireless device receiving the frame
5801  * @freq: Frequency on which the frame was received in MHz
5802  * @sig_dbm: signal strength in dBm, or 0 if unknown
5803  * @buf: Management frame (header + body)
5804  * @len: length of the frame data
5805  * @flags: flags, as defined in enum nl80211_rxmgmt_flags
5806  *
5807  * This function is called whenever an Action frame is received for a station
5808  * mode interface, but is not processed in kernel.
5809  *
5810  * Return: %true if a user space application has registered for this frame.
5811  * For action frames, that makes it responsible for rejecting unrecognized
5812  * action frames; %false otherwise, in which case for action frames the
5813  * driver is responsible for rejecting the frame.
5814  */
5815 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
5816                       const u8 *buf, size_t len, u32 flags);
5817
5818 /**
5819  * cfg80211_mgmt_tx_status - notification of TX status for management frame
5820  * @wdev: wireless device receiving the frame
5821  * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
5822  * @buf: Management frame (header + body)
5823  * @len: length of the frame data
5824  * @ack: Whether frame was acknowledged
5825  * @gfp: context flags
5826  *
5827  * This function is called whenever a management frame was requested to be
5828  * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
5829  * transmission attempt.
5830  */
5831 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
5832                              const u8 *buf, size_t len, bool ack, gfp_t gfp);
5833
5834
5835 /**
5836  * cfg80211_rx_control_port - notification about a received control port frame
5837  * @dev: The device the frame matched to
5838  * @buf: control port frame
5839  * @len: length of the frame data
5840  * @addr: The peer from which the frame was received
5841  * @proto: frame protocol, typically PAE or Pre-authentication
5842  * @unencrypted: Whether the frame was received unencrypted
5843  *
5844  * This function is used to inform userspace about a received control port
5845  * frame.  It should only be used if userspace indicated it wants to receive
5846  * control port frames over nl80211.
5847  *
5848  * The frame is the data portion of the 802.3 or 802.11 data frame with all
5849  * network layer headers removed (e.g. the raw EAPoL frame).
5850  *
5851  * Return: %true if the frame was passed to userspace
5852  */
5853 bool cfg80211_rx_control_port(struct net_device *dev,
5854                               const u8 *buf, size_t len,
5855                               const u8 *addr, u16 proto, bool unencrypted);
5856
5857 /**
5858  * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
5859  * @dev: network device
5860  * @rssi_event: the triggered RSSI event
5861  * @rssi_level: new RSSI level value or 0 if not available
5862  * @gfp: context flags
5863  *
5864  * This function is called when a configured connection quality monitoring
5865  * rssi threshold reached event occurs.
5866  */
5867 void cfg80211_cqm_rssi_notify(struct net_device *dev,
5868                               enum nl80211_cqm_rssi_threshold_event rssi_event,
5869                               s32 rssi_level, gfp_t gfp);
5870
5871 /**
5872  * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
5873  * @dev: network device
5874  * @peer: peer's MAC address
5875  * @num_packets: how many packets were lost -- should be a fixed threshold
5876  *      but probably no less than maybe 50, or maybe a throughput dependent
5877  *      threshold (to account for temporary interference)
5878  * @gfp: context flags
5879  */
5880 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
5881                                  const u8 *peer, u32 num_packets, gfp_t gfp);
5882
5883 /**
5884  * cfg80211_cqm_txe_notify - TX error rate event
5885  * @dev: network device
5886  * @peer: peer's MAC address
5887  * @num_packets: how many packets were lost
5888  * @rate: % of packets which failed transmission
5889  * @intvl: interval (in s) over which the TX failure threshold was breached.
5890  * @gfp: context flags
5891  *
5892  * Notify userspace when configured % TX failures over number of packets in a
5893  * given interval is exceeded.
5894  */
5895 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
5896                              u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
5897
5898 /**
5899  * cfg80211_cqm_beacon_loss_notify - beacon loss event
5900  * @dev: network device
5901  * @gfp: context flags
5902  *
5903  * Notify userspace about beacon loss from the connected AP.
5904  */
5905 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
5906
5907 /**
5908  * cfg80211_radar_event - radar detection event
5909  * @wiphy: the wiphy
5910  * @chandef: chandef for the current channel
5911  * @gfp: context flags
5912  *
5913  * This function is called when a radar is detected on the current chanenl.
5914  */
5915 void cfg80211_radar_event(struct wiphy *wiphy,
5916                           struct cfg80211_chan_def *chandef, gfp_t gfp);
5917
5918 /**
5919  * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
5920  * @dev: network device
5921  * @mac: MAC address of a station which opmode got modified
5922  * @sta_opmode: station's current opmode value
5923  * @gfp: context flags
5924  *
5925  * Driver should call this function when station's opmode modified via action
5926  * frame.
5927  */
5928 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
5929                                        struct sta_opmode_info *sta_opmode,
5930                                        gfp_t gfp);
5931
5932 /**
5933  * cfg80211_cac_event - Channel availability check (CAC) event
5934  * @netdev: network device
5935  * @chandef: chandef for the current channel
5936  * @event: type of event
5937  * @gfp: context flags
5938  *
5939  * This function is called when a Channel availability check (CAC) is finished
5940  * or aborted. This must be called to notify the completion of a CAC process,
5941  * also by full-MAC drivers.
5942  */
5943 void cfg80211_cac_event(struct net_device *netdev,
5944                         const struct cfg80211_chan_def *chandef,
5945                         enum nl80211_radar_event event, gfp_t gfp);
5946
5947
5948 /**
5949  * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
5950  * @dev: network device
5951  * @bssid: BSSID of AP (to avoid races)
5952  * @replay_ctr: new replay counter
5953  * @gfp: allocation flags
5954  */
5955 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
5956                                const u8 *replay_ctr, gfp_t gfp);
5957
5958 /**
5959  * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
5960  * @dev: network device
5961  * @index: candidate index (the smaller the index, the higher the priority)
5962  * @bssid: BSSID of AP
5963  * @preauth: Whether AP advertises support for RSN pre-authentication
5964  * @gfp: allocation flags
5965  */
5966 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
5967                                      const u8 *bssid, bool preauth, gfp_t gfp);
5968
5969 /**
5970  * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
5971  * @dev: The device the frame matched to
5972  * @addr: the transmitter address
5973  * @gfp: context flags
5974  *
5975  * This function is used in AP mode (only!) to inform userspace that
5976  * a spurious class 3 frame was received, to be able to deauth the
5977  * sender.
5978  * Return: %true if the frame was passed to userspace (or this failed
5979  * for a reason other than not having a subscription.)
5980  */
5981 bool cfg80211_rx_spurious_frame(struct net_device *dev,
5982                                 const u8 *addr, gfp_t gfp);
5983
5984 /**
5985  * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
5986  * @dev: The device the frame matched to
5987  * @addr: the transmitter address
5988  * @gfp: context flags
5989  *
5990  * This function is used in AP mode (only!) to inform userspace that
5991  * an associated station sent a 4addr frame but that wasn't expected.
5992  * It is allowed and desirable to send this event only once for each
5993  * station to avoid event flooding.
5994  * Return: %true if the frame was passed to userspace (or this failed
5995  * for a reason other than not having a subscription.)
5996  */
5997 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
5998                                         const u8 *addr, gfp_t gfp);
5999
6000 /**
6001  * cfg80211_probe_status - notify userspace about probe status
6002  * @dev: the device the probe was sent on
6003  * @addr: the address of the peer
6004  * @cookie: the cookie filled in @probe_client previously
6005  * @acked: indicates whether probe was acked or not
6006  * @ack_signal: signal strength (in dBm) of the ACK frame.
6007  * @is_valid_ack_signal: indicates the ack_signal is valid or not.
6008  * @gfp: allocation flags
6009  */
6010 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
6011                            u64 cookie, bool acked, s32 ack_signal,
6012                            bool is_valid_ack_signal, gfp_t gfp);
6013
6014 /**
6015  * cfg80211_report_obss_beacon - report beacon from other APs
6016  * @wiphy: The wiphy that received the beacon
6017  * @frame: the frame
6018  * @len: length of the frame
6019  * @freq: frequency the frame was received on
6020  * @sig_dbm: signal strength in dBm, or 0 if unknown
6021  *
6022  * Use this function to report to userspace when a beacon was
6023  * received. It is not useful to call this when there is no
6024  * netdev that is in AP/GO mode.
6025  */
6026 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
6027                                  const u8 *frame, size_t len,
6028                                  int freq, int sig_dbm);
6029
6030 /**
6031  * cfg80211_reg_can_beacon - check if beaconing is allowed
6032  * @wiphy: the wiphy
6033  * @chandef: the channel definition
6034  * @iftype: interface type
6035  *
6036  * Return: %true if there is no secondary channel or the secondary channel(s)
6037  * can be used for beaconing (i.e. is not a radar channel etc.)
6038  */
6039 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
6040                              struct cfg80211_chan_def *chandef,
6041                              enum nl80211_iftype iftype);
6042
6043 /**
6044  * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
6045  * @wiphy: the wiphy
6046  * @chandef: the channel definition
6047  * @iftype: interface type
6048  *
6049  * Return: %true if there is no secondary channel or the secondary channel(s)
6050  * can be used for beaconing (i.e. is not a radar channel etc.). This version
6051  * also checks if IR-relaxation conditions apply, to allow beaconing under
6052  * more permissive conditions.
6053  *
6054  * Requires the RTNL to be held.
6055  */
6056 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
6057                                    struct cfg80211_chan_def *chandef,
6058                                    enum nl80211_iftype iftype);
6059
6060 /*
6061  * cfg80211_ch_switch_notify - update wdev channel and notify userspace
6062  * @dev: the device which switched channels
6063  * @chandef: the new channel definition
6064  *
6065  * Caller must acquire wdev_lock, therefore must only be called from sleepable
6066  * driver context!
6067  */
6068 void cfg80211_ch_switch_notify(struct net_device *dev,
6069                                struct cfg80211_chan_def *chandef);
6070
6071 /*
6072  * cfg80211_ch_switch_started_notify - notify channel switch start
6073  * @dev: the device on which the channel switch started
6074  * @chandef: the future channel definition
6075  * @count: the number of TBTTs until the channel switch happens
6076  *
6077  * Inform the userspace about the channel switch that has just
6078  * started, so that it can take appropriate actions (eg. starting
6079  * channel switch on other vifs), if necessary.
6080  */
6081 void cfg80211_ch_switch_started_notify(struct net_device *dev,
6082                                        struct cfg80211_chan_def *chandef,
6083                                        u8 count);
6084
6085 /**
6086  * ieee80211_operating_class_to_band - convert operating class to band
6087  *
6088  * @operating_class: the operating class to convert
6089  * @band: band pointer to fill
6090  *
6091  * Returns %true if the conversion was successful, %false otherwise.
6092  */
6093 bool ieee80211_operating_class_to_band(u8 operating_class,
6094                                        enum nl80211_band *band);
6095
6096 /**
6097  * ieee80211_chandef_to_operating_class - convert chandef to operation class
6098  *
6099  * @chandef: the chandef to convert
6100  * @op_class: a pointer to the resulting operating class
6101  *
6102  * Returns %true if the conversion was successful, %false otherwise.
6103  */
6104 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
6105                                           u8 *op_class);
6106
6107 /*
6108  * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
6109  * @dev: the device on which the operation is requested
6110  * @peer: the MAC address of the peer device
6111  * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
6112  *      NL80211_TDLS_TEARDOWN)
6113  * @reason_code: the reason code for teardown request
6114  * @gfp: allocation flags
6115  *
6116  * This function is used to request userspace to perform TDLS operation that
6117  * requires knowledge of keys, i.e., link setup or teardown when the AP
6118  * connection uses encryption. This is optional mechanism for the driver to use
6119  * if it can automatically determine when a TDLS link could be useful (e.g.,
6120  * based on traffic and signal strength for a peer).
6121  */
6122 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
6123                                 enum nl80211_tdls_operation oper,
6124                                 u16 reason_code, gfp_t gfp);
6125
6126 /*
6127  * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
6128  * @rate: given rate_info to calculate bitrate from
6129  *
6130  * return 0 if MCS index >= 32
6131  */
6132 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
6133
6134 /**
6135  * cfg80211_unregister_wdev - remove the given wdev
6136  * @wdev: struct wireless_dev to remove
6137  *
6138  * Call this function only for wdevs that have no netdev assigned,
6139  * e.g. P2P Devices. It removes the device from the list so that
6140  * it can no longer be used. It is necessary to call this function
6141  * even when cfg80211 requests the removal of the interface by
6142  * calling the del_virtual_intf() callback. The function must also
6143  * be called when the driver wishes to unregister the wdev, e.g.
6144  * when the device is unbound from the driver.
6145  *
6146  * Requires the RTNL to be held.
6147  */
6148 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
6149
6150 /**
6151  * struct cfg80211_ft_event - FT Information Elements
6152  * @ies: FT IEs
6153  * @ies_len: length of the FT IE in bytes
6154  * @target_ap: target AP's MAC address
6155  * @ric_ies: RIC IE
6156  * @ric_ies_len: length of the RIC IE in bytes
6157  */
6158 struct cfg80211_ft_event_params {
6159         const u8 *ies;
6160         size_t ies_len;
6161         const u8 *target_ap;
6162         const u8 *ric_ies;
6163         size_t ric_ies_len;
6164 };
6165
6166 /**
6167  * cfg80211_ft_event - notify userspace about FT IE and RIC IE
6168  * @netdev: network device
6169  * @ft_event: IE information
6170  */
6171 void cfg80211_ft_event(struct net_device *netdev,
6172                        struct cfg80211_ft_event_params *ft_event);
6173
6174 /**
6175  * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
6176  * @ies: the input IE buffer
6177  * @len: the input length
6178  * @attr: the attribute ID to find
6179  * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
6180  *      if the function is only called to get the needed buffer size
6181  * @bufsize: size of the output buffer
6182  *
6183  * The function finds a given P2P attribute in the (vendor) IEs and
6184  * copies its contents to the given buffer.
6185  *
6186  * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
6187  * malformed or the attribute can't be found (respectively), or the
6188  * length of the found attribute (which can be zero).
6189  */
6190 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
6191                           enum ieee80211_p2p_attr_id attr,
6192                           u8 *buf, unsigned int bufsize);
6193
6194 /**
6195  * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
6196  * @ies: the IE buffer
6197  * @ielen: the length of the IE buffer
6198  * @ids: an array with element IDs that are allowed before
6199  *      the split. A WLAN_EID_EXTENSION value means that the next
6200  *      EID in the list is a sub-element of the EXTENSION IE.
6201  * @n_ids: the size of the element ID array
6202  * @after_ric: array IE types that come after the RIC element
6203  * @n_after_ric: size of the @after_ric array
6204  * @offset: offset where to start splitting in the buffer
6205  *
6206  * This function splits an IE buffer by updating the @offset
6207  * variable to point to the location where the buffer should be
6208  * split.
6209  *
6210  * It assumes that the given IE buffer is well-formed, this
6211  * has to be guaranteed by the caller!
6212  *
6213  * It also assumes that the IEs in the buffer are ordered
6214  * correctly, if not the result of using this function will not
6215  * be ordered correctly either, i.e. it does no reordering.
6216  *
6217  * The function returns the offset where the next part of the
6218  * buffer starts, which may be @ielen if the entire (remainder)
6219  * of the buffer should be used.
6220  */
6221 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
6222                               const u8 *ids, int n_ids,
6223                               const u8 *after_ric, int n_after_ric,
6224                               size_t offset);
6225
6226 /**
6227  * ieee80211_ie_split - split an IE buffer according to ordering
6228  * @ies: the IE buffer
6229  * @ielen: the length of the IE buffer
6230  * @ids: an array with element IDs that are allowed before
6231  *      the split. A WLAN_EID_EXTENSION value means that the next
6232  *      EID in the list is a sub-element of the EXTENSION IE.
6233  * @n_ids: the size of the element ID array
6234  * @offset: offset where to start splitting in the buffer
6235  *
6236  * This function splits an IE buffer by updating the @offset
6237  * variable to point to the location where the buffer should be
6238  * split.
6239  *
6240  * It assumes that the given IE buffer is well-formed, this
6241  * has to be guaranteed by the caller!
6242  *
6243  * It also assumes that the IEs in the buffer are ordered
6244  * correctly, if not the result of using this function will not
6245  * be ordered correctly either, i.e. it does no reordering.
6246  *
6247  * The function returns the offset where the next part of the
6248  * buffer starts, which may be @ielen if the entire (remainder)
6249  * of the buffer should be used.
6250  */
6251 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
6252                                         const u8 *ids, int n_ids, size_t offset)
6253 {
6254         return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
6255 }
6256
6257 /**
6258  * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
6259  * @wdev: the wireless device reporting the wakeup
6260  * @wakeup: the wakeup report
6261  * @gfp: allocation flags
6262  *
6263  * This function reports that the given device woke up. If it
6264  * caused the wakeup, report the reason(s), otherwise you may
6265  * pass %NULL as the @wakeup parameter to advertise that something
6266  * else caused the wakeup.
6267  */
6268 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
6269                                    struct cfg80211_wowlan_wakeup *wakeup,
6270                                    gfp_t gfp);
6271
6272 /**
6273  * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
6274  *
6275  * @wdev: the wireless device for which critical protocol is stopped.
6276  * @gfp: allocation flags
6277  *
6278  * This function can be called by the driver to indicate it has reverted
6279  * operation back to normal. One reason could be that the duration given
6280  * by .crit_proto_start() has expired.
6281  */
6282 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
6283
6284 /**
6285  * ieee80211_get_num_supported_channels - get number of channels device has
6286  * @wiphy: the wiphy
6287  *
6288  * Return: the number of channels supported by the device.
6289  */
6290 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
6291
6292 /**
6293  * cfg80211_check_combinations - check interface combinations
6294  *
6295  * @wiphy: the wiphy
6296  * @params: the interface combinations parameter
6297  *
6298  * This function can be called by the driver to check whether a
6299  * combination of interfaces and their types are allowed according to
6300  * the interface combinations.
6301  */
6302 int cfg80211_check_combinations(struct wiphy *wiphy,
6303                                 struct iface_combination_params *params);
6304
6305 /**
6306  * cfg80211_iter_combinations - iterate over matching combinations
6307  *
6308  * @wiphy: the wiphy
6309  * @params: the interface combinations parameter
6310  * @iter: function to call for each matching combination
6311  * @data: pointer to pass to iter function
6312  *
6313  * This function can be called by the driver to check what possible
6314  * combinations it fits in at a given moment, e.g. for channel switching
6315  * purposes.
6316  */
6317 int cfg80211_iter_combinations(struct wiphy *wiphy,
6318                                struct iface_combination_params *params,
6319                                void (*iter)(const struct ieee80211_iface_combination *c,
6320                                             void *data),
6321                                void *data);
6322
6323 /*
6324  * cfg80211_stop_iface - trigger interface disconnection
6325  *
6326  * @wiphy: the wiphy
6327  * @wdev: wireless device
6328  * @gfp: context flags
6329  *
6330  * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
6331  * disconnected.
6332  *
6333  * Note: This doesn't need any locks and is asynchronous.
6334  */
6335 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
6336                          gfp_t gfp);
6337
6338 /**
6339  * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
6340  * @wiphy: the wiphy to shut down
6341  *
6342  * This function shuts down all interfaces belonging to this wiphy by
6343  * calling dev_close() (and treating non-netdev interfaces as needed).
6344  * It shouldn't really be used unless there are some fatal device errors
6345  * that really can't be recovered in any other way.
6346  *
6347  * Callers must hold the RTNL and be able to deal with callbacks into
6348  * the driver while the function is running.
6349  */
6350 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
6351
6352 /**
6353  * wiphy_ext_feature_set - set the extended feature flag
6354  *
6355  * @wiphy: the wiphy to modify.
6356  * @ftidx: extended feature bit index.
6357  *
6358  * The extended features are flagged in multiple bytes (see
6359  * &struct wiphy.@ext_features)
6360  */
6361 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
6362                                          enum nl80211_ext_feature_index ftidx)
6363 {
6364         u8 *ft_byte;
6365
6366         ft_byte = &wiphy->ext_features[ftidx / 8];
6367         *ft_byte |= BIT(ftidx % 8);
6368 }
6369
6370 /**
6371  * wiphy_ext_feature_isset - check the extended feature flag
6372  *
6373  * @wiphy: the wiphy to modify.
6374  * @ftidx: extended feature bit index.
6375  *
6376  * The extended features are flagged in multiple bytes (see
6377  * &struct wiphy.@ext_features)
6378  */
6379 static inline bool
6380 wiphy_ext_feature_isset(struct wiphy *wiphy,
6381                         enum nl80211_ext_feature_index ftidx)
6382 {
6383         u8 ft_byte;
6384
6385         ft_byte = wiphy->ext_features[ftidx / 8];
6386         return (ft_byte & BIT(ftidx % 8)) != 0;
6387 }
6388
6389 /**
6390  * cfg80211_free_nan_func - free NAN function
6391  * @f: NAN function that should be freed
6392  *
6393  * Frees all the NAN function and all it's allocated members.
6394  */
6395 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
6396
6397 /**
6398  * struct cfg80211_nan_match_params - NAN match parameters
6399  * @type: the type of the function that triggered a match. If it is
6400  *       %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
6401  *       If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
6402  *       result.
6403  *       If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
6404  * @inst_id: the local instance id
6405  * @peer_inst_id: the instance id of the peer's function
6406  * @addr: the MAC address of the peer
6407  * @info_len: the length of the &info
6408  * @info: the Service Specific Info from the peer (if any)
6409  * @cookie: unique identifier of the corresponding function
6410  */
6411 struct cfg80211_nan_match_params {
6412         enum nl80211_nan_function_type type;
6413         u8 inst_id;
6414         u8 peer_inst_id;
6415         const u8 *addr;
6416         u8 info_len;
6417         const u8 *info;
6418         u64 cookie;
6419 };
6420
6421 /**
6422  * cfg80211_nan_match - report a match for a NAN function.
6423  * @wdev: the wireless device reporting the match
6424  * @match: match notification parameters
6425  * @gfp: allocation flags
6426  *
6427  * This function reports that the a NAN function had a match. This
6428  * can be a subscribe that had a match or a solicited publish that
6429  * was sent. It can also be a follow up that was received.
6430  */
6431 void cfg80211_nan_match(struct wireless_dev *wdev,
6432                         struct cfg80211_nan_match_params *match, gfp_t gfp);
6433
6434 /**
6435  * cfg80211_nan_func_terminated - notify about NAN function termination.
6436  *
6437  * @wdev: the wireless device reporting the match
6438  * @inst_id: the local instance id
6439  * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
6440  * @cookie: unique NAN function identifier
6441  * @gfp: allocation flags
6442  *
6443  * This function reports that the a NAN function is terminated.
6444  */
6445 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
6446                                   u8 inst_id,
6447                                   enum nl80211_nan_func_term_reason reason,
6448                                   u64 cookie, gfp_t gfp);
6449
6450 /* ethtool helper */
6451 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
6452
6453 /**
6454  * cfg80211_external_auth_request - userspace request for authentication
6455  * @netdev: network device
6456  * @params: External authentication parameters
6457  * @gfp: allocation flags
6458  * Returns: 0 on success, < 0 on error
6459  */
6460 int cfg80211_external_auth_request(struct net_device *netdev,
6461                                    struct cfg80211_external_auth_params *params,
6462                                    gfp_t gfp);
6463
6464 /* Logging, debugging and troubleshooting/diagnostic helpers. */
6465
6466 /* wiphy_printk helpers, similar to dev_printk */
6467
6468 #define wiphy_printk(level, wiphy, format, args...)             \
6469         dev_printk(level, &(wiphy)->dev, format, ##args)
6470 #define wiphy_emerg(wiphy, format, args...)                     \
6471         dev_emerg(&(wiphy)->dev, format, ##args)
6472 #define wiphy_alert(wiphy, format, args...)                     \
6473         dev_alert(&(wiphy)->dev, format, ##args)
6474 #define wiphy_crit(wiphy, format, args...)                      \
6475         dev_crit(&(wiphy)->dev, format, ##args)
6476 #define wiphy_err(wiphy, format, args...)                       \
6477         dev_err(&(wiphy)->dev, format, ##args)
6478 #define wiphy_warn(wiphy, format, args...)                      \
6479         dev_warn(&(wiphy)->dev, format, ##args)
6480 #define wiphy_notice(wiphy, format, args...)                    \
6481         dev_notice(&(wiphy)->dev, format, ##args)
6482 #define wiphy_info(wiphy, format, args...)                      \
6483         dev_info(&(wiphy)->dev, format, ##args)
6484
6485 #define wiphy_debug(wiphy, format, args...)                     \
6486         wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
6487
6488 #define wiphy_dbg(wiphy, format, args...)                       \
6489         dev_dbg(&(wiphy)->dev, format, ##args)
6490
6491 #if defined(VERBOSE_DEBUG)
6492 #define wiphy_vdbg      wiphy_dbg
6493 #else
6494 #define wiphy_vdbg(wiphy, format, args...)                              \
6495 ({                                                                      \
6496         if (0)                                                          \
6497                 wiphy_printk(KERN_DEBUG, wiphy, format, ##args);        \
6498         0;                                                              \
6499 })
6500 #endif
6501
6502 /*
6503  * wiphy_WARN() acts like wiphy_printk(), but with the key difference
6504  * of using a WARN/WARN_ON to get the message out, including the
6505  * file/line information and a backtrace.
6506  */
6507 #define wiphy_WARN(wiphy, format, args...)                      \
6508         WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
6509
6510 #endif /* __NET_CFG80211_H */