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