cfg80211: implement get_wireless_stats
[pandora-kernel.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-2009  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 /* remove once we remove the wext stuff */
24 #include <net/iw_handler.h>
25 #include <linux/wireless.h>
26
27
28 /*
29  * wireless hardware capability structures
30  */
31
32 /**
33  * enum ieee80211_band - supported frequency bands
34  *
35  * The bands are assigned this way because the supported
36  * bitrates differ in these bands.
37  *
38  * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
39  * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
40  */
41 enum ieee80211_band {
42         IEEE80211_BAND_2GHZ,
43         IEEE80211_BAND_5GHZ,
44
45         /* keep last */
46         IEEE80211_NUM_BANDS
47 };
48
49 /**
50  * enum ieee80211_channel_flags - channel flags
51  *
52  * Channel flags set by the regulatory control code.
53  *
54  * @IEEE80211_CHAN_DISABLED: This channel is disabled.
55  * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
56  *      on this channel.
57  * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
58  * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
59  * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
60  *      is not permitted.
61  * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
62  *      is not permitted.
63  */
64 enum ieee80211_channel_flags {
65         IEEE80211_CHAN_DISABLED         = 1<<0,
66         IEEE80211_CHAN_PASSIVE_SCAN     = 1<<1,
67         IEEE80211_CHAN_NO_IBSS          = 1<<2,
68         IEEE80211_CHAN_RADAR            = 1<<3,
69         IEEE80211_CHAN_NO_HT40PLUS      = 1<<4,
70         IEEE80211_CHAN_NO_HT40MINUS     = 1<<5,
71 };
72
73 #define IEEE80211_CHAN_NO_HT40 \
74         (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
75
76 /**
77  * struct ieee80211_channel - channel definition
78  *
79  * This structure describes a single channel for use
80  * with cfg80211.
81  *
82  * @center_freq: center frequency in MHz
83  * @max_bandwidth: maximum allowed bandwidth for this channel, in MHz
84  * @hw_value: hardware-specific value for the channel
85  * @flags: channel flags from &enum ieee80211_channel_flags.
86  * @orig_flags: channel flags at registration time, used by regulatory
87  *      code to support devices with additional restrictions
88  * @band: band this channel belongs to.
89  * @max_antenna_gain: maximum antenna gain in dBi
90  * @max_power: maximum transmission power (in dBm)
91  * @beacon_found: helper to regulatory code to indicate when a beacon
92  *      has been found on this channel. Use regulatory_hint_found_beacon()
93  *      to enable this, this is is useful only on 5 GHz band.
94  * @orig_mag: internal use
95  * @orig_mpwr: internal use
96  */
97 struct ieee80211_channel {
98         enum ieee80211_band band;
99         u16 center_freq;
100         u8 max_bandwidth;
101         u16 hw_value;
102         u32 flags;
103         int max_antenna_gain;
104         int max_power;
105         bool beacon_found;
106         u32 orig_flags;
107         int orig_mag, orig_mpwr;
108 };
109
110 /**
111  * enum ieee80211_rate_flags - rate flags
112  *
113  * Hardware/specification flags for rates. These are structured
114  * in a way that allows using the same bitrate structure for
115  * different bands/PHY modes.
116  *
117  * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
118  *      preamble on this bitrate; only relevant in 2.4GHz band and
119  *      with CCK rates.
120  * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
121  *      when used with 802.11a (on the 5 GHz band); filled by the
122  *      core code when registering the wiphy.
123  * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
124  *      when used with 802.11b (on the 2.4 GHz band); filled by the
125  *      core code when registering the wiphy.
126  * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
127  *      when used with 802.11g (on the 2.4 GHz band); filled by the
128  *      core code when registering the wiphy.
129  * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
130  */
131 enum ieee80211_rate_flags {
132         IEEE80211_RATE_SHORT_PREAMBLE   = 1<<0,
133         IEEE80211_RATE_MANDATORY_A      = 1<<1,
134         IEEE80211_RATE_MANDATORY_B      = 1<<2,
135         IEEE80211_RATE_MANDATORY_G      = 1<<3,
136         IEEE80211_RATE_ERP_G            = 1<<4,
137 };
138
139 /**
140  * struct ieee80211_rate - bitrate definition
141  *
142  * This structure describes a bitrate that an 802.11 PHY can
143  * operate with. The two values @hw_value and @hw_value_short
144  * are only for driver use when pointers to this structure are
145  * passed around.
146  *
147  * @flags: rate-specific flags
148  * @bitrate: bitrate in units of 100 Kbps
149  * @hw_value: driver/hardware value for this rate
150  * @hw_value_short: driver/hardware value for this rate when
151  *      short preamble is used
152  */
153 struct ieee80211_rate {
154         u32 flags;
155         u16 bitrate;
156         u16 hw_value, hw_value_short;
157 };
158
159 /**
160  * struct ieee80211_sta_ht_cap - STA's HT capabilities
161  *
162  * This structure describes most essential parameters needed
163  * to describe 802.11n HT capabilities for an STA.
164  *
165  * @ht_supported: is HT supported by the STA
166  * @cap: HT capabilities map as described in 802.11n spec
167  * @ampdu_factor: Maximum A-MPDU length factor
168  * @ampdu_density: Minimum A-MPDU spacing
169  * @mcs: Supported MCS rates
170  */
171 struct ieee80211_sta_ht_cap {
172         u16 cap; /* use IEEE80211_HT_CAP_ */
173         bool ht_supported;
174         u8 ampdu_factor;
175         u8 ampdu_density;
176         struct ieee80211_mcs_info mcs;
177 };
178
179 /**
180  * struct ieee80211_supported_band - frequency band definition
181  *
182  * This structure describes a frequency band a wiphy
183  * is able to operate in.
184  *
185  * @channels: Array of channels the hardware can operate in
186  *      in this band.
187  * @band: the band this structure represents
188  * @n_channels: Number of channels in @channels
189  * @bitrates: Array of bitrates the hardware can operate with
190  *      in this band. Must be sorted to give a valid "supported
191  *      rates" IE, i.e. CCK rates first, then OFDM.
192  * @n_bitrates: Number of bitrates in @bitrates
193  */
194 struct ieee80211_supported_band {
195         struct ieee80211_channel *channels;
196         struct ieee80211_rate *bitrates;
197         enum ieee80211_band band;
198         int n_channels;
199         int n_bitrates;
200         struct ieee80211_sta_ht_cap ht_cap;
201 };
202
203 /*
204  * Wireless hardware/device configuration structures and methods
205  */
206
207 /**
208  * struct vif_params - describes virtual interface parameters
209  * @mesh_id: mesh ID to use
210  * @mesh_id_len: length of the mesh ID
211  */
212 struct vif_params {
213        u8 *mesh_id;
214        int mesh_id_len;
215 };
216
217 /**
218  * struct key_params - key information
219  *
220  * Information about a key
221  *
222  * @key: key material
223  * @key_len: length of key material
224  * @cipher: cipher suite selector
225  * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
226  *      with the get_key() callback, must be in little endian,
227  *      length given by @seq_len.
228  */
229 struct key_params {
230         u8 *key;
231         u8 *seq;
232         int key_len;
233         int seq_len;
234         u32 cipher;
235 };
236
237 /**
238  * struct beacon_parameters - beacon parameters
239  *
240  * Used to configure the beacon for an interface.
241  *
242  * @head: head portion of beacon (before TIM IE)
243  *     or %NULL if not changed
244  * @tail: tail portion of beacon (after TIM IE)
245  *     or %NULL if not changed
246  * @interval: beacon interval or zero if not changed
247  * @dtim_period: DTIM period or zero if not changed
248  * @head_len: length of @head
249  * @tail_len: length of @tail
250  */
251 struct beacon_parameters {
252         u8 *head, *tail;
253         int interval, dtim_period;
254         int head_len, tail_len;
255 };
256
257 /**
258  * enum plink_action - actions to perform in mesh peers
259  *
260  * @PLINK_ACTION_INVALID: action 0 is reserved
261  * @PLINK_ACTION_OPEN: start mesh peer link establishment
262  * @PLINK_ACTION_BLOCL: block traffic from this mesh peer
263  */
264 enum plink_actions {
265         PLINK_ACTION_INVALID,
266         PLINK_ACTION_OPEN,
267         PLINK_ACTION_BLOCK,
268 };
269
270 /**
271  * struct station_parameters - station parameters
272  *
273  * Used to change and create a new station.
274  *
275  * @vlan: vlan interface station should belong to
276  * @supported_rates: supported rates in IEEE 802.11 format
277  *      (or NULL for no change)
278  * @supported_rates_len: number of supported rates
279  * @sta_flags_mask: station flags that changed
280  *      (bitmask of BIT(NL80211_STA_FLAG_...))
281  * @sta_flags_set: station flags values
282  *      (bitmask of BIT(NL80211_STA_FLAG_...))
283  * @listen_interval: listen interval or -1 for no change
284  * @aid: AID or zero for no change
285  */
286 struct station_parameters {
287         u8 *supported_rates;
288         struct net_device *vlan;
289         u32 sta_flags_mask, sta_flags_set;
290         int listen_interval;
291         u16 aid;
292         u8 supported_rates_len;
293         u8 plink_action;
294         struct ieee80211_ht_cap *ht_capa;
295 };
296
297 /**
298  * enum station_info_flags - station information flags
299  *
300  * Used by the driver to indicate which info in &struct station_info
301  * it has filled in during get_station() or dump_station().
302  *
303  * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
304  * @STATION_INFO_RX_BYTES: @rx_bytes filled
305  * @STATION_INFO_TX_BYTES: @tx_bytes filled
306  * @STATION_INFO_LLID: @llid filled
307  * @STATION_INFO_PLID: @plid filled
308  * @STATION_INFO_PLINK_STATE: @plink_state filled
309  * @STATION_INFO_SIGNAL: @signal filled
310  * @STATION_INFO_TX_BITRATE: @tx_bitrate fields are filled
311  *  (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
312  * @STATION_INFO_RX_PACKETS: @rx_packets filled
313  * @STATION_INFO_TX_PACKETS: @tx_packets filled
314  */
315 enum station_info_flags {
316         STATION_INFO_INACTIVE_TIME      = 1<<0,
317         STATION_INFO_RX_BYTES           = 1<<1,
318         STATION_INFO_TX_BYTES           = 1<<2,
319         STATION_INFO_LLID               = 1<<3,
320         STATION_INFO_PLID               = 1<<4,
321         STATION_INFO_PLINK_STATE        = 1<<5,
322         STATION_INFO_SIGNAL             = 1<<6,
323         STATION_INFO_TX_BITRATE         = 1<<7,
324         STATION_INFO_RX_PACKETS         = 1<<8,
325         STATION_INFO_TX_PACKETS         = 1<<9,
326 };
327
328 /**
329  * enum station_info_rate_flags - bitrate info flags
330  *
331  * Used by the driver to indicate the specific rate transmission
332  * type for 802.11n transmissions.
333  *
334  * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
335  * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
336  * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
337  */
338 enum rate_info_flags {
339         RATE_INFO_FLAGS_MCS             = 1<<0,
340         RATE_INFO_FLAGS_40_MHZ_WIDTH    = 1<<1,
341         RATE_INFO_FLAGS_SHORT_GI        = 1<<2,
342 };
343
344 /**
345  * struct rate_info - bitrate information
346  *
347  * Information about a receiving or transmitting bitrate
348  *
349  * @flags: bitflag of flags from &enum rate_info_flags
350  * @mcs: mcs index if struct describes a 802.11n bitrate
351  * @legacy: bitrate in 100kbit/s for 802.11abg
352  */
353 struct rate_info {
354         u8 flags;
355         u8 mcs;
356         u16 legacy;
357 };
358
359 /**
360  * struct station_info - station information
361  *
362  * Station information filled by driver for get_station() and dump_station.
363  *
364  * @filled: bitflag of flags from &enum station_info_flags
365  * @inactive_time: time since last station activity (tx/rx) in milliseconds
366  * @rx_bytes: bytes received from this station
367  * @tx_bytes: bytes transmitted to this station
368  * @llid: mesh local link id
369  * @plid: mesh peer link id
370  * @plink_state: mesh peer link state
371  * @signal: signal strength of last received packet in dBm
372  * @txrate: current unicast bitrate to this station
373  * @rx_packets: packets received from this station
374  * @tx_packets: packets transmitted to this station
375  */
376 struct station_info {
377         u32 filled;
378         u32 inactive_time;
379         u32 rx_bytes;
380         u32 tx_bytes;
381         u16 llid;
382         u16 plid;
383         u8 plink_state;
384         s8 signal;
385         struct rate_info txrate;
386         u32 rx_packets;
387         u32 tx_packets;
388 };
389
390 /**
391  * enum monitor_flags - monitor flags
392  *
393  * Monitor interface configuration flags. Note that these must be the bits
394  * according to the nl80211 flags.
395  *
396  * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
397  * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
398  * @MONITOR_FLAG_CONTROL: pass control frames
399  * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
400  * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
401  */
402 enum monitor_flags {
403         MONITOR_FLAG_FCSFAIL            = 1<<NL80211_MNTR_FLAG_FCSFAIL,
404         MONITOR_FLAG_PLCPFAIL           = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
405         MONITOR_FLAG_CONTROL            = 1<<NL80211_MNTR_FLAG_CONTROL,
406         MONITOR_FLAG_OTHER_BSS          = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
407         MONITOR_FLAG_COOK_FRAMES        = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
408 };
409
410 /**
411  * enum mpath_info_flags -  mesh path information flags
412  *
413  * Used by the driver to indicate which info in &struct mpath_info it has filled
414  * in during get_station() or dump_station().
415  *
416  * MPATH_INFO_FRAME_QLEN: @frame_qlen filled
417  * MPATH_INFO_DSN: @dsn filled
418  * MPATH_INFO_METRIC: @metric filled
419  * MPATH_INFO_EXPTIME: @exptime filled
420  * MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
421  * MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
422  * MPATH_INFO_FLAGS: @flags filled
423  */
424 enum mpath_info_flags {
425         MPATH_INFO_FRAME_QLEN           = BIT(0),
426         MPATH_INFO_DSN                  = BIT(1),
427         MPATH_INFO_METRIC               = BIT(2),
428         MPATH_INFO_EXPTIME              = BIT(3),
429         MPATH_INFO_DISCOVERY_TIMEOUT    = BIT(4),
430         MPATH_INFO_DISCOVERY_RETRIES    = BIT(5),
431         MPATH_INFO_FLAGS                = BIT(6),
432 };
433
434 /**
435  * struct mpath_info - mesh path information
436  *
437  * Mesh path information filled by driver for get_mpath() and dump_mpath().
438  *
439  * @filled: bitfield of flags from &enum mpath_info_flags
440  * @frame_qlen: number of queued frames for this destination
441  * @dsn: destination sequence number
442  * @metric: metric (cost) of this mesh path
443  * @exptime: expiration time for the mesh path from now, in msecs
444  * @flags: mesh path flags
445  * @discovery_timeout: total mesh path discovery timeout, in msecs
446  * @discovery_retries: mesh path discovery retries
447  */
448 struct mpath_info {
449         u32 filled;
450         u32 frame_qlen;
451         u32 dsn;
452         u32 metric;
453         u32 exptime;
454         u32 discovery_timeout;
455         u8 discovery_retries;
456         u8 flags;
457 };
458
459 /**
460  * struct bss_parameters - BSS parameters
461  *
462  * Used to change BSS parameters (mainly for AP mode).
463  *
464  * @use_cts_prot: Whether to use CTS protection
465  *      (0 = no, 1 = yes, -1 = do not change)
466  * @use_short_preamble: Whether the use of short preambles is allowed
467  *      (0 = no, 1 = yes, -1 = do not change)
468  * @use_short_slot_time: Whether the use of short slot time is allowed
469  *      (0 = no, 1 = yes, -1 = do not change)
470  * @basic_rates: basic rates in IEEE 802.11 format
471  *      (or NULL for no change)
472  * @basic_rates_len: number of basic rates
473  */
474 struct bss_parameters {
475         int use_cts_prot;
476         int use_short_preamble;
477         int use_short_slot_time;
478         u8 *basic_rates;
479         u8 basic_rates_len;
480 };
481
482 struct mesh_config {
483         /* Timeouts in ms */
484         /* Mesh plink management parameters */
485         u16 dot11MeshRetryTimeout;
486         u16 dot11MeshConfirmTimeout;
487         u16 dot11MeshHoldingTimeout;
488         u16 dot11MeshMaxPeerLinks;
489         u8  dot11MeshMaxRetries;
490         u8  dot11MeshTTL;
491         bool auto_open_plinks;
492         /* HWMP parameters */
493         u8  dot11MeshHWMPmaxPREQretries;
494         u32 path_refresh_time;
495         u16 min_discovery_timeout;
496         u32 dot11MeshHWMPactivePathTimeout;
497         u16 dot11MeshHWMPpreqMinInterval;
498         u16 dot11MeshHWMPnetDiameterTraversalTime;
499 };
500
501 /**
502  * struct ieee80211_txq_params - TX queue parameters
503  * @queue: TX queue identifier (NL80211_TXQ_Q_*)
504  * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
505  * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
506  *      1..32767]
507  * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
508  *      1..32767]
509  * @aifs: Arbitration interframe space [0..255]
510  */
511 struct ieee80211_txq_params {
512         enum nl80211_txq_q queue;
513         u16 txop;
514         u16 cwmin;
515         u16 cwmax;
516         u8 aifs;
517 };
518
519 /* from net/wireless.h */
520 struct wiphy;
521
522 /* from net/ieee80211.h */
523 struct ieee80211_channel;
524
525 /**
526  * struct cfg80211_ssid - SSID description
527  * @ssid: the SSID
528  * @ssid_len: length of the ssid
529  */
530 struct cfg80211_ssid {
531         u8 ssid[IEEE80211_MAX_SSID_LEN];
532         u8 ssid_len;
533 };
534
535 /**
536  * struct cfg80211_scan_request - scan request description
537  *
538  * @ssids: SSIDs to scan for (active scan only)
539  * @n_ssids: number of SSIDs
540  * @channels: channels to scan on.
541  * @n_channels: number of channels for each band
542  * @ie: optional information element(s) to add into Probe Request or %NULL
543  * @ie_len: length of ie in octets
544  * @wiphy: the wiphy this was for
545  * @ifidx: the interface index
546  */
547 struct cfg80211_scan_request {
548         struct cfg80211_ssid *ssids;
549         int n_ssids;
550         struct ieee80211_channel **channels;
551         u32 n_channels;
552         const u8 *ie;
553         size_t ie_len;
554
555         /* internal */
556         struct wiphy *wiphy;
557         int ifidx;
558 };
559
560 /**
561  * enum cfg80211_signal_type - signal type
562  *
563  * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
564  * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
565  * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
566  */
567 enum cfg80211_signal_type {
568         CFG80211_SIGNAL_TYPE_NONE,
569         CFG80211_SIGNAL_TYPE_MBM,
570         CFG80211_SIGNAL_TYPE_UNSPEC,
571 };
572
573 /**
574  * struct cfg80211_bss - BSS description
575  *
576  * This structure describes a BSS (which may also be a mesh network)
577  * for use in scan results and similar.
578  *
579  * @bssid: BSSID of the BSS
580  * @tsf: timestamp of last received update
581  * @beacon_interval: the beacon interval as from the frame
582  * @capability: the capability field in host byte order
583  * @information_elements: the information elements (Note that there
584  *      is no guarantee that these are well-formed!)
585  * @len_information_elements: total length of the information elements
586  * @signal: signal strength value (type depends on the wiphy's signal_type)
587  * @hold: BSS should not expire
588  * @free_priv: function pointer to free private data
589  * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
590  */
591 struct cfg80211_bss {
592         struct ieee80211_channel *channel;
593
594         u8 bssid[ETH_ALEN];
595         u64 tsf;
596         u16 beacon_interval;
597         u16 capability;
598         u8 *information_elements;
599         size_t len_information_elements;
600
601         s32 signal;
602
603         void (*free_priv)(struct cfg80211_bss *bss);
604         u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
605 };
606
607 /**
608  * struct cfg80211_crypto_settings - Crypto settings
609  * @wpa_versions: indicates which, if any, WPA versions are enabled
610  *      (from enum nl80211_wpa_versions)
611  * @cipher_group: group key cipher suite (or 0 if unset)
612  * @n_ciphers_pairwise: number of AP supported unicast ciphers
613  * @ciphers_pairwise: unicast key cipher suites
614  * @n_akm_suites: number of AKM suites
615  * @akm_suites: AKM suites
616  * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
617  *      sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
618  *      required to assume that the port is unauthorized until authorized by
619  *      user space. Otherwise, port is marked authorized by default.
620  */
621 struct cfg80211_crypto_settings {
622         u32 wpa_versions;
623         u32 cipher_group;
624         int n_ciphers_pairwise;
625         u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
626         int n_akm_suites;
627         u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
628         bool control_port;
629 };
630
631 /**
632  * struct cfg80211_auth_request - Authentication request data
633  *
634  * This structure provides information needed to complete IEEE 802.11
635  * authentication.
636  * NOTE: This structure will likely change when more code from mac80211 is
637  * moved into cfg80211 so that non-mac80211 drivers can benefit from it, too.
638  * Before using this in a driver that does not use mac80211, it would be better
639  * to check the status of that work and better yet, volunteer to work on it.
640  *
641  * @chan: The channel to use or %NULL if not specified (auto-select based on
642  *      scan results)
643  * @peer_addr: The address of the peer STA (AP BSSID in infrastructure case);
644  *      this field is required to be present; if the driver wants to help with
645  *      BSS selection, it should use (yet to be added) MLME event to allow user
646  *      space SME to be notified of roaming candidate, so that the SME can then
647  *      use the authentication request with the recommended BSSID and whatever
648  *      other data may be needed for authentication/association
649  * @ssid: SSID or %NULL if not yet available
650  * @ssid_len: Length of ssid in octets
651  * @auth_type: Authentication type (algorithm)
652  * @ie: Extra IEs to add to Authentication frame or %NULL
653  * @ie_len: Length of ie buffer in octets
654  */
655 struct cfg80211_auth_request {
656         struct ieee80211_channel *chan;
657         u8 *peer_addr;
658         const u8 *ssid;
659         size_t ssid_len;
660         enum nl80211_auth_type auth_type;
661         const u8 *ie;
662         size_t ie_len;
663 };
664
665 /**
666  * struct cfg80211_assoc_request - (Re)Association request data
667  *
668  * This structure provides information needed to complete IEEE 802.11
669  * (re)association.
670  * NOTE: This structure will likely change when more code from mac80211 is
671  * moved into cfg80211 so that non-mac80211 drivers can benefit from it, too.
672  * Before using this in a driver that does not use mac80211, it would be better
673  * to check the status of that work and better yet, volunteer to work on it.
674  *
675  * @chan: The channel to use or %NULL if not specified (auto-select based on
676  *      scan results)
677  * @peer_addr: The address of the peer STA (AP BSSID); this field is required
678  *      to be present and the STA must be in State 2 (authenticated) with the
679  *      peer STA
680  * @ssid: SSID
681  * @ssid_len: Length of ssid in octets
682  * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
683  * @ie_len: Length of ie buffer in octets
684  * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
685  * @crypto: crypto settings
686  */
687 struct cfg80211_assoc_request {
688         struct ieee80211_channel *chan;
689         u8 *peer_addr;
690         const u8 *ssid;
691         size_t ssid_len;
692         const u8 *ie;
693         size_t ie_len;
694         bool use_mfp;
695         struct cfg80211_crypto_settings crypto;
696 };
697
698 /**
699  * struct cfg80211_deauth_request - Deauthentication request data
700  *
701  * This structure provides information needed to complete IEEE 802.11
702  * deauthentication.
703  *
704  * @peer_addr: The address of the peer STA (AP BSSID); this field is required
705  *      to be present and the STA must be authenticated with the peer STA
706  * @ie: Extra IEs to add to Deauthentication frame or %NULL
707  * @ie_len: Length of ie buffer in octets
708  */
709 struct cfg80211_deauth_request {
710         u8 *peer_addr;
711         u16 reason_code;
712         const u8 *ie;
713         size_t ie_len;
714 };
715
716 /**
717  * struct cfg80211_disassoc_request - Disassociation request data
718  *
719  * This structure provides information needed to complete IEEE 802.11
720  * disassocation.
721  *
722  * @peer_addr: The address of the peer STA (AP BSSID); this field is required
723  *      to be present and the STA must be associated with the peer STA
724  * @ie: Extra IEs to add to Disassociation frame or %NULL
725  * @ie_len: Length of ie buffer in octets
726  */
727 struct cfg80211_disassoc_request {
728         u8 *peer_addr;
729         u16 reason_code;
730         const u8 *ie;
731         size_t ie_len;
732 };
733
734 /**
735  * struct cfg80211_ibss_params - IBSS parameters
736  *
737  * This structure defines the IBSS parameters for the join_ibss()
738  * method.
739  *
740  * @ssid: The SSID, will always be non-null.
741  * @ssid_len: The length of the SSID, will always be non-zero.
742  * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
743  *      search for IBSSs with a different BSSID.
744  * @channel: The channel to use if no IBSS can be found to join.
745  * @channel_fixed: The channel should be fixed -- do not search for
746  *      IBSSs to join on other channels.
747  * @ie: information element(s) to include in the beacon
748  * @ie_len: length of that
749  * @beacon_interval: beacon interval to use
750  */
751 struct cfg80211_ibss_params {
752         u8 *ssid;
753         u8 *bssid;
754         struct ieee80211_channel *channel;
755         u8 *ie;
756         u8 ssid_len, ie_len;
757         u16 beacon_interval;
758         bool channel_fixed;
759 };
760
761 /**
762  * struct cfg80211_connect_params - Connection parameters
763  *
764  * This structure provides information needed to complete IEEE 802.11
765  * authentication and association.
766  *
767  * @channel: The channel to use or %NULL if not specified (auto-select based
768  *      on scan results)
769  * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
770  *      results)
771  * @ssid: SSID
772  * @ssid_len: Length of ssid in octets
773  * @auth_type: Authentication type (algorithm)
774  * @assoc_ie: IEs for association request
775  * @assoc_ie_len: Length of assoc_ie in octets
776  * @privacy: indicates whether privacy-enabled APs should be used
777  * @crypto: crypto settings
778  */
779 struct cfg80211_connect_params {
780         struct ieee80211_channel *channel;
781         u8 *bssid;
782         u8 *ssid;
783         size_t ssid_len;
784         enum nl80211_auth_type auth_type;
785         u8 *ie;
786         size_t ie_len;
787         bool privacy;
788         struct cfg80211_crypto_settings crypto;
789 };
790
791 /**
792  * enum wiphy_params_flags - set_wiphy_params bitfield values
793  * WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
794  * WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
795  * WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
796  * WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
797  */
798 enum wiphy_params_flags {
799         WIPHY_PARAM_RETRY_SHORT         = 1 << 0,
800         WIPHY_PARAM_RETRY_LONG          = 1 << 1,
801         WIPHY_PARAM_FRAG_THRESHOLD      = 1 << 2,
802         WIPHY_PARAM_RTS_THRESHOLD       = 1 << 3,
803 };
804
805 /**
806  * enum tx_power_setting - TX power adjustment
807  *
808  * @TX_POWER_AUTOMATIC: the dbm parameter is ignored
809  * @TX_POWER_LIMITED: limit TX power by the dbm parameter
810  * @TX_POWER_FIXED: fix TX power to the dbm parameter
811  */
812 enum tx_power_setting {
813         TX_POWER_AUTOMATIC,
814         TX_POWER_LIMITED,
815         TX_POWER_FIXED,
816 };
817
818 /*
819  * cfg80211_bitrate_mask - masks for bitrate control
820  */
821 struct cfg80211_bitrate_mask {
822 /*
823  * As discussed in Berlin, this struct really
824  * should look like this:
825
826         struct {
827                 u32 legacy;
828                 u8 mcs[IEEE80211_HT_MCS_MASK_LEN];
829         } control[IEEE80211_NUM_BANDS];
830
831  * Since we can always fix in-kernel users, let's keep
832  * it simpler for now:
833  */
834         u32 fixed;   /* fixed bitrate, 0 == not fixed */
835         u32 maxrate; /* in kbps, 0 == no limit */
836 };
837
838 /**
839  * struct cfg80211_ops - backend description for wireless configuration
840  *
841  * This struct is registered by fullmac card drivers and/or wireless stacks
842  * in order to handle configuration requests on their interfaces.
843  *
844  * All callbacks except where otherwise noted should return 0
845  * on success or a negative error code.
846  *
847  * All operations are currently invoked under rtnl for consistency with the
848  * wireless extensions but this is subject to reevaluation as soon as this
849  * code is used more widely and we have a first user without wext.
850  *
851  * @suspend: wiphy device needs to be suspended
852  * @resume: wiphy device needs to be resumed
853  *
854  * @add_virtual_intf: create a new virtual interface with the given name,
855  *      must set the struct wireless_dev's iftype.
856  *
857  * @del_virtual_intf: remove the virtual interface determined by ifindex.
858  *
859  * @change_virtual_intf: change type/configuration of virtual interface,
860  *      keep the struct wireless_dev's iftype updated.
861  *
862  * @add_key: add a key with the given parameters. @mac_addr will be %NULL
863  *      when adding a group key.
864  *
865  * @get_key: get information about the key with the given parameters.
866  *      @mac_addr will be %NULL when requesting information for a group
867  *      key. All pointers given to the @callback function need not be valid
868  *      after it returns. This function should return an error if it is
869  *      not possible to retrieve the key, -ENOENT if it doesn't exist.
870  *
871  * @del_key: remove a key given the @mac_addr (%NULL for a group key)
872  *      and @key_index, return -ENOENT if the key doesn't exist.
873  *
874  * @set_default_key: set the default key on an interface
875  *
876  * @set_default_mgmt_key: set the default management frame key on an interface
877  *
878  * @add_beacon: Add a beacon with given parameters, @head, @interval
879  *      and @dtim_period will be valid, @tail is optional.
880  * @set_beacon: Change the beacon parameters for an access point mode
881  *      interface. This should reject the call when no beacon has been
882  *      configured.
883  * @del_beacon: Remove beacon configuration and stop sending the beacon.
884  *
885  * @add_station: Add a new station.
886  *
887  * @del_station: Remove a station; @mac may be NULL to remove all stations.
888  *
889  * @change_station: Modify a given station.
890  *
891  * @get_mesh_params: Put the current mesh parameters into *params
892  *
893  * @set_mesh_params: Set mesh parameters.
894  *      The mask is a bitfield which tells us which parameters to
895  *      set, and which to leave alone.
896  *
897  * @set_mesh_cfg: set mesh parameters (by now, just mesh id)
898  *
899  * @change_bss: Modify parameters for a given BSS.
900  *
901  * @set_txq_params: Set TX queue parameters
902  *
903  * @set_channel: Set channel
904  *
905  * @scan: Request to do a scan. If returning zero, the scan request is given
906  *      the driver, and will be valid until passed to cfg80211_scan_done().
907  *      For scan results, call cfg80211_inform_bss(); you can call this outside
908  *      the scan/scan_done bracket too.
909  *
910  * @auth: Request to authenticate with the specified peer
911  * @assoc: Request to (re)associate with the specified peer
912  * @deauth: Request to deauthenticate from the specified peer
913  * @disassoc: Request to disassociate from the specified peer
914  *
915  * @connect: Connect to the ESS with the specified parameters. When connected,
916  *      call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
917  *      If the connection fails for some reason, call cfg80211_connect_result()
918  *      with the status from the AP.
919  * @disconnect: Disconnect from the BSS/ESS.
920  *
921  * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
922  *      cfg80211_ibss_joined(), also call that function when changing BSSID due
923  *      to a merge.
924  * @leave_ibss: Leave the IBSS.
925  *
926  * @set_wiphy_params: Notify that wiphy parameters have changed;
927  *      @changed bitfield (see &enum wiphy_params_flags) describes which values
928  *      have changed. The actual parameter values are available in
929  *      struct wiphy. If returning an error, no value should be changed.
930  *
931  * @set_tx_power: set the transmit power according to the parameters
932  * @get_tx_power: store the current TX power into the dbm variable;
933  *      return 0 if successful
934  *
935  * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
936  *      functions to adjust rfkill hw state
937  *
938  * @testmode_cmd: run a test mode command
939  */
940 struct cfg80211_ops {
941         int     (*suspend)(struct wiphy *wiphy);
942         int     (*resume)(struct wiphy *wiphy);
943
944         int     (*add_virtual_intf)(struct wiphy *wiphy, char *name,
945                                     enum nl80211_iftype type, u32 *flags,
946                                     struct vif_params *params);
947         int     (*del_virtual_intf)(struct wiphy *wiphy, int ifindex);
948         int     (*change_virtual_intf)(struct wiphy *wiphy,
949                                        struct net_device *dev,
950                                        enum nl80211_iftype type, u32 *flags,
951                                        struct vif_params *params);
952
953         int     (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
954                            u8 key_index, const u8 *mac_addr,
955                            struct key_params *params);
956         int     (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
957                            u8 key_index, const u8 *mac_addr, void *cookie,
958                            void (*callback)(void *cookie, struct key_params*));
959         int     (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
960                            u8 key_index, const u8 *mac_addr);
961         int     (*set_default_key)(struct wiphy *wiphy,
962                                    struct net_device *netdev,
963                                    u8 key_index);
964         int     (*set_default_mgmt_key)(struct wiphy *wiphy,
965                                         struct net_device *netdev,
966                                         u8 key_index);
967
968         int     (*add_beacon)(struct wiphy *wiphy, struct net_device *dev,
969                               struct beacon_parameters *info);
970         int     (*set_beacon)(struct wiphy *wiphy, struct net_device *dev,
971                               struct beacon_parameters *info);
972         int     (*del_beacon)(struct wiphy *wiphy, struct net_device *dev);
973
974
975         int     (*add_station)(struct wiphy *wiphy, struct net_device *dev,
976                                u8 *mac, struct station_parameters *params);
977         int     (*del_station)(struct wiphy *wiphy, struct net_device *dev,
978                                u8 *mac);
979         int     (*change_station)(struct wiphy *wiphy, struct net_device *dev,
980                                   u8 *mac, struct station_parameters *params);
981         int     (*get_station)(struct wiphy *wiphy, struct net_device *dev,
982                                u8 *mac, struct station_info *sinfo);
983         int     (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
984                                int idx, u8 *mac, struct station_info *sinfo);
985
986         int     (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
987                                u8 *dst, u8 *next_hop);
988         int     (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
989                                u8 *dst);
990         int     (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
991                                   u8 *dst, u8 *next_hop);
992         int     (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
993                                u8 *dst, u8 *next_hop,
994                                struct mpath_info *pinfo);
995         int     (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
996                                int idx, u8 *dst, u8 *next_hop,
997                                struct mpath_info *pinfo);
998         int     (*get_mesh_params)(struct wiphy *wiphy,
999                                 struct net_device *dev,
1000                                 struct mesh_config *conf);
1001         int     (*set_mesh_params)(struct wiphy *wiphy,
1002                                 struct net_device *dev,
1003                                 const struct mesh_config *nconf, u32 mask);
1004         int     (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
1005                               struct bss_parameters *params);
1006
1007         int     (*set_txq_params)(struct wiphy *wiphy,
1008                                   struct ieee80211_txq_params *params);
1009
1010         int     (*set_channel)(struct wiphy *wiphy,
1011                                struct ieee80211_channel *chan,
1012                                enum nl80211_channel_type channel_type);
1013
1014         int     (*scan)(struct wiphy *wiphy, struct net_device *dev,
1015                         struct cfg80211_scan_request *request);
1016
1017         int     (*auth)(struct wiphy *wiphy, struct net_device *dev,
1018                         struct cfg80211_auth_request *req);
1019         int     (*assoc)(struct wiphy *wiphy, struct net_device *dev,
1020                          struct cfg80211_assoc_request *req);
1021         int     (*deauth)(struct wiphy *wiphy, struct net_device *dev,
1022                           struct cfg80211_deauth_request *req);
1023         int     (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
1024                             struct cfg80211_disassoc_request *req);
1025
1026         int     (*connect)(struct wiphy *wiphy, struct net_device *dev,
1027                            struct cfg80211_connect_params *sme);
1028         int     (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
1029                               u16 reason_code);
1030
1031         int     (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
1032                              struct cfg80211_ibss_params *params);
1033         int     (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
1034
1035         int     (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
1036
1037         int     (*set_tx_power)(struct wiphy *wiphy,
1038                                 enum tx_power_setting type, int dbm);
1039         int     (*get_tx_power)(struct wiphy *wiphy, int *dbm);
1040
1041         int     (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
1042                                 u8 *addr);
1043
1044         void    (*rfkill_poll)(struct wiphy *wiphy);
1045
1046 #ifdef CONFIG_NL80211_TESTMODE
1047         int     (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
1048 #endif
1049
1050         int     (*set_bitrate_mask)(struct wiphy *wiphy,
1051                                     struct net_device *dev,
1052                                     const u8 *peer,
1053                                     const struct cfg80211_bitrate_mask *mask);
1054
1055         /* some temporary stuff to finish wext */
1056         int     (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1057                                   bool enabled, int timeout);
1058 };
1059
1060 /*
1061  * wireless hardware and networking interfaces structures
1062  * and registration/helper functions
1063  */
1064
1065 /**
1066  * struct wiphy - wireless hardware description
1067  * @idx: the wiphy index assigned to this item
1068  * @class_dev: the class device representing /sys/class/ieee80211/<wiphy-name>
1069  * @custom_regulatory: tells us the driver for this device
1070  *      has its own custom regulatory domain and cannot identify the
1071  *      ISO / IEC 3166 alpha2 it belongs to. When this is enabled
1072  *      we will disregard the first regulatory hint (when the
1073  *      initiator is %REGDOM_SET_BY_CORE).
1074  * @strict_regulatory: tells us the driver for this device will ignore
1075  *      regulatory domain settings until it gets its own regulatory domain
1076  *      via its regulatory_hint(). After its gets its own regulatory domain
1077  *      it will only allow further regulatory domain settings to further
1078  *      enhance compliance. For example if channel 13 and 14 are disabled
1079  *      by this regulatory domain no user regulatory domain can enable these
1080  *      channels at a later time. This can be used for devices which do not
1081  *      have calibration information gauranteed for frequencies or settings
1082  *      outside of its regulatory domain.
1083  * @reg_notifier: the driver's regulatory notification callback
1084  * @regd: the driver's regulatory domain, if one was requested via
1085  *      the regulatory_hint() API. This can be used by the driver
1086  *      on the reg_notifier() if it chooses to ignore future
1087  *      regulatory domain changes caused by other drivers.
1088  * @signal_type: signal type reported in &struct cfg80211_bss.
1089  * @cipher_suites: supported cipher suites
1090  * @n_cipher_suites: number of supported cipher suites
1091  * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
1092  * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
1093  * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
1094  *      -1 = fragmentation disabled, only odd values >= 256 used
1095  * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
1096  */
1097 struct wiphy {
1098         /* assign these fields before you register the wiphy */
1099
1100         /* permanent MAC address */
1101         u8 perm_addr[ETH_ALEN];
1102
1103         /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
1104         u16 interface_modes;
1105
1106         bool custom_regulatory;
1107         bool strict_regulatory;
1108
1109         enum cfg80211_signal_type signal_type;
1110
1111         int bss_priv_size;
1112         u8 max_scan_ssids;
1113         u16 max_scan_ie_len;
1114
1115         int n_cipher_suites;
1116         const u32 *cipher_suites;
1117
1118         u8 retry_short;
1119         u8 retry_long;
1120         u32 frag_threshold;
1121         u32 rts_threshold;
1122
1123         /* If multiple wiphys are registered and you're handed e.g.
1124          * a regular netdev with assigned ieee80211_ptr, you won't
1125          * know whether it points to a wiphy your driver has registered
1126          * or not. Assign this to something global to your driver to
1127          * help determine whether you own this wiphy or not. */
1128         const void *privid;
1129
1130         struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
1131
1132         /* Lets us get back the wiphy on the callback */
1133         int (*reg_notifier)(struct wiphy *wiphy,
1134                             struct regulatory_request *request);
1135
1136         /* fields below are read-only, assigned by cfg80211 */
1137
1138         const struct ieee80211_regdomain *regd;
1139
1140         /* the item in /sys/class/ieee80211/ points to this,
1141          * you need use set_wiphy_dev() (see below) */
1142         struct device dev;
1143
1144         /* dir in debugfs: ieee80211/<wiphyname> */
1145         struct dentry *debugfsdir;
1146
1147         char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
1148 };
1149
1150 /**
1151  * wiphy_priv - return priv from wiphy
1152  *
1153  * @wiphy: the wiphy whose priv pointer to return
1154  */
1155 static inline void *wiphy_priv(struct wiphy *wiphy)
1156 {
1157         BUG_ON(!wiphy);
1158         return &wiphy->priv;
1159 }
1160
1161 /**
1162  * priv_to_wiphy - return the wiphy containing the priv
1163  *
1164  * @priv: a pointer previously returned by wiphy_priv
1165  */
1166 static inline struct wiphy *priv_to_wiphy(void *priv)
1167 {
1168         BUG_ON(!priv);
1169         return container_of(priv, struct wiphy, priv);
1170 }
1171
1172 /**
1173  * set_wiphy_dev - set device pointer for wiphy
1174  *
1175  * @wiphy: The wiphy whose device to bind
1176  * @dev: The device to parent it to
1177  */
1178 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
1179 {
1180         wiphy->dev.parent = dev;
1181 }
1182
1183 /**
1184  * wiphy_dev - get wiphy dev pointer
1185  *
1186  * @wiphy: The wiphy whose device struct to look up
1187  */
1188 static inline struct device *wiphy_dev(struct wiphy *wiphy)
1189 {
1190         return wiphy->dev.parent;
1191 }
1192
1193 /**
1194  * wiphy_name - get wiphy name
1195  *
1196  * @wiphy: The wiphy whose name to return
1197  */
1198 static inline const char *wiphy_name(struct wiphy *wiphy)
1199 {
1200         return dev_name(&wiphy->dev);
1201 }
1202
1203 /**
1204  * wiphy_new - create a new wiphy for use with cfg80211
1205  *
1206  * @ops: The configuration operations for this device
1207  * @sizeof_priv: The size of the private area to allocate
1208  *
1209  * Create a new wiphy and associate the given operations with it.
1210  * @sizeof_priv bytes are allocated for private use.
1211  *
1212  * The returned pointer must be assigned to each netdev's
1213  * ieee80211_ptr for proper operation.
1214  */
1215 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
1216
1217 /**
1218  * wiphy_register - register a wiphy with cfg80211
1219  *
1220  * @wiphy: The wiphy to register.
1221  *
1222  * Returns a non-negative wiphy index or a negative error code.
1223  */
1224 extern int wiphy_register(struct wiphy *wiphy);
1225
1226 /**
1227  * wiphy_unregister - deregister a wiphy from cfg80211
1228  *
1229  * @wiphy: The wiphy to unregister.
1230  *
1231  * After this call, no more requests can be made with this priv
1232  * pointer, but the call may sleep to wait for an outstanding
1233  * request that is being handled.
1234  */
1235 extern void wiphy_unregister(struct wiphy *wiphy);
1236
1237 /**
1238  * wiphy_free - free wiphy
1239  *
1240  * @wiphy: The wiphy to free
1241  */
1242 extern void wiphy_free(struct wiphy *wiphy);
1243
1244 /* internal struct */
1245 struct cfg80211_conn;
1246
1247 /**
1248  * struct wireless_dev - wireless per-netdev state
1249  *
1250  * This structure must be allocated by the driver/stack
1251  * that uses the ieee80211_ptr field in struct net_device
1252  * (this is intentional so it can be allocated along with
1253  * the netdev.)
1254  *
1255  * @wiphy: pointer to hardware description
1256  * @iftype: interface type
1257  * @list: (private) Used to collect the interfaces
1258  * @netdev: (private) Used to reference back to the netdev
1259  * @current_bss: (private) Used by the internal configuration code
1260  * @bssid: (private) Used by the internal configuration code
1261  * @ssid: (private) Used by the internal configuration code
1262  * @ssid_len: (private) Used by the internal configuration code
1263  * @wext: (private) Used by the internal wireless extensions compat code
1264  * @wext_bssid: (private) Used by the internal wireless extensions compat code
1265  */
1266 struct wireless_dev {
1267         struct wiphy *wiphy;
1268         enum nl80211_iftype iftype;
1269
1270         /* private to the generic wireless code */
1271         struct list_head list;
1272         struct net_device *netdev;
1273
1274         /* currently used for IBSS and SME - might be rearranged later */
1275         struct cfg80211_bss *current_bss;
1276         u8 ssid[IEEE80211_MAX_SSID_LEN];
1277         u8 ssid_len;
1278         enum {
1279                 CFG80211_SME_IDLE,
1280                 CFG80211_SME_CONNECTING,
1281                 CFG80211_SME_CONNECTED,
1282         } sme_state;
1283         struct cfg80211_conn *conn;
1284
1285 #ifdef CONFIG_WIRELESS_EXT
1286         /* wext data */
1287         struct {
1288                 union {
1289                         struct cfg80211_ibss_params ibss;
1290                         struct cfg80211_connect_params connect;
1291                 };
1292                 u8 *ie;
1293                 size_t ie_len;
1294                 u8 bssid[ETH_ALEN];
1295                 u8 ssid[IEEE80211_MAX_SSID_LEN];
1296                 s8 default_key, default_mgmt_key;
1297                 bool ps;
1298                 int ps_timeout;
1299         } wext;
1300 #endif
1301 };
1302
1303 /**
1304  * wdev_priv - return wiphy priv from wireless_dev
1305  *
1306  * @wdev: The wireless device whose wiphy's priv pointer to return
1307  */
1308 static inline void *wdev_priv(struct wireless_dev *wdev)
1309 {
1310         BUG_ON(!wdev);
1311         return wiphy_priv(wdev->wiphy);
1312 }
1313
1314 /*
1315  * Utility functions
1316  */
1317
1318 /**
1319  * ieee80211_channel_to_frequency - convert channel number to frequency
1320  */
1321 extern int ieee80211_channel_to_frequency(int chan);
1322
1323 /**
1324  * ieee80211_frequency_to_channel - convert frequency to channel number
1325  */
1326 extern int ieee80211_frequency_to_channel(int freq);
1327
1328 /*
1329  * Name indirection necessary because the ieee80211 code also has
1330  * a function named "ieee80211_get_channel", so if you include
1331  * cfg80211's header file you get cfg80211's version, if you try
1332  * to include both header files you'll (rightfully!) get a symbol
1333  * clash.
1334  */
1335 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
1336                                                          int freq);
1337 /**
1338  * ieee80211_get_channel - get channel struct from wiphy for specified frequency
1339  */
1340 static inline struct ieee80211_channel *
1341 ieee80211_get_channel(struct wiphy *wiphy, int freq)
1342 {
1343         return __ieee80211_get_channel(wiphy, freq);
1344 }
1345
1346 /**
1347  * ieee80211_get_response_rate - get basic rate for a given rate
1348  *
1349  * @sband: the band to look for rates in
1350  * @basic_rates: bitmap of basic rates
1351  * @bitrate: the bitrate for which to find the basic rate
1352  *
1353  * This function returns the basic rate corresponding to a given
1354  * bitrate, that is the next lower bitrate contained in the basic
1355  * rate map, which is, for this function, given as a bitmap of
1356  * indices of rates in the band's bitrate table.
1357  */
1358 struct ieee80211_rate *
1359 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
1360                             u32 basic_rates, int bitrate);
1361
1362 /*
1363  * Radiotap parsing functions -- for controlled injection support
1364  *
1365  * Implemented in net/wireless/radiotap.c
1366  * Documentation in Documentation/networking/radiotap-headers.txt
1367  */
1368
1369 /**
1370  * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
1371  * @rtheader: pointer to the radiotap header we are walking through
1372  * @max_length: length of radiotap header in cpu byte ordering
1373  * @this_arg_index: IEEE80211_RADIOTAP_... index of current arg
1374  * @this_arg: pointer to current radiotap arg
1375  * @arg_index: internal next argument index
1376  * @arg: internal next argument pointer
1377  * @next_bitmap: internal pointer to next present u32
1378  * @bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
1379  */
1380
1381 struct ieee80211_radiotap_iterator {
1382         struct ieee80211_radiotap_header *rtheader;
1383         int max_length;
1384         int this_arg_index;
1385         u8 *this_arg;
1386
1387         int arg_index;
1388         u8 *arg;
1389         __le32 *next_bitmap;
1390         u32 bitmap_shifter;
1391 };
1392
1393 extern int ieee80211_radiotap_iterator_init(
1394    struct ieee80211_radiotap_iterator *iterator,
1395    struct ieee80211_radiotap_header *radiotap_header,
1396    int max_length);
1397
1398 extern int ieee80211_radiotap_iterator_next(
1399    struct ieee80211_radiotap_iterator *iterator);
1400
1401 extern const unsigned char rfc1042_header[6];
1402 extern const unsigned char bridge_tunnel_header[6];
1403
1404 /**
1405  * ieee80211_get_hdrlen_from_skb - get header length from data
1406  *
1407  * Given an skb with a raw 802.11 header at the data pointer this function
1408  * returns the 802.11 header length in bytes (not including encryption
1409  * headers). If the data in the sk_buff is too short to contain a valid 802.11
1410  * header the function returns 0.
1411  *
1412  * @skb: the frame
1413  */
1414 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1415
1416 /**
1417  * ieee80211_hdrlen - get header length in bytes from frame control
1418  * @fc: frame control field in little-endian format
1419  */
1420 unsigned int ieee80211_hdrlen(__le16 fc);
1421
1422 /**
1423  * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
1424  * @skb: the 802.11 data frame
1425  * @addr: the device MAC address
1426  * @iftype: the virtual interface type
1427  */
1428 int ieee80211_data_to_8023(struct sk_buff *skb, u8 *addr,
1429                            enum nl80211_iftype iftype);
1430
1431 /**
1432  * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
1433  * @skb: the 802.3 frame
1434  * @addr: the device MAC address
1435  * @iftype: the virtual interface type
1436  * @bssid: the network bssid (used only for iftype STATION and ADHOC)
1437  * @qos: build 802.11 QoS data frame
1438  */
1439 int ieee80211_data_from_8023(struct sk_buff *skb, u8 *addr,
1440                              enum nl80211_iftype iftype, u8 *bssid, bool qos);
1441
1442 /**
1443  * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
1444  * @skb: the data frame
1445  */
1446 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
1447
1448 /*
1449  * Regulatory helper functions for wiphys
1450  */
1451
1452 /**
1453  * regulatory_hint - driver hint to the wireless core a regulatory domain
1454  * @wiphy: the wireless device giving the hint (used only for reporting
1455  *      conflicts)
1456  * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
1457  *      should be in. If @rd is set this should be NULL. Note that if you
1458  *      set this to NULL you should still set rd->alpha2 to some accepted
1459  *      alpha2.
1460  *
1461  * Wireless drivers can use this function to hint to the wireless core
1462  * what it believes should be the current regulatory domain by
1463  * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
1464  * domain should be in or by providing a completely build regulatory domain.
1465  * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
1466  * for a regulatory domain structure for the respective country.
1467  *
1468  * The wiphy must have been registered to cfg80211 prior to this call.
1469  * For cfg80211 drivers this means you must first use wiphy_register(),
1470  * for mac80211 drivers you must first use ieee80211_register_hw().
1471  *
1472  * Drivers should check the return value, its possible you can get
1473  * an -ENOMEM.
1474  */
1475 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
1476
1477 /**
1478  * regulatory_hint_11d - hints a country IE as a regulatory domain
1479  * @wiphy: the wireless device giving the hint (used only for reporting
1480  *      conflicts)
1481  * @country_ie: pointer to the country IE
1482  * @country_ie_len: length of the country IE
1483  *
1484  * We will intersect the rd with the what CRDA tells us should apply
1485  * for the alpha2 this country IE belongs to, this prevents APs from
1486  * sending us incorrect or outdated information against a country.
1487  */
1488 extern void regulatory_hint_11d(struct wiphy *wiphy,
1489                                 u8 *country_ie,
1490                                 u8 country_ie_len);
1491 /**
1492  * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
1493  * @wiphy: the wireless device we want to process the regulatory domain on
1494  * @regd: the custom regulatory domain to use for this wiphy
1495  *
1496  * Drivers can sometimes have custom regulatory domains which do not apply
1497  * to a specific country. Drivers can use this to apply such custom regulatory
1498  * domains. This routine must be called prior to wiphy registration. The
1499  * custom regulatory domain will be trusted completely and as such previous
1500  * default channel settings will be disregarded. If no rule is found for a
1501  * channel on the regulatory domain the channel will be disabled.
1502  */
1503 extern void wiphy_apply_custom_regulatory(
1504         struct wiphy *wiphy,
1505         const struct ieee80211_regdomain *regd);
1506
1507 /**
1508  * freq_reg_info - get regulatory information for the given frequency
1509  * @wiphy: the wiphy for which we want to process this rule for
1510  * @center_freq: Frequency in KHz for which we want regulatory information for
1511  * @desired_bw_khz: the desired max bandwidth you want to use per
1512  *      channel. Note that this is still 20 MHz if you want to use HT40
1513  *      as HT40 makes use of two channels for its 40 MHz width bandwidth.
1514  *      If set to 0 we'll assume you want the standard 20 MHz.
1515  * @reg_rule: the regulatory rule which we have for this frequency
1516  *
1517  * Use this function to get the regulatory rule for a specific frequency on
1518  * a given wireless device. If the device has a specific regulatory domain
1519  * it wants to follow we respect that unless a country IE has been received
1520  * and processed already.
1521  *
1522  * Returns 0 if it was able to find a valid regulatory rule which does
1523  * apply to the given center_freq otherwise it returns non-zero. It will
1524  * also return -ERANGE if we determine the given center_freq does not even have
1525  * a regulatory rule for a frequency range in the center_freq's band. See
1526  * freq_in_rule_band() for our current definition of a band -- this is purely
1527  * subjective and right now its 802.11 specific.
1528  */
1529 extern int freq_reg_info(struct wiphy *wiphy,
1530                          u32 center_freq,
1531                          u32 desired_bw_khz,
1532                          const struct ieee80211_reg_rule **reg_rule);
1533
1534 /*
1535  * Temporary wext handlers & helper functions
1536  *
1537  * In the future cfg80211 will simply assign the entire wext handler
1538  * structure to netdevs it manages, but we're not there yet.
1539  */
1540 int cfg80211_wext_giwname(struct net_device *dev,
1541                           struct iw_request_info *info,
1542                           char *name, char *extra);
1543 int cfg80211_wext_siwmode(struct net_device *dev, struct iw_request_info *info,
1544                           u32 *mode, char *extra);
1545 int cfg80211_wext_giwmode(struct net_device *dev, struct iw_request_info *info,
1546                           u32 *mode, char *extra);
1547 int cfg80211_wext_siwscan(struct net_device *dev,
1548                           struct iw_request_info *info,
1549                           union iwreq_data *wrqu, char *extra);
1550 int cfg80211_wext_giwscan(struct net_device *dev,
1551                           struct iw_request_info *info,
1552                           struct iw_point *data, char *extra);
1553 int cfg80211_wext_siwmlme(struct net_device *dev,
1554                           struct iw_request_info *info,
1555                           struct iw_point *data, char *extra);
1556 int cfg80211_wext_giwrange(struct net_device *dev,
1557                            struct iw_request_info *info,
1558                            struct iw_point *data, char *extra);
1559 int cfg80211_ibss_wext_siwfreq(struct net_device *dev,
1560                                struct iw_request_info *info,
1561                                struct iw_freq *freq, char *extra);
1562 int cfg80211_ibss_wext_giwfreq(struct net_device *dev,
1563                                struct iw_request_info *info,
1564                                struct iw_freq *freq, char *extra);
1565 int cfg80211_ibss_wext_siwessid(struct net_device *dev,
1566                                 struct iw_request_info *info,
1567                                 struct iw_point *data, char *ssid);
1568 int cfg80211_ibss_wext_giwessid(struct net_device *dev,
1569                                 struct iw_request_info *info,
1570                                 struct iw_point *data, char *ssid);
1571 int cfg80211_ibss_wext_siwap(struct net_device *dev,
1572                              struct iw_request_info *info,
1573                              struct sockaddr *ap_addr, char *extra);
1574 int cfg80211_ibss_wext_giwap(struct net_device *dev,
1575                              struct iw_request_info *info,
1576                              struct sockaddr *ap_addr, char *extra);
1577
1578 int cfg80211_mgd_wext_siwfreq(struct net_device *dev,
1579                               struct iw_request_info *info,
1580                               struct iw_freq *freq, char *extra);
1581 int cfg80211_mgd_wext_giwfreq(struct net_device *dev,
1582                               struct iw_request_info *info,
1583                               struct iw_freq *freq, char *extra);
1584 int cfg80211_mgd_wext_siwessid(struct net_device *dev,
1585                                struct iw_request_info *info,
1586                                struct iw_point *data, char *ssid);
1587 int cfg80211_mgd_wext_giwessid(struct net_device *dev,
1588                                struct iw_request_info *info,
1589                                struct iw_point *data, char *ssid);
1590 int cfg80211_mgd_wext_siwap(struct net_device *dev,
1591                             struct iw_request_info *info,
1592                             struct sockaddr *ap_addr, char *extra);
1593 int cfg80211_mgd_wext_giwap(struct net_device *dev,
1594                             struct iw_request_info *info,
1595                             struct sockaddr *ap_addr, char *extra);
1596 int cfg80211_wext_siwgenie(struct net_device *dev,
1597                            struct iw_request_info *info,
1598                            struct iw_point *data, char *extra);
1599 int cfg80211_wext_siwauth(struct net_device *dev,
1600                           struct iw_request_info *info,
1601                           struct iw_param *data, char *extra);
1602 int cfg80211_wext_giwauth(struct net_device *dev,
1603                           struct iw_request_info *info,
1604                           struct iw_param *data, char *extra);
1605
1606 struct ieee80211_channel *cfg80211_wext_freq(struct wiphy *wiphy,
1607                                              struct iw_freq *freq);
1608
1609 int cfg80211_wext_siwrate(struct net_device *dev,
1610                           struct iw_request_info *info,
1611                           struct iw_param *rate, char *extra);
1612 int cfg80211_wext_giwrate(struct net_device *dev,
1613                           struct iw_request_info *info,
1614                           struct iw_param *rate, char *extra);
1615
1616 int cfg80211_wext_siwrts(struct net_device *dev,
1617                          struct iw_request_info *info,
1618                          struct iw_param *rts, char *extra);
1619 int cfg80211_wext_giwrts(struct net_device *dev,
1620                          struct iw_request_info *info,
1621                          struct iw_param *rts, char *extra);
1622 int cfg80211_wext_siwfrag(struct net_device *dev,
1623                           struct iw_request_info *info,
1624                           struct iw_param *frag, char *extra);
1625 int cfg80211_wext_giwfrag(struct net_device *dev,
1626                           struct iw_request_info *info,
1627                           struct iw_param *frag, char *extra);
1628 int cfg80211_wext_siwretry(struct net_device *dev,
1629                            struct iw_request_info *info,
1630                            struct iw_param *retry, char *extra);
1631 int cfg80211_wext_giwretry(struct net_device *dev,
1632                            struct iw_request_info *info,
1633                            struct iw_param *retry, char *extra);
1634 int cfg80211_wext_siwencodeext(struct net_device *dev,
1635                                struct iw_request_info *info,
1636                                struct iw_point *erq, char *extra);
1637 int cfg80211_wext_siwencode(struct net_device *dev,
1638                             struct iw_request_info *info,
1639                             struct iw_point *erq, char *keybuf);
1640 int cfg80211_wext_giwencode(struct net_device *dev,
1641                             struct iw_request_info *info,
1642                             struct iw_point *erq, char *keybuf);
1643 int cfg80211_wext_siwtxpower(struct net_device *dev,
1644                              struct iw_request_info *info,
1645                              union iwreq_data *data, char *keybuf);
1646 int cfg80211_wext_giwtxpower(struct net_device *dev,
1647                              struct iw_request_info *info,
1648                              union iwreq_data *data, char *keybuf);
1649 struct iw_statistics *cfg80211_wireless_stats(struct net_device *dev);
1650
1651 int cfg80211_wext_siwpower(struct net_device *dev,
1652                            struct iw_request_info *info,
1653                            struct iw_param *wrq, char *extra);
1654 int cfg80211_wext_giwpower(struct net_device *dev,
1655                            struct iw_request_info *info,
1656                            struct iw_param *wrq, char *extra);
1657
1658 int cfg80211_wds_wext_siwap(struct net_device *dev,
1659                             struct iw_request_info *info,
1660                             struct sockaddr *addr, char *extra);
1661 int cfg80211_wds_wext_giwap(struct net_device *dev,
1662                             struct iw_request_info *info,
1663                             struct sockaddr *addr, char *extra);
1664
1665 /*
1666  * callbacks for asynchronous cfg80211 methods, notification
1667  * functions and BSS handling helpers
1668  */
1669
1670 /**
1671  * cfg80211_scan_done - notify that scan finished
1672  *
1673  * @request: the corresponding scan request
1674  * @aborted: set to true if the scan was aborted for any reason,
1675  *      userspace will be notified of that
1676  */
1677 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
1678
1679 /**
1680  * cfg80211_inform_bss - inform cfg80211 of a new BSS
1681  *
1682  * @wiphy: the wiphy reporting the BSS
1683  * @bss: the found BSS
1684  * @signal: the signal strength, type depends on the wiphy's signal_type
1685  * @gfp: context flags
1686  *
1687  * This informs cfg80211 that BSS information was found and
1688  * the BSS should be updated/added.
1689  */
1690 struct cfg80211_bss*
1691 cfg80211_inform_bss_frame(struct wiphy *wiphy,
1692                           struct ieee80211_channel *channel,
1693                           struct ieee80211_mgmt *mgmt, size_t len,
1694                           s32 signal, gfp_t gfp);
1695
1696 struct cfg80211_bss*
1697 cfg80211_inform_bss(struct wiphy *wiphy,
1698                     struct ieee80211_channel *channel,
1699                     const u8 *bssid,
1700                     u64 timestamp, u16 capability, u16 beacon_interval,
1701                     const u8 *ie, size_t ielen,
1702                     s32 signal, gfp_t gfp);
1703
1704 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
1705                                       struct ieee80211_channel *channel,
1706                                       const u8 *bssid,
1707                                       const u8 *ssid, size_t ssid_len,
1708                                       u16 capa_mask, u16 capa_val);
1709 static inline struct cfg80211_bss *
1710 cfg80211_get_ibss(struct wiphy *wiphy,
1711                   struct ieee80211_channel *channel,
1712                   const u8 *ssid, size_t ssid_len)
1713 {
1714         return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
1715                                 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
1716 }
1717
1718 struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
1719                                        struct ieee80211_channel *channel,
1720                                        const u8 *meshid, size_t meshidlen,
1721                                        const u8 *meshcfg);
1722 void cfg80211_put_bss(struct cfg80211_bss *bss);
1723
1724 /**
1725  * cfg80211_unlink_bss - unlink BSS from internal data structures
1726  * @wiphy: the wiphy
1727  * @bss: the bss to remove
1728  *
1729  * This function removes the given BSS from the internal data structures
1730  * thereby making it no longer show up in scan results etc. Use this
1731  * function when you detect a BSS is gone. Normally BSSes will also time
1732  * out, so it is not necessary to use this function at all.
1733  */
1734 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
1735
1736 /**
1737  * cfg80211_send_rx_auth - notification of processed authentication
1738  * @dev: network device
1739  * @buf: authentication frame (header + body)
1740  * @len: length of the frame data
1741  * @gfp: allocation flags
1742  *
1743  * This function is called whenever an authentication has been processed in
1744  * station mode. The driver is required to call either this function or
1745  * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
1746  * call.
1747  */
1748 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len, gfp_t gfp);
1749
1750 /**
1751  * cfg80211_send_auth_timeout - notification of timed out authentication
1752  * @dev: network device
1753  * @addr: The MAC address of the device with which the authentication timed out
1754  * @gfp: allocation flags
1755  */
1756 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr, gfp_t gfp);
1757
1758 /**
1759  * cfg80211_send_rx_assoc - notification of processed association
1760  * @dev: network device
1761  * @buf: (re)association response frame (header + body)
1762  * @len: length of the frame data
1763  * @gfp: allocation flags
1764  *
1765  * This function is called whenever a (re)association response has been
1766  * processed in station mode. The driver is required to call either this
1767  * function or cfg80211_send_assoc_timeout() to indicate the result of
1768  * cfg80211_ops::assoc() call.
1769  */
1770 void cfg80211_send_rx_assoc(struct net_device *dev, const u8 *buf, size_t len, gfp_t gfp);
1771
1772 /**
1773  * cfg80211_send_assoc_timeout - notification of timed out association
1774  * @dev: network device
1775  * @addr: The MAC address of the device with which the association timed out
1776  * @gfp: allocation flags
1777  */
1778 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr, gfp_t gfp);
1779
1780 /**
1781  * cfg80211_send_deauth - notification of processed deauthentication
1782  * @dev: network device
1783  * @buf: deauthentication frame (header + body)
1784  * @len: length of the frame data
1785  * @gfp: allocation flags
1786  *
1787  * This function is called whenever deauthentication has been processed in
1788  * station mode. This includes both received deauthentication frames and
1789  * locally generated ones.
1790  */
1791 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len, gfp_t gfp);
1792
1793 /**
1794  * cfg80211_send_disassoc - notification of processed disassociation
1795  * @dev: network device
1796  * @buf: disassociation response frame (header + body)
1797  * @len: length of the frame data
1798  * @gfp: allocation flags
1799  *
1800  * This function is called whenever disassociation has been processed in
1801  * station mode. This includes both received disassociation frames and locally
1802  * generated ones.
1803  */
1804 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len, gfp_t gfp);
1805
1806 /**
1807  * cfg80211_hold_bss - exclude bss from expiration
1808  * @bss: bss which should not expire
1809  *
1810  * In a case when the BSS is not updated but it shouldn't expire this
1811  * function can be used to mark the BSS to be excluded from expiration.
1812  */
1813 void cfg80211_hold_bss(struct cfg80211_bss *bss);
1814
1815 /**
1816  * cfg80211_unhold_bss - remove expiration exception from the BSS
1817  * @bss: bss which can expire again
1818  *
1819  * This function marks the BSS to be expirable again.
1820  */
1821 void cfg80211_unhold_bss(struct cfg80211_bss *bss);
1822
1823 /**
1824  * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
1825  * @dev: network device
1826  * @addr: The source MAC address of the frame
1827  * @key_type: The key type that the received frame used
1828  * @key_id: Key identifier (0..3)
1829  * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
1830  * @gfp: allocation flags
1831  *
1832  * This function is called whenever the local MAC detects a MIC failure in a
1833  * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
1834  * primitive.
1835  */
1836 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
1837                                   enum nl80211_key_type key_type, int key_id,
1838                                   const u8 *tsc, gfp_t gfp);
1839
1840 /**
1841  * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
1842  *
1843  * @dev: network device
1844  * @bssid: the BSSID of the IBSS joined
1845  * @gfp: allocation flags
1846  *
1847  * This function notifies cfg80211 that the device joined an IBSS or
1848  * switched to a different BSSID. Before this function can be called,
1849  * either a beacon has to have been received from the IBSS, or one of
1850  * the cfg80211_inform_bss{,_frame} functions must have been called
1851  * with the locally generated beacon -- this guarantees that there is
1852  * always a scan result for this IBSS. cfg80211 will handle the rest.
1853  */
1854 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
1855
1856 /**
1857  * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
1858  * @wiphy: the wiphy
1859  * @blocked: block status
1860  */
1861 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
1862
1863 /**
1864  * wiphy_rfkill_start_polling - start polling rfkill
1865  * @wiphy: the wiphy
1866  */
1867 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
1868
1869 /**
1870  * wiphy_rfkill_stop_polling - stop polling rfkill
1871  * @wiphy: the wiphy
1872  */
1873 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
1874
1875 #ifdef CONFIG_NL80211_TESTMODE
1876 /**
1877  * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
1878  * @wiphy: the wiphy
1879  * @approxlen: an upper bound of the length of the data that will
1880  *      be put into the skb
1881  *
1882  * This function allocates and pre-fills an skb for a reply to
1883  * the testmode command. Since it is intended for a reply, calling
1884  * it outside of the @testmode_cmd operation is invalid.
1885  *
1886  * The returned skb (or %NULL if any errors happen) is pre-filled
1887  * with the wiphy index and set up in a way that any data that is
1888  * put into the skb (with skb_put(), nla_put() or similar) will end
1889  * up being within the %NL80211_ATTR_TESTDATA attribute, so all that
1890  * needs to be done with the skb is adding data for the corresponding
1891  * userspace tool which can then read that data out of the testdata
1892  * attribute. You must not modify the skb in any other way.
1893  *
1894  * When done, call cfg80211_testmode_reply() with the skb and return
1895  * its error code as the result of the @testmode_cmd operation.
1896  */
1897 struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
1898                                                   int approxlen);
1899
1900 /**
1901  * cfg80211_testmode_reply - send the reply skb
1902  * @skb: The skb, must have been allocated with
1903  *      cfg80211_testmode_alloc_reply_skb()
1904  *
1905  * Returns an error code or 0 on success, since calling this
1906  * function will usually be the last thing before returning
1907  * from the @testmode_cmd you should return the error code.
1908  * Note that this function consumes the skb regardless of the
1909  * return value.
1910  */
1911 int cfg80211_testmode_reply(struct sk_buff *skb);
1912
1913 /**
1914  * cfg80211_testmode_alloc_event_skb - allocate testmode event
1915  * @wiphy: the wiphy
1916  * @approxlen: an upper bound of the length of the data that will
1917  *      be put into the skb
1918  * @gfp: allocation flags
1919  *
1920  * This function allocates and pre-fills an skb for an event on the
1921  * testmode multicast group.
1922  *
1923  * The returned skb (or %NULL if any errors happen) is set up in the
1924  * same way as with cfg80211_testmode_alloc_reply_skb() but prepared
1925  * for an event. As there, you should simply add data to it that will
1926  * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must
1927  * not modify the skb in any other way.
1928  *
1929  * When done filling the skb, call cfg80211_testmode_event() with the
1930  * skb to send the event.
1931  */
1932 struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
1933                                                   int approxlen, gfp_t gfp);
1934
1935 /**
1936  * cfg80211_testmode_event - send the event
1937  * @skb: The skb, must have been allocated with
1938  *      cfg80211_testmode_alloc_event_skb()
1939  * @gfp: allocation flags
1940  *
1941  * This function sends the given @skb, which must have been allocated
1942  * by cfg80211_testmode_alloc_event_skb(), as an event. It always
1943  * consumes it.
1944  */
1945 void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
1946
1947 #define CFG80211_TESTMODE_CMD(cmd)      .testmode_cmd = (cmd),
1948 #else
1949 #define CFG80211_TESTMODE_CMD(cmd)
1950 #endif
1951
1952 /**
1953  * cfg80211_connect_result - notify cfg80211 of connection result
1954  *
1955  * @dev: network device
1956  * @bssid: the BSSID of the AP
1957  * @req_ie: association request IEs (maybe be %NULL)
1958  * @req_ie_len: association request IEs length
1959  * @resp_ie: association response IEs (may be %NULL)
1960  * @resp_ie_len: assoc response IEs length
1961  * @status: status code, 0 for successful connection, use
1962  *      %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
1963  *      the real status code for failures.
1964  * @gfp: allocation flags
1965  *
1966  * It should be called by the underlying driver whenever connect() has
1967  * succeeded.
1968  */
1969 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
1970                              const u8 *req_ie, size_t req_ie_len,
1971                              const u8 *resp_ie, size_t resp_ie_len,
1972                              u16 status, gfp_t gfp);
1973
1974 /**
1975  * cfg80211_roamed - notify cfg80211 of roaming
1976  *
1977  * @dev: network device
1978  * @bssid: the BSSID of the new AP
1979  * @req_ie: association request IEs (maybe be %NULL)
1980  * @req_ie_len: association request IEs length
1981  * @resp_ie: association response IEs (may be %NULL)
1982  * @resp_ie_len: assoc response IEs length
1983  * @gfp: allocation flags
1984  *
1985  * It should be called by the underlying driver whenever it roamed
1986  * from one AP to another while connected.
1987  */
1988 void cfg80211_roamed(struct net_device *dev, const u8 *bssid,
1989                      const u8 *req_ie, size_t req_ie_len,
1990                      const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
1991
1992 /**
1993  * cfg80211_disconnected - notify cfg80211 that connection was dropped
1994  *
1995  * @dev: network device
1996  * @ie: information elements of the deauth/disassoc frame (may be %NULL)
1997  * @ie_len: length of IEs
1998  * @reason: reason code for the disconnection, set it to 0 if unknown
1999  * @gfp: allocation flags
2000  *
2001  * After it calls this function, the driver should enter an idle state
2002  * and not try to connect to any AP any more.
2003  */
2004 void cfg80211_disconnected(struct net_device *dev, u16 reason,
2005                            u8 *ie, size_t ie_len, gfp_t gfp);
2006
2007
2008 #endif /* __NET_CFG80211_H */