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