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