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