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