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