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