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