af_packet: Teach to listen for multiple unicast addresses.
[linux-2.6] / 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_FAT_ABOVE: extension channel above this channel
60  *      is not permitted.
61  * @IEEE80211_CHAN_NO_FAT_BELOW: 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_FAT_ABOVE     = 1<<4,
70         IEEE80211_CHAN_NO_FAT_BELOW     = 1<<5,
71 };
72
73 /**
74  * struct ieee80211_channel - channel definition
75  *
76  * This structure describes a single channel for use
77  * with cfg80211.
78  *
79  * @center_freq: center frequency in MHz
80  * @max_bandwidth: maximum allowed bandwidth for this channel, in MHz
81  * @hw_value: hardware-specific value for the channel
82  * @flags: channel flags from &enum ieee80211_channel_flags.
83  * @orig_flags: channel flags at registration time, used by regulatory
84  *      code to support devices with additional restrictions
85  * @band: band this channel belongs to.
86  * @max_antenna_gain: maximum antenna gain in dBi
87  * @max_power: maximum transmission power (in dBm)
88  * @beacon_found: helper to regulatory code to indicate when a beacon
89  *      has been found on this channel. Use regulatory_hint_found_beacon()
90  *      to enable this, this is is useful only on 5 GHz band.
91  * @orig_mag: internal use
92  * @orig_mpwr: internal use
93  */
94 struct ieee80211_channel {
95         enum ieee80211_band band;
96         u16 center_freq;
97         u8 max_bandwidth;
98         u16 hw_value;
99         u32 flags;
100         int max_antenna_gain;
101         int max_power;
102         bool beacon_found;
103         u32 orig_flags;
104         int orig_mag, orig_mpwr;
105 };
106
107 /**
108  * enum ieee80211_rate_flags - rate flags
109  *
110  * Hardware/specification flags for rates. These are structured
111  * in a way that allows using the same bitrate structure for
112  * different bands/PHY modes.
113  *
114  * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
115  *      preamble on this bitrate; only relevant in 2.4GHz band and
116  *      with CCK rates.
117  * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
118  *      when used with 802.11a (on the 5 GHz band); filled by the
119  *      core code when registering the wiphy.
120  * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
121  *      when used with 802.11b (on the 2.4 GHz band); filled by the
122  *      core code when registering the wiphy.
123  * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
124  *      when used with 802.11g (on the 2.4 GHz band); filled by the
125  *      core code when registering the wiphy.
126  * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
127  */
128 enum ieee80211_rate_flags {
129         IEEE80211_RATE_SHORT_PREAMBLE   = 1<<0,
130         IEEE80211_RATE_MANDATORY_A      = 1<<1,
131         IEEE80211_RATE_MANDATORY_B      = 1<<2,
132         IEEE80211_RATE_MANDATORY_G      = 1<<3,
133         IEEE80211_RATE_ERP_G            = 1<<4,
134 };
135
136 /**
137  * struct ieee80211_rate - bitrate definition
138  *
139  * This structure describes a bitrate that an 802.11 PHY can
140  * operate with. The two values @hw_value and @hw_value_short
141  * are only for driver use when pointers to this structure are
142  * passed around.
143  *
144  * @flags: rate-specific flags
145  * @bitrate: bitrate in units of 100 Kbps
146  * @hw_value: driver/hardware value for this rate
147  * @hw_value_short: driver/hardware value for this rate when
148  *      short preamble is used
149  */
150 struct ieee80211_rate {
151         u32 flags;
152         u16 bitrate;
153         u16 hw_value, hw_value_short;
154 };
155
156 /**
157  * struct ieee80211_sta_ht_cap - STA's HT capabilities
158  *
159  * This structure describes most essential parameters needed
160  * to describe 802.11n HT capabilities for an STA.
161  *
162  * @ht_supported: is HT supported by the STA
163  * @cap: HT capabilities map as described in 802.11n spec
164  * @ampdu_factor: Maximum A-MPDU length factor
165  * @ampdu_density: Minimum A-MPDU spacing
166  * @mcs: Supported MCS rates
167  */
168 struct ieee80211_sta_ht_cap {
169         u16 cap; /* use IEEE80211_HT_CAP_ */
170         bool ht_supported;
171         u8 ampdu_factor;
172         u8 ampdu_density;
173         struct ieee80211_mcs_info mcs;
174 };
175
176 /**
177  * struct ieee80211_supported_band - frequency band definition
178  *
179  * This structure describes a frequency band a wiphy
180  * is able to operate in.
181  *
182  * @channels: Array of channels the hardware can operate in
183  *      in this band.
184  * @band: the band this structure represents
185  * @n_channels: Number of channels in @channels
186  * @bitrates: Array of bitrates the hardware can operate with
187  *      in this band. Must be sorted to give a valid "supported
188  *      rates" IE, i.e. CCK rates first, then OFDM.
189  * @n_bitrates: Number of bitrates in @bitrates
190  */
191 struct ieee80211_supported_band {
192         struct ieee80211_channel *channels;
193         struct ieee80211_rate *bitrates;
194         enum ieee80211_band band;
195         int n_channels;
196         int n_bitrates;
197         struct ieee80211_sta_ht_cap ht_cap;
198 };
199
200 /*
201  * Wireless hardware/device configuration structures and methods
202  */
203
204 /**
205  * struct vif_params - describes virtual interface parameters
206  * @mesh_id: mesh ID to use
207  * @mesh_id_len: length of the mesh ID
208  */
209 struct vif_params {
210        u8 *mesh_id;
211        int mesh_id_len;
212 };
213
214 /**
215  * struct key_params - key information
216  *
217  * Information about a key
218  *
219  * @key: key material
220  * @key_len: length of key material
221  * @cipher: cipher suite selector
222  * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
223  *      with the get_key() callback, must be in little endian,
224  *      length given by @seq_len.
225  */
226 struct key_params {
227         u8 *key;
228         u8 *seq;
229         int key_len;
230         int seq_len;
231         u32 cipher;
232 };
233
234 /**
235  * struct beacon_parameters - beacon parameters
236  *
237  * Used to configure the beacon for an interface.
238  *
239  * @head: head portion of beacon (before TIM IE)
240  *     or %NULL if not changed
241  * @tail: tail portion of beacon (after TIM IE)
242  *     or %NULL if not changed
243  * @interval: beacon interval or zero if not changed
244  * @dtim_period: DTIM period or zero if not changed
245  * @head_len: length of @head
246  * @tail_len: length of @tail
247  */
248 struct beacon_parameters {
249         u8 *head, *tail;
250         int interval, dtim_period;
251         int head_len, tail_len;
252 };
253
254 /**
255  * enum plink_action - actions to perform in mesh peers
256  *
257  * @PLINK_ACTION_INVALID: action 0 is reserved
258  * @PLINK_ACTION_OPEN: start mesh peer link establishment
259  * @PLINK_ACTION_BLOCL: block traffic from this mesh peer
260  */
261 enum plink_actions {
262         PLINK_ACTION_INVALID,
263         PLINK_ACTION_OPEN,
264         PLINK_ACTION_BLOCK,
265 };
266
267 /**
268  * struct station_parameters - station parameters
269  *
270  * Used to change and create a new station.
271  *
272  * @vlan: vlan interface station should belong to
273  * @supported_rates: supported rates in IEEE 802.11 format
274  *      (or NULL for no change)
275  * @supported_rates_len: number of supported rates
276  * @sta_flags_mask: station flags that changed
277  *      (bitmask of BIT(NL80211_STA_FLAG_...))
278  * @sta_flags_set: station flags values
279  *      (bitmask of BIT(NL80211_STA_FLAG_...))
280  * @listen_interval: listen interval or -1 for no change
281  * @aid: AID or zero for no change
282  */
283 struct station_parameters {
284         u8 *supported_rates;
285         struct net_device *vlan;
286         u32 sta_flags_mask, sta_flags_set;
287         int listen_interval;
288         u16 aid;
289         u8 supported_rates_len;
290         u8 plink_action;
291         struct ieee80211_ht_cap *ht_capa;
292 };
293
294 /**
295  * enum station_info_flags - station information flags
296  *
297  * Used by the driver to indicate which info in &struct station_info
298  * it has filled in during get_station() or dump_station().
299  *
300  * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
301  * @STATION_INFO_RX_BYTES: @rx_bytes filled
302  * @STATION_INFO_TX_BYTES: @tx_bytes filled
303  * @STATION_INFO_LLID: @llid filled
304  * @STATION_INFO_PLID: @plid filled
305  * @STATION_INFO_PLINK_STATE: @plink_state filled
306  * @STATION_INFO_SIGNAL: @signal filled
307  * @STATION_INFO_TX_BITRATE: @tx_bitrate fields are filled
308  *  (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
309  * @STATION_INFO_RX_PACKETS: @rx_packets filled
310  * @STATION_INFO_TX_PACKETS: @tx_packets filled
311  */
312 enum station_info_flags {
313         STATION_INFO_INACTIVE_TIME      = 1<<0,
314         STATION_INFO_RX_BYTES           = 1<<1,
315         STATION_INFO_TX_BYTES           = 1<<2,
316         STATION_INFO_LLID               = 1<<3,
317         STATION_INFO_PLID               = 1<<4,
318         STATION_INFO_PLINK_STATE        = 1<<5,
319         STATION_INFO_SIGNAL             = 1<<6,
320         STATION_INFO_TX_BITRATE         = 1<<7,
321         STATION_INFO_RX_PACKETS         = 1<<8,
322         STATION_INFO_TX_PACKETS         = 1<<9,
323 };
324
325 /**
326  * enum station_info_rate_flags - bitrate info flags
327  *
328  * Used by the driver to indicate the specific rate transmission
329  * type for 802.11n transmissions.
330  *
331  * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
332  * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
333  * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
334  */
335 enum rate_info_flags {
336         RATE_INFO_FLAGS_MCS             = 1<<0,
337         RATE_INFO_FLAGS_40_MHZ_WIDTH    = 1<<1,
338         RATE_INFO_FLAGS_SHORT_GI        = 1<<2,
339 };
340
341 /**
342  * struct rate_info - bitrate information
343  *
344  * Information about a receiving or transmitting bitrate
345  *
346  * @flags: bitflag of flags from &enum rate_info_flags
347  * @mcs: mcs index if struct describes a 802.11n bitrate
348  * @legacy: bitrate in 100kbit/s for 802.11abg
349  */
350 struct rate_info {
351         u8 flags;
352         u8 mcs;
353         u16 legacy;
354 };
355
356 /**
357  * struct station_info - station information
358  *
359  * Station information filled by driver for get_station() and dump_station.
360  *
361  * @filled: bitflag of flags from &enum station_info_flags
362  * @inactive_time: time since last station activity (tx/rx) in milliseconds
363  * @rx_bytes: bytes received from this station
364  * @tx_bytes: bytes transmitted to this station
365  * @llid: mesh local link id
366  * @plid: mesh peer link id
367  * @plink_state: mesh peer link state
368  * @signal: signal strength of last received packet in dBm
369  * @txrate: current unicast bitrate to this station
370  * @rx_packets: packets received from this station
371  * @tx_packets: packets transmitted to this station
372  */
373 struct station_info {
374         u32 filled;
375         u32 inactive_time;
376         u32 rx_bytes;
377         u32 tx_bytes;
378         u16 llid;
379         u16 plid;
380         u8 plink_state;
381         s8 signal;
382         struct rate_info txrate;
383         u32 rx_packets;
384         u32 tx_packets;
385 };
386
387 /**
388  * enum monitor_flags - monitor flags
389  *
390  * Monitor interface configuration flags. Note that these must be the bits
391  * according to the nl80211 flags.
392  *
393  * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
394  * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
395  * @MONITOR_FLAG_CONTROL: pass control frames
396  * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
397  * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
398  */
399 enum monitor_flags {
400         MONITOR_FLAG_FCSFAIL            = 1<<NL80211_MNTR_FLAG_FCSFAIL,
401         MONITOR_FLAG_PLCPFAIL           = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
402         MONITOR_FLAG_CONTROL            = 1<<NL80211_MNTR_FLAG_CONTROL,
403         MONITOR_FLAG_OTHER_BSS          = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
404         MONITOR_FLAG_COOK_FRAMES        = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
405 };
406
407 /**
408  * enum mpath_info_flags -  mesh path information flags
409  *
410  * Used by the driver to indicate which info in &struct mpath_info it has filled
411  * in during get_station() or dump_station().
412  *
413  * MPATH_INFO_FRAME_QLEN: @frame_qlen filled
414  * MPATH_INFO_DSN: @dsn filled
415  * MPATH_INFO_METRIC: @metric filled
416  * MPATH_INFO_EXPTIME: @exptime filled
417  * MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
418  * MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
419  * MPATH_INFO_FLAGS: @flags filled
420  */
421 enum mpath_info_flags {
422         MPATH_INFO_FRAME_QLEN           = BIT(0),
423         MPATH_INFO_DSN                  = BIT(1),
424         MPATH_INFO_METRIC               = BIT(2),
425         MPATH_INFO_EXPTIME              = BIT(3),
426         MPATH_INFO_DISCOVERY_TIMEOUT    = BIT(4),
427         MPATH_INFO_DISCOVERY_RETRIES    = BIT(5),
428         MPATH_INFO_FLAGS                = BIT(6),
429 };
430
431 /**
432  * struct mpath_info - mesh path information
433  *
434  * Mesh path information filled by driver for get_mpath() and dump_mpath().
435  *
436  * @filled: bitfield of flags from &enum mpath_info_flags
437  * @frame_qlen: number of queued frames for this destination
438  * @dsn: destination sequence number
439  * @metric: metric (cost) of this mesh path
440  * @exptime: expiration time for the mesh path from now, in msecs
441  * @flags: mesh path flags
442  * @discovery_timeout: total mesh path discovery timeout, in msecs
443  * @discovery_retries: mesh path discovery retries
444  */
445 struct mpath_info {
446         u32 filled;
447         u32 frame_qlen;
448         u32 dsn;
449         u32 metric;
450         u32 exptime;
451         u32 discovery_timeout;
452         u8 discovery_retries;
453         u8 flags;
454 };
455
456 /**
457  * struct bss_parameters - BSS parameters
458  *
459  * Used to change BSS parameters (mainly for AP mode).
460  *
461  * @use_cts_prot: Whether to use CTS protection
462  *      (0 = no, 1 = yes, -1 = do not change)
463  * @use_short_preamble: Whether the use of short preambles is allowed
464  *      (0 = no, 1 = yes, -1 = do not change)
465  * @use_short_slot_time: Whether the use of short slot time is allowed
466  *      (0 = no, 1 = yes, -1 = do not change)
467  * @basic_rates: basic rates in IEEE 802.11 format
468  *      (or NULL for no change)
469  * @basic_rates_len: number of basic rates
470  */
471 struct bss_parameters {
472         int use_cts_prot;
473         int use_short_preamble;
474         int use_short_slot_time;
475         u8 *basic_rates;
476         u8 basic_rates_len;
477 };
478
479 struct mesh_config {
480         /* Timeouts in ms */
481         /* Mesh plink management parameters */
482         u16 dot11MeshRetryTimeout;
483         u16 dot11MeshConfirmTimeout;
484         u16 dot11MeshHoldingTimeout;
485         u16 dot11MeshMaxPeerLinks;
486         u8  dot11MeshMaxRetries;
487         u8  dot11MeshTTL;
488         bool auto_open_plinks;
489         /* HWMP parameters */
490         u8  dot11MeshHWMPmaxPREQretries;
491         u32 path_refresh_time;
492         u16 min_discovery_timeout;
493         u32 dot11MeshHWMPactivePathTimeout;
494         u16 dot11MeshHWMPpreqMinInterval;
495         u16 dot11MeshHWMPnetDiameterTraversalTime;
496 };
497
498 /**
499  * struct ieee80211_txq_params - TX queue parameters
500  * @queue: TX queue identifier (NL80211_TXQ_Q_*)
501  * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
502  * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
503  *      1..32767]
504  * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
505  *      1..32767]
506  * @aifs: Arbitration interframe space [0..255]
507  */
508 struct ieee80211_txq_params {
509         enum nl80211_txq_q queue;
510         u16 txop;
511         u16 cwmin;
512         u16 cwmax;
513         u8 aifs;
514 };
515
516 /* from net/wireless.h */
517 struct wiphy;
518
519 /* from net/ieee80211.h */
520 struct ieee80211_channel;
521
522 /**
523  * struct cfg80211_ssid - SSID description
524  * @ssid: the SSID
525  * @ssid_len: length of the ssid
526  */
527 struct cfg80211_ssid {
528         u8 ssid[IEEE80211_MAX_SSID_LEN];
529         u8 ssid_len;
530 };
531
532 /**
533  * struct cfg80211_scan_request - scan request description
534  *
535  * @ssids: SSIDs to scan for (active scan only)
536  * @n_ssids: number of SSIDs
537  * @channels: channels to scan on.
538  * @n_channels: number of channels for each band
539  * @ie: optional information element(s) to add into Probe Request or %NULL
540  * @ie_len: length of ie in octets
541  * @wiphy: the wiphy this was for
542  * @ifidx: the interface index
543  */
544 struct cfg80211_scan_request {
545         struct cfg80211_ssid *ssids;
546         int n_ssids;
547         struct ieee80211_channel **channels;
548         u32 n_channels;
549         const u8 *ie;
550         size_t ie_len;
551
552         /* internal */
553         struct wiphy *wiphy;
554         int ifidx;
555 };
556
557 /**
558  * enum cfg80211_signal_type - signal type
559  *
560  * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
561  * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
562  * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
563  */
564 enum cfg80211_signal_type {
565         CFG80211_SIGNAL_TYPE_NONE,
566         CFG80211_SIGNAL_TYPE_MBM,
567         CFG80211_SIGNAL_TYPE_UNSPEC,
568 };
569
570 /**
571  * struct cfg80211_bss - BSS description
572  *
573  * This structure describes a BSS (which may also be a mesh network)
574  * for use in scan results and similar.
575  *
576  * @bssid: BSSID of the BSS
577  * @tsf: timestamp of last received update
578  * @beacon_interval: the beacon interval as from the frame
579  * @capability: the capability field in host byte order
580  * @information_elements: the information elements (Note that there
581  *      is no guarantee that these are well-formed!)
582  * @len_information_elements: total length of the information elements
583  * @signal: signal strength value (type depends on the wiphy's signal_type)
584  * @hold: BSS should not expire
585  * @free_priv: function pointer to free private data
586  * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
587  */
588 struct cfg80211_bss {
589         struct ieee80211_channel *channel;
590
591         u8 bssid[ETH_ALEN];
592         u64 tsf;
593         u16 beacon_interval;
594         u16 capability;
595         u8 *information_elements;
596         size_t len_information_elements;
597
598         s32 signal;
599
600         void (*free_priv)(struct cfg80211_bss *bss);
601         u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
602 };
603
604 /**
605  * struct cfg80211_auth_request - Authentication request data
606  *
607  * This structure provides information needed to complete IEEE 802.11
608  * authentication.
609  * NOTE: This structure will likely change when more code from mac80211 is
610  * moved into cfg80211 so that non-mac80211 drivers can benefit from it, too.
611  * Before using this in a driver that does not use mac80211, it would be better
612  * to check the status of that work and better yet, volunteer to work on it.
613  *
614  * @chan: The channel to use or %NULL if not specified (auto-select based on
615  *      scan results)
616  * @peer_addr: The address of the peer STA (AP BSSID in infrastructure case);
617  *      this field is required to be present; if the driver wants to help with
618  *      BSS selection, it should use (yet to be added) MLME event to allow user
619  *      space SME to be notified of roaming candidate, so that the SME can then
620  *      use the authentication request with the recommended BSSID and whatever
621  *      other data may be needed for authentication/association
622  * @ssid: SSID or %NULL if not yet available
623  * @ssid_len: Length of ssid in octets
624  * @auth_type: Authentication type (algorithm)
625  * @ie: Extra IEs to add to Authentication frame or %NULL
626  * @ie_len: Length of ie buffer in octets
627  */
628 struct cfg80211_auth_request {
629         struct ieee80211_channel *chan;
630         u8 *peer_addr;
631         const u8 *ssid;
632         size_t ssid_len;
633         enum nl80211_auth_type auth_type;
634         const u8 *ie;
635         size_t ie_len;
636 };
637
638 /**
639  * struct cfg80211_assoc_request - (Re)Association request data
640  *
641  * This structure provides information needed to complete IEEE 802.11
642  * (re)association.
643  * NOTE: This structure will likely change when more code from mac80211 is
644  * moved into cfg80211 so that non-mac80211 drivers can benefit from it, too.
645  * Before using this in a driver that does not use mac80211, it would be better
646  * to check the status of that work and better yet, volunteer to work on it.
647  *
648  * @chan: The channel to use or %NULL if not specified (auto-select based on
649  *      scan results)
650  * @peer_addr: The address of the peer STA (AP BSSID); this field is required
651  *      to be present and the STA must be in State 2 (authenticated) with the
652  *      peer STA
653  * @ssid: SSID
654  * @ssid_len: Length of ssid in octets
655  * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
656  * @ie_len: Length of ie buffer in octets
657  * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
658  * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
659  *      sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
660  *      required to assume that the port is unauthorized until authorized by
661  *      user space. Otherwise, port is marked authorized by default.
662  */
663 struct cfg80211_assoc_request {
664         struct ieee80211_channel *chan;
665         u8 *peer_addr;
666         const u8 *ssid;
667         size_t ssid_len;
668         const u8 *ie;
669         size_t ie_len;
670         bool use_mfp;
671         bool control_port;
672 };
673
674 /**
675  * struct cfg80211_deauth_request - Deauthentication request data
676  *
677  * This structure provides information needed to complete IEEE 802.11
678  * deauthentication.
679  *
680  * @peer_addr: The address of the peer STA (AP BSSID); this field is required
681  *      to be present and the STA must be authenticated with the peer STA
682  * @ie: Extra IEs to add to Deauthentication frame or %NULL
683  * @ie_len: Length of ie buffer in octets
684  */
685 struct cfg80211_deauth_request {
686         u8 *peer_addr;
687         u16 reason_code;
688         const u8 *ie;
689         size_t ie_len;
690 };
691
692 /**
693  * struct cfg80211_disassoc_request - Disassociation request data
694  *
695  * This structure provides information needed to complete IEEE 802.11
696  * disassocation.
697  *
698  * @peer_addr: The address of the peer STA (AP BSSID); this field is required
699  *      to be present and the STA must be associated with the peer STA
700  * @ie: Extra IEs to add to Disassociation frame or %NULL
701  * @ie_len: Length of ie buffer in octets
702  */
703 struct cfg80211_disassoc_request {
704         u8 *peer_addr;
705         u16 reason_code;
706         const u8 *ie;
707         size_t ie_len;
708 };
709
710 /**
711  * struct cfg80211_ibss_params - IBSS parameters
712  *
713  * This structure defines the IBSS parameters for the join_ibss()
714  * method.
715  *
716  * @ssid: The SSID, will always be non-null.
717  * @ssid_len: The length of the SSID, will always be non-zero.
718  * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
719  *      search for IBSSs with a different BSSID.
720  * @channel: The channel to use if no IBSS can be found to join.
721  * @channel_fixed: The channel should be fixed -- do not search for
722  *      IBSSs to join on other channels.
723  * @ie: information element(s) to include in the beacon
724  * @ie_len: length of that
725  * @beacon_interval: beacon interval to use
726  */
727 struct cfg80211_ibss_params {
728         u8 *ssid;
729         u8 *bssid;
730         struct ieee80211_channel *channel;
731         u8 *ie;
732         u8 ssid_len, ie_len;
733         u16 beacon_interval;
734         bool channel_fixed;
735 };
736
737 /**
738  * enum wiphy_params_flags - set_wiphy_params bitfield values
739  * WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
740  * WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
741  * WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
742  * WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
743  */
744 enum wiphy_params_flags {
745         WIPHY_PARAM_RETRY_SHORT         = 1 << 0,
746         WIPHY_PARAM_RETRY_LONG          = 1 << 1,
747         WIPHY_PARAM_FRAG_THRESHOLD      = 1 << 2,
748         WIPHY_PARAM_RTS_THRESHOLD       = 1 << 3,
749 };
750
751 /**
752  * struct cfg80211_ops - backend description for wireless configuration
753  *
754  * This struct is registered by fullmac card drivers and/or wireless stacks
755  * in order to handle configuration requests on their interfaces.
756  *
757  * All callbacks except where otherwise noted should return 0
758  * on success or a negative error code.
759  *
760  * All operations are currently invoked under rtnl for consistency with the
761  * wireless extensions but this is subject to reevaluation as soon as this
762  * code is used more widely and we have a first user without wext.
763  *
764  * @suspend: wiphy device needs to be suspended
765  * @resume: wiphy device needs to be resumed
766  *
767  * @add_virtual_intf: create a new virtual interface with the given name,
768  *      must set the struct wireless_dev's iftype.
769  *
770  * @del_virtual_intf: remove the virtual interface determined by ifindex.
771  *
772  * @change_virtual_intf: change type/configuration of virtual interface,
773  *      keep the struct wireless_dev's iftype updated.
774  *
775  * @add_key: add a key with the given parameters. @mac_addr will be %NULL
776  *      when adding a group key.
777  *
778  * @get_key: get information about the key with the given parameters.
779  *      @mac_addr will be %NULL when requesting information for a group
780  *      key. All pointers given to the @callback function need not be valid
781  *      after it returns.
782  *
783  * @del_key: remove a key given the @mac_addr (%NULL for a group key)
784  *      and @key_index
785  *
786  * @set_default_key: set the default key on an interface
787  *
788  * @set_default_mgmt_key: set the default management frame key on an interface
789  *
790  * @add_beacon: Add a beacon with given parameters, @head, @interval
791  *      and @dtim_period will be valid, @tail is optional.
792  * @set_beacon: Change the beacon parameters for an access point mode
793  *      interface. This should reject the call when no beacon has been
794  *      configured.
795  * @del_beacon: Remove beacon configuration and stop sending the beacon.
796  *
797  * @add_station: Add a new station.
798  *
799  * @del_station: Remove a station; @mac may be NULL to remove all stations.
800  *
801  * @change_station: Modify a given station.
802  *
803  * @get_mesh_params: Put the current mesh parameters into *params
804  *
805  * @set_mesh_params: Set mesh parameters.
806  *      The mask is a bitfield which tells us which parameters to
807  *      set, and which to leave alone.
808  *
809  * @set_mesh_cfg: set mesh parameters (by now, just mesh id)
810  *
811  * @change_bss: Modify parameters for a given BSS.
812  *
813  * @set_txq_params: Set TX queue parameters
814  *
815  * @set_channel: Set channel
816  *
817  * @scan: Request to do a scan. If returning zero, the scan request is given
818  *      the driver, and will be valid until passed to cfg80211_scan_done().
819  *      For scan results, call cfg80211_inform_bss(); you can call this outside
820  *      the scan/scan_done bracket too.
821  *
822  * @auth: Request to authenticate with the specified peer
823  * @assoc: Request to (re)associate with the specified peer
824  * @deauth: Request to deauthenticate from the specified peer
825  * @disassoc: Request to disassociate from the specified peer
826  *
827  * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
828  *      cfg80211_ibss_joined(), also call that function when changing BSSID due
829  *      to a merge.
830  * @leave_ibss: Leave the IBSS.
831  *
832  * @set_wiphy_params: Notify that wiphy parameters have changed;
833  *      @changed bitfield (see &enum wiphy_params_flags) describes which values
834  *      have changed. The actual parameter values are available in
835  *      struct wiphy. If returning an error, no value should be changed.
836  */
837 struct cfg80211_ops {
838         int     (*suspend)(struct wiphy *wiphy);
839         int     (*resume)(struct wiphy *wiphy);
840
841         int     (*add_virtual_intf)(struct wiphy *wiphy, char *name,
842                                     enum nl80211_iftype type, u32 *flags,
843                                     struct vif_params *params);
844         int     (*del_virtual_intf)(struct wiphy *wiphy, int ifindex);
845         int     (*change_virtual_intf)(struct wiphy *wiphy, int ifindex,
846                                        enum nl80211_iftype type, u32 *flags,
847                                        struct vif_params *params);
848
849         int     (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
850                            u8 key_index, const u8 *mac_addr,
851                            struct key_params *params);
852         int     (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
853                            u8 key_index, const u8 *mac_addr, void *cookie,
854                            void (*callback)(void *cookie, struct key_params*));
855         int     (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
856                            u8 key_index, const u8 *mac_addr);
857         int     (*set_default_key)(struct wiphy *wiphy,
858                                    struct net_device *netdev,
859                                    u8 key_index);
860         int     (*set_default_mgmt_key)(struct wiphy *wiphy,
861                                         struct net_device *netdev,
862                                         u8 key_index);
863
864         int     (*add_beacon)(struct wiphy *wiphy, struct net_device *dev,
865                               struct beacon_parameters *info);
866         int     (*set_beacon)(struct wiphy *wiphy, struct net_device *dev,
867                               struct beacon_parameters *info);
868         int     (*del_beacon)(struct wiphy *wiphy, struct net_device *dev);
869
870
871         int     (*add_station)(struct wiphy *wiphy, struct net_device *dev,
872                                u8 *mac, struct station_parameters *params);
873         int     (*del_station)(struct wiphy *wiphy, struct net_device *dev,
874                                u8 *mac);
875         int     (*change_station)(struct wiphy *wiphy, struct net_device *dev,
876                                   u8 *mac, struct station_parameters *params);
877         int     (*get_station)(struct wiphy *wiphy, struct net_device *dev,
878                                u8 *mac, struct station_info *sinfo);
879         int     (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
880                                int idx, u8 *mac, struct station_info *sinfo);
881
882         int     (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
883                                u8 *dst, u8 *next_hop);
884         int     (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
885                                u8 *dst);
886         int     (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
887                                   u8 *dst, u8 *next_hop);
888         int     (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
889                                u8 *dst, u8 *next_hop,
890                                struct mpath_info *pinfo);
891         int     (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
892                                int idx, u8 *dst, u8 *next_hop,
893                                struct mpath_info *pinfo);
894         int     (*get_mesh_params)(struct wiphy *wiphy,
895                                 struct net_device *dev,
896                                 struct mesh_config *conf);
897         int     (*set_mesh_params)(struct wiphy *wiphy,
898                                 struct net_device *dev,
899                                 const struct mesh_config *nconf, u32 mask);
900         int     (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
901                               struct bss_parameters *params);
902
903         int     (*set_txq_params)(struct wiphy *wiphy,
904                                   struct ieee80211_txq_params *params);
905
906         int     (*set_channel)(struct wiphy *wiphy,
907                                struct ieee80211_channel *chan,
908                                enum nl80211_channel_type channel_type);
909
910         int     (*scan)(struct wiphy *wiphy, struct net_device *dev,
911                         struct cfg80211_scan_request *request);
912
913         int     (*auth)(struct wiphy *wiphy, struct net_device *dev,
914                         struct cfg80211_auth_request *req);
915         int     (*assoc)(struct wiphy *wiphy, struct net_device *dev,
916                          struct cfg80211_assoc_request *req);
917         int     (*deauth)(struct wiphy *wiphy, struct net_device *dev,
918                           struct cfg80211_deauth_request *req);
919         int     (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
920                             struct cfg80211_disassoc_request *req);
921
922         int     (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
923                              struct cfg80211_ibss_params *params);
924         int     (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
925
926         int     (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
927 };
928
929 /*
930  * wireless hardware and networking interfaces structures
931  * and registration/helper functions
932  */
933
934 /**
935  * struct wiphy - wireless hardware description
936  * @idx: the wiphy index assigned to this item
937  * @class_dev: the class device representing /sys/class/ieee80211/<wiphy-name>
938  * @custom_regulatory: tells us the driver for this device
939  *      has its own custom regulatory domain and cannot identify the
940  *      ISO / IEC 3166 alpha2 it belongs to. When this is enabled
941  *      we will disregard the first regulatory hint (when the
942  *      initiator is %REGDOM_SET_BY_CORE).
943  * @strict_regulatory: tells us the driver for this device will ignore
944  *      regulatory domain settings until it gets its own regulatory domain
945  *      via its regulatory_hint(). After its gets its own regulatory domain
946  *      it will only allow further regulatory domain settings to further
947  *      enhance compliance. For example if channel 13 and 14 are disabled
948  *      by this regulatory domain no user regulatory domain can enable these
949  *      channels at a later time. This can be used for devices which do not
950  *      have calibration information gauranteed for frequencies or settings
951  *      outside of its regulatory domain.
952  * @reg_notifier: the driver's regulatory notification callback
953  * @regd: the driver's regulatory domain, if one was requested via
954  *      the regulatory_hint() API. This can be used by the driver
955  *      on the reg_notifier() if it chooses to ignore future
956  *      regulatory domain changes caused by other drivers.
957  * @signal_type: signal type reported in &struct cfg80211_bss.
958  * @cipher_suites: supported cipher suites
959  * @n_cipher_suites: number of supported cipher suites
960  * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
961  * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
962  * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
963  *      -1 = fragmentation disabled, only odd values >= 256 used
964  * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
965  */
966 struct wiphy {
967         /* assign these fields before you register the wiphy */
968
969         /* permanent MAC address */
970         u8 perm_addr[ETH_ALEN];
971
972         /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
973         u16 interface_modes;
974
975         bool custom_regulatory;
976         bool strict_regulatory;
977
978         enum cfg80211_signal_type signal_type;
979
980         int bss_priv_size;
981         u8 max_scan_ssids;
982         u16 max_scan_ie_len;
983
984         int n_cipher_suites;
985         const u32 *cipher_suites;
986
987         u8 retry_short;
988         u8 retry_long;
989         u32 frag_threshold;
990         u32 rts_threshold;
991
992         /* If multiple wiphys are registered and you're handed e.g.
993          * a regular netdev with assigned ieee80211_ptr, you won't
994          * know whether it points to a wiphy your driver has registered
995          * or not. Assign this to something global to your driver to
996          * help determine whether you own this wiphy or not. */
997         void *privid;
998
999         struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
1000
1001         /* Lets us get back the wiphy on the callback */
1002         int (*reg_notifier)(struct wiphy *wiphy,
1003                             struct regulatory_request *request);
1004
1005         /* fields below are read-only, assigned by cfg80211 */
1006
1007         const struct ieee80211_regdomain *regd;
1008
1009         /* the item in /sys/class/ieee80211/ points to this,
1010          * you need use set_wiphy_dev() (see below) */
1011         struct device dev;
1012
1013         /* dir in debugfs: ieee80211/<wiphyname> */
1014         struct dentry *debugfsdir;
1015
1016         char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
1017 };
1018
1019 /**
1020  * wiphy_priv - return priv from wiphy
1021  *
1022  * @wiphy: the wiphy whose priv pointer to return
1023  */
1024 static inline void *wiphy_priv(struct wiphy *wiphy)
1025 {
1026         BUG_ON(!wiphy);
1027         return &wiphy->priv;
1028 }
1029
1030 /**
1031  * set_wiphy_dev - set device pointer for wiphy
1032  *
1033  * @wiphy: The wiphy whose device to bind
1034  * @dev: The device to parent it to
1035  */
1036 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
1037 {
1038         wiphy->dev.parent = dev;
1039 }
1040
1041 /**
1042  * wiphy_dev - get wiphy dev pointer
1043  *
1044  * @wiphy: The wiphy whose device struct to look up
1045  */
1046 static inline struct device *wiphy_dev(struct wiphy *wiphy)
1047 {
1048         return wiphy->dev.parent;
1049 }
1050
1051 /**
1052  * wiphy_name - get wiphy name
1053  *
1054  * @wiphy: The wiphy whose name to return
1055  */
1056 static inline const char *wiphy_name(struct wiphy *wiphy)
1057 {
1058         return dev_name(&wiphy->dev);
1059 }
1060
1061 /**
1062  * wiphy_new - create a new wiphy for use with cfg80211
1063  *
1064  * @ops: The configuration operations for this device
1065  * @sizeof_priv: The size of the private area to allocate
1066  *
1067  * Create a new wiphy and associate the given operations with it.
1068  * @sizeof_priv bytes are allocated for private use.
1069  *
1070  * The returned pointer must be assigned to each netdev's
1071  * ieee80211_ptr for proper operation.
1072  */
1073 struct wiphy *wiphy_new(struct cfg80211_ops *ops, int sizeof_priv);
1074
1075 /**
1076  * wiphy_register - register a wiphy with cfg80211
1077  *
1078  * @wiphy: The wiphy to register.
1079  *
1080  * Returns a non-negative wiphy index or a negative error code.
1081  */
1082 extern int wiphy_register(struct wiphy *wiphy);
1083
1084 /**
1085  * wiphy_unregister - deregister a wiphy from cfg80211
1086  *
1087  * @wiphy: The wiphy to unregister.
1088  *
1089  * After this call, no more requests can be made with this priv
1090  * pointer, but the call may sleep to wait for an outstanding
1091  * request that is being handled.
1092  */
1093 extern void wiphy_unregister(struct wiphy *wiphy);
1094
1095 /**
1096  * wiphy_free - free wiphy
1097  *
1098  * @wiphy: The wiphy to free
1099  */
1100 extern void wiphy_free(struct wiphy *wiphy);
1101
1102 /**
1103  * struct wireless_dev - wireless per-netdev state
1104  *
1105  * This structure must be allocated by the driver/stack
1106  * that uses the ieee80211_ptr field in struct net_device
1107  * (this is intentional so it can be allocated along with
1108  * the netdev.)
1109  *
1110  * @wiphy: pointer to hardware description
1111  * @iftype: interface type
1112  * @list: (private) Used to collect the interfaces
1113  * @netdev: (private) Used to reference back to the netdev
1114  * @current_bss: (private) Used by the internal configuration code
1115  * @bssid: (private) Used by the internal configuration code
1116  * @ssid: (private) Used by the internal configuration code
1117  * @ssid_len: (private) Used by the internal configuration code
1118  * @wext: (private) Used by the internal wireless extensions compat code
1119  * @wext_bssid: (private) Used by the internal wireless extensions compat code
1120  */
1121 struct wireless_dev {
1122         struct wiphy *wiphy;
1123         enum nl80211_iftype iftype;
1124
1125         /* private to the generic wireless code */
1126         struct list_head list;
1127         struct net_device *netdev;
1128
1129         /* currently used for IBSS - might be rearranged in the future */
1130         struct cfg80211_bss *current_bss;
1131         u8 bssid[ETH_ALEN];
1132         u8 ssid[IEEE80211_MAX_SSID_LEN];
1133         u8 ssid_len;
1134
1135 #ifdef CONFIG_WIRELESS_EXT
1136         /* wext data */
1137         struct {
1138                 struct cfg80211_ibss_params ibss;
1139                 u8 bssid[ETH_ALEN];
1140                 s8 default_key, default_mgmt_key;
1141         } wext;
1142 #endif
1143 };
1144
1145 /**
1146  * wdev_priv - return wiphy priv from wireless_dev
1147  *
1148  * @wdev: The wireless device whose wiphy's priv pointer to return
1149  */
1150 static inline void *wdev_priv(struct wireless_dev *wdev)
1151 {
1152         BUG_ON(!wdev);
1153         return wiphy_priv(wdev->wiphy);
1154 }
1155
1156 /*
1157  * Utility functions
1158  */
1159
1160 /**
1161  * ieee80211_channel_to_frequency - convert channel number to frequency
1162  */
1163 extern int ieee80211_channel_to_frequency(int chan);
1164
1165 /**
1166  * ieee80211_frequency_to_channel - convert frequency to channel number
1167  */
1168 extern int ieee80211_frequency_to_channel(int freq);
1169
1170 /*
1171  * Name indirection necessary because the ieee80211 code also has
1172  * a function named "ieee80211_get_channel", so if you include
1173  * cfg80211's header file you get cfg80211's version, if you try
1174  * to include both header files you'll (rightfully!) get a symbol
1175  * clash.
1176  */
1177 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
1178                                                          int freq);
1179 /**
1180  * ieee80211_get_channel - get channel struct from wiphy for specified frequency
1181  */
1182 static inline struct ieee80211_channel *
1183 ieee80211_get_channel(struct wiphy *wiphy, int freq)
1184 {
1185         return __ieee80211_get_channel(wiphy, freq);
1186 }
1187
1188 /**
1189  * ieee80211_get_response_rate - get basic rate for a given rate
1190  *
1191  * @sband: the band to look for rates in
1192  * @basic_rates: bitmap of basic rates
1193  * @bitrate: the bitrate for which to find the basic rate
1194  *
1195  * This function returns the basic rate corresponding to a given
1196  * bitrate, that is the next lower bitrate contained in the basic
1197  * rate map, which is, for this function, given as a bitmap of
1198  * indices of rates in the band's bitrate table.
1199  */
1200 struct ieee80211_rate *
1201 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
1202                             u32 basic_rates, int bitrate);
1203
1204 /*
1205  * Radiotap parsing functions -- for controlled injection support
1206  *
1207  * Implemented in net/wireless/radiotap.c
1208  * Documentation in Documentation/networking/radiotap-headers.txt
1209  */
1210
1211 /**
1212  * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
1213  * @rtheader: pointer to the radiotap header we are walking through
1214  * @max_length: length of radiotap header in cpu byte ordering
1215  * @this_arg_index: IEEE80211_RADIOTAP_... index of current arg
1216  * @this_arg: pointer to current radiotap arg
1217  * @arg_index: internal next argument index
1218  * @arg: internal next argument pointer
1219  * @next_bitmap: internal pointer to next present u32
1220  * @bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
1221  */
1222
1223 struct ieee80211_radiotap_iterator {
1224         struct ieee80211_radiotap_header *rtheader;
1225         int max_length;
1226         int this_arg_index;
1227         u8 *this_arg;
1228
1229         int arg_index;
1230         u8 *arg;
1231         __le32 *next_bitmap;
1232         u32 bitmap_shifter;
1233 };
1234
1235 extern int ieee80211_radiotap_iterator_init(
1236    struct ieee80211_radiotap_iterator *iterator,
1237    struct ieee80211_radiotap_header *radiotap_header,
1238    int max_length);
1239
1240 extern int ieee80211_radiotap_iterator_next(
1241    struct ieee80211_radiotap_iterator *iterator);
1242
1243 /*
1244  * Regulatory helper functions for wiphys
1245  */
1246
1247 /**
1248  * regulatory_hint - driver hint to the wireless core a regulatory domain
1249  * @wiphy: the wireless device giving the hint (used only for reporting
1250  *      conflicts)
1251  * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
1252  *      should be in. If @rd is set this should be NULL. Note that if you
1253  *      set this to NULL you should still set rd->alpha2 to some accepted
1254  *      alpha2.
1255  *
1256  * Wireless drivers can use this function to hint to the wireless core
1257  * what it believes should be the current regulatory domain by
1258  * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
1259  * domain should be in or by providing a completely build regulatory domain.
1260  * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
1261  * for a regulatory domain structure for the respective country.
1262  *
1263  * The wiphy must have been registered to cfg80211 prior to this call.
1264  * For cfg80211 drivers this means you must first use wiphy_register(),
1265  * for mac80211 drivers you must first use ieee80211_register_hw().
1266  *
1267  * Drivers should check the return value, its possible you can get
1268  * an -ENOMEM.
1269  */
1270 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
1271
1272 /**
1273  * regulatory_hint_11d - hints a country IE as a regulatory domain
1274  * @wiphy: the wireless device giving the hint (used only for reporting
1275  *      conflicts)
1276  * @country_ie: pointer to the country IE
1277  * @country_ie_len: length of the country IE
1278  *
1279  * We will intersect the rd with the what CRDA tells us should apply
1280  * for the alpha2 this country IE belongs to, this prevents APs from
1281  * sending us incorrect or outdated information against a country.
1282  */
1283 extern void regulatory_hint_11d(struct wiphy *wiphy,
1284                                 u8 *country_ie,
1285                                 u8 country_ie_len);
1286 /**
1287  * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
1288  * @wiphy: the wireless device we want to process the regulatory domain on
1289  * @regd: the custom regulatory domain to use for this wiphy
1290  *
1291  * Drivers can sometimes have custom regulatory domains which do not apply
1292  * to a specific country. Drivers can use this to apply such custom regulatory
1293  * domains. This routine must be called prior to wiphy registration. The
1294  * custom regulatory domain will be trusted completely and as such previous
1295  * default channel settings will be disregarded. If no rule is found for a
1296  * channel on the regulatory domain the channel will be disabled.
1297  */
1298 extern void wiphy_apply_custom_regulatory(
1299         struct wiphy *wiphy,
1300         const struct ieee80211_regdomain *regd);
1301
1302 /**
1303  * freq_reg_info - get regulatory information for the given frequency
1304  * @wiphy: the wiphy for which we want to process this rule for
1305  * @center_freq: Frequency in KHz for which we want regulatory information for
1306  * @bandwidth: the bandwidth requirement you have in KHz, if you do not have one
1307  *      you can set this to 0. If this frequency is allowed we then set
1308  *      this value to the maximum allowed bandwidth.
1309  * @reg_rule: the regulatory rule which we have for this frequency
1310  *
1311  * Use this function to get the regulatory rule for a specific frequency on
1312  * a given wireless device. If the device has a specific regulatory domain
1313  * it wants to follow we respect that unless a country IE has been received
1314  * and processed already.
1315  *
1316  * Returns 0 if it was able to find a valid regulatory rule which does
1317  * apply to the given center_freq otherwise it returns non-zero. It will
1318  * also return -ERANGE if we determine the given center_freq does not even have
1319  * a regulatory rule for a frequency range in the center_freq's band. See
1320  * freq_in_rule_band() for our current definition of a band -- this is purely
1321  * subjective and right now its 802.11 specific.
1322  */
1323 extern int freq_reg_info(struct wiphy *wiphy, u32 center_freq, u32 *bandwidth,
1324                          const struct ieee80211_reg_rule **reg_rule);
1325
1326 /*
1327  * Temporary wext handlers & helper functions
1328  *
1329  * In the future cfg80211 will simply assign the entire wext handler
1330  * structure to netdevs it manages, but we're not there yet.
1331  */
1332 int cfg80211_wext_giwname(struct net_device *dev,
1333                           struct iw_request_info *info,
1334                           char *name, char *extra);
1335 int cfg80211_wext_siwmode(struct net_device *dev, struct iw_request_info *info,
1336                           u32 *mode, char *extra);
1337 int cfg80211_wext_giwmode(struct net_device *dev, struct iw_request_info *info,
1338                           u32 *mode, char *extra);
1339 int cfg80211_wext_siwscan(struct net_device *dev,
1340                           struct iw_request_info *info,
1341                           union iwreq_data *wrqu, char *extra);
1342 int cfg80211_wext_giwscan(struct net_device *dev,
1343                           struct iw_request_info *info,
1344                           struct iw_point *data, char *extra);
1345 int cfg80211_wext_siwmlme(struct net_device *dev,
1346                           struct iw_request_info *info,
1347                           struct iw_point *data, char *extra);
1348 int cfg80211_wext_giwrange(struct net_device *dev,
1349                            struct iw_request_info *info,
1350                            struct iw_point *data, char *extra);
1351 int cfg80211_ibss_wext_siwfreq(struct net_device *dev,
1352                                struct iw_request_info *info,
1353                                struct iw_freq *freq, char *extra);
1354 int cfg80211_ibss_wext_giwfreq(struct net_device *dev,
1355                                struct iw_request_info *info,
1356                                struct iw_freq *freq, char *extra);
1357 int cfg80211_ibss_wext_siwessid(struct net_device *dev,
1358                                 struct iw_request_info *info,
1359                                 struct iw_point *data, char *ssid);
1360 int cfg80211_ibss_wext_giwessid(struct net_device *dev,
1361                                 struct iw_request_info *info,
1362                                 struct iw_point *data, char *ssid);
1363 int cfg80211_ibss_wext_siwap(struct net_device *dev,
1364                              struct iw_request_info *info,
1365                              struct sockaddr *ap_addr, char *extra);
1366 int cfg80211_ibss_wext_giwap(struct net_device *dev,
1367                              struct iw_request_info *info,
1368                              struct sockaddr *ap_addr, char *extra);
1369
1370 struct ieee80211_channel *cfg80211_wext_freq(struct wiphy *wiphy,
1371                                              struct iw_freq *freq);
1372
1373 int cfg80211_wext_siwrts(struct net_device *dev,
1374                          struct iw_request_info *info,
1375                          struct iw_param *rts, char *extra);
1376 int cfg80211_wext_giwrts(struct net_device *dev,
1377                          struct iw_request_info *info,
1378                          struct iw_param *rts, char *extra);
1379 int cfg80211_wext_siwfrag(struct net_device *dev,
1380                           struct iw_request_info *info,
1381                           struct iw_param *frag, char *extra);
1382 int cfg80211_wext_giwfrag(struct net_device *dev,
1383                           struct iw_request_info *info,
1384                           struct iw_param *frag, char *extra);
1385 int cfg80211_wext_siwretry(struct net_device *dev,
1386                            struct iw_request_info *info,
1387                            struct iw_param *retry, char *extra);
1388 int cfg80211_wext_giwretry(struct net_device *dev,
1389                            struct iw_request_info *info,
1390                            struct iw_param *retry, char *extra);
1391 int cfg80211_wext_siwencodeext(struct net_device *dev,
1392                                struct iw_request_info *info,
1393                                struct iw_point *erq, char *extra);
1394 int cfg80211_wext_siwencode(struct net_device *dev,
1395                             struct iw_request_info *info,
1396                             struct iw_point *erq, char *keybuf);
1397 int cfg80211_wext_giwencode(struct net_device *dev,
1398                             struct iw_request_info *info,
1399                             struct iw_point *erq, char *keybuf);
1400
1401 /*
1402  * callbacks for asynchronous cfg80211 methods, notification
1403  * functions and BSS handling helpers
1404  */
1405
1406 /**
1407  * cfg80211_scan_done - notify that scan finished
1408  *
1409  * @request: the corresponding scan request
1410  * @aborted: set to true if the scan was aborted for any reason,
1411  *      userspace will be notified of that
1412  */
1413 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
1414
1415 /**
1416  * cfg80211_inform_bss - inform cfg80211 of a new BSS
1417  *
1418  * @wiphy: the wiphy reporting the BSS
1419  * @bss: the found BSS
1420  * @signal: the signal strength, type depends on the wiphy's signal_type
1421  * @gfp: context flags
1422  *
1423  * This informs cfg80211 that BSS information was found and
1424  * the BSS should be updated/added.
1425  */
1426 struct cfg80211_bss*
1427 cfg80211_inform_bss_frame(struct wiphy *wiphy,
1428                           struct ieee80211_channel *channel,
1429                           struct ieee80211_mgmt *mgmt, size_t len,
1430                           s32 signal, gfp_t gfp);
1431
1432 struct cfg80211_bss*
1433 cfg80211_inform_bss(struct wiphy *wiphy,
1434                     struct ieee80211_channel *channel,
1435                     const u8 *bssid,
1436                     u64 timestamp, u16 capability, u16 beacon_interval,
1437                     const u8 *ie, size_t ielen,
1438                     s32 signal, gfp_t gfp);
1439
1440 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
1441                                       struct ieee80211_channel *channel,
1442                                       const u8 *bssid,
1443                                       const u8 *ssid, size_t ssid_len,
1444                                       u16 capa_mask, u16 capa_val);
1445 static inline struct cfg80211_bss *
1446 cfg80211_get_ibss(struct wiphy *wiphy,
1447                   struct ieee80211_channel *channel,
1448                   const u8 *ssid, size_t ssid_len)
1449 {
1450         return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
1451                                 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
1452 }
1453
1454 struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
1455                                        struct ieee80211_channel *channel,
1456                                        const u8 *meshid, size_t meshidlen,
1457                                        const u8 *meshcfg);
1458 void cfg80211_put_bss(struct cfg80211_bss *bss);
1459
1460 /**
1461  * cfg80211_unlink_bss - unlink BSS from internal data structures
1462  * @wiphy: the wiphy
1463  * @bss: the bss to remove
1464  *
1465  * This function removes the given BSS from the internal data structures
1466  * thereby making it no longer show up in scan results etc. Use this
1467  * function when you detect a BSS is gone. Normally BSSes will also time
1468  * out, so it is not necessary to use this function at all.
1469  */
1470 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
1471
1472 /**
1473  * cfg80211_send_rx_auth - notification of processed authentication
1474  * @dev: network device
1475  * @buf: authentication frame (header + body)
1476  * @len: length of the frame data
1477  *
1478  * This function is called whenever an authentication has been processed in
1479  * station mode. The driver is required to call either this function or
1480  * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
1481  * call.
1482  */
1483 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
1484
1485 /**
1486  * cfg80211_send_auth_timeout - notification of timed out authentication
1487  * @dev: network device
1488  * @addr: The MAC address of the device with which the authentication timed out
1489  */
1490 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
1491
1492 /**
1493  * cfg80211_send_rx_assoc - notification of processed association
1494  * @dev: network device
1495  * @buf: (re)association response frame (header + body)
1496  * @len: length of the frame data
1497  *
1498  * This function is called whenever a (re)association response has been
1499  * processed in station mode. The driver is required to call either this
1500  * function or cfg80211_send_assoc_timeout() to indicate the result of
1501  * cfg80211_ops::assoc() call.
1502  */
1503 void cfg80211_send_rx_assoc(struct net_device *dev, const u8 *buf, size_t len);
1504
1505 /**
1506  * cfg80211_send_assoc_timeout - notification of timed out association
1507  * @dev: network device
1508  * @addr: The MAC address of the device with which the association timed out
1509  */
1510 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
1511
1512 /**
1513  * cfg80211_send_deauth - notification of processed deauthentication
1514  * @dev: network device
1515  * @buf: deauthentication frame (header + body)
1516  * @len: length of the frame data
1517  *
1518  * This function is called whenever deauthentication has been processed in
1519  * station mode. This includes both received deauthentication frames and
1520  * locally generated ones.
1521  */
1522 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
1523
1524 /**
1525  * cfg80211_send_disassoc - notification of processed disassociation
1526  * @dev: network device
1527  * @buf: disassociation response frame (header + body)
1528  * @len: length of the frame data
1529  *
1530  * This function is called whenever disassociation has been processed in
1531  * station mode. This includes both received disassociation frames and locally
1532  * generated ones.
1533  */
1534 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
1535
1536 /**
1537  * cfg80211_hold_bss - exclude bss from expiration
1538  * @bss: bss which should not expire
1539  *
1540  * In a case when the BSS is not updated but it shouldn't expire this
1541  * function can be used to mark the BSS to be excluded from expiration.
1542  */
1543 void cfg80211_hold_bss(struct cfg80211_bss *bss);
1544
1545 /**
1546  * cfg80211_unhold_bss - remove expiration exception from the BSS
1547  * @bss: bss which can expire again
1548  *
1549  * This function marks the BSS to be expirable again.
1550  */
1551 void cfg80211_unhold_bss(struct cfg80211_bss *bss);
1552
1553 /**
1554  * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
1555  * @dev: network device
1556  * @addr: The source MAC address of the frame
1557  * @key_type: The key type that the received frame used
1558  * @key_id: Key identifier (0..3)
1559  * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
1560  *
1561  * This function is called whenever the local MAC detects a MIC failure in a
1562  * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
1563  * primitive.
1564  */
1565 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
1566                                   enum nl80211_key_type key_type, int key_id,
1567                                   const u8 *tsc);
1568
1569 /**
1570  * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
1571  *
1572  * @dev: network device
1573  * @bssid: the BSSID of the IBSS joined
1574  * @gfp: allocation flags
1575  *
1576  * This function notifies cfg80211 that the device joined an IBSS or
1577  * switched to a different BSSID. Before this function can be called,
1578  * either a beacon has to have been received from the IBSS, or one of
1579  * the cfg80211_inform_bss{,_frame} functions must have been called
1580  * with the locally generated beacon -- this guarantees that there is
1581  * always a scan result for this IBSS. cfg80211 will handle the rest.
1582  */
1583 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
1584
1585 #endif /* __NET_CFG80211_H */