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