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