Merge tag 'mips_fixes_4.16_1' of git://git.kernel.org/pub/scm/linux/kernel/git/jhogan...
[linux-2.6-microblaze.git] / include / net / cfg80211.h
1 #ifndef __NET_CFG80211_H
2 #define __NET_CFG80211_H
3 /*
4  * 802.11 device and configuration interface
5  *
6  * Copyright 2006-2010  Johannes Berg <johannes@sipsolutions.net>
7  * Copyright 2013-2014 Intel Mobile Communications GmbH
8  * Copyright 2015-2017  Intel Deutschland GmbH
9  *
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  * @chains: bitmask for filled values in @chain_signal.
1779  * @chain_signal: per-chain signal strength of last received BSS in dBm.
1780  */
1781 struct cfg80211_inform_bss {
1782         struct ieee80211_channel *chan;
1783         enum nl80211_bss_scan_width scan_width;
1784         s32 signal;
1785         u64 boottime_ns;
1786         u64 parent_tsf;
1787         u8 parent_bssid[ETH_ALEN] __aligned(2);
1788         u8 chains;
1789         s8 chain_signal[IEEE80211_MAX_CHAINS];
1790 };
1791
1792 /**
1793  * struct cfg80211_bss_ies - BSS entry IE data
1794  * @tsf: TSF contained in the frame that carried these IEs
1795  * @rcu_head: internal use, for freeing
1796  * @len: length of the IEs
1797  * @from_beacon: these IEs are known to come from a beacon
1798  * @data: IE data
1799  */
1800 struct cfg80211_bss_ies {
1801         u64 tsf;
1802         struct rcu_head rcu_head;
1803         int len;
1804         bool from_beacon;
1805         u8 data[];
1806 };
1807
1808 /**
1809  * struct cfg80211_bss - BSS description
1810  *
1811  * This structure describes a BSS (which may also be a mesh network)
1812  * for use in scan results and similar.
1813  *
1814  * @channel: channel this BSS is on
1815  * @scan_width: width of the control channel
1816  * @bssid: BSSID of the BSS
1817  * @beacon_interval: the beacon interval as from the frame
1818  * @capability: the capability field in host byte order
1819  * @ies: the information elements (Note that there is no guarantee that these
1820  *      are well-formed!); this is a pointer to either the beacon_ies or
1821  *      proberesp_ies depending on whether Probe Response frame has been
1822  *      received. It is always non-%NULL.
1823  * @beacon_ies: the information elements from the last Beacon frame
1824  *      (implementation note: if @hidden_beacon_bss is set this struct doesn't
1825  *      own the beacon_ies, but they're just pointers to the ones from the
1826  *      @hidden_beacon_bss struct)
1827  * @proberesp_ies: the information elements from the last Probe Response frame
1828  * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1829  *      a BSS that hides the SSID in its beacon, this points to the BSS struct
1830  *      that holds the beacon data. @beacon_ies is still valid, of course, and
1831  *      points to the same data as hidden_beacon_bss->beacon_ies in that case.
1832  * @signal: signal strength value (type depends on the wiphy's signal_type)
1833  * @chains: bitmask for filled values in @chain_signal.
1834  * @chain_signal: per-chain signal strength of last received BSS in dBm.
1835  * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1836  */
1837 struct cfg80211_bss {
1838         struct ieee80211_channel *channel;
1839         enum nl80211_bss_scan_width scan_width;
1840
1841         const struct cfg80211_bss_ies __rcu *ies;
1842         const struct cfg80211_bss_ies __rcu *beacon_ies;
1843         const struct cfg80211_bss_ies __rcu *proberesp_ies;
1844
1845         struct cfg80211_bss *hidden_beacon_bss;
1846
1847         s32 signal;
1848
1849         u16 beacon_interval;
1850         u16 capability;
1851
1852         u8 bssid[ETH_ALEN];
1853         u8 chains;
1854         s8 chain_signal[IEEE80211_MAX_CHAINS];
1855
1856         u8 priv[0] __aligned(sizeof(void *));
1857 };
1858
1859 /**
1860  * ieee80211_bss_get_ie - find IE with given ID
1861  * @bss: the bss to search
1862  * @ie: the IE ID
1863  *
1864  * Note that the return value is an RCU-protected pointer, so
1865  * rcu_read_lock() must be held when calling this function.
1866  * Return: %NULL if not found.
1867  */
1868 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1869
1870
1871 /**
1872  * struct cfg80211_auth_request - Authentication request data
1873  *
1874  * This structure provides information needed to complete IEEE 802.11
1875  * authentication.
1876  *
1877  * @bss: The BSS to authenticate with, the callee must obtain a reference
1878  *      to it if it needs to keep it.
1879  * @auth_type: Authentication type (algorithm)
1880  * @ie: Extra IEs to add to Authentication frame or %NULL
1881  * @ie_len: Length of ie buffer in octets
1882  * @key_len: length of WEP key for shared key authentication
1883  * @key_idx: index of WEP key for shared key authentication
1884  * @key: WEP key for shared key authentication
1885  * @auth_data: Fields and elements in Authentication frames. This contains
1886  *      the authentication frame body (non-IE and IE data), excluding the
1887  *      Authentication algorithm number, i.e., starting at the Authentication
1888  *      transaction sequence number field.
1889  * @auth_data_len: Length of auth_data buffer in octets
1890  */
1891 struct cfg80211_auth_request {
1892         struct cfg80211_bss *bss;
1893         const u8 *ie;
1894         size_t ie_len;
1895         enum nl80211_auth_type auth_type;
1896         const u8 *key;
1897         u8 key_len, key_idx;
1898         const u8 *auth_data;
1899         size_t auth_data_len;
1900 };
1901
1902 /**
1903  * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1904  *
1905  * @ASSOC_REQ_DISABLE_HT:  Disable HT (802.11n)
1906  * @ASSOC_REQ_DISABLE_VHT:  Disable VHT
1907  * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
1908  */
1909 enum cfg80211_assoc_req_flags {
1910         ASSOC_REQ_DISABLE_HT            = BIT(0),
1911         ASSOC_REQ_DISABLE_VHT           = BIT(1),
1912         ASSOC_REQ_USE_RRM               = BIT(2),
1913 };
1914
1915 /**
1916  * struct cfg80211_assoc_request - (Re)Association request data
1917  *
1918  * This structure provides information needed to complete IEEE 802.11
1919  * (re)association.
1920  * @bss: The BSS to associate with. If the call is successful the driver is
1921  *      given a reference that it must give back to cfg80211_send_rx_assoc()
1922  *      or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1923  *      association requests while already associating must be rejected.
1924  * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1925  * @ie_len: Length of ie buffer in octets
1926  * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1927  * @crypto: crypto settings
1928  * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
1929  *      to indicate a request to reassociate within the ESS instead of a request
1930  *      do the initial association with the ESS. When included, this is set to
1931  *      the BSSID of the current association, i.e., to the value that is
1932  *      included in the Current AP address field of the Reassociation Request
1933  *      frame.
1934  * @flags:  See &enum cfg80211_assoc_req_flags
1935  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
1936  *      will be used in ht_capa.  Un-supported values will be ignored.
1937  * @ht_capa_mask:  The bits of ht_capa which are to be used.
1938  * @vht_capa: VHT capability override
1939  * @vht_capa_mask: VHT capability mask indicating which fields to use
1940  * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
1941  *      %NULL if FILS is not used.
1942  * @fils_kek_len: Length of fils_kek in octets
1943  * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
1944  *      Request/Response frame or %NULL if FILS is not used. This field starts
1945  *      with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
1946  */
1947 struct cfg80211_assoc_request {
1948         struct cfg80211_bss *bss;
1949         const u8 *ie, *prev_bssid;
1950         size_t ie_len;
1951         struct cfg80211_crypto_settings crypto;
1952         bool use_mfp;
1953         u32 flags;
1954         struct ieee80211_ht_cap ht_capa;
1955         struct ieee80211_ht_cap ht_capa_mask;
1956         struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1957         const u8 *fils_kek;
1958         size_t fils_kek_len;
1959         const u8 *fils_nonces;
1960 };
1961
1962 /**
1963  * struct cfg80211_deauth_request - Deauthentication request data
1964  *
1965  * This structure provides information needed to complete IEEE 802.11
1966  * deauthentication.
1967  *
1968  * @bssid: the BSSID of the BSS to deauthenticate from
1969  * @ie: Extra IEs to add to Deauthentication frame or %NULL
1970  * @ie_len: Length of ie buffer in octets
1971  * @reason_code: The reason code for the deauthentication
1972  * @local_state_change: if set, change local state only and
1973  *      do not set a deauth frame
1974  */
1975 struct cfg80211_deauth_request {
1976         const u8 *bssid;
1977         const u8 *ie;
1978         size_t ie_len;
1979         u16 reason_code;
1980         bool local_state_change;
1981 };
1982
1983 /**
1984  * struct cfg80211_disassoc_request - Disassociation request data
1985  *
1986  * This structure provides information needed to complete IEEE 802.11
1987  * disassociation.
1988  *
1989  * @bss: the BSS to disassociate from
1990  * @ie: Extra IEs to add to Disassociation frame or %NULL
1991  * @ie_len: Length of ie buffer in octets
1992  * @reason_code: The reason code for the disassociation
1993  * @local_state_change: This is a request for a local state only, i.e., no
1994  *      Disassociation frame is to be transmitted.
1995  */
1996 struct cfg80211_disassoc_request {
1997         struct cfg80211_bss *bss;
1998         const u8 *ie;
1999         size_t ie_len;
2000         u16 reason_code;
2001         bool local_state_change;
2002 };
2003
2004 /**
2005  * struct cfg80211_ibss_params - IBSS parameters
2006  *
2007  * This structure defines the IBSS parameters for the join_ibss()
2008  * method.
2009  *
2010  * @ssid: The SSID, will always be non-null.
2011  * @ssid_len: The length of the SSID, will always be non-zero.
2012  * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2013  *      search for IBSSs with a different BSSID.
2014  * @chandef: defines the channel to use if no other IBSS to join can be found
2015  * @channel_fixed: The channel should be fixed -- do not search for
2016  *      IBSSs to join on other channels.
2017  * @ie: information element(s) to include in the beacon
2018  * @ie_len: length of that
2019  * @beacon_interval: beacon interval to use
2020  * @privacy: this is a protected network, keys will be configured
2021  *      after joining
2022  * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2023  *      sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2024  *      required to assume that the port is unauthorized until authorized by
2025  *      user space. Otherwise, port is marked authorized by default.
2026  * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2027  *      changes the channel when a radar is detected. This is required
2028  *      to operate on DFS channels.
2029  * @basic_rates: bitmap of basic rates to use when creating the IBSS
2030  * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2031  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
2032  *      will be used in ht_capa.  Un-supported values will be ignored.
2033  * @ht_capa_mask:  The bits of ht_capa which are to be used.
2034  * @wep_keys: static WEP keys, if not NULL points to an array of
2035  *      CFG80211_MAX_WEP_KEYS WEP keys
2036  * @wep_tx_key: key index (0..3) of the default TX static WEP key
2037  */
2038 struct cfg80211_ibss_params {
2039         const u8 *ssid;
2040         const u8 *bssid;
2041         struct cfg80211_chan_def chandef;
2042         const u8 *ie;
2043         u8 ssid_len, ie_len;
2044         u16 beacon_interval;
2045         u32 basic_rates;
2046         bool channel_fixed;
2047         bool privacy;
2048         bool control_port;
2049         bool userspace_handles_dfs;
2050         int mcast_rate[NUM_NL80211_BANDS];
2051         struct ieee80211_ht_cap ht_capa;
2052         struct ieee80211_ht_cap ht_capa_mask;
2053         struct key_params *wep_keys;
2054         int wep_tx_key;
2055 };
2056
2057 /**
2058  * struct cfg80211_bss_selection - connection parameters for BSS selection.
2059  *
2060  * @behaviour: requested BSS selection behaviour.
2061  * @param: parameters for requestion behaviour.
2062  * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2063  * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2064  */
2065 struct cfg80211_bss_selection {
2066         enum nl80211_bss_select_attr behaviour;
2067         union {
2068                 enum nl80211_band band_pref;
2069                 struct cfg80211_bss_select_adjust adjust;
2070         } param;
2071 };
2072
2073 /**
2074  * struct cfg80211_connect_params - Connection parameters
2075  *
2076  * This structure provides information needed to complete IEEE 802.11
2077  * authentication and association.
2078  *
2079  * @channel: The channel to use or %NULL if not specified (auto-select based
2080  *      on scan results)
2081  * @channel_hint: The channel of the recommended BSS for initial connection or
2082  *      %NULL if not specified
2083  * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2084  *      results)
2085  * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2086  *      %NULL if not specified. Unlike the @bssid parameter, the driver is
2087  *      allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2088  *      to use.
2089  * @ssid: SSID
2090  * @ssid_len: Length of ssid in octets
2091  * @auth_type: Authentication type (algorithm)
2092  * @ie: IEs for association request
2093  * @ie_len: Length of assoc_ie in octets
2094  * @privacy: indicates whether privacy-enabled APs should be used
2095  * @mfp: indicate whether management frame protection is used
2096  * @crypto: crypto settings
2097  * @key_len: length of WEP key for shared key authentication
2098  * @key_idx: index of WEP key for shared key authentication
2099  * @key: WEP key for shared key authentication
2100  * @flags:  See &enum cfg80211_assoc_req_flags
2101  * @bg_scan_period:  Background scan period in seconds
2102  *      or -1 to indicate that default value is to be used.
2103  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
2104  *      will be used in ht_capa.  Un-supported values will be ignored.
2105  * @ht_capa_mask:  The bits of ht_capa which are to be used.
2106  * @vht_capa:  VHT Capability overrides
2107  * @vht_capa_mask: The bits of vht_capa which are to be used.
2108  * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2109  *      networks.
2110  * @bss_select: criteria to be used for BSS selection.
2111  * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2112  *      to indicate a request to reassociate within the ESS instead of a request
2113  *      do the initial association with the ESS. When included, this is set to
2114  *      the BSSID of the current association, i.e., to the value that is
2115  *      included in the Current AP address field of the Reassociation Request
2116  *      frame.
2117  * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2118  *      NAI or %NULL if not specified. This is used to construct FILS wrapped
2119  *      data IE.
2120  * @fils_erp_username_len: Length of @fils_erp_username in octets.
2121  * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2122  *      %NULL if not specified. This specifies the domain name of ER server and
2123  *      is used to construct FILS wrapped data IE.
2124  * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2125  * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2126  *      messages. This is also used to construct FILS wrapped data IE.
2127  * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2128  *      keys in FILS or %NULL if not specified.
2129  * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2130  * @want_1x: indicates user-space supports and wants to use 802.1X driver
2131  *      offload of 4-way handshake.
2132  */
2133 struct cfg80211_connect_params {
2134         struct ieee80211_channel *channel;
2135         struct ieee80211_channel *channel_hint;
2136         const u8 *bssid;
2137         const u8 *bssid_hint;
2138         const u8 *ssid;
2139         size_t ssid_len;
2140         enum nl80211_auth_type auth_type;
2141         const u8 *ie;
2142         size_t ie_len;
2143         bool privacy;
2144         enum nl80211_mfp mfp;
2145         struct cfg80211_crypto_settings crypto;
2146         const u8 *key;
2147         u8 key_len, key_idx;
2148         u32 flags;
2149         int bg_scan_period;
2150         struct ieee80211_ht_cap ht_capa;
2151         struct ieee80211_ht_cap ht_capa_mask;
2152         struct ieee80211_vht_cap vht_capa;
2153         struct ieee80211_vht_cap vht_capa_mask;
2154         bool pbss;
2155         struct cfg80211_bss_selection bss_select;
2156         const u8 *prev_bssid;
2157         const u8 *fils_erp_username;
2158         size_t fils_erp_username_len;
2159         const u8 *fils_erp_realm;
2160         size_t fils_erp_realm_len;
2161         u16 fils_erp_next_seq_num;
2162         const u8 *fils_erp_rrk;
2163         size_t fils_erp_rrk_len;
2164         bool want_1x;
2165 };
2166
2167 /**
2168  * enum cfg80211_connect_params_changed - Connection parameters being updated
2169  *
2170  * This enum provides information of all connect parameters that
2171  * have to be updated as part of update_connect_params() call.
2172  *
2173  * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2174  */
2175 enum cfg80211_connect_params_changed {
2176         UPDATE_ASSOC_IES                = BIT(0),
2177 };
2178
2179 /**
2180  * enum wiphy_params_flags - set_wiphy_params bitfield values
2181  * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2182  * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2183  * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2184  * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2185  * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2186  * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2187  */
2188 enum wiphy_params_flags {
2189         WIPHY_PARAM_RETRY_SHORT         = 1 << 0,
2190         WIPHY_PARAM_RETRY_LONG          = 1 << 1,
2191         WIPHY_PARAM_FRAG_THRESHOLD      = 1 << 2,
2192         WIPHY_PARAM_RTS_THRESHOLD       = 1 << 3,
2193         WIPHY_PARAM_COVERAGE_CLASS      = 1 << 4,
2194         WIPHY_PARAM_DYN_ACK             = 1 << 5,
2195 };
2196
2197 /**
2198  * struct cfg80211_pmksa - PMK Security Association
2199  *
2200  * This structure is passed to the set/del_pmksa() method for PMKSA
2201  * caching.
2202  *
2203  * @bssid: The AP's BSSID (may be %NULL).
2204  * @pmkid: The identifier to refer a PMKSA.
2205  * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2206  *      derivation by a FILS STA. Otherwise, %NULL.
2207  * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2208  *      the hash algorithm used to generate this.
2209  * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2210  *      cache identifier (may be %NULL).
2211  * @ssid_len: Length of the @ssid in octets.
2212  * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2213  *      scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2214  *      %NULL).
2215  */
2216 struct cfg80211_pmksa {
2217         const u8 *bssid;
2218         const u8 *pmkid;
2219         const u8 *pmk;
2220         size_t pmk_len;
2221         const u8 *ssid;
2222         size_t ssid_len;
2223         const u8 *cache_id;
2224 };
2225
2226 /**
2227  * struct cfg80211_pkt_pattern - packet pattern
2228  * @mask: bitmask where to match pattern and where to ignore bytes,
2229  *      one bit per byte, in same format as nl80211
2230  * @pattern: bytes to match where bitmask is 1
2231  * @pattern_len: length of pattern (in bytes)
2232  * @pkt_offset: packet offset (in bytes)
2233  *
2234  * Internal note: @mask and @pattern are allocated in one chunk of
2235  * memory, free @mask only!
2236  */
2237 struct cfg80211_pkt_pattern {
2238         const u8 *mask, *pattern;
2239         int pattern_len;
2240         int pkt_offset;
2241 };
2242
2243 /**
2244  * struct cfg80211_wowlan_tcp - TCP connection parameters
2245  *
2246  * @sock: (internal) socket for source port allocation
2247  * @src: source IP address
2248  * @dst: destination IP address
2249  * @dst_mac: destination MAC address
2250  * @src_port: source port
2251  * @dst_port: destination port
2252  * @payload_len: data payload length
2253  * @payload: data payload buffer
2254  * @payload_seq: payload sequence stamping configuration
2255  * @data_interval: interval at which to send data packets
2256  * @wake_len: wakeup payload match length
2257  * @wake_data: wakeup payload match data
2258  * @wake_mask: wakeup payload match mask
2259  * @tokens_size: length of the tokens buffer
2260  * @payload_tok: payload token usage configuration
2261  */
2262 struct cfg80211_wowlan_tcp {
2263         struct socket *sock;
2264         __be32 src, dst;
2265         u16 src_port, dst_port;
2266         u8 dst_mac[ETH_ALEN];
2267         int payload_len;
2268         const u8 *payload;
2269         struct nl80211_wowlan_tcp_data_seq payload_seq;
2270         u32 data_interval;
2271         u32 wake_len;
2272         const u8 *wake_data, *wake_mask;
2273         u32 tokens_size;
2274         /* must be last, variable member */
2275         struct nl80211_wowlan_tcp_data_token payload_tok;
2276 };
2277
2278 /**
2279  * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2280  *
2281  * This structure defines the enabled WoWLAN triggers for the device.
2282  * @any: wake up on any activity -- special trigger if device continues
2283  *      operating as normal during suspend
2284  * @disconnect: wake up if getting disconnected
2285  * @magic_pkt: wake up on receiving magic packet
2286  * @patterns: wake up on receiving packet matching a pattern
2287  * @n_patterns: number of patterns
2288  * @gtk_rekey_failure: wake up on GTK rekey failure
2289  * @eap_identity_req: wake up on EAP identity request packet
2290  * @four_way_handshake: wake up on 4-way handshake
2291  * @rfkill_release: wake up when rfkill is released
2292  * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2293  *      NULL if not configured.
2294  * @nd_config: configuration for the scan to be used for net detect wake.
2295  */
2296 struct cfg80211_wowlan {
2297         bool any, disconnect, magic_pkt, gtk_rekey_failure,
2298              eap_identity_req, four_way_handshake,
2299              rfkill_release;
2300         struct cfg80211_pkt_pattern *patterns;
2301         struct cfg80211_wowlan_tcp *tcp;
2302         int n_patterns;
2303         struct cfg80211_sched_scan_request *nd_config;
2304 };
2305
2306 /**
2307  * struct cfg80211_coalesce_rules - Coalesce rule parameters
2308  *
2309  * This structure defines coalesce rule for the device.
2310  * @delay: maximum coalescing delay in msecs.
2311  * @condition: condition for packet coalescence.
2312  *      see &enum nl80211_coalesce_condition.
2313  * @patterns: array of packet patterns
2314  * @n_patterns: number of patterns
2315  */
2316 struct cfg80211_coalesce_rules {
2317         int delay;
2318         enum nl80211_coalesce_condition condition;
2319         struct cfg80211_pkt_pattern *patterns;
2320         int n_patterns;
2321 };
2322
2323 /**
2324  * struct cfg80211_coalesce - Packet coalescing settings
2325  *
2326  * This structure defines coalescing settings.
2327  * @rules: array of coalesce rules
2328  * @n_rules: number of rules
2329  */
2330 struct cfg80211_coalesce {
2331         struct cfg80211_coalesce_rules *rules;
2332         int n_rules;
2333 };
2334
2335 /**
2336  * struct cfg80211_wowlan_nd_match - information about the match
2337  *
2338  * @ssid: SSID of the match that triggered the wake up
2339  * @n_channels: Number of channels where the match occurred.  This
2340  *      value may be zero if the driver can't report the channels.
2341  * @channels: center frequencies of the channels where a match
2342  *      occurred (in MHz)
2343  */
2344 struct cfg80211_wowlan_nd_match {
2345         struct cfg80211_ssid ssid;
2346         int n_channels;
2347         u32 channels[];
2348 };
2349
2350 /**
2351  * struct cfg80211_wowlan_nd_info - net detect wake up information
2352  *
2353  * @n_matches: Number of match information instances provided in
2354  *      @matches.  This value may be zero if the driver can't provide
2355  *      match information.
2356  * @matches: Array of pointers to matches containing information about
2357  *      the matches that triggered the wake up.
2358  */
2359 struct cfg80211_wowlan_nd_info {
2360         int n_matches;
2361         struct cfg80211_wowlan_nd_match *matches[];
2362 };
2363
2364 /**
2365  * struct cfg80211_wowlan_wakeup - wakeup report
2366  * @disconnect: woke up by getting disconnected
2367  * @magic_pkt: woke up by receiving magic packet
2368  * @gtk_rekey_failure: woke up by GTK rekey failure
2369  * @eap_identity_req: woke up by EAP identity request packet
2370  * @four_way_handshake: woke up by 4-way handshake
2371  * @rfkill_release: woke up by rfkill being released
2372  * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2373  * @packet_present_len: copied wakeup packet data
2374  * @packet_len: original wakeup packet length
2375  * @packet: The packet causing the wakeup, if any.
2376  * @packet_80211:  For pattern match, magic packet and other data
2377  *      frame triggers an 802.3 frame should be reported, for
2378  *      disconnect due to deauth 802.11 frame. This indicates which
2379  *      it is.
2380  * @tcp_match: TCP wakeup packet received
2381  * @tcp_connlost: TCP connection lost or failed to establish
2382  * @tcp_nomoretokens: TCP data ran out of tokens
2383  * @net_detect: if not %NULL, woke up because of net detect
2384  */
2385 struct cfg80211_wowlan_wakeup {
2386         bool disconnect, magic_pkt, gtk_rekey_failure,
2387              eap_identity_req, four_way_handshake,
2388              rfkill_release, packet_80211,
2389              tcp_match, tcp_connlost, tcp_nomoretokens;
2390         s32 pattern_idx;
2391         u32 packet_present_len, packet_len;
2392         const void *packet;
2393         struct cfg80211_wowlan_nd_info *net_detect;
2394 };
2395
2396 /**
2397  * struct cfg80211_gtk_rekey_data - rekey data
2398  * @kek: key encryption key (NL80211_KEK_LEN bytes)
2399  * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2400  * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2401  */
2402 struct cfg80211_gtk_rekey_data {
2403         const u8 *kek, *kck, *replay_ctr;
2404 };
2405
2406 /**
2407  * struct cfg80211_update_ft_ies_params - FT IE Information
2408  *
2409  * This structure provides information needed to update the fast transition IE
2410  *
2411  * @md: The Mobility Domain ID, 2 Octet value
2412  * @ie: Fast Transition IEs
2413  * @ie_len: Length of ft_ie in octets
2414  */
2415 struct cfg80211_update_ft_ies_params {
2416         u16 md;
2417         const u8 *ie;
2418         size_t ie_len;
2419 };
2420
2421 /**
2422  * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2423  *
2424  * This structure provides information needed to transmit a mgmt frame
2425  *
2426  * @chan: channel to use
2427  * @offchan: indicates wether off channel operation is required
2428  * @wait: duration for ROC
2429  * @buf: buffer to transmit
2430  * @len: buffer length
2431  * @no_cck: don't use cck rates for this frame
2432  * @dont_wait_for_ack: tells the low level not to wait for an ack
2433  * @n_csa_offsets: length of csa_offsets array
2434  * @csa_offsets: array of all the csa offsets in the frame
2435  */
2436 struct cfg80211_mgmt_tx_params {
2437         struct ieee80211_channel *chan;
2438         bool offchan;
2439         unsigned int wait;
2440         const u8 *buf;
2441         size_t len;
2442         bool no_cck;
2443         bool dont_wait_for_ack;
2444         int n_csa_offsets;
2445         const u16 *csa_offsets;
2446 };
2447
2448 /**
2449  * struct cfg80211_dscp_exception - DSCP exception
2450  *
2451  * @dscp: DSCP value that does not adhere to the user priority range definition
2452  * @up: user priority value to which the corresponding DSCP value belongs
2453  */
2454 struct cfg80211_dscp_exception {
2455         u8 dscp;
2456         u8 up;
2457 };
2458
2459 /**
2460  * struct cfg80211_dscp_range - DSCP range definition for user priority
2461  *
2462  * @low: lowest DSCP value of this user priority range, inclusive
2463  * @high: highest DSCP value of this user priority range, inclusive
2464  */
2465 struct cfg80211_dscp_range {
2466         u8 low;
2467         u8 high;
2468 };
2469
2470 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2471 #define IEEE80211_QOS_MAP_MAX_EX        21
2472 #define IEEE80211_QOS_MAP_LEN_MIN       16
2473 #define IEEE80211_QOS_MAP_LEN_MAX \
2474         (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2475
2476 /**
2477  * struct cfg80211_qos_map - QoS Map Information
2478  *
2479  * This struct defines the Interworking QoS map setting for DSCP values
2480  *
2481  * @num_des: number of DSCP exceptions (0..21)
2482  * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2483  *      the user priority DSCP range definition
2484  * @up: DSCP range definition for a particular user priority
2485  */
2486 struct cfg80211_qos_map {
2487         u8 num_des;
2488         struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2489         struct cfg80211_dscp_range up[8];
2490 };
2491
2492 /**
2493  * struct cfg80211_nan_conf - NAN configuration
2494  *
2495  * This struct defines NAN configuration parameters
2496  *
2497  * @master_pref: master preference (1 - 255)
2498  * @bands: operating bands, a bitmap of &enum nl80211_band values.
2499  *      For instance, for NL80211_BAND_2GHZ, bit 0 would be set
2500  *      (i.e. BIT(NL80211_BAND_2GHZ)).
2501  */
2502 struct cfg80211_nan_conf {
2503         u8 master_pref;
2504         u8 bands;
2505 };
2506
2507 /**
2508  * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
2509  * configuration
2510  *
2511  * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
2512  * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
2513  */
2514 enum cfg80211_nan_conf_changes {
2515         CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
2516         CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
2517 };
2518
2519 /**
2520  * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
2521  *
2522  * @filter: the content of the filter
2523  * @len: the length of the filter
2524  */
2525 struct cfg80211_nan_func_filter {
2526         const u8 *filter;
2527         u8 len;
2528 };
2529
2530 /**
2531  * struct cfg80211_nan_func - a NAN function
2532  *
2533  * @type: &enum nl80211_nan_function_type
2534  * @service_id: the service ID of the function
2535  * @publish_type: &nl80211_nan_publish_type
2536  * @close_range: if true, the range should be limited. Threshold is
2537  *      implementation specific.
2538  * @publish_bcast: if true, the solicited publish should be broadcasted
2539  * @subscribe_active: if true, the subscribe is active
2540  * @followup_id: the instance ID for follow up
2541  * @followup_reqid: the requestor instance ID for follow up
2542  * @followup_dest: MAC address of the recipient of the follow up
2543  * @ttl: time to live counter in DW.
2544  * @serv_spec_info: Service Specific Info
2545  * @serv_spec_info_len: Service Specific Info length
2546  * @srf_include: if true, SRF is inclusive
2547  * @srf_bf: Bloom Filter
2548  * @srf_bf_len: Bloom Filter length
2549  * @srf_bf_idx: Bloom Filter index
2550  * @srf_macs: SRF MAC addresses
2551  * @srf_num_macs: number of MAC addresses in SRF
2552  * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
2553  * @tx_filters: filters that should be transmitted in the SDF.
2554  * @num_rx_filters: length of &rx_filters.
2555  * @num_tx_filters: length of &tx_filters.
2556  * @instance_id: driver allocated id of the function.
2557  * @cookie: unique NAN function identifier.
2558  */
2559 struct cfg80211_nan_func {
2560         enum nl80211_nan_function_type type;
2561         u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
2562         u8 publish_type;
2563         bool close_range;
2564         bool publish_bcast;
2565         bool subscribe_active;
2566         u8 followup_id;
2567         u8 followup_reqid;
2568         struct mac_address followup_dest;
2569         u32 ttl;
2570         const u8 *serv_spec_info;
2571         u8 serv_spec_info_len;
2572         bool srf_include;
2573         const u8 *srf_bf;
2574         u8 srf_bf_len;
2575         u8 srf_bf_idx;
2576         struct mac_address *srf_macs;
2577         int srf_num_macs;
2578         struct cfg80211_nan_func_filter *rx_filters;
2579         struct cfg80211_nan_func_filter *tx_filters;
2580         u8 num_tx_filters;
2581         u8 num_rx_filters;
2582         u8 instance_id;
2583         u64 cookie;
2584 };
2585
2586 /**
2587  * struct cfg80211_pmk_conf - PMK configuration
2588  *
2589  * @aa: authenticator address
2590  * @pmk_len: PMK length in bytes.
2591  * @pmk: the PMK material
2592  * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
2593  *      is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
2594  *      holds PMK-R0.
2595  */
2596 struct cfg80211_pmk_conf {
2597         const u8 *aa;
2598         u8 pmk_len;
2599         const u8 *pmk;
2600         const u8 *pmk_r0_name;
2601 };
2602
2603 /**
2604  * struct cfg80211_ops - backend description for wireless configuration
2605  *
2606  * This struct is registered by fullmac card drivers and/or wireless stacks
2607  * in order to handle configuration requests on their interfaces.
2608  *
2609  * All callbacks except where otherwise noted should return 0
2610  * on success or a negative error code.
2611  *
2612  * All operations are currently invoked under rtnl for consistency with the
2613  * wireless extensions but this is subject to reevaluation as soon as this
2614  * code is used more widely and we have a first user without wext.
2615  *
2616  * @suspend: wiphy device needs to be suspended. The variable @wow will
2617  *      be %NULL or contain the enabled Wake-on-Wireless triggers that are
2618  *      configured for the device.
2619  * @resume: wiphy device needs to be resumed
2620  * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2621  *      to call device_set_wakeup_enable() to enable/disable wakeup from
2622  *      the device.
2623  *
2624  * @add_virtual_intf: create a new virtual interface with the given name,
2625  *      must set the struct wireless_dev's iftype. Beware: You must create
2626  *      the new netdev in the wiphy's network namespace! Returns the struct
2627  *      wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2628  *      also set the address member in the wdev.
2629  *
2630  * @del_virtual_intf: remove the virtual interface
2631  *
2632  * @change_virtual_intf: change type/configuration of virtual interface,
2633  *      keep the struct wireless_dev's iftype updated.
2634  *
2635  * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2636  *      when adding a group key.
2637  *
2638  * @get_key: get information about the key with the given parameters.
2639  *      @mac_addr will be %NULL when requesting information for a group
2640  *      key. All pointers given to the @callback function need not be valid
2641  *      after it returns. This function should return an error if it is
2642  *      not possible to retrieve the key, -ENOENT if it doesn't exist.
2643  *
2644  * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2645  *      and @key_index, return -ENOENT if the key doesn't exist.
2646  *
2647  * @set_default_key: set the default key on an interface
2648  *
2649  * @set_default_mgmt_key: set the default management frame key on an interface
2650  *
2651  * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2652  *
2653  * @start_ap: Start acting in AP mode defined by the parameters.
2654  * @change_beacon: Change the beacon parameters for an access point mode
2655  *      interface. This should reject the call when AP mode wasn't started.
2656  * @stop_ap: Stop being an AP, including stopping beaconing.
2657  *
2658  * @add_station: Add a new station.
2659  * @del_station: Remove a station
2660  * @change_station: Modify a given station. Note that flags changes are not much
2661  *      validated in cfg80211, in particular the auth/assoc/authorized flags
2662  *      might come to the driver in invalid combinations -- make sure to check
2663  *      them, also against the existing state! Drivers must call
2664  *      cfg80211_check_station_change() to validate the information.
2665  * @get_station: get station information for the station identified by @mac
2666  * @dump_station: dump station callback -- resume dump at index @idx
2667  *
2668  * @add_mpath: add a fixed mesh path
2669  * @del_mpath: delete a given mesh path
2670  * @change_mpath: change a given mesh path
2671  * @get_mpath: get a mesh path for the given parameters
2672  * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2673  * @get_mpp: get a mesh proxy path for the given parameters
2674  * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
2675  * @join_mesh: join the mesh network with the specified parameters
2676  *      (invoked with the wireless_dev mutex held)
2677  * @leave_mesh: leave the current mesh network
2678  *      (invoked with the wireless_dev mutex held)
2679  *
2680  * @get_mesh_config: Get the current mesh configuration
2681  *
2682  * @update_mesh_config: Update mesh parameters on a running mesh.
2683  *      The mask is a bitfield which tells us which parameters to
2684  *      set, and which to leave alone.
2685  *
2686  * @change_bss: Modify parameters for a given BSS.
2687  *
2688  * @set_txq_params: Set TX queue parameters
2689  *
2690  * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2691  *      as it doesn't implement join_mesh and needs to set the channel to
2692  *      join the mesh instead.
2693  *
2694  * @set_monitor_channel: Set the monitor mode channel for the device. If other
2695  *      interfaces are active this callback should reject the configuration.
2696  *      If no interfaces are active or the device is down, the channel should
2697  *      be stored for when a monitor interface becomes active.
2698  *
2699  * @scan: Request to do a scan. If returning zero, the scan request is given
2700  *      the driver, and will be valid until passed to cfg80211_scan_done().
2701  *      For scan results, call cfg80211_inform_bss(); you can call this outside
2702  *      the scan/scan_done bracket too.
2703  * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
2704  *      indicate the status of the scan through cfg80211_scan_done().
2705  *
2706  * @auth: Request to authenticate with the specified peer
2707  *      (invoked with the wireless_dev mutex held)
2708  * @assoc: Request to (re)associate with the specified peer
2709  *      (invoked with the wireless_dev mutex held)
2710  * @deauth: Request to deauthenticate from the specified peer
2711  *      (invoked with the wireless_dev mutex held)
2712  * @disassoc: Request to disassociate from the specified peer
2713  *      (invoked with the wireless_dev mutex held)
2714  *
2715  * @connect: Connect to the ESS with the specified parameters. When connected,
2716  *      call cfg80211_connect_result()/cfg80211_connect_bss() with status code
2717  *      %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
2718  *      cfg80211_connect_result()/cfg80211_connect_bss() with the status code
2719  *      from the AP or cfg80211_connect_timeout() if no frame with status code
2720  *      was received.
2721  *      The driver is allowed to roam to other BSSes within the ESS when the
2722  *      other BSS matches the connect parameters. When such roaming is initiated
2723  *      by the driver, the driver is expected to verify that the target matches
2724  *      the configured security parameters and to use Reassociation Request
2725  *      frame instead of Association Request frame.
2726  *      The connect function can also be used to request the driver to perform a
2727  *      specific roam when connected to an ESS. In that case, the prev_bssid
2728  *      parameter is set to the BSSID of the currently associated BSS as an
2729  *      indication of requesting reassociation.
2730  *      In both the driver-initiated and new connect() call initiated roaming
2731  *      cases, the result of roaming is indicated with a call to
2732  *      cfg80211_roamed(). (invoked with the wireless_dev mutex held)
2733  * @update_connect_params: Update the connect parameters while connected to a
2734  *      BSS. The updated parameters can be used by driver/firmware for
2735  *      subsequent BSS selection (roaming) decisions and to form the
2736  *      Authentication/(Re)Association Request frames. This call does not
2737  *      request an immediate disassociation or reassociation with the current
2738  *      BSS, i.e., this impacts only subsequent (re)associations. The bits in
2739  *      changed are defined in &enum cfg80211_connect_params_changed.
2740  *      (invoked with the wireless_dev mutex held)
2741  * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
2742  *      connection is in progress. Once done, call cfg80211_disconnected() in
2743  *      case connection was already established (invoked with the
2744  *      wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
2745  *
2746  * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2747  *      cfg80211_ibss_joined(), also call that function when changing BSSID due
2748  *      to a merge.
2749  *      (invoked with the wireless_dev mutex held)
2750  * @leave_ibss: Leave the IBSS.
2751  *      (invoked with the wireless_dev mutex held)
2752  *
2753  * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2754  *      MESH mode)
2755  *
2756  * @set_wiphy_params: Notify that wiphy parameters have changed;
2757  *      @changed bitfield (see &enum wiphy_params_flags) describes which values
2758  *      have changed. The actual parameter values are available in
2759  *      struct wiphy. If returning an error, no value should be changed.
2760  *
2761  * @set_tx_power: set the transmit power according to the parameters,
2762  *      the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2763  *      wdev may be %NULL if power was set for the wiphy, and will
2764  *      always be %NULL unless the driver supports per-vif TX power
2765  *      (as advertised by the nl80211 feature flag.)
2766  * @get_tx_power: store the current TX power into the dbm variable;
2767  *      return 0 if successful
2768  *
2769  * @set_wds_peer: set the WDS peer for a WDS interface
2770  *
2771  * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2772  *      functions to adjust rfkill hw state
2773  *
2774  * @dump_survey: get site survey information.
2775  *
2776  * @remain_on_channel: Request the driver to remain awake on the specified
2777  *      channel for the specified duration to complete an off-channel
2778  *      operation (e.g., public action frame exchange). When the driver is
2779  *      ready on the requested channel, it must indicate this with an event
2780  *      notification by calling cfg80211_ready_on_channel().
2781  * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2782  *      This allows the operation to be terminated prior to timeout based on
2783  *      the duration value.
2784  * @mgmt_tx: Transmit a management frame.
2785  * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2786  *      frame on another channel
2787  *
2788  * @testmode_cmd: run a test mode command; @wdev may be %NULL
2789  * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2790  *      used by the function, but 0 and 1 must not be touched. Additionally,
2791  *      return error codes other than -ENOBUFS and -ENOENT will terminate the
2792  *      dump and return to userspace with an error, so be careful. If any data
2793  *      was passed in from userspace then the data/len arguments will be present
2794  *      and point to the data contained in %NL80211_ATTR_TESTDATA.
2795  *
2796  * @set_bitrate_mask: set the bitrate mask configuration
2797  *
2798  * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2799  *      devices running firmwares capable of generating the (re) association
2800  *      RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2801  * @del_pmksa: Delete a cached PMKID.
2802  * @flush_pmksa: Flush all cached PMKIDs.
2803  * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2804  *      allows the driver to adjust the dynamic ps timeout value.
2805  * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2806  *      After configuration, the driver should (soon) send an event indicating
2807  *      the current level is above/below the configured threshold; this may
2808  *      need some care when the configuration is changed (without first being
2809  *      disabled.)
2810  * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
2811  *      connection quality monitor.  An event is to be sent only when the
2812  *      signal level is found to be outside the two values.  The driver should
2813  *      set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
2814  *      If it is provided then there's no point providing @set_cqm_rssi_config.
2815  * @set_cqm_txe_config: Configure connection quality monitor TX error
2816  *      thresholds.
2817  * @sched_scan_start: Tell the driver to start a scheduled scan.
2818  * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
2819  *      given request id. This call must stop the scheduled scan and be ready
2820  *      for starting a new one before it returns, i.e. @sched_scan_start may be
2821  *      called immediately after that again and should not fail in that case.
2822  *      The driver should not call cfg80211_sched_scan_stopped() for a requested
2823  *      stop (when this method returns 0).
2824  *
2825  * @mgmt_frame_register: Notify driver that a management frame type was
2826  *      registered. The callback is allowed to sleep.
2827  *
2828  * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2829  *      Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2830  *      reject TX/RX mask combinations they cannot support by returning -EINVAL
2831  *      (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2832  *
2833  * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2834  *
2835  * @tdls_mgmt: Transmit a TDLS management frame.
2836  * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2837  *
2838  * @probe_client: probe an associated client, must return a cookie that it
2839  *      later passes to cfg80211_probe_status().
2840  *
2841  * @set_noack_map: Set the NoAck Map for the TIDs.
2842  *
2843  * @get_channel: Get the current operating channel for the virtual interface.
2844  *      For monitor interfaces, it should return %NULL unless there's a single
2845  *      current monitoring channel.
2846  *
2847  * @start_p2p_device: Start the given P2P device.
2848  * @stop_p2p_device: Stop the given P2P device.
2849  *
2850  * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2851  *      Parameters include ACL policy, an array of MAC address of stations
2852  *      and the number of MAC addresses. If there is already a list in driver
2853  *      this new list replaces the existing one. Driver has to clear its ACL
2854  *      when number of MAC addresses entries is passed as 0. Drivers which
2855  *      advertise the support for MAC based ACL have to implement this callback.
2856  *
2857  * @start_radar_detection: Start radar detection in the driver.
2858  *
2859  * @update_ft_ies: Provide updated Fast BSS Transition information to the
2860  *      driver. If the SME is in the driver/firmware, this information can be
2861  *      used in building Authentication and Reassociation Request frames.
2862  *
2863  * @crit_proto_start: Indicates a critical protocol needs more link reliability
2864  *      for a given duration (milliseconds). The protocol is provided so the
2865  *      driver can take the most appropriate actions.
2866  * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2867  *      reliability. This operation can not fail.
2868  * @set_coalesce: Set coalesce parameters.
2869  *
2870  * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
2871  *      responsible for veryfing if the switch is possible. Since this is
2872  *      inherently tricky driver may decide to disconnect an interface later
2873  *      with cfg80211_stop_iface(). This doesn't mean driver can accept
2874  *      everything. It should do it's best to verify requests and reject them
2875  *      as soon as possible.
2876  *
2877  * @set_qos_map: Set QoS mapping information to the driver
2878  *
2879  * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
2880  *      given interface This is used e.g. for dynamic HT 20/40 MHz channel width
2881  *      changes during the lifetime of the BSS.
2882  *
2883  * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
2884  *      with the given parameters; action frame exchange has been handled by
2885  *      userspace so this just has to modify the TX path to take the TS into
2886  *      account.
2887  *      If the admitted time is 0 just validate the parameters to make sure
2888  *      the session can be created at all; it is valid to just always return
2889  *      success for that but that may result in inefficient behaviour (handshake
2890  *      with the peer followed by immediate teardown when the addition is later
2891  *      rejected)
2892  * @del_tx_ts: remove an existing TX TS
2893  *
2894  * @join_ocb: join the OCB network with the specified parameters
2895  *      (invoked with the wireless_dev mutex held)
2896  * @leave_ocb: leave the current OCB network
2897  *      (invoked with the wireless_dev mutex held)
2898  *
2899  * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2900  *      is responsible for continually initiating channel-switching operations
2901  *      and returning to the base channel for communication with the AP.
2902  * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2903  *      peers must be on the base channel when the call completes.
2904  * @start_nan: Start the NAN interface.
2905  * @stop_nan: Stop the NAN interface.
2906  * @add_nan_func: Add a NAN function. Returns negative value on failure.
2907  *      On success @nan_func ownership is transferred to the driver and
2908  *      it may access it outside of the scope of this function. The driver
2909  *      should free the @nan_func when no longer needed by calling
2910  *      cfg80211_free_nan_func().
2911  *      On success the driver should assign an instance_id in the
2912  *      provided @nan_func.
2913  * @del_nan_func: Delete a NAN function.
2914  * @nan_change_conf: changes NAN configuration. The changed parameters must
2915  *      be specified in @changes (using &enum cfg80211_nan_conf_changes);
2916  *      All other parameters must be ignored.
2917  *
2918  * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
2919  *
2920  * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
2921  *      If not deleted through @del_pmk the PMK remains valid until disconnect
2922  *      upon which the driver should clear it.
2923  *      (invoked with the wireless_dev mutex held)
2924  * @del_pmk: delete the previously configured PMK for the given authenticator.
2925  *      (invoked with the wireless_dev mutex held)
2926  */
2927 struct cfg80211_ops {
2928         int     (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
2929         int     (*resume)(struct wiphy *wiphy);
2930         void    (*set_wakeup)(struct wiphy *wiphy, bool enabled);
2931
2932         struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2933                                                   const char *name,
2934                                                   unsigned char name_assign_type,
2935                                                   enum nl80211_iftype type,
2936                                                   struct vif_params *params);
2937         int     (*del_virtual_intf)(struct wiphy *wiphy,
2938                                     struct wireless_dev *wdev);
2939         int     (*change_virtual_intf)(struct wiphy *wiphy,
2940                                        struct net_device *dev,
2941                                        enum nl80211_iftype type,
2942                                        struct vif_params *params);
2943
2944         int     (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2945                            u8 key_index, bool pairwise, const u8 *mac_addr,
2946                            struct key_params *params);
2947         int     (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2948                            u8 key_index, bool pairwise, const u8 *mac_addr,
2949                            void *cookie,
2950                            void (*callback)(void *cookie, struct key_params*));
2951         int     (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2952                            u8 key_index, bool pairwise, const u8 *mac_addr);
2953         int     (*set_default_key)(struct wiphy *wiphy,
2954                                    struct net_device *netdev,
2955                                    u8 key_index, bool unicast, bool multicast);
2956         int     (*set_default_mgmt_key)(struct wiphy *wiphy,
2957                                         struct net_device *netdev,
2958                                         u8 key_index);
2959
2960         int     (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2961                             struct cfg80211_ap_settings *settings);
2962         int     (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2963                                  struct cfg80211_beacon_data *info);
2964         int     (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
2965
2966
2967         int     (*add_station)(struct wiphy *wiphy, struct net_device *dev,
2968                                const u8 *mac,
2969                                struct station_parameters *params);
2970         int     (*del_station)(struct wiphy *wiphy, struct net_device *dev,
2971                                struct station_del_parameters *params);
2972         int     (*change_station)(struct wiphy *wiphy, struct net_device *dev,
2973                                   const u8 *mac,
2974                                   struct station_parameters *params);
2975         int     (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2976                                const u8 *mac, struct station_info *sinfo);
2977         int     (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2978                                 int idx, u8 *mac, struct station_info *sinfo);
2979
2980         int     (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2981                                const u8 *dst, const u8 *next_hop);
2982         int     (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2983                                const u8 *dst);
2984         int     (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2985                                   const u8 *dst, const u8 *next_hop);
2986         int     (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2987                              u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
2988         int     (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2989                               int idx, u8 *dst, u8 *next_hop,
2990                               struct mpath_info *pinfo);
2991         int     (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
2992                            u8 *dst, u8 *mpp, struct mpath_info *pinfo);
2993         int     (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
2994                             int idx, u8 *dst, u8 *mpp,
2995                             struct mpath_info *pinfo);
2996         int     (*get_mesh_config)(struct wiphy *wiphy,
2997                                 struct net_device *dev,
2998                                 struct mesh_config *conf);
2999         int     (*update_mesh_config)(struct wiphy *wiphy,
3000                                       struct net_device *dev, u32 mask,
3001                                       const struct mesh_config *nconf);
3002         int     (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
3003                              const struct mesh_config *conf,
3004                              const struct mesh_setup *setup);
3005         int     (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
3006
3007         int     (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
3008                             struct ocb_setup *setup);
3009         int     (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
3010
3011         int     (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
3012                               struct bss_parameters *params);
3013
3014         int     (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
3015                                   struct ieee80211_txq_params *params);
3016
3017         int     (*libertas_set_mesh_channel)(struct wiphy *wiphy,
3018                                              struct net_device *dev,
3019                                              struct ieee80211_channel *chan);
3020
3021         int     (*set_monitor_channel)(struct wiphy *wiphy,
3022                                        struct cfg80211_chan_def *chandef);
3023
3024         int     (*scan)(struct wiphy *wiphy,
3025                         struct cfg80211_scan_request *request);
3026         void    (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3027
3028         int     (*auth)(struct wiphy *wiphy, struct net_device *dev,
3029                         struct cfg80211_auth_request *req);
3030         int     (*assoc)(struct wiphy *wiphy, struct net_device *dev,
3031                          struct cfg80211_assoc_request *req);
3032         int     (*deauth)(struct wiphy *wiphy, struct net_device *dev,
3033                           struct cfg80211_deauth_request *req);
3034         int     (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
3035                             struct cfg80211_disassoc_request *req);
3036
3037         int     (*connect)(struct wiphy *wiphy, struct net_device *dev,
3038                            struct cfg80211_connect_params *sme);
3039         int     (*update_connect_params)(struct wiphy *wiphy,
3040                                          struct net_device *dev,
3041                                          struct cfg80211_connect_params *sme,
3042                                          u32 changed);
3043         int     (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
3044                               u16 reason_code);
3045
3046         int     (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
3047                              struct cfg80211_ibss_params *params);
3048         int     (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
3049
3050         int     (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
3051                                   int rate[NUM_NL80211_BANDS]);
3052
3053         int     (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
3054
3055         int     (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3056                                 enum nl80211_tx_power_setting type, int mbm);
3057         int     (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3058                                 int *dbm);
3059
3060         int     (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
3061                                 const u8 *addr);
3062
3063         void    (*rfkill_poll)(struct wiphy *wiphy);
3064
3065 #ifdef CONFIG_NL80211_TESTMODE
3066         int     (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
3067                                 void *data, int len);
3068         int     (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
3069                                  struct netlink_callback *cb,
3070                                  void *data, int len);
3071 #endif
3072
3073         int     (*set_bitrate_mask)(struct wiphy *wiphy,
3074                                     struct net_device *dev,
3075                                     const u8 *peer,
3076                                     const struct cfg80211_bitrate_mask *mask);
3077
3078         int     (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
3079                         int idx, struct survey_info *info);
3080
3081         int     (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3082                              struct cfg80211_pmksa *pmksa);
3083         int     (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3084                              struct cfg80211_pmksa *pmksa);
3085         int     (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
3086
3087         int     (*remain_on_channel)(struct wiphy *wiphy,
3088                                      struct wireless_dev *wdev,
3089                                      struct ieee80211_channel *chan,
3090                                      unsigned int duration,
3091                                      u64 *cookie);
3092         int     (*cancel_remain_on_channel)(struct wiphy *wiphy,
3093                                             struct wireless_dev *wdev,
3094                                             u64 cookie);
3095
3096         int     (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
3097                            struct cfg80211_mgmt_tx_params *params,
3098                            u64 *cookie);
3099         int     (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
3100                                        struct wireless_dev *wdev,
3101                                        u64 cookie);
3102
3103         int     (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3104                                   bool enabled, int timeout);
3105
3106         int     (*set_cqm_rssi_config)(struct wiphy *wiphy,
3107                                        struct net_device *dev,
3108                                        s32 rssi_thold, u32 rssi_hyst);
3109
3110         int     (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
3111                                              struct net_device *dev,
3112                                              s32 rssi_low, s32 rssi_high);
3113
3114         int     (*set_cqm_txe_config)(struct wiphy *wiphy,
3115                                       struct net_device *dev,
3116                                       u32 rate, u32 pkts, u32 intvl);
3117
3118         void    (*mgmt_frame_register)(struct wiphy *wiphy,
3119                                        struct wireless_dev *wdev,
3120                                        u16 frame_type, bool reg);
3121
3122         int     (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
3123         int     (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
3124
3125         int     (*sched_scan_start)(struct wiphy *wiphy,
3126                                 struct net_device *dev,
3127                                 struct cfg80211_sched_scan_request *request);
3128         int     (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
3129                                    u64 reqid);
3130
3131         int     (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
3132                                   struct cfg80211_gtk_rekey_data *data);
3133
3134         int     (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3135                              const u8 *peer, u8 action_code,  u8 dialog_token,
3136                              u16 status_code, u32 peer_capability,
3137                              bool initiator, const u8 *buf, size_t len);
3138         int     (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
3139                              const u8 *peer, enum nl80211_tdls_operation oper);
3140
3141         int     (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
3142                                 const u8 *peer, u64 *cookie);
3143
3144         int     (*set_noack_map)(struct wiphy *wiphy,
3145                                   struct net_device *dev,
3146                                   u16 noack_map);
3147
3148         int     (*get_channel)(struct wiphy *wiphy,
3149                                struct wireless_dev *wdev,
3150                                struct cfg80211_chan_def *chandef);
3151
3152         int     (*start_p2p_device)(struct wiphy *wiphy,
3153                                     struct wireless_dev *wdev);
3154         void    (*stop_p2p_device)(struct wiphy *wiphy,
3155                                    struct wireless_dev *wdev);
3156
3157         int     (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
3158                                const struct cfg80211_acl_data *params);
3159
3160         int     (*start_radar_detection)(struct wiphy *wiphy,
3161                                          struct net_device *dev,
3162                                          struct cfg80211_chan_def *chandef,
3163                                          u32 cac_time_ms);
3164         int     (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
3165                                  struct cfg80211_update_ft_ies_params *ftie);
3166         int     (*crit_proto_start)(struct wiphy *wiphy,
3167                                     struct wireless_dev *wdev,
3168                                     enum nl80211_crit_proto_id protocol,
3169                                     u16 duration);
3170         void    (*crit_proto_stop)(struct wiphy *wiphy,
3171                                    struct wireless_dev *wdev);
3172         int     (*set_coalesce)(struct wiphy *wiphy,
3173                                 struct cfg80211_coalesce *coalesce);
3174
3175         int     (*channel_switch)(struct wiphy *wiphy,
3176                                   struct net_device *dev,
3177                                   struct cfg80211_csa_settings *params);
3178
3179         int     (*set_qos_map)(struct wiphy *wiphy,
3180                                struct net_device *dev,
3181                                struct cfg80211_qos_map *qos_map);
3182
3183         int     (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
3184                                     struct cfg80211_chan_def *chandef);
3185
3186         int     (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3187                              u8 tsid, const u8 *peer, u8 user_prio,
3188                              u16 admitted_time);
3189         int     (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3190                              u8 tsid, const u8 *peer);
3191
3192         int     (*tdls_channel_switch)(struct wiphy *wiphy,
3193                                        struct net_device *dev,
3194                                        const u8 *addr, u8 oper_class,
3195                                        struct cfg80211_chan_def *chandef);
3196         void    (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
3197                                               struct net_device *dev,
3198                                               const u8 *addr);
3199         int     (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
3200                              struct cfg80211_nan_conf *conf);
3201         void    (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3202         int     (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3203                                 struct cfg80211_nan_func *nan_func);
3204         void    (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3205                                u64 cookie);
3206         int     (*nan_change_conf)(struct wiphy *wiphy,
3207                                    struct wireless_dev *wdev,
3208                                    struct cfg80211_nan_conf *conf,
3209                                    u32 changes);
3210
3211         int     (*set_multicast_to_unicast)(struct wiphy *wiphy,
3212                                             struct net_device *dev,
3213                                             const bool enabled);
3214
3215         int     (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
3216                            const struct cfg80211_pmk_conf *conf);
3217         int     (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
3218                            const u8 *aa);
3219 };
3220
3221 /*
3222  * wireless hardware and networking interfaces structures
3223  * and registration/helper functions
3224  */
3225
3226 /**
3227  * enum wiphy_flags - wiphy capability flags
3228  *
3229  * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
3230  *      wiphy at all
3231  * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
3232  *      by default -- this flag will be set depending on the kernel's default
3233  *      on wiphy_new(), but can be changed by the driver if it has a good
3234  *      reason to override the default
3235  * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
3236  *      on a VLAN interface)
3237  * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
3238  * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
3239  *      control port protocol ethertype. The device also honours the
3240  *      control_port_no_encrypt flag.
3241  * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
3242  * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
3243  *      auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
3244  * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
3245  *      firmware.
3246  * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
3247  * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
3248  * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
3249  *      link setup/discovery operations internally. Setup, discovery and
3250  *      teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
3251  *      command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
3252  *      used for asking the driver/firmware to perform a TDLS operation.
3253  * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
3254  * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
3255  *      when there are virtual interfaces in AP mode by calling
3256  *      cfg80211_report_obss_beacon().
3257  * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
3258  *      responds to probe-requests in hardware.
3259  * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
3260  * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
3261  * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
3262  * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
3263  *      beaconing mode (AP, IBSS, Mesh, ...).
3264  * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
3265  *      before connection.
3266  */
3267 enum wiphy_flags {
3268         /* use hole at 0 */
3269         /* use hole at 1 */
3270         /* use hole at 2 */
3271         WIPHY_FLAG_NETNS_OK                     = BIT(3),
3272         WIPHY_FLAG_PS_ON_BY_DEFAULT             = BIT(4),
3273         WIPHY_FLAG_4ADDR_AP                     = BIT(5),
3274         WIPHY_FLAG_4ADDR_STATION                = BIT(6),
3275         WIPHY_FLAG_CONTROL_PORT_PROTOCOL        = BIT(7),
3276         WIPHY_FLAG_IBSS_RSN                     = BIT(8),
3277         WIPHY_FLAG_MESH_AUTH                    = BIT(10),
3278         /* use hole at 11 */
3279         /* use hole at 12 */
3280         WIPHY_FLAG_SUPPORTS_FW_ROAM             = BIT(13),
3281         WIPHY_FLAG_AP_UAPSD                     = BIT(14),
3282         WIPHY_FLAG_SUPPORTS_TDLS                = BIT(15),
3283         WIPHY_FLAG_TDLS_EXTERNAL_SETUP          = BIT(16),
3284         WIPHY_FLAG_HAVE_AP_SME                  = BIT(17),
3285         WIPHY_FLAG_REPORTS_OBSS                 = BIT(18),
3286         WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD        = BIT(19),
3287         WIPHY_FLAG_OFFCHAN_TX                   = BIT(20),
3288         WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL        = BIT(21),
3289         WIPHY_FLAG_SUPPORTS_5_10_MHZ            = BIT(22),
3290         WIPHY_FLAG_HAS_CHANNEL_SWITCH           = BIT(23),
3291         WIPHY_FLAG_HAS_STATIC_WEP               = BIT(24),
3292 };
3293
3294 /**
3295  * struct ieee80211_iface_limit - limit on certain interface types
3296  * @max: maximum number of interfaces of these types
3297  * @types: interface types (bits)
3298  */
3299 struct ieee80211_iface_limit {
3300         u16 max;
3301         u16 types;
3302 };
3303
3304 /**
3305  * struct ieee80211_iface_combination - possible interface combination
3306  *
3307  * With this structure the driver can describe which interface
3308  * combinations it supports concurrently.
3309  *
3310  * Examples:
3311  *
3312  * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
3313  *
3314  *    .. code-block:: c
3315  *
3316  *      struct ieee80211_iface_limit limits1[] = {
3317  *              { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3318  *              { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
3319  *      };
3320  *      struct ieee80211_iface_combination combination1 = {
3321  *              .limits = limits1,
3322  *              .n_limits = ARRAY_SIZE(limits1),
3323  *              .max_interfaces = 2,
3324  *              .beacon_int_infra_match = true,
3325  *      };
3326  *
3327  *
3328  * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
3329  *
3330  *    .. code-block:: c
3331  *
3332  *      struct ieee80211_iface_limit limits2[] = {
3333  *              { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
3334  *                                   BIT(NL80211_IFTYPE_P2P_GO), },
3335  *      };
3336  *      struct ieee80211_iface_combination combination2 = {
3337  *              .limits = limits2,
3338  *              .n_limits = ARRAY_SIZE(limits2),
3339  *              .max_interfaces = 8,
3340  *              .num_different_channels = 1,
3341  *      };
3342  *
3343  *
3344  * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
3345  *
3346  *    This allows for an infrastructure connection and three P2P connections.
3347  *
3348  *    .. code-block:: c
3349  *
3350  *      struct ieee80211_iface_limit limits3[] = {
3351  *              { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3352  *              { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
3353  *                                   BIT(NL80211_IFTYPE_P2P_CLIENT), },
3354  *      };
3355  *      struct ieee80211_iface_combination combination3 = {
3356  *              .limits = limits3,
3357  *              .n_limits = ARRAY_SIZE(limits3),
3358  *              .max_interfaces = 4,
3359  *              .num_different_channels = 2,
3360  *      };
3361  *
3362  */
3363 struct ieee80211_iface_combination {
3364         /**
3365          * @limits:
3366          * limits for the given interface types
3367          */
3368         const struct ieee80211_iface_limit *limits;
3369
3370         /**
3371          * @num_different_channels:
3372          * can use up to this many different channels
3373          */
3374         u32 num_different_channels;
3375
3376         /**
3377          * @max_interfaces:
3378          * maximum number of interfaces in total allowed in this group
3379          */
3380         u16 max_interfaces;
3381
3382         /**
3383          * @n_limits:
3384          * number of limitations
3385          */
3386         u8 n_limits;
3387
3388         /**
3389          * @beacon_int_infra_match:
3390          * In this combination, the beacon intervals between infrastructure
3391          * and AP types must match. This is required only in special cases.
3392          */
3393         bool beacon_int_infra_match;
3394
3395         /**
3396          * @radar_detect_widths:
3397          * bitmap of channel widths supported for radar detection
3398          */
3399         u8 radar_detect_widths;
3400
3401         /**
3402          * @radar_detect_regions:
3403          * bitmap of regions supported for radar detection
3404          */
3405         u8 radar_detect_regions;
3406
3407         /**
3408          * @beacon_int_min_gcd:
3409          * This interface combination supports different beacon intervals.
3410          *
3411          * = 0
3412          *   all beacon intervals for different interface must be same.
3413          * > 0
3414          *   any beacon interval for the interface part of this combination AND
3415          *   GCD of all beacon intervals from beaconing interfaces of this
3416          *   combination must be greater or equal to this value.
3417          */
3418         u32 beacon_int_min_gcd;
3419 };
3420
3421 struct ieee80211_txrx_stypes {
3422         u16 tx, rx;
3423 };
3424
3425 /**
3426  * enum wiphy_wowlan_support_flags - WoWLAN support flags
3427  * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
3428  *      trigger that keeps the device operating as-is and
3429  *      wakes up the host on any activity, for example a
3430  *      received packet that passed filtering; note that the
3431  *      packet should be preserved in that case
3432  * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
3433  *      (see nl80211.h)
3434  * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
3435  * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
3436  * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
3437  * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
3438  * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
3439  * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
3440  * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
3441  */
3442 enum wiphy_wowlan_support_flags {
3443         WIPHY_WOWLAN_ANY                = BIT(0),
3444         WIPHY_WOWLAN_MAGIC_PKT          = BIT(1),
3445         WIPHY_WOWLAN_DISCONNECT         = BIT(2),
3446         WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
3447         WIPHY_WOWLAN_GTK_REKEY_FAILURE  = BIT(4),
3448         WIPHY_WOWLAN_EAP_IDENTITY_REQ   = BIT(5),
3449         WIPHY_WOWLAN_4WAY_HANDSHAKE     = BIT(6),
3450         WIPHY_WOWLAN_RFKILL_RELEASE     = BIT(7),
3451         WIPHY_WOWLAN_NET_DETECT         = BIT(8),
3452 };
3453
3454 struct wiphy_wowlan_tcp_support {
3455         const struct nl80211_wowlan_tcp_data_token_feature *tok;
3456         u32 data_payload_max;
3457         u32 data_interval_max;
3458         u32 wake_payload_max;
3459         bool seq;
3460 };
3461
3462 /**
3463  * struct wiphy_wowlan_support - WoWLAN support data
3464  * @flags: see &enum wiphy_wowlan_support_flags
3465  * @n_patterns: number of supported wakeup patterns
3466  *      (see nl80211.h for the pattern definition)
3467  * @pattern_max_len: maximum length of each pattern
3468  * @pattern_min_len: minimum length of each pattern
3469  * @max_pkt_offset: maximum Rx packet offset
3470  * @max_nd_match_sets: maximum number of matchsets for net-detect,
3471  *      similar, but not necessarily identical, to max_match_sets for
3472  *      scheduled scans.
3473  *      See &struct cfg80211_sched_scan_request.@match_sets for more
3474  *      details.
3475  * @tcp: TCP wakeup support information
3476  */
3477 struct wiphy_wowlan_support {
3478         u32 flags;
3479         int n_patterns;
3480         int pattern_max_len;
3481         int pattern_min_len;
3482         int max_pkt_offset;
3483         int max_nd_match_sets;
3484         const struct wiphy_wowlan_tcp_support *tcp;
3485 };
3486
3487 /**
3488  * struct wiphy_coalesce_support - coalesce support data
3489  * @n_rules: maximum number of coalesce rules
3490  * @max_delay: maximum supported coalescing delay in msecs
3491  * @n_patterns: number of supported patterns in a rule
3492  *      (see nl80211.h for the pattern definition)
3493  * @pattern_max_len: maximum length of each pattern
3494  * @pattern_min_len: minimum length of each pattern
3495  * @max_pkt_offset: maximum Rx packet offset
3496  */
3497 struct wiphy_coalesce_support {
3498         int n_rules;
3499         int max_delay;
3500         int n_patterns;
3501         int pattern_max_len;
3502         int pattern_min_len;
3503         int max_pkt_offset;
3504 };
3505
3506 /**
3507  * enum wiphy_vendor_command_flags - validation flags for vendor commands
3508  * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
3509  * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
3510  * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
3511  *      (must be combined with %_WDEV or %_NETDEV)
3512  */
3513 enum wiphy_vendor_command_flags {
3514         WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
3515         WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
3516         WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
3517 };
3518
3519 /**
3520  * struct wiphy_vendor_command - vendor command definition
3521  * @info: vendor command identifying information, as used in nl80211
3522  * @flags: flags, see &enum wiphy_vendor_command_flags
3523  * @doit: callback for the operation, note that wdev is %NULL if the
3524  *      flags didn't ask for a wdev and non-%NULL otherwise; the data
3525  *      pointer may be %NULL if userspace provided no data at all
3526  * @dumpit: dump callback, for transferring bigger/multiple items. The
3527  *      @storage points to cb->args[5], ie. is preserved over the multiple
3528  *      dumpit calls.
3529  * It's recommended to not have the same sub command with both @doit and
3530  * @dumpit, so that userspace can assume certain ones are get and others
3531  * are used with dump requests.
3532  */
3533 struct wiphy_vendor_command {
3534         struct nl80211_vendor_cmd_info info;
3535         u32 flags;
3536         int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3537                     const void *data, int data_len);
3538         int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3539                       struct sk_buff *skb, const void *data, int data_len,
3540                       unsigned long *storage);
3541 };
3542
3543 /**
3544  * struct wiphy_iftype_ext_capab - extended capabilities per interface type
3545  * @iftype: interface type
3546  * @extended_capabilities: extended capabilities supported by the driver,
3547  *      additional capabilities might be supported by userspace; these are the
3548  *      802.11 extended capabilities ("Extended Capabilities element") and are
3549  *      in the same format as in the information element. See IEEE Std
3550  *      802.11-2012 8.4.2.29 for the defined fields.
3551  * @extended_capabilities_mask: mask of the valid values
3552  * @extended_capabilities_len: length of the extended capabilities
3553  */
3554 struct wiphy_iftype_ext_capab {
3555         enum nl80211_iftype iftype;
3556         const u8 *extended_capabilities;
3557         const u8 *extended_capabilities_mask;
3558         u8 extended_capabilities_len;
3559 };
3560
3561 /**
3562  * struct wiphy - wireless hardware description
3563  * @reg_notifier: the driver's regulatory notification callback,
3564  *      note that if your driver uses wiphy_apply_custom_regulatory()
3565  *      the reg_notifier's request can be passed as NULL
3566  * @regd: the driver's regulatory domain, if one was requested via
3567  *      the regulatory_hint() API. This can be used by the driver
3568  *      on the reg_notifier() if it chooses to ignore future
3569  *      regulatory domain changes caused by other drivers.
3570  * @signal_type: signal type reported in &struct cfg80211_bss.
3571  * @cipher_suites: supported cipher suites
3572  * @n_cipher_suites: number of supported cipher suites
3573  * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
3574  * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
3575  * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
3576  *      -1 = fragmentation disabled, only odd values >= 256 used
3577  * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
3578  * @_net: the network namespace this wiphy currently lives in
3579  * @perm_addr: permanent MAC address of this device
3580  * @addr_mask: If the device supports multiple MAC addresses by masking,
3581  *      set this to a mask with variable bits set to 1, e.g. if the last
3582  *      four bits are variable then set it to 00-00-00-00-00-0f. The actual
3583  *      variable bits shall be determined by the interfaces added, with
3584  *      interfaces not matching the mask being rejected to be brought up.
3585  * @n_addresses: number of addresses in @addresses.
3586  * @addresses: If the device has more than one address, set this pointer
3587  *      to a list of addresses (6 bytes each). The first one will be used
3588  *      by default for perm_addr. In this case, the mask should be set to
3589  *      all-zeroes. In this case it is assumed that the device can handle
3590  *      the same number of arbitrary MAC addresses.
3591  * @registered: protects ->resume and ->suspend sysfs callbacks against
3592  *      unregister hardware
3593  * @debugfsdir: debugfs directory used for this wiphy, will be renamed
3594  *      automatically on wiphy renames
3595  * @dev: (virtual) struct device for this wiphy
3596  * @registered: helps synchronize suspend/resume with wiphy unregister
3597  * @wext: wireless extension handlers
3598  * @priv: driver private data (sized according to wiphy_new() parameter)
3599  * @interface_modes: bitmask of interfaces types valid for this wiphy,
3600  *      must be set by driver
3601  * @iface_combinations: Valid interface combinations array, should not
3602  *      list single interface types.
3603  * @n_iface_combinations: number of entries in @iface_combinations array.
3604  * @software_iftypes: bitmask of software interface types, these are not
3605  *      subject to any restrictions since they are purely managed in SW.
3606  * @flags: wiphy flags, see &enum wiphy_flags
3607  * @regulatory_flags: wiphy regulatory flags, see
3608  *      &enum ieee80211_regulatory_flags
3609  * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
3610  * @ext_features: extended features advertised to nl80211, see
3611  *      &enum nl80211_ext_feature_index.
3612  * @bss_priv_size: each BSS struct has private data allocated with it,
3613  *      this variable determines its size
3614  * @max_scan_ssids: maximum number of SSIDs the device can scan for in
3615  *      any given scan
3616  * @max_sched_scan_reqs: maximum number of scheduled scan requests that
3617  *      the device can run concurrently.
3618  * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
3619  *      for in any given scheduled scan
3620  * @max_match_sets: maximum number of match sets the device can handle
3621  *      when performing a scheduled scan, 0 if filtering is not
3622  *      supported.
3623  * @max_scan_ie_len: maximum length of user-controlled IEs device can
3624  *      add to probe request frames transmitted during a scan, must not
3625  *      include fixed IEs like supported rates
3626  * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
3627  *      scans
3628  * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
3629  *      of iterations) for scheduled scan supported by the device.
3630  * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
3631  *      single scan plan supported by the device.
3632  * @max_sched_scan_plan_iterations: maximum number of iterations for a single
3633  *      scan plan supported by the device.
3634  * @coverage_class: current coverage class
3635  * @fw_version: firmware version for ethtool reporting
3636  * @hw_version: hardware version for ethtool reporting
3637  * @max_num_pmkids: maximum number of PMKIDs supported by device
3638  * @privid: a pointer that drivers can use to identify if an arbitrary
3639  *      wiphy is theirs, e.g. in global notifiers
3640  * @bands: information about bands/channels supported by this device
3641  *
3642  * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
3643  *      transmitted through nl80211, points to an array indexed by interface
3644  *      type
3645  *
3646  * @available_antennas_tx: bitmap of antennas which are available to be
3647  *      configured as TX antennas. Antenna configuration commands will be
3648  *      rejected unless this or @available_antennas_rx is set.
3649  *
3650  * @available_antennas_rx: bitmap of antennas which are available to be
3651  *      configured as RX antennas. Antenna configuration commands will be
3652  *      rejected unless this or @available_antennas_tx is set.
3653  *
3654  * @probe_resp_offload:
3655  *       Bitmap of supported protocols for probe response offloading.
3656  *       See &enum nl80211_probe_resp_offload_support_attr. Only valid
3657  *       when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3658  *
3659  * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
3660  *      may request, if implemented.
3661  *
3662  * @wowlan: WoWLAN support information
3663  * @wowlan_config: current WoWLAN configuration; this should usually not be
3664  *      used since access to it is necessarily racy, use the parameter passed
3665  *      to the suspend() operation instead.
3666  *
3667  * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
3668  * @ht_capa_mod_mask:  Specify what ht_cap values can be over-ridden.
3669  *      If null, then none can be over-ridden.
3670  * @vht_capa_mod_mask:  Specify what VHT capabilities can be over-ridden.
3671  *      If null, then none can be over-ridden.
3672  *
3673  * @wdev_list: the list of associated (virtual) interfaces; this list must
3674  *      not be modified by the driver, but can be read with RTNL/RCU protection.
3675  *
3676  * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
3677  *      supports for ACL.
3678  *
3679  * @extended_capabilities: extended capabilities supported by the driver,
3680  *      additional capabilities might be supported by userspace; these are
3681  *      the 802.11 extended capabilities ("Extended Capabilities element")
3682  *      and are in the same format as in the information element. See
3683  *      802.11-2012 8.4.2.29 for the defined fields. These are the default
3684  *      extended capabilities to be used if the capabilities are not specified
3685  *      for a specific interface type in iftype_ext_capab.
3686  * @extended_capabilities_mask: mask of the valid values
3687  * @extended_capabilities_len: length of the extended capabilities
3688  * @iftype_ext_capab: array of extended capabilities per interface type
3689  * @num_iftype_ext_capab: number of interface types for which extended
3690  *      capabilities are specified separately.
3691  * @coalesce: packet coalescing support information
3692  *
3693  * @vendor_commands: array of vendor commands supported by the hardware
3694  * @n_vendor_commands: number of vendor commands
3695  * @vendor_events: array of vendor events supported by the hardware
3696  * @n_vendor_events: number of vendor events
3697  *
3698  * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
3699  *      (including P2P GO) or 0 to indicate no such limit is advertised. The
3700  *      driver is allowed to advertise a theoretical limit that it can reach in
3701  *      some cases, but may not always reach.
3702  *
3703  * @max_num_csa_counters: Number of supported csa_counters in beacons
3704  *      and probe responses.  This value should be set if the driver
3705  *      wishes to limit the number of csa counters. Default (0) means
3706  *      infinite.
3707  * @max_adj_channel_rssi_comp: max offset of between the channel on which the
3708  *      frame was sent and the channel on which the frame was heard for which
3709  *      the reported rssi is still valid. If a driver is able to compensate the
3710  *      low rssi when a frame is heard on different channel, then it should set
3711  *      this variable to the maximal offset for which it can compensate.
3712  *      This value should be set in MHz.
3713  * @bss_select_support: bitmask indicating the BSS selection criteria supported
3714  *      by the driver in the .connect() callback. The bit position maps to the
3715  *      attribute indices defined in &enum nl80211_bss_select_attr.
3716  *
3717  * @cookie_counter: unique generic cookie counter, used to identify objects.
3718  * @nan_supported_bands: bands supported by the device in NAN mode, a
3719  *      bitmap of &enum nl80211_band values.  For instance, for
3720  *      NL80211_BAND_2GHZ, bit 0 would be set
3721  *      (i.e. BIT(NL80211_BAND_2GHZ)).
3722  */
3723 struct wiphy {
3724         /* assign these fields before you register the wiphy */
3725
3726         /* permanent MAC address(es) */
3727         u8 perm_addr[ETH_ALEN];
3728         u8 addr_mask[ETH_ALEN];
3729
3730         struct mac_address *addresses;
3731
3732         const struct ieee80211_txrx_stypes *mgmt_stypes;
3733
3734         const struct ieee80211_iface_combination *iface_combinations;
3735         int n_iface_combinations;
3736         u16 software_iftypes;
3737
3738         u16 n_addresses;
3739
3740         /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
3741         u16 interface_modes;
3742
3743         u16 max_acl_mac_addrs;
3744
3745         u32 flags, regulatory_flags, features;
3746         u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
3747
3748         u32 ap_sme_capa;
3749
3750         enum cfg80211_signal_type signal_type;
3751
3752         int bss_priv_size;
3753         u8 max_scan_ssids;
3754         u8 max_sched_scan_reqs;
3755         u8 max_sched_scan_ssids;
3756         u8 max_match_sets;
3757         u16 max_scan_ie_len;
3758         u16 max_sched_scan_ie_len;
3759         u32 max_sched_scan_plans;
3760         u32 max_sched_scan_plan_interval;
3761         u32 max_sched_scan_plan_iterations;
3762
3763         int n_cipher_suites;
3764         const u32 *cipher_suites;
3765
3766         u8 retry_short;
3767         u8 retry_long;
3768         u32 frag_threshold;
3769         u32 rts_threshold;
3770         u8 coverage_class;
3771
3772         char fw_version[ETHTOOL_FWVERS_LEN];
3773         u32 hw_version;
3774
3775 #ifdef CONFIG_PM
3776         const struct wiphy_wowlan_support *wowlan;
3777         struct cfg80211_wowlan *wowlan_config;
3778 #endif
3779
3780         u16 max_remain_on_channel_duration;
3781
3782         u8 max_num_pmkids;
3783
3784         u32 available_antennas_tx;
3785         u32 available_antennas_rx;
3786
3787         /*
3788          * Bitmap of supported protocols for probe response offloading
3789          * see &enum nl80211_probe_resp_offload_support_attr. Only valid
3790          * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3791          */
3792         u32 probe_resp_offload;
3793
3794         const u8 *extended_capabilities, *extended_capabilities_mask;
3795         u8 extended_capabilities_len;
3796
3797         const struct wiphy_iftype_ext_capab *iftype_ext_capab;
3798         unsigned int num_iftype_ext_capab;
3799
3800         /* If multiple wiphys are registered and you're handed e.g.
3801          * a regular netdev with assigned ieee80211_ptr, you won't
3802          * know whether it points to a wiphy your driver has registered
3803          * or not. Assign this to something global to your driver to
3804          * help determine whether you own this wiphy or not. */
3805         const void *privid;
3806
3807         struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
3808
3809         /* Lets us get back the wiphy on the callback */
3810         void (*reg_notifier)(struct wiphy *wiphy,
3811                              struct regulatory_request *request);
3812
3813         /* fields below are read-only, assigned by cfg80211 */
3814
3815         const struct ieee80211_regdomain __rcu *regd;
3816
3817         /* the item in /sys/class/ieee80211/ points to this,
3818          * you need use set_wiphy_dev() (see below) */
3819         struct device dev;
3820
3821         /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3822         bool registered;
3823
3824         /* dir in debugfs: ieee80211/<wiphyname> */
3825         struct dentry *debugfsdir;
3826
3827         const struct ieee80211_ht_cap *ht_capa_mod_mask;
3828         const struct ieee80211_vht_cap *vht_capa_mod_mask;
3829
3830         struct list_head wdev_list;
3831
3832         /* the network namespace this phy lives in currently */
3833         possible_net_t _net;
3834
3835 #ifdef CONFIG_CFG80211_WEXT
3836         const struct iw_handler_def *wext;
3837 #endif
3838
3839         const struct wiphy_coalesce_support *coalesce;
3840
3841         const struct wiphy_vendor_command *vendor_commands;
3842         const struct nl80211_vendor_cmd_info *vendor_events;
3843         int n_vendor_commands, n_vendor_events;
3844
3845         u16 max_ap_assoc_sta;
3846
3847         u8 max_num_csa_counters;
3848         u8 max_adj_channel_rssi_comp;
3849
3850         u32 bss_select_support;
3851
3852         u64 cookie_counter;
3853
3854         u8 nan_supported_bands;
3855
3856         char priv[0] __aligned(NETDEV_ALIGN);
3857 };
3858
3859 static inline struct net *wiphy_net(struct wiphy *wiphy)
3860 {
3861         return read_pnet(&wiphy->_net);
3862 }
3863
3864 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
3865 {
3866         write_pnet(&wiphy->_net, net);
3867 }
3868
3869 /**
3870  * wiphy_priv - return priv from wiphy
3871  *
3872  * @wiphy: the wiphy whose priv pointer to return
3873  * Return: The priv of @wiphy.
3874  */
3875 static inline void *wiphy_priv(struct wiphy *wiphy)
3876 {
3877         BUG_ON(!wiphy);
3878         return &wiphy->priv;
3879 }
3880
3881 /**
3882  * priv_to_wiphy - return the wiphy containing the priv
3883  *
3884  * @priv: a pointer previously returned by wiphy_priv
3885  * Return: The wiphy of @priv.
3886  */
3887 static inline struct wiphy *priv_to_wiphy(void *priv)
3888 {
3889         BUG_ON(!priv);
3890         return container_of(priv, struct wiphy, priv);
3891 }
3892
3893 /**
3894  * set_wiphy_dev - set device pointer for wiphy
3895  *
3896  * @wiphy: The wiphy whose device to bind
3897  * @dev: The device to parent it to
3898  */
3899 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
3900 {
3901         wiphy->dev.parent = dev;
3902 }
3903
3904 /**
3905  * wiphy_dev - get wiphy dev pointer
3906  *
3907  * @wiphy: The wiphy whose device struct to look up
3908  * Return: The dev of @wiphy.
3909  */
3910 static inline struct device *wiphy_dev(struct wiphy *wiphy)
3911 {
3912         return wiphy->dev.parent;
3913 }
3914
3915 /**
3916  * wiphy_name - get wiphy name
3917  *
3918  * @wiphy: The wiphy whose name to return
3919  * Return: The name of @wiphy.
3920  */
3921 static inline const char *wiphy_name(const struct wiphy *wiphy)
3922 {
3923         return dev_name(&wiphy->dev);
3924 }
3925
3926 /**
3927  * wiphy_new_nm - create a new wiphy for use with cfg80211
3928  *
3929  * @ops: The configuration operations for this device
3930  * @sizeof_priv: The size of the private area to allocate
3931  * @requested_name: Request a particular name.
3932  *      NULL is valid value, and means use the default phy%d naming.
3933  *
3934  * Create a new wiphy and associate the given operations with it.
3935  * @sizeof_priv bytes are allocated for private use.
3936  *
3937  * Return: A pointer to the new wiphy. This pointer must be
3938  * assigned to each netdev's ieee80211_ptr for proper operation.
3939  */
3940 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
3941                            const char *requested_name);
3942
3943 /**
3944  * wiphy_new - create a new wiphy for use with cfg80211
3945  *
3946  * @ops: The configuration operations for this device
3947  * @sizeof_priv: The size of the private area to allocate
3948  *
3949  * Create a new wiphy and associate the given operations with it.
3950  * @sizeof_priv bytes are allocated for private use.
3951  *
3952  * Return: A pointer to the new wiphy. This pointer must be
3953  * assigned to each netdev's ieee80211_ptr for proper operation.
3954  */
3955 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
3956                                       int sizeof_priv)
3957 {
3958         return wiphy_new_nm(ops, sizeof_priv, NULL);
3959 }
3960
3961 /**
3962  * wiphy_register - register a wiphy with cfg80211
3963  *
3964  * @wiphy: The wiphy to register.
3965  *
3966  * Return: A non-negative wiphy index or a negative error code.
3967  */
3968 int wiphy_register(struct wiphy *wiphy);
3969
3970 /**
3971  * wiphy_unregister - deregister a wiphy from cfg80211
3972  *
3973  * @wiphy: The wiphy to unregister.
3974  *
3975  * After this call, no more requests can be made with this priv
3976  * pointer, but the call may sleep to wait for an outstanding
3977  * request that is being handled.
3978  */
3979 void wiphy_unregister(struct wiphy *wiphy);
3980
3981 /**
3982  * wiphy_free - free wiphy
3983  *
3984  * @wiphy: The wiphy to free
3985  */
3986 void wiphy_free(struct wiphy *wiphy);
3987
3988 /* internal structs */
3989 struct cfg80211_conn;
3990 struct cfg80211_internal_bss;
3991 struct cfg80211_cached_keys;
3992 struct cfg80211_cqm_config;
3993
3994 /**
3995  * struct wireless_dev - wireless device state
3996  *
3997  * For netdevs, this structure must be allocated by the driver
3998  * that uses the ieee80211_ptr field in struct net_device (this
3999  * is intentional so it can be allocated along with the netdev.)
4000  * It need not be registered then as netdev registration will
4001  * be intercepted by cfg80211 to see the new wireless device.
4002  *
4003  * For non-netdev uses, it must also be allocated by the driver
4004  * in response to the cfg80211 callbacks that require it, as
4005  * there's no netdev registration in that case it may not be
4006  * allocated outside of callback operations that return it.
4007  *
4008  * @wiphy: pointer to hardware description
4009  * @iftype: interface type
4010  * @list: (private) Used to collect the interfaces
4011  * @netdev: (private) Used to reference back to the netdev, may be %NULL
4012  * @identifier: (private) Identifier used in nl80211 to identify this
4013  *      wireless device if it has no netdev
4014  * @current_bss: (private) Used by the internal configuration code
4015  * @chandef: (private) Used by the internal configuration code to track
4016  *      the user-set channel definition.
4017  * @preset_chandef: (private) Used by the internal configuration code to
4018  *      track the channel to be used for AP later
4019  * @bssid: (private) Used by the internal configuration code
4020  * @ssid: (private) Used by the internal configuration code
4021  * @ssid_len: (private) Used by the internal configuration code
4022  * @mesh_id_len: (private) Used by the internal configuration code
4023  * @mesh_id_up_len: (private) Used by the internal configuration code
4024  * @wext: (private) Used by the internal wireless extensions compat code
4025  * @use_4addr: indicates 4addr mode is used on this interface, must be
4026  *      set by driver (if supported) on add_interface BEFORE registering the
4027  *      netdev and may otherwise be used by driver read-only, will be update
4028  *      by cfg80211 on change_interface
4029  * @mgmt_registrations: list of registrations for management frames
4030  * @mgmt_registrations_lock: lock for the list
4031  * @mtx: mutex used to lock data in this struct, may be used by drivers
4032  *      and some API functions require it held
4033  * @beacon_interval: beacon interval used on this device for transmitting
4034  *      beacons, 0 when not valid
4035  * @address: The address for this device, valid only if @netdev is %NULL
4036  * @is_running: true if this is a non-netdev device that has been started, e.g.
4037  *      the P2P Device.
4038  * @cac_started: true if DFS channel availability check has been started
4039  * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
4040  * @cac_time_ms: CAC time in ms
4041  * @ps: powersave mode is enabled
4042  * @ps_timeout: dynamic powersave timeout
4043  * @ap_unexpected_nlportid: (private) netlink port ID of application
4044  *      registered for unexpected class 3 frames (AP mode)
4045  * @conn: (private) cfg80211 software SME connection state machine data
4046  * @connect_keys: (private) keys to set after connection is established
4047  * @conn_bss_type: connecting/connected BSS type
4048  * @conn_owner_nlportid: (private) connection owner socket port ID
4049  * @disconnect_wk: (private) auto-disconnect work
4050  * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
4051  * @ibss_fixed: (private) IBSS is using fixed BSSID
4052  * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
4053  * @event_list: (private) list for internal event processing
4054  * @event_lock: (private) lock for event list
4055  * @owner_nlportid: (private) owner socket port ID
4056  * @nl_owner_dead: (private) owner socket went away
4057  * @cqm_config: (private) nl80211 RSSI monitor state
4058  */
4059 struct wireless_dev {
4060         struct wiphy *wiphy;
4061         enum nl80211_iftype iftype;
4062
4063         /* the remainder of this struct should be private to cfg80211 */
4064         struct list_head list;
4065         struct net_device *netdev;
4066
4067         u32 identifier;
4068
4069         struct list_head mgmt_registrations;
4070         spinlock_t mgmt_registrations_lock;
4071
4072         struct mutex mtx;
4073
4074         bool use_4addr, is_running;
4075
4076         u8 address[ETH_ALEN] __aligned(sizeof(u16));
4077
4078         /* currently used for IBSS and SME - might be rearranged later */
4079         u8 ssid[IEEE80211_MAX_SSID_LEN];
4080         u8 ssid_len, mesh_id_len, mesh_id_up_len;
4081         struct cfg80211_conn *conn;
4082         struct cfg80211_cached_keys *connect_keys;
4083         enum ieee80211_bss_type conn_bss_type;
4084         u32 conn_owner_nlportid;
4085
4086         struct work_struct disconnect_wk;
4087         u8 disconnect_bssid[ETH_ALEN];
4088
4089         struct list_head event_list;
4090         spinlock_t event_lock;
4091
4092         struct cfg80211_internal_bss *current_bss; /* associated / joined */
4093         struct cfg80211_chan_def preset_chandef;
4094         struct cfg80211_chan_def chandef;
4095
4096         bool ibss_fixed;
4097         bool ibss_dfs_possible;
4098
4099         bool ps;
4100         int ps_timeout;
4101
4102         int beacon_interval;
4103
4104         u32 ap_unexpected_nlportid;
4105
4106         u32 owner_nlportid;
4107         bool nl_owner_dead;
4108
4109         bool cac_started;
4110         unsigned long cac_start_time;
4111         unsigned int cac_time_ms;
4112
4113 #ifdef CONFIG_CFG80211_WEXT
4114         /* wext data */
4115         struct {
4116                 struct cfg80211_ibss_params ibss;
4117                 struct cfg80211_connect_params connect;
4118                 struct cfg80211_cached_keys *keys;
4119                 const u8 *ie;
4120                 size_t ie_len;
4121                 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
4122                 u8 ssid[IEEE80211_MAX_SSID_LEN];
4123                 s8 default_key, default_mgmt_key;
4124                 bool prev_bssid_valid;
4125         } wext;
4126 #endif
4127
4128         struct cfg80211_cqm_config *cqm_config;
4129 };
4130
4131 static inline u8 *wdev_address(struct wireless_dev *wdev)
4132 {
4133         if (wdev->netdev)
4134                 return wdev->netdev->dev_addr;
4135         return wdev->address;
4136 }
4137
4138 static inline bool wdev_running(struct wireless_dev *wdev)
4139 {
4140         if (wdev->netdev)
4141                 return netif_running(wdev->netdev);
4142         return wdev->is_running;
4143 }
4144
4145 /**
4146  * wdev_priv - return wiphy priv from wireless_dev
4147  *
4148  * @wdev: The wireless device whose wiphy's priv pointer to return
4149  * Return: The wiphy priv of @wdev.
4150  */
4151 static inline void *wdev_priv(struct wireless_dev *wdev)
4152 {
4153         BUG_ON(!wdev);
4154         return wiphy_priv(wdev->wiphy);
4155 }
4156
4157 /**
4158  * DOC: Utility functions
4159  *
4160  * cfg80211 offers a number of utility functions that can be useful.
4161  */
4162
4163 /**
4164  * ieee80211_channel_to_frequency - convert channel number to frequency
4165  * @chan: channel number
4166  * @band: band, necessary due to channel number overlap
4167  * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
4168  */
4169 int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
4170
4171 /**
4172  * ieee80211_frequency_to_channel - convert frequency to channel number
4173  * @freq: center frequency
4174  * Return: The corresponding channel, or 0 if the conversion failed.
4175  */
4176 int ieee80211_frequency_to_channel(int freq);
4177
4178 /**
4179  * ieee80211_get_channel - get channel struct from wiphy for specified frequency
4180  *
4181  * @wiphy: the struct wiphy to get the channel for
4182  * @freq: the center frequency of the channel
4183  *
4184  * Return: The channel struct from @wiphy at @freq.
4185  */
4186 struct ieee80211_channel *ieee80211_get_channel(struct wiphy *wiphy, int freq);
4187
4188 /**
4189  * ieee80211_get_response_rate - get basic rate for a given rate
4190  *
4191  * @sband: the band to look for rates in
4192  * @basic_rates: bitmap of basic rates
4193  * @bitrate: the bitrate for which to find the basic rate
4194  *
4195  * Return: The basic rate corresponding to a given bitrate, that
4196  * is the next lower bitrate contained in the basic rate map,
4197  * which is, for this function, given as a bitmap of indices of
4198  * rates in the band's bitrate table.
4199  */
4200 struct ieee80211_rate *
4201 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
4202                             u32 basic_rates, int bitrate);
4203
4204 /**
4205  * ieee80211_mandatory_rates - get mandatory rates for a given band
4206  * @sband: the band to look for rates in
4207  * @scan_width: width of the control channel
4208  *
4209  * This function returns a bitmap of the mandatory rates for the given
4210  * band, bits are set according to the rate position in the bitrates array.
4211  */
4212 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
4213                               enum nl80211_bss_scan_width scan_width);
4214
4215 /*
4216  * Radiotap parsing functions -- for controlled injection support
4217  *
4218  * Implemented in net/wireless/radiotap.c
4219  * Documentation in Documentation/networking/radiotap-headers.txt
4220  */
4221
4222 struct radiotap_align_size {
4223         uint8_t align:4, size:4;
4224 };
4225
4226 struct ieee80211_radiotap_namespace {
4227         const struct radiotap_align_size *align_size;
4228         int n_bits;
4229         uint32_t oui;
4230         uint8_t subns;
4231 };
4232
4233 struct ieee80211_radiotap_vendor_namespaces {
4234         const struct ieee80211_radiotap_namespace *ns;
4235         int n_ns;
4236 };
4237
4238 /**
4239  * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
4240  * @this_arg_index: index of current arg, valid after each successful call
4241  *      to ieee80211_radiotap_iterator_next()
4242  * @this_arg: pointer to current radiotap arg; it is valid after each
4243  *      call to ieee80211_radiotap_iterator_next() but also after
4244  *      ieee80211_radiotap_iterator_init() where it will point to
4245  *      the beginning of the actual data portion
4246  * @this_arg_size: length of the current arg, for convenience
4247  * @current_namespace: pointer to the current namespace definition
4248  *      (or internally %NULL if the current namespace is unknown)
4249  * @is_radiotap_ns: indicates whether the current namespace is the default
4250  *      radiotap namespace or not
4251  *
4252  * @_rtheader: pointer to the radiotap header we are walking through
4253  * @_max_length: length of radiotap header in cpu byte ordering
4254  * @_arg_index: next argument index
4255  * @_arg: next argument pointer
4256  * @_next_bitmap: internal pointer to next present u32
4257  * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
4258  * @_vns: vendor namespace definitions
4259  * @_next_ns_data: beginning of the next namespace's data
4260  * @_reset_on_ext: internal; reset the arg index to 0 when going to the
4261  *      next bitmap word
4262  *
4263  * Describes the radiotap parser state. Fields prefixed with an underscore
4264  * must not be used by users of the parser, only by the parser internally.
4265  */
4266
4267 struct ieee80211_radiotap_iterator {
4268         struct ieee80211_radiotap_header *_rtheader;
4269         const struct ieee80211_radiotap_vendor_namespaces *_vns;
4270         const struct ieee80211_radiotap_namespace *current_namespace;
4271
4272         unsigned char *_arg, *_next_ns_data;
4273         __le32 *_next_bitmap;
4274
4275         unsigned char *this_arg;
4276         int this_arg_index;
4277         int this_arg_size;
4278
4279         int is_radiotap_ns;
4280
4281         int _max_length;
4282         int _arg_index;
4283         uint32_t _bitmap_shifter;
4284         int _reset_on_ext;
4285 };
4286
4287 int
4288 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
4289                                  struct ieee80211_radiotap_header *radiotap_header,
4290                                  int max_length,
4291                                  const struct ieee80211_radiotap_vendor_namespaces *vns);
4292
4293 int
4294 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
4295
4296
4297 extern const unsigned char rfc1042_header[6];
4298 extern const unsigned char bridge_tunnel_header[6];
4299
4300 /**
4301  * ieee80211_get_hdrlen_from_skb - get header length from data
4302  *
4303  * @skb: the frame
4304  *
4305  * Given an skb with a raw 802.11 header at the data pointer this function
4306  * returns the 802.11 header length.
4307  *
4308  * Return: The 802.11 header length in bytes (not including encryption
4309  * headers). Or 0 if the data in the sk_buff is too short to contain a valid
4310  * 802.11 header.
4311  */
4312 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
4313
4314 /**
4315  * ieee80211_hdrlen - get header length in bytes from frame control
4316  * @fc: frame control field in little-endian format
4317  * Return: The header length in bytes.
4318  */
4319 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
4320
4321 /**
4322  * ieee80211_get_mesh_hdrlen - get mesh extension header length
4323  * @meshhdr: the mesh extension header, only the flags field
4324  *      (first byte) will be accessed
4325  * Return: The length of the extension header, which is always at
4326  * least 6 bytes and at most 18 if address 5 and 6 are present.
4327  */
4328 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
4329
4330 /**
4331  * DOC: Data path helpers
4332  *
4333  * In addition to generic utilities, cfg80211 also offers
4334  * functions that help implement the data path for devices
4335  * that do not do the 802.11/802.3 conversion on the device.
4336  */
4337
4338 /**
4339  * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
4340  * @skb: the 802.11 data frame
4341  * @ehdr: pointer to a &struct ethhdr that will get the header, instead
4342  *      of it being pushed into the SKB
4343  * @addr: the device MAC address
4344  * @iftype: the virtual interface type
4345  * Return: 0 on success. Non-zero on error.
4346  */
4347 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
4348                                   const u8 *addr, enum nl80211_iftype iftype);
4349
4350 /**
4351  * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
4352  * @skb: the 802.11 data frame
4353  * @addr: the device MAC address
4354  * @iftype: the virtual interface type
4355  * Return: 0 on success. Non-zero on error.
4356  */
4357 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
4358                                          enum nl80211_iftype iftype)
4359 {
4360         return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype);
4361 }
4362
4363 /**
4364  * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
4365  *
4366  * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
4367  * The @list will be empty if the decode fails. The @skb must be fully
4368  * header-less before being passed in here; it is freed in this function.
4369  *
4370  * @skb: The input A-MSDU frame without any headers.
4371  * @list: The output list of 802.3 frames. It must be allocated and
4372  *      initialized by by the caller.
4373  * @addr: The device MAC address.
4374  * @iftype: The device interface type.
4375  * @extra_headroom: The hardware extra headroom for SKBs in the @list.
4376  * @check_da: DA to check in the inner ethernet header, or NULL
4377  * @check_sa: SA to check in the inner ethernet header, or NULL
4378  */
4379 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
4380                               const u8 *addr, enum nl80211_iftype iftype,
4381                               const unsigned int extra_headroom,
4382                               const u8 *check_da, const u8 *check_sa);
4383
4384 /**
4385  * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
4386  * @skb: the data frame
4387  * @qos_map: Interworking QoS mapping or %NULL if not in use
4388  * Return: The 802.1p/1d tag.
4389  */
4390 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
4391                                     struct cfg80211_qos_map *qos_map);
4392
4393 /**
4394  * cfg80211_find_ie_match - match information element and byte array in data
4395  *
4396  * @eid: element ID
4397  * @ies: data consisting of IEs
4398  * @len: length of data
4399  * @match: byte array to match
4400  * @match_len: number of bytes in the match array
4401  * @match_offset: offset in the IE where the byte array should match.
4402  *      If match_len is zero, this must also be set to zero.
4403  *      Otherwise this must be set to 2 or more, because the first
4404  *      byte is the element id, which is already compared to eid, and
4405  *      the second byte is the IE length.
4406  *
4407  * Return: %NULL if the element ID could not be found or if
4408  * the element is invalid (claims to be longer than the given
4409  * data) or if the byte array doesn't match, or a pointer to the first
4410  * byte of the requested element, that is the byte containing the
4411  * element ID.
4412  *
4413  * Note: There are no checks on the element length other than
4414  * having to fit into the given data and being large enough for the
4415  * byte array to match.
4416  */
4417 const u8 *cfg80211_find_ie_match(u8 eid, const u8 *ies, int len,
4418                                  const u8 *match, int match_len,
4419                                  int match_offset);
4420
4421 /**
4422  * cfg80211_find_ie - find information element in data
4423  *
4424  * @eid: element ID
4425  * @ies: data consisting of IEs
4426  * @len: length of data
4427  *
4428  * Return: %NULL if the element ID could not be found or if
4429  * the element is invalid (claims to be longer than the given
4430  * data), or a pointer to the first byte of the requested
4431  * element, that is the byte containing the element ID.
4432  *
4433  * Note: There are no checks on the element length other than
4434  * having to fit into the given data.
4435  */
4436 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
4437 {
4438         return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
4439 }
4440
4441 /**
4442  * cfg80211_find_ext_ie - find information element with EID Extension in data
4443  *
4444  * @ext_eid: element ID Extension
4445  * @ies: data consisting of IEs
4446  * @len: length of data
4447  *
4448  * Return: %NULL if the extended element ID could not be found or if
4449  * the element is invalid (claims to be longer than the given
4450  * data), or a pointer to the first byte of the requested
4451  * element, that is the byte containing the element ID.
4452  *
4453  * Note: There are no checks on the element length other than
4454  * having to fit into the given data.
4455  */
4456 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
4457 {
4458         return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
4459                                       &ext_eid, 1, 2);
4460 }
4461
4462 /**
4463  * cfg80211_find_vendor_ie - find vendor specific information element in data
4464  *
4465  * @oui: vendor OUI
4466  * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
4467  * @ies: data consisting of IEs
4468  * @len: length of data
4469  *
4470  * Return: %NULL if the vendor specific element ID could not be found or if the
4471  * element is invalid (claims to be longer than the given data), or a pointer to
4472  * the first byte of the requested element, that is the byte containing the
4473  * element ID.
4474  *
4475  * Note: There are no checks on the element length other than having to fit into
4476  * the given data.
4477  */
4478 const u8 *cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
4479                                   const u8 *ies, int len);
4480
4481 /**
4482  * DOC: Regulatory enforcement infrastructure
4483  *
4484  * TODO
4485  */
4486
4487 /**
4488  * regulatory_hint - driver hint to the wireless core a regulatory domain
4489  * @wiphy: the wireless device giving the hint (used only for reporting
4490  *      conflicts)
4491  * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
4492  *      should be in. If @rd is set this should be NULL. Note that if you
4493  *      set this to NULL you should still set rd->alpha2 to some accepted
4494  *      alpha2.
4495  *
4496  * Wireless drivers can use this function to hint to the wireless core
4497  * what it believes should be the current regulatory domain by
4498  * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
4499  * domain should be in or by providing a completely build regulatory domain.
4500  * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
4501  * for a regulatory domain structure for the respective country.
4502  *
4503  * The wiphy must have been registered to cfg80211 prior to this call.
4504  * For cfg80211 drivers this means you must first use wiphy_register(),
4505  * for mac80211 drivers you must first use ieee80211_register_hw().
4506  *
4507  * Drivers should check the return value, its possible you can get
4508  * an -ENOMEM.
4509  *
4510  * Return: 0 on success. -ENOMEM.
4511  */
4512 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
4513
4514 /**
4515  * regulatory_set_wiphy_regd - set regdom info for self managed drivers
4516  * @wiphy: the wireless device we want to process the regulatory domain on
4517  * @rd: the regulatory domain informatoin to use for this wiphy
4518  *
4519  * Set the regulatory domain information for self-managed wiphys, only they
4520  * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
4521  * information.
4522  *
4523  * Return: 0 on success. -EINVAL, -EPERM
4524  */
4525 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
4526                               struct ieee80211_regdomain *rd);
4527
4528 /**
4529  * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
4530  * @wiphy: the wireless device we want to process the regulatory domain on
4531  * @rd: the regulatory domain information to use for this wiphy
4532  *
4533  * This functions requires the RTNL to be held and applies the new regdomain
4534  * synchronously to this wiphy. For more details see
4535  * regulatory_set_wiphy_regd().
4536  *
4537  * Return: 0 on success. -EINVAL, -EPERM
4538  */
4539 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
4540                                         struct ieee80211_regdomain *rd);
4541
4542 /**
4543  * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
4544  * @wiphy: the wireless device we want to process the regulatory domain on
4545  * @regd: the custom regulatory domain to use for this wiphy
4546  *
4547  * Drivers can sometimes have custom regulatory domains which do not apply
4548  * to a specific country. Drivers can use this to apply such custom regulatory
4549  * domains. This routine must be called prior to wiphy registration. The
4550  * custom regulatory domain will be trusted completely and as such previous
4551  * default channel settings will be disregarded. If no rule is found for a
4552  * channel on the regulatory domain the channel will be disabled.
4553  * Drivers using this for a wiphy should also set the wiphy flag
4554  * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
4555  * that called this helper.
4556  */
4557 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
4558                                    const struct ieee80211_regdomain *regd);
4559
4560 /**
4561  * freq_reg_info - get regulatory information for the given frequency
4562  * @wiphy: the wiphy for which we want to process this rule for
4563  * @center_freq: Frequency in KHz for which we want regulatory information for
4564  *
4565  * Use this function to get the regulatory rule for a specific frequency on
4566  * a given wireless device. If the device has a specific regulatory domain
4567  * it wants to follow we respect that unless a country IE has been received
4568  * and processed already.
4569  *
4570  * Return: A valid pointer, or, when an error occurs, for example if no rule
4571  * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
4572  * check and PTR_ERR() to obtain the numeric return value. The numeric return
4573  * value will be -ERANGE if we determine the given center_freq does not even
4574  * have a regulatory rule for a frequency range in the center_freq's band.
4575  * See freq_in_rule_band() for our current definition of a band -- this is
4576  * purely subjective and right now it's 802.11 specific.
4577  */
4578 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
4579                                                u32 center_freq);
4580
4581 /**
4582  * reg_initiator_name - map regulatory request initiator enum to name
4583  * @initiator: the regulatory request initiator
4584  *
4585  * You can use this to map the regulatory request initiator enum to a
4586  * proper string representation.
4587  */
4588 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
4589
4590 /*
4591  * callbacks for asynchronous cfg80211 methods, notification
4592  * functions and BSS handling helpers
4593  */
4594
4595 /**
4596  * cfg80211_scan_done - notify that scan finished
4597  *
4598  * @request: the corresponding scan request
4599  * @info: information about the completed scan
4600  */
4601 void cfg80211_scan_done(struct cfg80211_scan_request *request,
4602                         struct cfg80211_scan_info *info);
4603
4604 /**
4605  * cfg80211_sched_scan_results - notify that new scan results are available
4606  *
4607  * @wiphy: the wiphy which got scheduled scan results
4608  * @reqid: identifier for the related scheduled scan request
4609  */
4610 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
4611
4612 /**
4613  * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
4614  *
4615  * @wiphy: the wiphy on which the scheduled scan stopped
4616  * @reqid: identifier for the related scheduled scan request
4617  *
4618  * The driver can call this function to inform cfg80211 that the
4619  * scheduled scan had to be stopped, for whatever reason.  The driver
4620  * is then called back via the sched_scan_stop operation when done.
4621  */
4622 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
4623
4624 /**
4625  * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
4626  *
4627  * @wiphy: the wiphy on which the scheduled scan stopped
4628  * @reqid: identifier for the related scheduled scan request
4629  *
4630  * The driver can call this function to inform cfg80211 that the
4631  * scheduled scan had to be stopped, for whatever reason.  The driver
4632  * is then called back via the sched_scan_stop operation when done.
4633  * This function should be called with rtnl locked.
4634  */
4635 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy, u64 reqid);
4636
4637 /**
4638  * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
4639  * @wiphy: the wiphy reporting the BSS
4640  * @data: the BSS metadata
4641  * @mgmt: the management frame (probe response or beacon)
4642  * @len: length of the management frame
4643  * @gfp: context flags
4644  *
4645  * This informs cfg80211 that BSS information was found and
4646  * the BSS should be updated/added.
4647  *
4648  * Return: A referenced struct, must be released with cfg80211_put_bss()!
4649  * Or %NULL on error.
4650  */
4651 struct cfg80211_bss * __must_check
4652 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
4653                                struct cfg80211_inform_bss *data,
4654                                struct ieee80211_mgmt *mgmt, size_t len,
4655                                gfp_t gfp);
4656
4657 static inline struct cfg80211_bss * __must_check
4658 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
4659                                 struct ieee80211_channel *rx_channel,
4660                                 enum nl80211_bss_scan_width scan_width,
4661                                 struct ieee80211_mgmt *mgmt, size_t len,
4662                                 s32 signal, gfp_t gfp)
4663 {
4664         struct cfg80211_inform_bss data = {
4665                 .chan = rx_channel,
4666                 .scan_width = scan_width,
4667                 .signal = signal,
4668         };
4669
4670         return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4671 }
4672
4673 static inline struct cfg80211_bss * __must_check
4674 cfg80211_inform_bss_frame(struct wiphy *wiphy,
4675                           struct ieee80211_channel *rx_channel,
4676                           struct ieee80211_mgmt *mgmt, size_t len,
4677                           s32 signal, gfp_t gfp)
4678 {
4679         struct cfg80211_inform_bss data = {
4680                 .chan = rx_channel,
4681                 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4682                 .signal = signal,
4683         };
4684
4685         return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4686 }
4687
4688 /**
4689  * enum cfg80211_bss_frame_type - frame type that the BSS data came from
4690  * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
4691  *      from a beacon or probe response
4692  * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
4693  * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
4694  */
4695 enum cfg80211_bss_frame_type {
4696         CFG80211_BSS_FTYPE_UNKNOWN,
4697         CFG80211_BSS_FTYPE_BEACON,
4698         CFG80211_BSS_FTYPE_PRESP,
4699 };
4700
4701 /**
4702  * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
4703  *
4704  * @wiphy: the wiphy reporting the BSS
4705  * @data: the BSS metadata
4706  * @ftype: frame type (if known)
4707  * @bssid: the BSSID of the BSS
4708  * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
4709  * @capability: the capability field sent by the peer
4710  * @beacon_interval: the beacon interval announced by the peer
4711  * @ie: additional IEs sent by the peer
4712  * @ielen: length of the additional IEs
4713  * @gfp: context flags
4714  *
4715  * This informs cfg80211 that BSS information was found and
4716  * the BSS should be updated/added.
4717  *
4718  * Return: A referenced struct, must be released with cfg80211_put_bss()!
4719  * Or %NULL on error.
4720  */
4721 struct cfg80211_bss * __must_check
4722 cfg80211_inform_bss_data(struct wiphy *wiphy,
4723                          struct cfg80211_inform_bss *data,
4724                          enum cfg80211_bss_frame_type ftype,
4725                          const u8 *bssid, u64 tsf, u16 capability,
4726                          u16 beacon_interval, const u8 *ie, size_t ielen,
4727                          gfp_t gfp);
4728
4729 static inline struct cfg80211_bss * __must_check
4730 cfg80211_inform_bss_width(struct wiphy *wiphy,
4731                           struct ieee80211_channel *rx_channel,
4732                           enum nl80211_bss_scan_width scan_width,
4733                           enum cfg80211_bss_frame_type ftype,
4734                           const u8 *bssid, u64 tsf, u16 capability,
4735                           u16 beacon_interval, const u8 *ie, size_t ielen,
4736                           s32 signal, gfp_t gfp)
4737 {
4738         struct cfg80211_inform_bss data = {
4739                 .chan = rx_channel,
4740                 .scan_width = scan_width,
4741                 .signal = signal,
4742         };
4743
4744         return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4745                                         capability, beacon_interval, ie, ielen,
4746                                         gfp);
4747 }
4748
4749 static inline struct cfg80211_bss * __must_check
4750 cfg80211_inform_bss(struct wiphy *wiphy,
4751                     struct ieee80211_channel *rx_channel,
4752                     enum cfg80211_bss_frame_type ftype,
4753                     const u8 *bssid, u64 tsf, u16 capability,
4754                     u16 beacon_interval, const u8 *ie, size_t ielen,
4755                     s32 signal, gfp_t gfp)
4756 {
4757         struct cfg80211_inform_bss data = {
4758                 .chan = rx_channel,
4759                 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4760                 .signal = signal,
4761         };
4762
4763         return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4764                                         capability, beacon_interval, ie, ielen,
4765                                         gfp);
4766 }
4767
4768 /**
4769  * cfg80211_get_bss - get a BSS reference
4770  * @wiphy: the wiphy this BSS struct belongs to
4771  * @channel: the channel to search on (or %NULL)
4772  * @bssid: the desired BSSID (or %NULL)
4773  * @ssid: the desired SSID (or %NULL)
4774  * @ssid_len: length of the SSID (or 0)
4775  * @bss_type: type of BSS, see &enum ieee80211_bss_type
4776  * @privacy: privacy filter, see &enum ieee80211_privacy
4777  */
4778 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
4779                                       struct ieee80211_channel *channel,
4780                                       const u8 *bssid,
4781                                       const u8 *ssid, size_t ssid_len,
4782                                       enum ieee80211_bss_type bss_type,
4783                                       enum ieee80211_privacy privacy);
4784 static inline struct cfg80211_bss *
4785 cfg80211_get_ibss(struct wiphy *wiphy,
4786                   struct ieee80211_channel *channel,
4787                   const u8 *ssid, size_t ssid_len)
4788 {
4789         return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
4790                                 IEEE80211_BSS_TYPE_IBSS,
4791                                 IEEE80211_PRIVACY_ANY);
4792 }
4793
4794 /**
4795  * cfg80211_ref_bss - reference BSS struct
4796  * @wiphy: the wiphy this BSS struct belongs to
4797  * @bss: the BSS struct to reference
4798  *
4799  * Increments the refcount of the given BSS struct.
4800  */
4801 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4802
4803 /**
4804  * cfg80211_put_bss - unref BSS struct
4805  * @wiphy: the wiphy this BSS struct belongs to
4806  * @bss: the BSS struct
4807  *
4808  * Decrements the refcount of the given BSS struct.
4809  */
4810 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4811
4812 /**
4813  * cfg80211_unlink_bss - unlink BSS from internal data structures
4814  * @wiphy: the wiphy
4815  * @bss: the bss to remove
4816  *
4817  * This function removes the given BSS from the internal data structures
4818  * thereby making it no longer show up in scan results etc. Use this
4819  * function when you detect a BSS is gone. Normally BSSes will also time
4820  * out, so it is not necessary to use this function at all.
4821  */
4822 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4823
4824 static inline enum nl80211_bss_scan_width
4825 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
4826 {
4827         switch (chandef->width) {
4828         case NL80211_CHAN_WIDTH_5:
4829                 return NL80211_BSS_CHAN_WIDTH_5;
4830         case NL80211_CHAN_WIDTH_10:
4831                 return NL80211_BSS_CHAN_WIDTH_10;
4832         default:
4833                 return NL80211_BSS_CHAN_WIDTH_20;
4834         }
4835 }
4836
4837 /**
4838  * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
4839  * @dev: network device
4840  * @buf: authentication frame (header + body)
4841  * @len: length of the frame data
4842  *
4843  * This function is called whenever an authentication, disassociation or
4844  * deauthentication frame has been received and processed in station mode.
4845  * After being asked to authenticate via cfg80211_ops::auth() the driver must
4846  * call either this function or cfg80211_auth_timeout().
4847  * After being asked to associate via cfg80211_ops::assoc() the driver must
4848  * call either this function or cfg80211_auth_timeout().
4849  * While connected, the driver must calls this for received and processed
4850  * disassociation and deauthentication frames. If the frame couldn't be used
4851  * because it was unprotected, the driver must call the function
4852  * cfg80211_rx_unprot_mlme_mgmt() instead.
4853  *
4854  * This function may sleep. The caller must hold the corresponding wdev's mutex.
4855  */
4856 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4857
4858 /**
4859  * cfg80211_auth_timeout - notification of timed out authentication
4860  * @dev: network device
4861  * @addr: The MAC address of the device with which the authentication timed out
4862  *
4863  * This function may sleep. The caller must hold the corresponding wdev's
4864  * mutex.
4865  */
4866 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
4867
4868 /**
4869  * cfg80211_rx_assoc_resp - notification of processed association response
4870  * @dev: network device
4871  * @bss: the BSS that association was requested with, ownership of the pointer
4872  *      moves to cfg80211 in this call
4873  * @buf: authentication frame (header + body)
4874  * @len: length of the frame data
4875  * @uapsd_queues: bitmap of queues configured for uapsd. Same format
4876  *      as the AC bitmap in the QoS info field
4877  *
4878  * After being asked to associate via cfg80211_ops::assoc() the driver must
4879  * call either this function or cfg80211_auth_timeout().
4880  *
4881  * This function may sleep. The caller must hold the corresponding wdev's mutex.
4882  */
4883 void cfg80211_rx_assoc_resp(struct net_device *dev,
4884                             struct cfg80211_bss *bss,
4885                             const u8 *buf, size_t len,
4886                             int uapsd_queues);
4887
4888 /**
4889  * cfg80211_assoc_timeout - notification of timed out association
4890  * @dev: network device
4891  * @bss: The BSS entry with which association timed out.
4892  *
4893  * This function may sleep. The caller must hold the corresponding wdev's mutex.
4894  */
4895 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
4896
4897 /**
4898  * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
4899  * @dev: network device
4900  * @bss: The BSS entry with which association was abandoned.
4901  *
4902  * Call this whenever - for reasons reported through other API, like deauth RX,
4903  * an association attempt was abandoned.
4904  * This function may sleep. The caller must hold the corresponding wdev's mutex.
4905  */
4906 void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
4907
4908 /**
4909  * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
4910  * @dev: network device
4911  * @buf: 802.11 frame (header + body)
4912  * @len: length of the frame data
4913  *
4914  * This function is called whenever deauthentication has been processed in
4915  * station mode. This includes both received deauthentication frames and
4916  * locally generated ones. This function may sleep. The caller must hold the
4917  * corresponding wdev's mutex.
4918  */
4919 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4920
4921 /**
4922  * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
4923  * @dev: network device
4924  * @buf: deauthentication frame (header + body)
4925  * @len: length of the frame data
4926  *
4927  * This function is called whenever a received deauthentication or dissassoc
4928  * frame has been dropped in station mode because of MFP being used but the
4929  * frame was not protected. This function may sleep.
4930  */
4931 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
4932                                   const u8 *buf, size_t len);
4933
4934 /**
4935  * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
4936  * @dev: network device
4937  * @addr: The source MAC address of the frame
4938  * @key_type: The key type that the received frame used
4939  * @key_id: Key identifier (0..3). Can be -1 if missing.
4940  * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
4941  * @gfp: allocation flags
4942  *
4943  * This function is called whenever the local MAC detects a MIC failure in a
4944  * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
4945  * primitive.
4946  */
4947 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
4948                                   enum nl80211_key_type key_type, int key_id,
4949                                   const u8 *tsc, gfp_t gfp);
4950
4951 /**
4952  * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
4953  *
4954  * @dev: network device
4955  * @bssid: the BSSID of the IBSS joined
4956  * @channel: the channel of the IBSS joined
4957  * @gfp: allocation flags
4958  *
4959  * This function notifies cfg80211 that the device joined an IBSS or
4960  * switched to a different BSSID. Before this function can be called,
4961  * either a beacon has to have been received from the IBSS, or one of
4962  * the cfg80211_inform_bss{,_frame} functions must have been called
4963  * with the locally generated beacon -- this guarantees that there is
4964  * always a scan result for this IBSS. cfg80211 will handle the rest.
4965  */
4966 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
4967                           struct ieee80211_channel *channel, gfp_t gfp);
4968
4969 /**
4970  * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
4971  *
4972  * @dev: network device
4973  * @macaddr: the MAC address of the new candidate
4974  * @ie: information elements advertised by the peer candidate
4975  * @ie_len: lenght of the information elements buffer
4976  * @gfp: allocation flags
4977  *
4978  * This function notifies cfg80211 that the mesh peer candidate has been
4979  * detected, most likely via a beacon or, less likely, via a probe response.
4980  * cfg80211 then sends a notification to userspace.
4981  */
4982 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
4983                 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
4984
4985 /**
4986  * DOC: RFkill integration
4987  *
4988  * RFkill integration in cfg80211 is almost invisible to drivers,
4989  * as cfg80211 automatically registers an rfkill instance for each
4990  * wireless device it knows about. Soft kill is also translated
4991  * into disconnecting and turning all interfaces off, drivers are
4992  * expected to turn off the device when all interfaces are down.
4993  *
4994  * However, devices may have a hard RFkill line, in which case they
4995  * also need to interact with the rfkill subsystem, via cfg80211.
4996  * They can do this with a few helper functions documented here.
4997  */
4998
4999 /**
5000  * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
5001  * @wiphy: the wiphy
5002  * @blocked: block status
5003  */
5004 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
5005
5006 /**
5007  * wiphy_rfkill_start_polling - start polling rfkill
5008  * @wiphy: the wiphy
5009  */
5010 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
5011
5012 /**
5013  * wiphy_rfkill_stop_polling - stop polling rfkill
5014  * @wiphy: the wiphy
5015  */
5016 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
5017
5018 /**
5019  * DOC: Vendor commands
5020  *
5021  * Occasionally, there are special protocol or firmware features that
5022  * can't be implemented very openly. For this and similar cases, the
5023  * vendor command functionality allows implementing the features with
5024  * (typically closed-source) userspace and firmware, using nl80211 as
5025  * the configuration mechanism.
5026  *
5027  * A driver supporting vendor commands must register them as an array
5028  * in struct wiphy, with handlers for each one, each command has an
5029  * OUI and sub command ID to identify it.
5030  *
5031  * Note that this feature should not be (ab)used to implement protocol
5032  * features that could openly be shared across drivers. In particular,
5033  * it must never be required to use vendor commands to implement any
5034  * "normal" functionality that higher-level userspace like connection
5035  * managers etc. need.
5036  */
5037
5038 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
5039                                            enum nl80211_commands cmd,
5040                                            enum nl80211_attrs attr,
5041                                            int approxlen);
5042
5043 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
5044                                            struct wireless_dev *wdev,
5045                                            enum nl80211_commands cmd,
5046                                            enum nl80211_attrs attr,
5047                                            int vendor_event_idx,
5048                                            int approxlen, gfp_t gfp);
5049
5050 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
5051
5052 /**
5053  * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
5054  * @wiphy: the wiphy
5055  * @approxlen: an upper bound of the length of the data that will
5056  *      be put into the skb
5057  *
5058  * This function allocates and pre-fills an skb for a reply to
5059  * a vendor command. Since it is intended for a reply, calling
5060  * it outside of a vendor command's doit() operation is invalid.
5061  *
5062  * The returned skb is pre-filled with some identifying data in
5063  * a way that any data that is put into the skb (with skb_put(),
5064  * nla_put() or similar) will end up being within the
5065  * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
5066  * with the skb is adding data for the corresponding userspace tool
5067  * which can then read that data out of the vendor data attribute.
5068  * You must not modify the skb in any other way.
5069  *
5070  * When done, call cfg80211_vendor_cmd_reply() with the skb and return
5071  * its error code as the result of the doit() operation.
5072  *
5073  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5074  */
5075 static inline struct sk_buff *
5076 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
5077 {
5078         return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
5079                                           NL80211_ATTR_VENDOR_DATA, approxlen);
5080 }
5081
5082 /**
5083  * cfg80211_vendor_cmd_reply - send the reply skb
5084  * @skb: The skb, must have been allocated with
5085  *      cfg80211_vendor_cmd_alloc_reply_skb()
5086  *
5087  * Since calling this function will usually be the last thing
5088  * before returning from the vendor command doit() you should
5089  * return the error code.  Note that this function consumes the
5090  * skb regardless of the return value.
5091  *
5092  * Return: An error code or 0 on success.
5093  */
5094 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
5095
5096 /**
5097  * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
5098  * @wiphy: the wiphy
5099  * @wdev: the wireless device
5100  * @event_idx: index of the vendor event in the wiphy's vendor_events
5101  * @approxlen: an upper bound of the length of the data that will
5102  *      be put into the skb
5103  * @gfp: allocation flags
5104  *
5105  * This function allocates and pre-fills an skb for an event on the
5106  * vendor-specific multicast group.
5107  *
5108  * If wdev != NULL, both the ifindex and identifier of the specified
5109  * wireless device are added to the event message before the vendor data
5110  * attribute.
5111  *
5112  * When done filling the skb, call cfg80211_vendor_event() with the
5113  * skb to send the event.
5114  *
5115  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5116  */
5117 static inline struct sk_buff *
5118 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
5119                              int approxlen, int event_idx, gfp_t gfp)
5120 {
5121         return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
5122                                           NL80211_ATTR_VENDOR_DATA,
5123                                           event_idx, approxlen, gfp);
5124 }
5125
5126 /**
5127  * cfg80211_vendor_event - send the event
5128  * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
5129  * @gfp: allocation flags
5130  *
5131  * This function sends the given @skb, which must have been allocated
5132  * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
5133  */
5134 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
5135 {
5136         __cfg80211_send_event_skb(skb, gfp);
5137 }
5138
5139 #ifdef CONFIG_NL80211_TESTMODE
5140 /**
5141  * DOC: Test mode
5142  *
5143  * Test mode is a set of utility functions to allow drivers to
5144  * interact with driver-specific tools to aid, for instance,
5145  * factory programming.
5146  *
5147  * This chapter describes how drivers interact with it, for more
5148  * information see the nl80211 book's chapter on it.
5149  */
5150
5151 /**
5152  * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
5153  * @wiphy: the wiphy
5154  * @approxlen: an upper bound of the length of the data that will
5155  *      be put into the skb
5156  *
5157  * This function allocates and pre-fills an skb for a reply to
5158  * the testmode command. Since it is intended for a reply, calling
5159  * it outside of the @testmode_cmd operation is invalid.
5160  *
5161  * The returned skb is pre-filled with the wiphy index and set up in
5162  * a way that any data that is put into the skb (with skb_put(),
5163  * nla_put() or similar) will end up being within the
5164  * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
5165  * with the skb is adding data for the corresponding userspace tool
5166  * which can then read that data out of the testdata attribute. You
5167  * must not modify the skb in any other way.
5168  *
5169  * When done, call cfg80211_testmode_reply() with the skb and return
5170  * its error code as the result of the @testmode_cmd operation.
5171  *
5172  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5173  */
5174 static inline struct sk_buff *
5175 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
5176 {
5177         return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
5178                                           NL80211_ATTR_TESTDATA, approxlen);
5179 }
5180
5181 /**
5182  * cfg80211_testmode_reply - send the reply skb
5183  * @skb: The skb, must have been allocated with
5184  *      cfg80211_testmode_alloc_reply_skb()
5185  *
5186  * Since calling this function will usually be the last thing
5187  * before returning from the @testmode_cmd you should return
5188  * the error code.  Note that this function consumes the skb
5189  * regardless of the return value.
5190  *
5191  * Return: An error code or 0 on success.
5192  */
5193 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
5194 {
5195         return cfg80211_vendor_cmd_reply(skb);
5196 }
5197
5198 /**
5199  * cfg80211_testmode_alloc_event_skb - allocate testmode event
5200  * @wiphy: the wiphy
5201  * @approxlen: an upper bound of the length of the data that will
5202  *      be put into the skb
5203  * @gfp: allocation flags
5204  *
5205  * This function allocates and pre-fills an skb for an event on the
5206  * testmode multicast group.
5207  *
5208  * The returned skb is set up in the same way as with
5209  * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
5210  * there, you should simply add data to it that will then end up in the
5211  * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
5212  * in any other way.
5213  *
5214  * When done filling the skb, call cfg80211_testmode_event() with the
5215  * skb to send the event.
5216  *
5217  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5218  */
5219 static inline struct sk_buff *
5220 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
5221 {
5222         return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
5223                                           NL80211_ATTR_TESTDATA, -1,
5224                                           approxlen, gfp);
5225 }
5226
5227 /**
5228  * cfg80211_testmode_event - send the event
5229  * @skb: The skb, must have been allocated with
5230  *      cfg80211_testmode_alloc_event_skb()
5231  * @gfp: allocation flags
5232  *
5233  * This function sends the given @skb, which must have been allocated
5234  * by cfg80211_testmode_alloc_event_skb(), as an event. It always
5235  * consumes it.
5236  */
5237 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
5238 {
5239         __cfg80211_send_event_skb(skb, gfp);
5240 }
5241
5242 #define CFG80211_TESTMODE_CMD(cmd)      .testmode_cmd = (cmd),
5243 #define CFG80211_TESTMODE_DUMP(cmd)     .testmode_dump = (cmd),
5244 #else
5245 #define CFG80211_TESTMODE_CMD(cmd)
5246 #define CFG80211_TESTMODE_DUMP(cmd)
5247 #endif
5248
5249 /**
5250  * struct cfg80211_connect_resp_params - Connection response params
5251  * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
5252  *      %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5253  *      the real status code for failures. If this call is used to report a
5254  *      failure due to a timeout (e.g., not receiving an Authentication frame
5255  *      from the AP) instead of an explicit rejection by the AP, -1 is used to
5256  *      indicate that this is a failure, but without a status code.
5257  *      @timeout_reason is used to report the reason for the timeout in that
5258  *      case.
5259  * @bssid: The BSSID of the AP (may be %NULL)
5260  * @bss: Entry of bss to which STA got connected to, can be obtained through
5261  *      cfg80211_get_bss() (may be %NULL). Only one parameter among @bssid and
5262  *      @bss needs to be specified.
5263  * @req_ie: Association request IEs (may be %NULL)
5264  * @req_ie_len: Association request IEs length
5265  * @resp_ie: Association response IEs (may be %NULL)
5266  * @resp_ie_len: Association response IEs length
5267  * @fils_kek: KEK derived from a successful FILS connection (may be %NULL)
5268  * @fils_kek_len: Length of @fils_kek in octets
5269  * @update_erp_next_seq_num: Boolean value to specify whether the value in
5270  *      @fils_erp_next_seq_num is valid.
5271  * @fils_erp_next_seq_num: The next sequence number to use in ERP message in
5272  *      FILS Authentication. This value should be specified irrespective of the
5273  *      status for a FILS connection.
5274  * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
5275  * @pmk_len: Length of @pmk in octets
5276  * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
5277  *      used for this FILS connection (may be %NULL).
5278  * @timeout_reason: Reason for connection timeout. This is used when the
5279  *      connection fails due to a timeout instead of an explicit rejection from
5280  *      the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
5281  *      not known. This value is used only if @status < 0 to indicate that the
5282  *      failure is due to a timeout and not due to explicit rejection by the AP.
5283  *      This value is ignored in other cases (@status >= 0).
5284  */
5285 struct cfg80211_connect_resp_params {
5286         int status;
5287         const u8 *bssid;
5288         struct cfg80211_bss *bss;
5289         const u8 *req_ie;
5290         size_t req_ie_len;
5291         const u8 *resp_ie;
5292         size_t resp_ie_len;
5293         const u8 *fils_kek;
5294         size_t fils_kek_len;
5295         bool update_erp_next_seq_num;
5296         u16 fils_erp_next_seq_num;
5297         const u8 *pmk;
5298         size_t pmk_len;
5299         const u8 *pmkid;
5300         enum nl80211_timeout_reason timeout_reason;
5301 };
5302
5303 /**
5304  * cfg80211_connect_done - notify cfg80211 of connection result
5305  *
5306  * @dev: network device
5307  * @params: connection response parameters
5308  * @gfp: allocation flags
5309  *
5310  * It should be called by the underlying driver once execution of the connection
5311  * request from connect() has been completed. This is similar to
5312  * cfg80211_connect_bss(), but takes a structure pointer for connection response
5313  * parameters. Only one of the functions among cfg80211_connect_bss(),
5314  * cfg80211_connect_result(), cfg80211_connect_timeout(),
5315  * and cfg80211_connect_done() should be called.
5316  */
5317 void cfg80211_connect_done(struct net_device *dev,
5318                            struct cfg80211_connect_resp_params *params,
5319                            gfp_t gfp);
5320
5321 /**
5322  * cfg80211_connect_bss - notify cfg80211 of connection result
5323  *
5324  * @dev: network device
5325  * @bssid: the BSSID of the AP
5326  * @bss: entry of bss to which STA got connected to, can be obtained
5327  *      through cfg80211_get_bss (may be %NULL)
5328  * @req_ie: association request IEs (maybe be %NULL)
5329  * @req_ie_len: association request IEs length
5330  * @resp_ie: association response IEs (may be %NULL)
5331  * @resp_ie_len: assoc response IEs length
5332  * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
5333  *      %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5334  *      the real status code for failures. If this call is used to report a
5335  *      failure due to a timeout (e.g., not receiving an Authentication frame
5336  *      from the AP) instead of an explicit rejection by the AP, -1 is used to
5337  *      indicate that this is a failure, but without a status code.
5338  *      @timeout_reason is used to report the reason for the timeout in that
5339  *      case.
5340  * @gfp: allocation flags
5341  * @timeout_reason: reason for connection timeout. This is used when the
5342  *      connection fails due to a timeout instead of an explicit rejection from
5343  *      the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
5344  *      not known. This value is used only if @status < 0 to indicate that the
5345  *      failure is due to a timeout and not due to explicit rejection by the AP.
5346  *      This value is ignored in other cases (@status >= 0).
5347  *
5348  * It should be called by the underlying driver once execution of the connection
5349  * request from connect() has been completed. This is similar to
5350  * cfg80211_connect_result(), but with the option of identifying the exact bss
5351  * entry for the connection. Only one of the functions among
5352  * cfg80211_connect_bss(), cfg80211_connect_result(),
5353  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
5354  */
5355 static inline void
5356 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
5357                      struct cfg80211_bss *bss, const u8 *req_ie,
5358                      size_t req_ie_len, const u8 *resp_ie,
5359                      size_t resp_ie_len, int status, gfp_t gfp,
5360                      enum nl80211_timeout_reason timeout_reason)
5361 {
5362         struct cfg80211_connect_resp_params params;
5363
5364         memset(&params, 0, sizeof(params));
5365         params.status = status;
5366         params.bssid = bssid;
5367         params.bss = bss;
5368         params.req_ie = req_ie;
5369         params.req_ie_len = req_ie_len;
5370         params.resp_ie = resp_ie;
5371         params.resp_ie_len = resp_ie_len;
5372         params.timeout_reason = timeout_reason;
5373
5374         cfg80211_connect_done(dev, &params, gfp);
5375 }
5376
5377 /**
5378  * cfg80211_connect_result - notify cfg80211 of connection result
5379  *
5380  * @dev: network device
5381  * @bssid: the BSSID of the AP
5382  * @req_ie: association request IEs (maybe be %NULL)
5383  * @req_ie_len: association request IEs length
5384  * @resp_ie: association response IEs (may be %NULL)
5385  * @resp_ie_len: assoc response IEs length
5386  * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
5387  *      %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5388  *      the real status code for failures.
5389  * @gfp: allocation flags
5390  *
5391  * It should be called by the underlying driver once execution of the connection
5392  * request from connect() has been completed. This is similar to
5393  * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
5394  * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
5395  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
5396  */
5397 static inline void
5398 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
5399                         const u8 *req_ie, size_t req_ie_len,
5400                         const u8 *resp_ie, size_t resp_ie_len,
5401                         u16 status, gfp_t gfp)
5402 {
5403         cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
5404                              resp_ie_len, status, gfp,
5405                              NL80211_TIMEOUT_UNSPECIFIED);
5406 }
5407
5408 /**
5409  * cfg80211_connect_timeout - notify cfg80211 of connection timeout
5410  *
5411  * @dev: network device
5412  * @bssid: the BSSID of the AP
5413  * @req_ie: association request IEs (maybe be %NULL)
5414  * @req_ie_len: association request IEs length
5415  * @gfp: allocation flags
5416  * @timeout_reason: reason for connection timeout.
5417  *
5418  * It should be called by the underlying driver whenever connect() has failed
5419  * in a sequence where no explicit authentication/association rejection was
5420  * received from the AP. This could happen, e.g., due to not being able to send
5421  * out the Authentication or Association Request frame or timing out while
5422  * waiting for the response. Only one of the functions among
5423  * cfg80211_connect_bss(), cfg80211_connect_result(),
5424  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
5425  */
5426 static inline void
5427 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
5428                          const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
5429                          enum nl80211_timeout_reason timeout_reason)
5430 {
5431         cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
5432                              gfp, timeout_reason);
5433 }
5434
5435 /**
5436  * struct cfg80211_roam_info - driver initiated roaming information
5437  *
5438  * @channel: the channel of the new AP
5439  * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
5440  * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
5441  * @req_ie: association request IEs (maybe be %NULL)
5442  * @req_ie_len: association request IEs length
5443  * @resp_ie: association response IEs (may be %NULL)
5444  * @resp_ie_len: assoc response IEs length
5445  */
5446 struct cfg80211_roam_info {
5447         struct ieee80211_channel *channel;
5448         struct cfg80211_bss *bss;
5449         const u8 *bssid;
5450         const u8 *req_ie;
5451         size_t req_ie_len;
5452         const u8 *resp_ie;
5453         size_t resp_ie_len;
5454 };
5455
5456 /**
5457  * cfg80211_roamed - notify cfg80211 of roaming
5458  *
5459  * @dev: network device
5460  * @info: information about the new BSS. struct &cfg80211_roam_info.
5461  * @gfp: allocation flags
5462  *
5463  * This function may be called with the driver passing either the BSSID of the
5464  * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
5465  * It should be called by the underlying driver whenever it roamed from one AP
5466  * to another while connected. Drivers which have roaming implemented in
5467  * firmware should pass the bss entry to avoid a race in bss entry timeout where
5468  * the bss entry of the new AP is seen in the driver, but gets timed out by the
5469  * time it is accessed in __cfg80211_roamed() due to delay in scheduling
5470  * rdev->event_work. In case of any failures, the reference is released
5471  * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
5472  * released while diconneting from the current bss.
5473  */
5474 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
5475                      gfp_t gfp);
5476
5477 /**
5478  * cfg80211_port_authorized - notify cfg80211 of successful security association
5479  *
5480  * @dev: network device
5481  * @bssid: the BSSID of the AP
5482  * @gfp: allocation flags
5483  *
5484  * This function should be called by a driver that supports 4 way handshake
5485  * offload after a security association was successfully established (i.e.,
5486  * the 4 way handshake was completed successfully). The call to this function
5487  * should be preceded with a call to cfg80211_connect_result(),
5488  * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
5489  * indicate the 802.11 association.
5490  */
5491 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
5492                               gfp_t gfp);
5493
5494 /**
5495  * cfg80211_disconnected - notify cfg80211 that connection was dropped
5496  *
5497  * @dev: network device
5498  * @ie: information elements of the deauth/disassoc frame (may be %NULL)
5499  * @ie_len: length of IEs
5500  * @reason: reason code for the disconnection, set it to 0 if unknown
5501  * @locally_generated: disconnection was requested locally
5502  * @gfp: allocation flags
5503  *
5504  * After it calls this function, the driver should enter an idle state
5505  * and not try to connect to any AP any more.
5506  */
5507 void cfg80211_disconnected(struct net_device *dev, u16 reason,
5508                            const u8 *ie, size_t ie_len,
5509                            bool locally_generated, gfp_t gfp);
5510
5511 /**
5512  * cfg80211_ready_on_channel - notification of remain_on_channel start
5513  * @wdev: wireless device
5514  * @cookie: the request cookie
5515  * @chan: The current channel (from remain_on_channel request)
5516  * @duration: Duration in milliseconds that the driver intents to remain on the
5517  *      channel
5518  * @gfp: allocation flags
5519  */
5520 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
5521                                struct ieee80211_channel *chan,
5522                                unsigned int duration, gfp_t gfp);
5523
5524 /**
5525  * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
5526  * @wdev: wireless device
5527  * @cookie: the request cookie
5528  * @chan: The current channel (from remain_on_channel request)
5529  * @gfp: allocation flags
5530  */
5531 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
5532                                         struct ieee80211_channel *chan,
5533                                         gfp_t gfp);
5534
5535
5536 /**
5537  * cfg80211_new_sta - notify userspace about station
5538  *
5539  * @dev: the netdev
5540  * @mac_addr: the station's address
5541  * @sinfo: the station information
5542  * @gfp: allocation flags
5543  */
5544 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
5545                       struct station_info *sinfo, gfp_t gfp);
5546
5547 /**
5548  * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
5549  * @dev: the netdev
5550  * @mac_addr: the station's address
5551  * @sinfo: the station information/statistics
5552  * @gfp: allocation flags
5553  */
5554 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
5555                             struct station_info *sinfo, gfp_t gfp);
5556
5557 /**
5558  * cfg80211_del_sta - notify userspace about deletion of a station
5559  *
5560  * @dev: the netdev
5561  * @mac_addr: the station's address
5562  * @gfp: allocation flags
5563  */
5564 static inline void cfg80211_del_sta(struct net_device *dev,
5565                                     const u8 *mac_addr, gfp_t gfp)
5566 {
5567         cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
5568 }
5569
5570 /**
5571  * cfg80211_conn_failed - connection request failed notification
5572  *
5573  * @dev: the netdev
5574  * @mac_addr: the station's address
5575  * @reason: the reason for connection failure
5576  * @gfp: allocation flags
5577  *
5578  * Whenever a station tries to connect to an AP and if the station
5579  * could not connect to the AP as the AP has rejected the connection
5580  * for some reasons, this function is called.
5581  *
5582  * The reason for connection failure can be any of the value from
5583  * nl80211_connect_failed_reason enum
5584  */
5585 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
5586                           enum nl80211_connect_failed_reason reason,
5587                           gfp_t gfp);
5588
5589 /**
5590  * cfg80211_rx_mgmt - notification of received, unprocessed management frame
5591  * @wdev: wireless device receiving the frame
5592  * @freq: Frequency on which the frame was received in MHz
5593  * @sig_dbm: signal strength in dBm, or 0 if unknown
5594  * @buf: Management frame (header + body)
5595  * @len: length of the frame data
5596  * @flags: flags, as defined in enum nl80211_rxmgmt_flags
5597  *
5598  * This function is called whenever an Action frame is received for a station
5599  * mode interface, but is not processed in kernel.
5600  *
5601  * Return: %true if a user space application has registered for this frame.
5602  * For action frames, that makes it responsible for rejecting unrecognized
5603  * action frames; %false otherwise, in which case for action frames the
5604  * driver is responsible for rejecting the frame.
5605  */
5606 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
5607                       const u8 *buf, size_t len, u32 flags);
5608
5609 /**
5610  * cfg80211_mgmt_tx_status - notification of TX status for management frame
5611  * @wdev: wireless device receiving the frame
5612  * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
5613  * @buf: Management frame (header + body)
5614  * @len: length of the frame data
5615  * @ack: Whether frame was acknowledged
5616  * @gfp: context flags
5617  *
5618  * This function is called whenever a management frame was requested to be
5619  * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
5620  * transmission attempt.
5621  */
5622 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
5623                              const u8 *buf, size_t len, bool ack, gfp_t gfp);
5624
5625
5626 /**
5627  * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
5628  * @dev: network device
5629  * @rssi_event: the triggered RSSI event
5630  * @rssi_level: new RSSI level value or 0 if not available
5631  * @gfp: context flags
5632  *
5633  * This function is called when a configured connection quality monitoring
5634  * rssi threshold reached event occurs.
5635  */
5636 void cfg80211_cqm_rssi_notify(struct net_device *dev,
5637                               enum nl80211_cqm_rssi_threshold_event rssi_event,
5638                               s32 rssi_level, gfp_t gfp);
5639
5640 /**
5641  * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
5642  * @dev: network device
5643  * @peer: peer's MAC address
5644  * @num_packets: how many packets were lost -- should be a fixed threshold
5645  *      but probably no less than maybe 50, or maybe a throughput dependent
5646  *      threshold (to account for temporary interference)
5647  * @gfp: context flags
5648  */
5649 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
5650                                  const u8 *peer, u32 num_packets, gfp_t gfp);
5651
5652 /**
5653  * cfg80211_cqm_txe_notify - TX error rate event
5654  * @dev: network device
5655  * @peer: peer's MAC address
5656  * @num_packets: how many packets were lost
5657  * @rate: % of packets which failed transmission
5658  * @intvl: interval (in s) over which the TX failure threshold was breached.
5659  * @gfp: context flags
5660  *
5661  * Notify userspace when configured % TX failures over number of packets in a
5662  * given interval is exceeded.
5663  */
5664 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
5665                              u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
5666
5667 /**
5668  * cfg80211_cqm_beacon_loss_notify - beacon loss event
5669  * @dev: network device
5670  * @gfp: context flags
5671  *
5672  * Notify userspace about beacon loss from the connected AP.
5673  */
5674 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
5675
5676 /**
5677  * cfg80211_radar_event - radar detection event
5678  * @wiphy: the wiphy
5679  * @chandef: chandef for the current channel
5680  * @gfp: context flags
5681  *
5682  * This function is called when a radar is detected on the current chanenl.
5683  */
5684 void cfg80211_radar_event(struct wiphy *wiphy,
5685                           struct cfg80211_chan_def *chandef, gfp_t gfp);
5686
5687 /**
5688  * cfg80211_cac_event - Channel availability check (CAC) event
5689  * @netdev: network device
5690  * @chandef: chandef for the current channel
5691  * @event: type of event
5692  * @gfp: context flags
5693  *
5694  * This function is called when a Channel availability check (CAC) is finished
5695  * or aborted. This must be called to notify the completion of a CAC process,
5696  * also by full-MAC drivers.
5697  */
5698 void cfg80211_cac_event(struct net_device *netdev,
5699                         const struct cfg80211_chan_def *chandef,
5700                         enum nl80211_radar_event event, gfp_t gfp);
5701
5702
5703 /**
5704  * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
5705  * @dev: network device
5706  * @bssid: BSSID of AP (to avoid races)
5707  * @replay_ctr: new replay counter
5708  * @gfp: allocation flags
5709  */
5710 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
5711                                const u8 *replay_ctr, gfp_t gfp);
5712
5713 /**
5714  * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
5715  * @dev: network device
5716  * @index: candidate index (the smaller the index, the higher the priority)
5717  * @bssid: BSSID of AP
5718  * @preauth: Whether AP advertises support for RSN pre-authentication
5719  * @gfp: allocation flags
5720  */
5721 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
5722                                      const u8 *bssid, bool preauth, gfp_t gfp);
5723
5724 /**
5725  * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
5726  * @dev: The device the frame matched to
5727  * @addr: the transmitter address
5728  * @gfp: context flags
5729  *
5730  * This function is used in AP mode (only!) to inform userspace that
5731  * a spurious class 3 frame was received, to be able to deauth the
5732  * sender.
5733  * Return: %true if the frame was passed to userspace (or this failed
5734  * for a reason other than not having a subscription.)
5735  */
5736 bool cfg80211_rx_spurious_frame(struct net_device *dev,
5737                                 const u8 *addr, gfp_t gfp);
5738
5739 /**
5740  * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
5741  * @dev: The device the frame matched to
5742  * @addr: the transmitter address
5743  * @gfp: context flags
5744  *
5745  * This function is used in AP mode (only!) to inform userspace that
5746  * an associated station sent a 4addr frame but that wasn't expected.
5747  * It is allowed and desirable to send this event only once for each
5748  * station to avoid event flooding.
5749  * Return: %true if the frame was passed to userspace (or this failed
5750  * for a reason other than not having a subscription.)
5751  */
5752 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
5753                                         const u8 *addr, gfp_t gfp);
5754
5755 /**
5756  * cfg80211_probe_status - notify userspace about probe status
5757  * @dev: the device the probe was sent on
5758  * @addr: the address of the peer
5759  * @cookie: the cookie filled in @probe_client previously
5760  * @acked: indicates whether probe was acked or not
5761  * @gfp: allocation flags
5762  */
5763 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
5764                            u64 cookie, bool acked, gfp_t gfp);
5765
5766 /**
5767  * cfg80211_report_obss_beacon - report beacon from other APs
5768  * @wiphy: The wiphy that received the beacon
5769  * @frame: the frame
5770  * @len: length of the frame
5771  * @freq: frequency the frame was received on
5772  * @sig_dbm: signal strength in dBm, or 0 if unknown
5773  *
5774  * Use this function to report to userspace when a beacon was
5775  * received. It is not useful to call this when there is no
5776  * netdev that is in AP/GO mode.
5777  */
5778 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
5779                                  const u8 *frame, size_t len,
5780                                  int freq, int sig_dbm);
5781
5782 /**
5783  * cfg80211_reg_can_beacon - check if beaconing is allowed
5784  * @wiphy: the wiphy
5785  * @chandef: the channel definition
5786  * @iftype: interface type
5787  *
5788  * Return: %true if there is no secondary channel or the secondary channel(s)
5789  * can be used for beaconing (i.e. is not a radar channel etc.)
5790  */
5791 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
5792                              struct cfg80211_chan_def *chandef,
5793                              enum nl80211_iftype iftype);
5794
5795 /**
5796  * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
5797  * @wiphy: the wiphy
5798  * @chandef: the channel definition
5799  * @iftype: interface type
5800  *
5801  * Return: %true if there is no secondary channel or the secondary channel(s)
5802  * can be used for beaconing (i.e. is not a radar channel etc.). This version
5803  * also checks if IR-relaxation conditions apply, to allow beaconing under
5804  * more permissive conditions.
5805  *
5806  * Requires the RTNL to be held.
5807  */
5808 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
5809                                    struct cfg80211_chan_def *chandef,
5810                                    enum nl80211_iftype iftype);
5811
5812 /*
5813  * cfg80211_ch_switch_notify - update wdev channel and notify userspace
5814  * @dev: the device which switched channels
5815  * @chandef: the new channel definition
5816  *
5817  * Caller must acquire wdev_lock, therefore must only be called from sleepable
5818  * driver context!
5819  */
5820 void cfg80211_ch_switch_notify(struct net_device *dev,
5821                                struct cfg80211_chan_def *chandef);
5822
5823 /*
5824  * cfg80211_ch_switch_started_notify - notify channel switch start
5825  * @dev: the device on which the channel switch started
5826  * @chandef: the future channel definition
5827  * @count: the number of TBTTs until the channel switch happens
5828  *
5829  * Inform the userspace about the channel switch that has just
5830  * started, so that it can take appropriate actions (eg. starting
5831  * channel switch on other vifs), if necessary.
5832  */
5833 void cfg80211_ch_switch_started_notify(struct net_device *dev,
5834                                        struct cfg80211_chan_def *chandef,
5835                                        u8 count);
5836
5837 /**
5838  * ieee80211_operating_class_to_band - convert operating class to band
5839  *
5840  * @operating_class: the operating class to convert
5841  * @band: band pointer to fill
5842  *
5843  * Returns %true if the conversion was successful, %false otherwise.
5844  */
5845 bool ieee80211_operating_class_to_band(u8 operating_class,
5846                                        enum nl80211_band *band);
5847
5848 /**
5849  * ieee80211_chandef_to_operating_class - convert chandef to operation class
5850  *
5851  * @chandef: the chandef to convert
5852  * @op_class: a pointer to the resulting operating class
5853  *
5854  * Returns %true if the conversion was successful, %false otherwise.
5855  */
5856 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
5857                                           u8 *op_class);
5858
5859 /*
5860  * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
5861  * @dev: the device on which the operation is requested
5862  * @peer: the MAC address of the peer device
5863  * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
5864  *      NL80211_TDLS_TEARDOWN)
5865  * @reason_code: the reason code for teardown request
5866  * @gfp: allocation flags
5867  *
5868  * This function is used to request userspace to perform TDLS operation that
5869  * requires knowledge of keys, i.e., link setup or teardown when the AP
5870  * connection uses encryption. This is optional mechanism for the driver to use
5871  * if it can automatically determine when a TDLS link could be useful (e.g.,
5872  * based on traffic and signal strength for a peer).
5873  */
5874 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
5875                                 enum nl80211_tdls_operation oper,
5876                                 u16 reason_code, gfp_t gfp);
5877
5878 /*
5879  * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
5880  * @rate: given rate_info to calculate bitrate from
5881  *
5882  * return 0 if MCS index >= 32
5883  */
5884 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
5885
5886 /**
5887  * cfg80211_unregister_wdev - remove the given wdev
5888  * @wdev: struct wireless_dev to remove
5889  *
5890  * Call this function only for wdevs that have no netdev assigned,
5891  * e.g. P2P Devices. It removes the device from the list so that
5892  * it can no longer be used. It is necessary to call this function
5893  * even when cfg80211 requests the removal of the interface by
5894  * calling the del_virtual_intf() callback. The function must also
5895  * be called when the driver wishes to unregister the wdev, e.g.
5896  * when the device is unbound from the driver.
5897  *
5898  * Requires the RTNL to be held.
5899  */
5900 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
5901
5902 /**
5903  * struct cfg80211_ft_event - FT Information Elements
5904  * @ies: FT IEs
5905  * @ies_len: length of the FT IE in bytes
5906  * @target_ap: target AP's MAC address
5907  * @ric_ies: RIC IE
5908  * @ric_ies_len: length of the RIC IE in bytes
5909  */
5910 struct cfg80211_ft_event_params {
5911         const u8 *ies;
5912         size_t ies_len;
5913         const u8 *target_ap;
5914         const u8 *ric_ies;
5915         size_t ric_ies_len;
5916 };
5917
5918 /**
5919  * cfg80211_ft_event - notify userspace about FT IE and RIC IE
5920  * @netdev: network device
5921  * @ft_event: IE information
5922  */
5923 void cfg80211_ft_event(struct net_device *netdev,
5924                        struct cfg80211_ft_event_params *ft_event);
5925
5926 /**
5927  * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
5928  * @ies: the input IE buffer
5929  * @len: the input length
5930  * @attr: the attribute ID to find
5931  * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
5932  *      if the function is only called to get the needed buffer size
5933  * @bufsize: size of the output buffer
5934  *
5935  * The function finds a given P2P attribute in the (vendor) IEs and
5936  * copies its contents to the given buffer.
5937  *
5938  * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
5939  * malformed or the attribute can't be found (respectively), or the
5940  * length of the found attribute (which can be zero).
5941  */
5942 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
5943                           enum ieee80211_p2p_attr_id attr,
5944                           u8 *buf, unsigned int bufsize);
5945
5946 /**
5947  * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
5948  * @ies: the IE buffer
5949  * @ielen: the length of the IE buffer
5950  * @ids: an array with element IDs that are allowed before
5951  *      the split. A WLAN_EID_EXTENSION value means that the next
5952  *      EID in the list is a sub-element of the EXTENSION IE.
5953  * @n_ids: the size of the element ID array
5954  * @after_ric: array IE types that come after the RIC element
5955  * @n_after_ric: size of the @after_ric array
5956  * @offset: offset where to start splitting in the buffer
5957  *
5958  * This function splits an IE buffer by updating the @offset
5959  * variable to point to the location where the buffer should be
5960  * split.
5961  *
5962  * It assumes that the given IE buffer is well-formed, this
5963  * has to be guaranteed by the caller!
5964  *
5965  * It also assumes that the IEs in the buffer are ordered
5966  * correctly, if not the result of using this function will not
5967  * be ordered correctly either, i.e. it does no reordering.
5968  *
5969  * The function returns the offset where the next part of the
5970  * buffer starts, which may be @ielen if the entire (remainder)
5971  * of the buffer should be used.
5972  */
5973 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
5974                               const u8 *ids, int n_ids,
5975                               const u8 *after_ric, int n_after_ric,
5976                               size_t offset);
5977
5978 /**
5979  * ieee80211_ie_split - split an IE buffer according to ordering
5980  * @ies: the IE buffer
5981  * @ielen: the length of the IE buffer
5982  * @ids: an array with element IDs that are allowed before
5983  *      the split. A WLAN_EID_EXTENSION value means that the next
5984  *      EID in the list is a sub-element of the EXTENSION IE.
5985  * @n_ids: the size of the element ID array
5986  * @offset: offset where to start splitting in the buffer
5987  *
5988  * This function splits an IE buffer by updating the @offset
5989  * variable to point to the location where the buffer should be
5990  * split.
5991  *
5992  * It assumes that the given IE buffer is well-formed, this
5993  * has to be guaranteed by the caller!
5994  *
5995  * It also assumes that the IEs in the buffer are ordered
5996  * correctly, if not the result of using this function will not
5997  * be ordered correctly either, i.e. it does no reordering.
5998  *
5999  * The function returns the offset where the next part of the
6000  * buffer starts, which may be @ielen if the entire (remainder)
6001  * of the buffer should be used.
6002  */
6003 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
6004                                         const u8 *ids, int n_ids, size_t offset)
6005 {
6006         return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
6007 }
6008
6009 /**
6010  * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
6011  * @wdev: the wireless device reporting the wakeup
6012  * @wakeup: the wakeup report
6013  * @gfp: allocation flags
6014  *
6015  * This function reports that the given device woke up. If it
6016  * caused the wakeup, report the reason(s), otherwise you may
6017  * pass %NULL as the @wakeup parameter to advertise that something
6018  * else caused the wakeup.
6019  */
6020 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
6021                                    struct cfg80211_wowlan_wakeup *wakeup,
6022                                    gfp_t gfp);
6023
6024 /**
6025  * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
6026  *
6027  * @wdev: the wireless device for which critical protocol is stopped.
6028  * @gfp: allocation flags
6029  *
6030  * This function can be called by the driver to indicate it has reverted
6031  * operation back to normal. One reason could be that the duration given
6032  * by .crit_proto_start() has expired.
6033  */
6034 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
6035
6036 /**
6037  * ieee80211_get_num_supported_channels - get number of channels device has
6038  * @wiphy: the wiphy
6039  *
6040  * Return: the number of channels supported by the device.
6041  */
6042 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
6043
6044 /**
6045  * cfg80211_check_combinations - check interface combinations
6046  *
6047  * @wiphy: the wiphy
6048  * @params: the interface combinations parameter
6049  *
6050  * This function can be called by the driver to check whether a
6051  * combination of interfaces and their types are allowed according to
6052  * the interface combinations.
6053  */
6054 int cfg80211_check_combinations(struct wiphy *wiphy,
6055                                 struct iface_combination_params *params);
6056
6057 /**
6058  * cfg80211_iter_combinations - iterate over matching combinations
6059  *
6060  * @wiphy: the wiphy
6061  * @params: the interface combinations parameter
6062  * @iter: function to call for each matching combination
6063  * @data: pointer to pass to iter function
6064  *
6065  * This function can be called by the driver to check what possible
6066  * combinations it fits in at a given moment, e.g. for channel switching
6067  * purposes.
6068  */
6069 int cfg80211_iter_combinations(struct wiphy *wiphy,
6070                                struct iface_combination_params *params,
6071                                void (*iter)(const struct ieee80211_iface_combination *c,
6072                                             void *data),
6073                                void *data);
6074
6075 /*
6076  * cfg80211_stop_iface - trigger interface disconnection
6077  *
6078  * @wiphy: the wiphy
6079  * @wdev: wireless device
6080  * @gfp: context flags
6081  *
6082  * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
6083  * disconnected.
6084  *
6085  * Note: This doesn't need any locks and is asynchronous.
6086  */
6087 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
6088                          gfp_t gfp);
6089
6090 /**
6091  * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
6092  * @wiphy: the wiphy to shut down
6093  *
6094  * This function shuts down all interfaces belonging to this wiphy by
6095  * calling dev_close() (and treating non-netdev interfaces as needed).
6096  * It shouldn't really be used unless there are some fatal device errors
6097  * that really can't be recovered in any other way.
6098  *
6099  * Callers must hold the RTNL and be able to deal with callbacks into
6100  * the driver while the function is running.
6101  */
6102 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
6103
6104 /**
6105  * wiphy_ext_feature_set - set the extended feature flag
6106  *
6107  * @wiphy: the wiphy to modify.
6108  * @ftidx: extended feature bit index.
6109  *
6110  * The extended features are flagged in multiple bytes (see
6111  * &struct wiphy.@ext_features)
6112  */
6113 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
6114                                          enum nl80211_ext_feature_index ftidx)
6115 {
6116         u8 *ft_byte;
6117
6118         ft_byte = &wiphy->ext_features[ftidx / 8];
6119         *ft_byte |= BIT(ftidx % 8);
6120 }
6121
6122 /**
6123  * wiphy_ext_feature_isset - check the extended feature flag
6124  *
6125  * @wiphy: the wiphy to modify.
6126  * @ftidx: extended feature bit index.
6127  *
6128  * The extended features are flagged in multiple bytes (see
6129  * &struct wiphy.@ext_features)
6130  */
6131 static inline bool
6132 wiphy_ext_feature_isset(struct wiphy *wiphy,
6133                         enum nl80211_ext_feature_index ftidx)
6134 {
6135         u8 ft_byte;
6136
6137         ft_byte = wiphy->ext_features[ftidx / 8];
6138         return (ft_byte & BIT(ftidx % 8)) != 0;
6139 }
6140
6141 /**
6142  * cfg80211_free_nan_func - free NAN function
6143  * @f: NAN function that should be freed
6144  *
6145  * Frees all the NAN function and all it's allocated members.
6146  */
6147 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
6148
6149 /**
6150  * struct cfg80211_nan_match_params - NAN match parameters
6151  * @type: the type of the function that triggered a match. If it is
6152  *       %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
6153  *       If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
6154  *       result.
6155  *       If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
6156  * @inst_id: the local instance id
6157  * @peer_inst_id: the instance id of the peer's function
6158  * @addr: the MAC address of the peer
6159  * @info_len: the length of the &info
6160  * @info: the Service Specific Info from the peer (if any)
6161  * @cookie: unique identifier of the corresponding function
6162  */
6163 struct cfg80211_nan_match_params {
6164         enum nl80211_nan_function_type type;
6165         u8 inst_id;
6166         u8 peer_inst_id;
6167         const u8 *addr;
6168         u8 info_len;
6169         const u8 *info;
6170         u64 cookie;
6171 };
6172
6173 /**
6174  * cfg80211_nan_match - report a match for a NAN function.
6175  * @wdev: the wireless device reporting the match
6176  * @match: match notification parameters
6177  * @gfp: allocation flags
6178  *
6179  * This function reports that the a NAN function had a match. This
6180  * can be a subscribe that had a match or a solicited publish that
6181  * was sent. It can also be a follow up that was received.
6182  */
6183 void cfg80211_nan_match(struct wireless_dev *wdev,
6184                         struct cfg80211_nan_match_params *match, gfp_t gfp);
6185
6186 /**
6187  * cfg80211_nan_func_terminated - notify about NAN function termination.
6188  *
6189  * @wdev: the wireless device reporting the match
6190  * @inst_id: the local instance id
6191  * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
6192  * @cookie: unique NAN function identifier
6193  * @gfp: allocation flags
6194  *
6195  * This function reports that the a NAN function is terminated.
6196  */
6197 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
6198                                   u8 inst_id,
6199                                   enum nl80211_nan_func_term_reason reason,
6200                                   u64 cookie, gfp_t gfp);
6201
6202 /* ethtool helper */
6203 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
6204
6205 /* Logging, debugging and troubleshooting/diagnostic helpers. */
6206
6207 /* wiphy_printk helpers, similar to dev_printk */
6208
6209 #define wiphy_printk(level, wiphy, format, args...)             \
6210         dev_printk(level, &(wiphy)->dev, format, ##args)
6211 #define wiphy_emerg(wiphy, format, args...)                     \
6212         dev_emerg(&(wiphy)->dev, format, ##args)
6213 #define wiphy_alert(wiphy, format, args...)                     \
6214         dev_alert(&(wiphy)->dev, format, ##args)
6215 #define wiphy_crit(wiphy, format, args...)                      \
6216         dev_crit(&(wiphy)->dev, format, ##args)
6217 #define wiphy_err(wiphy, format, args...)                       \
6218         dev_err(&(wiphy)->dev, format, ##args)
6219 #define wiphy_warn(wiphy, format, args...)                      \
6220         dev_warn(&(wiphy)->dev, format, ##args)
6221 #define wiphy_notice(wiphy, format, args...)                    \
6222         dev_notice(&(wiphy)->dev, format, ##args)
6223 #define wiphy_info(wiphy, format, args...)                      \
6224         dev_info(&(wiphy)->dev, format, ##args)
6225
6226 #define wiphy_debug(wiphy, format, args...)                     \
6227         wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
6228
6229 #define wiphy_dbg(wiphy, format, args...)                       \
6230         dev_dbg(&(wiphy)->dev, format, ##args)
6231
6232 #if defined(VERBOSE_DEBUG)
6233 #define wiphy_vdbg      wiphy_dbg
6234 #else
6235 #define wiphy_vdbg(wiphy, format, args...)                              \
6236 ({                                                                      \
6237         if (0)                                                          \
6238                 wiphy_printk(KERN_DEBUG, wiphy, format, ##args);        \
6239         0;                                                              \
6240 })
6241 #endif
6242
6243 /*
6244  * wiphy_WARN() acts like wiphy_printk(), but with the key difference
6245  * of using a WARN/WARN_ON to get the message out, including the
6246  * file/line information and a backtrace.
6247  */
6248 #define wiphy_WARN(wiphy, format, args...)                      \
6249         WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
6250
6251 #endif /* __NET_CFG80211_H */