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