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