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