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