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