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