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