OSDN Git Service

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