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