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