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