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