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