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