cfg80211: remove wireless_dev->bssid
[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,
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_auth_request - Authentication request data
609  *
610  * This structure provides information needed to complete IEEE 802.11
611  * authentication.
612  * NOTE: This structure will likely change when more code from mac80211 is
613  * moved into cfg80211 so that non-mac80211 drivers can benefit from it, too.
614  * Before using this in a driver that does not use mac80211, it would be better
615  * to check the status of that work and better yet, volunteer to work on it.
616  *
617  * @chan: The channel to use or %NULL if not specified (auto-select based on
618  *      scan results)
619  * @peer_addr: The address of the peer STA (AP BSSID in infrastructure case);
620  *      this field is required to be present; if the driver wants to help with
621  *      BSS selection, it should use (yet to be added) MLME event to allow user
622  *      space SME to be notified of roaming candidate, so that the SME can then
623  *      use the authentication request with the recommended BSSID and whatever
624  *      other data may be needed for authentication/association
625  * @ssid: SSID or %NULL if not yet available
626  * @ssid_len: Length of ssid in octets
627  * @auth_type: Authentication type (algorithm)
628  * @ie: Extra IEs to add to Authentication frame or %NULL
629  * @ie_len: Length of ie buffer in octets
630  */
631 struct cfg80211_auth_request {
632         struct ieee80211_channel *chan;
633         u8 *peer_addr;
634         const u8 *ssid;
635         size_t ssid_len;
636         enum nl80211_auth_type auth_type;
637         const u8 *ie;
638         size_t ie_len;
639 };
640
641 /**
642  * struct cfg80211_assoc_request - (Re)Association request data
643  *
644  * This structure provides information needed to complete IEEE 802.11
645  * (re)association.
646  * NOTE: This structure will likely change when more code from mac80211 is
647  * moved into cfg80211 so that non-mac80211 drivers can benefit from it, too.
648  * Before using this in a driver that does not use mac80211, it would be better
649  * to check the status of that work and better yet, volunteer to work on it.
650  *
651  * @chan: The channel to use or %NULL if not specified (auto-select based on
652  *      scan results)
653  * @peer_addr: The address of the peer STA (AP BSSID); this field is required
654  *      to be present and the STA must be in State 2 (authenticated) with the
655  *      peer STA
656  * @ssid: SSID
657  * @ssid_len: Length of ssid in octets
658  * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
659  * @ie_len: Length of ie buffer in octets
660  * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
661  * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
662  *      sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
663  *      required to assume that the port is unauthorized until authorized by
664  *      user space. Otherwise, port is marked authorized by default.
665  */
666 struct cfg80211_assoc_request {
667         struct ieee80211_channel *chan;
668         u8 *peer_addr;
669         const u8 *ssid;
670         size_t ssid_len;
671         const u8 *ie;
672         size_t ie_len;
673         bool use_mfp;
674         bool control_port;
675 };
676
677 /**
678  * struct cfg80211_deauth_request - Deauthentication request data
679  *
680  * This structure provides information needed to complete IEEE 802.11
681  * deauthentication.
682  *
683  * @peer_addr: The address of the peer STA (AP BSSID); this field is required
684  *      to be present and the STA must be authenticated with the peer STA
685  * @ie: Extra IEs to add to Deauthentication frame or %NULL
686  * @ie_len: Length of ie buffer in octets
687  */
688 struct cfg80211_deauth_request {
689         u8 *peer_addr;
690         u16 reason_code;
691         const u8 *ie;
692         size_t ie_len;
693 };
694
695 /**
696  * struct cfg80211_disassoc_request - Disassociation request data
697  *
698  * This structure provides information needed to complete IEEE 802.11
699  * disassocation.
700  *
701  * @peer_addr: The address of the peer STA (AP BSSID); this field is required
702  *      to be present and the STA must be associated with the peer STA
703  * @ie: Extra IEs to add to Disassociation frame or %NULL
704  * @ie_len: Length of ie buffer in octets
705  */
706 struct cfg80211_disassoc_request {
707         u8 *peer_addr;
708         u16 reason_code;
709         const u8 *ie;
710         size_t ie_len;
711 };
712
713 /**
714  * struct cfg80211_ibss_params - IBSS parameters
715  *
716  * This structure defines the IBSS parameters for the join_ibss()
717  * method.
718  *
719  * @ssid: The SSID, will always be non-null.
720  * @ssid_len: The length of the SSID, will always be non-zero.
721  * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
722  *      search for IBSSs with a different BSSID.
723  * @channel: The channel to use if no IBSS can be found to join.
724  * @channel_fixed: The channel should be fixed -- do not search for
725  *      IBSSs to join on other channels.
726  * @ie: information element(s) to include in the beacon
727  * @ie_len: length of that
728  * @beacon_interval: beacon interval to use
729  */
730 struct cfg80211_ibss_params {
731         u8 *ssid;
732         u8 *bssid;
733         struct ieee80211_channel *channel;
734         u8 *ie;
735         u8 ssid_len, ie_len;
736         u16 beacon_interval;
737         bool channel_fixed;
738 };
739
740 /**
741  * enum wiphy_params_flags - set_wiphy_params bitfield values
742  * WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
743  * WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
744  * WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
745  * WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
746  */
747 enum wiphy_params_flags {
748         WIPHY_PARAM_RETRY_SHORT         = 1 << 0,
749         WIPHY_PARAM_RETRY_LONG          = 1 << 1,
750         WIPHY_PARAM_FRAG_THRESHOLD      = 1 << 2,
751         WIPHY_PARAM_RTS_THRESHOLD       = 1 << 3,
752 };
753
754 /**
755  * enum tx_power_setting - TX power adjustment
756  *
757  * @TX_POWER_AUTOMATIC: the dbm parameter is ignored
758  * @TX_POWER_LIMITED: limit TX power by the dbm parameter
759  * @TX_POWER_FIXED: fix TX power to the dbm parameter
760  */
761 enum tx_power_setting {
762         TX_POWER_AUTOMATIC,
763         TX_POWER_LIMITED,
764         TX_POWER_FIXED,
765 };
766
767 /**
768  * struct cfg80211_ops - backend description for wireless configuration
769  *
770  * This struct is registered by fullmac card drivers and/or wireless stacks
771  * in order to handle configuration requests on their interfaces.
772  *
773  * All callbacks except where otherwise noted should return 0
774  * on success or a negative error code.
775  *
776  * All operations are currently invoked under rtnl for consistency with the
777  * wireless extensions but this is subject to reevaluation as soon as this
778  * code is used more widely and we have a first user without wext.
779  *
780  * @suspend: wiphy device needs to be suspended
781  * @resume: wiphy device needs to be resumed
782  *
783  * @add_virtual_intf: create a new virtual interface with the given name,
784  *      must set the struct wireless_dev's iftype.
785  *
786  * @del_virtual_intf: remove the virtual interface determined by ifindex.
787  *
788  * @change_virtual_intf: change type/configuration of virtual interface,
789  *      keep the struct wireless_dev's iftype updated.
790  *
791  * @add_key: add a key with the given parameters. @mac_addr will be %NULL
792  *      when adding a group key.
793  *
794  * @get_key: get information about the key with the given parameters.
795  *      @mac_addr will be %NULL when requesting information for a group
796  *      key. All pointers given to the @callback function need not be valid
797  *      after it returns. This function should return an error if it is
798  *      not possible to retrieve the key, -ENOENT if it doesn't exist.
799  *
800  * @del_key: remove a key given the @mac_addr (%NULL for a group key)
801  *      and @key_index, return -ENOENT if the key doesn't exist.
802  *
803  * @set_default_key: set the default key on an interface
804  *
805  * @set_default_mgmt_key: set the default management frame key on an interface
806  *
807  * @add_beacon: Add a beacon with given parameters, @head, @interval
808  *      and @dtim_period will be valid, @tail is optional.
809  * @set_beacon: Change the beacon parameters for an access point mode
810  *      interface. This should reject the call when no beacon has been
811  *      configured.
812  * @del_beacon: Remove beacon configuration and stop sending the beacon.
813  *
814  * @add_station: Add a new station.
815  *
816  * @del_station: Remove a station; @mac may be NULL to remove all stations.
817  *
818  * @change_station: Modify a given station.
819  *
820  * @get_mesh_params: Put the current mesh parameters into *params
821  *
822  * @set_mesh_params: Set mesh parameters.
823  *      The mask is a bitfield which tells us which parameters to
824  *      set, and which to leave alone.
825  *
826  * @set_mesh_cfg: set mesh parameters (by now, just mesh id)
827  *
828  * @change_bss: Modify parameters for a given BSS.
829  *
830  * @set_txq_params: Set TX queue parameters
831  *
832  * @set_channel: Set channel
833  *
834  * @scan: Request to do a scan. If returning zero, the scan request is given
835  *      the driver, and will be valid until passed to cfg80211_scan_done().
836  *      For scan results, call cfg80211_inform_bss(); you can call this outside
837  *      the scan/scan_done bracket too.
838  *
839  * @auth: Request to authenticate with the specified peer
840  * @assoc: Request to (re)associate with the specified peer
841  * @deauth: Request to deauthenticate from the specified peer
842  * @disassoc: Request to disassociate from the specified peer
843  *
844  * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
845  *      cfg80211_ibss_joined(), also call that function when changing BSSID due
846  *      to a merge.
847  * @leave_ibss: Leave the IBSS.
848  *
849  * @set_wiphy_params: Notify that wiphy parameters have changed;
850  *      @changed bitfield (see &enum wiphy_params_flags) describes which values
851  *      have changed. The actual parameter values are available in
852  *      struct wiphy. If returning an error, no value should be changed.
853  *
854  * @set_tx_power: set the transmit power according to the parameters
855  * @get_tx_power: store the current TX power into the dbm variable;
856  *      return 0 if successful
857  *
858  * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
859  *      functions to adjust rfkill hw state
860  */
861 struct cfg80211_ops {
862         int     (*suspend)(struct wiphy *wiphy);
863         int     (*resume)(struct wiphy *wiphy);
864
865         int     (*add_virtual_intf)(struct wiphy *wiphy, char *name,
866                                     enum nl80211_iftype type, u32 *flags,
867                                     struct vif_params *params);
868         int     (*del_virtual_intf)(struct wiphy *wiphy, int ifindex);
869         int     (*change_virtual_intf)(struct wiphy *wiphy,
870                                        struct net_device *dev,
871                                        enum nl80211_iftype type, u32 *flags,
872                                        struct vif_params *params);
873
874         int     (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
875                            u8 key_index, const u8 *mac_addr,
876                            struct key_params *params);
877         int     (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
878                            u8 key_index, const u8 *mac_addr, void *cookie,
879                            void (*callback)(void *cookie, struct key_params*));
880         int     (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
881                            u8 key_index, const u8 *mac_addr);
882         int     (*set_default_key)(struct wiphy *wiphy,
883                                    struct net_device *netdev,
884                                    u8 key_index);
885         int     (*set_default_mgmt_key)(struct wiphy *wiphy,
886                                         struct net_device *netdev,
887                                         u8 key_index);
888
889         int     (*add_beacon)(struct wiphy *wiphy, struct net_device *dev,
890                               struct beacon_parameters *info);
891         int     (*set_beacon)(struct wiphy *wiphy, struct net_device *dev,
892                               struct beacon_parameters *info);
893         int     (*del_beacon)(struct wiphy *wiphy, struct net_device *dev);
894
895
896         int     (*add_station)(struct wiphy *wiphy, struct net_device *dev,
897                                u8 *mac, struct station_parameters *params);
898         int     (*del_station)(struct wiphy *wiphy, struct net_device *dev,
899                                u8 *mac);
900         int     (*change_station)(struct wiphy *wiphy, struct net_device *dev,
901                                   u8 *mac, struct station_parameters *params);
902         int     (*get_station)(struct wiphy *wiphy, struct net_device *dev,
903                                u8 *mac, struct station_info *sinfo);
904         int     (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
905                                int idx, u8 *mac, struct station_info *sinfo);
906
907         int     (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
908                                u8 *dst, u8 *next_hop);
909         int     (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
910                                u8 *dst);
911         int     (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
912                                   u8 *dst, u8 *next_hop);
913         int     (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
914                                u8 *dst, u8 *next_hop,
915                                struct mpath_info *pinfo);
916         int     (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
917                                int idx, u8 *dst, u8 *next_hop,
918                                struct mpath_info *pinfo);
919         int     (*get_mesh_params)(struct wiphy *wiphy,
920                                 struct net_device *dev,
921                                 struct mesh_config *conf);
922         int     (*set_mesh_params)(struct wiphy *wiphy,
923                                 struct net_device *dev,
924                                 const struct mesh_config *nconf, u32 mask);
925         int     (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
926                               struct bss_parameters *params);
927
928         int     (*set_txq_params)(struct wiphy *wiphy,
929                                   struct ieee80211_txq_params *params);
930
931         int     (*set_channel)(struct wiphy *wiphy,
932                                struct ieee80211_channel *chan,
933                                enum nl80211_channel_type channel_type);
934
935         int     (*scan)(struct wiphy *wiphy, struct net_device *dev,
936                         struct cfg80211_scan_request *request);
937
938         int     (*auth)(struct wiphy *wiphy, struct net_device *dev,
939                         struct cfg80211_auth_request *req);
940         int     (*assoc)(struct wiphy *wiphy, struct net_device *dev,
941                          struct cfg80211_assoc_request *req);
942         int     (*deauth)(struct wiphy *wiphy, struct net_device *dev,
943                           struct cfg80211_deauth_request *req);
944         int     (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
945                             struct cfg80211_disassoc_request *req);
946
947         int     (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
948                              struct cfg80211_ibss_params *params);
949         int     (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
950
951         int     (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
952
953         int     (*set_tx_power)(struct wiphy *wiphy,
954                                 enum tx_power_setting type, int dbm);
955         int     (*get_tx_power)(struct wiphy *wiphy, int *dbm);
956
957         void    (*rfkill_poll)(struct wiphy *wiphy);
958 };
959
960 /*
961  * wireless hardware and networking interfaces structures
962  * and registration/helper functions
963  */
964
965 /**
966  * struct wiphy - wireless hardware description
967  * @idx: the wiphy index assigned to this item
968  * @class_dev: the class device representing /sys/class/ieee80211/<wiphy-name>
969  * @custom_regulatory: tells us the driver for this device
970  *      has its own custom regulatory domain and cannot identify the
971  *      ISO / IEC 3166 alpha2 it belongs to. When this is enabled
972  *      we will disregard the first regulatory hint (when the
973  *      initiator is %REGDOM_SET_BY_CORE).
974  * @strict_regulatory: tells us the driver for this device will ignore
975  *      regulatory domain settings until it gets its own regulatory domain
976  *      via its regulatory_hint(). After its gets its own regulatory domain
977  *      it will only allow further regulatory domain settings to further
978  *      enhance compliance. For example if channel 13 and 14 are disabled
979  *      by this regulatory domain no user regulatory domain can enable these
980  *      channels at a later time. This can be used for devices which do not
981  *      have calibration information gauranteed for frequencies or settings
982  *      outside of its regulatory domain.
983  * @reg_notifier: the driver's regulatory notification callback
984  * @regd: the driver's regulatory domain, if one was requested via
985  *      the regulatory_hint() API. This can be used by the driver
986  *      on the reg_notifier() if it chooses to ignore future
987  *      regulatory domain changes caused by other drivers.
988  * @signal_type: signal type reported in &struct cfg80211_bss.
989  * @cipher_suites: supported cipher suites
990  * @n_cipher_suites: number of supported cipher suites
991  * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
992  * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
993  * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
994  *      -1 = fragmentation disabled, only odd values >= 256 used
995  * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
996  */
997 struct wiphy {
998         /* assign these fields before you register the wiphy */
999
1000         /* permanent MAC address */
1001         u8 perm_addr[ETH_ALEN];
1002
1003         /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
1004         u16 interface_modes;
1005
1006         bool custom_regulatory;
1007         bool strict_regulatory;
1008
1009         enum cfg80211_signal_type signal_type;
1010
1011         int bss_priv_size;
1012         u8 max_scan_ssids;
1013         u16 max_scan_ie_len;
1014
1015         int n_cipher_suites;
1016         const u32 *cipher_suites;
1017
1018         u8 retry_short;
1019         u8 retry_long;
1020         u32 frag_threshold;
1021         u32 rts_threshold;
1022
1023         /* If multiple wiphys are registered and you're handed e.g.
1024          * a regular netdev with assigned ieee80211_ptr, you won't
1025          * know whether it points to a wiphy your driver has registered
1026          * or not. Assign this to something global to your driver to
1027          * help determine whether you own this wiphy or not. */
1028         const void *privid;
1029
1030         struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
1031
1032         /* Lets us get back the wiphy on the callback */
1033         int (*reg_notifier)(struct wiphy *wiphy,
1034                             struct regulatory_request *request);
1035
1036         /* fields below are read-only, assigned by cfg80211 */
1037
1038         const struct ieee80211_regdomain *regd;
1039
1040         /* the item in /sys/class/ieee80211/ points to this,
1041          * you need use set_wiphy_dev() (see below) */
1042         struct device dev;
1043
1044         /* dir in debugfs: ieee80211/<wiphyname> */
1045         struct dentry *debugfsdir;
1046
1047         char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
1048 };
1049
1050 /**
1051  * wiphy_priv - return priv from wiphy
1052  *
1053  * @wiphy: the wiphy whose priv pointer to return
1054  */
1055 static inline void *wiphy_priv(struct wiphy *wiphy)
1056 {
1057         BUG_ON(!wiphy);
1058         return &wiphy->priv;
1059 }
1060
1061 /**
1062  * priv_to_wiphy - return the wiphy containing the priv
1063  *
1064  * @priv: a pointer previously returned by wiphy_priv
1065  */
1066 static inline struct wiphy *priv_to_wiphy(void *priv)
1067 {
1068         BUG_ON(!priv);
1069         return container_of(priv, struct wiphy, priv);
1070 }
1071
1072 /**
1073  * set_wiphy_dev - set device pointer for wiphy
1074  *
1075  * @wiphy: The wiphy whose device to bind
1076  * @dev: The device to parent it to
1077  */
1078 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
1079 {
1080         wiphy->dev.parent = dev;
1081 }
1082
1083 /**
1084  * wiphy_dev - get wiphy dev pointer
1085  *
1086  * @wiphy: The wiphy whose device struct to look up
1087  */
1088 static inline struct device *wiphy_dev(struct wiphy *wiphy)
1089 {
1090         return wiphy->dev.parent;
1091 }
1092
1093 /**
1094  * wiphy_name - get wiphy name
1095  *
1096  * @wiphy: The wiphy whose name to return
1097  */
1098 static inline const char *wiphy_name(struct wiphy *wiphy)
1099 {
1100         return dev_name(&wiphy->dev);
1101 }
1102
1103 /**
1104  * wiphy_new - create a new wiphy for use with cfg80211
1105  *
1106  * @ops: The configuration operations for this device
1107  * @sizeof_priv: The size of the private area to allocate
1108  *
1109  * Create a new wiphy and associate the given operations with it.
1110  * @sizeof_priv bytes are allocated for private use.
1111  *
1112  * The returned pointer must be assigned to each netdev's
1113  * ieee80211_ptr for proper operation.
1114  */
1115 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
1116
1117 /**
1118  * wiphy_register - register a wiphy with cfg80211
1119  *
1120  * @wiphy: The wiphy to register.
1121  *
1122  * Returns a non-negative wiphy index or a negative error code.
1123  */
1124 extern int wiphy_register(struct wiphy *wiphy);
1125
1126 /**
1127  * wiphy_unregister - deregister a wiphy from cfg80211
1128  *
1129  * @wiphy: The wiphy to unregister.
1130  *
1131  * After this call, no more requests can be made with this priv
1132  * pointer, but the call may sleep to wait for an outstanding
1133  * request that is being handled.
1134  */
1135 extern void wiphy_unregister(struct wiphy *wiphy);
1136
1137 /**
1138  * wiphy_free - free wiphy
1139  *
1140  * @wiphy: The wiphy to free
1141  */
1142 extern void wiphy_free(struct wiphy *wiphy);
1143
1144 /**
1145  * struct wireless_dev - wireless per-netdev state
1146  *
1147  * This structure must be allocated by the driver/stack
1148  * that uses the ieee80211_ptr field in struct net_device
1149  * (this is intentional so it can be allocated along with
1150  * the netdev.)
1151  *
1152  * @wiphy: pointer to hardware description
1153  * @iftype: interface type
1154  * @list: (private) Used to collect the interfaces
1155  * @netdev: (private) Used to reference back to the netdev
1156  * @current_bss: (private) Used by the internal configuration code
1157  * @bssid: (private) Used by the internal configuration code
1158  * @ssid: (private) Used by the internal configuration code
1159  * @ssid_len: (private) Used by the internal configuration code
1160  * @wext: (private) Used by the internal wireless extensions compat code
1161  * @wext_bssid: (private) Used by the internal wireless extensions compat code
1162  */
1163 struct wireless_dev {
1164         struct wiphy *wiphy;
1165         enum nl80211_iftype iftype;
1166
1167         /* private to the generic wireless code */
1168         struct list_head list;
1169         struct net_device *netdev;
1170
1171         /* currently used for IBSS - might be rearranged in the future */
1172         struct cfg80211_bss *current_bss;
1173         u8 ssid[IEEE80211_MAX_SSID_LEN];
1174         u8 ssid_len;
1175
1176 #ifdef CONFIG_WIRELESS_EXT
1177         /* wext data */
1178         struct {
1179                 struct cfg80211_ibss_params ibss;
1180                 u8 bssid[ETH_ALEN];
1181                 s8 default_key, default_mgmt_key;
1182         } wext;
1183 #endif
1184 };
1185
1186 /**
1187  * wdev_priv - return wiphy priv from wireless_dev
1188  *
1189  * @wdev: The wireless device whose wiphy's priv pointer to return
1190  */
1191 static inline void *wdev_priv(struct wireless_dev *wdev)
1192 {
1193         BUG_ON(!wdev);
1194         return wiphy_priv(wdev->wiphy);
1195 }
1196
1197 /*
1198  * Utility functions
1199  */
1200
1201 /**
1202  * ieee80211_channel_to_frequency - convert channel number to frequency
1203  */
1204 extern int ieee80211_channel_to_frequency(int chan);
1205
1206 /**
1207  * ieee80211_frequency_to_channel - convert frequency to channel number
1208  */
1209 extern int ieee80211_frequency_to_channel(int freq);
1210
1211 /*
1212  * Name indirection necessary because the ieee80211 code also has
1213  * a function named "ieee80211_get_channel", so if you include
1214  * cfg80211's header file you get cfg80211's version, if you try
1215  * to include both header files you'll (rightfully!) get a symbol
1216  * clash.
1217  */
1218 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
1219                                                          int freq);
1220 /**
1221  * ieee80211_get_channel - get channel struct from wiphy for specified frequency
1222  */
1223 static inline struct ieee80211_channel *
1224 ieee80211_get_channel(struct wiphy *wiphy, int freq)
1225 {
1226         return __ieee80211_get_channel(wiphy, freq);
1227 }
1228
1229 /**
1230  * ieee80211_get_response_rate - get basic rate for a given rate
1231  *
1232  * @sband: the band to look for rates in
1233  * @basic_rates: bitmap of basic rates
1234  * @bitrate: the bitrate for which to find the basic rate
1235  *
1236  * This function returns the basic rate corresponding to a given
1237  * bitrate, that is the next lower bitrate contained in the basic
1238  * rate map, which is, for this function, given as a bitmap of
1239  * indices of rates in the band's bitrate table.
1240  */
1241 struct ieee80211_rate *
1242 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
1243                             u32 basic_rates, int bitrate);
1244
1245 /*
1246  * Radiotap parsing functions -- for controlled injection support
1247  *
1248  * Implemented in net/wireless/radiotap.c
1249  * Documentation in Documentation/networking/radiotap-headers.txt
1250  */
1251
1252 /**
1253  * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
1254  * @rtheader: pointer to the radiotap header we are walking through
1255  * @max_length: length of radiotap header in cpu byte ordering
1256  * @this_arg_index: IEEE80211_RADIOTAP_... index of current arg
1257  * @this_arg: pointer to current radiotap arg
1258  * @arg_index: internal next argument index
1259  * @arg: internal next argument pointer
1260  * @next_bitmap: internal pointer to next present u32
1261  * @bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
1262  */
1263
1264 struct ieee80211_radiotap_iterator {
1265         struct ieee80211_radiotap_header *rtheader;
1266         int max_length;
1267         int this_arg_index;
1268         u8 *this_arg;
1269
1270         int arg_index;
1271         u8 *arg;
1272         __le32 *next_bitmap;
1273         u32 bitmap_shifter;
1274 };
1275
1276 extern int ieee80211_radiotap_iterator_init(
1277    struct ieee80211_radiotap_iterator *iterator,
1278    struct ieee80211_radiotap_header *radiotap_header,
1279    int max_length);
1280
1281 extern int ieee80211_radiotap_iterator_next(
1282    struct ieee80211_radiotap_iterator *iterator);
1283
1284 extern const unsigned char rfc1042_header[6];
1285 extern const unsigned char bridge_tunnel_header[6];
1286
1287 /**
1288  * ieee80211_get_hdrlen_from_skb - get header length from data
1289  *
1290  * Given an skb with a raw 802.11 header at the data pointer this function
1291  * returns the 802.11 header length in bytes (not including encryption
1292  * headers). If the data in the sk_buff is too short to contain a valid 802.11
1293  * header the function returns 0.
1294  *
1295  * @skb: the frame
1296  */
1297 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1298
1299 /**
1300  * ieee80211_hdrlen - get header length in bytes from frame control
1301  * @fc: frame control field in little-endian format
1302  */
1303 unsigned int ieee80211_hdrlen(__le16 fc);
1304
1305 /**
1306  * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
1307  * @skb: the 802.11 data frame
1308  * @addr: the device MAC address
1309  * @iftype: the virtual interface type
1310  */
1311 int ieee80211_data_to_8023(struct sk_buff *skb, u8 *addr,
1312                            enum nl80211_iftype iftype);
1313
1314 /**
1315  * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
1316  * @skb: the 802.3 frame
1317  * @addr: the device MAC address
1318  * @iftype: the virtual interface type
1319  * @bssid: the network bssid (used only for iftype STATION and ADHOC)
1320  * @qos: build 802.11 QoS data frame
1321  */
1322 int ieee80211_data_from_8023(struct sk_buff *skb, u8 *addr,
1323                              enum nl80211_iftype iftype, u8 *bssid, bool qos);
1324
1325 /**
1326  * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
1327  * @skb: the data frame
1328  */
1329 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
1330
1331 /*
1332  * Regulatory helper functions for wiphys
1333  */
1334
1335 /**
1336  * regulatory_hint - driver hint to the wireless core a regulatory domain
1337  * @wiphy: the wireless device giving the hint (used only for reporting
1338  *      conflicts)
1339  * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
1340  *      should be in. If @rd is set this should be NULL. Note that if you
1341  *      set this to NULL you should still set rd->alpha2 to some accepted
1342  *      alpha2.
1343  *
1344  * Wireless drivers can use this function to hint to the wireless core
1345  * what it believes should be the current regulatory domain by
1346  * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
1347  * domain should be in or by providing a completely build regulatory domain.
1348  * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
1349  * for a regulatory domain structure for the respective country.
1350  *
1351  * The wiphy must have been registered to cfg80211 prior to this call.
1352  * For cfg80211 drivers this means you must first use wiphy_register(),
1353  * for mac80211 drivers you must first use ieee80211_register_hw().
1354  *
1355  * Drivers should check the return value, its possible you can get
1356  * an -ENOMEM.
1357  */
1358 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
1359
1360 /**
1361  * regulatory_hint_11d - hints a country IE as a regulatory domain
1362  * @wiphy: the wireless device giving the hint (used only for reporting
1363  *      conflicts)
1364  * @country_ie: pointer to the country IE
1365  * @country_ie_len: length of the country IE
1366  *
1367  * We will intersect the rd with the what CRDA tells us should apply
1368  * for the alpha2 this country IE belongs to, this prevents APs from
1369  * sending us incorrect or outdated information against a country.
1370  */
1371 extern void regulatory_hint_11d(struct wiphy *wiphy,
1372                                 u8 *country_ie,
1373                                 u8 country_ie_len);
1374 /**
1375  * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
1376  * @wiphy: the wireless device we want to process the regulatory domain on
1377  * @regd: the custom regulatory domain to use for this wiphy
1378  *
1379  * Drivers can sometimes have custom regulatory domains which do not apply
1380  * to a specific country. Drivers can use this to apply such custom regulatory
1381  * domains. This routine must be called prior to wiphy registration. The
1382  * custom regulatory domain will be trusted completely and as such previous
1383  * default channel settings will be disregarded. If no rule is found for a
1384  * channel on the regulatory domain the channel will be disabled.
1385  */
1386 extern void wiphy_apply_custom_regulatory(
1387         struct wiphy *wiphy,
1388         const struct ieee80211_regdomain *regd);
1389
1390 /**
1391  * freq_reg_info - get regulatory information for the given frequency
1392  * @wiphy: the wiphy for which we want to process this rule for
1393  * @center_freq: Frequency in KHz for which we want regulatory information for
1394  * @desired_bw_khz: the desired max bandwidth you want to use per
1395  *      channel. Note that this is still 20 MHz if you want to use HT40
1396  *      as HT40 makes use of two channels for its 40 MHz width bandwidth.
1397  *      If set to 0 we'll assume you want the standard 20 MHz.
1398  * @reg_rule: the regulatory rule which we have for this frequency
1399  *
1400  * Use this function to get the regulatory rule for a specific frequency on
1401  * a given wireless device. If the device has a specific regulatory domain
1402  * it wants to follow we respect that unless a country IE has been received
1403  * and processed already.
1404  *
1405  * Returns 0 if it was able to find a valid regulatory rule which does
1406  * apply to the given center_freq otherwise it returns non-zero. It will
1407  * also return -ERANGE if we determine the given center_freq does not even have
1408  * a regulatory rule for a frequency range in the center_freq's band. See
1409  * freq_in_rule_band() for our current definition of a band -- this is purely
1410  * subjective and right now its 802.11 specific.
1411  */
1412 extern int freq_reg_info(struct wiphy *wiphy,
1413                          u32 center_freq,
1414                          u32 desired_bw_khz,
1415                          const struct ieee80211_reg_rule **reg_rule);
1416
1417 /*
1418  * Temporary wext handlers & helper functions
1419  *
1420  * In the future cfg80211 will simply assign the entire wext handler
1421  * structure to netdevs it manages, but we're not there yet.
1422  */
1423 int cfg80211_wext_giwname(struct net_device *dev,
1424                           struct iw_request_info *info,
1425                           char *name, char *extra);
1426 int cfg80211_wext_siwmode(struct net_device *dev, struct iw_request_info *info,
1427                           u32 *mode, char *extra);
1428 int cfg80211_wext_giwmode(struct net_device *dev, struct iw_request_info *info,
1429                           u32 *mode, char *extra);
1430 int cfg80211_wext_siwscan(struct net_device *dev,
1431                           struct iw_request_info *info,
1432                           union iwreq_data *wrqu, char *extra);
1433 int cfg80211_wext_giwscan(struct net_device *dev,
1434                           struct iw_request_info *info,
1435                           struct iw_point *data, char *extra);
1436 int cfg80211_wext_siwmlme(struct net_device *dev,
1437                           struct iw_request_info *info,
1438                           struct iw_point *data, char *extra);
1439 int cfg80211_wext_giwrange(struct net_device *dev,
1440                            struct iw_request_info *info,
1441                            struct iw_point *data, char *extra);
1442 int cfg80211_ibss_wext_siwfreq(struct net_device *dev,
1443                                struct iw_request_info *info,
1444                                struct iw_freq *freq, char *extra);
1445 int cfg80211_ibss_wext_giwfreq(struct net_device *dev,
1446                                struct iw_request_info *info,
1447                                struct iw_freq *freq, char *extra);
1448 int cfg80211_ibss_wext_siwessid(struct net_device *dev,
1449                                 struct iw_request_info *info,
1450                                 struct iw_point *data, char *ssid);
1451 int cfg80211_ibss_wext_giwessid(struct net_device *dev,
1452                                 struct iw_request_info *info,
1453                                 struct iw_point *data, char *ssid);
1454 int cfg80211_ibss_wext_siwap(struct net_device *dev,
1455                              struct iw_request_info *info,
1456                              struct sockaddr *ap_addr, char *extra);
1457 int cfg80211_ibss_wext_giwap(struct net_device *dev,
1458                              struct iw_request_info *info,
1459                              struct sockaddr *ap_addr, char *extra);
1460
1461 struct ieee80211_channel *cfg80211_wext_freq(struct wiphy *wiphy,
1462                                              struct iw_freq *freq);
1463
1464 int cfg80211_wext_siwrts(struct net_device *dev,
1465                          struct iw_request_info *info,
1466                          struct iw_param *rts, char *extra);
1467 int cfg80211_wext_giwrts(struct net_device *dev,
1468                          struct iw_request_info *info,
1469                          struct iw_param *rts, char *extra);
1470 int cfg80211_wext_siwfrag(struct net_device *dev,
1471                           struct iw_request_info *info,
1472                           struct iw_param *frag, char *extra);
1473 int cfg80211_wext_giwfrag(struct net_device *dev,
1474                           struct iw_request_info *info,
1475                           struct iw_param *frag, char *extra);
1476 int cfg80211_wext_siwretry(struct net_device *dev,
1477                            struct iw_request_info *info,
1478                            struct iw_param *retry, char *extra);
1479 int cfg80211_wext_giwretry(struct net_device *dev,
1480                            struct iw_request_info *info,
1481                            struct iw_param *retry, char *extra);
1482 int cfg80211_wext_siwencodeext(struct net_device *dev,
1483                                struct iw_request_info *info,
1484                                struct iw_point *erq, char *extra);
1485 int cfg80211_wext_siwencode(struct net_device *dev,
1486                             struct iw_request_info *info,
1487                             struct iw_point *erq, char *keybuf);
1488 int cfg80211_wext_giwencode(struct net_device *dev,
1489                             struct iw_request_info *info,
1490                             struct iw_point *erq, char *keybuf);
1491 int cfg80211_wext_siwtxpower(struct net_device *dev,
1492                              struct iw_request_info *info,
1493                              union iwreq_data *data, char *keybuf);
1494 int cfg80211_wext_giwtxpower(struct net_device *dev,
1495                              struct iw_request_info *info,
1496                              union iwreq_data *data, char *keybuf);
1497
1498 /*
1499  * callbacks for asynchronous cfg80211 methods, notification
1500  * functions and BSS handling helpers
1501  */
1502
1503 /**
1504  * cfg80211_scan_done - notify that scan finished
1505  *
1506  * @request: the corresponding scan request
1507  * @aborted: set to true if the scan was aborted for any reason,
1508  *      userspace will be notified of that
1509  */
1510 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
1511
1512 /**
1513  * cfg80211_inform_bss - inform cfg80211 of a new BSS
1514  *
1515  * @wiphy: the wiphy reporting the BSS
1516  * @bss: the found BSS
1517  * @signal: the signal strength, type depends on the wiphy's signal_type
1518  * @gfp: context flags
1519  *
1520  * This informs cfg80211 that BSS information was found and
1521  * the BSS should be updated/added.
1522  */
1523 struct cfg80211_bss*
1524 cfg80211_inform_bss_frame(struct wiphy *wiphy,
1525                           struct ieee80211_channel *channel,
1526                           struct ieee80211_mgmt *mgmt, size_t len,
1527                           s32 signal, gfp_t gfp);
1528
1529 struct cfg80211_bss*
1530 cfg80211_inform_bss(struct wiphy *wiphy,
1531                     struct ieee80211_channel *channel,
1532                     const u8 *bssid,
1533                     u64 timestamp, u16 capability, u16 beacon_interval,
1534                     const u8 *ie, size_t ielen,
1535                     s32 signal, gfp_t gfp);
1536
1537 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
1538                                       struct ieee80211_channel *channel,
1539                                       const u8 *bssid,
1540                                       const u8 *ssid, size_t ssid_len,
1541                                       u16 capa_mask, u16 capa_val);
1542 static inline struct cfg80211_bss *
1543 cfg80211_get_ibss(struct wiphy *wiphy,
1544                   struct ieee80211_channel *channel,
1545                   const u8 *ssid, size_t ssid_len)
1546 {
1547         return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
1548                                 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
1549 }
1550
1551 struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
1552                                        struct ieee80211_channel *channel,
1553                                        const u8 *meshid, size_t meshidlen,
1554                                        const u8 *meshcfg);
1555 void cfg80211_put_bss(struct cfg80211_bss *bss);
1556
1557 /**
1558  * cfg80211_unlink_bss - unlink BSS from internal data structures
1559  * @wiphy: the wiphy
1560  * @bss: the bss to remove
1561  *
1562  * This function removes the given BSS from the internal data structures
1563  * thereby making it no longer show up in scan results etc. Use this
1564  * function when you detect a BSS is gone. Normally BSSes will also time
1565  * out, so it is not necessary to use this function at all.
1566  */
1567 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
1568
1569 /**
1570  * cfg80211_send_rx_auth - notification of processed authentication
1571  * @dev: network device
1572  * @buf: authentication frame (header + body)
1573  * @len: length of the frame data
1574  * @gfp: allocation flags
1575  *
1576  * This function is called whenever an authentication has been processed in
1577  * station mode. The driver is required to call either this function or
1578  * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
1579  * call.
1580  */
1581 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len, gfp_t gfp);
1582
1583 /**
1584  * cfg80211_send_auth_timeout - notification of timed out authentication
1585  * @dev: network device
1586  * @addr: The MAC address of the device with which the authentication timed out
1587  * @gfp: allocation flags
1588  */
1589 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr, gfp_t gfp);
1590
1591 /**
1592  * cfg80211_send_rx_assoc - notification of processed association
1593  * @dev: network device
1594  * @buf: (re)association response frame (header + body)
1595  * @len: length of the frame data
1596  * @gfp: allocation flags
1597  *
1598  * This function is called whenever a (re)association response has been
1599  * processed in station mode. The driver is required to call either this
1600  * function or cfg80211_send_assoc_timeout() to indicate the result of
1601  * cfg80211_ops::assoc() call.
1602  */
1603 void cfg80211_send_rx_assoc(struct net_device *dev, const u8 *buf, size_t len, gfp_t gfp);
1604
1605 /**
1606  * cfg80211_send_assoc_timeout - notification of timed out association
1607  * @dev: network device
1608  * @addr: The MAC address of the device with which the association timed out
1609  * @gfp: allocation flags
1610  */
1611 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr, gfp_t gfp);
1612
1613 /**
1614  * cfg80211_send_deauth - notification of processed deauthentication
1615  * @dev: network device
1616  * @buf: deauthentication frame (header + body)
1617  * @len: length of the frame data
1618  * @gfp: allocation flags
1619  *
1620  * This function is called whenever deauthentication has been processed in
1621  * station mode. This includes both received deauthentication frames and
1622  * locally generated ones.
1623  */
1624 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len, gfp_t gfp);
1625
1626 /**
1627  * cfg80211_send_disassoc - notification of processed disassociation
1628  * @dev: network device
1629  * @buf: disassociation response frame (header + body)
1630  * @len: length of the frame data
1631  * @gfp: allocation flags
1632  *
1633  * This function is called whenever disassociation has been processed in
1634  * station mode. This includes both received disassociation frames and locally
1635  * generated ones.
1636  */
1637 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len, gfp_t gfp);
1638
1639 /**
1640  * cfg80211_hold_bss - exclude bss from expiration
1641  * @bss: bss which should not expire
1642  *
1643  * In a case when the BSS is not updated but it shouldn't expire this
1644  * function can be used to mark the BSS to be excluded from expiration.
1645  */
1646 void cfg80211_hold_bss(struct cfg80211_bss *bss);
1647
1648 /**
1649  * cfg80211_unhold_bss - remove expiration exception from the BSS
1650  * @bss: bss which can expire again
1651  *
1652  * This function marks the BSS to be expirable again.
1653  */
1654 void cfg80211_unhold_bss(struct cfg80211_bss *bss);
1655
1656 /**
1657  * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
1658  * @dev: network device
1659  * @addr: The source MAC address of the frame
1660  * @key_type: The key type that the received frame used
1661  * @key_id: Key identifier (0..3)
1662  * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
1663  * @gfp: allocation flags
1664  *
1665  * This function is called whenever the local MAC detects a MIC failure in a
1666  * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
1667  * primitive.
1668  */
1669 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
1670                                   enum nl80211_key_type key_type, int key_id,
1671                                   const u8 *tsc, gfp_t gfp);
1672
1673 /**
1674  * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
1675  *
1676  * @dev: network device
1677  * @bssid: the BSSID of the IBSS joined
1678  * @gfp: allocation flags
1679  *
1680  * This function notifies cfg80211 that the device joined an IBSS or
1681  * switched to a different BSSID. Before this function can be called,
1682  * either a beacon has to have been received from the IBSS, or one of
1683  * the cfg80211_inform_bss{,_frame} functions must have been called
1684  * with the locally generated beacon -- this guarantees that there is
1685  * always a scan result for this IBSS. cfg80211 will handle the rest.
1686  */
1687 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
1688
1689 /**
1690  * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
1691  * @wiphy: the wiphy
1692  * @blocked: block status
1693  */
1694 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
1695
1696 /**
1697  * wiphy_rfkill_start_polling - start polling rfkill
1698  * @wiphy: the wiphy
1699  */
1700 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
1701
1702 /**
1703  * wiphy_rfkill_stop_polling - stop polling rfkill
1704  * @wiphy: the wiphy
1705  */
1706 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
1707
1708 #endif /* __NET_CFG80211_H */