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