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