Merge branch 'linaro-fixes/android-3.10' into linaro-android-3.10-lsk
[firefly-linux-kernel-4.4.55.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  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11  */
12
13 #include <linux/netdevice.h>
14 #include <linux/debugfs.h>
15 #include <linux/list.h>
16 #include <linux/bug.h>
17 #include <linux/netlink.h>
18 #include <linux/skbuff.h>
19 #include <linux/nl80211.h>
20 #include <linux/if_ether.h>
21 #include <linux/ieee80211.h>
22 #include <linux/net.h>
23 #include <net/regulatory.h>
24
25 /**
26  * DOC: Introduction
27  *
28  * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
29  * userspace and drivers, and offers some utility functionality associated
30  * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
31  * by all modern wireless drivers in Linux, so that they offer a consistent
32  * API through nl80211. For backward compatibility, cfg80211 also offers
33  * wireless extensions to userspace, but hides them from drivers completely.
34  *
35  * Additionally, cfg80211 contains code to help enforce regulatory spectrum
36  * use restrictions.
37  */
38
39
40 /**
41  * DOC: Device registration
42  *
43  * In order for a driver to use cfg80211, it must register the hardware device
44  * with cfg80211. This happens through a number of hardware capability structs
45  * described below.
46  *
47  * The fundamental structure for each device is the 'wiphy', of which each
48  * instance describes a physical wireless device connected to the system. Each
49  * such wiphy can have zero, one, or many virtual interfaces associated with
50  * it, which need to be identified as such by pointing the network interface's
51  * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
52  * the wireless part of the interface, normally this struct is embedded in the
53  * network interface's private data area. Drivers can optionally allow creating
54  * or destroying virtual interfaces on the fly, but without at least one or the
55  * ability to create some the wireless device isn't useful.
56  *
57  * Each wiphy structure contains device capability information, and also has
58  * a pointer to the various operations the driver offers. The definitions and
59  * structures here describe these capabilities in detail.
60  */
61
62 struct wiphy;
63
64 /*
65  * wireless hardware capability structures
66  */
67
68 /**
69  * enum ieee80211_band - supported frequency bands
70  *
71  * The bands are assigned this way because the supported
72  * bitrates differ in these bands.
73  *
74  * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
75  * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
76  * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
77  * @IEEE80211_NUM_BANDS: number of defined bands
78  */
79 enum ieee80211_band {
80         IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
81         IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
82         IEEE80211_BAND_60GHZ = NL80211_BAND_60GHZ,
83
84         /* keep last */
85         IEEE80211_NUM_BANDS
86 };
87
88 /**
89  * enum ieee80211_channel_flags - channel flags
90  *
91  * Channel flags set by the regulatory control code.
92  *
93  * @IEEE80211_CHAN_DISABLED: This channel is disabled.
94  * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
95  *      on this channel.
96  * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
97  * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
98  * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
99  *      is not permitted.
100  * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
101  *      is not permitted.
102  * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
103  * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
104  *      this flag indicates that an 80 MHz channel cannot use this
105  *      channel as the control or any of the secondary channels.
106  *      This may be due to the driver or due to regulatory bandwidth
107  *      restrictions.
108  * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
109  *      this flag indicates that an 160 MHz channel cannot use this
110  *      channel as the control or any of the secondary channels.
111  *      This may be due to the driver or due to regulatory bandwidth
112  *      restrictions.
113  */
114 enum ieee80211_channel_flags {
115         IEEE80211_CHAN_DISABLED         = 1<<0,
116         IEEE80211_CHAN_PASSIVE_SCAN     = 1<<1,
117         IEEE80211_CHAN_NO_IBSS          = 1<<2,
118         IEEE80211_CHAN_RADAR            = 1<<3,
119         IEEE80211_CHAN_NO_HT40PLUS      = 1<<4,
120         IEEE80211_CHAN_NO_HT40MINUS     = 1<<5,
121         IEEE80211_CHAN_NO_OFDM          = 1<<6,
122         IEEE80211_CHAN_NO_80MHZ         = 1<<7,
123         IEEE80211_CHAN_NO_160MHZ        = 1<<8,
124 };
125
126 #define IEEE80211_CHAN_NO_HT40 \
127         (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
128
129 #define IEEE80211_DFS_MIN_CAC_TIME_MS           60000
130 #define IEEE80211_DFS_MIN_NOP_TIME_MS           (30 * 60 * 1000)
131
132 /**
133  * struct ieee80211_channel - channel definition
134  *
135  * This structure describes a single channel for use
136  * with cfg80211.
137  *
138  * @center_freq: center frequency in MHz
139  * @hw_value: hardware-specific value for the channel
140  * @flags: channel flags from &enum ieee80211_channel_flags.
141  * @orig_flags: channel flags at registration time, used by regulatory
142  *      code to support devices with additional restrictions
143  * @band: band this channel belongs to.
144  * @max_antenna_gain: maximum antenna gain in dBi
145  * @max_power: maximum transmission power (in dBm)
146  * @max_reg_power: maximum regulatory transmission power (in dBm)
147  * @beacon_found: helper to regulatory code to indicate when a beacon
148  *      has been found on this channel. Use regulatory_hint_found_beacon()
149  *      to enable this, this is useful only on 5 GHz band.
150  * @orig_mag: internal use
151  * @orig_mpwr: internal use
152  * @dfs_state: current state of this channel. Only relevant if radar is required
153  *      on this channel.
154  * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
155  */
156 struct ieee80211_channel {
157         enum ieee80211_band band;
158         u16 center_freq;
159         u16 hw_value;
160         u32 flags;
161         int max_antenna_gain;
162         int max_power;
163         int max_reg_power;
164         bool beacon_found;
165         u32 orig_flags;
166         int orig_mag, orig_mpwr;
167         enum nl80211_dfs_state dfs_state;
168         unsigned long dfs_state_entered;
169 };
170
171 /**
172  * enum ieee80211_rate_flags - rate flags
173  *
174  * Hardware/specification flags for rates. These are structured
175  * in a way that allows using the same bitrate structure for
176  * different bands/PHY modes.
177  *
178  * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
179  *      preamble on this bitrate; only relevant in 2.4GHz band and
180  *      with CCK rates.
181  * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
182  *      when used with 802.11a (on the 5 GHz band); filled by the
183  *      core code when registering the wiphy.
184  * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
185  *      when used with 802.11b (on the 2.4 GHz band); filled by the
186  *      core code when registering the wiphy.
187  * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
188  *      when used with 802.11g (on the 2.4 GHz band); filled by the
189  *      core code when registering the wiphy.
190  * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
191  */
192 enum ieee80211_rate_flags {
193         IEEE80211_RATE_SHORT_PREAMBLE   = 1<<0,
194         IEEE80211_RATE_MANDATORY_A      = 1<<1,
195         IEEE80211_RATE_MANDATORY_B      = 1<<2,
196         IEEE80211_RATE_MANDATORY_G      = 1<<3,
197         IEEE80211_RATE_ERP_G            = 1<<4,
198 };
199
200 /**
201  * struct ieee80211_rate - bitrate definition
202  *
203  * This structure describes a bitrate that an 802.11 PHY can
204  * operate with. The two values @hw_value and @hw_value_short
205  * are only for driver use when pointers to this structure are
206  * passed around.
207  *
208  * @flags: rate-specific flags
209  * @bitrate: bitrate in units of 100 Kbps
210  * @hw_value: driver/hardware value for this rate
211  * @hw_value_short: driver/hardware value for this rate when
212  *      short preamble is used
213  */
214 struct ieee80211_rate {
215         u32 flags;
216         u16 bitrate;
217         u16 hw_value, hw_value_short;
218 };
219
220 /**
221  * struct ieee80211_sta_ht_cap - STA's HT capabilities
222  *
223  * This structure describes most essential parameters needed
224  * to describe 802.11n HT capabilities for an STA.
225  *
226  * @ht_supported: is HT supported by the STA
227  * @cap: HT capabilities map as described in 802.11n spec
228  * @ampdu_factor: Maximum A-MPDU length factor
229  * @ampdu_density: Minimum A-MPDU spacing
230  * @mcs: Supported MCS rates
231  */
232 struct ieee80211_sta_ht_cap {
233         u16 cap; /* use IEEE80211_HT_CAP_ */
234         bool ht_supported;
235         u8 ampdu_factor;
236         u8 ampdu_density;
237         struct ieee80211_mcs_info mcs;
238 };
239
240 /**
241  * struct ieee80211_sta_vht_cap - STA's VHT capabilities
242  *
243  * This structure describes most essential parameters needed
244  * to describe 802.11ac VHT capabilities for an STA.
245  *
246  * @vht_supported: is VHT supported by the STA
247  * @cap: VHT capabilities map as described in 802.11ac spec
248  * @vht_mcs: Supported VHT MCS rates
249  */
250 struct ieee80211_sta_vht_cap {
251         bool vht_supported;
252         u32 cap; /* use IEEE80211_VHT_CAP_ */
253         struct ieee80211_vht_mcs_info vht_mcs;
254 };
255
256 /**
257  * struct ieee80211_supported_band - frequency band definition
258  *
259  * This structure describes a frequency band a wiphy
260  * is able to operate in.
261  *
262  * @channels: Array of channels the hardware can operate in
263  *      in this band.
264  * @band: the band this structure represents
265  * @n_channels: Number of channels in @channels
266  * @bitrates: Array of bitrates the hardware can operate with
267  *      in this band. Must be sorted to give a valid "supported
268  *      rates" IE, i.e. CCK rates first, then OFDM.
269  * @n_bitrates: Number of bitrates in @bitrates
270  * @ht_cap: HT capabilities in this band
271  * @vht_cap: VHT capabilities in this band
272  */
273 struct ieee80211_supported_band {
274         struct ieee80211_channel *channels;
275         struct ieee80211_rate *bitrates;
276         enum ieee80211_band band;
277         int n_channels;
278         int n_bitrates;
279         struct ieee80211_sta_ht_cap ht_cap;
280         struct ieee80211_sta_vht_cap vht_cap;
281 };
282
283 /*
284  * Wireless hardware/device configuration structures and methods
285  */
286
287 /**
288  * DOC: Actions and configuration
289  *
290  * Each wireless device and each virtual interface offer a set of configuration
291  * operations and other actions that are invoked by userspace. Each of these
292  * actions is described in the operations structure, and the parameters these
293  * operations use are described separately.
294  *
295  * Additionally, some operations are asynchronous and expect to get status
296  * information via some functions that drivers need to call.
297  *
298  * Scanning and BSS list handling with its associated functionality is described
299  * in a separate chapter.
300  */
301
302 /**
303  * struct vif_params - describes virtual interface parameters
304  * @use_4addr: use 4-address frames
305  * @macaddr: address to use for this virtual interface. This will only
306  *      be used for non-netdevice interfaces. If this parameter is set
307  *      to zero address the driver may determine the address as needed.
308  */
309 struct vif_params {
310        int use_4addr;
311        u8 macaddr[ETH_ALEN];
312 };
313
314 /**
315  * struct key_params - key information
316  *
317  * Information about a key
318  *
319  * @key: key material
320  * @key_len: length of key material
321  * @cipher: cipher suite selector
322  * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
323  *      with the get_key() callback, must be in little endian,
324  *      length given by @seq_len.
325  * @seq_len: length of @seq.
326  */
327 struct key_params {
328         u8 *key;
329         u8 *seq;
330         int key_len;
331         int seq_len;
332         u32 cipher;
333 };
334
335 /**
336  * struct cfg80211_chan_def - channel definition
337  * @chan: the (control) channel
338  * @width: channel width
339  * @center_freq1: center frequency of first segment
340  * @center_freq2: center frequency of second segment
341  *      (only with 80+80 MHz)
342  */
343 struct cfg80211_chan_def {
344         struct ieee80211_channel *chan;
345         enum nl80211_chan_width width;
346         u32 center_freq1;
347         u32 center_freq2;
348 };
349
350 /**
351  * cfg80211_get_chandef_type - return old channel type from chandef
352  * @chandef: the channel definition
353  *
354  * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
355  * chandef, which must have a bandwidth allowing this conversion.
356  */
357 static inline enum nl80211_channel_type
358 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
359 {
360         switch (chandef->width) {
361         case NL80211_CHAN_WIDTH_20_NOHT:
362                 return NL80211_CHAN_NO_HT;
363         case NL80211_CHAN_WIDTH_20:
364                 return NL80211_CHAN_HT20;
365         case NL80211_CHAN_WIDTH_40:
366                 if (chandef->center_freq1 > chandef->chan->center_freq)
367                         return NL80211_CHAN_HT40PLUS;
368                 return NL80211_CHAN_HT40MINUS;
369         default:
370                 WARN_ON(1);
371                 return NL80211_CHAN_NO_HT;
372         }
373 }
374
375 /**
376  * cfg80211_chandef_create - create channel definition using channel type
377  * @chandef: the channel definition struct to fill
378  * @channel: the control channel
379  * @chantype: the channel type
380  *
381  * Given a channel type, create a channel definition.
382  */
383 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
384                              struct ieee80211_channel *channel,
385                              enum nl80211_channel_type chantype);
386
387 /**
388  * cfg80211_chandef_identical - check if two channel definitions are identical
389  * @chandef1: first channel definition
390  * @chandef2: second channel definition
391  *
392  * Return: %true if the channels defined by the channel definitions are
393  * identical, %false otherwise.
394  */
395 static inline bool
396 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
397                            const struct cfg80211_chan_def *chandef2)
398 {
399         return (chandef1->chan == chandef2->chan &&
400                 chandef1->width == chandef2->width &&
401                 chandef1->center_freq1 == chandef2->center_freq1 &&
402                 chandef1->center_freq2 == chandef2->center_freq2);
403 }
404
405 /**
406  * cfg80211_chandef_compatible - check if two channel definitions are compatible
407  * @chandef1: first channel definition
408  * @chandef2: second channel definition
409  *
410  * Return: %NULL if the given channel definitions are incompatible,
411  * chandef1 or chandef2 otherwise.
412  */
413 const struct cfg80211_chan_def *
414 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
415                             const struct cfg80211_chan_def *chandef2);
416
417 /**
418  * cfg80211_chandef_valid - check if a channel definition is valid
419  * @chandef: the channel definition to check
420  * Return: %true if the channel definition is valid. %false otherwise.
421  */
422 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
423
424 /**
425  * cfg80211_chandef_usable - check if secondary channels can be used
426  * @wiphy: the wiphy to validate against
427  * @chandef: the channel definition to check
428  * @prohibited_flags: the regulatory channel flags that must not be set
429  * Return: %true if secondary channels are usable. %false otherwise.
430  */
431 bool cfg80211_chandef_usable(struct wiphy *wiphy,
432                              const struct cfg80211_chan_def *chandef,
433                              u32 prohibited_flags);
434
435 /**
436  * enum survey_info_flags - survey information flags
437  *
438  * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
439  * @SURVEY_INFO_IN_USE: channel is currently being used
440  * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
441  * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
442  * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
443  * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
444  * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
445  *
446  * Used by the driver to indicate which info in &struct survey_info
447  * it has filled in during the get_survey().
448  */
449 enum survey_info_flags {
450         SURVEY_INFO_NOISE_DBM = 1<<0,
451         SURVEY_INFO_IN_USE = 1<<1,
452         SURVEY_INFO_CHANNEL_TIME = 1<<2,
453         SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
454         SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
455         SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
456         SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
457 };
458
459 /**
460  * struct survey_info - channel survey response
461  *
462  * @channel: the channel this survey record reports, mandatory
463  * @filled: bitflag of flags from &enum survey_info_flags
464  * @noise: channel noise in dBm. This and all following fields are
465  *     optional
466  * @channel_time: amount of time in ms the radio spent on the channel
467  * @channel_time_busy: amount of time the primary channel was sensed busy
468  * @channel_time_ext_busy: amount of time the extension channel was sensed busy
469  * @channel_time_rx: amount of time the radio spent receiving data
470  * @channel_time_tx: amount of time the radio spent transmitting data
471  *
472  * Used by dump_survey() to report back per-channel survey information.
473  *
474  * This structure can later be expanded with things like
475  * channel duty cycle etc.
476  */
477 struct survey_info {
478         struct ieee80211_channel *channel;
479         u64 channel_time;
480         u64 channel_time_busy;
481         u64 channel_time_ext_busy;
482         u64 channel_time_rx;
483         u64 channel_time_tx;
484         u32 filled;
485         s8 noise;
486 };
487
488 /**
489  * struct cfg80211_crypto_settings - Crypto settings
490  * @wpa_versions: indicates which, if any, WPA versions are enabled
491  *      (from enum nl80211_wpa_versions)
492  * @cipher_group: group key cipher suite (or 0 if unset)
493  * @n_ciphers_pairwise: number of AP supported unicast ciphers
494  * @ciphers_pairwise: unicast key cipher suites
495  * @n_akm_suites: number of AKM suites
496  * @akm_suites: AKM suites
497  * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
498  *      sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
499  *      required to assume that the port is unauthorized until authorized by
500  *      user space. Otherwise, port is marked authorized by default.
501  * @control_port_ethertype: the control port protocol that should be
502  *      allowed through even on unauthorized ports
503  * @control_port_no_encrypt: TRUE to prevent encryption of control port
504  *      protocol frames.
505  */
506 struct cfg80211_crypto_settings {
507         u32 wpa_versions;
508         u32 cipher_group;
509         int n_ciphers_pairwise;
510         u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
511         int n_akm_suites;
512         u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
513         bool control_port;
514         __be16 control_port_ethertype;
515         bool control_port_no_encrypt;
516 };
517
518 /**
519  * struct cfg80211_beacon_data - beacon data
520  * @head: head portion of beacon (before TIM IE)
521  *     or %NULL if not changed
522  * @tail: tail portion of beacon (after TIM IE)
523  *     or %NULL if not changed
524  * @head_len: length of @head
525  * @tail_len: length of @tail
526  * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
527  * @beacon_ies_len: length of beacon_ies in octets
528  * @proberesp_ies: extra information element(s) to add into Probe Response
529  *      frames or %NULL
530  * @proberesp_ies_len: length of proberesp_ies in octets
531  * @assocresp_ies: extra information element(s) to add into (Re)Association
532  *      Response frames or %NULL
533  * @assocresp_ies_len: length of assocresp_ies in octets
534  * @probe_resp_len: length of probe response template (@probe_resp)
535  * @probe_resp: probe response template (AP mode only)
536  */
537 struct cfg80211_beacon_data {
538         const u8 *head, *tail;
539         const u8 *beacon_ies;
540         const u8 *proberesp_ies;
541         const u8 *assocresp_ies;
542         const u8 *probe_resp;
543
544         size_t head_len, tail_len;
545         size_t beacon_ies_len;
546         size_t proberesp_ies_len;
547         size_t assocresp_ies_len;
548         size_t probe_resp_len;
549 };
550
551 struct mac_address {
552         u8 addr[ETH_ALEN];
553 };
554
555 /**
556  * struct cfg80211_acl_data - Access control list data
557  *
558  * @acl_policy: ACL policy to be applied on the station's
559  *      entry specified by mac_addr
560  * @n_acl_entries: Number of MAC address entries passed
561  * @mac_addrs: List of MAC addresses of stations to be used for ACL
562  */
563 struct cfg80211_acl_data {
564         enum nl80211_acl_policy acl_policy;
565         int n_acl_entries;
566
567         /* Keep it last */
568         struct mac_address mac_addrs[];
569 };
570
571 /**
572  * struct cfg80211_ap_settings - AP configuration
573  *
574  * Used to configure an AP interface.
575  *
576  * @chandef: defines the channel to use
577  * @beacon: beacon data
578  * @beacon_interval: beacon interval
579  * @dtim_period: DTIM period
580  * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
581  *      user space)
582  * @ssid_len: length of @ssid
583  * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
584  * @crypto: crypto settings
585  * @privacy: the BSS uses privacy
586  * @auth_type: Authentication type (algorithm)
587  * @inactivity_timeout: time in seconds to determine station's inactivity.
588  * @p2p_ctwindow: P2P CT Window
589  * @p2p_opp_ps: P2P opportunistic PS
590  * @acl: ACL configuration used by the drivers which has support for
591  *      MAC address based access control
592  * @radar_required: set if radar detection is required
593  */
594 struct cfg80211_ap_settings {
595         struct cfg80211_chan_def chandef;
596
597         struct cfg80211_beacon_data beacon;
598
599         int beacon_interval, dtim_period;
600         const u8 *ssid;
601         size_t ssid_len;
602         enum nl80211_hidden_ssid hidden_ssid;
603         struct cfg80211_crypto_settings crypto;
604         bool privacy;
605         enum nl80211_auth_type auth_type;
606         int inactivity_timeout;
607         u8 p2p_ctwindow;
608         bool p2p_opp_ps;
609         const struct cfg80211_acl_data *acl;
610         bool radar_required;
611 };
612
613 /**
614  * enum station_parameters_apply_mask - station parameter values to apply
615  * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
616  * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
617  * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
618  *
619  * Not all station parameters have in-band "no change" signalling,
620  * for those that don't these flags will are used.
621  */
622 enum station_parameters_apply_mask {
623         STATION_PARAM_APPLY_UAPSD = BIT(0),
624         STATION_PARAM_APPLY_CAPABILITY = BIT(1),
625         STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
626 };
627
628 /**
629  * struct station_parameters - station parameters
630  *
631  * Used to change and create a new station.
632  *
633  * @vlan: vlan interface station should belong to
634  * @supported_rates: supported rates in IEEE 802.11 format
635  *      (or NULL for no change)
636  * @supported_rates_len: number of supported rates
637  * @sta_flags_mask: station flags that changed
638  *      (bitmask of BIT(NL80211_STA_FLAG_...))
639  * @sta_flags_set: station flags values
640  *      (bitmask of BIT(NL80211_STA_FLAG_...))
641  * @listen_interval: listen interval or -1 for no change
642  * @aid: AID or zero for no change
643  * @plink_action: plink action to take
644  * @plink_state: set the peer link state for a station
645  * @ht_capa: HT capabilities of station
646  * @vht_capa: VHT capabilities of station
647  * @uapsd_queues: bitmap of queues configured for uapsd. same format
648  *      as the AC bitmap in the QoS info field
649  * @max_sp: max Service Period. same format as the MAX_SP in the
650  *      QoS info field (but already shifted down)
651  * @sta_modify_mask: bitmap indicating which parameters changed
652  *      (for those that don't have a natural "no change" value),
653  *      see &enum station_parameters_apply_mask
654  * @local_pm: local link-specific mesh power save mode (no change when set
655  *      to unknown)
656  * @capability: station capability
657  * @ext_capab: extended capabilities of the station
658  * @ext_capab_len: number of extended capabilities
659  */
660 struct station_parameters {
661         const u8 *supported_rates;
662         struct net_device *vlan;
663         u32 sta_flags_mask, sta_flags_set;
664         u32 sta_modify_mask;
665         int listen_interval;
666         u16 aid;
667         u8 supported_rates_len;
668         u8 plink_action;
669         u8 plink_state;
670         const struct ieee80211_ht_cap *ht_capa;
671         const struct ieee80211_vht_cap *vht_capa;
672         u8 uapsd_queues;
673         u8 max_sp;
674         enum nl80211_mesh_power_mode local_pm;
675         u16 capability;
676         const u8 *ext_capab;
677         u8 ext_capab_len;
678 };
679
680 /**
681  * enum cfg80211_station_type - the type of station being modified
682  * @CFG80211_STA_AP_CLIENT: client of an AP interface
683  * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
684  *      the AP MLME in the device
685  * @CFG80211_STA_AP_STA: AP station on managed interface
686  * @CFG80211_STA_IBSS: IBSS station
687  * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
688  *      while TDLS setup is in progress, it moves out of this state when
689  *      being marked authorized; use this only if TDLS with external setup is
690  *      supported/used)
691  * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
692  *      entry that is operating, has been marked authorized by userspace)
693  * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
694  * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
695  */
696 enum cfg80211_station_type {
697         CFG80211_STA_AP_CLIENT,
698         CFG80211_STA_AP_MLME_CLIENT,
699         CFG80211_STA_AP_STA,
700         CFG80211_STA_IBSS,
701         CFG80211_STA_TDLS_PEER_SETUP,
702         CFG80211_STA_TDLS_PEER_ACTIVE,
703         CFG80211_STA_MESH_PEER_KERNEL,
704         CFG80211_STA_MESH_PEER_USER,
705 };
706
707 /**
708  * cfg80211_check_station_change - validate parameter changes
709  * @wiphy: the wiphy this operates on
710  * @params: the new parameters for a station
711  * @statype: the type of station being modified
712  *
713  * Utility function for the @change_station driver method. Call this function
714  * with the appropriate station type looking up the station (and checking that
715  * it exists). It will verify whether the station change is acceptable, and if
716  * not will return an error code. Note that it may modify the parameters for
717  * backward compatibility reasons, so don't use them before calling this.
718  */
719 int cfg80211_check_station_change(struct wiphy *wiphy,
720                                   struct station_parameters *params,
721                                   enum cfg80211_station_type statype);
722
723 /**
724  * enum station_info_flags - station information flags
725  *
726  * Used by the driver to indicate which info in &struct station_info
727  * it has filled in during get_station() or dump_station().
728  *
729  * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
730  * @STATION_INFO_RX_BYTES: @rx_bytes filled
731  * @STATION_INFO_TX_BYTES: @tx_bytes filled
732  * @STATION_INFO_RX_BYTES64: @rx_bytes filled with 64-bit value
733  * @STATION_INFO_TX_BYTES64: @tx_bytes filled with 64-bit value
734  * @STATION_INFO_LLID: @llid filled
735  * @STATION_INFO_PLID: @plid filled
736  * @STATION_INFO_PLINK_STATE: @plink_state filled
737  * @STATION_INFO_SIGNAL: @signal filled
738  * @STATION_INFO_TX_BITRATE: @txrate fields are filled
739  *  (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
740  * @STATION_INFO_RX_PACKETS: @rx_packets filled with 32-bit value
741  * @STATION_INFO_TX_PACKETS: @tx_packets filled with 32-bit value
742  * @STATION_INFO_TX_RETRIES: @tx_retries filled
743  * @STATION_INFO_TX_FAILED: @tx_failed filled
744  * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
745  * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
746  * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
747  * @STATION_INFO_BSS_PARAM: @bss_param filled
748  * @STATION_INFO_CONNECTED_TIME: @connected_time filled
749  * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
750  * @STATION_INFO_STA_FLAGS: @sta_flags filled
751  * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
752  * @STATION_INFO_T_OFFSET: @t_offset filled
753  * @STATION_INFO_LOCAL_PM: @local_pm filled
754  * @STATION_INFO_PEER_PM: @peer_pm filled
755  * @STATION_INFO_NONPEER_PM: @nonpeer_pm filled
756  */
757 enum station_info_flags {
758         STATION_INFO_INACTIVE_TIME      = 1<<0,
759         STATION_INFO_RX_BYTES           = 1<<1,
760         STATION_INFO_TX_BYTES           = 1<<2,
761         STATION_INFO_LLID               = 1<<3,
762         STATION_INFO_PLID               = 1<<4,
763         STATION_INFO_PLINK_STATE        = 1<<5,
764         STATION_INFO_SIGNAL             = 1<<6,
765         STATION_INFO_TX_BITRATE         = 1<<7,
766         STATION_INFO_RX_PACKETS         = 1<<8,
767         STATION_INFO_TX_PACKETS         = 1<<9,
768         STATION_INFO_TX_RETRIES         = 1<<10,
769         STATION_INFO_TX_FAILED          = 1<<11,
770         STATION_INFO_RX_DROP_MISC       = 1<<12,
771         STATION_INFO_SIGNAL_AVG         = 1<<13,
772         STATION_INFO_RX_BITRATE         = 1<<14,
773         STATION_INFO_BSS_PARAM          = 1<<15,
774         STATION_INFO_CONNECTED_TIME     = 1<<16,
775         STATION_INFO_ASSOC_REQ_IES      = 1<<17,
776         STATION_INFO_STA_FLAGS          = 1<<18,
777         STATION_INFO_BEACON_LOSS_COUNT  = 1<<19,
778         STATION_INFO_T_OFFSET           = 1<<20,
779         STATION_INFO_LOCAL_PM           = 1<<21,
780         STATION_INFO_PEER_PM            = 1<<22,
781         STATION_INFO_NONPEER_PM         = 1<<23,
782         STATION_INFO_RX_BYTES64         = 1<<24,
783         STATION_INFO_TX_BYTES64         = 1<<25,
784 };
785
786 /**
787  * enum station_info_rate_flags - bitrate info flags
788  *
789  * Used by the driver to indicate the specific rate transmission
790  * type for 802.11n transmissions.
791  *
792  * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
793  * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
794  * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 MHz width transmission
795  * @RATE_INFO_FLAGS_80_MHZ_WIDTH: 80 MHz width transmission
796  * @RATE_INFO_FLAGS_80P80_MHZ_WIDTH: 80+80 MHz width transmission
797  * @RATE_INFO_FLAGS_160_MHZ_WIDTH: 160 MHz width transmission
798  * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
799  * @RATE_INFO_FLAGS_60G: 60GHz MCS
800  */
801 enum rate_info_flags {
802         RATE_INFO_FLAGS_MCS                     = BIT(0),
803         RATE_INFO_FLAGS_VHT_MCS                 = BIT(1),
804         RATE_INFO_FLAGS_40_MHZ_WIDTH            = BIT(2),
805         RATE_INFO_FLAGS_80_MHZ_WIDTH            = BIT(3),
806         RATE_INFO_FLAGS_80P80_MHZ_WIDTH         = BIT(4),
807         RATE_INFO_FLAGS_160_MHZ_WIDTH           = BIT(5),
808         RATE_INFO_FLAGS_SHORT_GI                = BIT(6),
809         RATE_INFO_FLAGS_60G                     = BIT(7),
810 };
811
812 /**
813  * struct rate_info - bitrate information
814  *
815  * Information about a receiving or transmitting bitrate
816  *
817  * @flags: bitflag of flags from &enum rate_info_flags
818  * @mcs: mcs index if struct describes a 802.11n bitrate
819  * @legacy: bitrate in 100kbit/s for 802.11abg
820  * @nss: number of streams (VHT only)
821  */
822 struct rate_info {
823         u8 flags;
824         u8 mcs;
825         u16 legacy;
826         u8 nss;
827 };
828
829 /**
830  * enum station_info_rate_flags - bitrate info flags
831  *
832  * Used by the driver to indicate the specific rate transmission
833  * type for 802.11n transmissions.
834  *
835  * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
836  * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
837  * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
838  */
839 enum bss_param_flags {
840         BSS_PARAM_FLAGS_CTS_PROT        = 1<<0,
841         BSS_PARAM_FLAGS_SHORT_PREAMBLE  = 1<<1,
842         BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
843 };
844
845 /**
846  * struct sta_bss_parameters - BSS parameters for the attached station
847  *
848  * Information about the currently associated BSS
849  *
850  * @flags: bitflag of flags from &enum bss_param_flags
851  * @dtim_period: DTIM period for the BSS
852  * @beacon_interval: beacon interval
853  */
854 struct sta_bss_parameters {
855         u8 flags;
856         u8 dtim_period;
857         u16 beacon_interval;
858 };
859
860 /**
861  * struct station_info - station information
862  *
863  * Station information filled by driver for get_station() and dump_station.
864  *
865  * @filled: bitflag of flags from &enum station_info_flags
866  * @connected_time: time(in secs) since a station is last connected
867  * @inactive_time: time since last station activity (tx/rx) in milliseconds
868  * @rx_bytes: bytes received from this station
869  * @tx_bytes: bytes transmitted to this station
870  * @llid: mesh local link id
871  * @plid: mesh peer link id
872  * @plink_state: mesh peer link state
873  * @signal: The signal strength, type depends on the wiphy's signal_type.
874  *      For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
875  * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
876  *      For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
877  * @txrate: current unicast bitrate from this station
878  * @rxrate: current unicast bitrate to this station
879  * @rx_packets: packets received from this station
880  * @tx_packets: packets transmitted to this station
881  * @tx_retries: cumulative retry counts
882  * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
883  * @rx_dropped_misc:  Dropped for un-specified reason.
884  * @bss_param: current BSS parameters
885  * @generation: generation number for nl80211 dumps.
886  *      This number should increase every time the list of stations
887  *      changes, i.e. when a station is added or removed, so that
888  *      userspace can tell whether it got a consistent snapshot.
889  * @assoc_req_ies: IEs from (Re)Association Request.
890  *      This is used only when in AP mode with drivers that do not use
891  *      user space MLME/SME implementation. The information is provided for
892  *      the cfg80211_new_sta() calls to notify user space of the IEs.
893  * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
894  * @sta_flags: station flags mask & values
895  * @beacon_loss_count: Number of times beacon loss event has triggered.
896  * @t_offset: Time offset of the station relative to this host.
897  * @local_pm: local mesh STA power save mode
898  * @peer_pm: peer mesh STA power save mode
899  * @nonpeer_pm: non-peer mesh STA power save mode
900  */
901 struct station_info {
902         u32 filled;
903         u32 connected_time;
904         u32 inactive_time;
905         u64 rx_bytes;
906         u64 tx_bytes;
907         u16 llid;
908         u16 plid;
909         u8 plink_state;
910         s8 signal;
911         s8 signal_avg;
912         struct rate_info txrate;
913         struct rate_info rxrate;
914         u32 rx_packets;
915         u32 tx_packets;
916         u32 tx_retries;
917         u32 tx_failed;
918         u32 rx_dropped_misc;
919         struct sta_bss_parameters bss_param;
920         struct nl80211_sta_flag_update sta_flags;
921
922         int generation;
923
924         const u8 *assoc_req_ies;
925         size_t assoc_req_ies_len;
926
927         u32 beacon_loss_count;
928         s64 t_offset;
929         enum nl80211_mesh_power_mode local_pm;
930         enum nl80211_mesh_power_mode peer_pm;
931         enum nl80211_mesh_power_mode nonpeer_pm;
932
933         /*
934          * Note: Add a new enum station_info_flags value for each new field and
935          * use it to check which fields are initialized.
936          */
937 };
938
939 /**
940  * enum monitor_flags - monitor flags
941  *
942  * Monitor interface configuration flags. Note that these must be the bits
943  * according to the nl80211 flags.
944  *
945  * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
946  * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
947  * @MONITOR_FLAG_CONTROL: pass control frames
948  * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
949  * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
950  */
951 enum monitor_flags {
952         MONITOR_FLAG_FCSFAIL            = 1<<NL80211_MNTR_FLAG_FCSFAIL,
953         MONITOR_FLAG_PLCPFAIL           = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
954         MONITOR_FLAG_CONTROL            = 1<<NL80211_MNTR_FLAG_CONTROL,
955         MONITOR_FLAG_OTHER_BSS          = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
956         MONITOR_FLAG_COOK_FRAMES        = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
957 };
958
959 /**
960  * enum mpath_info_flags -  mesh path information flags
961  *
962  * Used by the driver to indicate which info in &struct mpath_info it has filled
963  * in during get_station() or dump_station().
964  *
965  * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
966  * @MPATH_INFO_SN: @sn filled
967  * @MPATH_INFO_METRIC: @metric filled
968  * @MPATH_INFO_EXPTIME: @exptime filled
969  * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
970  * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
971  * @MPATH_INFO_FLAGS: @flags filled
972  */
973 enum mpath_info_flags {
974         MPATH_INFO_FRAME_QLEN           = BIT(0),
975         MPATH_INFO_SN                   = BIT(1),
976         MPATH_INFO_METRIC               = BIT(2),
977         MPATH_INFO_EXPTIME              = BIT(3),
978         MPATH_INFO_DISCOVERY_TIMEOUT    = BIT(4),
979         MPATH_INFO_DISCOVERY_RETRIES    = BIT(5),
980         MPATH_INFO_FLAGS                = BIT(6),
981 };
982
983 /**
984  * struct mpath_info - mesh path information
985  *
986  * Mesh path information filled by driver for get_mpath() and dump_mpath().
987  *
988  * @filled: bitfield of flags from &enum mpath_info_flags
989  * @frame_qlen: number of queued frames for this destination
990  * @sn: target sequence number
991  * @metric: metric (cost) of this mesh path
992  * @exptime: expiration time for the mesh path from now, in msecs
993  * @flags: mesh path flags
994  * @discovery_timeout: total mesh path discovery timeout, in msecs
995  * @discovery_retries: mesh path discovery retries
996  * @generation: generation number for nl80211 dumps.
997  *      This number should increase every time the list of mesh paths
998  *      changes, i.e. when a station is added or removed, so that
999  *      userspace can tell whether it got a consistent snapshot.
1000  */
1001 struct mpath_info {
1002         u32 filled;
1003         u32 frame_qlen;
1004         u32 sn;
1005         u32 metric;
1006         u32 exptime;
1007         u32 discovery_timeout;
1008         u8 discovery_retries;
1009         u8 flags;
1010
1011         int generation;
1012 };
1013
1014 /**
1015  * struct bss_parameters - BSS parameters
1016  *
1017  * Used to change BSS parameters (mainly for AP mode).
1018  *
1019  * @use_cts_prot: Whether to use CTS protection
1020  *      (0 = no, 1 = yes, -1 = do not change)
1021  * @use_short_preamble: Whether the use of short preambles is allowed
1022  *      (0 = no, 1 = yes, -1 = do not change)
1023  * @use_short_slot_time: Whether the use of short slot time is allowed
1024  *      (0 = no, 1 = yes, -1 = do not change)
1025  * @basic_rates: basic rates in IEEE 802.11 format
1026  *      (or NULL for no change)
1027  * @basic_rates_len: number of basic rates
1028  * @ap_isolate: do not forward packets between connected stations
1029  * @ht_opmode: HT Operation mode
1030  *      (u16 = opmode, -1 = do not change)
1031  * @p2p_ctwindow: P2P CT Window (-1 = no change)
1032  * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1033  */
1034 struct bss_parameters {
1035         int use_cts_prot;
1036         int use_short_preamble;
1037         int use_short_slot_time;
1038         u8 *basic_rates;
1039         u8 basic_rates_len;
1040         int ap_isolate;
1041         int ht_opmode;
1042         s8 p2p_ctwindow, p2p_opp_ps;
1043 };
1044
1045 /**
1046  * struct mesh_config - 802.11s mesh configuration
1047  *
1048  * These parameters can be changed while the mesh is active.
1049  *
1050  * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1051  *      by the Mesh Peering Open message
1052  * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1053  *      used by the Mesh Peering Open message
1054  * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1055  *      the mesh peering management to close a mesh peering
1056  * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1057  *      mesh interface
1058  * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1059  *      be sent to establish a new peer link instance in a mesh
1060  * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1061  * @element_ttl: the value of TTL field set at a mesh STA for path selection
1062  *      elements
1063  * @auto_open_plinks: whether we should automatically open peer links when we
1064  *      detect compatible mesh peers
1065  * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1066  *      synchronize to for 11s default synchronization method
1067  * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1068  *      that an originator mesh STA can send to a particular path target
1069  * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1070  * @min_discovery_timeout: the minimum length of time to wait until giving up on
1071  *      a path discovery in milliseconds
1072  * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1073  *      receiving a PREQ shall consider the forwarding information from the
1074  *      root to be valid. (TU = time unit)
1075  * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1076  *      which a mesh STA can send only one action frame containing a PREQ
1077  *      element
1078  * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1079  *      which a mesh STA can send only one Action frame containing a PERR
1080  *      element
1081  * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1082  *      it takes for an HWMP information element to propagate across the mesh
1083  * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1084  * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1085  *      announcements are transmitted
1086  * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1087  *      station has access to a broader network beyond the MBSS. (This is
1088  *      missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1089  *      only means that the station will announce others it's a mesh gate, but
1090  *      not necessarily using the gate announcement protocol. Still keeping the
1091  *      same nomenclature to be in sync with the spec)
1092  * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1093  *      entity (default is TRUE - forwarding entity)
1094  * @rssi_threshold: the threshold for average signal strength of candidate
1095  *      station to establish a peer link
1096  * @ht_opmode: mesh HT protection mode
1097  *
1098  * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1099  *      receiving a proactive PREQ shall consider the forwarding information to
1100  *      the root mesh STA to be valid.
1101  *
1102  * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1103  *      PREQs are transmitted.
1104  * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1105  *      during which a mesh STA can send only one Action frame containing
1106  *      a PREQ element for root path confirmation.
1107  * @power_mode: The default mesh power save mode which will be the initial
1108  *      setting for new peer links.
1109  * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1110  *      after transmitting its beacon.
1111  */
1112 struct mesh_config {
1113         u16 dot11MeshRetryTimeout;
1114         u16 dot11MeshConfirmTimeout;
1115         u16 dot11MeshHoldingTimeout;
1116         u16 dot11MeshMaxPeerLinks;
1117         u8 dot11MeshMaxRetries;
1118         u8 dot11MeshTTL;
1119         u8 element_ttl;
1120         bool auto_open_plinks;
1121         u32 dot11MeshNbrOffsetMaxNeighbor;
1122         u8 dot11MeshHWMPmaxPREQretries;
1123         u32 path_refresh_time;
1124         u16 min_discovery_timeout;
1125         u32 dot11MeshHWMPactivePathTimeout;
1126         u16 dot11MeshHWMPpreqMinInterval;
1127         u16 dot11MeshHWMPperrMinInterval;
1128         u16 dot11MeshHWMPnetDiameterTraversalTime;
1129         u8 dot11MeshHWMPRootMode;
1130         u16 dot11MeshHWMPRannInterval;
1131         bool dot11MeshGateAnnouncementProtocol;
1132         bool dot11MeshForwarding;
1133         s32 rssi_threshold;
1134         u16 ht_opmode;
1135         u32 dot11MeshHWMPactivePathToRootTimeout;
1136         u16 dot11MeshHWMProotInterval;
1137         u16 dot11MeshHWMPconfirmationInterval;
1138         enum nl80211_mesh_power_mode power_mode;
1139         u16 dot11MeshAwakeWindowDuration;
1140 };
1141
1142 /**
1143  * struct mesh_setup - 802.11s mesh setup configuration
1144  * @chandef: defines the channel to use
1145  * @mesh_id: the mesh ID
1146  * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1147  * @sync_method: which synchronization method to use
1148  * @path_sel_proto: which path selection protocol to use
1149  * @path_metric: which metric to use
1150  * @ie: vendor information elements (optional)
1151  * @ie_len: length of vendor information elements
1152  * @is_authenticated: this mesh requires authentication
1153  * @is_secure: this mesh uses security
1154  * @user_mpm: userspace handles all MPM functions
1155  * @dtim_period: DTIM period to use
1156  * @beacon_interval: beacon interval to use
1157  * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1158  *
1159  * These parameters are fixed when the mesh is created.
1160  */
1161 struct mesh_setup {
1162         struct cfg80211_chan_def chandef;
1163         const u8 *mesh_id;
1164         u8 mesh_id_len;
1165         u8 sync_method;
1166         u8 path_sel_proto;
1167         u8 path_metric;
1168         const u8 *ie;
1169         u8 ie_len;
1170         bool is_authenticated;
1171         bool is_secure;
1172         bool user_mpm;
1173         u8 dtim_period;
1174         u16 beacon_interval;
1175         int mcast_rate[IEEE80211_NUM_BANDS];
1176 };
1177
1178 /**
1179  * struct ieee80211_txq_params - TX queue parameters
1180  * @ac: AC identifier
1181  * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1182  * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1183  *      1..32767]
1184  * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1185  *      1..32767]
1186  * @aifs: Arbitration interframe space [0..255]
1187  */
1188 struct ieee80211_txq_params {
1189         enum nl80211_ac ac;
1190         u16 txop;
1191         u16 cwmin;
1192         u16 cwmax;
1193         u8 aifs;
1194 };
1195
1196 /**
1197  * DOC: Scanning and BSS list handling
1198  *
1199  * The scanning process itself is fairly simple, but cfg80211 offers quite
1200  * a bit of helper functionality. To start a scan, the scan operation will
1201  * be invoked with a scan definition. This scan definition contains the
1202  * channels to scan, and the SSIDs to send probe requests for (including the
1203  * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1204  * probe. Additionally, a scan request may contain extra information elements
1205  * that should be added to the probe request. The IEs are guaranteed to be
1206  * well-formed, and will not exceed the maximum length the driver advertised
1207  * in the wiphy structure.
1208  *
1209  * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1210  * it is responsible for maintaining the BSS list; the driver should not
1211  * maintain a list itself. For this notification, various functions exist.
1212  *
1213  * Since drivers do not maintain a BSS list, there are also a number of
1214  * functions to search for a BSS and obtain information about it from the
1215  * BSS structure cfg80211 maintains. The BSS list is also made available
1216  * to userspace.
1217  */
1218
1219 /**
1220  * struct cfg80211_ssid - SSID description
1221  * @ssid: the SSID
1222  * @ssid_len: length of the ssid
1223  */
1224 struct cfg80211_ssid {
1225         u8 ssid[IEEE80211_MAX_SSID_LEN];
1226         u8 ssid_len;
1227 };
1228
1229 /**
1230  * struct cfg80211_scan_request - scan request description
1231  *
1232  * @ssids: SSIDs to scan for (active scan only)
1233  * @n_ssids: number of SSIDs
1234  * @channels: channels to scan on.
1235  * @n_channels: total number of channels to scan
1236  * @ie: optional information element(s) to add into Probe Request or %NULL
1237  * @ie_len: length of ie in octets
1238  * @flags: bit field of flags controlling operation
1239  * @rates: bitmap of rates to advertise for each band
1240  * @wiphy: the wiphy this was for
1241  * @scan_start: time (in jiffies) when the scan started
1242  * @wdev: the wireless device to scan for
1243  * @aborted: (internal) scan request was notified as aborted
1244  * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1245  */
1246 struct cfg80211_scan_request {
1247         struct cfg80211_ssid *ssids;
1248         int n_ssids;
1249         u32 n_channels;
1250         const u8 *ie;
1251         size_t ie_len;
1252         u32 flags;
1253
1254         u32 rates[IEEE80211_NUM_BANDS];
1255
1256         struct wireless_dev *wdev;
1257
1258         /* internal */
1259         struct wiphy *wiphy;
1260         unsigned long scan_start;
1261         bool aborted;
1262         bool no_cck;
1263
1264         /* keep last */
1265         struct ieee80211_channel *channels[0];
1266 };
1267
1268 /**
1269  * struct cfg80211_match_set - sets of attributes to match
1270  *
1271  * @ssid: SSID to be matched
1272  */
1273 struct cfg80211_match_set {
1274         struct cfg80211_ssid ssid;
1275 };
1276
1277 /**
1278  * struct cfg80211_sched_scan_request - scheduled scan request description
1279  *
1280  * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1281  * @n_ssids: number of SSIDs
1282  * @n_channels: total number of channels to scan
1283  * @interval: interval between each scheduled scan cycle
1284  * @ie: optional information element(s) to add into Probe Request or %NULL
1285  * @ie_len: length of ie in octets
1286  * @flags: bit field of flags controlling operation
1287  * @match_sets: sets of parameters to be matched for a scan result
1288  *      entry to be considered valid and to be passed to the host
1289  *      (others are filtered out).
1290  *      If ommited, all results are passed.
1291  * @n_match_sets: number of match sets
1292  * @wiphy: the wiphy this was for
1293  * @dev: the interface
1294  * @scan_start: start time of the scheduled scan
1295  * @channels: channels to scan
1296  * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1297  */
1298 struct cfg80211_sched_scan_request {
1299         struct cfg80211_ssid *ssids;
1300         int n_ssids;
1301         u32 n_channels;
1302         u32 interval;
1303         const u8 *ie;
1304         size_t ie_len;
1305         u32 flags;
1306         struct cfg80211_match_set *match_sets;
1307         int n_match_sets;
1308         s32 rssi_thold;
1309
1310         /* internal */
1311         struct wiphy *wiphy;
1312         struct net_device *dev;
1313         unsigned long scan_start;
1314
1315         /* keep last */
1316         struct ieee80211_channel *channels[0];
1317 };
1318
1319 /**
1320  * enum cfg80211_signal_type - signal type
1321  *
1322  * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1323  * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1324  * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1325  */
1326 enum cfg80211_signal_type {
1327         CFG80211_SIGNAL_TYPE_NONE,
1328         CFG80211_SIGNAL_TYPE_MBM,
1329         CFG80211_SIGNAL_TYPE_UNSPEC,
1330 };
1331
1332 /**
1333  * struct cfg80211_bss_ie_data - BSS entry IE data
1334  * @tsf: TSF contained in the frame that carried these IEs
1335  * @rcu_head: internal use, for freeing
1336  * @len: length of the IEs
1337  * @data: IE data
1338  */
1339 struct cfg80211_bss_ies {
1340         u64 tsf;
1341         struct rcu_head rcu_head;
1342         int len;
1343         u8 data[];
1344 };
1345
1346 /**
1347  * struct cfg80211_bss - BSS description
1348  *
1349  * This structure describes a BSS (which may also be a mesh network)
1350  * for use in scan results and similar.
1351  *
1352  * @channel: channel this BSS is on
1353  * @bssid: BSSID of the BSS
1354  * @beacon_interval: the beacon interval as from the frame
1355  * @capability: the capability field in host byte order
1356  * @ies: the information elements (Note that there is no guarantee that these
1357  *      are well-formed!); this is a pointer to either the beacon_ies or
1358  *      proberesp_ies depending on whether Probe Response frame has been
1359  *      received. It is always non-%NULL.
1360  * @beacon_ies: the information elements from the last Beacon frame
1361  *      (implementation note: if @hidden_beacon_bss is set this struct doesn't
1362  *      own the beacon_ies, but they're just pointers to the ones from the
1363  *      @hidden_beacon_bss struct)
1364  * @proberesp_ies: the information elements from the last Probe Response frame
1365  * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1366  *      a BSS that hides the SSID in its beacon, this points to the BSS struct
1367  *      that holds the beacon data. @beacon_ies is still valid, of course, and
1368  *      points to the same data as hidden_beacon_bss->beacon_ies in that case.
1369  * @signal: signal strength value (type depends on the wiphy's signal_type)
1370  * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1371  */
1372 struct cfg80211_bss {
1373         struct ieee80211_channel *channel;
1374
1375         const struct cfg80211_bss_ies __rcu *ies;
1376         const struct cfg80211_bss_ies __rcu *beacon_ies;
1377         const struct cfg80211_bss_ies __rcu *proberesp_ies;
1378
1379         struct cfg80211_bss *hidden_beacon_bss;
1380
1381         s32 signal;
1382
1383         u16 beacon_interval;
1384         u16 capability;
1385
1386         u8 bssid[ETH_ALEN];
1387
1388         u8 priv[0] __aligned(sizeof(void *));
1389 };
1390
1391 /**
1392  * ieee80211_bss_get_ie - find IE with given ID
1393  * @bss: the bss to search
1394  * @ie: the IE ID
1395  *
1396  * Note that the return value is an RCU-protected pointer, so
1397  * rcu_read_lock() must be held when calling this function.
1398  * Return: %NULL if not found.
1399  */
1400 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1401
1402
1403 /**
1404  * struct cfg80211_auth_request - Authentication request data
1405  *
1406  * This structure provides information needed to complete IEEE 802.11
1407  * authentication.
1408  *
1409  * @bss: The BSS to authenticate with.
1410  * @auth_type: Authentication type (algorithm)
1411  * @ie: Extra IEs to add to Authentication frame or %NULL
1412  * @ie_len: Length of ie buffer in octets
1413  * @key_len: length of WEP key for shared key authentication
1414  * @key_idx: index of WEP key for shared key authentication
1415  * @key: WEP key for shared key authentication
1416  * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1417  *      Authentication transaction sequence number field.
1418  * @sae_data_len: Length of sae_data buffer in octets
1419  */
1420 struct cfg80211_auth_request {
1421         struct cfg80211_bss *bss;
1422         const u8 *ie;
1423         size_t ie_len;
1424         enum nl80211_auth_type auth_type;
1425         const u8 *key;
1426         u8 key_len, key_idx;
1427         const u8 *sae_data;
1428         size_t sae_data_len;
1429 };
1430
1431 /**
1432  * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1433  *
1434  * @ASSOC_REQ_DISABLE_HT:  Disable HT (802.11n)
1435  * @ASSOC_REQ_DISABLE_VHT:  Disable VHT
1436  */
1437 enum cfg80211_assoc_req_flags {
1438         ASSOC_REQ_DISABLE_HT            = BIT(0),
1439         ASSOC_REQ_DISABLE_VHT           = BIT(1),
1440 };
1441
1442 /**
1443  * struct cfg80211_assoc_request - (Re)Association request data
1444  *
1445  * This structure provides information needed to complete IEEE 802.11
1446  * (re)association.
1447  * @bss: The BSS to associate with. If the call is successful the driver
1448  *      is given a reference that it must release, normally via a call to
1449  *      cfg80211_send_rx_assoc(), or, if association timed out, with a
1450  *      call to cfg80211_put_bss() (in addition to calling
1451  *      cfg80211_send_assoc_timeout())
1452  * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1453  * @ie_len: Length of ie buffer in octets
1454  * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1455  * @crypto: crypto settings
1456  * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1457  * @flags:  See &enum cfg80211_assoc_req_flags
1458  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
1459  *   will be used in ht_capa.  Un-supported values will be ignored.
1460  * @ht_capa_mask:  The bits of ht_capa which are to be used.
1461  * @vht_capa: VHT capability override
1462  * @vht_capa_mask: VHT capability mask indicating which fields to use
1463  */
1464 struct cfg80211_assoc_request {
1465         struct cfg80211_bss *bss;
1466         const u8 *ie, *prev_bssid;
1467         size_t ie_len;
1468         struct cfg80211_crypto_settings crypto;
1469         bool use_mfp;
1470         u32 flags;
1471         struct ieee80211_ht_cap ht_capa;
1472         struct ieee80211_ht_cap ht_capa_mask;
1473         struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1474 };
1475
1476 /**
1477  * struct cfg80211_deauth_request - Deauthentication request data
1478  *
1479  * This structure provides information needed to complete IEEE 802.11
1480  * deauthentication.
1481  *
1482  * @bssid: the BSSID of the BSS to deauthenticate from
1483  * @ie: Extra IEs to add to Deauthentication frame or %NULL
1484  * @ie_len: Length of ie buffer in octets
1485  * @reason_code: The reason code for the deauthentication
1486  * @local_state_change: if set, change local state only and
1487  *      do not set a deauth frame
1488  */
1489 struct cfg80211_deauth_request {
1490         const u8 *bssid;
1491         const u8 *ie;
1492         size_t ie_len;
1493         u16 reason_code;
1494         bool local_state_change;
1495 };
1496
1497 /**
1498  * struct cfg80211_disassoc_request - Disassociation request data
1499  *
1500  * This structure provides information needed to complete IEEE 802.11
1501  * disassocation.
1502  *
1503  * @bss: the BSS to disassociate from
1504  * @ie: Extra IEs to add to Disassociation frame or %NULL
1505  * @ie_len: Length of ie buffer in octets
1506  * @reason_code: The reason code for the disassociation
1507  * @local_state_change: This is a request for a local state only, i.e., no
1508  *      Disassociation frame is to be transmitted.
1509  */
1510 struct cfg80211_disassoc_request {
1511         struct cfg80211_bss *bss;
1512         const u8 *ie;
1513         size_t ie_len;
1514         u16 reason_code;
1515         bool local_state_change;
1516 };
1517
1518 /**
1519  * struct cfg80211_ibss_params - IBSS parameters
1520  *
1521  * This structure defines the IBSS parameters for the join_ibss()
1522  * method.
1523  *
1524  * @ssid: The SSID, will always be non-null.
1525  * @ssid_len: The length of the SSID, will always be non-zero.
1526  * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1527  *      search for IBSSs with a different BSSID.
1528  * @chandef: defines the channel to use if no other IBSS to join can be found
1529  * @channel_fixed: The channel should be fixed -- do not search for
1530  *      IBSSs to join on other channels.
1531  * @ie: information element(s) to include in the beacon
1532  * @ie_len: length of that
1533  * @beacon_interval: beacon interval to use
1534  * @privacy: this is a protected network, keys will be configured
1535  *      after joining
1536  * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1537  *      sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1538  *      required to assume that the port is unauthorized until authorized by
1539  *      user space. Otherwise, port is marked authorized by default.
1540  * @basic_rates: bitmap of basic rates to use when creating the IBSS
1541  * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1542  */
1543 struct cfg80211_ibss_params {
1544         u8 *ssid;
1545         u8 *bssid;
1546         struct cfg80211_chan_def chandef;
1547         u8 *ie;
1548         u8 ssid_len, ie_len;
1549         u16 beacon_interval;
1550         u32 basic_rates;
1551         bool channel_fixed;
1552         bool privacy;
1553         bool control_port;
1554         int mcast_rate[IEEE80211_NUM_BANDS];
1555 };
1556
1557 /**
1558  * struct cfg80211_connect_params - Connection parameters
1559  *
1560  * This structure provides information needed to complete IEEE 802.11
1561  * authentication and association.
1562  *
1563  * @channel: The channel to use or %NULL if not specified (auto-select based
1564  *      on scan results)
1565  * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1566  *      results)
1567  * @ssid: SSID
1568  * @ssid_len: Length of ssid in octets
1569  * @auth_type: Authentication type (algorithm)
1570  * @ie: IEs for association request
1571  * @ie_len: Length of assoc_ie in octets
1572  * @privacy: indicates whether privacy-enabled APs should be used
1573  * @mfp: indicate whether management frame protection is used
1574  * @crypto: crypto settings
1575  * @key_len: length of WEP key for shared key authentication
1576  * @key_idx: index of WEP key for shared key authentication
1577  * @key: WEP key for shared key authentication
1578  * @flags:  See &enum cfg80211_assoc_req_flags
1579  * @bg_scan_period:  Background scan period in seconds
1580  *   or -1 to indicate that default value is to be used.
1581  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
1582  *   will be used in ht_capa.  Un-supported values will be ignored.
1583  * @ht_capa_mask:  The bits of ht_capa which are to be used.
1584  * @vht_capa:  VHT Capability overrides
1585  * @vht_capa_mask: The bits of vht_capa which are to be used.
1586  */
1587 struct cfg80211_connect_params {
1588         struct ieee80211_channel *channel;
1589         u8 *bssid;
1590         u8 *ssid;
1591         size_t ssid_len;
1592         enum nl80211_auth_type auth_type;
1593         u8 *ie;
1594         size_t ie_len;
1595         bool privacy;
1596         enum nl80211_mfp mfp;
1597         struct cfg80211_crypto_settings crypto;
1598         const u8 *key;
1599         u8 key_len, key_idx;
1600         u32 flags;
1601         int bg_scan_period;
1602         struct ieee80211_ht_cap ht_capa;
1603         struct ieee80211_ht_cap ht_capa_mask;
1604         struct ieee80211_vht_cap vht_capa;
1605         struct ieee80211_vht_cap vht_capa_mask;
1606 };
1607
1608 /**
1609  * enum wiphy_params_flags - set_wiphy_params bitfield values
1610  * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1611  * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1612  * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1613  * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1614  * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1615  */
1616 enum wiphy_params_flags {
1617         WIPHY_PARAM_RETRY_SHORT         = 1 << 0,
1618         WIPHY_PARAM_RETRY_LONG          = 1 << 1,
1619         WIPHY_PARAM_FRAG_THRESHOLD      = 1 << 2,
1620         WIPHY_PARAM_RTS_THRESHOLD       = 1 << 3,
1621         WIPHY_PARAM_COVERAGE_CLASS      = 1 << 4,
1622 };
1623
1624 /*
1625  * cfg80211_bitrate_mask - masks for bitrate control
1626  */
1627 struct cfg80211_bitrate_mask {
1628         struct {
1629                 u32 legacy;
1630                 u8 mcs[IEEE80211_HT_MCS_MASK_LEN];
1631         } control[IEEE80211_NUM_BANDS];
1632 };
1633 /**
1634  * struct cfg80211_pmksa - PMK Security Association
1635  *
1636  * This structure is passed to the set/del_pmksa() method for PMKSA
1637  * caching.
1638  *
1639  * @bssid: The AP's BSSID.
1640  * @pmkid: The PMK material itself.
1641  */
1642 struct cfg80211_pmksa {
1643         u8 *bssid;
1644         u8 *pmkid;
1645 };
1646
1647 /**
1648  * struct cfg80211_wowlan_trig_pkt_pattern - packet pattern
1649  * @mask: bitmask where to match pattern and where to ignore bytes,
1650  *      one bit per byte, in same format as nl80211
1651  * @pattern: bytes to match where bitmask is 1
1652  * @pattern_len: length of pattern (in bytes)
1653  * @pkt_offset: packet offset (in bytes)
1654  *
1655  * Internal note: @mask and @pattern are allocated in one chunk of
1656  * memory, free @mask only!
1657  */
1658 struct cfg80211_wowlan_trig_pkt_pattern {
1659         u8 *mask, *pattern;
1660         int pattern_len;
1661         int pkt_offset;
1662 };
1663
1664 /**
1665  * struct cfg80211_wowlan_tcp - TCP connection parameters
1666  *
1667  * @sock: (internal) socket for source port allocation
1668  * @src: source IP address
1669  * @dst: destination IP address
1670  * @dst_mac: destination MAC address
1671  * @src_port: source port
1672  * @dst_port: destination port
1673  * @payload_len: data payload length
1674  * @payload: data payload buffer
1675  * @payload_seq: payload sequence stamping configuration
1676  * @data_interval: interval at which to send data packets
1677  * @wake_len: wakeup payload match length
1678  * @wake_data: wakeup payload match data
1679  * @wake_mask: wakeup payload match mask
1680  * @tokens_size: length of the tokens buffer
1681  * @payload_tok: payload token usage configuration
1682  */
1683 struct cfg80211_wowlan_tcp {
1684         struct socket *sock;
1685         __be32 src, dst;
1686         u16 src_port, dst_port;
1687         u8 dst_mac[ETH_ALEN];
1688         int payload_len;
1689         const u8 *payload;
1690         struct nl80211_wowlan_tcp_data_seq payload_seq;
1691         u32 data_interval;
1692         u32 wake_len;
1693         const u8 *wake_data, *wake_mask;
1694         u32 tokens_size;
1695         /* must be last, variable member */
1696         struct nl80211_wowlan_tcp_data_token payload_tok;
1697 };
1698
1699 /**
1700  * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1701  *
1702  * This structure defines the enabled WoWLAN triggers for the device.
1703  * @any: wake up on any activity -- special trigger if device continues
1704  *      operating as normal during suspend
1705  * @disconnect: wake up if getting disconnected
1706  * @magic_pkt: wake up on receiving magic packet
1707  * @patterns: wake up on receiving packet matching a pattern
1708  * @n_patterns: number of patterns
1709  * @gtk_rekey_failure: wake up on GTK rekey failure
1710  * @eap_identity_req: wake up on EAP identity request packet
1711  * @four_way_handshake: wake up on 4-way handshake
1712  * @rfkill_release: wake up when rfkill is released
1713  * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
1714  *      NULL if not configured.
1715  */
1716 struct cfg80211_wowlan {
1717         bool any, disconnect, magic_pkt, gtk_rekey_failure,
1718              eap_identity_req, four_way_handshake,
1719              rfkill_release;
1720         struct cfg80211_wowlan_trig_pkt_pattern *patterns;
1721         struct cfg80211_wowlan_tcp *tcp;
1722         int n_patterns;
1723 };
1724
1725 /**
1726  * struct cfg80211_wowlan_wakeup - wakeup report
1727  * @disconnect: woke up by getting disconnected
1728  * @magic_pkt: woke up by receiving magic packet
1729  * @gtk_rekey_failure: woke up by GTK rekey failure
1730  * @eap_identity_req: woke up by EAP identity request packet
1731  * @four_way_handshake: woke up by 4-way handshake
1732  * @rfkill_release: woke up by rfkill being released
1733  * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
1734  * @packet_present_len: copied wakeup packet data
1735  * @packet_len: original wakeup packet length
1736  * @packet: The packet causing the wakeup, if any.
1737  * @packet_80211:  For pattern match, magic packet and other data
1738  *      frame triggers an 802.3 frame should be reported, for
1739  *      disconnect due to deauth 802.11 frame. This indicates which
1740  *      it is.
1741  * @tcp_match: TCP wakeup packet received
1742  * @tcp_connlost: TCP connection lost or failed to establish
1743  * @tcp_nomoretokens: TCP data ran out of tokens
1744  */
1745 struct cfg80211_wowlan_wakeup {
1746         bool disconnect, magic_pkt, gtk_rekey_failure,
1747              eap_identity_req, four_way_handshake,
1748              rfkill_release, packet_80211,
1749              tcp_match, tcp_connlost, tcp_nomoretokens;
1750         s32 pattern_idx;
1751         u32 packet_present_len, packet_len;
1752         const void *packet;
1753 };
1754
1755 /**
1756  * struct cfg80211_gtk_rekey_data - rekey data
1757  * @kek: key encryption key
1758  * @kck: key confirmation key
1759  * @replay_ctr: replay counter
1760  */
1761 struct cfg80211_gtk_rekey_data {
1762         u8 kek[NL80211_KEK_LEN];
1763         u8 kck[NL80211_KCK_LEN];
1764         u8 replay_ctr[NL80211_REPLAY_CTR_LEN];
1765 };
1766
1767 /**
1768  * struct cfg80211_update_ft_ies_params - FT IE Information
1769  *
1770  * This structure provides information needed to update the fast transition IE
1771  *
1772  * @md: The Mobility Domain ID, 2 Octet value
1773  * @ie: Fast Transition IEs
1774  * @ie_len: Length of ft_ie in octets
1775  */
1776 struct cfg80211_update_ft_ies_params {
1777         u16 md;
1778         const u8 *ie;
1779         size_t ie_len;
1780 };
1781
1782 /**
1783  * struct cfg80211_ops - backend description for wireless configuration
1784  *
1785  * This struct is registered by fullmac card drivers and/or wireless stacks
1786  * in order to handle configuration requests on their interfaces.
1787  *
1788  * All callbacks except where otherwise noted should return 0
1789  * on success or a negative error code.
1790  *
1791  * All operations are currently invoked under rtnl for consistency with the
1792  * wireless extensions but this is subject to reevaluation as soon as this
1793  * code is used more widely and we have a first user without wext.
1794  *
1795  * @suspend: wiphy device needs to be suspended. The variable @wow will
1796  *      be %NULL or contain the enabled Wake-on-Wireless triggers that are
1797  *      configured for the device.
1798  * @resume: wiphy device needs to be resumed
1799  * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
1800  *      to call device_set_wakeup_enable() to enable/disable wakeup from
1801  *      the device.
1802  *
1803  * @add_virtual_intf: create a new virtual interface with the given name,
1804  *      must set the struct wireless_dev's iftype. Beware: You must create
1805  *      the new netdev in the wiphy's network namespace! Returns the struct
1806  *      wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
1807  *      also set the address member in the wdev.
1808  *
1809  * @del_virtual_intf: remove the virtual interface
1810  *
1811  * @change_virtual_intf: change type/configuration of virtual interface,
1812  *      keep the struct wireless_dev's iftype updated.
1813  *
1814  * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1815  *      when adding a group key.
1816  *
1817  * @get_key: get information about the key with the given parameters.
1818  *      @mac_addr will be %NULL when requesting information for a group
1819  *      key. All pointers given to the @callback function need not be valid
1820  *      after it returns. This function should return an error if it is
1821  *      not possible to retrieve the key, -ENOENT if it doesn't exist.
1822  *
1823  * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1824  *      and @key_index, return -ENOENT if the key doesn't exist.
1825  *
1826  * @set_default_key: set the default key on an interface
1827  *
1828  * @set_default_mgmt_key: set the default management frame key on an interface
1829  *
1830  * @set_rekey_data: give the data necessary for GTK rekeying to the driver
1831  *
1832  * @start_ap: Start acting in AP mode defined by the parameters.
1833  * @change_beacon: Change the beacon parameters for an access point mode
1834  *      interface. This should reject the call when AP mode wasn't started.
1835  * @stop_ap: Stop being an AP, including stopping beaconing.
1836  *
1837  * @add_station: Add a new station.
1838  * @del_station: Remove a station; @mac may be NULL to remove all stations.
1839  * @change_station: Modify a given station. Note that flags changes are not much
1840  *      validated in cfg80211, in particular the auth/assoc/authorized flags
1841  *      might come to the driver in invalid combinations -- make sure to check
1842  *      them, also against the existing state! Drivers must call
1843  *      cfg80211_check_station_change() to validate the information.
1844  * @get_station: get station information for the station identified by @mac
1845  * @dump_station: dump station callback -- resume dump at index @idx
1846  *
1847  * @add_mpath: add a fixed mesh path
1848  * @del_mpath: delete a given mesh path
1849  * @change_mpath: change a given mesh path
1850  * @get_mpath: get a mesh path for the given parameters
1851  * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1852  * @join_mesh: join the mesh network with the specified parameters
1853  * @leave_mesh: leave the current mesh network
1854  *
1855  * @get_mesh_config: Get the current mesh configuration
1856  *
1857  * @update_mesh_config: Update mesh parameters on a running mesh.
1858  *      The mask is a bitfield which tells us which parameters to
1859  *      set, and which to leave alone.
1860  *
1861  * @change_bss: Modify parameters for a given BSS.
1862  *
1863  * @set_txq_params: Set TX queue parameters
1864  *
1865  * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
1866  *      as it doesn't implement join_mesh and needs to set the channel to
1867  *      join the mesh instead.
1868  *
1869  * @set_monitor_channel: Set the monitor mode channel for the device. If other
1870  *      interfaces are active this callback should reject the configuration.
1871  *      If no interfaces are active or the device is down, the channel should
1872  *      be stored for when a monitor interface becomes active.
1873  *
1874  * @scan: Request to do a scan. If returning zero, the scan request is given
1875  *      the driver, and will be valid until passed to cfg80211_scan_done().
1876  *      For scan results, call cfg80211_inform_bss(); you can call this outside
1877  *      the scan/scan_done bracket too.
1878  *
1879  * @auth: Request to authenticate with the specified peer
1880  * @assoc: Request to (re)associate with the specified peer
1881  * @deauth: Request to deauthenticate from the specified peer
1882  * @disassoc: Request to disassociate from the specified peer
1883  *
1884  * @connect: Connect to the ESS with the specified parameters. When connected,
1885  *      call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1886  *      If the connection fails for some reason, call cfg80211_connect_result()
1887  *      with the status from the AP.
1888  * @disconnect: Disconnect from the BSS/ESS.
1889  *
1890  * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1891  *      cfg80211_ibss_joined(), also call that function when changing BSSID due
1892  *      to a merge.
1893  * @leave_ibss: Leave the IBSS.
1894  *
1895  * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
1896  *      MESH mode)
1897  *
1898  * @set_wiphy_params: Notify that wiphy parameters have changed;
1899  *      @changed bitfield (see &enum wiphy_params_flags) describes which values
1900  *      have changed. The actual parameter values are available in
1901  *      struct wiphy. If returning an error, no value should be changed.
1902  *
1903  * @set_tx_power: set the transmit power according to the parameters,
1904  *      the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
1905  *      wdev may be %NULL if power was set for the wiphy, and will
1906  *      always be %NULL unless the driver supports per-vif TX power
1907  *      (as advertised by the nl80211 feature flag.)
1908  * @get_tx_power: store the current TX power into the dbm variable;
1909  *      return 0 if successful
1910  *
1911  * @set_wds_peer: set the WDS peer for a WDS interface
1912  *
1913  * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1914  *      functions to adjust rfkill hw state
1915  *
1916  * @dump_survey: get site survey information.
1917  *
1918  * @remain_on_channel: Request the driver to remain awake on the specified
1919  *      channel for the specified duration to complete an off-channel
1920  *      operation (e.g., public action frame exchange). When the driver is
1921  *      ready on the requested channel, it must indicate this with an event
1922  *      notification by calling cfg80211_ready_on_channel().
1923  * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1924  *      This allows the operation to be terminated prior to timeout based on
1925  *      the duration value.
1926  * @mgmt_tx: Transmit a management frame.
1927  * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
1928  *      frame on another channel
1929  *
1930  * @testmode_cmd: run a test mode command
1931  * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
1932  *      used by the function, but 0 and 1 must not be touched. Additionally,
1933  *      return error codes other than -ENOBUFS and -ENOENT will terminate the
1934  *      dump and return to userspace with an error, so be careful. If any data
1935  *      was passed in from userspace then the data/len arguments will be present
1936  *      and point to the data contained in %NL80211_ATTR_TESTDATA.
1937  *
1938  * @set_bitrate_mask: set the bitrate mask configuration
1939  *
1940  * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1941  *      devices running firmwares capable of generating the (re) association
1942  *      RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1943  * @del_pmksa: Delete a cached PMKID.
1944  * @flush_pmksa: Flush all cached PMKIDs.
1945  * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1946  *      allows the driver to adjust the dynamic ps timeout value.
1947  * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1948  * @set_cqm_txe_config: Configure connection quality monitor TX error
1949  *      thresholds.
1950  * @sched_scan_start: Tell the driver to start a scheduled scan.
1951  * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan.
1952  *
1953  * @mgmt_frame_register: Notify driver that a management frame type was
1954  *      registered. Note that this callback may not sleep, and cannot run
1955  *      concurrently with itself.
1956  *
1957  * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1958  *      Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1959  *      reject TX/RX mask combinations they cannot support by returning -EINVAL
1960  *      (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1961  *
1962  * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1963  *
1964  * @set_ringparam: Set tx and rx ring sizes.
1965  *
1966  * @get_ringparam: Get tx and rx ring current and maximum sizes.
1967  *
1968  * @tdls_mgmt: Transmit a TDLS management frame.
1969  * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
1970  *
1971  * @probe_client: probe an associated client, must return a cookie that it
1972  *      later passes to cfg80211_probe_status().
1973  *
1974  * @set_noack_map: Set the NoAck Map for the TIDs.
1975  *
1976  * @get_et_sset_count:  Ethtool API to get string-set count.
1977  *      See @ethtool_ops.get_sset_count
1978  *
1979  * @get_et_stats:  Ethtool API to get a set of u64 stats.
1980  *      See @ethtool_ops.get_ethtool_stats
1981  *
1982  * @get_et_strings:  Ethtool API to get a set of strings to describe stats
1983  *      and perhaps other supported types of ethtool data-sets.
1984  *      See @ethtool_ops.get_strings
1985  *
1986  * @get_channel: Get the current operating channel for the virtual interface.
1987  *      For monitor interfaces, it should return %NULL unless there's a single
1988  *      current monitoring channel.
1989  *
1990  * @start_p2p_device: Start the given P2P device.
1991  * @stop_p2p_device: Stop the given P2P device.
1992  *
1993  * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
1994  *      Parameters include ACL policy, an array of MAC address of stations
1995  *      and the number of MAC addresses. If there is already a list in driver
1996  *      this new list replaces the existing one. Driver has to clear its ACL
1997  *      when number of MAC addresses entries is passed as 0. Drivers which
1998  *      advertise the support for MAC based ACL have to implement this callback.
1999  *
2000  * @start_radar_detection: Start radar detection in the driver.
2001  *
2002  * @update_ft_ies: Provide updated Fast BSS Transition information to the
2003  *      driver. If the SME is in the driver/firmware, this information can be
2004  *      used in building Authentication and Reassociation Request frames.
2005  *
2006  * @crit_proto_start: Indicates a critical protocol needs more link reliability
2007  *      for a given duration (milliseconds). The protocol is provided so the
2008  *      driver can take the most appropriate actions.
2009  * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2010  *      reliability. This operation can not fail.
2011  */
2012 struct cfg80211_ops {
2013         int     (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
2014         int     (*resume)(struct wiphy *wiphy);
2015         void    (*set_wakeup)(struct wiphy *wiphy, bool enabled);
2016
2017         struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2018                                                   const char *name,
2019                                                   enum nl80211_iftype type,
2020                                                   u32 *flags,
2021                                                   struct vif_params *params);
2022         int     (*del_virtual_intf)(struct wiphy *wiphy,
2023                                     struct wireless_dev *wdev);
2024         int     (*change_virtual_intf)(struct wiphy *wiphy,
2025                                        struct net_device *dev,
2026                                        enum nl80211_iftype type, u32 *flags,
2027                                        struct vif_params *params);
2028
2029         int     (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2030                            u8 key_index, bool pairwise, const u8 *mac_addr,
2031                            struct key_params *params);
2032         int     (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2033                            u8 key_index, bool pairwise, const u8 *mac_addr,
2034                            void *cookie,
2035                            void (*callback)(void *cookie, struct key_params*));
2036         int     (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2037                            u8 key_index, bool pairwise, const u8 *mac_addr);
2038         int     (*set_default_key)(struct wiphy *wiphy,
2039                                    struct net_device *netdev,
2040                                    u8 key_index, bool unicast, bool multicast);
2041         int     (*set_default_mgmt_key)(struct wiphy *wiphy,
2042                                         struct net_device *netdev,
2043                                         u8 key_index);
2044
2045         int     (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2046                             struct cfg80211_ap_settings *settings);
2047         int     (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2048                                  struct cfg80211_beacon_data *info);
2049         int     (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
2050
2051
2052         int     (*add_station)(struct wiphy *wiphy, struct net_device *dev,
2053                                u8 *mac, struct station_parameters *params);
2054         int     (*del_station)(struct wiphy *wiphy, struct net_device *dev,
2055                                u8 *mac);
2056         int     (*change_station)(struct wiphy *wiphy, struct net_device *dev,
2057                                   u8 *mac, struct station_parameters *params);
2058         int     (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2059                                u8 *mac, struct station_info *sinfo);
2060         int     (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2061                                int idx, u8 *mac, struct station_info *sinfo);
2062
2063         int     (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2064                                u8 *dst, u8 *next_hop);
2065         int     (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2066                                u8 *dst);
2067         int     (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2068                                   u8 *dst, u8 *next_hop);
2069         int     (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2070                                u8 *dst, u8 *next_hop,
2071                                struct mpath_info *pinfo);
2072         int     (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2073                                int idx, u8 *dst, u8 *next_hop,
2074                                struct mpath_info *pinfo);
2075         int     (*get_mesh_config)(struct wiphy *wiphy,
2076                                 struct net_device *dev,
2077                                 struct mesh_config *conf);
2078         int     (*update_mesh_config)(struct wiphy *wiphy,
2079                                       struct net_device *dev, u32 mask,
2080                                       const struct mesh_config *nconf);
2081         int     (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
2082                              const struct mesh_config *conf,
2083                              const struct mesh_setup *setup);
2084         int     (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
2085
2086         int     (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
2087                               struct bss_parameters *params);
2088
2089         int     (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
2090                                   struct ieee80211_txq_params *params);
2091
2092         int     (*libertas_set_mesh_channel)(struct wiphy *wiphy,
2093                                              struct net_device *dev,
2094                                              struct ieee80211_channel *chan);
2095
2096         int     (*set_monitor_channel)(struct wiphy *wiphy,
2097                                        struct cfg80211_chan_def *chandef);
2098
2099         int     (*scan)(struct wiphy *wiphy,
2100                         struct cfg80211_scan_request *request);
2101
2102         int     (*auth)(struct wiphy *wiphy, struct net_device *dev,
2103                         struct cfg80211_auth_request *req);
2104         int     (*assoc)(struct wiphy *wiphy, struct net_device *dev,
2105                          struct cfg80211_assoc_request *req);
2106         int     (*deauth)(struct wiphy *wiphy, struct net_device *dev,
2107                           struct cfg80211_deauth_request *req);
2108         int     (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
2109                             struct cfg80211_disassoc_request *req);
2110
2111         int     (*connect)(struct wiphy *wiphy, struct net_device *dev,
2112                            struct cfg80211_connect_params *sme);
2113         int     (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
2114                               u16 reason_code);
2115
2116         int     (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
2117                              struct cfg80211_ibss_params *params);
2118         int     (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
2119
2120         int     (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
2121                                   int rate[IEEE80211_NUM_BANDS]);
2122
2123         int     (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
2124
2125         int     (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2126                                 enum nl80211_tx_power_setting type, int mbm);
2127         int     (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2128                                 int *dbm);
2129
2130         int     (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
2131                                 const u8 *addr);
2132
2133         void    (*rfkill_poll)(struct wiphy *wiphy);
2134
2135 #ifdef CONFIG_NL80211_TESTMODE
2136         int     (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
2137         int     (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
2138                                  struct netlink_callback *cb,
2139                                  void *data, int len);
2140 #endif
2141
2142         int     (*set_bitrate_mask)(struct wiphy *wiphy,
2143                                     struct net_device *dev,
2144                                     const u8 *peer,
2145                                     const struct cfg80211_bitrate_mask *mask);
2146
2147         int     (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
2148                         int idx, struct survey_info *info);
2149
2150         int     (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2151                              struct cfg80211_pmksa *pmksa);
2152         int     (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2153                              struct cfg80211_pmksa *pmksa);
2154         int     (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
2155
2156         int     (*remain_on_channel)(struct wiphy *wiphy,
2157                                      struct wireless_dev *wdev,
2158                                      struct ieee80211_channel *chan,
2159                                      unsigned int duration,
2160                                      u64 *cookie);
2161         int     (*cancel_remain_on_channel)(struct wiphy *wiphy,
2162                                             struct wireless_dev *wdev,
2163                                             u64 cookie);
2164
2165         int     (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
2166                           struct ieee80211_channel *chan, bool offchan,
2167                           unsigned int wait, const u8 *buf, size_t len,
2168                           bool no_cck, bool dont_wait_for_ack, u64 *cookie);
2169         int     (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
2170                                        struct wireless_dev *wdev,
2171                                        u64 cookie);
2172
2173         int     (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2174                                   bool enabled, int timeout);
2175
2176         int     (*set_cqm_rssi_config)(struct wiphy *wiphy,
2177                                        struct net_device *dev,
2178                                        s32 rssi_thold, u32 rssi_hyst);
2179
2180         int     (*set_cqm_txe_config)(struct wiphy *wiphy,
2181                                       struct net_device *dev,
2182                                       u32 rate, u32 pkts, u32 intvl);
2183
2184         void    (*mgmt_frame_register)(struct wiphy *wiphy,
2185                                        struct wireless_dev *wdev,
2186                                        u16 frame_type, bool reg);
2187
2188         int     (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2189         int     (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2190
2191         int     (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
2192         void    (*get_ringparam)(struct wiphy *wiphy,
2193                                  u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2194
2195         int     (*sched_scan_start)(struct wiphy *wiphy,
2196                                 struct net_device *dev,
2197                                 struct cfg80211_sched_scan_request *request);
2198         int     (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2199
2200         int     (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2201                                   struct cfg80211_gtk_rekey_data *data);
2202
2203         int     (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2204                              u8 *peer, u8 action_code,  u8 dialog_token,
2205                              u16 status_code, const u8 *buf, size_t len);
2206         int     (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2207                              u8 *peer, enum nl80211_tdls_operation oper);
2208
2209         int     (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2210                                 const u8 *peer, u64 *cookie);
2211
2212         int     (*set_noack_map)(struct wiphy *wiphy,
2213                                   struct net_device *dev,
2214                                   u16 noack_map);
2215
2216         int     (*get_et_sset_count)(struct wiphy *wiphy,
2217                                      struct net_device *dev, int sset);
2218         void    (*get_et_stats)(struct wiphy *wiphy, struct net_device *dev,
2219                                 struct ethtool_stats *stats, u64 *data);
2220         void    (*get_et_strings)(struct wiphy *wiphy, struct net_device *dev,
2221                                   u32 sset, u8 *data);
2222
2223         int     (*get_channel)(struct wiphy *wiphy,
2224                                struct wireless_dev *wdev,
2225                                struct cfg80211_chan_def *chandef);
2226
2227         int     (*start_p2p_device)(struct wiphy *wiphy,
2228                                     struct wireless_dev *wdev);
2229         void    (*stop_p2p_device)(struct wiphy *wiphy,
2230                                    struct wireless_dev *wdev);
2231
2232         int     (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2233                                const struct cfg80211_acl_data *params);
2234
2235         int     (*start_radar_detection)(struct wiphy *wiphy,
2236                                          struct net_device *dev,
2237                                          struct cfg80211_chan_def *chandef);
2238         int     (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
2239                                  struct cfg80211_update_ft_ies_params *ftie);
2240         int     (*crit_proto_start)(struct wiphy *wiphy,
2241                                     struct wireless_dev *wdev,
2242                                     enum nl80211_crit_proto_id protocol,
2243                                     u16 duration);
2244         void    (*crit_proto_stop)(struct wiphy *wiphy,
2245                                    struct wireless_dev *wdev);
2246 };
2247
2248 /*
2249  * wireless hardware and networking interfaces structures
2250  * and registration/helper functions
2251  */
2252
2253 /**
2254  * enum wiphy_flags - wiphy capability flags
2255  *
2256  * @WIPHY_FLAG_CUSTOM_REGULATORY:  tells us the driver for this device
2257  *      has its own custom regulatory domain and cannot identify the
2258  *      ISO / IEC 3166 alpha2 it belongs to. When this is enabled
2259  *      we will disregard the first regulatory hint (when the
2260  *      initiator is %REGDOM_SET_BY_CORE). wiphys can set the custom
2261  *      regulatory domain using wiphy_apply_custom_regulatory()
2262  *      prior to wiphy registration.
2263  * @WIPHY_FLAG_STRICT_REGULATORY: tells us that the wiphy for this device
2264  *      has regulatory domain that it wishes to be considered as the
2265  *      superset for regulatory rules. After this device gets its regulatory
2266  *      domain programmed further regulatory hints shall only be considered
2267  *      for this device to enhance regulatory compliance, forcing the
2268  *      device to only possibly use subsets of the original regulatory
2269  *      rules. For example if channel 13 and 14 are disabled by this
2270  *      device's regulatory domain no user specified regulatory hint which
2271  *      has these channels enabled would enable them for this wiphy,
2272  *      the device's original regulatory domain will be trusted as the
2273  *      base. You can program the superset of regulatory rules for this
2274  *      wiphy with regulatory_hint() for cards programmed with an
2275  *      ISO3166-alpha2 country code. wiphys that use regulatory_hint()
2276  *      will have their wiphy->regd programmed once the regulatory
2277  *      domain is set, and all other regulatory hints will be ignored
2278  *      until their own regulatory domain gets programmed.
2279  * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
2280  *      that passive scan flags and beaconing flags may not be lifted by
2281  *      cfg80211 due to regulatory beacon hints. For more information on beacon
2282  *      hints read the documenation for regulatory_hint_found_beacon()
2283  * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2284  *      wiphy at all
2285  * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2286  *      by default -- this flag will be set depending on the kernel's default
2287  *      on wiphy_new(), but can be changed by the driver if it has a good
2288  *      reason to override the default
2289  * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2290  *      on a VLAN interface)
2291  * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2292  * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2293  *      control port protocol ethertype. The device also honours the
2294  *      control_port_no_encrypt flag.
2295  * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2296  * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2297  *      auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2298  * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2299  * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2300  *      firmware.
2301  * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2302  * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2303  * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2304  *      link setup/discovery operations internally. Setup, discovery and
2305  *      teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2306  *      command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2307  *      used for asking the driver/firmware to perform a TDLS operation.
2308  * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2309  * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2310  *      when there are virtual interfaces in AP mode by calling
2311  *      cfg80211_report_obss_beacon().
2312  * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2313  *      responds to probe-requests in hardware.
2314  * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2315  * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2316  */
2317 enum wiphy_flags {
2318         WIPHY_FLAG_CUSTOM_REGULATORY            = BIT(0),
2319         WIPHY_FLAG_STRICT_REGULATORY            = BIT(1),
2320         WIPHY_FLAG_DISABLE_BEACON_HINTS         = BIT(2),
2321         WIPHY_FLAG_NETNS_OK                     = BIT(3),
2322         WIPHY_FLAG_PS_ON_BY_DEFAULT             = BIT(4),
2323         WIPHY_FLAG_4ADDR_AP                     = BIT(5),
2324         WIPHY_FLAG_4ADDR_STATION                = BIT(6),
2325         WIPHY_FLAG_CONTROL_PORT_PROTOCOL        = BIT(7),
2326         WIPHY_FLAG_IBSS_RSN                     = BIT(8),
2327         WIPHY_FLAG_MESH_AUTH                    = BIT(10),
2328         WIPHY_FLAG_SUPPORTS_SCHED_SCAN          = BIT(11),
2329         /* use hole at 12 */
2330         WIPHY_FLAG_SUPPORTS_FW_ROAM             = BIT(13),
2331         WIPHY_FLAG_AP_UAPSD                     = BIT(14),
2332         WIPHY_FLAG_SUPPORTS_TDLS                = BIT(15),
2333         WIPHY_FLAG_TDLS_EXTERNAL_SETUP          = BIT(16),
2334         WIPHY_FLAG_HAVE_AP_SME                  = BIT(17),
2335         WIPHY_FLAG_REPORTS_OBSS                 = BIT(18),
2336         WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD        = BIT(19),
2337         WIPHY_FLAG_OFFCHAN_TX                   = BIT(20),
2338         WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL        = BIT(21),
2339 };
2340
2341 /**
2342  * struct ieee80211_iface_limit - limit on certain interface types
2343  * @max: maximum number of interfaces of these types
2344  * @types: interface types (bits)
2345  */
2346 struct ieee80211_iface_limit {
2347         u16 max;
2348         u16 types;
2349 };
2350
2351 /**
2352  * struct ieee80211_iface_combination - possible interface combination
2353  * @limits: limits for the given interface types
2354  * @n_limits: number of limitations
2355  * @num_different_channels: can use up to this many different channels
2356  * @max_interfaces: maximum number of interfaces in total allowed in this
2357  *      group
2358  * @beacon_int_infra_match: In this combination, the beacon intervals
2359  *      between infrastructure and AP types must match. This is required
2360  *      only in special cases.
2361  * @radar_detect_widths: bitmap of channel widths supported for radar detection
2362  *
2363  * These examples can be expressed as follows:
2364  *
2365  * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2366  *
2367  *  struct ieee80211_iface_limit limits1[] = {
2368  *      { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2369  *      { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2370  *  };
2371  *  struct ieee80211_iface_combination combination1 = {
2372  *      .limits = limits1,
2373  *      .n_limits = ARRAY_SIZE(limits1),
2374  *      .max_interfaces = 2,
2375  *      .beacon_int_infra_match = true,
2376  *  };
2377  *
2378  *
2379  * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2380  *
2381  *  struct ieee80211_iface_limit limits2[] = {
2382  *      { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2383  *                           BIT(NL80211_IFTYPE_P2P_GO), },
2384  *  };
2385  *  struct ieee80211_iface_combination combination2 = {
2386  *      .limits = limits2,
2387  *      .n_limits = ARRAY_SIZE(limits2),
2388  *      .max_interfaces = 8,
2389  *      .num_different_channels = 1,
2390  *  };
2391  *
2392  *
2393  * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2394  * This allows for an infrastructure connection and three P2P connections.
2395  *
2396  *  struct ieee80211_iface_limit limits3[] = {
2397  *      { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2398  *      { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2399  *                           BIT(NL80211_IFTYPE_P2P_CLIENT), },
2400  *  };
2401  *  struct ieee80211_iface_combination combination3 = {
2402  *      .limits = limits3,
2403  *      .n_limits = ARRAY_SIZE(limits3),
2404  *      .max_interfaces = 4,
2405  *      .num_different_channels = 2,
2406  *  };
2407  */
2408 struct ieee80211_iface_combination {
2409         const struct ieee80211_iface_limit *limits;
2410         u32 num_different_channels;
2411         u16 max_interfaces;
2412         u8 n_limits;
2413         bool beacon_int_infra_match;
2414         u8 radar_detect_widths;
2415 };
2416
2417 struct ieee80211_txrx_stypes {
2418         u16 tx, rx;
2419 };
2420
2421 /**
2422  * enum wiphy_wowlan_support_flags - WoWLAN support flags
2423  * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
2424  *      trigger that keeps the device operating as-is and
2425  *      wakes up the host on any activity, for example a
2426  *      received packet that passed filtering; note that the
2427  *      packet should be preserved in that case
2428  * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
2429  *      (see nl80211.h)
2430  * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
2431  * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2432  * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2433  * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2434  * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2435  * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
2436  */
2437 enum wiphy_wowlan_support_flags {
2438         WIPHY_WOWLAN_ANY                = BIT(0),
2439         WIPHY_WOWLAN_MAGIC_PKT          = BIT(1),
2440         WIPHY_WOWLAN_DISCONNECT         = BIT(2),
2441         WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
2442         WIPHY_WOWLAN_GTK_REKEY_FAILURE  = BIT(4),
2443         WIPHY_WOWLAN_EAP_IDENTITY_REQ   = BIT(5),
2444         WIPHY_WOWLAN_4WAY_HANDSHAKE     = BIT(6),
2445         WIPHY_WOWLAN_RFKILL_RELEASE     = BIT(7),
2446 };
2447
2448 struct wiphy_wowlan_tcp_support {
2449         const struct nl80211_wowlan_tcp_data_token_feature *tok;
2450         u32 data_payload_max;
2451         u32 data_interval_max;
2452         u32 wake_payload_max;
2453         bool seq;
2454 };
2455
2456 /**
2457  * struct wiphy_wowlan_support - WoWLAN support data
2458  * @flags: see &enum wiphy_wowlan_support_flags
2459  * @n_patterns: number of supported wakeup patterns
2460  *      (see nl80211.h for the pattern definition)
2461  * @pattern_max_len: maximum length of each pattern
2462  * @pattern_min_len: minimum length of each pattern
2463  * @max_pkt_offset: maximum Rx packet offset
2464  * @tcp: TCP wakeup support information
2465  */
2466 struct wiphy_wowlan_support {
2467         u32 flags;
2468         int n_patterns;
2469         int pattern_max_len;
2470         int pattern_min_len;
2471         int max_pkt_offset;
2472         const struct wiphy_wowlan_tcp_support *tcp;
2473 };
2474
2475 /**
2476  * enum wiphy_vendor_command_flags - validation flags for vendor commands
2477  * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
2478  * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
2479  * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
2480  *      (must be combined with %_WDEV or %_NETDEV)
2481  */
2482 enum wiphy_vendor_command_flags {
2483         WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
2484         WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
2485         WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
2486 };
2487
2488 /**
2489  * struct wiphy_vendor_command - vendor command definition
2490  * @info: vendor command identifying information, as used in nl80211
2491  * @flags: flags, see &enum wiphy_vendor_command_flags
2492  * @doit: callback for the operation, note that wdev is %NULL if the
2493  *      flags didn't ask for a wdev and non-%NULL otherwise; the data
2494  *      pointer may be %NULL if userspace provided no data at all
2495  */
2496 struct wiphy_vendor_command {
2497         struct nl80211_vendor_cmd_info info;
2498         u32 flags;
2499         int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
2500                     void *data, int data_len);
2501 };
2502
2503 /**
2504  * struct wiphy - wireless hardware description
2505  * @reg_notifier: the driver's regulatory notification callback,
2506  *      note that if your driver uses wiphy_apply_custom_regulatory()
2507  *      the reg_notifier's request can be passed as NULL
2508  * @regd: the driver's regulatory domain, if one was requested via
2509  *      the regulatory_hint() API. This can be used by the driver
2510  *      on the reg_notifier() if it chooses to ignore future
2511  *      regulatory domain changes caused by other drivers.
2512  * @signal_type: signal type reported in &struct cfg80211_bss.
2513  * @cipher_suites: supported cipher suites
2514  * @n_cipher_suites: number of supported cipher suites
2515  * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
2516  * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
2517  * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
2518  *      -1 = fragmentation disabled, only odd values >= 256 used
2519  * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
2520  * @_net: the network namespace this wiphy currently lives in
2521  * @perm_addr: permanent MAC address of this device
2522  * @addr_mask: If the device supports multiple MAC addresses by masking,
2523  *      set this to a mask with variable bits set to 1, e.g. if the last
2524  *      four bits are variable then set it to 00:...:00:0f. The actual
2525  *      variable bits shall be determined by the interfaces added, with
2526  *      interfaces not matching the mask being rejected to be brought up.
2527  * @n_addresses: number of addresses in @addresses.
2528  * @addresses: If the device has more than one address, set this pointer
2529  *      to a list of addresses (6 bytes each). The first one will be used
2530  *      by default for perm_addr. In this case, the mask should be set to
2531  *      all-zeroes. In this case it is assumed that the device can handle
2532  *      the same number of arbitrary MAC addresses.
2533  * @registered: protects ->resume and ->suspend sysfs callbacks against
2534  *      unregister hardware
2535  * @debugfsdir: debugfs directory used for this wiphy, will be renamed
2536  *      automatically on wiphy renames
2537  * @dev: (virtual) struct device for this wiphy
2538  * @registered: helps synchronize suspend/resume with wiphy unregister
2539  * @wext: wireless extension handlers
2540  * @priv: driver private data (sized according to wiphy_new() parameter)
2541  * @interface_modes: bitmask of interfaces types valid for this wiphy,
2542  *      must be set by driver
2543  * @iface_combinations: Valid interface combinations array, should not
2544  *      list single interface types.
2545  * @n_iface_combinations: number of entries in @iface_combinations array.
2546  * @software_iftypes: bitmask of software interface types, these are not
2547  *      subject to any restrictions since they are purely managed in SW.
2548  * @flags: wiphy flags, see &enum wiphy_flags
2549  * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
2550  * @bss_priv_size: each BSS struct has private data allocated with it,
2551  *      this variable determines its size
2552  * @max_scan_ssids: maximum number of SSIDs the device can scan for in
2553  *      any given scan
2554  * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
2555  *      for in any given scheduled scan
2556  * @max_match_sets: maximum number of match sets the device can handle
2557  *      when performing a scheduled scan, 0 if filtering is not
2558  *      supported.
2559  * @max_scan_ie_len: maximum length of user-controlled IEs device can
2560  *      add to probe request frames transmitted during a scan, must not
2561  *      include fixed IEs like supported rates
2562  * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
2563  *      scans
2564  * @coverage_class: current coverage class
2565  * @fw_version: firmware version for ethtool reporting
2566  * @hw_version: hardware version for ethtool reporting
2567  * @max_num_pmkids: maximum number of PMKIDs supported by device
2568  * @privid: a pointer that drivers can use to identify if an arbitrary
2569  *      wiphy is theirs, e.g. in global notifiers
2570  * @bands: information about bands/channels supported by this device
2571  *
2572  * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
2573  *      transmitted through nl80211, points to an array indexed by interface
2574  *      type
2575  *
2576  * @available_antennas_tx: bitmap of antennas which are available to be
2577  *      configured as TX antennas. Antenna configuration commands will be
2578  *      rejected unless this or @available_antennas_rx is set.
2579  *
2580  * @available_antennas_rx: bitmap of antennas which are available to be
2581  *      configured as RX antennas. Antenna configuration commands will be
2582  *      rejected unless this or @available_antennas_tx is set.
2583  *
2584  * @probe_resp_offload:
2585  *       Bitmap of supported protocols for probe response offloading.
2586  *       See &enum nl80211_probe_resp_offload_support_attr. Only valid
2587  *       when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2588  *
2589  * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
2590  *      may request, if implemented.
2591  *
2592  * @wowlan: WoWLAN support information
2593  *
2594  * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
2595  * @ht_capa_mod_mask:  Specify what ht_cap values can be over-ridden.
2596  *      If null, then none can be over-ridden.
2597  * @vht_capa_mod_mask:  Specify what VHT capabilities can be over-ridden.
2598  *      If null, then none can be over-ridden.
2599  *
2600  * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
2601  *      supports for ACL.
2602  *
2603  * @extended_capabilities: extended capabilities supported by the driver,
2604  *      additional capabilities might be supported by userspace; these are
2605  *      the 802.11 extended capabilities ("Extended Capabilities element")
2606  *      and are in the same format as in the information element. See
2607  *      802.11-2012 8.4.2.29 for the defined fields.
2608  * @extended_capabilities_mask: mask of the valid values
2609  * @extended_capabilities_len: length of the extended capabilities
2610  * @country_ie_pref: country IE processing preferences specified
2611  *      by enum nl80211_country_ie_pref
2612  * @vendor_commands: array of vendor commands supported by the hardware
2613  * @n_vendor_commands: number of vendor commands
2614  * @vendor_events: array of vendor events supported by the hardware
2615  * @n_vendor_events: number of vendor events
2616  */
2617 struct wiphy {
2618         /* assign these fields before you register the wiphy */
2619
2620         /* permanent MAC address(es) */
2621         u8 perm_addr[ETH_ALEN];
2622         u8 addr_mask[ETH_ALEN];
2623
2624         struct mac_address *addresses;
2625
2626         const struct ieee80211_txrx_stypes *mgmt_stypes;
2627
2628         const struct ieee80211_iface_combination *iface_combinations;
2629         int n_iface_combinations;
2630         u16 software_iftypes;
2631
2632         u16 n_addresses;
2633
2634         /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
2635         u16 interface_modes;
2636
2637         u16 max_acl_mac_addrs;
2638
2639         u32 flags, features;
2640
2641         u32 ap_sme_capa;
2642
2643         enum cfg80211_signal_type signal_type;
2644
2645         int bss_priv_size;
2646         u8 max_scan_ssids;
2647         u8 max_sched_scan_ssids;
2648         u8 max_match_sets;
2649         u16 max_scan_ie_len;
2650         u16 max_sched_scan_ie_len;
2651
2652         int n_cipher_suites;
2653         const u32 *cipher_suites;
2654
2655         u8 retry_short;
2656         u8 retry_long;
2657         u32 frag_threshold;
2658         u32 rts_threshold;
2659         u8 coverage_class;
2660
2661         char fw_version[ETHTOOL_FWVERS_LEN];
2662         u32 hw_version;
2663
2664 #ifdef CONFIG_PM
2665         struct wiphy_wowlan_support wowlan;
2666 #endif
2667
2668         u16 max_remain_on_channel_duration;
2669
2670         u8 max_num_pmkids;
2671
2672         u32 available_antennas_tx;
2673         u32 available_antennas_rx;
2674
2675         /*
2676          * Bitmap of supported protocols for probe response offloading
2677          * see &enum nl80211_probe_resp_offload_support_attr. Only valid
2678          * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2679          */
2680         u32 probe_resp_offload;
2681
2682         const u8 *extended_capabilities, *extended_capabilities_mask;
2683         u8 extended_capabilities_len;
2684
2685         u8 country_ie_pref;
2686
2687         /* If multiple wiphys are registered and you're handed e.g.
2688          * a regular netdev with assigned ieee80211_ptr, you won't
2689          * know whether it points to a wiphy your driver has registered
2690          * or not. Assign this to something global to your driver to
2691          * help determine whether you own this wiphy or not. */
2692         const void *privid;
2693
2694         struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
2695
2696         /* Lets us get back the wiphy on the callback */
2697         void (*reg_notifier)(struct wiphy *wiphy,
2698                              struct regulatory_request *request);
2699
2700         /* fields below are read-only, assigned by cfg80211 */
2701
2702         const struct ieee80211_regdomain __rcu *regd;
2703
2704         /* the item in /sys/class/ieee80211/ points to this,
2705          * you need use set_wiphy_dev() (see below) */
2706         struct device dev;
2707
2708         /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
2709         bool registered;
2710
2711         /* dir in debugfs: ieee80211/<wiphyname> */
2712         struct dentry *debugfsdir;
2713
2714         const struct ieee80211_ht_cap *ht_capa_mod_mask;
2715         const struct ieee80211_vht_cap *vht_capa_mod_mask;
2716
2717 #ifdef CONFIG_NET_NS
2718         /* the network namespace this phy lives in currently */
2719         struct net *_net;
2720 #endif
2721
2722 #ifdef CONFIG_CFG80211_WEXT
2723         const struct iw_handler_def *wext;
2724 #endif
2725
2726         const struct wiphy_vendor_command *vendor_commands;
2727         const struct nl80211_vendor_cmd_info *vendor_events;
2728         int n_vendor_commands, n_vendor_events;
2729
2730         char priv[0] __aligned(NETDEV_ALIGN);
2731 };
2732
2733 static inline struct net *wiphy_net(struct wiphy *wiphy)
2734 {
2735         return read_pnet(&wiphy->_net);
2736 }
2737
2738 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
2739 {
2740         write_pnet(&wiphy->_net, net);
2741 }
2742
2743 /**
2744  * wiphy_priv - return priv from wiphy
2745  *
2746  * @wiphy: the wiphy whose priv pointer to return
2747  * Return: The priv of @wiphy.
2748  */
2749 static inline void *wiphy_priv(struct wiphy *wiphy)
2750 {
2751         BUG_ON(!wiphy);
2752         return &wiphy->priv;
2753 }
2754
2755 /**
2756  * priv_to_wiphy - return the wiphy containing the priv
2757  *
2758  * @priv: a pointer previously returned by wiphy_priv
2759  * Return: The wiphy of @priv.
2760  */
2761 static inline struct wiphy *priv_to_wiphy(void *priv)
2762 {
2763         BUG_ON(!priv);
2764         return container_of(priv, struct wiphy, priv);
2765 }
2766
2767 /**
2768  * set_wiphy_dev - set device pointer for wiphy
2769  *
2770  * @wiphy: The wiphy whose device to bind
2771  * @dev: The device to parent it to
2772  */
2773 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
2774 {
2775         wiphy->dev.parent = dev;
2776 }
2777
2778 /**
2779  * wiphy_dev - get wiphy dev pointer
2780  *
2781  * @wiphy: The wiphy whose device struct to look up
2782  * Return: The dev of @wiphy.
2783  */
2784 static inline struct device *wiphy_dev(struct wiphy *wiphy)
2785 {
2786         return wiphy->dev.parent;
2787 }
2788
2789 /**
2790  * wiphy_name - get wiphy name
2791  *
2792  * @wiphy: The wiphy whose name to return
2793  * Return: The name of @wiphy.
2794  */
2795 static inline const char *wiphy_name(const struct wiphy *wiphy)
2796 {
2797         return dev_name(&wiphy->dev);
2798 }
2799
2800 /**
2801  * wiphy_new - create a new wiphy for use with cfg80211
2802  *
2803  * @ops: The configuration operations for this device
2804  * @sizeof_priv: The size of the private area to allocate
2805  *
2806  * Create a new wiphy and associate the given operations with it.
2807  * @sizeof_priv bytes are allocated for private use.
2808  *
2809  * Return: A pointer to the new wiphy. This pointer must be
2810  * assigned to each netdev's ieee80211_ptr for proper operation.
2811  */
2812 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
2813
2814 /**
2815  * wiphy_register - register a wiphy with cfg80211
2816  *
2817  * @wiphy: The wiphy to register.
2818  *
2819  * Return: A non-negative wiphy index or a negative error code.
2820  */
2821 extern int wiphy_register(struct wiphy *wiphy);
2822
2823 /**
2824  * wiphy_unregister - deregister a wiphy from cfg80211
2825  *
2826  * @wiphy: The wiphy to unregister.
2827  *
2828  * After this call, no more requests can be made with this priv
2829  * pointer, but the call may sleep to wait for an outstanding
2830  * request that is being handled.
2831  */
2832 extern void wiphy_unregister(struct wiphy *wiphy);
2833
2834 /**
2835  * wiphy_free - free wiphy
2836  *
2837  * @wiphy: The wiphy to free
2838  */
2839 extern void wiphy_free(struct wiphy *wiphy);
2840
2841 /* internal structs */
2842 struct cfg80211_conn;
2843 struct cfg80211_internal_bss;
2844 struct cfg80211_cached_keys;
2845
2846 /**
2847  * struct wireless_dev - wireless device state
2848  *
2849  * For netdevs, this structure must be allocated by the driver
2850  * that uses the ieee80211_ptr field in struct net_device (this
2851  * is intentional so it can be allocated along with the netdev.)
2852  * It need not be registered then as netdev registration will
2853  * be intercepted by cfg80211 to see the new wireless device.
2854  *
2855  * For non-netdev uses, it must also be allocated by the driver
2856  * in response to the cfg80211 callbacks that require it, as
2857  * there's no netdev registration in that case it may not be
2858  * allocated outside of callback operations that return it.
2859  *
2860  * @wiphy: pointer to hardware description
2861  * @iftype: interface type
2862  * @list: (private) Used to collect the interfaces
2863  * @netdev: (private) Used to reference back to the netdev, may be %NULL
2864  * @identifier: (private) Identifier used in nl80211 to identify this
2865  *      wireless device if it has no netdev
2866  * @current_bss: (private) Used by the internal configuration code
2867  * @channel: (private) Used by the internal configuration code to track
2868  *      the user-set AP, monitor and WDS channel
2869  * @preset_chan: (private) Used by the internal configuration code to
2870  *      track the channel to be used for AP later
2871  * @bssid: (private) Used by the internal configuration code
2872  * @ssid: (private) Used by the internal configuration code
2873  * @ssid_len: (private) Used by the internal configuration code
2874  * @mesh_id_len: (private) Used by the internal configuration code
2875  * @mesh_id_up_len: (private) Used by the internal configuration code
2876  * @wext: (private) Used by the internal wireless extensions compat code
2877  * @use_4addr: indicates 4addr mode is used on this interface, must be
2878  *      set by driver (if supported) on add_interface BEFORE registering the
2879  *      netdev and may otherwise be used by driver read-only, will be update
2880  *      by cfg80211 on change_interface
2881  * @mgmt_registrations: list of registrations for management frames
2882  * @mgmt_registrations_lock: lock for the list
2883  * @mtx: mutex used to lock data in this struct
2884  * @cleanup_work: work struct used for cleanup that can't be done directly
2885  * @beacon_interval: beacon interval used on this device for transmitting
2886  *      beacons, 0 when not valid
2887  * @address: The address for this device, valid only if @netdev is %NULL
2888  * @p2p_started: true if this is a P2P Device that has been started
2889  * @cac_started: true if DFS channel availability check has been started
2890  * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
2891  */
2892 struct wireless_dev {
2893         struct wiphy *wiphy;
2894         enum nl80211_iftype iftype;
2895
2896         /* the remainder of this struct should be private to cfg80211 */
2897         struct list_head list;
2898         struct net_device *netdev;
2899
2900         u32 identifier;
2901
2902         struct list_head mgmt_registrations;
2903         spinlock_t mgmt_registrations_lock;
2904
2905         struct mutex mtx;
2906
2907         struct work_struct cleanup_work;
2908
2909         bool use_4addr, p2p_started;
2910
2911         u8 address[ETH_ALEN] __aligned(sizeof(u16));
2912
2913         /* currently used for IBSS and SME - might be rearranged later */
2914         u8 ssid[IEEE80211_MAX_SSID_LEN];
2915         u8 ssid_len, mesh_id_len, mesh_id_up_len;
2916         enum {
2917                 CFG80211_SME_IDLE,
2918                 CFG80211_SME_CONNECTING,
2919                 CFG80211_SME_CONNECTED,
2920         } sme_state;
2921         struct cfg80211_conn *conn;
2922         struct cfg80211_cached_keys *connect_keys;
2923
2924         struct list_head event_list;
2925         spinlock_t event_lock;
2926
2927         struct cfg80211_internal_bss *current_bss; /* associated / joined */
2928         struct cfg80211_chan_def preset_chandef;
2929
2930         /* for AP and mesh channel tracking */
2931         struct ieee80211_channel *channel;
2932
2933         bool ibss_fixed;
2934
2935         bool ps;
2936         int ps_timeout;
2937
2938         int beacon_interval;
2939
2940         u32 ap_unexpected_nlportid;
2941
2942         bool cac_started;
2943         unsigned long cac_start_time;
2944
2945 #ifdef CONFIG_CFG80211_WEXT
2946         /* wext data */
2947         struct {
2948                 struct cfg80211_ibss_params ibss;
2949                 struct cfg80211_connect_params connect;
2950                 struct cfg80211_cached_keys *keys;
2951                 u8 *ie;
2952                 size_t ie_len;
2953                 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
2954                 u8 ssid[IEEE80211_MAX_SSID_LEN];
2955                 s8 default_key, default_mgmt_key;
2956                 bool prev_bssid_valid;
2957         } wext;
2958 #endif
2959 };
2960
2961 static inline u8 *wdev_address(struct wireless_dev *wdev)
2962 {
2963         if (wdev->netdev)
2964                 return wdev->netdev->dev_addr;
2965         return wdev->address;
2966 }
2967
2968 /**
2969  * wdev_priv - return wiphy priv from wireless_dev
2970  *
2971  * @wdev: The wireless device whose wiphy's priv pointer to return
2972  * Return: The wiphy priv of @wdev.
2973  */
2974 static inline void *wdev_priv(struct wireless_dev *wdev)
2975 {
2976         BUG_ON(!wdev);
2977         return wiphy_priv(wdev->wiphy);
2978 }
2979
2980 /**
2981  * DOC: Utility functions
2982  *
2983  * cfg80211 offers a number of utility functions that can be useful.
2984  */
2985
2986 /**
2987  * ieee80211_channel_to_frequency - convert channel number to frequency
2988  * @chan: channel number
2989  * @band: band, necessary due to channel number overlap
2990  * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
2991  */
2992 extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
2993
2994 /**
2995  * ieee80211_frequency_to_channel - convert frequency to channel number
2996  * @freq: center frequency
2997  * Return: The corresponding channel, or 0 if the conversion failed.
2998  */
2999 extern int ieee80211_frequency_to_channel(int freq);
3000
3001 /*
3002  * Name indirection necessary because the ieee80211 code also has
3003  * a function named "ieee80211_get_channel", so if you include
3004  * cfg80211's header file you get cfg80211's version, if you try
3005  * to include both header files you'll (rightfully!) get a symbol
3006  * clash.
3007  */
3008 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
3009                                                          int freq);
3010 /**
3011  * ieee80211_get_channel - get channel struct from wiphy for specified frequency
3012  * @wiphy: the struct wiphy to get the channel for
3013  * @freq: the center frequency of the channel
3014  * Return: The channel struct from @wiphy at @freq.
3015  */
3016 static inline struct ieee80211_channel *
3017 ieee80211_get_channel(struct wiphy *wiphy, int freq)
3018 {
3019         return __ieee80211_get_channel(wiphy, freq);
3020 }
3021
3022 /**
3023  * ieee80211_get_response_rate - get basic rate for a given rate
3024  *
3025  * @sband: the band to look for rates in
3026  * @basic_rates: bitmap of basic rates
3027  * @bitrate: the bitrate for which to find the basic rate
3028  *
3029  * Return: The basic rate corresponding to a given bitrate, that
3030  * is the next lower bitrate contained in the basic rate map,
3031  * which is, for this function, given as a bitmap of indices of
3032  * rates in the band's bitrate table.
3033  */
3034 struct ieee80211_rate *
3035 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
3036                             u32 basic_rates, int bitrate);
3037
3038 /*
3039  * Radiotap parsing functions -- for controlled injection support
3040  *
3041  * Implemented in net/wireless/radiotap.c
3042  * Documentation in Documentation/networking/radiotap-headers.txt
3043  */
3044
3045 struct radiotap_align_size {
3046         uint8_t align:4, size:4;
3047 };
3048
3049 struct ieee80211_radiotap_namespace {
3050         const struct radiotap_align_size *align_size;
3051         int n_bits;
3052         uint32_t oui;
3053         uint8_t subns;
3054 };
3055
3056 struct ieee80211_radiotap_vendor_namespaces {
3057         const struct ieee80211_radiotap_namespace *ns;
3058         int n_ns;
3059 };
3060
3061 /**
3062  * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
3063  * @this_arg_index: index of current arg, valid after each successful call
3064  *      to ieee80211_radiotap_iterator_next()
3065  * @this_arg: pointer to current radiotap arg; it is valid after each
3066  *      call to ieee80211_radiotap_iterator_next() but also after
3067  *      ieee80211_radiotap_iterator_init() where it will point to
3068  *      the beginning of the actual data portion
3069  * @this_arg_size: length of the current arg, for convenience
3070  * @current_namespace: pointer to the current namespace definition
3071  *      (or internally %NULL if the current namespace is unknown)
3072  * @is_radiotap_ns: indicates whether the current namespace is the default
3073  *      radiotap namespace or not
3074  *
3075  * @_rtheader: pointer to the radiotap header we are walking through
3076  * @_max_length: length of radiotap header in cpu byte ordering
3077  * @_arg_index: next argument index
3078  * @_arg: next argument pointer
3079  * @_next_bitmap: internal pointer to next present u32
3080  * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
3081  * @_vns: vendor namespace definitions
3082  * @_next_ns_data: beginning of the next namespace's data
3083  * @_reset_on_ext: internal; reset the arg index to 0 when going to the
3084  *      next bitmap word
3085  *
3086  * Describes the radiotap parser state. Fields prefixed with an underscore
3087  * must not be used by users of the parser, only by the parser internally.
3088  */
3089
3090 struct ieee80211_radiotap_iterator {
3091         struct ieee80211_radiotap_header *_rtheader;
3092         const struct ieee80211_radiotap_vendor_namespaces *_vns;
3093         const struct ieee80211_radiotap_namespace *current_namespace;
3094
3095         unsigned char *_arg, *_next_ns_data;
3096         __le32 *_next_bitmap;
3097
3098         unsigned char *this_arg;
3099         int this_arg_index;
3100         int this_arg_size;
3101
3102         int is_radiotap_ns;
3103
3104         int _max_length;
3105         int _arg_index;
3106         uint32_t _bitmap_shifter;
3107         int _reset_on_ext;
3108 };
3109
3110 extern int ieee80211_radiotap_iterator_init(
3111         struct ieee80211_radiotap_iterator *iterator,
3112         struct ieee80211_radiotap_header *radiotap_header,
3113         int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
3114
3115 extern int ieee80211_radiotap_iterator_next(
3116         struct ieee80211_radiotap_iterator *iterator);
3117
3118
3119 extern const unsigned char rfc1042_header[6];
3120 extern const unsigned char bridge_tunnel_header[6];
3121
3122 /**
3123  * ieee80211_get_hdrlen_from_skb - get header length from data
3124  *
3125  * @skb: the frame
3126  *
3127  * Given an skb with a raw 802.11 header at the data pointer this function
3128  * returns the 802.11 header length.
3129  *
3130  * Return: The 802.11 header length in bytes (not including encryption
3131  * headers). Or 0 if the data in the sk_buff is too short to contain a valid
3132  * 802.11 header.
3133  */
3134 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
3135
3136 /**
3137  * ieee80211_hdrlen - get header length in bytes from frame control
3138  * @fc: frame control field in little-endian format
3139  * Return: The header length in bytes.
3140  */
3141 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
3142
3143 /**
3144  * ieee80211_get_mesh_hdrlen - get mesh extension header length
3145  * @meshhdr: the mesh extension header, only the flags field
3146  *      (first byte) will be accessed
3147  * Return: The length of the extension header, which is always at
3148  * least 6 bytes and at most 18 if address 5 and 6 are present.
3149  */
3150 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
3151
3152 /**
3153  * DOC: Data path helpers
3154  *
3155  * In addition to generic utilities, cfg80211 also offers
3156  * functions that help implement the data path for devices
3157  * that do not do the 802.11/802.3 conversion on the device.
3158  */
3159
3160 /**
3161  * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
3162  * @skb: the 802.11 data frame
3163  * @addr: the device MAC address
3164  * @iftype: the virtual interface type
3165  * Return: 0 on success. Non-zero on error.
3166  */
3167 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
3168                            enum nl80211_iftype iftype);
3169
3170 /**
3171  * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
3172  * @skb: the 802.3 frame
3173  * @addr: the device MAC address
3174  * @iftype: the virtual interface type
3175  * @bssid: the network bssid (used only for iftype STATION and ADHOC)
3176  * @qos: build 802.11 QoS data frame
3177  * Return: 0 on success, or a negative error code.
3178  */
3179 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
3180                              enum nl80211_iftype iftype, u8 *bssid, bool qos);
3181
3182 /**
3183  * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
3184  *
3185  * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
3186  * 802.3 frames. The @list will be empty if the decode fails. The
3187  * @skb is consumed after the function returns.
3188  *
3189  * @skb: The input IEEE 802.11n A-MSDU frame.
3190  * @list: The output list of 802.3 frames. It must be allocated and
3191  *      initialized by by the caller.
3192  * @addr: The device MAC address.
3193  * @iftype: The device interface type.
3194  * @extra_headroom: The hardware extra headroom for SKBs in the @list.
3195  * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
3196  */
3197 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
3198                               const u8 *addr, enum nl80211_iftype iftype,
3199                               const unsigned int extra_headroom,
3200                               bool has_80211_header);
3201
3202 /**
3203  * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
3204  * @skb: the data frame
3205  * Return: The 802.1p/1d tag.
3206  */
3207 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
3208
3209 /**
3210  * cfg80211_find_ie - find information element in data
3211  *
3212  * @eid: element ID
3213  * @ies: data consisting of IEs
3214  * @len: length of data
3215  *
3216  * Return: %NULL if the element ID could not be found or if
3217  * the element is invalid (claims to be longer than the given
3218  * data), or a pointer to the first byte of the requested
3219  * element, that is the byte containing the element ID.
3220  *
3221  * Note: There are no checks on the element length other than
3222  * having to fit into the given data.
3223  */
3224 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
3225
3226 /**
3227  * cfg80211_find_vendor_ie - find vendor specific information element in data
3228  *
3229  * @oui: vendor OUI
3230  * @oui_type: vendor-specific OUI type
3231  * @ies: data consisting of IEs
3232  * @len: length of data
3233  *
3234  * Return: %NULL if the vendor specific element ID could not be found or if the
3235  * element is invalid (claims to be longer than the given data), or a pointer to
3236  * the first byte of the requested element, that is the byte containing the
3237  * element ID.
3238  *
3239  * Note: There are no checks on the element length other than having to fit into
3240  * the given data.
3241  */
3242 const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
3243                                   const u8 *ies, int len);
3244
3245 /**
3246  * DOC: Regulatory enforcement infrastructure
3247  *
3248  * TODO
3249  */
3250
3251 /**
3252  * regulatory_hint - driver hint to the wireless core a regulatory domain
3253  * @wiphy: the wireless device giving the hint (used only for reporting
3254  *      conflicts)
3255  * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
3256  *      should be in. If @rd is set this should be NULL. Note that if you
3257  *      set this to NULL you should still set rd->alpha2 to some accepted
3258  *      alpha2.
3259  *
3260  * Wireless drivers can use this function to hint to the wireless core
3261  * what it believes should be the current regulatory domain by
3262  * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
3263  * domain should be in or by providing a completely build regulatory domain.
3264  * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
3265  * for a regulatory domain structure for the respective country.
3266  *
3267  * The wiphy must have been registered to cfg80211 prior to this call.
3268  * For cfg80211 drivers this means you must first use wiphy_register(),
3269  * for mac80211 drivers you must first use ieee80211_register_hw().
3270  *
3271  * Drivers should check the return value, its possible you can get
3272  * an -ENOMEM.
3273  *
3274  * Return: 0 on success. -ENOMEM.
3275  */
3276 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
3277
3278 /**
3279  * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
3280  * @wiphy: the wireless device we want to process the regulatory domain on
3281  * @regd: the custom regulatory domain to use for this wiphy
3282  *
3283  * Drivers can sometimes have custom regulatory domains which do not apply
3284  * to a specific country. Drivers can use this to apply such custom regulatory
3285  * domains. This routine must be called prior to wiphy registration. The
3286  * custom regulatory domain will be trusted completely and as such previous
3287  * default channel settings will be disregarded. If no rule is found for a
3288  * channel on the regulatory domain the channel will be disabled.
3289  */
3290 extern void wiphy_apply_custom_regulatory(
3291         struct wiphy *wiphy,
3292         const struct ieee80211_regdomain *regd);
3293
3294 /**
3295  * freq_reg_info - get regulatory information for the given frequency
3296  * @wiphy: the wiphy for which we want to process this rule for
3297  * @center_freq: Frequency in KHz for which we want regulatory information for
3298  *
3299  * Use this function to get the regulatory rule for a specific frequency on
3300  * a given wireless device. If the device has a specific regulatory domain
3301  * it wants to follow we respect that unless a country IE has been received
3302  * and processed already.
3303  *
3304  * Return: A valid pointer, or, when an error occurs, for example if no rule
3305  * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
3306  * check and PTR_ERR() to obtain the numeric return value. The numeric return
3307  * value will be -ERANGE if we determine the given center_freq does not even
3308  * have a regulatory rule for a frequency range in the center_freq's band.
3309  * See freq_in_rule_band() for our current definition of a band -- this is
3310  * purely subjective and right now it's 802.11 specific.
3311  */
3312 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
3313                                                u32 center_freq);
3314
3315 /*
3316  * callbacks for asynchronous cfg80211 methods, notification
3317  * functions and BSS handling helpers
3318  */
3319
3320 /**
3321  * cfg80211_scan_done - notify that scan finished
3322  *
3323  * @request: the corresponding scan request
3324  * @aborted: set to true if the scan was aborted for any reason,
3325  *      userspace will be notified of that
3326  */
3327 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
3328
3329 /**
3330  * cfg80211_sched_scan_results - notify that new scan results are available
3331  *
3332  * @wiphy: the wiphy which got scheduled scan results
3333  */
3334 void cfg80211_sched_scan_results(struct wiphy *wiphy);
3335
3336 /**
3337  * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
3338  *
3339  * @wiphy: the wiphy on which the scheduled scan stopped
3340  *
3341  * The driver can call this function to inform cfg80211 that the
3342  * scheduled scan had to be stopped, for whatever reason.  The driver
3343  * is then called back via the sched_scan_stop operation when done.
3344  */
3345 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
3346
3347 /**
3348  * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
3349  *
3350  * @wiphy: the wiphy reporting the BSS
3351  * @channel: The channel the frame was received on
3352  * @mgmt: the management frame (probe response or beacon)
3353  * @len: length of the management frame
3354  * @signal: the signal strength, type depends on the wiphy's signal_type
3355  * @gfp: context flags
3356  *
3357  * This informs cfg80211 that BSS information was found and
3358  * the BSS should be updated/added.
3359  *
3360  * Return: A referenced struct, must be released with cfg80211_put_bss()!
3361  * Or %NULL on error.
3362  */
3363 struct cfg80211_bss * __must_check
3364 cfg80211_inform_bss_frame(struct wiphy *wiphy,
3365                           struct ieee80211_channel *channel,
3366                           struct ieee80211_mgmt *mgmt, size_t len,
3367                           s32 signal, gfp_t gfp);
3368
3369 /**
3370  * cfg80211_inform_bss - inform cfg80211 of a new BSS
3371  *
3372  * @wiphy: the wiphy reporting the BSS
3373  * @channel: The channel the frame was received on
3374  * @bssid: the BSSID of the BSS
3375  * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
3376  * @capability: the capability field sent by the peer
3377  * @beacon_interval: the beacon interval announced by the peer
3378  * @ie: additional IEs sent by the peer
3379  * @ielen: length of the additional IEs
3380  * @signal: the signal strength, type depends on the wiphy's signal_type
3381  * @gfp: context flags
3382  *
3383  * This informs cfg80211 that BSS information was found and
3384  * the BSS should be updated/added.
3385  *
3386  * Return: A referenced struct, must be released with cfg80211_put_bss()!
3387  * Or %NULL on error.
3388  */
3389 struct cfg80211_bss * __must_check
3390 cfg80211_inform_bss(struct wiphy *wiphy,
3391                     struct ieee80211_channel *channel,
3392                     const u8 *bssid, u64 tsf, u16 capability,
3393                     u16 beacon_interval, const u8 *ie, size_t ielen,
3394                     s32 signal, gfp_t gfp);
3395
3396 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
3397                                       struct ieee80211_channel *channel,
3398                                       const u8 *bssid,
3399                                       const u8 *ssid, size_t ssid_len,
3400                                       u16 capa_mask, u16 capa_val);
3401 static inline struct cfg80211_bss *
3402 cfg80211_get_ibss(struct wiphy *wiphy,
3403                   struct ieee80211_channel *channel,
3404                   const u8 *ssid, size_t ssid_len)
3405 {
3406         return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
3407                                 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
3408 }
3409
3410 /**
3411  * cfg80211_ref_bss - reference BSS struct
3412  * @wiphy: the wiphy this BSS struct belongs to
3413  * @bss: the BSS struct to reference
3414  *
3415  * Increments the refcount of the given BSS struct.
3416  */
3417 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3418
3419 /**
3420  * cfg80211_put_bss - unref BSS struct
3421  * @wiphy: the wiphy this BSS struct belongs to
3422  * @bss: the BSS struct
3423  *
3424  * Decrements the refcount of the given BSS struct.
3425  */
3426 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3427
3428 /**
3429  * cfg80211_unlink_bss - unlink BSS from internal data structures
3430  * @wiphy: the wiphy
3431  * @bss: the bss to remove
3432  *
3433  * This function removes the given BSS from the internal data structures
3434  * thereby making it no longer show up in scan results etc. Use this
3435  * function when you detect a BSS is gone. Normally BSSes will also time
3436  * out, so it is not necessary to use this function at all.
3437  */
3438 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3439
3440 /**
3441  * cfg80211_send_rx_auth - notification of processed authentication
3442  * @dev: network device
3443  * @buf: authentication frame (header + body)
3444  * @len: length of the frame data
3445  *
3446  * This function is called whenever an authentication has been processed in
3447  * station mode. The driver is required to call either this function or
3448  * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
3449  * call. This function may sleep.
3450  */
3451 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
3452
3453 /**
3454  * cfg80211_send_auth_timeout - notification of timed out authentication
3455  * @dev: network device
3456  * @addr: The MAC address of the device with which the authentication timed out
3457  *
3458  * This function may sleep.
3459  */
3460 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
3461
3462 /**
3463  * cfg80211_send_rx_assoc - notification of processed association
3464  * @dev: network device
3465  * @bss: the BSS struct association was requested for, the struct reference
3466  *      is owned by cfg80211 after this call
3467  * @buf: (re)association response frame (header + body)
3468  * @len: length of the frame data
3469  *
3470  * This function is called whenever a (re)association response has been
3471  * processed in station mode. The driver is required to call either this
3472  * function or cfg80211_send_assoc_timeout() to indicate the result of
3473  * cfg80211_ops::assoc() call. This function may sleep.
3474  */
3475 void cfg80211_send_rx_assoc(struct net_device *dev, struct cfg80211_bss *bss,
3476                             const u8 *buf, size_t len);
3477
3478 /**
3479  * cfg80211_send_assoc_timeout - notification of timed out association
3480  * @dev: network device
3481  * @addr: The MAC address of the device with which the association timed out
3482  *
3483  * This function may sleep.
3484  */
3485 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
3486
3487 /**
3488  * cfg80211_send_deauth - notification of processed deauthentication
3489  * @dev: network device
3490  * @buf: deauthentication frame (header + body)
3491  * @len: length of the frame data
3492  *
3493  * This function is called whenever deauthentication has been processed in
3494  * station mode. This includes both received deauthentication frames and
3495  * locally generated ones. This function may sleep.
3496  */
3497 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
3498
3499 /**
3500  * __cfg80211_send_deauth - notification of processed deauthentication
3501  * @dev: network device
3502  * @buf: deauthentication frame (header + body)
3503  * @len: length of the frame data
3504  *
3505  * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
3506  */
3507 void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
3508
3509 /**
3510  * cfg80211_send_disassoc - notification of processed disassociation
3511  * @dev: network device
3512  * @buf: disassociation response frame (header + body)
3513  * @len: length of the frame data
3514  *
3515  * This function is called whenever disassociation has been processed in
3516  * station mode. This includes both received disassociation frames and locally
3517  * generated ones. This function may sleep.
3518  */
3519 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
3520
3521 /**
3522  * __cfg80211_send_disassoc - notification of processed disassociation
3523  * @dev: network device
3524  * @buf: disassociation response frame (header + body)
3525  * @len: length of the frame data
3526  *
3527  * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
3528  */
3529 void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
3530         size_t len);
3531
3532 /**
3533  * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
3534  * @dev: network device
3535  * @buf: deauthentication frame (header + body)
3536  * @len: length of the frame data
3537  *
3538  * This function is called whenever a received Deauthentication frame has been
3539  * dropped in station mode because of MFP being used but the Deauthentication
3540  * frame was not protected. This function may sleep.
3541  */
3542 void cfg80211_send_unprot_deauth(struct net_device *dev, const u8 *buf,
3543                                  size_t len);
3544
3545 /**
3546  * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
3547  * @dev: network device
3548  * @buf: disassociation frame (header + body)
3549  * @len: length of the frame data
3550  *
3551  * This function is called whenever a received Disassociation frame has been
3552  * dropped in station mode because of MFP being used but the Disassociation
3553  * frame was not protected. This function may sleep.
3554  */
3555 void cfg80211_send_unprot_disassoc(struct net_device *dev, const u8 *buf,
3556                                    size_t len);
3557
3558 /**
3559  * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
3560  * @dev: network device
3561  * @addr: The source MAC address of the frame
3562  * @key_type: The key type that the received frame used
3563  * @key_id: Key identifier (0..3). Can be -1 if missing.
3564  * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
3565  * @gfp: allocation flags
3566  *
3567  * This function is called whenever the local MAC detects a MIC failure in a
3568  * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
3569  * primitive.
3570  */
3571 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
3572                                   enum nl80211_key_type key_type, int key_id,
3573                                   const u8 *tsc, gfp_t gfp);
3574
3575 /**
3576  * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
3577  *
3578  * @dev: network device
3579  * @bssid: the BSSID of the IBSS joined
3580  * @gfp: allocation flags
3581  *
3582  * This function notifies cfg80211 that the device joined an IBSS or
3583  * switched to a different BSSID. Before this function can be called,
3584  * either a beacon has to have been received from the IBSS, or one of
3585  * the cfg80211_inform_bss{,_frame} functions must have been called
3586  * with the locally generated beacon -- this guarantees that there is
3587  * always a scan result for this IBSS. cfg80211 will handle the rest.
3588  */
3589 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
3590
3591 /**
3592  * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
3593  *
3594  * @dev: network device
3595  * @macaddr: the MAC address of the new candidate
3596  * @ie: information elements advertised by the peer candidate
3597  * @ie_len: lenght of the information elements buffer
3598  * @gfp: allocation flags
3599  *
3600  * This function notifies cfg80211 that the mesh peer candidate has been
3601  * detected, most likely via a beacon or, less likely, via a probe response.
3602  * cfg80211 then sends a notification to userspace.
3603  */
3604 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
3605                 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
3606
3607 /**
3608  * DOC: RFkill integration
3609  *
3610  * RFkill integration in cfg80211 is almost invisible to drivers,
3611  * as cfg80211 automatically registers an rfkill instance for each
3612  * wireless device it knows about. Soft kill is also translated
3613  * into disconnecting and turning all interfaces off, drivers are
3614  * expected to turn off the device when all interfaces are down.
3615  *
3616  * However, devices may have a hard RFkill line, in which case they
3617  * also need to interact with the rfkill subsystem, via cfg80211.
3618  * They can do this with a few helper functions documented here.
3619  */
3620
3621 /**
3622  * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
3623  * @wiphy: the wiphy
3624  * @blocked: block status
3625  */
3626 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
3627
3628 /**
3629  * wiphy_rfkill_start_polling - start polling rfkill
3630  * @wiphy: the wiphy
3631  */
3632 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
3633
3634 /**
3635  * wiphy_rfkill_stop_polling - stop polling rfkill
3636  * @wiphy: the wiphy
3637  */
3638 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
3639
3640 /**
3641  * DOC: Vendor commands
3642  *
3643  * Occasionally, there are special protocol or firmware features that
3644  * can't be implemented very openly. For this and similar cases, the
3645  * vendor command functionality allows implementing the features with
3646  * (typically closed-source) userspace and firmware, using nl80211 as
3647  * the configuration mechanism.
3648  *
3649  * A driver supporting vendor commands must register them as an array
3650  * in struct wiphy, with handlers for each one, each command has an
3651  * OUI and sub command ID to identify it.
3652  *
3653  * Note that this feature should not be (ab)used to implement protocol
3654  * features that could openly be shared across drivers. In particular,
3655  * it must never be required to use vendor commands to implement any
3656  * "normal" functionality that higher-level userspace like connection
3657  * managers etc. need.
3658  */
3659
3660 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
3661                                            enum nl80211_commands cmd,
3662                                            enum nl80211_attrs attr,
3663                                            int approxlen);
3664
3665 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
3666                                            enum nl80211_commands cmd,
3667                                            enum nl80211_attrs attr,
3668                                            int vendor_event_idx,
3669                                            int approxlen, gfp_t gfp);
3670
3671 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
3672
3673 /**
3674  * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
3675  * @wiphy: the wiphy
3676  * @approxlen: an upper bound of the length of the data that will
3677  *      be put into the skb
3678  *
3679  * This function allocates and pre-fills an skb for a reply to
3680  * a vendor command. Since it is intended for a reply, calling
3681  * it outside of a vendor command's doit() operation is invalid.
3682  *
3683  * The returned skb is pre-filled with some identifying data in
3684  * a way that any data that is put into the skb (with skb_put(),
3685  * nla_put() or similar) will end up being within the
3686  * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
3687  * with the skb is adding data for the corresponding userspace tool
3688  * which can then read that data out of the testdata attribute. You
3689  * must not modify the skb in any other way.
3690  *
3691  * When done, call cfg80211_vendor_cmd_reply() with the skb and return
3692  * its error code as the result of the doit() operation.
3693  *
3694  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
3695  */
3696 static inline struct sk_buff *
3697 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
3698 {
3699         return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
3700                                           NL80211_ATTR_TESTDATA, approxlen);
3701 }
3702
3703 /**
3704  * cfg80211_vendor_cmd_reply - send the reply skb
3705  * @skb: The skb, must have been allocated with
3706  *      cfg80211_vendor_cmd_alloc_reply_skb()
3707  *
3708  * Since calling this function will usually be the last thing
3709  * before returning from the vendor command doit() you should
3710  * return the error code.  Note that this function consumes the
3711  * skb regardless of the return value.
3712  *
3713  * Return: An error code or 0 on success.
3714  */
3715 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
3716
3717 /**
3718  * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
3719  * @wiphy: the wiphy
3720  * @event_idx: index of the vendor event in the wiphy's vendor_events
3721  * @approxlen: an upper bound of the length of the data that will
3722  *      be put into the skb
3723  * @gfp: allocation flags
3724  *
3725  * This function allocates and pre-fills an skb for an event on the
3726  * vendor-specific multicast group.
3727  *
3728  * When done filling the skb, call cfg80211_vendor_event() with the
3729  * skb to send the event.
3730  *
3731  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
3732  */
3733 static inline struct sk_buff *
3734 cfg80211_vendor_event_alloc(struct wiphy *wiphy, int approxlen,
3735                             int event_idx, gfp_t gfp)
3736 {
3737         return __cfg80211_alloc_event_skb(wiphy, NL80211_CMD_VENDOR,
3738                                           NL80211_ATTR_VENDOR_DATA,
3739                                           event_idx, approxlen, gfp);
3740 }
3741
3742 /**
3743  * cfg80211_vendor_event - send the event
3744  * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
3745  * @gfp: allocation flags
3746  *
3747  * This function sends the given @skb, which must have been allocated
3748  * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
3749  */
3750 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
3751 {
3752         __cfg80211_send_event_skb(skb, gfp);
3753 }
3754
3755 #ifdef CONFIG_NL80211_TESTMODE
3756 /**
3757  * DOC: Test mode
3758  *
3759  * Test mode is a set of utility functions to allow drivers to
3760  * interact with driver-specific tools to aid, for instance,
3761  * factory programming.
3762  *
3763  * This chapter describes how drivers interact with it, for more
3764  * information see the nl80211 book's chapter on it.
3765  */
3766
3767 /**
3768  * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
3769  * @wiphy: the wiphy
3770  * @approxlen: an upper bound of the length of the data that will
3771  *      be put into the skb
3772  *
3773  * This function allocates and pre-fills an skb for a reply to
3774  * the testmode command. Since it is intended for a reply, calling
3775  * it outside of the @testmode_cmd operation is invalid.
3776  *
3777  * The returned skb is pre-filled with the wiphy index and set up in
3778  * a way that any data that is put into the skb (with skb_put(),
3779  * nla_put() or similar) will end up being within the
3780  * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
3781  * with the skb is adding data for the corresponding userspace tool
3782  * which can then read that data out of the testdata attribute. You
3783  * must not modify the skb in any other way.
3784  *
3785  * When done, call cfg80211_testmode_reply() with the skb and return
3786  * its error code as the result of the @testmode_cmd operation.
3787  *
3788  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
3789  */
3790 static inline struct sk_buff *
3791 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
3792 {
3793         return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
3794                                           NL80211_ATTR_TESTDATA, approxlen);
3795 }
3796
3797 /**
3798  * cfg80211_testmode_reply - send the reply skb
3799  * @skb: The skb, must have been allocated with
3800  *      cfg80211_testmode_alloc_reply_skb()
3801  *
3802  * Since calling this function will usually be the last thing
3803  * before returning from the @testmode_cmd you should return
3804  * the error code.  Note that this function consumes the skb
3805  * regardless of the return value.
3806  *
3807  * Return: An error code or 0 on success.
3808  */
3809 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
3810 {
3811         return cfg80211_vendor_cmd_reply(skb);
3812 }
3813
3814 /**
3815  * cfg80211_testmode_alloc_event_skb - allocate testmode event
3816  * @wiphy: the wiphy
3817  * @approxlen: an upper bound of the length of the data that will
3818  *      be put into the skb
3819  * @gfp: allocation flags
3820  *
3821  * This function allocates and pre-fills an skb for an event on the
3822  * testmode multicast group.
3823  *
3824  * The returned skb is set up in the same way as with
3825  * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
3826  * there, you should simply add data to it that will then end up in the
3827  * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
3828  * in any other way.
3829  *
3830  * When done filling the skb, call cfg80211_testmode_event() with the
3831  * skb to send the event.
3832  *
3833  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
3834  */
3835 static inline struct sk_buff *
3836 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
3837 {
3838         return __cfg80211_alloc_event_skb(wiphy, NL80211_CMD_TESTMODE,
3839                                           NL80211_ATTR_TESTDATA, -1,
3840                                           approxlen, gfp);
3841 }
3842
3843 /**
3844  * cfg80211_testmode_event - send the event
3845  * @skb: The skb, must have been allocated with
3846  *      cfg80211_testmode_alloc_event_skb()
3847  * @gfp: allocation flags
3848  *
3849  * This function sends the given @skb, which must have been allocated
3850  * by cfg80211_testmode_alloc_event_skb(), as an event. It always
3851  * consumes it.
3852  */
3853 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
3854 {
3855         __cfg80211_send_event_skb(skb, gfp);
3856 }
3857
3858 #define CFG80211_TESTMODE_CMD(cmd)      .testmode_cmd = (cmd),
3859 #define CFG80211_TESTMODE_DUMP(cmd)     .testmode_dump = (cmd),
3860 #else
3861 #define CFG80211_TESTMODE_CMD(cmd)
3862 #define CFG80211_TESTMODE_DUMP(cmd)
3863 #endif
3864
3865 /**
3866  * cfg80211_connect_result - notify cfg80211 of connection result
3867  *
3868  * @dev: network device
3869  * @bssid: the BSSID of the AP
3870  * @req_ie: association request IEs (maybe be %NULL)
3871  * @req_ie_len: association request IEs length
3872  * @resp_ie: association response IEs (may be %NULL)
3873  * @resp_ie_len: assoc response IEs length
3874  * @status: status code, 0 for successful connection, use
3875  *      %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
3876  *      the real status code for failures.
3877  * @gfp: allocation flags
3878  *
3879  * It should be called by the underlying driver whenever connect() has
3880  * succeeded.
3881  */
3882 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
3883                              const u8 *req_ie, size_t req_ie_len,
3884                              const u8 *resp_ie, size_t resp_ie_len,
3885                              u16 status, gfp_t gfp);
3886
3887 /**
3888  * cfg80211_roamed - notify cfg80211 of roaming
3889  *
3890  * @dev: network device
3891  * @channel: the channel of the new AP
3892  * @bssid: the BSSID of the new AP
3893  * @req_ie: association request IEs (maybe be %NULL)
3894  * @req_ie_len: association request IEs length
3895  * @resp_ie: association response IEs (may be %NULL)
3896  * @resp_ie_len: assoc response IEs length
3897  * @gfp: allocation flags
3898  *
3899  * It should be called by the underlying driver whenever it roamed
3900  * from one AP to another while connected.
3901  */
3902 void cfg80211_roamed(struct net_device *dev,
3903                      struct ieee80211_channel *channel,
3904                      const u8 *bssid,
3905                      const u8 *req_ie, size_t req_ie_len,
3906                      const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3907
3908 /**
3909  * cfg80211_roamed_bss - notify cfg80211 of roaming
3910  *
3911  * @dev: network device
3912  * @bss: entry of bss to which STA got roamed
3913  * @req_ie: association request IEs (maybe be %NULL)
3914  * @req_ie_len: association request IEs length
3915  * @resp_ie: association response IEs (may be %NULL)
3916  * @resp_ie_len: assoc response IEs length
3917  * @gfp: allocation flags
3918  *
3919  * This is just a wrapper to notify cfg80211 of roaming event with driver
3920  * passing bss to avoid a race in timeout of the bss entry. It should be
3921  * called by the underlying driver whenever it roamed from one AP to another
3922  * while connected. Drivers which have roaming implemented in firmware
3923  * may use this function to avoid a race in bss entry timeout where the bss
3924  * entry of the new AP is seen in the driver, but gets timed out by the time
3925  * it is accessed in __cfg80211_roamed() due to delay in scheduling
3926  * rdev->event_work. In case of any failures, the reference is released
3927  * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
3928  * it will be released while diconneting from the current bss.
3929  */
3930 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
3931                          const u8 *req_ie, size_t req_ie_len,
3932                          const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3933
3934 /**
3935  * cfg80211_disconnected - notify cfg80211 that connection was dropped
3936  *
3937  * @dev: network device
3938  * @ie: information elements of the deauth/disassoc frame (may be %NULL)
3939  * @ie_len: length of IEs
3940  * @reason: reason code for the disconnection, set it to 0 if unknown
3941  * @gfp: allocation flags
3942  *
3943  * After it calls this function, the driver should enter an idle state
3944  * and not try to connect to any AP any more.
3945  */
3946 void cfg80211_disconnected(struct net_device *dev, u16 reason,
3947                            u8 *ie, size_t ie_len, gfp_t gfp);
3948
3949 /**
3950  * cfg80211_ready_on_channel - notification of remain_on_channel start
3951  * @wdev: wireless device
3952  * @cookie: the request cookie
3953  * @chan: The current channel (from remain_on_channel request)
3954  * @duration: Duration in milliseconds that the driver intents to remain on the
3955  *      channel
3956  * @gfp: allocation flags
3957  */
3958 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
3959                                struct ieee80211_channel *chan,
3960                                unsigned int duration, gfp_t gfp);
3961
3962 /**
3963  * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
3964  * @wdev: wireless device
3965  * @cookie: the request cookie
3966  * @chan: The current channel (from remain_on_channel request)
3967  * @gfp: allocation flags
3968  */
3969 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
3970                                         struct ieee80211_channel *chan,
3971                                         gfp_t gfp);
3972
3973
3974 /**
3975  * cfg80211_new_sta - notify userspace about station
3976  *
3977  * @dev: the netdev
3978  * @mac_addr: the station's address
3979  * @sinfo: the station information
3980  * @gfp: allocation flags
3981  */
3982 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
3983                       struct station_info *sinfo, gfp_t gfp);
3984
3985 /**
3986  * cfg80211_del_sta - notify userspace about deletion of a station
3987  *
3988  * @dev: the netdev
3989  * @mac_addr: the station's address
3990  * @gfp: allocation flags
3991  */
3992 void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
3993
3994 /**
3995  * cfg80211_conn_failed - connection request failed notification
3996  *
3997  * @dev: the netdev
3998  * @mac_addr: the station's address
3999  * @reason: the reason for connection failure
4000  * @gfp: allocation flags
4001  *
4002  * Whenever a station tries to connect to an AP and if the station
4003  * could not connect to the AP as the AP has rejected the connection
4004  * for some reasons, this function is called.
4005  *
4006  * The reason for connection failure can be any of the value from
4007  * nl80211_connect_failed_reason enum
4008  */
4009 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
4010                           enum nl80211_connect_failed_reason reason,
4011                           gfp_t gfp);
4012
4013 /**
4014  * cfg80211_rx_mgmt - notification of received, unprocessed management frame
4015  * @wdev: wireless device receiving the frame
4016  * @freq: Frequency on which the frame was received in MHz
4017  * @sig_dbm: signal strength in mBm, or 0 if unknown
4018  * @buf: Management frame (header + body)
4019  * @len: length of the frame data
4020  * @gfp: context flags
4021  *
4022  * This function is called whenever an Action frame is received for a station
4023  * mode interface, but is not processed in kernel.
4024  *
4025  * Return: %true if a user space application has registered for this frame.
4026  * For action frames, that makes it responsible for rejecting unrecognized
4027  * action frames; %false otherwise, in which case for action frames the
4028  * driver is responsible for rejecting the frame.
4029  */
4030 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
4031                       const u8 *buf, size_t len, gfp_t gfp);
4032
4033 /**
4034  * cfg80211_mgmt_tx_status - notification of TX status for management frame
4035  * @wdev: wireless device receiving the frame
4036  * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
4037  * @buf: Management frame (header + body)
4038  * @len: length of the frame data
4039  * @ack: Whether frame was acknowledged
4040  * @gfp: context flags
4041  *
4042  * This function is called whenever a management frame was requested to be
4043  * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
4044  * transmission attempt.
4045  */
4046 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
4047                              const u8 *buf, size_t len, bool ack, gfp_t gfp);
4048
4049
4050 /**
4051  * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
4052  * @dev: network device
4053  * @rssi_event: the triggered RSSI event
4054  * @gfp: context flags
4055  *
4056  * This function is called when a configured connection quality monitoring
4057  * rssi threshold reached event occurs.
4058  */
4059 void cfg80211_cqm_rssi_notify(struct net_device *dev,
4060                               enum nl80211_cqm_rssi_threshold_event rssi_event,
4061                               gfp_t gfp);
4062
4063 /**
4064  * cfg80211_radar_event - radar detection event
4065  * @wiphy: the wiphy
4066  * @chandef: chandef for the current channel
4067  * @gfp: context flags
4068  *
4069  * This function is called when a radar is detected on the current chanenl.
4070  */
4071 void cfg80211_radar_event(struct wiphy *wiphy,
4072                           struct cfg80211_chan_def *chandef, gfp_t gfp);
4073
4074 /**
4075  * cfg80211_cac_event - Channel availability check (CAC) event
4076  * @netdev: network device
4077  * @event: type of event
4078  * @gfp: context flags
4079  *
4080  * This function is called when a Channel availability check (CAC) is finished
4081  * or aborted. This must be called to notify the completion of a CAC process,
4082  * also by full-MAC drivers.
4083  */
4084 void cfg80211_cac_event(struct net_device *netdev,
4085                         enum nl80211_radar_event event, gfp_t gfp);
4086
4087
4088 /**
4089  * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
4090  * @dev: network device
4091  * @peer: peer's MAC address
4092  * @num_packets: how many packets were lost -- should be a fixed threshold
4093  *      but probably no less than maybe 50, or maybe a throughput dependent
4094  *      threshold (to account for temporary interference)
4095  * @gfp: context flags
4096  */
4097 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
4098                                  const u8 *peer, u32 num_packets, gfp_t gfp);
4099
4100 /**
4101  * cfg80211_cqm_txe_notify - TX error rate event
4102  * @dev: network device
4103  * @peer: peer's MAC address
4104  * @num_packets: how many packets were lost
4105  * @rate: % of packets which failed transmission
4106  * @intvl: interval (in s) over which the TX failure threshold was breached.
4107  * @gfp: context flags
4108  *
4109  * Notify userspace when configured % TX failures over number of packets in a
4110  * given interval is exceeded.
4111  */
4112 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
4113                              u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
4114
4115 /**
4116  * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
4117  * @dev: network device
4118  * @bssid: BSSID of AP (to avoid races)
4119  * @replay_ctr: new replay counter
4120  * @gfp: allocation flags
4121  */
4122 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
4123                                const u8 *replay_ctr, gfp_t gfp);
4124
4125 /**
4126  * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
4127  * @dev: network device
4128  * @index: candidate index (the smaller the index, the higher the priority)
4129  * @bssid: BSSID of AP
4130  * @preauth: Whether AP advertises support for RSN pre-authentication
4131  * @gfp: allocation flags
4132  */
4133 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
4134                                      const u8 *bssid, bool preauth, gfp_t gfp);
4135
4136 /**
4137  * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
4138  * @dev: The device the frame matched to
4139  * @addr: the transmitter address
4140  * @gfp: context flags
4141  *
4142  * This function is used in AP mode (only!) to inform userspace that
4143  * a spurious class 3 frame was received, to be able to deauth the
4144  * sender.
4145  * Return: %true if the frame was passed to userspace (or this failed
4146  * for a reason other than not having a subscription.)
4147  */
4148 bool cfg80211_rx_spurious_frame(struct net_device *dev,
4149                                 const u8 *addr, gfp_t gfp);
4150
4151 /**
4152  * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
4153  * @dev: The device the frame matched to
4154  * @addr: the transmitter address
4155  * @gfp: context flags
4156  *
4157  * This function is used in AP mode (only!) to inform userspace that
4158  * an associated station sent a 4addr frame but that wasn't expected.
4159  * It is allowed and desirable to send this event only once for each
4160  * station to avoid event flooding.
4161  * Return: %true if the frame was passed to userspace (or this failed
4162  * for a reason other than not having a subscription.)
4163  */
4164 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
4165                                         const u8 *addr, gfp_t gfp);
4166
4167 /**
4168  * cfg80211_probe_status - notify userspace about probe status
4169  * @dev: the device the probe was sent on
4170  * @addr: the address of the peer
4171  * @cookie: the cookie filled in @probe_client previously
4172  * @acked: indicates whether probe was acked or not
4173  * @gfp: allocation flags
4174  */
4175 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
4176                            u64 cookie, bool acked, gfp_t gfp);
4177
4178 /**
4179  * cfg80211_report_obss_beacon - report beacon from other APs
4180  * @wiphy: The wiphy that received the beacon
4181  * @frame: the frame
4182  * @len: length of the frame
4183  * @freq: frequency the frame was received on
4184  * @sig_dbm: signal strength in mBm, or 0 if unknown
4185  *
4186  * Use this function to report to userspace when a beacon was
4187  * received. It is not useful to call this when there is no
4188  * netdev that is in AP/GO mode.
4189  */
4190 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
4191                                  const u8 *frame, size_t len,
4192                                  int freq, int sig_dbm);
4193
4194 /**
4195  * cfg80211_reg_can_beacon - check if beaconing is allowed
4196  * @wiphy: the wiphy
4197  * @chandef: the channel definition
4198  *
4199  * Return: %true if there is no secondary channel or the secondary channel(s)
4200  * can be used for beaconing (i.e. is not a radar channel etc.)
4201  */
4202 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
4203                              struct cfg80211_chan_def *chandef);
4204
4205 /*
4206  * cfg80211_ch_switch_notify - update wdev channel and notify userspace
4207  * @dev: the device which switched channels
4208  * @chandef: the new channel definition
4209  *
4210  * Acquires wdev_lock, so must only be called from sleepable driver context!
4211  */
4212 void cfg80211_ch_switch_notify(struct net_device *dev,
4213                                struct cfg80211_chan_def *chandef);
4214
4215 /**
4216  * ieee80211_operating_class_to_band - convert operating class to band
4217  *
4218  * @operating_class: the operating class to convert
4219  * @band: band pointer to fill
4220  *
4221  * Returns %true if the conversion was successful, %false otherwise.
4222  */
4223 bool ieee80211_operating_class_to_band(u8 operating_class,
4224                                        enum ieee80211_band *band);
4225
4226 /*
4227  * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
4228  * @dev: the device on which the operation is requested
4229  * @peer: the MAC address of the peer device
4230  * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
4231  *      NL80211_TDLS_TEARDOWN)
4232  * @reason_code: the reason code for teardown request
4233  * @gfp: allocation flags
4234  *
4235  * This function is used to request userspace to perform TDLS operation that
4236  * requires knowledge of keys, i.e., link setup or teardown when the AP
4237  * connection uses encryption. This is optional mechanism for the driver to use
4238  * if it can automatically determine when a TDLS link could be useful (e.g.,
4239  * based on traffic and signal strength for a peer).
4240  */
4241 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
4242                                 enum nl80211_tdls_operation oper,
4243                                 u16 reason_code, gfp_t gfp);
4244
4245 /*
4246  * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
4247  * @rate: given rate_info to calculate bitrate from
4248  *
4249  * return 0 if MCS index >= 32
4250  */
4251 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
4252
4253 /**
4254  * cfg80211_unregister_wdev - remove the given wdev
4255  * @wdev: struct wireless_dev to remove
4256  *
4257  * Call this function only for wdevs that have no netdev assigned,
4258  * e.g. P2P Devices. It removes the device from the list so that
4259  * it can no longer be used. It is necessary to call this function
4260  * even when cfg80211 requests the removal of the interface by
4261  * calling the del_virtual_intf() callback. The function must also
4262  * be called when the driver wishes to unregister the wdev, e.g.
4263  * when the device is unbound from the driver.
4264  *
4265  * Requires the RTNL to be held.
4266  */
4267 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
4268
4269 /**
4270  * struct cfg80211_ft_event - FT Information Elements
4271  * @ies: FT IEs
4272  * @ies_len: length of the FT IE in bytes
4273  * @target_ap: target AP's MAC address
4274  * @ric_ies: RIC IE
4275  * @ric_ies_len: length of the RIC IE in bytes
4276  */
4277 struct cfg80211_ft_event_params {
4278         const u8 *ies;
4279         size_t ies_len;
4280         const u8 *target_ap;
4281         const u8 *ric_ies;
4282         size_t ric_ies_len;
4283 };
4284
4285 /**
4286  * cfg80211_ft_event - notify userspace about FT IE and RIC IE
4287  * @netdev: network device
4288  * @ft_event: IE information
4289  */
4290 void cfg80211_ft_event(struct net_device *netdev,
4291                        struct cfg80211_ft_event_params *ft_event);
4292
4293 /**
4294  * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
4295  * @ies: the input IE buffer
4296  * @len: the input length
4297  * @attr: the attribute ID to find
4298  * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
4299  *      if the function is only called to get the needed buffer size
4300  * @bufsize: size of the output buffer
4301  *
4302  * The function finds a given P2P attribute in the (vendor) IEs and
4303  * copies its contents to the given buffer.
4304  *
4305  * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
4306  * malformed or the attribute can't be found (respectively), or the
4307  * length of the found attribute (which can be zero).
4308  */
4309 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
4310                           enum ieee80211_p2p_attr_id attr,
4311                           u8 *buf, unsigned int bufsize);
4312
4313 /**
4314  * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
4315  * @wdev: the wireless device reporting the wakeup
4316  * @wakeup: the wakeup report
4317  * @gfp: allocation flags
4318  *
4319  * This function reports that the given device woke up. If it
4320  * caused the wakeup, report the reason(s), otherwise you may
4321  * pass %NULL as the @wakeup parameter to advertise that something
4322  * else caused the wakeup.
4323  */
4324 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
4325                                    struct cfg80211_wowlan_wakeup *wakeup,
4326                                    gfp_t gfp);
4327
4328 /**
4329  * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
4330  *
4331  * @wdev: the wireless device for which critical protocol is stopped.
4332  *
4333  * This function can be called by the driver to indicate it has reverted
4334  * operation back to normal. One reason could be that the duration given
4335  * by .crit_proto_start() has expired.
4336  */
4337 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
4338
4339 /* Logging, debugging and troubleshooting/diagnostic helpers. */
4340
4341 /* wiphy_printk helpers, similar to dev_printk */
4342
4343 #define wiphy_printk(level, wiphy, format, args...)             \
4344         dev_printk(level, &(wiphy)->dev, format, ##args)
4345 #define wiphy_emerg(wiphy, format, args...)                     \
4346         dev_emerg(&(wiphy)->dev, format, ##args)
4347 #define wiphy_alert(wiphy, format, args...)                     \
4348         dev_alert(&(wiphy)->dev, format, ##args)
4349 #define wiphy_crit(wiphy, format, args...)                      \
4350         dev_crit(&(wiphy)->dev, format, ##args)
4351 #define wiphy_err(wiphy, format, args...)                       \
4352         dev_err(&(wiphy)->dev, format, ##args)
4353 #define wiphy_warn(wiphy, format, args...)                      \
4354         dev_warn(&(wiphy)->dev, format, ##args)
4355 #define wiphy_notice(wiphy, format, args...)                    \
4356         dev_notice(&(wiphy)->dev, format, ##args)
4357 #define wiphy_info(wiphy, format, args...)                      \
4358         dev_info(&(wiphy)->dev, format, ##args)
4359
4360 #define wiphy_debug(wiphy, format, args...)                     \
4361         wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
4362
4363 #define wiphy_dbg(wiphy, format, args...)                       \
4364         dev_dbg(&(wiphy)->dev, format, ##args)
4365
4366 #if defined(VERBOSE_DEBUG)
4367 #define wiphy_vdbg      wiphy_dbg
4368 #else
4369 #define wiphy_vdbg(wiphy, format, args...)                              \
4370 ({                                                                      \
4371         if (0)                                                          \
4372                 wiphy_printk(KERN_DEBUG, wiphy, format, ##args);        \
4373         0;                                                              \
4374 })
4375 #endif
4376
4377 /*
4378  * wiphy_WARN() acts like wiphy_printk(), but with the key difference
4379  * of using a WARN/WARN_ON to get the message out, including the
4380  * file/line information and a backtrace.
4381  */
4382 #define wiphy_WARN(wiphy, format, args...)                      \
4383         WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
4384
4385 #endif /* __NET_CFG80211_H */