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