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