xref: /linux/include/net/cfg80211.h (revision 13091aa30535b719e269f20a7bc34002bf5afae5)
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-2017	Intel Deutschland GmbH
9  * Copyright (C) 2018-2019 Intel Corporation
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License version 2 as
13  * published by the Free Software Foundation.
14  */
15 
16 #include <linux/netdevice.h>
17 #include <linux/debugfs.h>
18 #include <linux/list.h>
19 #include <linux/bug.h>
20 #include <linux/netlink.h>
21 #include <linux/skbuff.h>
22 #include <linux/nl80211.h>
23 #include <linux/if_ether.h>
24 #include <linux/ieee80211.h>
25 #include <linux/net.h>
26 #include <net/regulatory.h>
27 
28 /**
29  * DOC: Introduction
30  *
31  * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
32  * userspace and drivers, and offers some utility functionality associated
33  * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
34  * by all modern wireless drivers in Linux, so that they offer a consistent
35  * API through nl80211. For backward compatibility, cfg80211 also offers
36  * wireless extensions to userspace, but hides them from drivers completely.
37  *
38  * Additionally, cfg80211 contains code to help enforce regulatory spectrum
39  * use restrictions.
40  */
41 
42 
43 /**
44  * DOC: Device registration
45  *
46  * In order for a driver to use cfg80211, it must register the hardware device
47  * with cfg80211. This happens through a number of hardware capability structs
48  * described below.
49  *
50  * The fundamental structure for each device is the 'wiphy', of which each
51  * instance describes a physical wireless device connected to the system. Each
52  * such wiphy can have zero, one, or many virtual interfaces associated with
53  * it, which need to be identified as such by pointing the network interface's
54  * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
55  * the wireless part of the interface, normally this struct is embedded in the
56  * network interface's private data area. Drivers can optionally allow creating
57  * or destroying virtual interfaces on the fly, but without at least one or the
58  * ability to create some the wireless device isn't useful.
59  *
60  * Each wiphy structure contains device capability information, and also has
61  * a pointer to the various operations the driver offers. The definitions and
62  * structures here describe these capabilities in detail.
63  */
64 
65 struct wiphy;
66 
67 /*
68  * wireless hardware capability structures
69  */
70 
71 /**
72  * enum ieee80211_channel_flags - channel flags
73  *
74  * Channel flags set by the regulatory control code.
75  *
76  * @IEEE80211_CHAN_DISABLED: This channel is disabled.
77  * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
78  * 	sending probe requests or beaconing.
79  * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
80  * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
81  * 	is not permitted.
82  * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
83  * 	is not permitted.
84  * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
85  * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
86  *	this flag indicates that an 80 MHz channel cannot use this
87  *	channel as the control or any of the secondary channels.
88  *	This may be due to the driver or due to regulatory bandwidth
89  *	restrictions.
90  * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
91  *	this flag indicates that an 160 MHz channel cannot use this
92  *	channel as the control or any of the secondary channels.
93  *	This may be due to the driver or due to regulatory bandwidth
94  *	restrictions.
95  * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
96  * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
97  * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
98  *	on this channel.
99  * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
100  *	on this channel.
101  *
102  */
103 enum ieee80211_channel_flags {
104 	IEEE80211_CHAN_DISABLED		= 1<<0,
105 	IEEE80211_CHAN_NO_IR		= 1<<1,
106 	/* hole at 1<<2 */
107 	IEEE80211_CHAN_RADAR		= 1<<3,
108 	IEEE80211_CHAN_NO_HT40PLUS	= 1<<4,
109 	IEEE80211_CHAN_NO_HT40MINUS	= 1<<5,
110 	IEEE80211_CHAN_NO_OFDM		= 1<<6,
111 	IEEE80211_CHAN_NO_80MHZ		= 1<<7,
112 	IEEE80211_CHAN_NO_160MHZ	= 1<<8,
113 	IEEE80211_CHAN_INDOOR_ONLY	= 1<<9,
114 	IEEE80211_CHAN_IR_CONCURRENT	= 1<<10,
115 	IEEE80211_CHAN_NO_20MHZ		= 1<<11,
116 	IEEE80211_CHAN_NO_10MHZ		= 1<<12,
117 };
118 
119 #define IEEE80211_CHAN_NO_HT40 \
120 	(IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
121 
122 #define IEEE80211_DFS_MIN_CAC_TIME_MS		60000
123 #define IEEE80211_DFS_MIN_NOP_TIME_MS		(30 * 60 * 1000)
124 
125 /**
126  * struct ieee80211_channel - channel definition
127  *
128  * This structure describes a single channel for use
129  * with cfg80211.
130  *
131  * @center_freq: center frequency in MHz
132  * @hw_value: hardware-specific value for the channel
133  * @flags: channel flags from &enum ieee80211_channel_flags.
134  * @orig_flags: channel flags at registration time, used by regulatory
135  *	code to support devices with additional restrictions
136  * @band: band this channel belongs to.
137  * @max_antenna_gain: maximum antenna gain in dBi
138  * @max_power: maximum transmission power (in dBm)
139  * @max_reg_power: maximum regulatory transmission power (in dBm)
140  * @beacon_found: helper to regulatory code to indicate when a beacon
141  *	has been found on this channel. Use regulatory_hint_found_beacon()
142  *	to enable this, this is useful only on 5 GHz band.
143  * @orig_mag: internal use
144  * @orig_mpwr: internal use
145  * @dfs_state: current state of this channel. Only relevant if radar is required
146  *	on this channel.
147  * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
148  * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
149  */
150 struct ieee80211_channel {
151 	enum nl80211_band band;
152 	u32 center_freq;
153 	u16 hw_value;
154 	u32 flags;
155 	int max_antenna_gain;
156 	int max_power;
157 	int max_reg_power;
158 	bool beacon_found;
159 	u32 orig_flags;
160 	int orig_mag, orig_mpwr;
161 	enum nl80211_dfs_state dfs_state;
162 	unsigned long dfs_state_entered;
163 	unsigned int dfs_cac_ms;
164 };
165 
166 /**
167  * enum ieee80211_rate_flags - rate flags
168  *
169  * Hardware/specification flags for rates. These are structured
170  * in a way that allows using the same bitrate structure for
171  * different bands/PHY modes.
172  *
173  * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
174  *	preamble on this bitrate; only relevant in 2.4GHz band and
175  *	with CCK rates.
176  * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
177  *	when used with 802.11a (on the 5 GHz band); filled by the
178  *	core code when registering the wiphy.
179  * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
180  *	when used with 802.11b (on the 2.4 GHz band); filled by the
181  *	core code when registering the wiphy.
182  * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
183  *	when used with 802.11g (on the 2.4 GHz band); filled by the
184  *	core code when registering the wiphy.
185  * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
186  * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
187  * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
188  */
189 enum ieee80211_rate_flags {
190 	IEEE80211_RATE_SHORT_PREAMBLE	= 1<<0,
191 	IEEE80211_RATE_MANDATORY_A	= 1<<1,
192 	IEEE80211_RATE_MANDATORY_B	= 1<<2,
193 	IEEE80211_RATE_MANDATORY_G	= 1<<3,
194 	IEEE80211_RATE_ERP_G		= 1<<4,
195 	IEEE80211_RATE_SUPPORTS_5MHZ	= 1<<5,
196 	IEEE80211_RATE_SUPPORTS_10MHZ	= 1<<6,
197 };
198 
199 /**
200  * enum ieee80211_bss_type - BSS type filter
201  *
202  * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
203  * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
204  * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
205  * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
206  * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
207  */
208 enum ieee80211_bss_type {
209 	IEEE80211_BSS_TYPE_ESS,
210 	IEEE80211_BSS_TYPE_PBSS,
211 	IEEE80211_BSS_TYPE_IBSS,
212 	IEEE80211_BSS_TYPE_MBSS,
213 	IEEE80211_BSS_TYPE_ANY
214 };
215 
216 /**
217  * enum ieee80211_privacy - BSS privacy filter
218  *
219  * @IEEE80211_PRIVACY_ON: privacy bit set
220  * @IEEE80211_PRIVACY_OFF: privacy bit clear
221  * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
222  */
223 enum ieee80211_privacy {
224 	IEEE80211_PRIVACY_ON,
225 	IEEE80211_PRIVACY_OFF,
226 	IEEE80211_PRIVACY_ANY
227 };
228 
229 #define IEEE80211_PRIVACY(x)	\
230 	((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
231 
232 /**
233  * struct ieee80211_rate - bitrate definition
234  *
235  * This structure describes a bitrate that an 802.11 PHY can
236  * operate with. The two values @hw_value and @hw_value_short
237  * are only for driver use when pointers to this structure are
238  * passed around.
239  *
240  * @flags: rate-specific flags
241  * @bitrate: bitrate in units of 100 Kbps
242  * @hw_value: driver/hardware value for this rate
243  * @hw_value_short: driver/hardware value for this rate when
244  *	short preamble is used
245  */
246 struct ieee80211_rate {
247 	u32 flags;
248 	u16 bitrate;
249 	u16 hw_value, hw_value_short;
250 };
251 
252 /**
253  * struct ieee80211_sta_ht_cap - STA's HT capabilities
254  *
255  * This structure describes most essential parameters needed
256  * to describe 802.11n HT capabilities for an STA.
257  *
258  * @ht_supported: is HT supported by the STA
259  * @cap: HT capabilities map as described in 802.11n spec
260  * @ampdu_factor: Maximum A-MPDU length factor
261  * @ampdu_density: Minimum A-MPDU spacing
262  * @mcs: Supported MCS rates
263  */
264 struct ieee80211_sta_ht_cap {
265 	u16 cap; /* use IEEE80211_HT_CAP_ */
266 	bool ht_supported;
267 	u8 ampdu_factor;
268 	u8 ampdu_density;
269 	struct ieee80211_mcs_info mcs;
270 };
271 
272 /**
273  * struct ieee80211_sta_vht_cap - STA's VHT capabilities
274  *
275  * This structure describes most essential parameters needed
276  * to describe 802.11ac VHT capabilities for an STA.
277  *
278  * @vht_supported: is VHT supported by the STA
279  * @cap: VHT capabilities map as described in 802.11ac spec
280  * @vht_mcs: Supported VHT MCS rates
281  */
282 struct ieee80211_sta_vht_cap {
283 	bool vht_supported;
284 	u32 cap; /* use IEEE80211_VHT_CAP_ */
285 	struct ieee80211_vht_mcs_info vht_mcs;
286 };
287 
288 #define IEEE80211_HE_PPE_THRES_MAX_LEN		25
289 
290 /**
291  * struct ieee80211_sta_he_cap - STA's HE capabilities
292  *
293  * This structure describes most essential parameters needed
294  * to describe 802.11ax HE capabilities for a STA.
295  *
296  * @has_he: true iff HE data is valid.
297  * @he_cap_elem: Fixed portion of the HE capabilities element.
298  * @he_mcs_nss_supp: The supported NSS/MCS combinations.
299  * @ppe_thres: Holds the PPE Thresholds data.
300  */
301 struct ieee80211_sta_he_cap {
302 	bool has_he;
303 	struct ieee80211_he_cap_elem he_cap_elem;
304 	struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp;
305 	u8 ppe_thres[IEEE80211_HE_PPE_THRES_MAX_LEN];
306 };
307 
308 /**
309  * struct ieee80211_sband_iftype_data
310  *
311  * This structure encapsulates sband data that is relevant for the
312  * interface types defined in @types_mask.  Each type in the
313  * @types_mask must be unique across all instances of iftype_data.
314  *
315  * @types_mask: interface types mask
316  * @he_cap: holds the HE capabilities
317  */
318 struct ieee80211_sband_iftype_data {
319 	u16 types_mask;
320 	struct ieee80211_sta_he_cap he_cap;
321 };
322 
323 /**
324  * struct ieee80211_supported_band - frequency band definition
325  *
326  * This structure describes a frequency band a wiphy
327  * is able to operate in.
328  *
329  * @channels: Array of channels the hardware can operate in
330  *	in this band.
331  * @band: the band this structure represents
332  * @n_channels: Number of channels in @channels
333  * @bitrates: Array of bitrates the hardware can operate with
334  *	in this band. Must be sorted to give a valid "supported
335  *	rates" IE, i.e. CCK rates first, then OFDM.
336  * @n_bitrates: Number of bitrates in @bitrates
337  * @ht_cap: HT capabilities in this band
338  * @vht_cap: VHT capabilities in this band
339  * @n_iftype_data: number of iftype data entries
340  * @iftype_data: interface type data entries.  Note that the bits in
341  *	@types_mask inside this structure cannot overlap (i.e. only
342  *	one occurrence of each type is allowed across all instances of
343  *	iftype_data).
344  */
345 struct ieee80211_supported_band {
346 	struct ieee80211_channel *channels;
347 	struct ieee80211_rate *bitrates;
348 	enum nl80211_band band;
349 	int n_channels;
350 	int n_bitrates;
351 	struct ieee80211_sta_ht_cap ht_cap;
352 	struct ieee80211_sta_vht_cap vht_cap;
353 	u16 n_iftype_data;
354 	const struct ieee80211_sband_iftype_data *iftype_data;
355 };
356 
357 /**
358  * ieee80211_get_sband_iftype_data - return sband data for a given iftype
359  * @sband: the sband to search for the STA on
360  * @iftype: enum nl80211_iftype
361  *
362  * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
363  */
364 static inline const struct ieee80211_sband_iftype_data *
365 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband,
366 				u8 iftype)
367 {
368 	int i;
369 
370 	if (WARN_ON(iftype >= NL80211_IFTYPE_MAX))
371 		return NULL;
372 
373 	for (i = 0; i < sband->n_iftype_data; i++)  {
374 		const struct ieee80211_sband_iftype_data *data =
375 			&sband->iftype_data[i];
376 
377 		if (data->types_mask & BIT(iftype))
378 			return data;
379 	}
380 
381 	return NULL;
382 }
383 
384 /**
385  * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype
386  * @sband: the sband to search for the iftype on
387  * @iftype: enum nl80211_iftype
388  *
389  * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
390  */
391 static inline const struct ieee80211_sta_he_cap *
392 ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band *sband,
393 			    u8 iftype)
394 {
395 	const struct ieee80211_sband_iftype_data *data =
396 		ieee80211_get_sband_iftype_data(sband, iftype);
397 
398 	if (data && data->he_cap.has_he)
399 		return &data->he_cap;
400 
401 	return NULL;
402 }
403 
404 /**
405  * ieee80211_get_he_sta_cap - return HE capabilities for an sband's STA
406  * @sband: the sband to search for the STA on
407  *
408  * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
409  */
410 static inline const struct ieee80211_sta_he_cap *
411 ieee80211_get_he_sta_cap(const struct ieee80211_supported_band *sband)
412 {
413 	return ieee80211_get_he_iftype_cap(sband, NL80211_IFTYPE_STATION);
414 }
415 
416 /**
417  * wiphy_read_of_freq_limits - read frequency limits from device tree
418  *
419  * @wiphy: the wireless device to get extra limits for
420  *
421  * Some devices may have extra limitations specified in DT. This may be useful
422  * for chipsets that normally support more bands but are limited due to board
423  * design (e.g. by antennas or external power amplifier).
424  *
425  * This function reads info from DT and uses it to *modify* channels (disable
426  * unavailable ones). It's usually a *bad* idea to use it in drivers with
427  * shared channel data as DT limitations are device specific. You should make
428  * sure to call it only if channels in wiphy are copied and can be modified
429  * without affecting other devices.
430  *
431  * As this function access device node it has to be called after set_wiphy_dev.
432  * It also modifies channels so they have to be set first.
433  * If using this helper, call it before wiphy_register().
434  */
435 #ifdef CONFIG_OF
436 void wiphy_read_of_freq_limits(struct wiphy *wiphy);
437 #else /* CONFIG_OF */
438 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
439 {
440 }
441 #endif /* !CONFIG_OF */
442 
443 
444 /*
445  * Wireless hardware/device configuration structures and methods
446  */
447 
448 /**
449  * DOC: Actions and configuration
450  *
451  * Each wireless device and each virtual interface offer a set of configuration
452  * operations and other actions that are invoked by userspace. Each of these
453  * actions is described in the operations structure, and the parameters these
454  * operations use are described separately.
455  *
456  * Additionally, some operations are asynchronous and expect to get status
457  * information via some functions that drivers need to call.
458  *
459  * Scanning and BSS list handling with its associated functionality is described
460  * in a separate chapter.
461  */
462 
463 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
464 				    WLAN_USER_POSITION_LEN)
465 
466 /**
467  * struct vif_params - describes virtual interface parameters
468  * @flags: monitor interface flags, unchanged if 0, otherwise
469  *	%MONITOR_FLAG_CHANGED will be set
470  * @use_4addr: use 4-address frames
471  * @macaddr: address to use for this virtual interface.
472  *	If this parameter is set to zero address the driver may
473  *	determine the address as needed.
474  *	This feature is only fully supported by drivers that enable the
475  *	%NL80211_FEATURE_MAC_ON_CREATE flag.  Others may support creating
476  **	only p2p devices with specified MAC.
477  * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
478  *	belonging to that MU-MIMO groupID; %NULL if not changed
479  * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
480  *	MU-MIMO packets going to the specified station; %NULL if not changed
481  */
482 struct vif_params {
483 	u32 flags;
484 	int use_4addr;
485 	u8 macaddr[ETH_ALEN];
486 	const u8 *vht_mumimo_groups;
487 	const u8 *vht_mumimo_follow_addr;
488 };
489 
490 /**
491  * struct key_params - key information
492  *
493  * Information about a key
494  *
495  * @key: key material
496  * @key_len: length of key material
497  * @cipher: cipher suite selector
498  * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
499  *	with the get_key() callback, must be in little endian,
500  *	length given by @seq_len.
501  * @seq_len: length of @seq.
502  * @mode: key install mode (RX_TX, NO_TX or SET_TX)
503  */
504 struct key_params {
505 	const u8 *key;
506 	const u8 *seq;
507 	int key_len;
508 	int seq_len;
509 	u32 cipher;
510 	enum nl80211_key_mode mode;
511 };
512 
513 /**
514  * struct cfg80211_chan_def - channel definition
515  * @chan: the (control) channel
516  * @width: channel width
517  * @center_freq1: center frequency of first segment
518  * @center_freq2: center frequency of second segment
519  *	(only with 80+80 MHz)
520  */
521 struct cfg80211_chan_def {
522 	struct ieee80211_channel *chan;
523 	enum nl80211_chan_width width;
524 	u32 center_freq1;
525 	u32 center_freq2;
526 };
527 
528 /**
529  * cfg80211_get_chandef_type - return old channel type from chandef
530  * @chandef: the channel definition
531  *
532  * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
533  * chandef, which must have a bandwidth allowing this conversion.
534  */
535 static inline enum nl80211_channel_type
536 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
537 {
538 	switch (chandef->width) {
539 	case NL80211_CHAN_WIDTH_20_NOHT:
540 		return NL80211_CHAN_NO_HT;
541 	case NL80211_CHAN_WIDTH_20:
542 		return NL80211_CHAN_HT20;
543 	case NL80211_CHAN_WIDTH_40:
544 		if (chandef->center_freq1 > chandef->chan->center_freq)
545 			return NL80211_CHAN_HT40PLUS;
546 		return NL80211_CHAN_HT40MINUS;
547 	default:
548 		WARN_ON(1);
549 		return NL80211_CHAN_NO_HT;
550 	}
551 }
552 
553 /**
554  * cfg80211_chandef_create - create channel definition using channel type
555  * @chandef: the channel definition struct to fill
556  * @channel: the control channel
557  * @chantype: the channel type
558  *
559  * Given a channel type, create a channel definition.
560  */
561 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
562 			     struct ieee80211_channel *channel,
563 			     enum nl80211_channel_type chantype);
564 
565 /**
566  * cfg80211_chandef_identical - check if two channel definitions are identical
567  * @chandef1: first channel definition
568  * @chandef2: second channel definition
569  *
570  * Return: %true if the channels defined by the channel definitions are
571  * identical, %false otherwise.
572  */
573 static inline bool
574 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
575 			   const struct cfg80211_chan_def *chandef2)
576 {
577 	return (chandef1->chan == chandef2->chan &&
578 		chandef1->width == chandef2->width &&
579 		chandef1->center_freq1 == chandef2->center_freq1 &&
580 		chandef1->center_freq2 == chandef2->center_freq2);
581 }
582 
583 /**
584  * cfg80211_chandef_compatible - check if two channel definitions are compatible
585  * @chandef1: first channel definition
586  * @chandef2: second channel definition
587  *
588  * Return: %NULL if the given channel definitions are incompatible,
589  * chandef1 or chandef2 otherwise.
590  */
591 const struct cfg80211_chan_def *
592 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
593 			    const struct cfg80211_chan_def *chandef2);
594 
595 /**
596  * cfg80211_chandef_valid - check if a channel definition is valid
597  * @chandef: the channel definition to check
598  * Return: %true if the channel definition is valid. %false otherwise.
599  */
600 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
601 
602 /**
603  * cfg80211_chandef_usable - check if secondary channels can be used
604  * @wiphy: the wiphy to validate against
605  * @chandef: the channel definition to check
606  * @prohibited_flags: the regulatory channel flags that must not be set
607  * Return: %true if secondary channels are usable. %false otherwise.
608  */
609 bool cfg80211_chandef_usable(struct wiphy *wiphy,
610 			     const struct cfg80211_chan_def *chandef,
611 			     u32 prohibited_flags);
612 
613 /**
614  * cfg80211_chandef_dfs_required - checks if radar detection is required
615  * @wiphy: the wiphy to validate against
616  * @chandef: the channel definition to check
617  * @iftype: the interface type as specified in &enum nl80211_iftype
618  * Returns:
619  *	1 if radar detection is required, 0 if it is not, < 0 on error
620  */
621 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
622 				  const struct cfg80211_chan_def *chandef,
623 				  enum nl80211_iftype iftype);
624 
625 /**
626  * ieee80211_chandef_rate_flags - returns rate flags for a channel
627  *
628  * In some channel types, not all rates may be used - for example CCK
629  * rates may not be used in 5/10 MHz channels.
630  *
631  * @chandef: channel definition for the channel
632  *
633  * Returns: rate flags which apply for this channel
634  */
635 static inline enum ieee80211_rate_flags
636 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
637 {
638 	switch (chandef->width) {
639 	case NL80211_CHAN_WIDTH_5:
640 		return IEEE80211_RATE_SUPPORTS_5MHZ;
641 	case NL80211_CHAN_WIDTH_10:
642 		return IEEE80211_RATE_SUPPORTS_10MHZ;
643 	default:
644 		break;
645 	}
646 	return 0;
647 }
648 
649 /**
650  * ieee80211_chandef_max_power - maximum transmission power for the chandef
651  *
652  * In some regulations, the transmit power may depend on the configured channel
653  * bandwidth which may be defined as dBm/MHz. This function returns the actual
654  * max_power for non-standard (20 MHz) channels.
655  *
656  * @chandef: channel definition for the channel
657  *
658  * Returns: maximum allowed transmission power in dBm for the chandef
659  */
660 static inline int
661 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
662 {
663 	switch (chandef->width) {
664 	case NL80211_CHAN_WIDTH_5:
665 		return min(chandef->chan->max_reg_power - 6,
666 			   chandef->chan->max_power);
667 	case NL80211_CHAN_WIDTH_10:
668 		return min(chandef->chan->max_reg_power - 3,
669 			   chandef->chan->max_power);
670 	default:
671 		break;
672 	}
673 	return chandef->chan->max_power;
674 }
675 
676 /**
677  * enum survey_info_flags - survey information flags
678  *
679  * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
680  * @SURVEY_INFO_IN_USE: channel is currently being used
681  * @SURVEY_INFO_TIME: active time (in ms) was filled in
682  * @SURVEY_INFO_TIME_BUSY: busy time was filled in
683  * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
684  * @SURVEY_INFO_TIME_RX: receive time was filled in
685  * @SURVEY_INFO_TIME_TX: transmit time was filled in
686  * @SURVEY_INFO_TIME_SCAN: scan time was filled in
687  *
688  * Used by the driver to indicate which info in &struct survey_info
689  * it has filled in during the get_survey().
690  */
691 enum survey_info_flags {
692 	SURVEY_INFO_NOISE_DBM		= BIT(0),
693 	SURVEY_INFO_IN_USE		= BIT(1),
694 	SURVEY_INFO_TIME		= BIT(2),
695 	SURVEY_INFO_TIME_BUSY		= BIT(3),
696 	SURVEY_INFO_TIME_EXT_BUSY	= BIT(4),
697 	SURVEY_INFO_TIME_RX		= BIT(5),
698 	SURVEY_INFO_TIME_TX		= BIT(6),
699 	SURVEY_INFO_TIME_SCAN		= BIT(7),
700 };
701 
702 /**
703  * struct survey_info - channel survey response
704  *
705  * @channel: the channel this survey record reports, may be %NULL for a single
706  *	record to report global statistics
707  * @filled: bitflag of flags from &enum survey_info_flags
708  * @noise: channel noise in dBm. This and all following fields are
709  *	optional
710  * @time: amount of time in ms the radio was turn on (on the channel)
711  * @time_busy: amount of time the primary channel was sensed busy
712  * @time_ext_busy: amount of time the extension channel was sensed busy
713  * @time_rx: amount of time the radio spent receiving data
714  * @time_tx: amount of time the radio spent transmitting data
715  * @time_scan: amount of time the radio spent for scanning
716  *
717  * Used by dump_survey() to report back per-channel survey information.
718  *
719  * This structure can later be expanded with things like
720  * channel duty cycle etc.
721  */
722 struct survey_info {
723 	struct ieee80211_channel *channel;
724 	u64 time;
725 	u64 time_busy;
726 	u64 time_ext_busy;
727 	u64 time_rx;
728 	u64 time_tx;
729 	u64 time_scan;
730 	u32 filled;
731 	s8 noise;
732 };
733 
734 #define CFG80211_MAX_WEP_KEYS	4
735 
736 /**
737  * struct cfg80211_crypto_settings - Crypto settings
738  * @wpa_versions: indicates which, if any, WPA versions are enabled
739  *	(from enum nl80211_wpa_versions)
740  * @cipher_group: group key cipher suite (or 0 if unset)
741  * @n_ciphers_pairwise: number of AP supported unicast ciphers
742  * @ciphers_pairwise: unicast key cipher suites
743  * @n_akm_suites: number of AKM suites
744  * @akm_suites: AKM suites
745  * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
746  *	sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
747  *	required to assume that the port is unauthorized until authorized by
748  *	user space. Otherwise, port is marked authorized by default.
749  * @control_port_ethertype: the control port protocol that should be
750  *	allowed through even on unauthorized ports
751  * @control_port_no_encrypt: TRUE to prevent encryption of control port
752  *	protocol frames.
753  * @control_port_over_nl80211: TRUE if userspace expects to exchange control
754  *	port frames over NL80211 instead of the network interface.
755  * @wep_keys: static WEP keys, if not NULL points to an array of
756  *	CFG80211_MAX_WEP_KEYS WEP keys
757  * @wep_tx_key: key index (0..3) of the default TX static WEP key
758  * @psk: PSK (for devices supporting 4-way-handshake offload)
759  * @sae_pwd: password for SAE authentication (for devices supporting SAE
760  *	offload)
761  * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
762  */
763 struct cfg80211_crypto_settings {
764 	u32 wpa_versions;
765 	u32 cipher_group;
766 	int n_ciphers_pairwise;
767 	u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
768 	int n_akm_suites;
769 	u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
770 	bool control_port;
771 	__be16 control_port_ethertype;
772 	bool control_port_no_encrypt;
773 	bool control_port_over_nl80211;
774 	struct key_params *wep_keys;
775 	int wep_tx_key;
776 	const u8 *psk;
777 	const u8 *sae_pwd;
778 	u8 sae_pwd_len;
779 };
780 
781 /**
782  * struct cfg80211_beacon_data - beacon data
783  * @head: head portion of beacon (before TIM IE)
784  *	or %NULL if not changed
785  * @tail: tail portion of beacon (after TIM IE)
786  *	or %NULL if not changed
787  * @head_len: length of @head
788  * @tail_len: length of @tail
789  * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
790  * @beacon_ies_len: length of beacon_ies in octets
791  * @proberesp_ies: extra information element(s) to add into Probe Response
792  *	frames or %NULL
793  * @proberesp_ies_len: length of proberesp_ies in octets
794  * @assocresp_ies: extra information element(s) to add into (Re)Association
795  *	Response frames or %NULL
796  * @assocresp_ies_len: length of assocresp_ies in octets
797  * @probe_resp_len: length of probe response template (@probe_resp)
798  * @probe_resp: probe response template (AP mode only)
799  * @ftm_responder: enable FTM responder functionality; -1 for no change
800  *	(which also implies no change in LCI/civic location data)
801  * @lci: Measurement Report element content, starting with Measurement Token
802  *	(measurement type 8)
803  * @civicloc: Measurement Report element content, starting with Measurement
804  *	Token (measurement type 11)
805  * @lci_len: LCI data length
806  * @civicloc_len: Civic location data length
807  */
808 struct cfg80211_beacon_data {
809 	const u8 *head, *tail;
810 	const u8 *beacon_ies;
811 	const u8 *proberesp_ies;
812 	const u8 *assocresp_ies;
813 	const u8 *probe_resp;
814 	const u8 *lci;
815 	const u8 *civicloc;
816 	s8 ftm_responder;
817 
818 	size_t head_len, tail_len;
819 	size_t beacon_ies_len;
820 	size_t proberesp_ies_len;
821 	size_t assocresp_ies_len;
822 	size_t probe_resp_len;
823 	size_t lci_len;
824 	size_t civicloc_len;
825 };
826 
827 struct mac_address {
828 	u8 addr[ETH_ALEN];
829 };
830 
831 /**
832  * struct cfg80211_acl_data - Access control list data
833  *
834  * @acl_policy: ACL policy to be applied on the station's
835  *	entry specified by mac_addr
836  * @n_acl_entries: Number of MAC address entries passed
837  * @mac_addrs: List of MAC addresses of stations to be used for ACL
838  */
839 struct cfg80211_acl_data {
840 	enum nl80211_acl_policy acl_policy;
841 	int n_acl_entries;
842 
843 	/* Keep it last */
844 	struct mac_address mac_addrs[];
845 };
846 
847 /*
848  * cfg80211_bitrate_mask - masks for bitrate control
849  */
850 struct cfg80211_bitrate_mask {
851 	struct {
852 		u32 legacy;
853 		u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
854 		u16 vht_mcs[NL80211_VHT_NSS_MAX];
855 		enum nl80211_txrate_gi gi;
856 	} control[NUM_NL80211_BANDS];
857 };
858 
859 /**
860  * enum cfg80211_ap_settings_flags - AP settings flags
861  *
862  * Used by cfg80211_ap_settings
863  *
864  * @AP_SETTINGS_EXTERNAL_AUTH_SUPPORT: AP supports external authentication
865  */
866 enum cfg80211_ap_settings_flags {
867 	AP_SETTINGS_EXTERNAL_AUTH_SUPPORT = BIT(0),
868 };
869 
870 /**
871  * struct cfg80211_ap_settings - AP configuration
872  *
873  * Used to configure an AP interface.
874  *
875  * @chandef: defines the channel to use
876  * @beacon: beacon data
877  * @beacon_interval: beacon interval
878  * @dtim_period: DTIM period
879  * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
880  *	user space)
881  * @ssid_len: length of @ssid
882  * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
883  * @crypto: crypto settings
884  * @privacy: the BSS uses privacy
885  * @auth_type: Authentication type (algorithm)
886  * @smps_mode: SMPS mode
887  * @inactivity_timeout: time in seconds to determine station's inactivity.
888  * @p2p_ctwindow: P2P CT Window
889  * @p2p_opp_ps: P2P opportunistic PS
890  * @acl: ACL configuration used by the drivers which has support for
891  *	MAC address based access control
892  * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
893  *	networks.
894  * @beacon_rate: bitrate to be used for beacons
895  * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
896  * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
897  * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
898  * @ht_required: stations must support HT
899  * @vht_required: stations must support VHT
900  * @twt_responder: Enable Target Wait Time
901  * @flags: flags, as defined in enum cfg80211_ap_settings_flags
902  */
903 struct cfg80211_ap_settings {
904 	struct cfg80211_chan_def chandef;
905 
906 	struct cfg80211_beacon_data beacon;
907 
908 	int beacon_interval, dtim_period;
909 	const u8 *ssid;
910 	size_t ssid_len;
911 	enum nl80211_hidden_ssid hidden_ssid;
912 	struct cfg80211_crypto_settings crypto;
913 	bool privacy;
914 	enum nl80211_auth_type auth_type;
915 	enum nl80211_smps_mode smps_mode;
916 	int inactivity_timeout;
917 	u8 p2p_ctwindow;
918 	bool p2p_opp_ps;
919 	const struct cfg80211_acl_data *acl;
920 	bool pbss;
921 	struct cfg80211_bitrate_mask beacon_rate;
922 
923 	const struct ieee80211_ht_cap *ht_cap;
924 	const struct ieee80211_vht_cap *vht_cap;
925 	const struct ieee80211_he_cap_elem *he_cap;
926 	bool ht_required, vht_required;
927 	bool twt_responder;
928 	u32 flags;
929 };
930 
931 /**
932  * struct cfg80211_csa_settings - channel switch settings
933  *
934  * Used for channel switch
935  *
936  * @chandef: defines the channel to use after the switch
937  * @beacon_csa: beacon data while performing the switch
938  * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
939  * @counter_offsets_presp: offsets of the counters within the probe response
940  * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
941  * @n_counter_offsets_presp: number of csa counters in the probe response
942  * @beacon_after: beacon data to be used on the new channel
943  * @radar_required: whether radar detection is required on the new channel
944  * @block_tx: whether transmissions should be blocked while changing
945  * @count: number of beacons until switch
946  */
947 struct cfg80211_csa_settings {
948 	struct cfg80211_chan_def chandef;
949 	struct cfg80211_beacon_data beacon_csa;
950 	const u16 *counter_offsets_beacon;
951 	const u16 *counter_offsets_presp;
952 	unsigned int n_counter_offsets_beacon;
953 	unsigned int n_counter_offsets_presp;
954 	struct cfg80211_beacon_data beacon_after;
955 	bool radar_required;
956 	bool block_tx;
957 	u8 count;
958 };
959 
960 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
961 
962 /**
963  * struct iface_combination_params - input parameters for interface combinations
964  *
965  * Used to pass interface combination parameters
966  *
967  * @num_different_channels: the number of different channels we want
968  *	to use for verification
969  * @radar_detect: a bitmap where each bit corresponds to a channel
970  *	width where radar detection is needed, as in the definition of
971  *	&struct ieee80211_iface_combination.@radar_detect_widths
972  * @iftype_num: array with the number of interfaces of each interface
973  *	type.  The index is the interface type as specified in &enum
974  *	nl80211_iftype.
975  * @new_beacon_int: set this to the beacon interval of a new interface
976  *	that's not operating yet, if such is to be checked as part of
977  *	the verification
978  */
979 struct iface_combination_params {
980 	int num_different_channels;
981 	u8 radar_detect;
982 	int iftype_num[NUM_NL80211_IFTYPES];
983 	u32 new_beacon_int;
984 };
985 
986 /**
987  * enum station_parameters_apply_mask - station parameter values to apply
988  * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
989  * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
990  * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
991  *
992  * Not all station parameters have in-band "no change" signalling,
993  * for those that don't these flags will are used.
994  */
995 enum station_parameters_apply_mask {
996 	STATION_PARAM_APPLY_UAPSD = BIT(0),
997 	STATION_PARAM_APPLY_CAPABILITY = BIT(1),
998 	STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
999 	STATION_PARAM_APPLY_STA_TXPOWER = BIT(3),
1000 };
1001 
1002 /**
1003  * struct sta_txpwr - station txpower configuration
1004  *
1005  * Used to configure txpower for station.
1006  *
1007  * @power: tx power (in dBm) to be used for sending data traffic. If tx power
1008  *	is not provided, the default per-interface tx power setting will be
1009  *	overriding. Driver should be picking up the lowest tx power, either tx
1010  *	power per-interface or per-station.
1011  * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1012  *	will be less than or equal to specified from userspace, whereas if TPC
1013  *	%type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1014  *	NL80211_TX_POWER_FIXED is not a valid configuration option for
1015  *	per peer TPC.
1016  */
1017 struct sta_txpwr {
1018 	s16 power;
1019 	enum nl80211_tx_power_setting type;
1020 };
1021 
1022 /**
1023  * struct station_parameters - station parameters
1024  *
1025  * Used to change and create a new station.
1026  *
1027  * @vlan: vlan interface station should belong to
1028  * @supported_rates: supported rates in IEEE 802.11 format
1029  *	(or NULL for no change)
1030  * @supported_rates_len: number of supported rates
1031  * @sta_flags_mask: station flags that changed
1032  *	(bitmask of BIT(%NL80211_STA_FLAG_...))
1033  * @sta_flags_set: station flags values
1034  *	(bitmask of BIT(%NL80211_STA_FLAG_...))
1035  * @listen_interval: listen interval or -1 for no change
1036  * @aid: AID or zero for no change
1037  * @peer_aid: mesh peer AID or zero for no change
1038  * @plink_action: plink action to take
1039  * @plink_state: set the peer link state for a station
1040  * @ht_capa: HT capabilities of station
1041  * @vht_capa: VHT capabilities of station
1042  * @uapsd_queues: bitmap of queues configured for uapsd. same format
1043  *	as the AC bitmap in the QoS info field
1044  * @max_sp: max Service Period. same format as the MAX_SP in the
1045  *	QoS info field (but already shifted down)
1046  * @sta_modify_mask: bitmap indicating which parameters changed
1047  *	(for those that don't have a natural "no change" value),
1048  *	see &enum station_parameters_apply_mask
1049  * @local_pm: local link-specific mesh power save mode (no change when set
1050  *	to unknown)
1051  * @capability: station capability
1052  * @ext_capab: extended capabilities of the station
1053  * @ext_capab_len: number of extended capabilities
1054  * @supported_channels: supported channels in IEEE 802.11 format
1055  * @supported_channels_len: number of supported channels
1056  * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1057  * @supported_oper_classes_len: number of supported operating classes
1058  * @opmode_notif: operating mode field from Operating Mode Notification
1059  * @opmode_notif_used: information if operating mode field is used
1060  * @support_p2p_ps: information if station supports P2P PS mechanism
1061  * @he_capa: HE capabilities of station
1062  * @he_capa_len: the length of the HE capabilities
1063  * @airtime_weight: airtime scheduler weight for this station
1064  */
1065 struct station_parameters {
1066 	const u8 *supported_rates;
1067 	struct net_device *vlan;
1068 	u32 sta_flags_mask, sta_flags_set;
1069 	u32 sta_modify_mask;
1070 	int listen_interval;
1071 	u16 aid;
1072 	u16 peer_aid;
1073 	u8 supported_rates_len;
1074 	u8 plink_action;
1075 	u8 plink_state;
1076 	const struct ieee80211_ht_cap *ht_capa;
1077 	const struct ieee80211_vht_cap *vht_capa;
1078 	u8 uapsd_queues;
1079 	u8 max_sp;
1080 	enum nl80211_mesh_power_mode local_pm;
1081 	u16 capability;
1082 	const u8 *ext_capab;
1083 	u8 ext_capab_len;
1084 	const u8 *supported_channels;
1085 	u8 supported_channels_len;
1086 	const u8 *supported_oper_classes;
1087 	u8 supported_oper_classes_len;
1088 	u8 opmode_notif;
1089 	bool opmode_notif_used;
1090 	int support_p2p_ps;
1091 	const struct ieee80211_he_cap_elem *he_capa;
1092 	u8 he_capa_len;
1093 	u16 airtime_weight;
1094 	struct sta_txpwr txpwr;
1095 };
1096 
1097 /**
1098  * struct station_del_parameters - station deletion parameters
1099  *
1100  * Used to delete a station entry (or all stations).
1101  *
1102  * @mac: MAC address of the station to remove or NULL to remove all stations
1103  * @subtype: Management frame subtype to use for indicating removal
1104  *	(10 = Disassociation, 12 = Deauthentication)
1105  * @reason_code: Reason code for the Disassociation/Deauthentication frame
1106  */
1107 struct station_del_parameters {
1108 	const u8 *mac;
1109 	u8 subtype;
1110 	u16 reason_code;
1111 };
1112 
1113 /**
1114  * enum cfg80211_station_type - the type of station being modified
1115  * @CFG80211_STA_AP_CLIENT: client of an AP interface
1116  * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1117  *	unassociated (update properties for this type of client is permitted)
1118  * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1119  *	the AP MLME in the device
1120  * @CFG80211_STA_AP_STA: AP station on managed interface
1121  * @CFG80211_STA_IBSS: IBSS station
1122  * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1123  *	while TDLS setup is in progress, it moves out of this state when
1124  *	being marked authorized; use this only if TDLS with external setup is
1125  *	supported/used)
1126  * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1127  *	entry that is operating, has been marked authorized by userspace)
1128  * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1129  * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1130  */
1131 enum cfg80211_station_type {
1132 	CFG80211_STA_AP_CLIENT,
1133 	CFG80211_STA_AP_CLIENT_UNASSOC,
1134 	CFG80211_STA_AP_MLME_CLIENT,
1135 	CFG80211_STA_AP_STA,
1136 	CFG80211_STA_IBSS,
1137 	CFG80211_STA_TDLS_PEER_SETUP,
1138 	CFG80211_STA_TDLS_PEER_ACTIVE,
1139 	CFG80211_STA_MESH_PEER_KERNEL,
1140 	CFG80211_STA_MESH_PEER_USER,
1141 };
1142 
1143 /**
1144  * cfg80211_check_station_change - validate parameter changes
1145  * @wiphy: the wiphy this operates on
1146  * @params: the new parameters for a station
1147  * @statype: the type of station being modified
1148  *
1149  * Utility function for the @change_station driver method. Call this function
1150  * with the appropriate station type looking up the station (and checking that
1151  * it exists). It will verify whether the station change is acceptable, and if
1152  * not will return an error code. Note that it may modify the parameters for
1153  * backward compatibility reasons, so don't use them before calling this.
1154  */
1155 int cfg80211_check_station_change(struct wiphy *wiphy,
1156 				  struct station_parameters *params,
1157 				  enum cfg80211_station_type statype);
1158 
1159 /**
1160  * enum station_info_rate_flags - bitrate info flags
1161  *
1162  * Used by the driver to indicate the specific rate transmission
1163  * type for 802.11n transmissions.
1164  *
1165  * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1166  * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1167  * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1168  * @RATE_INFO_FLAGS_60G: 60GHz MCS
1169  * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1170  */
1171 enum rate_info_flags {
1172 	RATE_INFO_FLAGS_MCS			= BIT(0),
1173 	RATE_INFO_FLAGS_VHT_MCS			= BIT(1),
1174 	RATE_INFO_FLAGS_SHORT_GI		= BIT(2),
1175 	RATE_INFO_FLAGS_60G			= BIT(3),
1176 	RATE_INFO_FLAGS_HE_MCS			= BIT(4),
1177 };
1178 
1179 /**
1180  * enum rate_info_bw - rate bandwidth information
1181  *
1182  * Used by the driver to indicate the rate bandwidth.
1183  *
1184  * @RATE_INFO_BW_5: 5 MHz bandwidth
1185  * @RATE_INFO_BW_10: 10 MHz bandwidth
1186  * @RATE_INFO_BW_20: 20 MHz bandwidth
1187  * @RATE_INFO_BW_40: 40 MHz bandwidth
1188  * @RATE_INFO_BW_80: 80 MHz bandwidth
1189  * @RATE_INFO_BW_160: 160 MHz bandwidth
1190  * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1191  */
1192 enum rate_info_bw {
1193 	RATE_INFO_BW_20 = 0,
1194 	RATE_INFO_BW_5,
1195 	RATE_INFO_BW_10,
1196 	RATE_INFO_BW_40,
1197 	RATE_INFO_BW_80,
1198 	RATE_INFO_BW_160,
1199 	RATE_INFO_BW_HE_RU,
1200 };
1201 
1202 /**
1203  * struct rate_info - bitrate information
1204  *
1205  * Information about a receiving or transmitting bitrate
1206  *
1207  * @flags: bitflag of flags from &enum rate_info_flags
1208  * @mcs: mcs index if struct describes an HT/VHT/HE rate
1209  * @legacy: bitrate in 100kbit/s for 802.11abg
1210  * @nss: number of streams (VHT & HE only)
1211  * @bw: bandwidth (from &enum rate_info_bw)
1212  * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1213  * @he_dcm: HE DCM value
1214  * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1215  *	only valid if bw is %RATE_INFO_BW_HE_RU)
1216  */
1217 struct rate_info {
1218 	u8 flags;
1219 	u8 mcs;
1220 	u16 legacy;
1221 	u8 nss;
1222 	u8 bw;
1223 	u8 he_gi;
1224 	u8 he_dcm;
1225 	u8 he_ru_alloc;
1226 };
1227 
1228 /**
1229  * enum station_info_rate_flags - bitrate info flags
1230  *
1231  * Used by the driver to indicate the specific rate transmission
1232  * type for 802.11n transmissions.
1233  *
1234  * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1235  * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1236  * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1237  */
1238 enum bss_param_flags {
1239 	BSS_PARAM_FLAGS_CTS_PROT	= 1<<0,
1240 	BSS_PARAM_FLAGS_SHORT_PREAMBLE	= 1<<1,
1241 	BSS_PARAM_FLAGS_SHORT_SLOT_TIME	= 1<<2,
1242 };
1243 
1244 /**
1245  * struct sta_bss_parameters - BSS parameters for the attached station
1246  *
1247  * Information about the currently associated BSS
1248  *
1249  * @flags: bitflag of flags from &enum bss_param_flags
1250  * @dtim_period: DTIM period for the BSS
1251  * @beacon_interval: beacon interval
1252  */
1253 struct sta_bss_parameters {
1254 	u8 flags;
1255 	u8 dtim_period;
1256 	u16 beacon_interval;
1257 };
1258 
1259 /**
1260  * struct cfg80211_txq_stats - TXQ statistics for this TID
1261  * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1262  *	indicate the relevant values in this struct are filled
1263  * @backlog_bytes: total number of bytes currently backlogged
1264  * @backlog_packets: total number of packets currently backlogged
1265  * @flows: number of new flows seen
1266  * @drops: total number of packets dropped
1267  * @ecn_marks: total number of packets marked with ECN CE
1268  * @overlimit: number of drops due to queue space overflow
1269  * @overmemory: number of drops due to memory limit overflow
1270  * @collisions: number of hash collisions
1271  * @tx_bytes: total number of bytes dequeued
1272  * @tx_packets: total number of packets dequeued
1273  * @max_flows: maximum number of flows supported
1274  */
1275 struct cfg80211_txq_stats {
1276 	u32 filled;
1277 	u32 backlog_bytes;
1278 	u32 backlog_packets;
1279 	u32 flows;
1280 	u32 drops;
1281 	u32 ecn_marks;
1282 	u32 overlimit;
1283 	u32 overmemory;
1284 	u32 collisions;
1285 	u32 tx_bytes;
1286 	u32 tx_packets;
1287 	u32 max_flows;
1288 };
1289 
1290 /**
1291  * struct cfg80211_tid_stats - per-TID statistics
1292  * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1293  *	indicate the relevant values in this struct are filled
1294  * @rx_msdu: number of received MSDUs
1295  * @tx_msdu: number of (attempted) transmitted MSDUs
1296  * @tx_msdu_retries: number of retries (not counting the first) for
1297  *	transmitted MSDUs
1298  * @tx_msdu_failed: number of failed transmitted MSDUs
1299  * @txq_stats: TXQ statistics
1300  */
1301 struct cfg80211_tid_stats {
1302 	u32 filled;
1303 	u64 rx_msdu;
1304 	u64 tx_msdu;
1305 	u64 tx_msdu_retries;
1306 	u64 tx_msdu_failed;
1307 	struct cfg80211_txq_stats txq_stats;
1308 };
1309 
1310 #define IEEE80211_MAX_CHAINS	4
1311 
1312 /**
1313  * struct station_info - station information
1314  *
1315  * Station information filled by driver for get_station() and dump_station.
1316  *
1317  * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1318  *	indicate the relevant values in this struct for them
1319  * @connected_time: time(in secs) since a station is last connected
1320  * @inactive_time: time since last station activity (tx/rx) in milliseconds
1321  * @rx_bytes: bytes (size of MPDUs) received from this station
1322  * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1323  * @llid: mesh local link id
1324  * @plid: mesh peer link id
1325  * @plink_state: mesh peer link state
1326  * @signal: The signal strength, type depends on the wiphy's signal_type.
1327  *	For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1328  * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1329  *	For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1330  * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1331  * @chain_signal: per-chain signal strength of last received packet in dBm
1332  * @chain_signal_avg: per-chain signal strength average in dBm
1333  * @txrate: current unicast bitrate from this station
1334  * @rxrate: current unicast bitrate to this station
1335  * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1336  * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1337  * @tx_retries: cumulative retry counts (MPDUs)
1338  * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1339  * @rx_dropped_misc:  Dropped for un-specified reason.
1340  * @bss_param: current BSS parameters
1341  * @generation: generation number for nl80211 dumps.
1342  *	This number should increase every time the list of stations
1343  *	changes, i.e. when a station is added or removed, so that
1344  *	userspace can tell whether it got a consistent snapshot.
1345  * @assoc_req_ies: IEs from (Re)Association Request.
1346  *	This is used only when in AP mode with drivers that do not use
1347  *	user space MLME/SME implementation. The information is provided for
1348  *	the cfg80211_new_sta() calls to notify user space of the IEs.
1349  * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1350  * @sta_flags: station flags mask & values
1351  * @beacon_loss_count: Number of times beacon loss event has triggered.
1352  * @t_offset: Time offset of the station relative to this host.
1353  * @local_pm: local mesh STA power save mode
1354  * @peer_pm: peer mesh STA power save mode
1355  * @nonpeer_pm: non-peer mesh STA power save mode
1356  * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1357  *	towards this station.
1358  * @rx_beacon: number of beacons received from this peer
1359  * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1360  *	from this peer
1361  * @connected_to_gate: true if mesh STA has a path to mesh gate
1362  * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1363  * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1364  * @airtime_weight: current airtime scheduling weight
1365  * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1366  *	(IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1367  *	Note that this doesn't use the @filled bit, but is used if non-NULL.
1368  * @ack_signal: signal strength (in dBm) of the last ACK frame.
1369  * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1370  *	been sent.
1371  * @rx_mpdu_count: number of MPDUs received from this station
1372  * @fcs_err_count: number of packets (MPDUs) received from this station with
1373  *	an FCS error. This counter should be incremented only when TA of the
1374  *	received packet with an FCS error matches the peer MAC address.
1375  * @airtime_link_metric: mesh airtime link metric.
1376  */
1377 struct station_info {
1378 	u64 filled;
1379 	u32 connected_time;
1380 	u32 inactive_time;
1381 	u64 rx_bytes;
1382 	u64 tx_bytes;
1383 	u16 llid;
1384 	u16 plid;
1385 	u8 plink_state;
1386 	s8 signal;
1387 	s8 signal_avg;
1388 
1389 	u8 chains;
1390 	s8 chain_signal[IEEE80211_MAX_CHAINS];
1391 	s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1392 
1393 	struct rate_info txrate;
1394 	struct rate_info rxrate;
1395 	u32 rx_packets;
1396 	u32 tx_packets;
1397 	u32 tx_retries;
1398 	u32 tx_failed;
1399 	u32 rx_dropped_misc;
1400 	struct sta_bss_parameters bss_param;
1401 	struct nl80211_sta_flag_update sta_flags;
1402 
1403 	int generation;
1404 
1405 	const u8 *assoc_req_ies;
1406 	size_t assoc_req_ies_len;
1407 
1408 	u32 beacon_loss_count;
1409 	s64 t_offset;
1410 	enum nl80211_mesh_power_mode local_pm;
1411 	enum nl80211_mesh_power_mode peer_pm;
1412 	enum nl80211_mesh_power_mode nonpeer_pm;
1413 
1414 	u32 expected_throughput;
1415 
1416 	u64 tx_duration;
1417 	u64 rx_duration;
1418 	u64 rx_beacon;
1419 	u8 rx_beacon_signal_avg;
1420 	u8 connected_to_gate;
1421 
1422 	struct cfg80211_tid_stats *pertid;
1423 	s8 ack_signal;
1424 	s8 avg_ack_signal;
1425 
1426 	u16 airtime_weight;
1427 
1428 	u32 rx_mpdu_count;
1429 	u32 fcs_err_count;
1430 
1431 	u32 airtime_link_metric;
1432 };
1433 
1434 #if IS_ENABLED(CONFIG_CFG80211)
1435 /**
1436  * cfg80211_get_station - retrieve information about a given station
1437  * @dev: the device where the station is supposed to be connected to
1438  * @mac_addr: the mac address of the station of interest
1439  * @sinfo: pointer to the structure to fill with the information
1440  *
1441  * Returns 0 on success and sinfo is filled with the available information
1442  * otherwise returns a negative error code and the content of sinfo has to be
1443  * considered undefined.
1444  */
1445 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1446 			 struct station_info *sinfo);
1447 #else
1448 static inline int cfg80211_get_station(struct net_device *dev,
1449 				       const u8 *mac_addr,
1450 				       struct station_info *sinfo)
1451 {
1452 	return -ENOENT;
1453 }
1454 #endif
1455 
1456 /**
1457  * enum monitor_flags - monitor flags
1458  *
1459  * Monitor interface configuration flags. Note that these must be the bits
1460  * according to the nl80211 flags.
1461  *
1462  * @MONITOR_FLAG_CHANGED: set if the flags were changed
1463  * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1464  * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1465  * @MONITOR_FLAG_CONTROL: pass control frames
1466  * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1467  * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1468  * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1469  */
1470 enum monitor_flags {
1471 	MONITOR_FLAG_CHANGED		= 1<<__NL80211_MNTR_FLAG_INVALID,
1472 	MONITOR_FLAG_FCSFAIL		= 1<<NL80211_MNTR_FLAG_FCSFAIL,
1473 	MONITOR_FLAG_PLCPFAIL		= 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1474 	MONITOR_FLAG_CONTROL		= 1<<NL80211_MNTR_FLAG_CONTROL,
1475 	MONITOR_FLAG_OTHER_BSS		= 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1476 	MONITOR_FLAG_COOK_FRAMES	= 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1477 	MONITOR_FLAG_ACTIVE		= 1<<NL80211_MNTR_FLAG_ACTIVE,
1478 };
1479 
1480 /**
1481  * enum mpath_info_flags -  mesh path information flags
1482  *
1483  * Used by the driver to indicate which info in &struct mpath_info it has filled
1484  * in during get_station() or dump_station().
1485  *
1486  * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1487  * @MPATH_INFO_SN: @sn filled
1488  * @MPATH_INFO_METRIC: @metric filled
1489  * @MPATH_INFO_EXPTIME: @exptime filled
1490  * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1491  * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1492  * @MPATH_INFO_FLAGS: @flags filled
1493  * @MPATH_INFO_HOP_COUNT: @hop_count filled
1494  * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
1495  */
1496 enum mpath_info_flags {
1497 	MPATH_INFO_FRAME_QLEN		= BIT(0),
1498 	MPATH_INFO_SN			= BIT(1),
1499 	MPATH_INFO_METRIC		= BIT(2),
1500 	MPATH_INFO_EXPTIME		= BIT(3),
1501 	MPATH_INFO_DISCOVERY_TIMEOUT	= BIT(4),
1502 	MPATH_INFO_DISCOVERY_RETRIES	= BIT(5),
1503 	MPATH_INFO_FLAGS		= BIT(6),
1504 	MPATH_INFO_HOP_COUNT		= BIT(7),
1505 	MPATH_INFO_PATH_CHANGE		= BIT(8),
1506 };
1507 
1508 /**
1509  * struct mpath_info - mesh path information
1510  *
1511  * Mesh path information filled by driver for get_mpath() and dump_mpath().
1512  *
1513  * @filled: bitfield of flags from &enum mpath_info_flags
1514  * @frame_qlen: number of queued frames for this destination
1515  * @sn: target sequence number
1516  * @metric: metric (cost) of this mesh path
1517  * @exptime: expiration time for the mesh path from now, in msecs
1518  * @flags: mesh path flags
1519  * @discovery_timeout: total mesh path discovery timeout, in msecs
1520  * @discovery_retries: mesh path discovery retries
1521  * @generation: generation number for nl80211 dumps.
1522  *	This number should increase every time the list of mesh paths
1523  *	changes, i.e. when a station is added or removed, so that
1524  *	userspace can tell whether it got a consistent snapshot.
1525  * @hop_count: hops to destination
1526  * @path_change_count: total number of path changes to destination
1527  */
1528 struct mpath_info {
1529 	u32 filled;
1530 	u32 frame_qlen;
1531 	u32 sn;
1532 	u32 metric;
1533 	u32 exptime;
1534 	u32 discovery_timeout;
1535 	u8 discovery_retries;
1536 	u8 flags;
1537 	u8 hop_count;
1538 	u32 path_change_count;
1539 
1540 	int generation;
1541 };
1542 
1543 /**
1544  * struct bss_parameters - BSS parameters
1545  *
1546  * Used to change BSS parameters (mainly for AP mode).
1547  *
1548  * @use_cts_prot: Whether to use CTS protection
1549  *	(0 = no, 1 = yes, -1 = do not change)
1550  * @use_short_preamble: Whether the use of short preambles is allowed
1551  *	(0 = no, 1 = yes, -1 = do not change)
1552  * @use_short_slot_time: Whether the use of short slot time is allowed
1553  *	(0 = no, 1 = yes, -1 = do not change)
1554  * @basic_rates: basic rates in IEEE 802.11 format
1555  *	(or NULL for no change)
1556  * @basic_rates_len: number of basic rates
1557  * @ap_isolate: do not forward packets between connected stations
1558  * @ht_opmode: HT Operation mode
1559  * 	(u16 = opmode, -1 = do not change)
1560  * @p2p_ctwindow: P2P CT Window (-1 = no change)
1561  * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1562  */
1563 struct bss_parameters {
1564 	int use_cts_prot;
1565 	int use_short_preamble;
1566 	int use_short_slot_time;
1567 	const u8 *basic_rates;
1568 	u8 basic_rates_len;
1569 	int ap_isolate;
1570 	int ht_opmode;
1571 	s8 p2p_ctwindow, p2p_opp_ps;
1572 };
1573 
1574 /**
1575  * struct mesh_config - 802.11s mesh configuration
1576  *
1577  * These parameters can be changed while the mesh is active.
1578  *
1579  * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1580  *	by the Mesh Peering Open message
1581  * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1582  *	used by the Mesh Peering Open message
1583  * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1584  *	the mesh peering management to close a mesh peering
1585  * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1586  *	mesh interface
1587  * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1588  *	be sent to establish a new peer link instance in a mesh
1589  * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1590  * @element_ttl: the value of TTL field set at a mesh STA for path selection
1591  *	elements
1592  * @auto_open_plinks: whether we should automatically open peer links when we
1593  *	detect compatible mesh peers
1594  * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1595  *	synchronize to for 11s default synchronization method
1596  * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1597  *	that an originator mesh STA can send to a particular path target
1598  * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1599  * @min_discovery_timeout: the minimum length of time to wait until giving up on
1600  *	a path discovery in milliseconds
1601  * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1602  *	receiving a PREQ shall consider the forwarding information from the
1603  *	root to be valid. (TU = time unit)
1604  * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1605  *	which a mesh STA can send only one action frame containing a PREQ
1606  *	element
1607  * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1608  *	which a mesh STA can send only one Action frame containing a PERR
1609  *	element
1610  * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1611  *	it takes for an HWMP information element to propagate across the mesh
1612  * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1613  * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1614  *	announcements are transmitted
1615  * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1616  *	station has access to a broader network beyond the MBSS. (This is
1617  *	missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1618  *	only means that the station will announce others it's a mesh gate, but
1619  *	not necessarily using the gate announcement protocol. Still keeping the
1620  *	same nomenclature to be in sync with the spec)
1621  * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1622  *	entity (default is TRUE - forwarding entity)
1623  * @rssi_threshold: the threshold for average signal strength of candidate
1624  *	station to establish a peer link
1625  * @ht_opmode: mesh HT protection mode
1626  *
1627  * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1628  *	receiving a proactive PREQ shall consider the forwarding information to
1629  *	the root mesh STA to be valid.
1630  *
1631  * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1632  *	PREQs are transmitted.
1633  * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1634  *	during which a mesh STA can send only one Action frame containing
1635  *	a PREQ element for root path confirmation.
1636  * @power_mode: The default mesh power save mode which will be the initial
1637  *	setting for new peer links.
1638  * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1639  *	after transmitting its beacon.
1640  * @plink_timeout: If no tx activity is seen from a STA we've established
1641  *	peering with for longer than this time (in seconds), then remove it
1642  *	from the STA's list of peers.  Default is 30 minutes.
1643  * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
1644  *      connected to a mesh gate in mesh formation info.  If false, the
1645  *      value in mesh formation is determined by the presence of root paths
1646  *      in the mesh path table
1647  */
1648 struct mesh_config {
1649 	u16 dot11MeshRetryTimeout;
1650 	u16 dot11MeshConfirmTimeout;
1651 	u16 dot11MeshHoldingTimeout;
1652 	u16 dot11MeshMaxPeerLinks;
1653 	u8 dot11MeshMaxRetries;
1654 	u8 dot11MeshTTL;
1655 	u8 element_ttl;
1656 	bool auto_open_plinks;
1657 	u32 dot11MeshNbrOffsetMaxNeighbor;
1658 	u8 dot11MeshHWMPmaxPREQretries;
1659 	u32 path_refresh_time;
1660 	u16 min_discovery_timeout;
1661 	u32 dot11MeshHWMPactivePathTimeout;
1662 	u16 dot11MeshHWMPpreqMinInterval;
1663 	u16 dot11MeshHWMPperrMinInterval;
1664 	u16 dot11MeshHWMPnetDiameterTraversalTime;
1665 	u8 dot11MeshHWMPRootMode;
1666 	bool dot11MeshConnectedToMeshGate;
1667 	u16 dot11MeshHWMPRannInterval;
1668 	bool dot11MeshGateAnnouncementProtocol;
1669 	bool dot11MeshForwarding;
1670 	s32 rssi_threshold;
1671 	u16 ht_opmode;
1672 	u32 dot11MeshHWMPactivePathToRootTimeout;
1673 	u16 dot11MeshHWMProotInterval;
1674 	u16 dot11MeshHWMPconfirmationInterval;
1675 	enum nl80211_mesh_power_mode power_mode;
1676 	u16 dot11MeshAwakeWindowDuration;
1677 	u32 plink_timeout;
1678 };
1679 
1680 /**
1681  * struct mesh_setup - 802.11s mesh setup configuration
1682  * @chandef: defines the channel to use
1683  * @mesh_id: the mesh ID
1684  * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1685  * @sync_method: which synchronization method to use
1686  * @path_sel_proto: which path selection protocol to use
1687  * @path_metric: which metric to use
1688  * @auth_id: which authentication method this mesh is using
1689  * @ie: vendor information elements (optional)
1690  * @ie_len: length of vendor information elements
1691  * @is_authenticated: this mesh requires authentication
1692  * @is_secure: this mesh uses security
1693  * @user_mpm: userspace handles all MPM functions
1694  * @dtim_period: DTIM period to use
1695  * @beacon_interval: beacon interval to use
1696  * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1697  * @basic_rates: basic rates to use when creating the mesh
1698  * @beacon_rate: bitrate to be used for beacons
1699  * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1700  *	changes the channel when a radar is detected. This is required
1701  *	to operate on DFS channels.
1702  * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1703  *	port frames over NL80211 instead of the network interface.
1704  *
1705  * These parameters are fixed when the mesh is created.
1706  */
1707 struct mesh_setup {
1708 	struct cfg80211_chan_def chandef;
1709 	const u8 *mesh_id;
1710 	u8 mesh_id_len;
1711 	u8 sync_method;
1712 	u8 path_sel_proto;
1713 	u8 path_metric;
1714 	u8 auth_id;
1715 	const u8 *ie;
1716 	u8 ie_len;
1717 	bool is_authenticated;
1718 	bool is_secure;
1719 	bool user_mpm;
1720 	u8 dtim_period;
1721 	u16 beacon_interval;
1722 	int mcast_rate[NUM_NL80211_BANDS];
1723 	u32 basic_rates;
1724 	struct cfg80211_bitrate_mask beacon_rate;
1725 	bool userspace_handles_dfs;
1726 	bool control_port_over_nl80211;
1727 };
1728 
1729 /**
1730  * struct ocb_setup - 802.11p OCB mode setup configuration
1731  * @chandef: defines the channel to use
1732  *
1733  * These parameters are fixed when connecting to the network
1734  */
1735 struct ocb_setup {
1736 	struct cfg80211_chan_def chandef;
1737 };
1738 
1739 /**
1740  * struct ieee80211_txq_params - TX queue parameters
1741  * @ac: AC identifier
1742  * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1743  * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1744  *	1..32767]
1745  * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1746  *	1..32767]
1747  * @aifs: Arbitration interframe space [0..255]
1748  */
1749 struct ieee80211_txq_params {
1750 	enum nl80211_ac ac;
1751 	u16 txop;
1752 	u16 cwmin;
1753 	u16 cwmax;
1754 	u8 aifs;
1755 };
1756 
1757 /**
1758  * DOC: Scanning and BSS list handling
1759  *
1760  * The scanning process itself is fairly simple, but cfg80211 offers quite
1761  * a bit of helper functionality. To start a scan, the scan operation will
1762  * be invoked with a scan definition. This scan definition contains the
1763  * channels to scan, and the SSIDs to send probe requests for (including the
1764  * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1765  * probe. Additionally, a scan request may contain extra information elements
1766  * that should be added to the probe request. The IEs are guaranteed to be
1767  * well-formed, and will not exceed the maximum length the driver advertised
1768  * in the wiphy structure.
1769  *
1770  * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1771  * it is responsible for maintaining the BSS list; the driver should not
1772  * maintain a list itself. For this notification, various functions exist.
1773  *
1774  * Since drivers do not maintain a BSS list, there are also a number of
1775  * functions to search for a BSS and obtain information about it from the
1776  * BSS structure cfg80211 maintains. The BSS list is also made available
1777  * to userspace.
1778  */
1779 
1780 /**
1781  * struct cfg80211_ssid - SSID description
1782  * @ssid: the SSID
1783  * @ssid_len: length of the ssid
1784  */
1785 struct cfg80211_ssid {
1786 	u8 ssid[IEEE80211_MAX_SSID_LEN];
1787 	u8 ssid_len;
1788 };
1789 
1790 /**
1791  * struct cfg80211_scan_info - information about completed scan
1792  * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1793  *	wireless device that requested the scan is connected to. If this
1794  *	information is not available, this field is left zero.
1795  * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1796  * @aborted: set to true if the scan was aborted for any reason,
1797  *	userspace will be notified of that
1798  */
1799 struct cfg80211_scan_info {
1800 	u64 scan_start_tsf;
1801 	u8 tsf_bssid[ETH_ALEN] __aligned(2);
1802 	bool aborted;
1803 };
1804 
1805 /**
1806  * struct cfg80211_scan_request - scan request description
1807  *
1808  * @ssids: SSIDs to scan for (active scan only)
1809  * @n_ssids: number of SSIDs
1810  * @channels: channels to scan on.
1811  * @n_channels: total number of channels to scan
1812  * @scan_width: channel width for scanning
1813  * @ie: optional information element(s) to add into Probe Request or %NULL
1814  * @ie_len: length of ie in octets
1815  * @duration: how long to listen on each channel, in TUs. If
1816  *	%duration_mandatory is not set, this is the maximum dwell time and
1817  *	the actual dwell time may be shorter.
1818  * @duration_mandatory: if set, the scan duration must be as specified by the
1819  *	%duration field.
1820  * @flags: bit field of flags controlling operation
1821  * @rates: bitmap of rates to advertise for each band
1822  * @wiphy: the wiphy this was for
1823  * @scan_start: time (in jiffies) when the scan started
1824  * @wdev: the wireless device to scan for
1825  * @info: (internal) information about completed scan
1826  * @notified: (internal) scan request was notified as done or aborted
1827  * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1828  * @mac_addr: MAC address used with randomisation
1829  * @mac_addr_mask: MAC address mask used with randomisation, bits that
1830  *	are 0 in the mask should be randomised, bits that are 1 should
1831  *	be taken from the @mac_addr
1832  * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
1833  */
1834 struct cfg80211_scan_request {
1835 	struct cfg80211_ssid *ssids;
1836 	int n_ssids;
1837 	u32 n_channels;
1838 	enum nl80211_bss_scan_width scan_width;
1839 	const u8 *ie;
1840 	size_t ie_len;
1841 	u16 duration;
1842 	bool duration_mandatory;
1843 	u32 flags;
1844 
1845 	u32 rates[NUM_NL80211_BANDS];
1846 
1847 	struct wireless_dev *wdev;
1848 
1849 	u8 mac_addr[ETH_ALEN] __aligned(2);
1850 	u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1851 	u8 bssid[ETH_ALEN] __aligned(2);
1852 
1853 	/* internal */
1854 	struct wiphy *wiphy;
1855 	unsigned long scan_start;
1856 	struct cfg80211_scan_info info;
1857 	bool notified;
1858 	bool no_cck;
1859 
1860 	/* keep last */
1861 	struct ieee80211_channel *channels[0];
1862 };
1863 
1864 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1865 {
1866 	int i;
1867 
1868 	get_random_bytes(buf, ETH_ALEN);
1869 	for (i = 0; i < ETH_ALEN; i++) {
1870 		buf[i] &= ~mask[i];
1871 		buf[i] |= addr[i] & mask[i];
1872 	}
1873 }
1874 
1875 /**
1876  * struct cfg80211_match_set - sets of attributes to match
1877  *
1878  * @ssid: SSID to be matched; may be zero-length in case of BSSID match
1879  *	or no match (RSSI only)
1880  * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
1881  *	or no match (RSSI only)
1882  * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1883  * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied
1884  *	for filtering out scan results received. Drivers advertize this support
1885  *	of band specific rssi based filtering through the feature capability
1886  *	%NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band
1887  *	specific rssi thresholds take precedence over rssi_thold, if specified.
1888  *	If not specified for any band, it will be assigned with rssi_thold of
1889  *	corresponding matchset.
1890  */
1891 struct cfg80211_match_set {
1892 	struct cfg80211_ssid ssid;
1893 	u8 bssid[ETH_ALEN];
1894 	s32 rssi_thold;
1895 	s32 per_band_rssi_thold[NUM_NL80211_BANDS];
1896 };
1897 
1898 /**
1899  * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1900  *
1901  * @interval: interval between scheduled scan iterations. In seconds.
1902  * @iterations: number of scan iterations in this scan plan. Zero means
1903  *	infinite loop.
1904  *	The last scan plan will always have this parameter set to zero,
1905  *	all other scan plans will have a finite number of iterations.
1906  */
1907 struct cfg80211_sched_scan_plan {
1908 	u32 interval;
1909 	u32 iterations;
1910 };
1911 
1912 /**
1913  * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
1914  *
1915  * @band: band of BSS which should match for RSSI level adjustment.
1916  * @delta: value of RSSI level adjustment.
1917  */
1918 struct cfg80211_bss_select_adjust {
1919 	enum nl80211_band band;
1920 	s8 delta;
1921 };
1922 
1923 /**
1924  * struct cfg80211_sched_scan_request - scheduled scan request description
1925  *
1926  * @reqid: identifies this request.
1927  * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1928  * @n_ssids: number of SSIDs
1929  * @n_channels: total number of channels to scan
1930  * @scan_width: channel width for scanning
1931  * @ie: optional information element(s) to add into Probe Request or %NULL
1932  * @ie_len: length of ie in octets
1933  * @flags: bit field of flags controlling operation
1934  * @match_sets: sets of parameters to be matched for a scan result
1935  * 	entry to be considered valid and to be passed to the host
1936  * 	(others are filtered out).
1937  *	If ommited, all results are passed.
1938  * @n_match_sets: number of match sets
1939  * @report_results: indicates that results were reported for this request
1940  * @wiphy: the wiphy this was for
1941  * @dev: the interface
1942  * @scan_start: start time of the scheduled scan
1943  * @channels: channels to scan
1944  * @min_rssi_thold: for drivers only supporting a single threshold, this
1945  *	contains the minimum over all matchsets
1946  * @mac_addr: MAC address used with randomisation
1947  * @mac_addr_mask: MAC address mask used with randomisation, bits that
1948  *	are 0 in the mask should be randomised, bits that are 1 should
1949  *	be taken from the @mac_addr
1950  * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
1951  *	index must be executed first.
1952  * @n_scan_plans: number of scan plans, at least 1.
1953  * @rcu_head: RCU callback used to free the struct
1954  * @owner_nlportid: netlink portid of owner (if this should is a request
1955  *	owned by a particular socket)
1956  * @nl_owner_dead: netlink owner socket was closed - this request be freed
1957  * @list: for keeping list of requests.
1958  * @delay: delay in seconds to use before starting the first scan
1959  *	cycle.  The driver may ignore this parameter and start
1960  *	immediately (or at any other time), if this feature is not
1961  *	supported.
1962  * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
1963  * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
1964  *	reporting in connected state to cases where a matching BSS is determined
1965  *	to have better or slightly worse RSSI than the current connected BSS.
1966  *	The relative RSSI threshold values are ignored in disconnected state.
1967  * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
1968  *	to the specified band while deciding whether a better BSS is reported
1969  *	using @relative_rssi. If delta is a negative number, the BSSs that
1970  *	belong to the specified band will be penalized by delta dB in relative
1971  *	comparisions.
1972  */
1973 struct cfg80211_sched_scan_request {
1974 	u64 reqid;
1975 	struct cfg80211_ssid *ssids;
1976 	int n_ssids;
1977 	u32 n_channels;
1978 	enum nl80211_bss_scan_width scan_width;
1979 	const u8 *ie;
1980 	size_t ie_len;
1981 	u32 flags;
1982 	struct cfg80211_match_set *match_sets;
1983 	int n_match_sets;
1984 	s32 min_rssi_thold;
1985 	u32 delay;
1986 	struct cfg80211_sched_scan_plan *scan_plans;
1987 	int n_scan_plans;
1988 
1989 	u8 mac_addr[ETH_ALEN] __aligned(2);
1990 	u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1991 
1992 	bool relative_rssi_set;
1993 	s8 relative_rssi;
1994 	struct cfg80211_bss_select_adjust rssi_adjust;
1995 
1996 	/* internal */
1997 	struct wiphy *wiphy;
1998 	struct net_device *dev;
1999 	unsigned long scan_start;
2000 	bool report_results;
2001 	struct rcu_head rcu_head;
2002 	u32 owner_nlportid;
2003 	bool nl_owner_dead;
2004 	struct list_head list;
2005 
2006 	/* keep last */
2007 	struct ieee80211_channel *channels[0];
2008 };
2009 
2010 /**
2011  * enum cfg80211_signal_type - signal type
2012  *
2013  * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2014  * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2015  * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2016  */
2017 enum cfg80211_signal_type {
2018 	CFG80211_SIGNAL_TYPE_NONE,
2019 	CFG80211_SIGNAL_TYPE_MBM,
2020 	CFG80211_SIGNAL_TYPE_UNSPEC,
2021 };
2022 
2023 /**
2024  * struct cfg80211_inform_bss - BSS inform data
2025  * @chan: channel the frame was received on
2026  * @scan_width: scan width that was used
2027  * @signal: signal strength value, according to the wiphy's
2028  *	signal type
2029  * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2030  *	received; should match the time when the frame was actually
2031  *	received by the device (not just by the host, in case it was
2032  *	buffered on the device) and be accurate to about 10ms.
2033  *	If the frame isn't buffered, just passing the return value of
2034  *	ktime_get_boot_ns() is likely appropriate.
2035  * @parent_tsf: the time at the start of reception of the first octet of the
2036  *	timestamp field of the frame. The time is the TSF of the BSS specified
2037  *	by %parent_bssid.
2038  * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2039  *	the BSS that requested the scan in which the beacon/probe was received.
2040  * @chains: bitmask for filled values in @chain_signal.
2041  * @chain_signal: per-chain signal strength of last received BSS in dBm.
2042  */
2043 struct cfg80211_inform_bss {
2044 	struct ieee80211_channel *chan;
2045 	enum nl80211_bss_scan_width scan_width;
2046 	s32 signal;
2047 	u64 boottime_ns;
2048 	u64 parent_tsf;
2049 	u8 parent_bssid[ETH_ALEN] __aligned(2);
2050 	u8 chains;
2051 	s8 chain_signal[IEEE80211_MAX_CHAINS];
2052 };
2053 
2054 /**
2055  * struct cfg80211_bss_ies - BSS entry IE data
2056  * @tsf: TSF contained in the frame that carried these IEs
2057  * @rcu_head: internal use, for freeing
2058  * @len: length of the IEs
2059  * @from_beacon: these IEs are known to come from a beacon
2060  * @data: IE data
2061  */
2062 struct cfg80211_bss_ies {
2063 	u64 tsf;
2064 	struct rcu_head rcu_head;
2065 	int len;
2066 	bool from_beacon;
2067 	u8 data[];
2068 };
2069 
2070 /**
2071  * struct cfg80211_bss - BSS description
2072  *
2073  * This structure describes a BSS (which may also be a mesh network)
2074  * for use in scan results and similar.
2075  *
2076  * @channel: channel this BSS is on
2077  * @scan_width: width of the control channel
2078  * @bssid: BSSID of the BSS
2079  * @beacon_interval: the beacon interval as from the frame
2080  * @capability: the capability field in host byte order
2081  * @ies: the information elements (Note that there is no guarantee that these
2082  *	are well-formed!); this is a pointer to either the beacon_ies or
2083  *	proberesp_ies depending on whether Probe Response frame has been
2084  *	received. It is always non-%NULL.
2085  * @beacon_ies: the information elements from the last Beacon frame
2086  *	(implementation note: if @hidden_beacon_bss is set this struct doesn't
2087  *	own the beacon_ies, but they're just pointers to the ones from the
2088  *	@hidden_beacon_bss struct)
2089  * @proberesp_ies: the information elements from the last Probe Response frame
2090  * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2091  *	a BSS that hides the SSID in its beacon, this points to the BSS struct
2092  *	that holds the beacon data. @beacon_ies is still valid, of course, and
2093  *	points to the same data as hidden_beacon_bss->beacon_ies in that case.
2094  * @transmitted_bss: pointer to the transmitted BSS, if this is a
2095  *	non-transmitted one (multi-BSSID support)
2096  * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2097  *	(multi-BSSID support)
2098  * @signal: signal strength value (type depends on the wiphy's signal_type)
2099  * @chains: bitmask for filled values in @chain_signal.
2100  * @chain_signal: per-chain signal strength of last received BSS in dBm.
2101  * @bssid_index: index in the multiple BSS set
2102  * @max_bssid_indicator: max number of members in the BSS set
2103  * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2104  */
2105 struct cfg80211_bss {
2106 	struct ieee80211_channel *channel;
2107 	enum nl80211_bss_scan_width scan_width;
2108 
2109 	const struct cfg80211_bss_ies __rcu *ies;
2110 	const struct cfg80211_bss_ies __rcu *beacon_ies;
2111 	const struct cfg80211_bss_ies __rcu *proberesp_ies;
2112 
2113 	struct cfg80211_bss *hidden_beacon_bss;
2114 	struct cfg80211_bss *transmitted_bss;
2115 	struct list_head nontrans_list;
2116 
2117 	s32 signal;
2118 
2119 	u16 beacon_interval;
2120 	u16 capability;
2121 
2122 	u8 bssid[ETH_ALEN];
2123 	u8 chains;
2124 	s8 chain_signal[IEEE80211_MAX_CHAINS];
2125 
2126 	u8 bssid_index;
2127 	u8 max_bssid_indicator;
2128 
2129 	u8 priv[0] __aligned(sizeof(void *));
2130 };
2131 
2132 /**
2133  * ieee80211_bss_get_elem - find element with given ID
2134  * @bss: the bss to search
2135  * @id: the element ID
2136  *
2137  * Note that the return value is an RCU-protected pointer, so
2138  * rcu_read_lock() must be held when calling this function.
2139  * Return: %NULL if not found.
2140  */
2141 const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
2142 
2143 /**
2144  * ieee80211_bss_get_ie - find IE with given ID
2145  * @bss: the bss to search
2146  * @id: the element ID
2147  *
2148  * Note that the return value is an RCU-protected pointer, so
2149  * rcu_read_lock() must be held when calling this function.
2150  * Return: %NULL if not found.
2151  */
2152 static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
2153 {
2154 	return (void *)ieee80211_bss_get_elem(bss, id);
2155 }
2156 
2157 
2158 /**
2159  * struct cfg80211_auth_request - Authentication request data
2160  *
2161  * This structure provides information needed to complete IEEE 802.11
2162  * authentication.
2163  *
2164  * @bss: The BSS to authenticate with, the callee must obtain a reference
2165  *	to it if it needs to keep it.
2166  * @auth_type: Authentication type (algorithm)
2167  * @ie: Extra IEs to add to Authentication frame or %NULL
2168  * @ie_len: Length of ie buffer in octets
2169  * @key_len: length of WEP key for shared key authentication
2170  * @key_idx: index of WEP key for shared key authentication
2171  * @key: WEP key for shared key authentication
2172  * @auth_data: Fields and elements in Authentication frames. This contains
2173  *	the authentication frame body (non-IE and IE data), excluding the
2174  *	Authentication algorithm number, i.e., starting at the Authentication
2175  *	transaction sequence number field.
2176  * @auth_data_len: Length of auth_data buffer in octets
2177  */
2178 struct cfg80211_auth_request {
2179 	struct cfg80211_bss *bss;
2180 	const u8 *ie;
2181 	size_t ie_len;
2182 	enum nl80211_auth_type auth_type;
2183 	const u8 *key;
2184 	u8 key_len, key_idx;
2185 	const u8 *auth_data;
2186 	size_t auth_data_len;
2187 };
2188 
2189 /**
2190  * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2191  *
2192  * @ASSOC_REQ_DISABLE_HT:  Disable HT (802.11n)
2193  * @ASSOC_REQ_DISABLE_VHT:  Disable VHT
2194  * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2195  * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2196  *	authentication capability. Drivers can offload authentication to
2197  *	userspace if this flag is set. Only applicable for cfg80211_connect()
2198  *	request (connect callback).
2199  */
2200 enum cfg80211_assoc_req_flags {
2201 	ASSOC_REQ_DISABLE_HT			= BIT(0),
2202 	ASSOC_REQ_DISABLE_VHT			= BIT(1),
2203 	ASSOC_REQ_USE_RRM			= BIT(2),
2204 	CONNECT_REQ_EXTERNAL_AUTH_SUPPORT	= BIT(3),
2205 };
2206 
2207 /**
2208  * struct cfg80211_assoc_request - (Re)Association request data
2209  *
2210  * This structure provides information needed to complete IEEE 802.11
2211  * (re)association.
2212  * @bss: The BSS to associate with. If the call is successful the driver is
2213  *	given a reference that it must give back to cfg80211_send_rx_assoc()
2214  *	or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2215  *	association requests while already associating must be rejected.
2216  * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2217  * @ie_len: Length of ie buffer in octets
2218  * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2219  * @crypto: crypto settings
2220  * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2221  *	to indicate a request to reassociate within the ESS instead of a request
2222  *	do the initial association with the ESS. When included, this is set to
2223  *	the BSSID of the current association, i.e., to the value that is
2224  *	included in the Current AP address field of the Reassociation Request
2225  *	frame.
2226  * @flags:  See &enum cfg80211_assoc_req_flags
2227  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
2228  *	will be used in ht_capa.  Un-supported values will be ignored.
2229  * @ht_capa_mask:  The bits of ht_capa which are to be used.
2230  * @vht_capa: VHT capability override
2231  * @vht_capa_mask: VHT capability mask indicating which fields to use
2232  * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2233  *	%NULL if FILS is not used.
2234  * @fils_kek_len: Length of fils_kek in octets
2235  * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2236  *	Request/Response frame or %NULL if FILS is not used. This field starts
2237  *	with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2238  */
2239 struct cfg80211_assoc_request {
2240 	struct cfg80211_bss *bss;
2241 	const u8 *ie, *prev_bssid;
2242 	size_t ie_len;
2243 	struct cfg80211_crypto_settings crypto;
2244 	bool use_mfp;
2245 	u32 flags;
2246 	struct ieee80211_ht_cap ht_capa;
2247 	struct ieee80211_ht_cap ht_capa_mask;
2248 	struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2249 	const u8 *fils_kek;
2250 	size_t fils_kek_len;
2251 	const u8 *fils_nonces;
2252 };
2253 
2254 /**
2255  * struct cfg80211_deauth_request - Deauthentication request data
2256  *
2257  * This structure provides information needed to complete IEEE 802.11
2258  * deauthentication.
2259  *
2260  * @bssid: the BSSID of the BSS to deauthenticate from
2261  * @ie: Extra IEs to add to Deauthentication frame or %NULL
2262  * @ie_len: Length of ie buffer in octets
2263  * @reason_code: The reason code for the deauthentication
2264  * @local_state_change: if set, change local state only and
2265  *	do not set a deauth frame
2266  */
2267 struct cfg80211_deauth_request {
2268 	const u8 *bssid;
2269 	const u8 *ie;
2270 	size_t ie_len;
2271 	u16 reason_code;
2272 	bool local_state_change;
2273 };
2274 
2275 /**
2276  * struct cfg80211_disassoc_request - Disassociation request data
2277  *
2278  * This structure provides information needed to complete IEEE 802.11
2279  * disassociation.
2280  *
2281  * @bss: the BSS to disassociate from
2282  * @ie: Extra IEs to add to Disassociation frame or %NULL
2283  * @ie_len: Length of ie buffer in octets
2284  * @reason_code: The reason code for the disassociation
2285  * @local_state_change: This is a request for a local state only, i.e., no
2286  *	Disassociation frame is to be transmitted.
2287  */
2288 struct cfg80211_disassoc_request {
2289 	struct cfg80211_bss *bss;
2290 	const u8 *ie;
2291 	size_t ie_len;
2292 	u16 reason_code;
2293 	bool local_state_change;
2294 };
2295 
2296 /**
2297  * struct cfg80211_ibss_params - IBSS parameters
2298  *
2299  * This structure defines the IBSS parameters for the join_ibss()
2300  * method.
2301  *
2302  * @ssid: The SSID, will always be non-null.
2303  * @ssid_len: The length of the SSID, will always be non-zero.
2304  * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2305  *	search for IBSSs with a different BSSID.
2306  * @chandef: defines the channel to use if no other IBSS to join can be found
2307  * @channel_fixed: The channel should be fixed -- do not search for
2308  *	IBSSs to join on other channels.
2309  * @ie: information element(s) to include in the beacon
2310  * @ie_len: length of that
2311  * @beacon_interval: beacon interval to use
2312  * @privacy: this is a protected network, keys will be configured
2313  *	after joining
2314  * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2315  *	sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2316  *	required to assume that the port is unauthorized until authorized by
2317  *	user space. Otherwise, port is marked authorized by default.
2318  * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2319  *	port frames over NL80211 instead of the network interface.
2320  * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2321  *	changes the channel when a radar is detected. This is required
2322  *	to operate on DFS channels.
2323  * @basic_rates: bitmap of basic rates to use when creating the IBSS
2324  * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2325  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
2326  *	will be used in ht_capa.  Un-supported values will be ignored.
2327  * @ht_capa_mask:  The bits of ht_capa which are to be used.
2328  * @wep_keys: static WEP keys, if not NULL points to an array of
2329  * 	CFG80211_MAX_WEP_KEYS WEP keys
2330  * @wep_tx_key: key index (0..3) of the default TX static WEP key
2331  */
2332 struct cfg80211_ibss_params {
2333 	const u8 *ssid;
2334 	const u8 *bssid;
2335 	struct cfg80211_chan_def chandef;
2336 	const u8 *ie;
2337 	u8 ssid_len, ie_len;
2338 	u16 beacon_interval;
2339 	u32 basic_rates;
2340 	bool channel_fixed;
2341 	bool privacy;
2342 	bool control_port;
2343 	bool control_port_over_nl80211;
2344 	bool userspace_handles_dfs;
2345 	int mcast_rate[NUM_NL80211_BANDS];
2346 	struct ieee80211_ht_cap ht_capa;
2347 	struct ieee80211_ht_cap ht_capa_mask;
2348 	struct key_params *wep_keys;
2349 	int wep_tx_key;
2350 };
2351 
2352 /**
2353  * struct cfg80211_bss_selection - connection parameters for BSS selection.
2354  *
2355  * @behaviour: requested BSS selection behaviour.
2356  * @param: parameters for requestion behaviour.
2357  * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2358  * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2359  */
2360 struct cfg80211_bss_selection {
2361 	enum nl80211_bss_select_attr behaviour;
2362 	union {
2363 		enum nl80211_band band_pref;
2364 		struct cfg80211_bss_select_adjust adjust;
2365 	} param;
2366 };
2367 
2368 /**
2369  * struct cfg80211_connect_params - Connection parameters
2370  *
2371  * This structure provides information needed to complete IEEE 802.11
2372  * authentication and association.
2373  *
2374  * @channel: The channel to use or %NULL if not specified (auto-select based
2375  *	on scan results)
2376  * @channel_hint: The channel of the recommended BSS for initial connection or
2377  *	%NULL if not specified
2378  * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2379  *	results)
2380  * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2381  *	%NULL if not specified. Unlike the @bssid parameter, the driver is
2382  *	allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2383  *	to use.
2384  * @ssid: SSID
2385  * @ssid_len: Length of ssid in octets
2386  * @auth_type: Authentication type (algorithm)
2387  * @ie: IEs for association request
2388  * @ie_len: Length of assoc_ie in octets
2389  * @privacy: indicates whether privacy-enabled APs should be used
2390  * @mfp: indicate whether management frame protection is used
2391  * @crypto: crypto settings
2392  * @key_len: length of WEP key for shared key authentication
2393  * @key_idx: index of WEP key for shared key authentication
2394  * @key: WEP key for shared key authentication
2395  * @flags:  See &enum cfg80211_assoc_req_flags
2396  * @bg_scan_period:  Background scan period in seconds
2397  *	or -1 to indicate that default value is to be used.
2398  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
2399  *	will be used in ht_capa.  Un-supported values will be ignored.
2400  * @ht_capa_mask:  The bits of ht_capa which are to be used.
2401  * @vht_capa:  VHT Capability overrides
2402  * @vht_capa_mask: The bits of vht_capa which are to be used.
2403  * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2404  *	networks.
2405  * @bss_select: criteria to be used for BSS selection.
2406  * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2407  *	to indicate a request to reassociate within the ESS instead of a request
2408  *	do the initial association with the ESS. When included, this is set to
2409  *	the BSSID of the current association, i.e., to the value that is
2410  *	included in the Current AP address field of the Reassociation Request
2411  *	frame.
2412  * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2413  *	NAI or %NULL if not specified. This is used to construct FILS wrapped
2414  *	data IE.
2415  * @fils_erp_username_len: Length of @fils_erp_username in octets.
2416  * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2417  *	%NULL if not specified. This specifies the domain name of ER server and
2418  *	is used to construct FILS wrapped data IE.
2419  * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2420  * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2421  *	messages. This is also used to construct FILS wrapped data IE.
2422  * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2423  *	keys in FILS or %NULL if not specified.
2424  * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2425  * @want_1x: indicates user-space supports and wants to use 802.1X driver
2426  *	offload of 4-way handshake.
2427  */
2428 struct cfg80211_connect_params {
2429 	struct ieee80211_channel *channel;
2430 	struct ieee80211_channel *channel_hint;
2431 	const u8 *bssid;
2432 	const u8 *bssid_hint;
2433 	const u8 *ssid;
2434 	size_t ssid_len;
2435 	enum nl80211_auth_type auth_type;
2436 	const u8 *ie;
2437 	size_t ie_len;
2438 	bool privacy;
2439 	enum nl80211_mfp mfp;
2440 	struct cfg80211_crypto_settings crypto;
2441 	const u8 *key;
2442 	u8 key_len, key_idx;
2443 	u32 flags;
2444 	int bg_scan_period;
2445 	struct ieee80211_ht_cap ht_capa;
2446 	struct ieee80211_ht_cap ht_capa_mask;
2447 	struct ieee80211_vht_cap vht_capa;
2448 	struct ieee80211_vht_cap vht_capa_mask;
2449 	bool pbss;
2450 	struct cfg80211_bss_selection bss_select;
2451 	const u8 *prev_bssid;
2452 	const u8 *fils_erp_username;
2453 	size_t fils_erp_username_len;
2454 	const u8 *fils_erp_realm;
2455 	size_t fils_erp_realm_len;
2456 	u16 fils_erp_next_seq_num;
2457 	const u8 *fils_erp_rrk;
2458 	size_t fils_erp_rrk_len;
2459 	bool want_1x;
2460 };
2461 
2462 /**
2463  * enum cfg80211_connect_params_changed - Connection parameters being updated
2464  *
2465  * This enum provides information of all connect parameters that
2466  * have to be updated as part of update_connect_params() call.
2467  *
2468  * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2469  * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
2470  *	username, erp sequence number and rrk) are updated
2471  * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
2472  */
2473 enum cfg80211_connect_params_changed {
2474 	UPDATE_ASSOC_IES		= BIT(0),
2475 	UPDATE_FILS_ERP_INFO		= BIT(1),
2476 	UPDATE_AUTH_TYPE		= BIT(2),
2477 };
2478 
2479 /**
2480  * enum wiphy_params_flags - set_wiphy_params bitfield values
2481  * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2482  * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2483  * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2484  * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2485  * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2486  * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2487  * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
2488  * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
2489  * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
2490  */
2491 enum wiphy_params_flags {
2492 	WIPHY_PARAM_RETRY_SHORT		= 1 << 0,
2493 	WIPHY_PARAM_RETRY_LONG		= 1 << 1,
2494 	WIPHY_PARAM_FRAG_THRESHOLD	= 1 << 2,
2495 	WIPHY_PARAM_RTS_THRESHOLD	= 1 << 3,
2496 	WIPHY_PARAM_COVERAGE_CLASS	= 1 << 4,
2497 	WIPHY_PARAM_DYN_ACK		= 1 << 5,
2498 	WIPHY_PARAM_TXQ_LIMIT		= 1 << 6,
2499 	WIPHY_PARAM_TXQ_MEMORY_LIMIT	= 1 << 7,
2500 	WIPHY_PARAM_TXQ_QUANTUM		= 1 << 8,
2501 };
2502 
2503 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT	256
2504 
2505 /**
2506  * struct cfg80211_pmksa - PMK Security Association
2507  *
2508  * This structure is passed to the set/del_pmksa() method for PMKSA
2509  * caching.
2510  *
2511  * @bssid: The AP's BSSID (may be %NULL).
2512  * @pmkid: The identifier to refer a PMKSA.
2513  * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2514  *	derivation by a FILS STA. Otherwise, %NULL.
2515  * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2516  *	the hash algorithm used to generate this.
2517  * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2518  *	cache identifier (may be %NULL).
2519  * @ssid_len: Length of the @ssid in octets.
2520  * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2521  *	scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2522  *	%NULL).
2523  */
2524 struct cfg80211_pmksa {
2525 	const u8 *bssid;
2526 	const u8 *pmkid;
2527 	const u8 *pmk;
2528 	size_t pmk_len;
2529 	const u8 *ssid;
2530 	size_t ssid_len;
2531 	const u8 *cache_id;
2532 };
2533 
2534 /**
2535  * struct cfg80211_pkt_pattern - packet pattern
2536  * @mask: bitmask where to match pattern and where to ignore bytes,
2537  *	one bit per byte, in same format as nl80211
2538  * @pattern: bytes to match where bitmask is 1
2539  * @pattern_len: length of pattern (in bytes)
2540  * @pkt_offset: packet offset (in bytes)
2541  *
2542  * Internal note: @mask and @pattern are allocated in one chunk of
2543  * memory, free @mask only!
2544  */
2545 struct cfg80211_pkt_pattern {
2546 	const u8 *mask, *pattern;
2547 	int pattern_len;
2548 	int pkt_offset;
2549 };
2550 
2551 /**
2552  * struct cfg80211_wowlan_tcp - TCP connection parameters
2553  *
2554  * @sock: (internal) socket for source port allocation
2555  * @src: source IP address
2556  * @dst: destination IP address
2557  * @dst_mac: destination MAC address
2558  * @src_port: source port
2559  * @dst_port: destination port
2560  * @payload_len: data payload length
2561  * @payload: data payload buffer
2562  * @payload_seq: payload sequence stamping configuration
2563  * @data_interval: interval at which to send data packets
2564  * @wake_len: wakeup payload match length
2565  * @wake_data: wakeup payload match data
2566  * @wake_mask: wakeup payload match mask
2567  * @tokens_size: length of the tokens buffer
2568  * @payload_tok: payload token usage configuration
2569  */
2570 struct cfg80211_wowlan_tcp {
2571 	struct socket *sock;
2572 	__be32 src, dst;
2573 	u16 src_port, dst_port;
2574 	u8 dst_mac[ETH_ALEN];
2575 	int payload_len;
2576 	const u8 *payload;
2577 	struct nl80211_wowlan_tcp_data_seq payload_seq;
2578 	u32 data_interval;
2579 	u32 wake_len;
2580 	const u8 *wake_data, *wake_mask;
2581 	u32 tokens_size;
2582 	/* must be last, variable member */
2583 	struct nl80211_wowlan_tcp_data_token payload_tok;
2584 };
2585 
2586 /**
2587  * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2588  *
2589  * This structure defines the enabled WoWLAN triggers for the device.
2590  * @any: wake up on any activity -- special trigger if device continues
2591  *	operating as normal during suspend
2592  * @disconnect: wake up if getting disconnected
2593  * @magic_pkt: wake up on receiving magic packet
2594  * @patterns: wake up on receiving packet matching a pattern
2595  * @n_patterns: number of patterns
2596  * @gtk_rekey_failure: wake up on GTK rekey failure
2597  * @eap_identity_req: wake up on EAP identity request packet
2598  * @four_way_handshake: wake up on 4-way handshake
2599  * @rfkill_release: wake up when rfkill is released
2600  * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2601  *	NULL if not configured.
2602  * @nd_config: configuration for the scan to be used for net detect wake.
2603  */
2604 struct cfg80211_wowlan {
2605 	bool any, disconnect, magic_pkt, gtk_rekey_failure,
2606 	     eap_identity_req, four_way_handshake,
2607 	     rfkill_release;
2608 	struct cfg80211_pkt_pattern *patterns;
2609 	struct cfg80211_wowlan_tcp *tcp;
2610 	int n_patterns;
2611 	struct cfg80211_sched_scan_request *nd_config;
2612 };
2613 
2614 /**
2615  * struct cfg80211_coalesce_rules - Coalesce rule parameters
2616  *
2617  * This structure defines coalesce rule for the device.
2618  * @delay: maximum coalescing delay in msecs.
2619  * @condition: condition for packet coalescence.
2620  *	see &enum nl80211_coalesce_condition.
2621  * @patterns: array of packet patterns
2622  * @n_patterns: number of patterns
2623  */
2624 struct cfg80211_coalesce_rules {
2625 	int delay;
2626 	enum nl80211_coalesce_condition condition;
2627 	struct cfg80211_pkt_pattern *patterns;
2628 	int n_patterns;
2629 };
2630 
2631 /**
2632  * struct cfg80211_coalesce - Packet coalescing settings
2633  *
2634  * This structure defines coalescing settings.
2635  * @rules: array of coalesce rules
2636  * @n_rules: number of rules
2637  */
2638 struct cfg80211_coalesce {
2639 	struct cfg80211_coalesce_rules *rules;
2640 	int n_rules;
2641 };
2642 
2643 /**
2644  * struct cfg80211_wowlan_nd_match - information about the match
2645  *
2646  * @ssid: SSID of the match that triggered the wake up
2647  * @n_channels: Number of channels where the match occurred.  This
2648  *	value may be zero if the driver can't report the channels.
2649  * @channels: center frequencies of the channels where a match
2650  *	occurred (in MHz)
2651  */
2652 struct cfg80211_wowlan_nd_match {
2653 	struct cfg80211_ssid ssid;
2654 	int n_channels;
2655 	u32 channels[];
2656 };
2657 
2658 /**
2659  * struct cfg80211_wowlan_nd_info - net detect wake up information
2660  *
2661  * @n_matches: Number of match information instances provided in
2662  *	@matches.  This value may be zero if the driver can't provide
2663  *	match information.
2664  * @matches: Array of pointers to matches containing information about
2665  *	the matches that triggered the wake up.
2666  */
2667 struct cfg80211_wowlan_nd_info {
2668 	int n_matches;
2669 	struct cfg80211_wowlan_nd_match *matches[];
2670 };
2671 
2672 /**
2673  * struct cfg80211_wowlan_wakeup - wakeup report
2674  * @disconnect: woke up by getting disconnected
2675  * @magic_pkt: woke up by receiving magic packet
2676  * @gtk_rekey_failure: woke up by GTK rekey failure
2677  * @eap_identity_req: woke up by EAP identity request packet
2678  * @four_way_handshake: woke up by 4-way handshake
2679  * @rfkill_release: woke up by rfkill being released
2680  * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2681  * @packet_present_len: copied wakeup packet data
2682  * @packet_len: original wakeup packet length
2683  * @packet: The packet causing the wakeup, if any.
2684  * @packet_80211:  For pattern match, magic packet and other data
2685  *	frame triggers an 802.3 frame should be reported, for
2686  *	disconnect due to deauth 802.11 frame. This indicates which
2687  *	it is.
2688  * @tcp_match: TCP wakeup packet received
2689  * @tcp_connlost: TCP connection lost or failed to establish
2690  * @tcp_nomoretokens: TCP data ran out of tokens
2691  * @net_detect: if not %NULL, woke up because of net detect
2692  */
2693 struct cfg80211_wowlan_wakeup {
2694 	bool disconnect, magic_pkt, gtk_rekey_failure,
2695 	     eap_identity_req, four_way_handshake,
2696 	     rfkill_release, packet_80211,
2697 	     tcp_match, tcp_connlost, tcp_nomoretokens;
2698 	s32 pattern_idx;
2699 	u32 packet_present_len, packet_len;
2700 	const void *packet;
2701 	struct cfg80211_wowlan_nd_info *net_detect;
2702 };
2703 
2704 /**
2705  * struct cfg80211_gtk_rekey_data - rekey data
2706  * @kek: key encryption key (NL80211_KEK_LEN bytes)
2707  * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2708  * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2709  */
2710 struct cfg80211_gtk_rekey_data {
2711 	const u8 *kek, *kck, *replay_ctr;
2712 };
2713 
2714 /**
2715  * struct cfg80211_update_ft_ies_params - FT IE Information
2716  *
2717  * This structure provides information needed to update the fast transition IE
2718  *
2719  * @md: The Mobility Domain ID, 2 Octet value
2720  * @ie: Fast Transition IEs
2721  * @ie_len: Length of ft_ie in octets
2722  */
2723 struct cfg80211_update_ft_ies_params {
2724 	u16 md;
2725 	const u8 *ie;
2726 	size_t ie_len;
2727 };
2728 
2729 /**
2730  * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2731  *
2732  * This structure provides information needed to transmit a mgmt frame
2733  *
2734  * @chan: channel to use
2735  * @offchan: indicates wether off channel operation is required
2736  * @wait: duration for ROC
2737  * @buf: buffer to transmit
2738  * @len: buffer length
2739  * @no_cck: don't use cck rates for this frame
2740  * @dont_wait_for_ack: tells the low level not to wait for an ack
2741  * @n_csa_offsets: length of csa_offsets array
2742  * @csa_offsets: array of all the csa offsets in the frame
2743  */
2744 struct cfg80211_mgmt_tx_params {
2745 	struct ieee80211_channel *chan;
2746 	bool offchan;
2747 	unsigned int wait;
2748 	const u8 *buf;
2749 	size_t len;
2750 	bool no_cck;
2751 	bool dont_wait_for_ack;
2752 	int n_csa_offsets;
2753 	const u16 *csa_offsets;
2754 };
2755 
2756 /**
2757  * struct cfg80211_dscp_exception - DSCP exception
2758  *
2759  * @dscp: DSCP value that does not adhere to the user priority range definition
2760  * @up: user priority value to which the corresponding DSCP value belongs
2761  */
2762 struct cfg80211_dscp_exception {
2763 	u8 dscp;
2764 	u8 up;
2765 };
2766 
2767 /**
2768  * struct cfg80211_dscp_range - DSCP range definition for user priority
2769  *
2770  * @low: lowest DSCP value of this user priority range, inclusive
2771  * @high: highest DSCP value of this user priority range, inclusive
2772  */
2773 struct cfg80211_dscp_range {
2774 	u8 low;
2775 	u8 high;
2776 };
2777 
2778 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2779 #define IEEE80211_QOS_MAP_MAX_EX	21
2780 #define IEEE80211_QOS_MAP_LEN_MIN	16
2781 #define IEEE80211_QOS_MAP_LEN_MAX \
2782 	(IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2783 
2784 /**
2785  * struct cfg80211_qos_map - QoS Map Information
2786  *
2787  * This struct defines the Interworking QoS map setting for DSCP values
2788  *
2789  * @num_des: number of DSCP exceptions (0..21)
2790  * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2791  *	the user priority DSCP range definition
2792  * @up: DSCP range definition for a particular user priority
2793  */
2794 struct cfg80211_qos_map {
2795 	u8 num_des;
2796 	struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2797 	struct cfg80211_dscp_range up[8];
2798 };
2799 
2800 /**
2801  * struct cfg80211_nan_conf - NAN configuration
2802  *
2803  * This struct defines NAN configuration parameters
2804  *
2805  * @master_pref: master preference (1 - 255)
2806  * @bands: operating bands, a bitmap of &enum nl80211_band values.
2807  *	For instance, for NL80211_BAND_2GHZ, bit 0 would be set
2808  *	(i.e. BIT(NL80211_BAND_2GHZ)).
2809  */
2810 struct cfg80211_nan_conf {
2811 	u8 master_pref;
2812 	u8 bands;
2813 };
2814 
2815 /**
2816  * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
2817  * configuration
2818  *
2819  * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
2820  * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
2821  */
2822 enum cfg80211_nan_conf_changes {
2823 	CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
2824 	CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
2825 };
2826 
2827 /**
2828  * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
2829  *
2830  * @filter: the content of the filter
2831  * @len: the length of the filter
2832  */
2833 struct cfg80211_nan_func_filter {
2834 	const u8 *filter;
2835 	u8 len;
2836 };
2837 
2838 /**
2839  * struct cfg80211_nan_func - a NAN function
2840  *
2841  * @type: &enum nl80211_nan_function_type
2842  * @service_id: the service ID of the function
2843  * @publish_type: &nl80211_nan_publish_type
2844  * @close_range: if true, the range should be limited. Threshold is
2845  *	implementation specific.
2846  * @publish_bcast: if true, the solicited publish should be broadcasted
2847  * @subscribe_active: if true, the subscribe is active
2848  * @followup_id: the instance ID for follow up
2849  * @followup_reqid: the requestor instance ID for follow up
2850  * @followup_dest: MAC address of the recipient of the follow up
2851  * @ttl: time to live counter in DW.
2852  * @serv_spec_info: Service Specific Info
2853  * @serv_spec_info_len: Service Specific Info length
2854  * @srf_include: if true, SRF is inclusive
2855  * @srf_bf: Bloom Filter
2856  * @srf_bf_len: Bloom Filter length
2857  * @srf_bf_idx: Bloom Filter index
2858  * @srf_macs: SRF MAC addresses
2859  * @srf_num_macs: number of MAC addresses in SRF
2860  * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
2861  * @tx_filters: filters that should be transmitted in the SDF.
2862  * @num_rx_filters: length of &rx_filters.
2863  * @num_tx_filters: length of &tx_filters.
2864  * @instance_id: driver allocated id of the function.
2865  * @cookie: unique NAN function identifier.
2866  */
2867 struct cfg80211_nan_func {
2868 	enum nl80211_nan_function_type type;
2869 	u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
2870 	u8 publish_type;
2871 	bool close_range;
2872 	bool publish_bcast;
2873 	bool subscribe_active;
2874 	u8 followup_id;
2875 	u8 followup_reqid;
2876 	struct mac_address followup_dest;
2877 	u32 ttl;
2878 	const u8 *serv_spec_info;
2879 	u8 serv_spec_info_len;
2880 	bool srf_include;
2881 	const u8 *srf_bf;
2882 	u8 srf_bf_len;
2883 	u8 srf_bf_idx;
2884 	struct mac_address *srf_macs;
2885 	int srf_num_macs;
2886 	struct cfg80211_nan_func_filter *rx_filters;
2887 	struct cfg80211_nan_func_filter *tx_filters;
2888 	u8 num_tx_filters;
2889 	u8 num_rx_filters;
2890 	u8 instance_id;
2891 	u64 cookie;
2892 };
2893 
2894 /**
2895  * struct cfg80211_pmk_conf - PMK configuration
2896  *
2897  * @aa: authenticator address
2898  * @pmk_len: PMK length in bytes.
2899  * @pmk: the PMK material
2900  * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
2901  *	is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
2902  *	holds PMK-R0.
2903  */
2904 struct cfg80211_pmk_conf {
2905 	const u8 *aa;
2906 	u8 pmk_len;
2907 	const u8 *pmk;
2908 	const u8 *pmk_r0_name;
2909 };
2910 
2911 /**
2912  * struct cfg80211_external_auth_params - Trigger External authentication.
2913  *
2914  * Commonly used across the external auth request and event interfaces.
2915  *
2916  * @action: action type / trigger for external authentication. Only significant
2917  *	for the authentication request event interface (driver to user space).
2918  * @bssid: BSSID of the peer with which the authentication has
2919  *	to happen. Used by both the authentication request event and
2920  *	authentication response command interface.
2921  * @ssid: SSID of the AP.  Used by both the authentication request event and
2922  *	authentication response command interface.
2923  * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
2924  *	authentication request event interface.
2925  * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
2926  *	use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
2927  *	the real status code for failures. Used only for the authentication
2928  *	response command interface (user space to driver).
2929  * @pmkid: The identifier to refer a PMKSA.
2930  */
2931 struct cfg80211_external_auth_params {
2932 	enum nl80211_external_auth_action action;
2933 	u8 bssid[ETH_ALEN] __aligned(2);
2934 	struct cfg80211_ssid ssid;
2935 	unsigned int key_mgmt_suite;
2936 	u16 status;
2937 	const u8 *pmkid;
2938 };
2939 
2940 /**
2941  * struct cfg80211_ftm_responder_stats - FTM responder statistics
2942  *
2943  * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
2944  *	indicate the relevant values in this struct for them
2945  * @success_num: number of FTM sessions in which all frames were successfully
2946  *	answered
2947  * @partial_num: number of FTM sessions in which part of frames were
2948  *	successfully answered
2949  * @failed_num: number of failed FTM sessions
2950  * @asap_num: number of ASAP FTM sessions
2951  * @non_asap_num: number of  non-ASAP FTM sessions
2952  * @total_duration_ms: total sessions durations - gives an indication
2953  *	of how much time the responder was busy
2954  * @unknown_triggers_num: number of unknown FTM triggers - triggers from
2955  *	initiators that didn't finish successfully the negotiation phase with
2956  *	the responder
2957  * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
2958  *	for a new scheduling although it already has scheduled FTM slot
2959  * @out_of_window_triggers_num: total FTM triggers out of scheduled window
2960  */
2961 struct cfg80211_ftm_responder_stats {
2962 	u32 filled;
2963 	u32 success_num;
2964 	u32 partial_num;
2965 	u32 failed_num;
2966 	u32 asap_num;
2967 	u32 non_asap_num;
2968 	u64 total_duration_ms;
2969 	u32 unknown_triggers_num;
2970 	u32 reschedule_requests_num;
2971 	u32 out_of_window_triggers_num;
2972 };
2973 
2974 /**
2975  * struct cfg80211_pmsr_ftm_result - FTM result
2976  * @failure_reason: if this measurement failed (PMSR status is
2977  *	%NL80211_PMSR_STATUS_FAILURE), this gives a more precise
2978  *	reason than just "failure"
2979  * @burst_index: if reporting partial results, this is the index
2980  *	in [0 .. num_bursts-1] of the burst that's being reported
2981  * @num_ftmr_attempts: number of FTM request frames transmitted
2982  * @num_ftmr_successes: number of FTM request frames acked
2983  * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
2984  *	fill this to indicate in how many seconds a retry is deemed possible
2985  *	by the responder
2986  * @num_bursts_exp: actual number of bursts exponent negotiated
2987  * @burst_duration: actual burst duration negotiated
2988  * @ftms_per_burst: actual FTMs per burst negotiated
2989  * @lci_len: length of LCI information (if present)
2990  * @civicloc_len: length of civic location information (if present)
2991  * @lci: LCI data (may be %NULL)
2992  * @civicloc: civic location data (may be %NULL)
2993  * @rssi_avg: average RSSI over FTM action frames reported
2994  * @rssi_spread: spread of the RSSI over FTM action frames reported
2995  * @tx_rate: bitrate for transmitted FTM action frame response
2996  * @rx_rate: bitrate of received FTM action frame
2997  * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
2998  * @rtt_variance: variance of RTTs measured (note that standard deviation is
2999  *	the square root of the variance)
3000  * @rtt_spread: spread of the RTTs measured
3001  * @dist_avg: average of distances (mm) measured
3002  *	(must have either this or @rtt_avg)
3003  * @dist_variance: variance of distances measured (see also @rtt_variance)
3004  * @dist_spread: spread of distances measured (see also @rtt_spread)
3005  * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
3006  * @num_ftmr_successes_valid: @num_ftmr_successes is valid
3007  * @rssi_avg_valid: @rssi_avg is valid
3008  * @rssi_spread_valid: @rssi_spread is valid
3009  * @tx_rate_valid: @tx_rate is valid
3010  * @rx_rate_valid: @rx_rate is valid
3011  * @rtt_avg_valid: @rtt_avg is valid
3012  * @rtt_variance_valid: @rtt_variance is valid
3013  * @rtt_spread_valid: @rtt_spread is valid
3014  * @dist_avg_valid: @dist_avg is valid
3015  * @dist_variance_valid: @dist_variance is valid
3016  * @dist_spread_valid: @dist_spread is valid
3017  */
3018 struct cfg80211_pmsr_ftm_result {
3019 	const u8 *lci;
3020 	const u8 *civicloc;
3021 	unsigned int lci_len;
3022 	unsigned int civicloc_len;
3023 	enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
3024 	u32 num_ftmr_attempts, num_ftmr_successes;
3025 	s16 burst_index;
3026 	u8 busy_retry_time;
3027 	u8 num_bursts_exp;
3028 	u8 burst_duration;
3029 	u8 ftms_per_burst;
3030 	s32 rssi_avg;
3031 	s32 rssi_spread;
3032 	struct rate_info tx_rate, rx_rate;
3033 	s64 rtt_avg;
3034 	s64 rtt_variance;
3035 	s64 rtt_spread;
3036 	s64 dist_avg;
3037 	s64 dist_variance;
3038 	s64 dist_spread;
3039 
3040 	u16 num_ftmr_attempts_valid:1,
3041 	    num_ftmr_successes_valid:1,
3042 	    rssi_avg_valid:1,
3043 	    rssi_spread_valid:1,
3044 	    tx_rate_valid:1,
3045 	    rx_rate_valid:1,
3046 	    rtt_avg_valid:1,
3047 	    rtt_variance_valid:1,
3048 	    rtt_spread_valid:1,
3049 	    dist_avg_valid:1,
3050 	    dist_variance_valid:1,
3051 	    dist_spread_valid:1;
3052 };
3053 
3054 /**
3055  * struct cfg80211_pmsr_result - peer measurement result
3056  * @addr: address of the peer
3057  * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3058  *	measurement was made)
3059  * @ap_tsf: AP's TSF at measurement time
3060  * @status: status of the measurement
3061  * @final: if reporting partial results, mark this as the last one; if not
3062  *	reporting partial results always set this flag
3063  * @ap_tsf_valid: indicates the @ap_tsf value is valid
3064  * @type: type of the measurement reported, note that we only support reporting
3065  *	one type at a time, but you can report multiple results separately and
3066  *	they're all aggregated for userspace.
3067  */
3068 struct cfg80211_pmsr_result {
3069 	u64 host_time, ap_tsf;
3070 	enum nl80211_peer_measurement_status status;
3071 
3072 	u8 addr[ETH_ALEN];
3073 
3074 	u8 final:1,
3075 	   ap_tsf_valid:1;
3076 
3077 	enum nl80211_peer_measurement_type type;
3078 
3079 	union {
3080 		struct cfg80211_pmsr_ftm_result ftm;
3081 	};
3082 };
3083 
3084 /**
3085  * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3086  * @requested: indicates FTM is requested
3087  * @preamble: frame preamble to use
3088  * @burst_period: burst period to use
3089  * @asap: indicates to use ASAP mode
3090  * @num_bursts_exp: number of bursts exponent
3091  * @burst_duration: burst duration
3092  * @ftms_per_burst: number of FTMs per burst
3093  * @ftmr_retries: number of retries for FTM request
3094  * @request_lci: request LCI information
3095  * @request_civicloc: request civic location information
3096  *
3097  * See also nl80211 for the respective attribute documentation.
3098  */
3099 struct cfg80211_pmsr_ftm_request_peer {
3100 	enum nl80211_preamble preamble;
3101 	u16 burst_period;
3102 	u8 requested:1,
3103 	   asap:1,
3104 	   request_lci:1,
3105 	   request_civicloc:1;
3106 	u8 num_bursts_exp;
3107 	u8 burst_duration;
3108 	u8 ftms_per_burst;
3109 	u8 ftmr_retries;
3110 };
3111 
3112 /**
3113  * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3114  * @addr: MAC address
3115  * @chandef: channel to use
3116  * @report_ap_tsf: report the associated AP's TSF
3117  * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3118  */
3119 struct cfg80211_pmsr_request_peer {
3120 	u8 addr[ETH_ALEN];
3121 	struct cfg80211_chan_def chandef;
3122 	u8 report_ap_tsf:1;
3123 	struct cfg80211_pmsr_ftm_request_peer ftm;
3124 };
3125 
3126 /**
3127  * struct cfg80211_pmsr_request - peer measurement request
3128  * @cookie: cookie, set by cfg80211
3129  * @nl_portid: netlink portid - used by cfg80211
3130  * @drv_data: driver data for this request, if required for aborting,
3131  *	not otherwise freed or anything by cfg80211
3132  * @mac_addr: MAC address used for (randomised) request
3133  * @mac_addr_mask: MAC address mask used for randomisation, bits that
3134  *	are 0 in the mask should be randomised, bits that are 1 should
3135  *	be taken from the @mac_addr
3136  * @list: used by cfg80211 to hold on to the request
3137  * @timeout: timeout (in milliseconds) for the whole operation, if
3138  *	zero it means there's no timeout
3139  * @n_peers: number of peers to do measurements with
3140  * @peers: per-peer measurement request data
3141  */
3142 struct cfg80211_pmsr_request {
3143 	u64 cookie;
3144 	void *drv_data;
3145 	u32 n_peers;
3146 	u32 nl_portid;
3147 
3148 	u32 timeout;
3149 
3150 	u8 mac_addr[ETH_ALEN] __aligned(2);
3151 	u8 mac_addr_mask[ETH_ALEN] __aligned(2);
3152 
3153 	struct list_head list;
3154 
3155 	struct cfg80211_pmsr_request_peer peers[];
3156 };
3157 
3158 /**
3159  * struct cfg80211_update_owe_info - OWE Information
3160  *
3161  * This structure provides information needed for the drivers to offload OWE
3162  * (Opportunistic Wireless Encryption) processing to the user space.
3163  *
3164  * Commonly used across update_owe_info request and event interfaces.
3165  *
3166  * @peer: MAC address of the peer device for which the OWE processing
3167  *	has to be done.
3168  * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
3169  *	processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
3170  *	cannot give you the real status code for failures. Used only for
3171  *	OWE update request command interface (user space to driver).
3172  * @ie: IEs obtained from the peer or constructed by the user space. These are
3173  *	the IEs of the remote peer in the event from the host driver and
3174  *	the constructed IEs by the user space in the request interface.
3175  * @ie_len: Length of IEs in octets.
3176  */
3177 struct cfg80211_update_owe_info {
3178 	u8 peer[ETH_ALEN] __aligned(2);
3179 	u16 status;
3180 	const u8 *ie;
3181 	size_t ie_len;
3182 };
3183 
3184 /**
3185  * struct cfg80211_ops - backend description for wireless configuration
3186  *
3187  * This struct is registered by fullmac card drivers and/or wireless stacks
3188  * in order to handle configuration requests on their interfaces.
3189  *
3190  * All callbacks except where otherwise noted should return 0
3191  * on success or a negative error code.
3192  *
3193  * All operations are currently invoked under rtnl for consistency with the
3194  * wireless extensions but this is subject to reevaluation as soon as this
3195  * code is used more widely and we have a first user without wext.
3196  *
3197  * @suspend: wiphy device needs to be suspended. The variable @wow will
3198  *	be %NULL or contain the enabled Wake-on-Wireless triggers that are
3199  *	configured for the device.
3200  * @resume: wiphy device needs to be resumed
3201  * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3202  *	to call device_set_wakeup_enable() to enable/disable wakeup from
3203  *	the device.
3204  *
3205  * @add_virtual_intf: create a new virtual interface with the given name,
3206  *	must set the struct wireless_dev's iftype. Beware: You must create
3207  *	the new netdev in the wiphy's network namespace! Returns the struct
3208  *	wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3209  *	also set the address member in the wdev.
3210  *
3211  * @del_virtual_intf: remove the virtual interface
3212  *
3213  * @change_virtual_intf: change type/configuration of virtual interface,
3214  *	keep the struct wireless_dev's iftype updated.
3215  *
3216  * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3217  *	when adding a group key.
3218  *
3219  * @get_key: get information about the key with the given parameters.
3220  *	@mac_addr will be %NULL when requesting information for a group
3221  *	key. All pointers given to the @callback function need not be valid
3222  *	after it returns. This function should return an error if it is
3223  *	not possible to retrieve the key, -ENOENT if it doesn't exist.
3224  *
3225  * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3226  *	and @key_index, return -ENOENT if the key doesn't exist.
3227  *
3228  * @set_default_key: set the default key on an interface
3229  *
3230  * @set_default_mgmt_key: set the default management frame key on an interface
3231  *
3232  * @set_rekey_data: give the data necessary for GTK rekeying to the driver
3233  *
3234  * @start_ap: Start acting in AP mode defined by the parameters.
3235  * @change_beacon: Change the beacon parameters for an access point mode
3236  *	interface. This should reject the call when AP mode wasn't started.
3237  * @stop_ap: Stop being an AP, including stopping beaconing.
3238  *
3239  * @add_station: Add a new station.
3240  * @del_station: Remove a station
3241  * @change_station: Modify a given station. Note that flags changes are not much
3242  *	validated in cfg80211, in particular the auth/assoc/authorized flags
3243  *	might come to the driver in invalid combinations -- make sure to check
3244  *	them, also against the existing state! Drivers must call
3245  *	cfg80211_check_station_change() to validate the information.
3246  * @get_station: get station information for the station identified by @mac
3247  * @dump_station: dump station callback -- resume dump at index @idx
3248  *
3249  * @add_mpath: add a fixed mesh path
3250  * @del_mpath: delete a given mesh path
3251  * @change_mpath: change a given mesh path
3252  * @get_mpath: get a mesh path for the given parameters
3253  * @dump_mpath: dump mesh path callback -- resume dump at index @idx
3254  * @get_mpp: get a mesh proxy path for the given parameters
3255  * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
3256  * @join_mesh: join the mesh network with the specified parameters
3257  *	(invoked with the wireless_dev mutex held)
3258  * @leave_mesh: leave the current mesh network
3259  *	(invoked with the wireless_dev mutex held)
3260  *
3261  * @get_mesh_config: Get the current mesh configuration
3262  *
3263  * @update_mesh_config: Update mesh parameters on a running mesh.
3264  *	The mask is a bitfield which tells us which parameters to
3265  *	set, and which to leave alone.
3266  *
3267  * @change_bss: Modify parameters for a given BSS.
3268  *
3269  * @set_txq_params: Set TX queue parameters
3270  *
3271  * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
3272  *	as it doesn't implement join_mesh and needs to set the channel to
3273  *	join the mesh instead.
3274  *
3275  * @set_monitor_channel: Set the monitor mode channel for the device. If other
3276  *	interfaces are active this callback should reject the configuration.
3277  *	If no interfaces are active or the device is down, the channel should
3278  *	be stored for when a monitor interface becomes active.
3279  *
3280  * @scan: Request to do a scan. If returning zero, the scan request is given
3281  *	the driver, and will be valid until passed to cfg80211_scan_done().
3282  *	For scan results, call cfg80211_inform_bss(); you can call this outside
3283  *	the scan/scan_done bracket too.
3284  * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
3285  *	indicate the status of the scan through cfg80211_scan_done().
3286  *
3287  * @auth: Request to authenticate with the specified peer
3288  *	(invoked with the wireless_dev mutex held)
3289  * @assoc: Request to (re)associate with the specified peer
3290  *	(invoked with the wireless_dev mutex held)
3291  * @deauth: Request to deauthenticate from the specified peer
3292  *	(invoked with the wireless_dev mutex held)
3293  * @disassoc: Request to disassociate from the specified peer
3294  *	(invoked with the wireless_dev mutex held)
3295  *
3296  * @connect: Connect to the ESS with the specified parameters. When connected,
3297  *	call cfg80211_connect_result()/cfg80211_connect_bss() with status code
3298  *	%WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
3299  *	cfg80211_connect_result()/cfg80211_connect_bss() with the status code
3300  *	from the AP or cfg80211_connect_timeout() if no frame with status code
3301  *	was received.
3302  *	The driver is allowed to roam to other BSSes within the ESS when the
3303  *	other BSS matches the connect parameters. When such roaming is initiated
3304  *	by the driver, the driver is expected to verify that the target matches
3305  *	the configured security parameters and to use Reassociation Request
3306  *	frame instead of Association Request frame.
3307  *	The connect function can also be used to request the driver to perform a
3308  *	specific roam when connected to an ESS. In that case, the prev_bssid
3309  *	parameter is set to the BSSID of the currently associated BSS as an
3310  *	indication of requesting reassociation.
3311  *	In both the driver-initiated and new connect() call initiated roaming
3312  *	cases, the result of roaming is indicated with a call to
3313  *	cfg80211_roamed(). (invoked with the wireless_dev mutex held)
3314  * @update_connect_params: Update the connect parameters while connected to a
3315  *	BSS. The updated parameters can be used by driver/firmware for
3316  *	subsequent BSS selection (roaming) decisions and to form the
3317  *	Authentication/(Re)Association Request frames. This call does not
3318  *	request an immediate disassociation or reassociation with the current
3319  *	BSS, i.e., this impacts only subsequent (re)associations. The bits in
3320  *	changed are defined in &enum cfg80211_connect_params_changed.
3321  *	(invoked with the wireless_dev mutex held)
3322  * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
3323  *      connection is in progress. Once done, call cfg80211_disconnected() in
3324  *      case connection was already established (invoked with the
3325  *      wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
3326  *
3327  * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
3328  *	cfg80211_ibss_joined(), also call that function when changing BSSID due
3329  *	to a merge.
3330  *	(invoked with the wireless_dev mutex held)
3331  * @leave_ibss: Leave the IBSS.
3332  *	(invoked with the wireless_dev mutex held)
3333  *
3334  * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
3335  *	MESH mode)
3336  *
3337  * @set_wiphy_params: Notify that wiphy parameters have changed;
3338  *	@changed bitfield (see &enum wiphy_params_flags) describes which values
3339  *	have changed. The actual parameter values are available in
3340  *	struct wiphy. If returning an error, no value should be changed.
3341  *
3342  * @set_tx_power: set the transmit power according to the parameters,
3343  *	the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
3344  *	wdev may be %NULL if power was set for the wiphy, and will
3345  *	always be %NULL unless the driver supports per-vif TX power
3346  *	(as advertised by the nl80211 feature flag.)
3347  * @get_tx_power: store the current TX power into the dbm variable;
3348  *	return 0 if successful
3349  *
3350  * @set_wds_peer: set the WDS peer for a WDS interface
3351  *
3352  * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
3353  *	functions to adjust rfkill hw state
3354  *
3355  * @dump_survey: get site survey information.
3356  *
3357  * @remain_on_channel: Request the driver to remain awake on the specified
3358  *	channel for the specified duration to complete an off-channel
3359  *	operation (e.g., public action frame exchange). When the driver is
3360  *	ready on the requested channel, it must indicate this with an event
3361  *	notification by calling cfg80211_ready_on_channel().
3362  * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
3363  *	This allows the operation to be terminated prior to timeout based on
3364  *	the duration value.
3365  * @mgmt_tx: Transmit a management frame.
3366  * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
3367  *	frame on another channel
3368  *
3369  * @testmode_cmd: run a test mode command; @wdev may be %NULL
3370  * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
3371  *	used by the function, but 0 and 1 must not be touched. Additionally,
3372  *	return error codes other than -ENOBUFS and -ENOENT will terminate the
3373  *	dump and return to userspace with an error, so be careful. If any data
3374  *	was passed in from userspace then the data/len arguments will be present
3375  *	and point to the data contained in %NL80211_ATTR_TESTDATA.
3376  *
3377  * @set_bitrate_mask: set the bitrate mask configuration
3378  *
3379  * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
3380  *	devices running firmwares capable of generating the (re) association
3381  *	RSN IE. It allows for faster roaming between WPA2 BSSIDs.
3382  * @del_pmksa: Delete a cached PMKID.
3383  * @flush_pmksa: Flush all cached PMKIDs.
3384  * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
3385  *	allows the driver to adjust the dynamic ps timeout value.
3386  * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
3387  *	After configuration, the driver should (soon) send an event indicating
3388  *	the current level is above/below the configured threshold; this may
3389  *	need some care when the configuration is changed (without first being
3390  *	disabled.)
3391  * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
3392  *	connection quality monitor.  An event is to be sent only when the
3393  *	signal level is found to be outside the two values.  The driver should
3394  *	set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
3395  *	If it is provided then there's no point providing @set_cqm_rssi_config.
3396  * @set_cqm_txe_config: Configure connection quality monitor TX error
3397  *	thresholds.
3398  * @sched_scan_start: Tell the driver to start a scheduled scan.
3399  * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
3400  *	given request id. This call must stop the scheduled scan and be ready
3401  *	for starting a new one before it returns, i.e. @sched_scan_start may be
3402  *	called immediately after that again and should not fail in that case.
3403  *	The driver should not call cfg80211_sched_scan_stopped() for a requested
3404  *	stop (when this method returns 0).
3405  *
3406  * @mgmt_frame_register: Notify driver that a management frame type was
3407  *	registered. The callback is allowed to sleep.
3408  *
3409  * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3410  *	Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3411  *	reject TX/RX mask combinations they cannot support by returning -EINVAL
3412  *	(also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3413  *
3414  * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3415  *
3416  * @tdls_mgmt: Transmit a TDLS management frame.
3417  * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
3418  *
3419  * @probe_client: probe an associated client, must return a cookie that it
3420  *	later passes to cfg80211_probe_status().
3421  *
3422  * @set_noack_map: Set the NoAck Map for the TIDs.
3423  *
3424  * @get_channel: Get the current operating channel for the virtual interface.
3425  *	For monitor interfaces, it should return %NULL unless there's a single
3426  *	current monitoring channel.
3427  *
3428  * @start_p2p_device: Start the given P2P device.
3429  * @stop_p2p_device: Stop the given P2P device.
3430  *
3431  * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
3432  *	Parameters include ACL policy, an array of MAC address of stations
3433  *	and the number of MAC addresses. If there is already a list in driver
3434  *	this new list replaces the existing one. Driver has to clear its ACL
3435  *	when number of MAC addresses entries is passed as 0. Drivers which
3436  *	advertise the support for MAC based ACL have to implement this callback.
3437  *
3438  * @start_radar_detection: Start radar detection in the driver.
3439  *
3440  * @update_ft_ies: Provide updated Fast BSS Transition information to the
3441  *	driver. If the SME is in the driver/firmware, this information can be
3442  *	used in building Authentication and Reassociation Request frames.
3443  *
3444  * @crit_proto_start: Indicates a critical protocol needs more link reliability
3445  *	for a given duration (milliseconds). The protocol is provided so the
3446  *	driver can take the most appropriate actions.
3447  * @crit_proto_stop: Indicates critical protocol no longer needs increased link
3448  *	reliability. This operation can not fail.
3449  * @set_coalesce: Set coalesce parameters.
3450  *
3451  * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
3452  *	responsible for veryfing if the switch is possible. Since this is
3453  *	inherently tricky driver may decide to disconnect an interface later
3454  *	with cfg80211_stop_iface(). This doesn't mean driver can accept
3455  *	everything. It should do it's best to verify requests and reject them
3456  *	as soon as possible.
3457  *
3458  * @set_qos_map: Set QoS mapping information to the driver
3459  *
3460  * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
3461  *	given interface This is used e.g. for dynamic HT 20/40 MHz channel width
3462  *	changes during the lifetime of the BSS.
3463  *
3464  * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
3465  *	with the given parameters; action frame exchange has been handled by
3466  *	userspace so this just has to modify the TX path to take the TS into
3467  *	account.
3468  *	If the admitted time is 0 just validate the parameters to make sure
3469  *	the session can be created at all; it is valid to just always return
3470  *	success for that but that may result in inefficient behaviour (handshake
3471  *	with the peer followed by immediate teardown when the addition is later
3472  *	rejected)
3473  * @del_tx_ts: remove an existing TX TS
3474  *
3475  * @join_ocb: join the OCB network with the specified parameters
3476  *	(invoked with the wireless_dev mutex held)
3477  * @leave_ocb: leave the current OCB network
3478  *	(invoked with the wireless_dev mutex held)
3479  *
3480  * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3481  *	is responsible for continually initiating channel-switching operations
3482  *	and returning to the base channel for communication with the AP.
3483  * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3484  *	peers must be on the base channel when the call completes.
3485  * @start_nan: Start the NAN interface.
3486  * @stop_nan: Stop the NAN interface.
3487  * @add_nan_func: Add a NAN function. Returns negative value on failure.
3488  *	On success @nan_func ownership is transferred to the driver and
3489  *	it may access it outside of the scope of this function. The driver
3490  *	should free the @nan_func when no longer needed by calling
3491  *	cfg80211_free_nan_func().
3492  *	On success the driver should assign an instance_id in the
3493  *	provided @nan_func.
3494  * @del_nan_func: Delete a NAN function.
3495  * @nan_change_conf: changes NAN configuration. The changed parameters must
3496  *	be specified in @changes (using &enum cfg80211_nan_conf_changes);
3497  *	All other parameters must be ignored.
3498  *
3499  * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
3500  *
3501  * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
3502  *      function should return phy stats, and interface stats otherwise.
3503  *
3504  * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
3505  *	If not deleted through @del_pmk the PMK remains valid until disconnect
3506  *	upon which the driver should clear it.
3507  *	(invoked with the wireless_dev mutex held)
3508  * @del_pmk: delete the previously configured PMK for the given authenticator.
3509  *	(invoked with the wireless_dev mutex held)
3510  *
3511  * @external_auth: indicates result of offloaded authentication processing from
3512  *     user space
3513  *
3514  * @tx_control_port: TX a control port frame (EAPoL).  The noencrypt parameter
3515  *	tells the driver that the frame should not be encrypted.
3516  *
3517  * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3518  *	Statistics should be cumulative, currently no way to reset is provided.
3519  * @start_pmsr: start peer measurement (e.g. FTM)
3520  * @abort_pmsr: abort peer measurement
3521  *
3522  * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
3523  *	but offloading OWE processing to the user space will get the updated
3524  *	DH IE through this interface.
3525  *
3526  * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
3527  *	and overrule HWMP path selection algorithm.
3528  */
3529 struct cfg80211_ops {
3530 	int	(*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
3531 	int	(*resume)(struct wiphy *wiphy);
3532 	void	(*set_wakeup)(struct wiphy *wiphy, bool enabled);
3533 
3534 	struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
3535 						  const char *name,
3536 						  unsigned char name_assign_type,
3537 						  enum nl80211_iftype type,
3538 						  struct vif_params *params);
3539 	int	(*del_virtual_intf)(struct wiphy *wiphy,
3540 				    struct wireless_dev *wdev);
3541 	int	(*change_virtual_intf)(struct wiphy *wiphy,
3542 				       struct net_device *dev,
3543 				       enum nl80211_iftype type,
3544 				       struct vif_params *params);
3545 
3546 	int	(*add_key)(struct wiphy *wiphy, struct net_device *netdev,
3547 			   u8 key_index, bool pairwise, const u8 *mac_addr,
3548 			   struct key_params *params);
3549 	int	(*get_key)(struct wiphy *wiphy, struct net_device *netdev,
3550 			   u8 key_index, bool pairwise, const u8 *mac_addr,
3551 			   void *cookie,
3552 			   void (*callback)(void *cookie, struct key_params*));
3553 	int	(*del_key)(struct wiphy *wiphy, struct net_device *netdev,
3554 			   u8 key_index, bool pairwise, const u8 *mac_addr);
3555 	int	(*set_default_key)(struct wiphy *wiphy,
3556 				   struct net_device *netdev,
3557 				   u8 key_index, bool unicast, bool multicast);
3558 	int	(*set_default_mgmt_key)(struct wiphy *wiphy,
3559 					struct net_device *netdev,
3560 					u8 key_index);
3561 
3562 	int	(*start_ap)(struct wiphy *wiphy, struct net_device *dev,
3563 			    struct cfg80211_ap_settings *settings);
3564 	int	(*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
3565 				 struct cfg80211_beacon_data *info);
3566 	int	(*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
3567 
3568 
3569 	int	(*add_station)(struct wiphy *wiphy, struct net_device *dev,
3570 			       const u8 *mac,
3571 			       struct station_parameters *params);
3572 	int	(*del_station)(struct wiphy *wiphy, struct net_device *dev,
3573 			       struct station_del_parameters *params);
3574 	int	(*change_station)(struct wiphy *wiphy, struct net_device *dev,
3575 				  const u8 *mac,
3576 				  struct station_parameters *params);
3577 	int	(*get_station)(struct wiphy *wiphy, struct net_device *dev,
3578 			       const u8 *mac, struct station_info *sinfo);
3579 	int	(*dump_station)(struct wiphy *wiphy, struct net_device *dev,
3580 				int idx, u8 *mac, struct station_info *sinfo);
3581 
3582 	int	(*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
3583 			       const u8 *dst, const u8 *next_hop);
3584 	int	(*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
3585 			       const u8 *dst);
3586 	int	(*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
3587 				  const u8 *dst, const u8 *next_hop);
3588 	int	(*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
3589 			     u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
3590 	int	(*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
3591 			      int idx, u8 *dst, u8 *next_hop,
3592 			      struct mpath_info *pinfo);
3593 	int	(*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
3594 			   u8 *dst, u8 *mpp, struct mpath_info *pinfo);
3595 	int	(*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
3596 			    int idx, u8 *dst, u8 *mpp,
3597 			    struct mpath_info *pinfo);
3598 	int	(*get_mesh_config)(struct wiphy *wiphy,
3599 				struct net_device *dev,
3600 				struct mesh_config *conf);
3601 	int	(*update_mesh_config)(struct wiphy *wiphy,
3602 				      struct net_device *dev, u32 mask,
3603 				      const struct mesh_config *nconf);
3604 	int	(*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
3605 			     const struct mesh_config *conf,
3606 			     const struct mesh_setup *setup);
3607 	int	(*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
3608 
3609 	int	(*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
3610 			    struct ocb_setup *setup);
3611 	int	(*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
3612 
3613 	int	(*change_bss)(struct wiphy *wiphy, struct net_device *dev,
3614 			      struct bss_parameters *params);
3615 
3616 	int	(*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
3617 				  struct ieee80211_txq_params *params);
3618 
3619 	int	(*libertas_set_mesh_channel)(struct wiphy *wiphy,
3620 					     struct net_device *dev,
3621 					     struct ieee80211_channel *chan);
3622 
3623 	int	(*set_monitor_channel)(struct wiphy *wiphy,
3624 				       struct cfg80211_chan_def *chandef);
3625 
3626 	int	(*scan)(struct wiphy *wiphy,
3627 			struct cfg80211_scan_request *request);
3628 	void	(*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3629 
3630 	int	(*auth)(struct wiphy *wiphy, struct net_device *dev,
3631 			struct cfg80211_auth_request *req);
3632 	int	(*assoc)(struct wiphy *wiphy, struct net_device *dev,
3633 			 struct cfg80211_assoc_request *req);
3634 	int	(*deauth)(struct wiphy *wiphy, struct net_device *dev,
3635 			  struct cfg80211_deauth_request *req);
3636 	int	(*disassoc)(struct wiphy *wiphy, struct net_device *dev,
3637 			    struct cfg80211_disassoc_request *req);
3638 
3639 	int	(*connect)(struct wiphy *wiphy, struct net_device *dev,
3640 			   struct cfg80211_connect_params *sme);
3641 	int	(*update_connect_params)(struct wiphy *wiphy,
3642 					 struct net_device *dev,
3643 					 struct cfg80211_connect_params *sme,
3644 					 u32 changed);
3645 	int	(*disconnect)(struct wiphy *wiphy, struct net_device *dev,
3646 			      u16 reason_code);
3647 
3648 	int	(*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
3649 			     struct cfg80211_ibss_params *params);
3650 	int	(*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
3651 
3652 	int	(*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
3653 				  int rate[NUM_NL80211_BANDS]);
3654 
3655 	int	(*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
3656 
3657 	int	(*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3658 				enum nl80211_tx_power_setting type, int mbm);
3659 	int	(*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3660 				int *dbm);
3661 
3662 	int	(*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
3663 				const u8 *addr);
3664 
3665 	void	(*rfkill_poll)(struct wiphy *wiphy);
3666 
3667 #ifdef CONFIG_NL80211_TESTMODE
3668 	int	(*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
3669 				void *data, int len);
3670 	int	(*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
3671 				 struct netlink_callback *cb,
3672 				 void *data, int len);
3673 #endif
3674 
3675 	int	(*set_bitrate_mask)(struct wiphy *wiphy,
3676 				    struct net_device *dev,
3677 				    const u8 *peer,
3678 				    const struct cfg80211_bitrate_mask *mask);
3679 
3680 	int	(*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
3681 			int idx, struct survey_info *info);
3682 
3683 	int	(*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3684 			     struct cfg80211_pmksa *pmksa);
3685 	int	(*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3686 			     struct cfg80211_pmksa *pmksa);
3687 	int	(*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
3688 
3689 	int	(*remain_on_channel)(struct wiphy *wiphy,
3690 				     struct wireless_dev *wdev,
3691 				     struct ieee80211_channel *chan,
3692 				     unsigned int duration,
3693 				     u64 *cookie);
3694 	int	(*cancel_remain_on_channel)(struct wiphy *wiphy,
3695 					    struct wireless_dev *wdev,
3696 					    u64 cookie);
3697 
3698 	int	(*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
3699 			   struct cfg80211_mgmt_tx_params *params,
3700 			   u64 *cookie);
3701 	int	(*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
3702 				       struct wireless_dev *wdev,
3703 				       u64 cookie);
3704 
3705 	int	(*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3706 				  bool enabled, int timeout);
3707 
3708 	int	(*set_cqm_rssi_config)(struct wiphy *wiphy,
3709 				       struct net_device *dev,
3710 				       s32 rssi_thold, u32 rssi_hyst);
3711 
3712 	int	(*set_cqm_rssi_range_config)(struct wiphy *wiphy,
3713 					     struct net_device *dev,
3714 					     s32 rssi_low, s32 rssi_high);
3715 
3716 	int	(*set_cqm_txe_config)(struct wiphy *wiphy,
3717 				      struct net_device *dev,
3718 				      u32 rate, u32 pkts, u32 intvl);
3719 
3720 	void	(*mgmt_frame_register)(struct wiphy *wiphy,
3721 				       struct wireless_dev *wdev,
3722 				       u16 frame_type, bool reg);
3723 
3724 	int	(*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
3725 	int	(*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
3726 
3727 	int	(*sched_scan_start)(struct wiphy *wiphy,
3728 				struct net_device *dev,
3729 				struct cfg80211_sched_scan_request *request);
3730 	int	(*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
3731 				   u64 reqid);
3732 
3733 	int	(*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
3734 				  struct cfg80211_gtk_rekey_data *data);
3735 
3736 	int	(*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3737 			     const u8 *peer, u8 action_code,  u8 dialog_token,
3738 			     u16 status_code, u32 peer_capability,
3739 			     bool initiator, const u8 *buf, size_t len);
3740 	int	(*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
3741 			     const u8 *peer, enum nl80211_tdls_operation oper);
3742 
3743 	int	(*probe_client)(struct wiphy *wiphy, struct net_device *dev,
3744 				const u8 *peer, u64 *cookie);
3745 
3746 	int	(*set_noack_map)(struct wiphy *wiphy,
3747 				  struct net_device *dev,
3748 				  u16 noack_map);
3749 
3750 	int	(*get_channel)(struct wiphy *wiphy,
3751 			       struct wireless_dev *wdev,
3752 			       struct cfg80211_chan_def *chandef);
3753 
3754 	int	(*start_p2p_device)(struct wiphy *wiphy,
3755 				    struct wireless_dev *wdev);
3756 	void	(*stop_p2p_device)(struct wiphy *wiphy,
3757 				   struct wireless_dev *wdev);
3758 
3759 	int	(*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
3760 			       const struct cfg80211_acl_data *params);
3761 
3762 	int	(*start_radar_detection)(struct wiphy *wiphy,
3763 					 struct net_device *dev,
3764 					 struct cfg80211_chan_def *chandef,
3765 					 u32 cac_time_ms);
3766 	int	(*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
3767 				 struct cfg80211_update_ft_ies_params *ftie);
3768 	int	(*crit_proto_start)(struct wiphy *wiphy,
3769 				    struct wireless_dev *wdev,
3770 				    enum nl80211_crit_proto_id protocol,
3771 				    u16 duration);
3772 	void	(*crit_proto_stop)(struct wiphy *wiphy,
3773 				   struct wireless_dev *wdev);
3774 	int	(*set_coalesce)(struct wiphy *wiphy,
3775 				struct cfg80211_coalesce *coalesce);
3776 
3777 	int	(*channel_switch)(struct wiphy *wiphy,
3778 				  struct net_device *dev,
3779 				  struct cfg80211_csa_settings *params);
3780 
3781 	int     (*set_qos_map)(struct wiphy *wiphy,
3782 			       struct net_device *dev,
3783 			       struct cfg80211_qos_map *qos_map);
3784 
3785 	int	(*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
3786 				    struct cfg80211_chan_def *chandef);
3787 
3788 	int	(*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3789 			     u8 tsid, const u8 *peer, u8 user_prio,
3790 			     u16 admitted_time);
3791 	int	(*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3792 			     u8 tsid, const u8 *peer);
3793 
3794 	int	(*tdls_channel_switch)(struct wiphy *wiphy,
3795 				       struct net_device *dev,
3796 				       const u8 *addr, u8 oper_class,
3797 				       struct cfg80211_chan_def *chandef);
3798 	void	(*tdls_cancel_channel_switch)(struct wiphy *wiphy,
3799 					      struct net_device *dev,
3800 					      const u8 *addr);
3801 	int	(*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
3802 			     struct cfg80211_nan_conf *conf);
3803 	void	(*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3804 	int	(*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3805 				struct cfg80211_nan_func *nan_func);
3806 	void	(*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3807 			       u64 cookie);
3808 	int	(*nan_change_conf)(struct wiphy *wiphy,
3809 				   struct wireless_dev *wdev,
3810 				   struct cfg80211_nan_conf *conf,
3811 				   u32 changes);
3812 
3813 	int	(*set_multicast_to_unicast)(struct wiphy *wiphy,
3814 					    struct net_device *dev,
3815 					    const bool enabled);
3816 
3817 	int	(*get_txq_stats)(struct wiphy *wiphy,
3818 				 struct wireless_dev *wdev,
3819 				 struct cfg80211_txq_stats *txqstats);
3820 
3821 	int	(*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
3822 			   const struct cfg80211_pmk_conf *conf);
3823 	int	(*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
3824 			   const u8 *aa);
3825 	int     (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
3826 				 struct cfg80211_external_auth_params *params);
3827 
3828 	int	(*tx_control_port)(struct wiphy *wiphy,
3829 				   struct net_device *dev,
3830 				   const u8 *buf, size_t len,
3831 				   const u8 *dest, const __be16 proto,
3832 				   const bool noencrypt);
3833 
3834 	int	(*get_ftm_responder_stats)(struct wiphy *wiphy,
3835 				struct net_device *dev,
3836 				struct cfg80211_ftm_responder_stats *ftm_stats);
3837 
3838 	int	(*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
3839 			      struct cfg80211_pmsr_request *request);
3840 	void	(*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
3841 			      struct cfg80211_pmsr_request *request);
3842 	int	(*update_owe_info)(struct wiphy *wiphy, struct net_device *dev,
3843 				   struct cfg80211_update_owe_info *owe_info);
3844 	int	(*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev,
3845 				   const u8 *buf, size_t len);
3846 };
3847 
3848 /*
3849  * wireless hardware and networking interfaces structures
3850  * and registration/helper functions
3851  */
3852 
3853 /**
3854  * enum wiphy_flags - wiphy capability flags
3855  *
3856  * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
3857  *	wiphy at all
3858  * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
3859  *	by default -- this flag will be set depending on the kernel's default
3860  *	on wiphy_new(), but can be changed by the driver if it has a good
3861  *	reason to override the default
3862  * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
3863  *	on a VLAN interface). This flag also serves an extra purpose of
3864  *	supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
3865  * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
3866  * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
3867  *	control port protocol ethertype. The device also honours the
3868  *	control_port_no_encrypt flag.
3869  * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
3870  * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
3871  *	auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
3872  * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
3873  *	firmware.
3874  * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
3875  * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
3876  * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
3877  *	link setup/discovery operations internally. Setup, discovery and
3878  *	teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
3879  *	command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
3880  *	used for asking the driver/firmware to perform a TDLS operation.
3881  * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
3882  * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
3883  *	when there are virtual interfaces in AP mode by calling
3884  *	cfg80211_report_obss_beacon().
3885  * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
3886  *	responds to probe-requests in hardware.
3887  * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
3888  * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
3889  * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
3890  * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
3891  *	beaconing mode (AP, IBSS, Mesh, ...).
3892  * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
3893  *	before connection.
3894  */
3895 enum wiphy_flags {
3896 	/* use hole at 0 */
3897 	/* use hole at 1 */
3898 	/* use hole at 2 */
3899 	WIPHY_FLAG_NETNS_OK			= BIT(3),
3900 	WIPHY_FLAG_PS_ON_BY_DEFAULT		= BIT(4),
3901 	WIPHY_FLAG_4ADDR_AP			= BIT(5),
3902 	WIPHY_FLAG_4ADDR_STATION		= BIT(6),
3903 	WIPHY_FLAG_CONTROL_PORT_PROTOCOL	= BIT(7),
3904 	WIPHY_FLAG_IBSS_RSN			= BIT(8),
3905 	WIPHY_FLAG_MESH_AUTH			= BIT(10),
3906 	/* use hole at 11 */
3907 	/* use hole at 12 */
3908 	WIPHY_FLAG_SUPPORTS_FW_ROAM		= BIT(13),
3909 	WIPHY_FLAG_AP_UAPSD			= BIT(14),
3910 	WIPHY_FLAG_SUPPORTS_TDLS		= BIT(15),
3911 	WIPHY_FLAG_TDLS_EXTERNAL_SETUP		= BIT(16),
3912 	WIPHY_FLAG_HAVE_AP_SME			= BIT(17),
3913 	WIPHY_FLAG_REPORTS_OBSS			= BIT(18),
3914 	WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD	= BIT(19),
3915 	WIPHY_FLAG_OFFCHAN_TX			= BIT(20),
3916 	WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL	= BIT(21),
3917 	WIPHY_FLAG_SUPPORTS_5_10_MHZ		= BIT(22),
3918 	WIPHY_FLAG_HAS_CHANNEL_SWITCH		= BIT(23),
3919 	WIPHY_FLAG_HAS_STATIC_WEP		= BIT(24),
3920 };
3921 
3922 /**
3923  * struct ieee80211_iface_limit - limit on certain interface types
3924  * @max: maximum number of interfaces of these types
3925  * @types: interface types (bits)
3926  */
3927 struct ieee80211_iface_limit {
3928 	u16 max;
3929 	u16 types;
3930 };
3931 
3932 /**
3933  * struct ieee80211_iface_combination - possible interface combination
3934  *
3935  * With this structure the driver can describe which interface
3936  * combinations it supports concurrently.
3937  *
3938  * Examples:
3939  *
3940  * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
3941  *
3942  *    .. code-block:: c
3943  *
3944  *	struct ieee80211_iface_limit limits1[] = {
3945  *		{ .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3946  *		{ .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
3947  *	};
3948  *	struct ieee80211_iface_combination combination1 = {
3949  *		.limits = limits1,
3950  *		.n_limits = ARRAY_SIZE(limits1),
3951  *		.max_interfaces = 2,
3952  *		.beacon_int_infra_match = true,
3953  *	};
3954  *
3955  *
3956  * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
3957  *
3958  *    .. code-block:: c
3959  *
3960  *	struct ieee80211_iface_limit limits2[] = {
3961  *		{ .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
3962  *				     BIT(NL80211_IFTYPE_P2P_GO), },
3963  *	};
3964  *	struct ieee80211_iface_combination combination2 = {
3965  *		.limits = limits2,
3966  *		.n_limits = ARRAY_SIZE(limits2),
3967  *		.max_interfaces = 8,
3968  *		.num_different_channels = 1,
3969  *	};
3970  *
3971  *
3972  * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
3973  *
3974  *    This allows for an infrastructure connection and three P2P connections.
3975  *
3976  *    .. code-block:: c
3977  *
3978  *	struct ieee80211_iface_limit limits3[] = {
3979  *		{ .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3980  *		{ .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
3981  *				     BIT(NL80211_IFTYPE_P2P_CLIENT), },
3982  *	};
3983  *	struct ieee80211_iface_combination combination3 = {
3984  *		.limits = limits3,
3985  *		.n_limits = ARRAY_SIZE(limits3),
3986  *		.max_interfaces = 4,
3987  *		.num_different_channels = 2,
3988  *	};
3989  *
3990  */
3991 struct ieee80211_iface_combination {
3992 	/**
3993 	 * @limits:
3994 	 * limits for the given interface types
3995 	 */
3996 	const struct ieee80211_iface_limit *limits;
3997 
3998 	/**
3999 	 * @num_different_channels:
4000 	 * can use up to this many different channels
4001 	 */
4002 	u32 num_different_channels;
4003 
4004 	/**
4005 	 * @max_interfaces:
4006 	 * maximum number of interfaces in total allowed in this group
4007 	 */
4008 	u16 max_interfaces;
4009 
4010 	/**
4011 	 * @n_limits:
4012 	 * number of limitations
4013 	 */
4014 	u8 n_limits;
4015 
4016 	/**
4017 	 * @beacon_int_infra_match:
4018 	 * In this combination, the beacon intervals between infrastructure
4019 	 * and AP types must match. This is required only in special cases.
4020 	 */
4021 	bool beacon_int_infra_match;
4022 
4023 	/**
4024 	 * @radar_detect_widths:
4025 	 * bitmap of channel widths supported for radar detection
4026 	 */
4027 	u8 radar_detect_widths;
4028 
4029 	/**
4030 	 * @radar_detect_regions:
4031 	 * bitmap of regions supported for radar detection
4032 	 */
4033 	u8 radar_detect_regions;
4034 
4035 	/**
4036 	 * @beacon_int_min_gcd:
4037 	 * This interface combination supports different beacon intervals.
4038 	 *
4039 	 * = 0
4040 	 *   all beacon intervals for different interface must be same.
4041 	 * > 0
4042 	 *   any beacon interval for the interface part of this combination AND
4043 	 *   GCD of all beacon intervals from beaconing interfaces of this
4044 	 *   combination must be greater or equal to this value.
4045 	 */
4046 	u32 beacon_int_min_gcd;
4047 };
4048 
4049 struct ieee80211_txrx_stypes {
4050 	u16 tx, rx;
4051 };
4052 
4053 /**
4054  * enum wiphy_wowlan_support_flags - WoWLAN support flags
4055  * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
4056  *	trigger that keeps the device operating as-is and
4057  *	wakes up the host on any activity, for example a
4058  *	received packet that passed filtering; note that the
4059  *	packet should be preserved in that case
4060  * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
4061  *	(see nl80211.h)
4062  * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
4063  * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
4064  * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
4065  * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
4066  * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
4067  * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
4068  * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
4069  */
4070 enum wiphy_wowlan_support_flags {
4071 	WIPHY_WOWLAN_ANY		= BIT(0),
4072 	WIPHY_WOWLAN_MAGIC_PKT		= BIT(1),
4073 	WIPHY_WOWLAN_DISCONNECT		= BIT(2),
4074 	WIPHY_WOWLAN_SUPPORTS_GTK_REKEY	= BIT(3),
4075 	WIPHY_WOWLAN_GTK_REKEY_FAILURE	= BIT(4),
4076 	WIPHY_WOWLAN_EAP_IDENTITY_REQ	= BIT(5),
4077 	WIPHY_WOWLAN_4WAY_HANDSHAKE	= BIT(6),
4078 	WIPHY_WOWLAN_RFKILL_RELEASE	= BIT(7),
4079 	WIPHY_WOWLAN_NET_DETECT		= BIT(8),
4080 };
4081 
4082 struct wiphy_wowlan_tcp_support {
4083 	const struct nl80211_wowlan_tcp_data_token_feature *tok;
4084 	u32 data_payload_max;
4085 	u32 data_interval_max;
4086 	u32 wake_payload_max;
4087 	bool seq;
4088 };
4089 
4090 /**
4091  * struct wiphy_wowlan_support - WoWLAN support data
4092  * @flags: see &enum wiphy_wowlan_support_flags
4093  * @n_patterns: number of supported wakeup patterns
4094  *	(see nl80211.h for the pattern definition)
4095  * @pattern_max_len: maximum length of each pattern
4096  * @pattern_min_len: minimum length of each pattern
4097  * @max_pkt_offset: maximum Rx packet offset
4098  * @max_nd_match_sets: maximum number of matchsets for net-detect,
4099  *	similar, but not necessarily identical, to max_match_sets for
4100  *	scheduled scans.
4101  *	See &struct cfg80211_sched_scan_request.@match_sets for more
4102  *	details.
4103  * @tcp: TCP wakeup support information
4104  */
4105 struct wiphy_wowlan_support {
4106 	u32 flags;
4107 	int n_patterns;
4108 	int pattern_max_len;
4109 	int pattern_min_len;
4110 	int max_pkt_offset;
4111 	int max_nd_match_sets;
4112 	const struct wiphy_wowlan_tcp_support *tcp;
4113 };
4114 
4115 /**
4116  * struct wiphy_coalesce_support - coalesce support data
4117  * @n_rules: maximum number of coalesce rules
4118  * @max_delay: maximum supported coalescing delay in msecs
4119  * @n_patterns: number of supported patterns in a rule
4120  *	(see nl80211.h for the pattern definition)
4121  * @pattern_max_len: maximum length of each pattern
4122  * @pattern_min_len: minimum length of each pattern
4123  * @max_pkt_offset: maximum Rx packet offset
4124  */
4125 struct wiphy_coalesce_support {
4126 	int n_rules;
4127 	int max_delay;
4128 	int n_patterns;
4129 	int pattern_max_len;
4130 	int pattern_min_len;
4131 	int max_pkt_offset;
4132 };
4133 
4134 /**
4135  * enum wiphy_vendor_command_flags - validation flags for vendor commands
4136  * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4137  * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4138  * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4139  *	(must be combined with %_WDEV or %_NETDEV)
4140  */
4141 enum wiphy_vendor_command_flags {
4142 	WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
4143 	WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
4144 	WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
4145 };
4146 
4147 /**
4148  * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4149  *
4150  * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4151  * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4152  * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4153  *
4154  */
4155 enum wiphy_opmode_flag {
4156 	STA_OPMODE_MAX_BW_CHANGED	= BIT(0),
4157 	STA_OPMODE_SMPS_MODE_CHANGED	= BIT(1),
4158 	STA_OPMODE_N_SS_CHANGED		= BIT(2),
4159 };
4160 
4161 /**
4162  * struct sta_opmode_info - Station's ht/vht operation mode information
4163  * @changed: contains value from &enum wiphy_opmode_flag
4164  * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
4165  * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
4166  * @rx_nss: new rx_nss value of a station
4167  */
4168 
4169 struct sta_opmode_info {
4170 	u32 changed;
4171 	enum nl80211_smps_mode smps_mode;
4172 	enum nl80211_chan_width bw;
4173 	u8 rx_nss;
4174 };
4175 
4176 #define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)ERR_PTR(-ENODATA))
4177 
4178 /**
4179  * struct wiphy_vendor_command - vendor command definition
4180  * @info: vendor command identifying information, as used in nl80211
4181  * @flags: flags, see &enum wiphy_vendor_command_flags
4182  * @doit: callback for the operation, note that wdev is %NULL if the
4183  *	flags didn't ask for a wdev and non-%NULL otherwise; the data
4184  *	pointer may be %NULL if userspace provided no data at all
4185  * @dumpit: dump callback, for transferring bigger/multiple items. The
4186  *	@storage points to cb->args[5], ie. is preserved over the multiple
4187  *	dumpit calls.
4188  * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
4189  *	Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
4190  *	attribute is just raw data (e.g. a firmware command).
4191  * @maxattr: highest attribute number in policy
4192  * It's recommended to not have the same sub command with both @doit and
4193  * @dumpit, so that userspace can assume certain ones are get and others
4194  * are used with dump requests.
4195  */
4196 struct wiphy_vendor_command {
4197 	struct nl80211_vendor_cmd_info info;
4198 	u32 flags;
4199 	int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4200 		    const void *data, int data_len);
4201 	int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4202 		      struct sk_buff *skb, const void *data, int data_len,
4203 		      unsigned long *storage);
4204 	const struct nla_policy *policy;
4205 	unsigned int maxattr;
4206 };
4207 
4208 /**
4209  * struct wiphy_iftype_ext_capab - extended capabilities per interface type
4210  * @iftype: interface type
4211  * @extended_capabilities: extended capabilities supported by the driver,
4212  *	additional capabilities might be supported by userspace; these are the
4213  *	802.11 extended capabilities ("Extended Capabilities element") and are
4214  *	in the same format as in the information element. See IEEE Std
4215  *	802.11-2012 8.4.2.29 for the defined fields.
4216  * @extended_capabilities_mask: mask of the valid values
4217  * @extended_capabilities_len: length of the extended capabilities
4218  */
4219 struct wiphy_iftype_ext_capab {
4220 	enum nl80211_iftype iftype;
4221 	const u8 *extended_capabilities;
4222 	const u8 *extended_capabilities_mask;
4223 	u8 extended_capabilities_len;
4224 };
4225 
4226 /**
4227  * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
4228  * @max_peers: maximum number of peers in a single measurement
4229  * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
4230  * @randomize_mac_addr: can randomize MAC address for measurement
4231  * @ftm.supported: FTM measurement is supported
4232  * @ftm.asap: ASAP-mode is supported
4233  * @ftm.non_asap: non-ASAP-mode is supported
4234  * @ftm.request_lci: can request LCI data
4235  * @ftm.request_civicloc: can request civic location data
4236  * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
4237  * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
4238  * @ftm.max_bursts_exponent: maximum burst exponent supported
4239  *	(set to -1 if not limited; note that setting this will necessarily
4240  *	forbid using the value 15 to let the responder pick)
4241  * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
4242  *	not limited)
4243  */
4244 struct cfg80211_pmsr_capabilities {
4245 	unsigned int max_peers;
4246 	u8 report_ap_tsf:1,
4247 	   randomize_mac_addr:1;
4248 
4249 	struct {
4250 		u32 preambles;
4251 		u32 bandwidths;
4252 		s8 max_bursts_exponent;
4253 		u8 max_ftms_per_burst;
4254 		u8 supported:1,
4255 		   asap:1,
4256 		   non_asap:1,
4257 		   request_lci:1,
4258 		   request_civicloc:1;
4259 	} ftm;
4260 };
4261 
4262 /**
4263  * struct wiphy - wireless hardware description
4264  * @reg_notifier: the driver's regulatory notification callback,
4265  *	note that if your driver uses wiphy_apply_custom_regulatory()
4266  *	the reg_notifier's request can be passed as NULL
4267  * @regd: the driver's regulatory domain, if one was requested via
4268  * 	the regulatory_hint() API. This can be used by the driver
4269  *	on the reg_notifier() if it chooses to ignore future
4270  *	regulatory domain changes caused by other drivers.
4271  * @signal_type: signal type reported in &struct cfg80211_bss.
4272  * @cipher_suites: supported cipher suites
4273  * @n_cipher_suites: number of supported cipher suites
4274  * @akm_suites: supported AKM suites
4275  * @n_akm_suites: number of supported AKM suites
4276  * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
4277  * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
4278  * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
4279  *	-1 = fragmentation disabled, only odd values >= 256 used
4280  * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
4281  * @_net: the network namespace this wiphy currently lives in
4282  * @perm_addr: permanent MAC address of this device
4283  * @addr_mask: If the device supports multiple MAC addresses by masking,
4284  *	set this to a mask with variable bits set to 1, e.g. if the last
4285  *	four bits are variable then set it to 00-00-00-00-00-0f. The actual
4286  *	variable bits shall be determined by the interfaces added, with
4287  *	interfaces not matching the mask being rejected to be brought up.
4288  * @n_addresses: number of addresses in @addresses.
4289  * @addresses: If the device has more than one address, set this pointer
4290  *	to a list of addresses (6 bytes each). The first one will be used
4291  *	by default for perm_addr. In this case, the mask should be set to
4292  *	all-zeroes. In this case it is assumed that the device can handle
4293  *	the same number of arbitrary MAC addresses.
4294  * @registered: protects ->resume and ->suspend sysfs callbacks against
4295  *	unregister hardware
4296  * @debugfsdir: debugfs directory used for this wiphy, will be renamed
4297  *	automatically on wiphy renames
4298  * @dev: (virtual) struct device for this wiphy
4299  * @registered: helps synchronize suspend/resume with wiphy unregister
4300  * @wext: wireless extension handlers
4301  * @priv: driver private data (sized according to wiphy_new() parameter)
4302  * @interface_modes: bitmask of interfaces types valid for this wiphy,
4303  *	must be set by driver
4304  * @iface_combinations: Valid interface combinations array, should not
4305  *	list single interface types.
4306  * @n_iface_combinations: number of entries in @iface_combinations array.
4307  * @software_iftypes: bitmask of software interface types, these are not
4308  *	subject to any restrictions since they are purely managed in SW.
4309  * @flags: wiphy flags, see &enum wiphy_flags
4310  * @regulatory_flags: wiphy regulatory flags, see
4311  *	&enum ieee80211_regulatory_flags
4312  * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
4313  * @ext_features: extended features advertised to nl80211, see
4314  *	&enum nl80211_ext_feature_index.
4315  * @bss_priv_size: each BSS struct has private data allocated with it,
4316  *	this variable determines its size
4317  * @max_scan_ssids: maximum number of SSIDs the device can scan for in
4318  *	any given scan
4319  * @max_sched_scan_reqs: maximum number of scheduled scan requests that
4320  *	the device can run concurrently.
4321  * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
4322  *	for in any given scheduled scan
4323  * @max_match_sets: maximum number of match sets the device can handle
4324  *	when performing a scheduled scan, 0 if filtering is not
4325  *	supported.
4326  * @max_scan_ie_len: maximum length of user-controlled IEs device can
4327  *	add to probe request frames transmitted during a scan, must not
4328  *	include fixed IEs like supported rates
4329  * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
4330  *	scans
4331  * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
4332  *	of iterations) for scheduled scan supported by the device.
4333  * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
4334  *	single scan plan supported by the device.
4335  * @max_sched_scan_plan_iterations: maximum number of iterations for a single
4336  *	scan plan supported by the device.
4337  * @coverage_class: current coverage class
4338  * @fw_version: firmware version for ethtool reporting
4339  * @hw_version: hardware version for ethtool reporting
4340  * @max_num_pmkids: maximum number of PMKIDs supported by device
4341  * @privid: a pointer that drivers can use to identify if an arbitrary
4342  *	wiphy is theirs, e.g. in global notifiers
4343  * @bands: information about bands/channels supported by this device
4344  *
4345  * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
4346  *	transmitted through nl80211, points to an array indexed by interface
4347  *	type
4348  *
4349  * @available_antennas_tx: bitmap of antennas which are available to be
4350  *	configured as TX antennas. Antenna configuration commands will be
4351  *	rejected unless this or @available_antennas_rx is set.
4352  *
4353  * @available_antennas_rx: bitmap of antennas which are available to be
4354  *	configured as RX antennas. Antenna configuration commands will be
4355  *	rejected unless this or @available_antennas_tx is set.
4356  *
4357  * @probe_resp_offload:
4358  *	 Bitmap of supported protocols for probe response offloading.
4359  *	 See &enum nl80211_probe_resp_offload_support_attr. Only valid
4360  *	 when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4361  *
4362  * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
4363  *	may request, if implemented.
4364  *
4365  * @wowlan: WoWLAN support information
4366  * @wowlan_config: current WoWLAN configuration; this should usually not be
4367  *	used since access to it is necessarily racy, use the parameter passed
4368  *	to the suspend() operation instead.
4369  *
4370  * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
4371  * @ht_capa_mod_mask:  Specify what ht_cap values can be over-ridden.
4372  *	If null, then none can be over-ridden.
4373  * @vht_capa_mod_mask:  Specify what VHT capabilities can be over-ridden.
4374  *	If null, then none can be over-ridden.
4375  *
4376  * @wdev_list: the list of associated (virtual) interfaces; this list must
4377  *	not be modified by the driver, but can be read with RTNL/RCU protection.
4378  *
4379  * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
4380  *	supports for ACL.
4381  *
4382  * @extended_capabilities: extended capabilities supported by the driver,
4383  *	additional capabilities might be supported by userspace; these are
4384  *	the 802.11 extended capabilities ("Extended Capabilities element")
4385  *	and are in the same format as in the information element. See
4386  *	802.11-2012 8.4.2.29 for the defined fields. These are the default
4387  *	extended capabilities to be used if the capabilities are not specified
4388  *	for a specific interface type in iftype_ext_capab.
4389  * @extended_capabilities_mask: mask of the valid values
4390  * @extended_capabilities_len: length of the extended capabilities
4391  * @iftype_ext_capab: array of extended capabilities per interface type
4392  * @num_iftype_ext_capab: number of interface types for which extended
4393  *	capabilities are specified separately.
4394  * @coalesce: packet coalescing support information
4395  *
4396  * @vendor_commands: array of vendor commands supported by the hardware
4397  * @n_vendor_commands: number of vendor commands
4398  * @vendor_events: array of vendor events supported by the hardware
4399  * @n_vendor_events: number of vendor events
4400  *
4401  * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
4402  *	(including P2P GO) or 0 to indicate no such limit is advertised. The
4403  *	driver is allowed to advertise a theoretical limit that it can reach in
4404  *	some cases, but may not always reach.
4405  *
4406  * @max_num_csa_counters: Number of supported csa_counters in beacons
4407  *	and probe responses.  This value should be set if the driver
4408  *	wishes to limit the number of csa counters. Default (0) means
4409  *	infinite.
4410  * @max_adj_channel_rssi_comp: max offset of between the channel on which the
4411  *	frame was sent and the channel on which the frame was heard for which
4412  *	the reported rssi is still valid. If a driver is able to compensate the
4413  *	low rssi when a frame is heard on different channel, then it should set
4414  *	this variable to the maximal offset for which it can compensate.
4415  *	This value should be set in MHz.
4416  * @bss_select_support: bitmask indicating the BSS selection criteria supported
4417  *	by the driver in the .connect() callback. The bit position maps to the
4418  *	attribute indices defined in &enum nl80211_bss_select_attr.
4419  *
4420  * @nan_supported_bands: bands supported by the device in NAN mode, a
4421  *	bitmap of &enum nl80211_band values.  For instance, for
4422  *	NL80211_BAND_2GHZ, bit 0 would be set
4423  *	(i.e. BIT(NL80211_BAND_2GHZ)).
4424  *
4425  * @txq_limit: configuration of internal TX queue frame limit
4426  * @txq_memory_limit: configuration internal TX queue memory limit
4427  * @txq_quantum: configuration of internal TX queue scheduler quantum
4428  *
4429  * @support_mbssid: can HW support association with nontransmitted AP
4430  * @support_only_he_mbssid: don't parse MBSSID elements if it is not
4431  *	HE AP, in order to avoid compatibility issues.
4432  *	@support_mbssid must be set for this to have any effect.
4433  *
4434  * @pmsr_capa: peer measurement capabilities
4435  */
4436 struct wiphy {
4437 	/* assign these fields before you register the wiphy */
4438 
4439 	/* permanent MAC address(es) */
4440 	u8 perm_addr[ETH_ALEN];
4441 	u8 addr_mask[ETH_ALEN];
4442 
4443 	struct mac_address *addresses;
4444 
4445 	const struct ieee80211_txrx_stypes *mgmt_stypes;
4446 
4447 	const struct ieee80211_iface_combination *iface_combinations;
4448 	int n_iface_combinations;
4449 	u16 software_iftypes;
4450 
4451 	u16 n_addresses;
4452 
4453 	/* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
4454 	u16 interface_modes;
4455 
4456 	u16 max_acl_mac_addrs;
4457 
4458 	u32 flags, regulatory_flags, features;
4459 	u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
4460 
4461 	u32 ap_sme_capa;
4462 
4463 	enum cfg80211_signal_type signal_type;
4464 
4465 	int bss_priv_size;
4466 	u8 max_scan_ssids;
4467 	u8 max_sched_scan_reqs;
4468 	u8 max_sched_scan_ssids;
4469 	u8 max_match_sets;
4470 	u16 max_scan_ie_len;
4471 	u16 max_sched_scan_ie_len;
4472 	u32 max_sched_scan_plans;
4473 	u32 max_sched_scan_plan_interval;
4474 	u32 max_sched_scan_plan_iterations;
4475 
4476 	int n_cipher_suites;
4477 	const u32 *cipher_suites;
4478 
4479 	int n_akm_suites;
4480 	const u32 *akm_suites;
4481 
4482 	u8 retry_short;
4483 	u8 retry_long;
4484 	u32 frag_threshold;
4485 	u32 rts_threshold;
4486 	u8 coverage_class;
4487 
4488 	char fw_version[ETHTOOL_FWVERS_LEN];
4489 	u32 hw_version;
4490 
4491 #ifdef CONFIG_PM
4492 	const struct wiphy_wowlan_support *wowlan;
4493 	struct cfg80211_wowlan *wowlan_config;
4494 #endif
4495 
4496 	u16 max_remain_on_channel_duration;
4497 
4498 	u8 max_num_pmkids;
4499 
4500 	u32 available_antennas_tx;
4501 	u32 available_antennas_rx;
4502 
4503 	/*
4504 	 * Bitmap of supported protocols for probe response offloading
4505 	 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
4506 	 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4507 	 */
4508 	u32 probe_resp_offload;
4509 
4510 	const u8 *extended_capabilities, *extended_capabilities_mask;
4511 	u8 extended_capabilities_len;
4512 
4513 	const struct wiphy_iftype_ext_capab *iftype_ext_capab;
4514 	unsigned int num_iftype_ext_capab;
4515 
4516 	/* If multiple wiphys are registered and you're handed e.g.
4517 	 * a regular netdev with assigned ieee80211_ptr, you won't
4518 	 * know whether it points to a wiphy your driver has registered
4519 	 * or not. Assign this to something global to your driver to
4520 	 * help determine whether you own this wiphy or not. */
4521 	const void *privid;
4522 
4523 	struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
4524 
4525 	/* Lets us get back the wiphy on the callback */
4526 	void (*reg_notifier)(struct wiphy *wiphy,
4527 			     struct regulatory_request *request);
4528 
4529 	/* fields below are read-only, assigned by cfg80211 */
4530 
4531 	const struct ieee80211_regdomain __rcu *regd;
4532 
4533 	/* the item in /sys/class/ieee80211/ points to this,
4534 	 * you need use set_wiphy_dev() (see below) */
4535 	struct device dev;
4536 
4537 	/* protects ->resume, ->suspend sysfs callbacks against unregister hw */
4538 	bool registered;
4539 
4540 	/* dir in debugfs: ieee80211/<wiphyname> */
4541 	struct dentry *debugfsdir;
4542 
4543 	const struct ieee80211_ht_cap *ht_capa_mod_mask;
4544 	const struct ieee80211_vht_cap *vht_capa_mod_mask;
4545 
4546 	struct list_head wdev_list;
4547 
4548 	/* the network namespace this phy lives in currently */
4549 	possible_net_t _net;
4550 
4551 #ifdef CONFIG_CFG80211_WEXT
4552 	const struct iw_handler_def *wext;
4553 #endif
4554 
4555 	const struct wiphy_coalesce_support *coalesce;
4556 
4557 	const struct wiphy_vendor_command *vendor_commands;
4558 	const struct nl80211_vendor_cmd_info *vendor_events;
4559 	int n_vendor_commands, n_vendor_events;
4560 
4561 	u16 max_ap_assoc_sta;
4562 
4563 	u8 max_num_csa_counters;
4564 	u8 max_adj_channel_rssi_comp;
4565 
4566 	u32 bss_select_support;
4567 
4568 	u8 nan_supported_bands;
4569 
4570 	u32 txq_limit;
4571 	u32 txq_memory_limit;
4572 	u32 txq_quantum;
4573 
4574 	u8 support_mbssid:1,
4575 	   support_only_he_mbssid:1;
4576 
4577 	const struct cfg80211_pmsr_capabilities *pmsr_capa;
4578 
4579 	char priv[0] __aligned(NETDEV_ALIGN);
4580 };
4581 
4582 static inline struct net *wiphy_net(struct wiphy *wiphy)
4583 {
4584 	return read_pnet(&wiphy->_net);
4585 }
4586 
4587 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
4588 {
4589 	write_pnet(&wiphy->_net, net);
4590 }
4591 
4592 /**
4593  * wiphy_priv - return priv from wiphy
4594  *
4595  * @wiphy: the wiphy whose priv pointer to return
4596  * Return: The priv of @wiphy.
4597  */
4598 static inline void *wiphy_priv(struct wiphy *wiphy)
4599 {
4600 	BUG_ON(!wiphy);
4601 	return &wiphy->priv;
4602 }
4603 
4604 /**
4605  * priv_to_wiphy - return the wiphy containing the priv
4606  *
4607  * @priv: a pointer previously returned by wiphy_priv
4608  * Return: The wiphy of @priv.
4609  */
4610 static inline struct wiphy *priv_to_wiphy(void *priv)
4611 {
4612 	BUG_ON(!priv);
4613 	return container_of(priv, struct wiphy, priv);
4614 }
4615 
4616 /**
4617  * set_wiphy_dev - set device pointer for wiphy
4618  *
4619  * @wiphy: The wiphy whose device to bind
4620  * @dev: The device to parent it to
4621  */
4622 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
4623 {
4624 	wiphy->dev.parent = dev;
4625 }
4626 
4627 /**
4628  * wiphy_dev - get wiphy dev pointer
4629  *
4630  * @wiphy: The wiphy whose device struct to look up
4631  * Return: The dev of @wiphy.
4632  */
4633 static inline struct device *wiphy_dev(struct wiphy *wiphy)
4634 {
4635 	return wiphy->dev.parent;
4636 }
4637 
4638 /**
4639  * wiphy_name - get wiphy name
4640  *
4641  * @wiphy: The wiphy whose name to return
4642  * Return: The name of @wiphy.
4643  */
4644 static inline const char *wiphy_name(const struct wiphy *wiphy)
4645 {
4646 	return dev_name(&wiphy->dev);
4647 }
4648 
4649 /**
4650  * wiphy_new_nm - create a new wiphy for use with cfg80211
4651  *
4652  * @ops: The configuration operations for this device
4653  * @sizeof_priv: The size of the private area to allocate
4654  * @requested_name: Request a particular name.
4655  *	NULL is valid value, and means use the default phy%d naming.
4656  *
4657  * Create a new wiphy and associate the given operations with it.
4658  * @sizeof_priv bytes are allocated for private use.
4659  *
4660  * Return: A pointer to the new wiphy. This pointer must be
4661  * assigned to each netdev's ieee80211_ptr for proper operation.
4662  */
4663 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
4664 			   const char *requested_name);
4665 
4666 /**
4667  * wiphy_new - create a new wiphy for use with cfg80211
4668  *
4669  * @ops: The configuration operations for this device
4670  * @sizeof_priv: The size of the private area to allocate
4671  *
4672  * Create a new wiphy and associate the given operations with it.
4673  * @sizeof_priv bytes are allocated for private use.
4674  *
4675  * Return: A pointer to the new wiphy. This pointer must be
4676  * assigned to each netdev's ieee80211_ptr for proper operation.
4677  */
4678 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
4679 				      int sizeof_priv)
4680 {
4681 	return wiphy_new_nm(ops, sizeof_priv, NULL);
4682 }
4683 
4684 /**
4685  * wiphy_register - register a wiphy with cfg80211
4686  *
4687  * @wiphy: The wiphy to register.
4688  *
4689  * Return: A non-negative wiphy index or a negative error code.
4690  */
4691 int wiphy_register(struct wiphy *wiphy);
4692 
4693 /**
4694  * wiphy_unregister - deregister a wiphy from cfg80211
4695  *
4696  * @wiphy: The wiphy to unregister.
4697  *
4698  * After this call, no more requests can be made with this priv
4699  * pointer, but the call may sleep to wait for an outstanding
4700  * request that is being handled.
4701  */
4702 void wiphy_unregister(struct wiphy *wiphy);
4703 
4704 /**
4705  * wiphy_free - free wiphy
4706  *
4707  * @wiphy: The wiphy to free
4708  */
4709 void wiphy_free(struct wiphy *wiphy);
4710 
4711 /* internal structs */
4712 struct cfg80211_conn;
4713 struct cfg80211_internal_bss;
4714 struct cfg80211_cached_keys;
4715 struct cfg80211_cqm_config;
4716 
4717 /**
4718  * struct wireless_dev - wireless device state
4719  *
4720  * For netdevs, this structure must be allocated by the driver
4721  * that uses the ieee80211_ptr field in struct net_device (this
4722  * is intentional so it can be allocated along with the netdev.)
4723  * It need not be registered then as netdev registration will
4724  * be intercepted by cfg80211 to see the new wireless device.
4725  *
4726  * For non-netdev uses, it must also be allocated by the driver
4727  * in response to the cfg80211 callbacks that require it, as
4728  * there's no netdev registration in that case it may not be
4729  * allocated outside of callback operations that return it.
4730  *
4731  * @wiphy: pointer to hardware description
4732  * @iftype: interface type
4733  * @list: (private) Used to collect the interfaces
4734  * @netdev: (private) Used to reference back to the netdev, may be %NULL
4735  * @identifier: (private) Identifier used in nl80211 to identify this
4736  *	wireless device if it has no netdev
4737  * @current_bss: (private) Used by the internal configuration code
4738  * @chandef: (private) Used by the internal configuration code to track
4739  *	the user-set channel definition.
4740  * @preset_chandef: (private) Used by the internal configuration code to
4741  *	track the channel to be used for AP later
4742  * @bssid: (private) Used by the internal configuration code
4743  * @ssid: (private) Used by the internal configuration code
4744  * @ssid_len: (private) Used by the internal configuration code
4745  * @mesh_id_len: (private) Used by the internal configuration code
4746  * @mesh_id_up_len: (private) Used by the internal configuration code
4747  * @wext: (private) Used by the internal wireless extensions compat code
4748  * @wext.ibss: (private) IBSS data part of wext handling
4749  * @wext.connect: (private) connection handling data
4750  * @wext.keys: (private) (WEP) key data
4751  * @wext.ie: (private) extra elements for association
4752  * @wext.ie_len: (private) length of extra elements
4753  * @wext.bssid: (private) selected network BSSID
4754  * @wext.ssid: (private) selected network SSID
4755  * @wext.default_key: (private) selected default key index
4756  * @wext.default_mgmt_key: (private) selected default management key index
4757  * @wext.prev_bssid: (private) previous BSSID for reassociation
4758  * @wext.prev_bssid_valid: (private) previous BSSID validity
4759  * @use_4addr: indicates 4addr mode is used on this interface, must be
4760  *	set by driver (if supported) on add_interface BEFORE registering the
4761  *	netdev and may otherwise be used by driver read-only, will be update
4762  *	by cfg80211 on change_interface
4763  * @mgmt_registrations: list of registrations for management frames
4764  * @mgmt_registrations_lock: lock for the list
4765  * @mtx: mutex used to lock data in this struct, may be used by drivers
4766  *	and some API functions require it held
4767  * @beacon_interval: beacon interval used on this device for transmitting
4768  *	beacons, 0 when not valid
4769  * @address: The address for this device, valid only if @netdev is %NULL
4770  * @is_running: true if this is a non-netdev device that has been started, e.g.
4771  *	the P2P Device.
4772  * @cac_started: true if DFS channel availability check has been started
4773  * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
4774  * @cac_time_ms: CAC time in ms
4775  * @ps: powersave mode is enabled
4776  * @ps_timeout: dynamic powersave timeout
4777  * @ap_unexpected_nlportid: (private) netlink port ID of application
4778  *	registered for unexpected class 3 frames (AP mode)
4779  * @conn: (private) cfg80211 software SME connection state machine data
4780  * @connect_keys: (private) keys to set after connection is established
4781  * @conn_bss_type: connecting/connected BSS type
4782  * @conn_owner_nlportid: (private) connection owner socket port ID
4783  * @disconnect_wk: (private) auto-disconnect work
4784  * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
4785  * @ibss_fixed: (private) IBSS is using fixed BSSID
4786  * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
4787  * @event_list: (private) list for internal event processing
4788  * @event_lock: (private) lock for event list
4789  * @owner_nlportid: (private) owner socket port ID
4790  * @nl_owner_dead: (private) owner socket went away
4791  * @cqm_config: (private) nl80211 RSSI monitor state
4792  * @pmsr_list: (private) peer measurement requests
4793  * @pmsr_lock: (private) peer measurements requests/results lock
4794  * @pmsr_free_wk: (private) peer measurements cleanup work
4795  */
4796 struct wireless_dev {
4797 	struct wiphy *wiphy;
4798 	enum nl80211_iftype iftype;
4799 
4800 	/* the remainder of this struct should be private to cfg80211 */
4801 	struct list_head list;
4802 	struct net_device *netdev;
4803 
4804 	u32 identifier;
4805 
4806 	struct list_head mgmt_registrations;
4807 	spinlock_t mgmt_registrations_lock;
4808 
4809 	struct mutex mtx;
4810 
4811 	bool use_4addr, is_running;
4812 
4813 	u8 address[ETH_ALEN] __aligned(sizeof(u16));
4814 
4815 	/* currently used for IBSS and SME - might be rearranged later */
4816 	u8 ssid[IEEE80211_MAX_SSID_LEN];
4817 	u8 ssid_len, mesh_id_len, mesh_id_up_len;
4818 	struct cfg80211_conn *conn;
4819 	struct cfg80211_cached_keys *connect_keys;
4820 	enum ieee80211_bss_type conn_bss_type;
4821 	u32 conn_owner_nlportid;
4822 
4823 	struct work_struct disconnect_wk;
4824 	u8 disconnect_bssid[ETH_ALEN];
4825 
4826 	struct list_head event_list;
4827 	spinlock_t event_lock;
4828 
4829 	struct cfg80211_internal_bss *current_bss; /* associated / joined */
4830 	struct cfg80211_chan_def preset_chandef;
4831 	struct cfg80211_chan_def chandef;
4832 
4833 	bool ibss_fixed;
4834 	bool ibss_dfs_possible;
4835 
4836 	bool ps;
4837 	int ps_timeout;
4838 
4839 	int beacon_interval;
4840 
4841 	u32 ap_unexpected_nlportid;
4842 
4843 	u32 owner_nlportid;
4844 	bool nl_owner_dead;
4845 
4846 	bool cac_started;
4847 	unsigned long cac_start_time;
4848 	unsigned int cac_time_ms;
4849 
4850 #ifdef CONFIG_CFG80211_WEXT
4851 	/* wext data */
4852 	struct {
4853 		struct cfg80211_ibss_params ibss;
4854 		struct cfg80211_connect_params connect;
4855 		struct cfg80211_cached_keys *keys;
4856 		const u8 *ie;
4857 		size_t ie_len;
4858 		u8 bssid[ETH_ALEN];
4859 		u8 prev_bssid[ETH_ALEN];
4860 		u8 ssid[IEEE80211_MAX_SSID_LEN];
4861 		s8 default_key, default_mgmt_key;
4862 		bool prev_bssid_valid;
4863 	} wext;
4864 #endif
4865 
4866 	struct cfg80211_cqm_config *cqm_config;
4867 
4868 	struct list_head pmsr_list;
4869 	spinlock_t pmsr_lock;
4870 	struct work_struct pmsr_free_wk;
4871 };
4872 
4873 static inline u8 *wdev_address(struct wireless_dev *wdev)
4874 {
4875 	if (wdev->netdev)
4876 		return wdev->netdev->dev_addr;
4877 	return wdev->address;
4878 }
4879 
4880 static inline bool wdev_running(struct wireless_dev *wdev)
4881 {
4882 	if (wdev->netdev)
4883 		return netif_running(wdev->netdev);
4884 	return wdev->is_running;
4885 }
4886 
4887 /**
4888  * wdev_priv - return wiphy priv from wireless_dev
4889  *
4890  * @wdev: The wireless device whose wiphy's priv pointer to return
4891  * Return: The wiphy priv of @wdev.
4892  */
4893 static inline void *wdev_priv(struct wireless_dev *wdev)
4894 {
4895 	BUG_ON(!wdev);
4896 	return wiphy_priv(wdev->wiphy);
4897 }
4898 
4899 /**
4900  * DOC: Utility functions
4901  *
4902  * cfg80211 offers a number of utility functions that can be useful.
4903  */
4904 
4905 /**
4906  * ieee80211_channel_to_frequency - convert channel number to frequency
4907  * @chan: channel number
4908  * @band: band, necessary due to channel number overlap
4909  * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
4910  */
4911 int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
4912 
4913 /**
4914  * ieee80211_frequency_to_channel - convert frequency to channel number
4915  * @freq: center frequency
4916  * Return: The corresponding channel, or 0 if the conversion failed.
4917  */
4918 int ieee80211_frequency_to_channel(int freq);
4919 
4920 /**
4921  * ieee80211_get_channel - get channel struct from wiphy for specified frequency
4922  *
4923  * @wiphy: the struct wiphy to get the channel for
4924  * @freq: the center frequency of the channel
4925  *
4926  * Return: The channel struct from @wiphy at @freq.
4927  */
4928 struct ieee80211_channel *ieee80211_get_channel(struct wiphy *wiphy, int freq);
4929 
4930 /**
4931  * ieee80211_get_response_rate - get basic rate for a given rate
4932  *
4933  * @sband: the band to look for rates in
4934  * @basic_rates: bitmap of basic rates
4935  * @bitrate: the bitrate for which to find the basic rate
4936  *
4937  * Return: The basic rate corresponding to a given bitrate, that
4938  * is the next lower bitrate contained in the basic rate map,
4939  * which is, for this function, given as a bitmap of indices of
4940  * rates in the band's bitrate table.
4941  */
4942 struct ieee80211_rate *
4943 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
4944 			    u32 basic_rates, int bitrate);
4945 
4946 /**
4947  * ieee80211_mandatory_rates - get mandatory rates for a given band
4948  * @sband: the band to look for rates in
4949  * @scan_width: width of the control channel
4950  *
4951  * This function returns a bitmap of the mandatory rates for the given
4952  * band, bits are set according to the rate position in the bitrates array.
4953  */
4954 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
4955 			      enum nl80211_bss_scan_width scan_width);
4956 
4957 /*
4958  * Radiotap parsing functions -- for controlled injection support
4959  *
4960  * Implemented in net/wireless/radiotap.c
4961  * Documentation in Documentation/networking/radiotap-headers.txt
4962  */
4963 
4964 struct radiotap_align_size {
4965 	uint8_t align:4, size:4;
4966 };
4967 
4968 struct ieee80211_radiotap_namespace {
4969 	const struct radiotap_align_size *align_size;
4970 	int n_bits;
4971 	uint32_t oui;
4972 	uint8_t subns;
4973 };
4974 
4975 struct ieee80211_radiotap_vendor_namespaces {
4976 	const struct ieee80211_radiotap_namespace *ns;
4977 	int n_ns;
4978 };
4979 
4980 /**
4981  * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
4982  * @this_arg_index: index of current arg, valid after each successful call
4983  *	to ieee80211_radiotap_iterator_next()
4984  * @this_arg: pointer to current radiotap arg; it is valid after each
4985  *	call to ieee80211_radiotap_iterator_next() but also after
4986  *	ieee80211_radiotap_iterator_init() where it will point to
4987  *	the beginning of the actual data portion
4988  * @this_arg_size: length of the current arg, for convenience
4989  * @current_namespace: pointer to the current namespace definition
4990  *	(or internally %NULL if the current namespace is unknown)
4991  * @is_radiotap_ns: indicates whether the current namespace is the default
4992  *	radiotap namespace or not
4993  *
4994  * @_rtheader: pointer to the radiotap header we are walking through
4995  * @_max_length: length of radiotap header in cpu byte ordering
4996  * @_arg_index: next argument index
4997  * @_arg: next argument pointer
4998  * @_next_bitmap: internal pointer to next present u32
4999  * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
5000  * @_vns: vendor namespace definitions
5001  * @_next_ns_data: beginning of the next namespace's data
5002  * @_reset_on_ext: internal; reset the arg index to 0 when going to the
5003  *	next bitmap word
5004  *
5005  * Describes the radiotap parser state. Fields prefixed with an underscore
5006  * must not be used by users of the parser, only by the parser internally.
5007  */
5008 
5009 struct ieee80211_radiotap_iterator {
5010 	struct ieee80211_radiotap_header *_rtheader;
5011 	const struct ieee80211_radiotap_vendor_namespaces *_vns;
5012 	const struct ieee80211_radiotap_namespace *current_namespace;
5013 
5014 	unsigned char *_arg, *_next_ns_data;
5015 	__le32 *_next_bitmap;
5016 
5017 	unsigned char *this_arg;
5018 	int this_arg_index;
5019 	int this_arg_size;
5020 
5021 	int is_radiotap_ns;
5022 
5023 	int _max_length;
5024 	int _arg_index;
5025 	uint32_t _bitmap_shifter;
5026 	int _reset_on_ext;
5027 };
5028 
5029 int
5030 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
5031 				 struct ieee80211_radiotap_header *radiotap_header,
5032 				 int max_length,
5033 				 const struct ieee80211_radiotap_vendor_namespaces *vns);
5034 
5035 int
5036 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
5037 
5038 
5039 extern const unsigned char rfc1042_header[6];
5040 extern const unsigned char bridge_tunnel_header[6];
5041 
5042 /**
5043  * ieee80211_get_hdrlen_from_skb - get header length from data
5044  *
5045  * @skb: the frame
5046  *
5047  * Given an skb with a raw 802.11 header at the data pointer this function
5048  * returns the 802.11 header length.
5049  *
5050  * Return: The 802.11 header length in bytes (not including encryption
5051  * headers). Or 0 if the data in the sk_buff is too short to contain a valid
5052  * 802.11 header.
5053  */
5054 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
5055 
5056 /**
5057  * ieee80211_hdrlen - get header length in bytes from frame control
5058  * @fc: frame control field in little-endian format
5059  * Return: The header length in bytes.
5060  */
5061 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
5062 
5063 /**
5064  * ieee80211_get_mesh_hdrlen - get mesh extension header length
5065  * @meshhdr: the mesh extension header, only the flags field
5066  *	(first byte) will be accessed
5067  * Return: The length of the extension header, which is always at
5068  * least 6 bytes and at most 18 if address 5 and 6 are present.
5069  */
5070 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
5071 
5072 /**
5073  * DOC: Data path helpers
5074  *
5075  * In addition to generic utilities, cfg80211 also offers
5076  * functions that help implement the data path for devices
5077  * that do not do the 802.11/802.3 conversion on the device.
5078  */
5079 
5080 /**
5081  * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
5082  * @skb: the 802.11 data frame
5083  * @ehdr: pointer to a &struct ethhdr that will get the header, instead
5084  *	of it being pushed into the SKB
5085  * @addr: the device MAC address
5086  * @iftype: the virtual interface type
5087  * @data_offset: offset of payload after the 802.11 header
5088  * Return: 0 on success. Non-zero on error.
5089  */
5090 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
5091 				  const u8 *addr, enum nl80211_iftype iftype,
5092 				  u8 data_offset);
5093 
5094 /**
5095  * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
5096  * @skb: the 802.11 data frame
5097  * @addr: the device MAC address
5098  * @iftype: the virtual interface type
5099  * Return: 0 on success. Non-zero on error.
5100  */
5101 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
5102 					 enum nl80211_iftype iftype)
5103 {
5104 	return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0);
5105 }
5106 
5107 /**
5108  * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
5109  *
5110  * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
5111  * The @list will be empty if the decode fails. The @skb must be fully
5112  * header-less before being passed in here; it is freed in this function.
5113  *
5114  * @skb: The input A-MSDU frame without any headers.
5115  * @list: The output list of 802.3 frames. It must be allocated and
5116  *	initialized by by the caller.
5117  * @addr: The device MAC address.
5118  * @iftype: The device interface type.
5119  * @extra_headroom: The hardware extra headroom for SKBs in the @list.
5120  * @check_da: DA to check in the inner ethernet header, or NULL
5121  * @check_sa: SA to check in the inner ethernet header, or NULL
5122  */
5123 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
5124 			      const u8 *addr, enum nl80211_iftype iftype,
5125 			      const unsigned int extra_headroom,
5126 			      const u8 *check_da, const u8 *check_sa);
5127 
5128 /**
5129  * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
5130  * @skb: the data frame
5131  * @qos_map: Interworking QoS mapping or %NULL if not in use
5132  * Return: The 802.1p/1d tag.
5133  */
5134 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
5135 				    struct cfg80211_qos_map *qos_map);
5136 
5137 /**
5138  * cfg80211_find_elem_match - match information element and byte array in data
5139  *
5140  * @eid: element ID
5141  * @ies: data consisting of IEs
5142  * @len: length of data
5143  * @match: byte array to match
5144  * @match_len: number of bytes in the match array
5145  * @match_offset: offset in the IE data where the byte array should match.
5146  *	Note the difference to cfg80211_find_ie_match() which considers
5147  *	the offset to start from the element ID byte, but here we take
5148  *	the data portion instead.
5149  *
5150  * Return: %NULL if the element ID could not be found or if
5151  * the element is invalid (claims to be longer than the given
5152  * data) or if the byte array doesn't match; otherwise return the
5153  * requested element struct.
5154  *
5155  * Note: There are no checks on the element length other than
5156  * having to fit into the given data and being large enough for the
5157  * byte array to match.
5158  */
5159 const struct element *
5160 cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
5161 			 const u8 *match, unsigned int match_len,
5162 			 unsigned int match_offset);
5163 
5164 /**
5165  * cfg80211_find_ie_match - match information element and byte array in data
5166  *
5167  * @eid: element ID
5168  * @ies: data consisting of IEs
5169  * @len: length of data
5170  * @match: byte array to match
5171  * @match_len: number of bytes in the match array
5172  * @match_offset: offset in the IE where the byte array should match.
5173  *	If match_len is zero, this must also be set to zero.
5174  *	Otherwise this must be set to 2 or more, because the first
5175  *	byte is the element id, which is already compared to eid, and
5176  *	the second byte is the IE length.
5177  *
5178  * Return: %NULL if the element ID could not be found or if
5179  * the element is invalid (claims to be longer than the given
5180  * data) or if the byte array doesn't match, or a pointer to the first
5181  * byte of the requested element, that is the byte containing the
5182  * element ID.
5183  *
5184  * Note: There are no checks on the element length other than
5185  * having to fit into the given data and being large enough for the
5186  * byte array to match.
5187  */
5188 static inline const u8 *
5189 cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
5190 		       const u8 *match, unsigned int match_len,
5191 		       unsigned int match_offset)
5192 {
5193 	/* match_offset can't be smaller than 2, unless match_len is
5194 	 * zero, in which case match_offset must be zero as well.
5195 	 */
5196 	if (WARN_ON((match_len && match_offset < 2) ||
5197 		    (!match_len && match_offset)))
5198 		return NULL;
5199 
5200 	return (void *)cfg80211_find_elem_match(eid, ies, len,
5201 						match, match_len,
5202 						match_offset ?
5203 							match_offset - 2 : 0);
5204 }
5205 
5206 /**
5207  * cfg80211_find_elem - find information element in data
5208  *
5209  * @eid: element ID
5210  * @ies: data consisting of IEs
5211  * @len: length of data
5212  *
5213  * Return: %NULL if the element ID could not be found or if
5214  * the element is invalid (claims to be longer than the given
5215  * data) or if the byte array doesn't match; otherwise return the
5216  * requested element struct.
5217  *
5218  * Note: There are no checks on the element length other than
5219  * having to fit into the given data.
5220  */
5221 static inline const struct element *
5222 cfg80211_find_elem(u8 eid, const u8 *ies, int len)
5223 {
5224 	return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
5225 }
5226 
5227 /**
5228  * cfg80211_find_ie - find information element in data
5229  *
5230  * @eid: element ID
5231  * @ies: data consisting of IEs
5232  * @len: length of data
5233  *
5234  * Return: %NULL if the element ID could not be found or if
5235  * the element is invalid (claims to be longer than the given
5236  * data), or a pointer to the first byte of the requested
5237  * element, that is the byte containing the element ID.
5238  *
5239  * Note: There are no checks on the element length other than
5240  * having to fit into the given data.
5241  */
5242 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
5243 {
5244 	return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
5245 }
5246 
5247 /**
5248  * cfg80211_find_ext_elem - find information element with EID Extension in data
5249  *
5250  * @ext_eid: element ID Extension
5251  * @ies: data consisting of IEs
5252  * @len: length of data
5253  *
5254  * Return: %NULL if the etended element could not be found or if
5255  * the element is invalid (claims to be longer than the given
5256  * data) or if the byte array doesn't match; otherwise return the
5257  * requested element struct.
5258  *
5259  * Note: There are no checks on the element length other than
5260  * having to fit into the given data.
5261  */
5262 static inline const struct element *
5263 cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
5264 {
5265 	return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
5266 					&ext_eid, 1, 0);
5267 }
5268 
5269 /**
5270  * cfg80211_find_ext_ie - find information element with EID Extension in data
5271  *
5272  * @ext_eid: element ID Extension
5273  * @ies: data consisting of IEs
5274  * @len: length of data
5275  *
5276  * Return: %NULL if the extended element ID could not be found or if
5277  * the element is invalid (claims to be longer than the given
5278  * data), or a pointer to the first byte of the requested
5279  * element, that is the byte containing the element ID.
5280  *
5281  * Note: There are no checks on the element length other than
5282  * having to fit into the given data.
5283  */
5284 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
5285 {
5286 	return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
5287 				      &ext_eid, 1, 2);
5288 }
5289 
5290 /**
5291  * cfg80211_find_vendor_elem - find vendor specific information element in data
5292  *
5293  * @oui: vendor OUI
5294  * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5295  * @ies: data consisting of IEs
5296  * @len: length of data
5297  *
5298  * Return: %NULL if the vendor specific element ID could not be found or if the
5299  * element is invalid (claims to be longer than the given data); otherwise
5300  * return the element structure for the requested element.
5301  *
5302  * Note: There are no checks on the element length other than having to fit into
5303  * the given data.
5304  */
5305 const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
5306 						const u8 *ies,
5307 						unsigned int len);
5308 
5309 /**
5310  * cfg80211_find_vendor_ie - find vendor specific information element in data
5311  *
5312  * @oui: vendor OUI
5313  * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5314  * @ies: data consisting of IEs
5315  * @len: length of data
5316  *
5317  * Return: %NULL if the vendor specific element ID could not be found or if the
5318  * element is invalid (claims to be longer than the given data), or a pointer to
5319  * the first byte of the requested element, that is the byte containing the
5320  * element ID.
5321  *
5322  * Note: There are no checks on the element length other than having to fit into
5323  * the given data.
5324  */
5325 static inline const u8 *
5326 cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
5327 			const u8 *ies, unsigned int len)
5328 {
5329 	return (void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
5330 }
5331 
5332 /**
5333  * cfg80211_send_layer2_update - send layer 2 update frame
5334  *
5335  * @dev: network device
5336  * @addr: STA MAC address
5337  *
5338  * Wireless drivers can use this function to update forwarding tables in bridge
5339  * devices upon STA association.
5340  */
5341 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
5342 
5343 /**
5344  * DOC: Regulatory enforcement infrastructure
5345  *
5346  * TODO
5347  */
5348 
5349 /**
5350  * regulatory_hint - driver hint to the wireless core a regulatory domain
5351  * @wiphy: the wireless device giving the hint (used only for reporting
5352  *	conflicts)
5353  * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
5354  * 	should be in. If @rd is set this should be NULL. Note that if you
5355  * 	set this to NULL you should still set rd->alpha2 to some accepted
5356  * 	alpha2.
5357  *
5358  * Wireless drivers can use this function to hint to the wireless core
5359  * what it believes should be the current regulatory domain by
5360  * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
5361  * domain should be in or by providing a completely build regulatory domain.
5362  * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
5363  * for a regulatory domain structure for the respective country.
5364  *
5365  * The wiphy must have been registered to cfg80211 prior to this call.
5366  * For cfg80211 drivers this means you must first use wiphy_register(),
5367  * for mac80211 drivers you must first use ieee80211_register_hw().
5368  *
5369  * Drivers should check the return value, its possible you can get
5370  * an -ENOMEM.
5371  *
5372  * Return: 0 on success. -ENOMEM.
5373  */
5374 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
5375 
5376 /**
5377  * regulatory_set_wiphy_regd - set regdom info for self managed drivers
5378  * @wiphy: the wireless device we want to process the regulatory domain on
5379  * @rd: the regulatory domain informatoin to use for this wiphy
5380  *
5381  * Set the regulatory domain information for self-managed wiphys, only they
5382  * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
5383  * information.
5384  *
5385  * Return: 0 on success. -EINVAL, -EPERM
5386  */
5387 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
5388 			      struct ieee80211_regdomain *rd);
5389 
5390 /**
5391  * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
5392  * @wiphy: the wireless device we want to process the regulatory domain on
5393  * @rd: the regulatory domain information to use for this wiphy
5394  *
5395  * This functions requires the RTNL to be held and applies the new regdomain
5396  * synchronously to this wiphy. For more details see
5397  * regulatory_set_wiphy_regd().
5398  *
5399  * Return: 0 on success. -EINVAL, -EPERM
5400  */
5401 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
5402 					struct ieee80211_regdomain *rd);
5403 
5404 /**
5405  * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
5406  * @wiphy: the wireless device we want to process the regulatory domain on
5407  * @regd: the custom regulatory domain to use for this wiphy
5408  *
5409  * Drivers can sometimes have custom regulatory domains which do not apply
5410  * to a specific country. Drivers can use this to apply such custom regulatory
5411  * domains. This routine must be called prior to wiphy registration. The
5412  * custom regulatory domain will be trusted completely and as such previous
5413  * default channel settings will be disregarded. If no rule is found for a
5414  * channel on the regulatory domain the channel will be disabled.
5415  * Drivers using this for a wiphy should also set the wiphy flag
5416  * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
5417  * that called this helper.
5418  */
5419 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
5420 				   const struct ieee80211_regdomain *regd);
5421 
5422 /**
5423  * freq_reg_info - get regulatory information for the given frequency
5424  * @wiphy: the wiphy for which we want to process this rule for
5425  * @center_freq: Frequency in KHz for which we want regulatory information for
5426  *
5427  * Use this function to get the regulatory rule for a specific frequency on
5428  * a given wireless device. If the device has a specific regulatory domain
5429  * it wants to follow we respect that unless a country IE has been received
5430  * and processed already.
5431  *
5432  * Return: A valid pointer, or, when an error occurs, for example if no rule
5433  * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
5434  * check and PTR_ERR() to obtain the numeric return value. The numeric return
5435  * value will be -ERANGE if we determine the given center_freq does not even
5436  * have a regulatory rule for a frequency range in the center_freq's band.
5437  * See freq_in_rule_band() for our current definition of a band -- this is
5438  * purely subjective and right now it's 802.11 specific.
5439  */
5440 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
5441 					       u32 center_freq);
5442 
5443 /**
5444  * reg_initiator_name - map regulatory request initiator enum to name
5445  * @initiator: the regulatory request initiator
5446  *
5447  * You can use this to map the regulatory request initiator enum to a
5448  * proper string representation.
5449  */
5450 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
5451 
5452 /**
5453  * DOC: Internal regulatory db functions
5454  *
5455  */
5456 
5457 /**
5458  * reg_query_regdb_wmm -  Query internal regulatory db for wmm rule
5459  * Regulatory self-managed driver can use it to proactively
5460  *
5461  * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
5462  * @freq: the freqency(in MHz) to be queried.
5463  * @rule: pointer to store the wmm rule from the regulatory db.
5464  *
5465  * Self-managed wireless drivers can use this function to  query
5466  * the internal regulatory database to check whether the given
5467  * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
5468  *
5469  * Drivers should check the return value, its possible you can get
5470  * an -ENODATA.
5471  *
5472  * Return: 0 on success. -ENODATA.
5473  */
5474 int reg_query_regdb_wmm(char *alpha2, int freq,
5475 			struct ieee80211_reg_rule *rule);
5476 
5477 /*
5478  * callbacks for asynchronous cfg80211 methods, notification
5479  * functions and BSS handling helpers
5480  */
5481 
5482 /**
5483  * cfg80211_scan_done - notify that scan finished
5484  *
5485  * @request: the corresponding scan request
5486  * @info: information about the completed scan
5487  */
5488 void cfg80211_scan_done(struct cfg80211_scan_request *request,
5489 			struct cfg80211_scan_info *info);
5490 
5491 /**
5492  * cfg80211_sched_scan_results - notify that new scan results are available
5493  *
5494  * @wiphy: the wiphy which got scheduled scan results
5495  * @reqid: identifier for the related scheduled scan request
5496  */
5497 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
5498 
5499 /**
5500  * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
5501  *
5502  * @wiphy: the wiphy on which the scheduled scan stopped
5503  * @reqid: identifier for the related scheduled scan request
5504  *
5505  * The driver can call this function to inform cfg80211 that the
5506  * scheduled scan had to be stopped, for whatever reason.  The driver
5507  * is then called back via the sched_scan_stop operation when done.
5508  */
5509 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
5510 
5511 /**
5512  * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
5513  *
5514  * @wiphy: the wiphy on which the scheduled scan stopped
5515  * @reqid: identifier for the related scheduled scan request
5516  *
5517  * The driver can call this function to inform cfg80211 that the
5518  * scheduled scan had to be stopped, for whatever reason.  The driver
5519  * is then called back via the sched_scan_stop operation when done.
5520  * This function should be called with rtnl locked.
5521  */
5522 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy, u64 reqid);
5523 
5524 /**
5525  * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
5526  * @wiphy: the wiphy reporting the BSS
5527  * @data: the BSS metadata
5528  * @mgmt: the management frame (probe response or beacon)
5529  * @len: length of the management frame
5530  * @gfp: context flags
5531  *
5532  * This informs cfg80211 that BSS information was found and
5533  * the BSS should be updated/added.
5534  *
5535  * Return: A referenced struct, must be released with cfg80211_put_bss()!
5536  * Or %NULL on error.
5537  */
5538 struct cfg80211_bss * __must_check
5539 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
5540 			       struct cfg80211_inform_bss *data,
5541 			       struct ieee80211_mgmt *mgmt, size_t len,
5542 			       gfp_t gfp);
5543 
5544 static inline struct cfg80211_bss * __must_check
5545 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
5546 				struct ieee80211_channel *rx_channel,
5547 				enum nl80211_bss_scan_width scan_width,
5548 				struct ieee80211_mgmt *mgmt, size_t len,
5549 				s32 signal, gfp_t gfp)
5550 {
5551 	struct cfg80211_inform_bss data = {
5552 		.chan = rx_channel,
5553 		.scan_width = scan_width,
5554 		.signal = signal,
5555 	};
5556 
5557 	return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
5558 }
5559 
5560 static inline struct cfg80211_bss * __must_check
5561 cfg80211_inform_bss_frame(struct wiphy *wiphy,
5562 			  struct ieee80211_channel *rx_channel,
5563 			  struct ieee80211_mgmt *mgmt, size_t len,
5564 			  s32 signal, gfp_t gfp)
5565 {
5566 	struct cfg80211_inform_bss data = {
5567 		.chan = rx_channel,
5568 		.scan_width = NL80211_BSS_CHAN_WIDTH_20,
5569 		.signal = signal,
5570 	};
5571 
5572 	return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
5573 }
5574 
5575 /**
5576  * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
5577  * @bssid: transmitter BSSID
5578  * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
5579  * @mbssid_index: BSSID index, taken from Multiple BSSID index element
5580  * @new_bssid: calculated nontransmitted BSSID
5581  */
5582 static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
5583 					  u8 mbssid_index, u8 *new_bssid)
5584 {
5585 	u64 bssid_u64 = ether_addr_to_u64(bssid);
5586 	u64 mask = GENMASK_ULL(max_bssid - 1, 0);
5587 	u64 new_bssid_u64;
5588 
5589 	new_bssid_u64 = bssid_u64 & ~mask;
5590 
5591 	new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
5592 
5593 	u64_to_ether_addr(new_bssid_u64, new_bssid);
5594 }
5595 
5596 /**
5597  * cfg80211_is_element_inherited - returns if element ID should be inherited
5598  * @element: element to check
5599  * @non_inherit_element: non inheritance element
5600  */
5601 bool cfg80211_is_element_inherited(const struct element *element,
5602 				   const struct element *non_inherit_element);
5603 
5604 /**
5605  * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
5606  * @ie: ies
5607  * @ielen: length of IEs
5608  * @mbssid_elem: current MBSSID element
5609  * @sub_elem: current MBSSID subelement (profile)
5610  * @merged_ie: location of the merged profile
5611  * @max_copy_len: max merged profile length
5612  */
5613 size_t cfg80211_merge_profile(const u8 *ie, size_t ielen,
5614 			      const struct element *mbssid_elem,
5615 			      const struct element *sub_elem,
5616 			      u8 *merged_ie, size_t max_copy_len);
5617 
5618 /**
5619  * enum cfg80211_bss_frame_type - frame type that the BSS data came from
5620  * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
5621  *	from a beacon or probe response
5622  * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
5623  * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
5624  */
5625 enum cfg80211_bss_frame_type {
5626 	CFG80211_BSS_FTYPE_UNKNOWN,
5627 	CFG80211_BSS_FTYPE_BEACON,
5628 	CFG80211_BSS_FTYPE_PRESP,
5629 };
5630 
5631 /**
5632  * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
5633  *
5634  * @wiphy: the wiphy reporting the BSS
5635  * @data: the BSS metadata
5636  * @ftype: frame type (if known)
5637  * @bssid: the BSSID of the BSS
5638  * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
5639  * @capability: the capability field sent by the peer
5640  * @beacon_interval: the beacon interval announced by the peer
5641  * @ie: additional IEs sent by the peer
5642  * @ielen: length of the additional IEs
5643  * @gfp: context flags
5644  *
5645  * This informs cfg80211 that BSS information was found and
5646  * the BSS should be updated/added.
5647  *
5648  * Return: A referenced struct, must be released with cfg80211_put_bss()!
5649  * Or %NULL on error.
5650  */
5651 struct cfg80211_bss * __must_check
5652 cfg80211_inform_bss_data(struct wiphy *wiphy,
5653 			 struct cfg80211_inform_bss *data,
5654 			 enum cfg80211_bss_frame_type ftype,
5655 			 const u8 *bssid, u64 tsf, u16 capability,
5656 			 u16 beacon_interval, const u8 *ie, size_t ielen,
5657 			 gfp_t gfp);
5658 
5659 static inline struct cfg80211_bss * __must_check
5660 cfg80211_inform_bss_width(struct wiphy *wiphy,
5661 			  struct ieee80211_channel *rx_channel,
5662 			  enum nl80211_bss_scan_width scan_width,
5663 			  enum cfg80211_bss_frame_type ftype,
5664 			  const u8 *bssid, u64 tsf, u16 capability,
5665 			  u16 beacon_interval, const u8 *ie, size_t ielen,
5666 			  s32 signal, gfp_t gfp)
5667 {
5668 	struct cfg80211_inform_bss data = {
5669 		.chan = rx_channel,
5670 		.scan_width = scan_width,
5671 		.signal = signal,
5672 	};
5673 
5674 	return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
5675 					capability, beacon_interval, ie, ielen,
5676 					gfp);
5677 }
5678 
5679 static inline struct cfg80211_bss * __must_check
5680 cfg80211_inform_bss(struct wiphy *wiphy,
5681 		    struct ieee80211_channel *rx_channel,
5682 		    enum cfg80211_bss_frame_type ftype,
5683 		    const u8 *bssid, u64 tsf, u16 capability,
5684 		    u16 beacon_interval, const u8 *ie, size_t ielen,
5685 		    s32 signal, gfp_t gfp)
5686 {
5687 	struct cfg80211_inform_bss data = {
5688 		.chan = rx_channel,
5689 		.scan_width = NL80211_BSS_CHAN_WIDTH_20,
5690 		.signal = signal,
5691 	};
5692 
5693 	return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
5694 					capability, beacon_interval, ie, ielen,
5695 					gfp);
5696 }
5697 
5698 /**
5699  * cfg80211_get_bss - get a BSS reference
5700  * @wiphy: the wiphy this BSS struct belongs to
5701  * @channel: the channel to search on (or %NULL)
5702  * @bssid: the desired BSSID (or %NULL)
5703  * @ssid: the desired SSID (or %NULL)
5704  * @ssid_len: length of the SSID (or 0)
5705  * @bss_type: type of BSS, see &enum ieee80211_bss_type
5706  * @privacy: privacy filter, see &enum ieee80211_privacy
5707  */
5708 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
5709 				      struct ieee80211_channel *channel,
5710 				      const u8 *bssid,
5711 				      const u8 *ssid, size_t ssid_len,
5712 				      enum ieee80211_bss_type bss_type,
5713 				      enum ieee80211_privacy privacy);
5714 static inline struct cfg80211_bss *
5715 cfg80211_get_ibss(struct wiphy *wiphy,
5716 		  struct ieee80211_channel *channel,
5717 		  const u8 *ssid, size_t ssid_len)
5718 {
5719 	return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
5720 				IEEE80211_BSS_TYPE_IBSS,
5721 				IEEE80211_PRIVACY_ANY);
5722 }
5723 
5724 /**
5725  * cfg80211_ref_bss - reference BSS struct
5726  * @wiphy: the wiphy this BSS struct belongs to
5727  * @bss: the BSS struct to reference
5728  *
5729  * Increments the refcount of the given BSS struct.
5730  */
5731 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5732 
5733 /**
5734  * cfg80211_put_bss - unref BSS struct
5735  * @wiphy: the wiphy this BSS struct belongs to
5736  * @bss: the BSS struct
5737  *
5738  * Decrements the refcount of the given BSS struct.
5739  */
5740 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5741 
5742 /**
5743  * cfg80211_unlink_bss - unlink BSS from internal data structures
5744  * @wiphy: the wiphy
5745  * @bss: the bss to remove
5746  *
5747  * This function removes the given BSS from the internal data structures
5748  * thereby making it no longer show up in scan results etc. Use this
5749  * function when you detect a BSS is gone. Normally BSSes will also time
5750  * out, so it is not necessary to use this function at all.
5751  */
5752 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5753 
5754 /**
5755  * cfg80211_bss_iter - iterate all BSS entries
5756  *
5757  * This function iterates over the BSS entries associated with the given wiphy
5758  * and calls the callback for the iterated BSS. The iterator function is not
5759  * allowed to call functions that might modify the internal state of the BSS DB.
5760  *
5761  * @wiphy: the wiphy
5762  * @chandef: if given, the iterator function will be called only if the channel
5763  *     of the currently iterated BSS is a subset of the given channel.
5764  * @iter: the iterator function to call
5765  * @iter_data: an argument to the iterator function
5766  */
5767 void cfg80211_bss_iter(struct wiphy *wiphy,
5768 		       struct cfg80211_chan_def *chandef,
5769 		       void (*iter)(struct wiphy *wiphy,
5770 				    struct cfg80211_bss *bss,
5771 				    void *data),
5772 		       void *iter_data);
5773 
5774 static inline enum nl80211_bss_scan_width
5775 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
5776 {
5777 	switch (chandef->width) {
5778 	case NL80211_CHAN_WIDTH_5:
5779 		return NL80211_BSS_CHAN_WIDTH_5;
5780 	case NL80211_CHAN_WIDTH_10:
5781 		return NL80211_BSS_CHAN_WIDTH_10;
5782 	default:
5783 		return NL80211_BSS_CHAN_WIDTH_20;
5784 	}
5785 }
5786 
5787 /**
5788  * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
5789  * @dev: network device
5790  * @buf: authentication frame (header + body)
5791  * @len: length of the frame data
5792  *
5793  * This function is called whenever an authentication, disassociation or
5794  * deauthentication frame has been received and processed in station mode.
5795  * After being asked to authenticate via cfg80211_ops::auth() the driver must
5796  * call either this function or cfg80211_auth_timeout().
5797  * After being asked to associate via cfg80211_ops::assoc() the driver must
5798  * call either this function or cfg80211_auth_timeout().
5799  * While connected, the driver must calls this for received and processed
5800  * disassociation and deauthentication frames. If the frame couldn't be used
5801  * because it was unprotected, the driver must call the function
5802  * cfg80211_rx_unprot_mlme_mgmt() instead.
5803  *
5804  * This function may sleep. The caller must hold the corresponding wdev's mutex.
5805  */
5806 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
5807 
5808 /**
5809  * cfg80211_auth_timeout - notification of timed out authentication
5810  * @dev: network device
5811  * @addr: The MAC address of the device with which the authentication timed out
5812  *
5813  * This function may sleep. The caller must hold the corresponding wdev's
5814  * mutex.
5815  */
5816 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
5817 
5818 /**
5819  * cfg80211_rx_assoc_resp - notification of processed association response
5820  * @dev: network device
5821  * @bss: the BSS that association was requested with, ownership of the pointer
5822  *	moves to cfg80211 in this call
5823  * @buf: (Re)Association Response frame (header + body)
5824  * @len: length of the frame data
5825  * @uapsd_queues: bitmap of queues configured for uapsd. Same format
5826  *	as the AC bitmap in the QoS info field
5827  * @req_ies: information elements from the (Re)Association Request frame
5828  * @req_ies_len: length of req_ies data
5829  *
5830  * After being asked to associate via cfg80211_ops::assoc() the driver must
5831  * call either this function or cfg80211_auth_timeout().
5832  *
5833  * This function may sleep. The caller must hold the corresponding wdev's mutex.
5834  */
5835 void cfg80211_rx_assoc_resp(struct net_device *dev,
5836 			    struct cfg80211_bss *bss,
5837 			    const u8 *buf, size_t len,
5838 			    int uapsd_queues,
5839 			    const u8 *req_ies, size_t req_ies_len);
5840 
5841 /**
5842  * cfg80211_assoc_timeout - notification of timed out association
5843  * @dev: network device
5844  * @bss: The BSS entry with which association timed out.
5845  *
5846  * This function may sleep. The caller must hold the corresponding wdev's mutex.
5847  */
5848 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
5849 
5850 /**
5851  * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
5852  * @dev: network device
5853  * @bss: The BSS entry with which association was abandoned.
5854  *
5855  * Call this whenever - for reasons reported through other API, like deauth RX,
5856  * an association attempt was abandoned.
5857  * This function may sleep. The caller must hold the corresponding wdev's mutex.
5858  */
5859 void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
5860 
5861 /**
5862  * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
5863  * @dev: network device
5864  * @buf: 802.11 frame (header + body)
5865  * @len: length of the frame data
5866  *
5867  * This function is called whenever deauthentication has been processed in
5868  * station mode. This includes both received deauthentication frames and
5869  * locally generated ones. This function may sleep. The caller must hold the
5870  * corresponding wdev's mutex.
5871  */
5872 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
5873 
5874 /**
5875  * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
5876  * @dev: network device
5877  * @buf: deauthentication frame (header + body)
5878  * @len: length of the frame data
5879  *
5880  * This function is called whenever a received deauthentication or dissassoc
5881  * frame has been dropped in station mode because of MFP being used but the
5882  * frame was not protected. This function may sleep.
5883  */
5884 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
5885 				  const u8 *buf, size_t len);
5886 
5887 /**
5888  * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
5889  * @dev: network device
5890  * @addr: The source MAC address of the frame
5891  * @key_type: The key type that the received frame used
5892  * @key_id: Key identifier (0..3). Can be -1 if missing.
5893  * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
5894  * @gfp: allocation flags
5895  *
5896  * This function is called whenever the local MAC detects a MIC failure in a
5897  * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
5898  * primitive.
5899  */
5900 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
5901 				  enum nl80211_key_type key_type, int key_id,
5902 				  const u8 *tsc, gfp_t gfp);
5903 
5904 /**
5905  * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
5906  *
5907  * @dev: network device
5908  * @bssid: the BSSID of the IBSS joined
5909  * @channel: the channel of the IBSS joined
5910  * @gfp: allocation flags
5911  *
5912  * This function notifies cfg80211 that the device joined an IBSS or
5913  * switched to a different BSSID. Before this function can be called,
5914  * either a beacon has to have been received from the IBSS, or one of
5915  * the cfg80211_inform_bss{,_frame} functions must have been called
5916  * with the locally generated beacon -- this guarantees that there is
5917  * always a scan result for this IBSS. cfg80211 will handle the rest.
5918  */
5919 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
5920 			  struct ieee80211_channel *channel, gfp_t gfp);
5921 
5922 /**
5923  * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
5924  *
5925  * @dev: network device
5926  * @macaddr: the MAC address of the new candidate
5927  * @ie: information elements advertised by the peer candidate
5928  * @ie_len: length of the information elements buffer
5929  * @gfp: allocation flags
5930  *
5931  * This function notifies cfg80211 that the mesh peer candidate has been
5932  * detected, most likely via a beacon or, less likely, via a probe response.
5933  * cfg80211 then sends a notification to userspace.
5934  */
5935 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
5936 		const u8 *macaddr, const u8 *ie, u8 ie_len,
5937 		int sig_dbm, gfp_t gfp);
5938 
5939 /**
5940  * DOC: RFkill integration
5941  *
5942  * RFkill integration in cfg80211 is almost invisible to drivers,
5943  * as cfg80211 automatically registers an rfkill instance for each
5944  * wireless device it knows about. Soft kill is also translated
5945  * into disconnecting and turning all interfaces off, drivers are
5946  * expected to turn off the device when all interfaces are down.
5947  *
5948  * However, devices may have a hard RFkill line, in which case they
5949  * also need to interact with the rfkill subsystem, via cfg80211.
5950  * They can do this with a few helper functions documented here.
5951  */
5952 
5953 /**
5954  * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
5955  * @wiphy: the wiphy
5956  * @blocked: block status
5957  */
5958 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
5959 
5960 /**
5961  * wiphy_rfkill_start_polling - start polling rfkill
5962  * @wiphy: the wiphy
5963  */
5964 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
5965 
5966 /**
5967  * wiphy_rfkill_stop_polling - stop polling rfkill
5968  * @wiphy: the wiphy
5969  */
5970 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
5971 
5972 /**
5973  * DOC: Vendor commands
5974  *
5975  * Occasionally, there are special protocol or firmware features that
5976  * can't be implemented very openly. For this and similar cases, the
5977  * vendor command functionality allows implementing the features with
5978  * (typically closed-source) userspace and firmware, using nl80211 as
5979  * the configuration mechanism.
5980  *
5981  * A driver supporting vendor commands must register them as an array
5982  * in struct wiphy, with handlers for each one, each command has an
5983  * OUI and sub command ID to identify it.
5984  *
5985  * Note that this feature should not be (ab)used to implement protocol
5986  * features that could openly be shared across drivers. In particular,
5987  * it must never be required to use vendor commands to implement any
5988  * "normal" functionality that higher-level userspace like connection
5989  * managers etc. need.
5990  */
5991 
5992 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
5993 					   enum nl80211_commands cmd,
5994 					   enum nl80211_attrs attr,
5995 					   int approxlen);
5996 
5997 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
5998 					   struct wireless_dev *wdev,
5999 					   enum nl80211_commands cmd,
6000 					   enum nl80211_attrs attr,
6001 					   unsigned int portid,
6002 					   int vendor_event_idx,
6003 					   int approxlen, gfp_t gfp);
6004 
6005 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
6006 
6007 /**
6008  * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
6009  * @wiphy: the wiphy
6010  * @approxlen: an upper bound of the length of the data that will
6011  *	be put into the skb
6012  *
6013  * This function allocates and pre-fills an skb for a reply to
6014  * a vendor command. Since it is intended for a reply, calling
6015  * it outside of a vendor command's doit() operation is invalid.
6016  *
6017  * The returned skb is pre-filled with some identifying data in
6018  * a way that any data that is put into the skb (with skb_put(),
6019  * nla_put() or similar) will end up being within the
6020  * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
6021  * with the skb is adding data for the corresponding userspace tool
6022  * which can then read that data out of the vendor data attribute.
6023  * You must not modify the skb in any other way.
6024  *
6025  * When done, call cfg80211_vendor_cmd_reply() with the skb and return
6026  * its error code as the result of the doit() operation.
6027  *
6028  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6029  */
6030 static inline struct sk_buff *
6031 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6032 {
6033 	return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
6034 					  NL80211_ATTR_VENDOR_DATA, approxlen);
6035 }
6036 
6037 /**
6038  * cfg80211_vendor_cmd_reply - send the reply skb
6039  * @skb: The skb, must have been allocated with
6040  *	cfg80211_vendor_cmd_alloc_reply_skb()
6041  *
6042  * Since calling this function will usually be the last thing
6043  * before returning from the vendor command doit() you should
6044  * return the error code.  Note that this function consumes the
6045  * skb regardless of the return value.
6046  *
6047  * Return: An error code or 0 on success.
6048  */
6049 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
6050 
6051 /**
6052  * cfg80211_vendor_cmd_get_sender
6053  * @wiphy: the wiphy
6054  *
6055  * Return the current netlink port ID in a vendor command handler.
6056  * Valid to call only there.
6057  */
6058 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
6059 
6060 /**
6061  * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
6062  * @wiphy: the wiphy
6063  * @wdev: the wireless device
6064  * @event_idx: index of the vendor event in the wiphy's vendor_events
6065  * @approxlen: an upper bound of the length of the data that will
6066  *	be put into the skb
6067  * @gfp: allocation flags
6068  *
6069  * This function allocates and pre-fills an skb for an event on the
6070  * vendor-specific multicast group.
6071  *
6072  * If wdev != NULL, both the ifindex and identifier of the specified
6073  * wireless device are added to the event message before the vendor data
6074  * attribute.
6075  *
6076  * When done filling the skb, call cfg80211_vendor_event() with the
6077  * skb to send the event.
6078  *
6079  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6080  */
6081 static inline struct sk_buff *
6082 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
6083 			     int approxlen, int event_idx, gfp_t gfp)
6084 {
6085 	return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6086 					  NL80211_ATTR_VENDOR_DATA,
6087 					  0, event_idx, approxlen, gfp);
6088 }
6089 
6090 /**
6091  * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
6092  * @wiphy: the wiphy
6093  * @wdev: the wireless device
6094  * @event_idx: index of the vendor event in the wiphy's vendor_events
6095  * @portid: port ID of the receiver
6096  * @approxlen: an upper bound of the length of the data that will
6097  *	be put into the skb
6098  * @gfp: allocation flags
6099  *
6100  * This function allocates and pre-fills an skb for an event to send to
6101  * a specific (userland) socket. This socket would previously have been
6102  * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
6103  * care to register a netlink notifier to see when the socket closes.
6104  *
6105  * If wdev != NULL, both the ifindex and identifier of the specified
6106  * wireless device are added to the event message before the vendor data
6107  * attribute.
6108  *
6109  * When done filling the skb, call cfg80211_vendor_event() with the
6110  * skb to send the event.
6111  *
6112  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6113  */
6114 static inline struct sk_buff *
6115 cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
6116 				  struct wireless_dev *wdev,
6117 				  unsigned int portid, int approxlen,
6118 				  int event_idx, gfp_t gfp)
6119 {
6120 	return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6121 					  NL80211_ATTR_VENDOR_DATA,
6122 					  portid, event_idx, approxlen, gfp);
6123 }
6124 
6125 /**
6126  * cfg80211_vendor_event - send the event
6127  * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
6128  * @gfp: allocation flags
6129  *
6130  * This function sends the given @skb, which must have been allocated
6131  * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
6132  */
6133 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
6134 {
6135 	__cfg80211_send_event_skb(skb, gfp);
6136 }
6137 
6138 #ifdef CONFIG_NL80211_TESTMODE
6139 /**
6140  * DOC: Test mode
6141  *
6142  * Test mode is a set of utility functions to allow drivers to
6143  * interact with driver-specific tools to aid, for instance,
6144  * factory programming.
6145  *
6146  * This chapter describes how drivers interact with it, for more
6147  * information see the nl80211 book's chapter on it.
6148  */
6149 
6150 /**
6151  * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
6152  * @wiphy: the wiphy
6153  * @approxlen: an upper bound of the length of the data that will
6154  *	be put into the skb
6155  *
6156  * This function allocates and pre-fills an skb for a reply to
6157  * the testmode command. Since it is intended for a reply, calling
6158  * it outside of the @testmode_cmd operation is invalid.
6159  *
6160  * The returned skb is pre-filled with the wiphy index and set up in
6161  * a way that any data that is put into the skb (with skb_put(),
6162  * nla_put() or similar) will end up being within the
6163  * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
6164  * with the skb is adding data for the corresponding userspace tool
6165  * which can then read that data out of the testdata attribute. You
6166  * must not modify the skb in any other way.
6167  *
6168  * When done, call cfg80211_testmode_reply() with the skb and return
6169  * its error code as the result of the @testmode_cmd operation.
6170  *
6171  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6172  */
6173 static inline struct sk_buff *
6174 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6175 {
6176 	return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
6177 					  NL80211_ATTR_TESTDATA, approxlen);
6178 }
6179 
6180 /**
6181  * cfg80211_testmode_reply - send the reply skb
6182  * @skb: The skb, must have been allocated with
6183  *	cfg80211_testmode_alloc_reply_skb()
6184  *
6185  * Since calling this function will usually be the last thing
6186  * before returning from the @testmode_cmd you should return
6187  * the error code.  Note that this function consumes the skb
6188  * regardless of the return value.
6189  *
6190  * Return: An error code or 0 on success.
6191  */
6192 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
6193 {
6194 	return cfg80211_vendor_cmd_reply(skb);
6195 }
6196 
6197 /**
6198  * cfg80211_testmode_alloc_event_skb - allocate testmode event
6199  * @wiphy: the wiphy
6200  * @approxlen: an upper bound of the length of the data that will
6201  *	be put into the skb
6202  * @gfp: allocation flags
6203  *
6204  * This function allocates and pre-fills an skb for an event on the
6205  * testmode multicast group.
6206  *
6207  * The returned skb is set up in the same way as with
6208  * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
6209  * there, you should simply add data to it that will then end up in the
6210  * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
6211  * in any other way.
6212  *
6213  * When done filling the skb, call cfg80211_testmode_event() with the
6214  * skb to send the event.
6215  *
6216  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6217  */
6218 static inline struct sk_buff *
6219 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
6220 {
6221 	return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
6222 					  NL80211_ATTR_TESTDATA, 0, -1,
6223 					  approxlen, gfp);
6224 }
6225 
6226 /**
6227  * cfg80211_testmode_event - send the event
6228  * @skb: The skb, must have been allocated with
6229  *	cfg80211_testmode_alloc_event_skb()
6230  * @gfp: allocation flags
6231  *
6232  * This function sends the given @skb, which must have been allocated
6233  * by cfg80211_testmode_alloc_event_skb(), as an event. It always
6234  * consumes it.
6235  */
6236 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
6237 {
6238 	__cfg80211_send_event_skb(skb, gfp);
6239 }
6240 
6241 #define CFG80211_TESTMODE_CMD(cmd)	.testmode_cmd = (cmd),
6242 #define CFG80211_TESTMODE_DUMP(cmd)	.testmode_dump = (cmd),
6243 #else
6244 #define CFG80211_TESTMODE_CMD(cmd)
6245 #define CFG80211_TESTMODE_DUMP(cmd)
6246 #endif
6247 
6248 /**
6249  * struct cfg80211_fils_resp_params - FILS connection response params
6250  * @kek: KEK derived from a successful FILS connection (may be %NULL)
6251  * @kek_len: Length of @fils_kek in octets
6252  * @update_erp_next_seq_num: Boolean value to specify whether the value in
6253  *	@erp_next_seq_num is valid.
6254  * @erp_next_seq_num: The next sequence number to use in ERP message in
6255  *	FILS Authentication. This value should be specified irrespective of the
6256  *	status for a FILS connection.
6257  * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
6258  * @pmk_len: Length of @pmk in octets
6259  * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
6260  *	used for this FILS connection (may be %NULL).
6261  */
6262 struct cfg80211_fils_resp_params {
6263 	const u8 *kek;
6264 	size_t kek_len;
6265 	bool update_erp_next_seq_num;
6266 	u16 erp_next_seq_num;
6267 	const u8 *pmk;
6268 	size_t pmk_len;
6269 	const u8 *pmkid;
6270 };
6271 
6272 /**
6273  * struct cfg80211_connect_resp_params - Connection response params
6274  * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
6275  *	%WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6276  *	the real status code for failures. If this call is used to report a
6277  *	failure due to a timeout (e.g., not receiving an Authentication frame
6278  *	from the AP) instead of an explicit rejection by the AP, -1 is used to
6279  *	indicate that this is a failure, but without a status code.
6280  *	@timeout_reason is used to report the reason for the timeout in that
6281  *	case.
6282  * @bssid: The BSSID of the AP (may be %NULL)
6283  * @bss: Entry of bss to which STA got connected to, can be obtained through
6284  *	cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6285  *	bss from the connect_request and hold a reference to it and return
6286  *	through this param to avoid a warning if the bss is expired during the
6287  *	connection, esp. for those drivers implementing connect op.
6288  *	Only one parameter among @bssid and @bss needs to be specified.
6289  * @req_ie: Association request IEs (may be %NULL)
6290  * @req_ie_len: Association request IEs length
6291  * @resp_ie: Association response IEs (may be %NULL)
6292  * @resp_ie_len: Association response IEs length
6293  * @fils: FILS connection response parameters.
6294  * @timeout_reason: Reason for connection timeout. This is used when the
6295  *	connection fails due to a timeout instead of an explicit rejection from
6296  *	the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6297  *	not known. This value is used only if @status < 0 to indicate that the
6298  *	failure is due to a timeout and not due to explicit rejection by the AP.
6299  *	This value is ignored in other cases (@status >= 0).
6300  */
6301 struct cfg80211_connect_resp_params {
6302 	int status;
6303 	const u8 *bssid;
6304 	struct cfg80211_bss *bss;
6305 	const u8 *req_ie;
6306 	size_t req_ie_len;
6307 	const u8 *resp_ie;
6308 	size_t resp_ie_len;
6309 	struct cfg80211_fils_resp_params fils;
6310 	enum nl80211_timeout_reason timeout_reason;
6311 };
6312 
6313 /**
6314  * cfg80211_connect_done - notify cfg80211 of connection result
6315  *
6316  * @dev: network device
6317  * @params: connection response parameters
6318  * @gfp: allocation flags
6319  *
6320  * It should be called by the underlying driver once execution of the connection
6321  * request from connect() has been completed. This is similar to
6322  * cfg80211_connect_bss(), but takes a structure pointer for connection response
6323  * parameters. Only one of the functions among cfg80211_connect_bss(),
6324  * cfg80211_connect_result(), cfg80211_connect_timeout(),
6325  * and cfg80211_connect_done() should be called.
6326  */
6327 void cfg80211_connect_done(struct net_device *dev,
6328 			   struct cfg80211_connect_resp_params *params,
6329 			   gfp_t gfp);
6330 
6331 /**
6332  * cfg80211_connect_bss - notify cfg80211 of connection result
6333  *
6334  * @dev: network device
6335  * @bssid: the BSSID of the AP
6336  * @bss: Entry of bss to which STA got connected to, can be obtained through
6337  *	cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6338  *	bss from the connect_request and hold a reference to it and return
6339  *	through this param to avoid a warning if the bss is expired during the
6340  *	connection, esp. for those drivers implementing connect op.
6341  *	Only one parameter among @bssid and @bss needs to be specified.
6342  * @req_ie: association request IEs (maybe be %NULL)
6343  * @req_ie_len: association request IEs length
6344  * @resp_ie: association response IEs (may be %NULL)
6345  * @resp_ie_len: assoc response IEs length
6346  * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6347  *	%WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6348  *	the real status code for failures. If this call is used to report a
6349  *	failure due to a timeout (e.g., not receiving an Authentication frame
6350  *	from the AP) instead of an explicit rejection by the AP, -1 is used to
6351  *	indicate that this is a failure, but without a status code.
6352  *	@timeout_reason is used to report the reason for the timeout in that
6353  *	case.
6354  * @gfp: allocation flags
6355  * @timeout_reason: reason for connection timeout. This is used when the
6356  *	connection fails due to a timeout instead of an explicit rejection from
6357  *	the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6358  *	not known. This value is used only if @status < 0 to indicate that the
6359  *	failure is due to a timeout and not due to explicit rejection by the AP.
6360  *	This value is ignored in other cases (@status >= 0).
6361  *
6362  * It should be called by the underlying driver once execution of the connection
6363  * request from connect() has been completed. This is similar to
6364  * cfg80211_connect_result(), but with the option of identifying the exact bss
6365  * entry for the connection. Only one of the functions among
6366  * cfg80211_connect_bss(), cfg80211_connect_result(),
6367  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6368  */
6369 static inline void
6370 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
6371 		     struct cfg80211_bss *bss, const u8 *req_ie,
6372 		     size_t req_ie_len, const u8 *resp_ie,
6373 		     size_t resp_ie_len, int status, gfp_t gfp,
6374 		     enum nl80211_timeout_reason timeout_reason)
6375 {
6376 	struct cfg80211_connect_resp_params params;
6377 
6378 	memset(&params, 0, sizeof(params));
6379 	params.status = status;
6380 	params.bssid = bssid;
6381 	params.bss = bss;
6382 	params.req_ie = req_ie;
6383 	params.req_ie_len = req_ie_len;
6384 	params.resp_ie = resp_ie;
6385 	params.resp_ie_len = resp_ie_len;
6386 	params.timeout_reason = timeout_reason;
6387 
6388 	cfg80211_connect_done(dev, &params, gfp);
6389 }
6390 
6391 /**
6392  * cfg80211_connect_result - notify cfg80211 of connection result
6393  *
6394  * @dev: network device
6395  * @bssid: the BSSID of the AP
6396  * @req_ie: association request IEs (maybe be %NULL)
6397  * @req_ie_len: association request IEs length
6398  * @resp_ie: association response IEs (may be %NULL)
6399  * @resp_ie_len: assoc response IEs length
6400  * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6401  *	%WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6402  *	the real status code for failures.
6403  * @gfp: allocation flags
6404  *
6405  * It should be called by the underlying driver once execution of the connection
6406  * request from connect() has been completed. This is similar to
6407  * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
6408  * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
6409  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6410  */
6411 static inline void
6412 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
6413 			const u8 *req_ie, size_t req_ie_len,
6414 			const u8 *resp_ie, size_t resp_ie_len,
6415 			u16 status, gfp_t gfp)
6416 {
6417 	cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
6418 			     resp_ie_len, status, gfp,
6419 			     NL80211_TIMEOUT_UNSPECIFIED);
6420 }
6421 
6422 /**
6423  * cfg80211_connect_timeout - notify cfg80211 of connection timeout
6424  *
6425  * @dev: network device
6426  * @bssid: the BSSID of the AP
6427  * @req_ie: association request IEs (maybe be %NULL)
6428  * @req_ie_len: association request IEs length
6429  * @gfp: allocation flags
6430  * @timeout_reason: reason for connection timeout.
6431  *
6432  * It should be called by the underlying driver whenever connect() has failed
6433  * in a sequence where no explicit authentication/association rejection was
6434  * received from the AP. This could happen, e.g., due to not being able to send
6435  * out the Authentication or Association Request frame or timing out while
6436  * waiting for the response. Only one of the functions among
6437  * cfg80211_connect_bss(), cfg80211_connect_result(),
6438  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6439  */
6440 static inline void
6441 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
6442 			 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
6443 			 enum nl80211_timeout_reason timeout_reason)
6444 {
6445 	cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
6446 			     gfp, timeout_reason);
6447 }
6448 
6449 /**
6450  * struct cfg80211_roam_info - driver initiated roaming information
6451  *
6452  * @channel: the channel of the new AP
6453  * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
6454  * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
6455  * @req_ie: association request IEs (maybe be %NULL)
6456  * @req_ie_len: association request IEs length
6457  * @resp_ie: association response IEs (may be %NULL)
6458  * @resp_ie_len: assoc response IEs length
6459  * @fils: FILS related roaming information.
6460  */
6461 struct cfg80211_roam_info {
6462 	struct ieee80211_channel *channel;
6463 	struct cfg80211_bss *bss;
6464 	const u8 *bssid;
6465 	const u8 *req_ie;
6466 	size_t req_ie_len;
6467 	const u8 *resp_ie;
6468 	size_t resp_ie_len;
6469 	struct cfg80211_fils_resp_params fils;
6470 };
6471 
6472 /**
6473  * cfg80211_roamed - notify cfg80211 of roaming
6474  *
6475  * @dev: network device
6476  * @info: information about the new BSS. struct &cfg80211_roam_info.
6477  * @gfp: allocation flags
6478  *
6479  * This function may be called with the driver passing either the BSSID of the
6480  * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
6481  * It should be called by the underlying driver whenever it roamed from one AP
6482  * to another while connected. Drivers which have roaming implemented in
6483  * firmware should pass the bss entry to avoid a race in bss entry timeout where
6484  * the bss entry of the new AP is seen in the driver, but gets timed out by the
6485  * time it is accessed in __cfg80211_roamed() due to delay in scheduling
6486  * rdev->event_work. In case of any failures, the reference is released
6487  * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
6488  * released while diconneting from the current bss.
6489  */
6490 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
6491 		     gfp_t gfp);
6492 
6493 /**
6494  * cfg80211_port_authorized - notify cfg80211 of successful security association
6495  *
6496  * @dev: network device
6497  * @bssid: the BSSID of the AP
6498  * @gfp: allocation flags
6499  *
6500  * This function should be called by a driver that supports 4 way handshake
6501  * offload after a security association was successfully established (i.e.,
6502  * the 4 way handshake was completed successfully). The call to this function
6503  * should be preceded with a call to cfg80211_connect_result(),
6504  * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
6505  * indicate the 802.11 association.
6506  */
6507 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
6508 			      gfp_t gfp);
6509 
6510 /**
6511  * cfg80211_disconnected - notify cfg80211 that connection was dropped
6512  *
6513  * @dev: network device
6514  * @ie: information elements of the deauth/disassoc frame (may be %NULL)
6515  * @ie_len: length of IEs
6516  * @reason: reason code for the disconnection, set it to 0 if unknown
6517  * @locally_generated: disconnection was requested locally
6518  * @gfp: allocation flags
6519  *
6520  * After it calls this function, the driver should enter an idle state
6521  * and not try to connect to any AP any more.
6522  */
6523 void cfg80211_disconnected(struct net_device *dev, u16 reason,
6524 			   const u8 *ie, size_t ie_len,
6525 			   bool locally_generated, gfp_t gfp);
6526 
6527 /**
6528  * cfg80211_ready_on_channel - notification of remain_on_channel start
6529  * @wdev: wireless device
6530  * @cookie: the request cookie
6531  * @chan: The current channel (from remain_on_channel request)
6532  * @duration: Duration in milliseconds that the driver intents to remain on the
6533  *	channel
6534  * @gfp: allocation flags
6535  */
6536 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
6537 			       struct ieee80211_channel *chan,
6538 			       unsigned int duration, gfp_t gfp);
6539 
6540 /**
6541  * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
6542  * @wdev: wireless device
6543  * @cookie: the request cookie
6544  * @chan: The current channel (from remain_on_channel request)
6545  * @gfp: allocation flags
6546  */
6547 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
6548 					struct ieee80211_channel *chan,
6549 					gfp_t gfp);
6550 
6551 /**
6552  * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
6553  * @wdev: wireless device
6554  * @cookie: the requested cookie
6555  * @chan: The current channel (from tx_mgmt request)
6556  * @gfp: allocation flags
6557  */
6558 void cfg80211_tx_mgmt_expired(struct wireless_dev *wdev, u64 cookie,
6559 			      struct ieee80211_channel *chan, gfp_t gfp);
6560 
6561 /**
6562  * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
6563  *
6564  * @sinfo: the station information
6565  * @gfp: allocation flags
6566  */
6567 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
6568 
6569 /**
6570  * cfg80211_sinfo_release_content - release contents of station info
6571  * @sinfo: the station information
6572  *
6573  * Releases any potentially allocated sub-information of the station
6574  * information, but not the struct itself (since it's typically on
6575  * the stack.)
6576  */
6577 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
6578 {
6579 	kfree(sinfo->pertid);
6580 }
6581 
6582 /**
6583  * cfg80211_new_sta - notify userspace about station
6584  *
6585  * @dev: the netdev
6586  * @mac_addr: the station's address
6587  * @sinfo: the station information
6588  * @gfp: allocation flags
6589  */
6590 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
6591 		      struct station_info *sinfo, gfp_t gfp);
6592 
6593 /**
6594  * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
6595  * @dev: the netdev
6596  * @mac_addr: the station's address
6597  * @sinfo: the station information/statistics
6598  * @gfp: allocation flags
6599  */
6600 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
6601 			    struct station_info *sinfo, gfp_t gfp);
6602 
6603 /**
6604  * cfg80211_del_sta - notify userspace about deletion of a station
6605  *
6606  * @dev: the netdev
6607  * @mac_addr: the station's address
6608  * @gfp: allocation flags
6609  */
6610 static inline void cfg80211_del_sta(struct net_device *dev,
6611 				    const u8 *mac_addr, gfp_t gfp)
6612 {
6613 	cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
6614 }
6615 
6616 /**
6617  * cfg80211_conn_failed - connection request failed notification
6618  *
6619  * @dev: the netdev
6620  * @mac_addr: the station's address
6621  * @reason: the reason for connection failure
6622  * @gfp: allocation flags
6623  *
6624  * Whenever a station tries to connect to an AP and if the station
6625  * could not connect to the AP as the AP has rejected the connection
6626  * for some reasons, this function is called.
6627  *
6628  * The reason for connection failure can be any of the value from
6629  * nl80211_connect_failed_reason enum
6630  */
6631 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
6632 			  enum nl80211_connect_failed_reason reason,
6633 			  gfp_t gfp);
6634 
6635 /**
6636  * cfg80211_rx_mgmt - notification of received, unprocessed management frame
6637  * @wdev: wireless device receiving the frame
6638  * @freq: Frequency on which the frame was received in MHz
6639  * @sig_dbm: signal strength in dBm, or 0 if unknown
6640  * @buf: Management frame (header + body)
6641  * @len: length of the frame data
6642  * @flags: flags, as defined in enum nl80211_rxmgmt_flags
6643  *
6644  * This function is called whenever an Action frame is received for a station
6645  * mode interface, but is not processed in kernel.
6646  *
6647  * Return: %true if a user space application has registered for this frame.
6648  * For action frames, that makes it responsible for rejecting unrecognized
6649  * action frames; %false otherwise, in which case for action frames the
6650  * driver is responsible for rejecting the frame.
6651  */
6652 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
6653 		      const u8 *buf, size_t len, u32 flags);
6654 
6655 /**
6656  * cfg80211_mgmt_tx_status - notification of TX status for management frame
6657  * @wdev: wireless device receiving the frame
6658  * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
6659  * @buf: Management frame (header + body)
6660  * @len: length of the frame data
6661  * @ack: Whether frame was acknowledged
6662  * @gfp: context flags
6663  *
6664  * This function is called whenever a management frame was requested to be
6665  * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
6666  * transmission attempt.
6667  */
6668 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
6669 			     const u8 *buf, size_t len, bool ack, gfp_t gfp);
6670 
6671 
6672 /**
6673  * cfg80211_rx_control_port - notification about a received control port frame
6674  * @dev: The device the frame matched to
6675  * @skb: The skbuf with the control port frame.  It is assumed that the skbuf
6676  *	is 802.3 formatted (with 802.3 header).  The skb can be non-linear.
6677  *	This function does not take ownership of the skb, so the caller is
6678  *	responsible for any cleanup.  The caller must also ensure that
6679  *	skb->protocol is set appropriately.
6680  * @unencrypted: Whether the frame was received unencrypted
6681  *
6682  * This function is used to inform userspace about a received control port
6683  * frame.  It should only be used if userspace indicated it wants to receive
6684  * control port frames over nl80211.
6685  *
6686  * The frame is the data portion of the 802.3 or 802.11 data frame with all
6687  * network layer headers removed (e.g. the raw EAPoL frame).
6688  *
6689  * Return: %true if the frame was passed to userspace
6690  */
6691 bool cfg80211_rx_control_port(struct net_device *dev,
6692 			      struct sk_buff *skb, bool unencrypted);
6693 
6694 /**
6695  * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
6696  * @dev: network device
6697  * @rssi_event: the triggered RSSI event
6698  * @rssi_level: new RSSI level value or 0 if not available
6699  * @gfp: context flags
6700  *
6701  * This function is called when a configured connection quality monitoring
6702  * rssi threshold reached event occurs.
6703  */
6704 void cfg80211_cqm_rssi_notify(struct net_device *dev,
6705 			      enum nl80211_cqm_rssi_threshold_event rssi_event,
6706 			      s32 rssi_level, gfp_t gfp);
6707 
6708 /**
6709  * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
6710  * @dev: network device
6711  * @peer: peer's MAC address
6712  * @num_packets: how many packets were lost -- should be a fixed threshold
6713  *	but probably no less than maybe 50, or maybe a throughput dependent
6714  *	threshold (to account for temporary interference)
6715  * @gfp: context flags
6716  */
6717 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
6718 				 const u8 *peer, u32 num_packets, gfp_t gfp);
6719 
6720 /**
6721  * cfg80211_cqm_txe_notify - TX error rate event
6722  * @dev: network device
6723  * @peer: peer's MAC address
6724  * @num_packets: how many packets were lost
6725  * @rate: % of packets which failed transmission
6726  * @intvl: interval (in s) over which the TX failure threshold was breached.
6727  * @gfp: context flags
6728  *
6729  * Notify userspace when configured % TX failures over number of packets in a
6730  * given interval is exceeded.
6731  */
6732 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
6733 			     u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
6734 
6735 /**
6736  * cfg80211_cqm_beacon_loss_notify - beacon loss event
6737  * @dev: network device
6738  * @gfp: context flags
6739  *
6740  * Notify userspace about beacon loss from the connected AP.
6741  */
6742 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
6743 
6744 /**
6745  * cfg80211_radar_event - radar detection event
6746  * @wiphy: the wiphy
6747  * @chandef: chandef for the current channel
6748  * @gfp: context flags
6749  *
6750  * This function is called when a radar is detected on the current chanenl.
6751  */
6752 void cfg80211_radar_event(struct wiphy *wiphy,
6753 			  struct cfg80211_chan_def *chandef, gfp_t gfp);
6754 
6755 /**
6756  * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
6757  * @dev: network device
6758  * @mac: MAC address of a station which opmode got modified
6759  * @sta_opmode: station's current opmode value
6760  * @gfp: context flags
6761  *
6762  * Driver should call this function when station's opmode modified via action
6763  * frame.
6764  */
6765 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
6766 				       struct sta_opmode_info *sta_opmode,
6767 				       gfp_t gfp);
6768 
6769 /**
6770  * cfg80211_cac_event - Channel availability check (CAC) event
6771  * @netdev: network device
6772  * @chandef: chandef for the current channel
6773  * @event: type of event
6774  * @gfp: context flags
6775  *
6776  * This function is called when a Channel availability check (CAC) is finished
6777  * or aborted. This must be called to notify the completion of a CAC process,
6778  * also by full-MAC drivers.
6779  */
6780 void cfg80211_cac_event(struct net_device *netdev,
6781 			const struct cfg80211_chan_def *chandef,
6782 			enum nl80211_radar_event event, gfp_t gfp);
6783 
6784 
6785 /**
6786  * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
6787  * @dev: network device
6788  * @bssid: BSSID of AP (to avoid races)
6789  * @replay_ctr: new replay counter
6790  * @gfp: allocation flags
6791  */
6792 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
6793 			       const u8 *replay_ctr, gfp_t gfp);
6794 
6795 /**
6796  * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
6797  * @dev: network device
6798  * @index: candidate index (the smaller the index, the higher the priority)
6799  * @bssid: BSSID of AP
6800  * @preauth: Whether AP advertises support for RSN pre-authentication
6801  * @gfp: allocation flags
6802  */
6803 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
6804 				     const u8 *bssid, bool preauth, gfp_t gfp);
6805 
6806 /**
6807  * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
6808  * @dev: The device the frame matched to
6809  * @addr: the transmitter address
6810  * @gfp: context flags
6811  *
6812  * This function is used in AP mode (only!) to inform userspace that
6813  * a spurious class 3 frame was received, to be able to deauth the
6814  * sender.
6815  * Return: %true if the frame was passed to userspace (or this failed
6816  * for a reason other than not having a subscription.)
6817  */
6818 bool cfg80211_rx_spurious_frame(struct net_device *dev,
6819 				const u8 *addr, gfp_t gfp);
6820 
6821 /**
6822  * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
6823  * @dev: The device the frame matched to
6824  * @addr: the transmitter address
6825  * @gfp: context flags
6826  *
6827  * This function is used in AP mode (only!) to inform userspace that
6828  * an associated station sent a 4addr frame but that wasn't expected.
6829  * It is allowed and desirable to send this event only once for each
6830  * station to avoid event flooding.
6831  * Return: %true if the frame was passed to userspace (or this failed
6832  * for a reason other than not having a subscription.)
6833  */
6834 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
6835 					const u8 *addr, gfp_t gfp);
6836 
6837 /**
6838  * cfg80211_probe_status - notify userspace about probe status
6839  * @dev: the device the probe was sent on
6840  * @addr: the address of the peer
6841  * @cookie: the cookie filled in @probe_client previously
6842  * @acked: indicates whether probe was acked or not
6843  * @ack_signal: signal strength (in dBm) of the ACK frame.
6844  * @is_valid_ack_signal: indicates the ack_signal is valid or not.
6845  * @gfp: allocation flags
6846  */
6847 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
6848 			   u64 cookie, bool acked, s32 ack_signal,
6849 			   bool is_valid_ack_signal, gfp_t gfp);
6850 
6851 /**
6852  * cfg80211_report_obss_beacon - report beacon from other APs
6853  * @wiphy: The wiphy that received the beacon
6854  * @frame: the frame
6855  * @len: length of the frame
6856  * @freq: frequency the frame was received on
6857  * @sig_dbm: signal strength in dBm, or 0 if unknown
6858  *
6859  * Use this function to report to userspace when a beacon was
6860  * received. It is not useful to call this when there is no
6861  * netdev that is in AP/GO mode.
6862  */
6863 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
6864 				 const u8 *frame, size_t len,
6865 				 int freq, int sig_dbm);
6866 
6867 /**
6868  * cfg80211_reg_can_beacon - check if beaconing is allowed
6869  * @wiphy: the wiphy
6870  * @chandef: the channel definition
6871  * @iftype: interface type
6872  *
6873  * Return: %true if there is no secondary channel or the secondary channel(s)
6874  * can be used for beaconing (i.e. is not a radar channel etc.)
6875  */
6876 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
6877 			     struct cfg80211_chan_def *chandef,
6878 			     enum nl80211_iftype iftype);
6879 
6880 /**
6881  * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
6882  * @wiphy: the wiphy
6883  * @chandef: the channel definition
6884  * @iftype: interface type
6885  *
6886  * Return: %true if there is no secondary channel or the secondary channel(s)
6887  * can be used for beaconing (i.e. is not a radar channel etc.). This version
6888  * also checks if IR-relaxation conditions apply, to allow beaconing under
6889  * more permissive conditions.
6890  *
6891  * Requires the RTNL to be held.
6892  */
6893 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
6894 				   struct cfg80211_chan_def *chandef,
6895 				   enum nl80211_iftype iftype);
6896 
6897 /*
6898  * cfg80211_ch_switch_notify - update wdev channel and notify userspace
6899  * @dev: the device which switched channels
6900  * @chandef: the new channel definition
6901  *
6902  * Caller must acquire wdev_lock, therefore must only be called from sleepable
6903  * driver context!
6904  */
6905 void cfg80211_ch_switch_notify(struct net_device *dev,
6906 			       struct cfg80211_chan_def *chandef);
6907 
6908 /*
6909  * cfg80211_ch_switch_started_notify - notify channel switch start
6910  * @dev: the device on which the channel switch started
6911  * @chandef: the future channel definition
6912  * @count: the number of TBTTs until the channel switch happens
6913  *
6914  * Inform the userspace about the channel switch that has just
6915  * started, so that it can take appropriate actions (eg. starting
6916  * channel switch on other vifs), if necessary.
6917  */
6918 void cfg80211_ch_switch_started_notify(struct net_device *dev,
6919 				       struct cfg80211_chan_def *chandef,
6920 				       u8 count);
6921 
6922 /**
6923  * ieee80211_operating_class_to_band - convert operating class to band
6924  *
6925  * @operating_class: the operating class to convert
6926  * @band: band pointer to fill
6927  *
6928  * Returns %true if the conversion was successful, %false otherwise.
6929  */
6930 bool ieee80211_operating_class_to_band(u8 operating_class,
6931 				       enum nl80211_band *band);
6932 
6933 /**
6934  * ieee80211_chandef_to_operating_class - convert chandef to operation class
6935  *
6936  * @chandef: the chandef to convert
6937  * @op_class: a pointer to the resulting operating class
6938  *
6939  * Returns %true if the conversion was successful, %false otherwise.
6940  */
6941 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
6942 					  u8 *op_class);
6943 
6944 /*
6945  * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
6946  * @dev: the device on which the operation is requested
6947  * @peer: the MAC address of the peer device
6948  * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
6949  *	NL80211_TDLS_TEARDOWN)
6950  * @reason_code: the reason code for teardown request
6951  * @gfp: allocation flags
6952  *
6953  * This function is used to request userspace to perform TDLS operation that
6954  * requires knowledge of keys, i.e., link setup or teardown when the AP
6955  * connection uses encryption. This is optional mechanism for the driver to use
6956  * if it can automatically determine when a TDLS link could be useful (e.g.,
6957  * based on traffic and signal strength for a peer).
6958  */
6959 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
6960 				enum nl80211_tdls_operation oper,
6961 				u16 reason_code, gfp_t gfp);
6962 
6963 /*
6964  * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
6965  * @rate: given rate_info to calculate bitrate from
6966  *
6967  * return 0 if MCS index >= 32
6968  */
6969 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
6970 
6971 /**
6972  * cfg80211_unregister_wdev - remove the given wdev
6973  * @wdev: struct wireless_dev to remove
6974  *
6975  * Call this function only for wdevs that have no netdev assigned,
6976  * e.g. P2P Devices. It removes the device from the list so that
6977  * it can no longer be used. It is necessary to call this function
6978  * even when cfg80211 requests the removal of the interface by
6979  * calling the del_virtual_intf() callback. The function must also
6980  * be called when the driver wishes to unregister the wdev, e.g.
6981  * when the device is unbound from the driver.
6982  *
6983  * Requires the RTNL to be held.
6984  */
6985 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
6986 
6987 /**
6988  * struct cfg80211_ft_event - FT Information Elements
6989  * @ies: FT IEs
6990  * @ies_len: length of the FT IE in bytes
6991  * @target_ap: target AP's MAC address
6992  * @ric_ies: RIC IE
6993  * @ric_ies_len: length of the RIC IE in bytes
6994  */
6995 struct cfg80211_ft_event_params {
6996 	const u8 *ies;
6997 	size_t ies_len;
6998 	const u8 *target_ap;
6999 	const u8 *ric_ies;
7000 	size_t ric_ies_len;
7001 };
7002 
7003 /**
7004  * cfg80211_ft_event - notify userspace about FT IE and RIC IE
7005  * @netdev: network device
7006  * @ft_event: IE information
7007  */
7008 void cfg80211_ft_event(struct net_device *netdev,
7009 		       struct cfg80211_ft_event_params *ft_event);
7010 
7011 /**
7012  * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
7013  * @ies: the input IE buffer
7014  * @len: the input length
7015  * @attr: the attribute ID to find
7016  * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
7017  *	if the function is only called to get the needed buffer size
7018  * @bufsize: size of the output buffer
7019  *
7020  * The function finds a given P2P attribute in the (vendor) IEs and
7021  * copies its contents to the given buffer.
7022  *
7023  * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
7024  * malformed or the attribute can't be found (respectively), or the
7025  * length of the found attribute (which can be zero).
7026  */
7027 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
7028 			  enum ieee80211_p2p_attr_id attr,
7029 			  u8 *buf, unsigned int bufsize);
7030 
7031 /**
7032  * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
7033  * @ies: the IE buffer
7034  * @ielen: the length of the IE buffer
7035  * @ids: an array with element IDs that are allowed before
7036  *	the split. A WLAN_EID_EXTENSION value means that the next
7037  *	EID in the list is a sub-element of the EXTENSION IE.
7038  * @n_ids: the size of the element ID array
7039  * @after_ric: array IE types that come after the RIC element
7040  * @n_after_ric: size of the @after_ric array
7041  * @offset: offset where to start splitting in the buffer
7042  *
7043  * This function splits an IE buffer by updating the @offset
7044  * variable to point to the location where the buffer should be
7045  * split.
7046  *
7047  * It assumes that the given IE buffer is well-formed, this
7048  * has to be guaranteed by the caller!
7049  *
7050  * It also assumes that the IEs in the buffer are ordered
7051  * correctly, if not the result of using this function will not
7052  * be ordered correctly either, i.e. it does no reordering.
7053  *
7054  * The function returns the offset where the next part of the
7055  * buffer starts, which may be @ielen if the entire (remainder)
7056  * of the buffer should be used.
7057  */
7058 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
7059 			      const u8 *ids, int n_ids,
7060 			      const u8 *after_ric, int n_after_ric,
7061 			      size_t offset);
7062 
7063 /**
7064  * ieee80211_ie_split - split an IE buffer according to ordering
7065  * @ies: the IE buffer
7066  * @ielen: the length of the IE buffer
7067  * @ids: an array with element IDs that are allowed before
7068  *	the split. A WLAN_EID_EXTENSION value means that the next
7069  *	EID in the list is a sub-element of the EXTENSION IE.
7070  * @n_ids: the size of the element ID array
7071  * @offset: offset where to start splitting in the buffer
7072  *
7073  * This function splits an IE buffer by updating the @offset
7074  * variable to point to the location where the buffer should be
7075  * split.
7076  *
7077  * It assumes that the given IE buffer is well-formed, this
7078  * has to be guaranteed by the caller!
7079  *
7080  * It also assumes that the IEs in the buffer are ordered
7081  * correctly, if not the result of using this function will not
7082  * be ordered correctly either, i.e. it does no reordering.
7083  *
7084  * The function returns the offset where the next part of the
7085  * buffer starts, which may be @ielen if the entire (remainder)
7086  * of the buffer should be used.
7087  */
7088 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
7089 					const u8 *ids, int n_ids, size_t offset)
7090 {
7091 	return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
7092 }
7093 
7094 /**
7095  * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
7096  * @wdev: the wireless device reporting the wakeup
7097  * @wakeup: the wakeup report
7098  * @gfp: allocation flags
7099  *
7100  * This function reports that the given device woke up. If it
7101  * caused the wakeup, report the reason(s), otherwise you may
7102  * pass %NULL as the @wakeup parameter to advertise that something
7103  * else caused the wakeup.
7104  */
7105 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
7106 				   struct cfg80211_wowlan_wakeup *wakeup,
7107 				   gfp_t gfp);
7108 
7109 /**
7110  * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
7111  *
7112  * @wdev: the wireless device for which critical protocol is stopped.
7113  * @gfp: allocation flags
7114  *
7115  * This function can be called by the driver to indicate it has reverted
7116  * operation back to normal. One reason could be that the duration given
7117  * by .crit_proto_start() has expired.
7118  */
7119 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
7120 
7121 /**
7122  * ieee80211_get_num_supported_channels - get number of channels device has
7123  * @wiphy: the wiphy
7124  *
7125  * Return: the number of channels supported by the device.
7126  */
7127 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
7128 
7129 /**
7130  * cfg80211_check_combinations - check interface combinations
7131  *
7132  * @wiphy: the wiphy
7133  * @params: the interface combinations parameter
7134  *
7135  * This function can be called by the driver to check whether a
7136  * combination of interfaces and their types are allowed according to
7137  * the interface combinations.
7138  */
7139 int cfg80211_check_combinations(struct wiphy *wiphy,
7140 				struct iface_combination_params *params);
7141 
7142 /**
7143  * cfg80211_iter_combinations - iterate over matching combinations
7144  *
7145  * @wiphy: the wiphy
7146  * @params: the interface combinations parameter
7147  * @iter: function to call for each matching combination
7148  * @data: pointer to pass to iter function
7149  *
7150  * This function can be called by the driver to check what possible
7151  * combinations it fits in at a given moment, e.g. for channel switching
7152  * purposes.
7153  */
7154 int cfg80211_iter_combinations(struct wiphy *wiphy,
7155 			       struct iface_combination_params *params,
7156 			       void (*iter)(const struct ieee80211_iface_combination *c,
7157 					    void *data),
7158 			       void *data);
7159 
7160 /*
7161  * cfg80211_stop_iface - trigger interface disconnection
7162  *
7163  * @wiphy: the wiphy
7164  * @wdev: wireless device
7165  * @gfp: context flags
7166  *
7167  * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
7168  * disconnected.
7169  *
7170  * Note: This doesn't need any locks and is asynchronous.
7171  */
7172 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
7173 			 gfp_t gfp);
7174 
7175 /**
7176  * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
7177  * @wiphy: the wiphy to shut down
7178  *
7179  * This function shuts down all interfaces belonging to this wiphy by
7180  * calling dev_close() (and treating non-netdev interfaces as needed).
7181  * It shouldn't really be used unless there are some fatal device errors
7182  * that really can't be recovered in any other way.
7183  *
7184  * Callers must hold the RTNL and be able to deal with callbacks into
7185  * the driver while the function is running.
7186  */
7187 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
7188 
7189 /**
7190  * wiphy_ext_feature_set - set the extended feature flag
7191  *
7192  * @wiphy: the wiphy to modify.
7193  * @ftidx: extended feature bit index.
7194  *
7195  * The extended features are flagged in multiple bytes (see
7196  * &struct wiphy.@ext_features)
7197  */
7198 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
7199 					 enum nl80211_ext_feature_index ftidx)
7200 {
7201 	u8 *ft_byte;
7202 
7203 	ft_byte = &wiphy->ext_features[ftidx / 8];
7204 	*ft_byte |= BIT(ftidx % 8);
7205 }
7206 
7207 /**
7208  * wiphy_ext_feature_isset - check the extended feature flag
7209  *
7210  * @wiphy: the wiphy to modify.
7211  * @ftidx: extended feature bit index.
7212  *
7213  * The extended features are flagged in multiple bytes (see
7214  * &struct wiphy.@ext_features)
7215  */
7216 static inline bool
7217 wiphy_ext_feature_isset(struct wiphy *wiphy,
7218 			enum nl80211_ext_feature_index ftidx)
7219 {
7220 	u8 ft_byte;
7221 
7222 	ft_byte = wiphy->ext_features[ftidx / 8];
7223 	return (ft_byte & BIT(ftidx % 8)) != 0;
7224 }
7225 
7226 /**
7227  * cfg80211_free_nan_func - free NAN function
7228  * @f: NAN function that should be freed
7229  *
7230  * Frees all the NAN function and all it's allocated members.
7231  */
7232 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
7233 
7234 /**
7235  * struct cfg80211_nan_match_params - NAN match parameters
7236  * @type: the type of the function that triggered a match. If it is
7237  *	 %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
7238  *	 If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
7239  *	 result.
7240  *	 If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
7241  * @inst_id: the local instance id
7242  * @peer_inst_id: the instance id of the peer's function
7243  * @addr: the MAC address of the peer
7244  * @info_len: the length of the &info
7245  * @info: the Service Specific Info from the peer (if any)
7246  * @cookie: unique identifier of the corresponding function
7247  */
7248 struct cfg80211_nan_match_params {
7249 	enum nl80211_nan_function_type type;
7250 	u8 inst_id;
7251 	u8 peer_inst_id;
7252 	const u8 *addr;
7253 	u8 info_len;
7254 	const u8 *info;
7255 	u64 cookie;
7256 };
7257 
7258 /**
7259  * cfg80211_nan_match - report a match for a NAN function.
7260  * @wdev: the wireless device reporting the match
7261  * @match: match notification parameters
7262  * @gfp: allocation flags
7263  *
7264  * This function reports that the a NAN function had a match. This
7265  * can be a subscribe that had a match or a solicited publish that
7266  * was sent. It can also be a follow up that was received.
7267  */
7268 void cfg80211_nan_match(struct wireless_dev *wdev,
7269 			struct cfg80211_nan_match_params *match, gfp_t gfp);
7270 
7271 /**
7272  * cfg80211_nan_func_terminated - notify about NAN function termination.
7273  *
7274  * @wdev: the wireless device reporting the match
7275  * @inst_id: the local instance id
7276  * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
7277  * @cookie: unique NAN function identifier
7278  * @gfp: allocation flags
7279  *
7280  * This function reports that the a NAN function is terminated.
7281  */
7282 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
7283 				  u8 inst_id,
7284 				  enum nl80211_nan_func_term_reason reason,
7285 				  u64 cookie, gfp_t gfp);
7286 
7287 /* ethtool helper */
7288 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
7289 
7290 /**
7291  * cfg80211_external_auth_request - userspace request for authentication
7292  * @netdev: network device
7293  * @params: External authentication parameters
7294  * @gfp: allocation flags
7295  * Returns: 0 on success, < 0 on error
7296  */
7297 int cfg80211_external_auth_request(struct net_device *netdev,
7298 				   struct cfg80211_external_auth_params *params,
7299 				   gfp_t gfp);
7300 
7301 /**
7302  * cfg80211_pmsr_report - report peer measurement result data
7303  * @wdev: the wireless device reporting the measurement
7304  * @req: the original measurement request
7305  * @result: the result data
7306  * @gfp: allocation flags
7307  */
7308 void cfg80211_pmsr_report(struct wireless_dev *wdev,
7309 			  struct cfg80211_pmsr_request *req,
7310 			  struct cfg80211_pmsr_result *result,
7311 			  gfp_t gfp);
7312 
7313 /**
7314  * cfg80211_pmsr_complete - report peer measurement completed
7315  * @wdev: the wireless device reporting the measurement
7316  * @req: the original measurement request
7317  * @gfp: allocation flags
7318  *
7319  * Report that the entire measurement completed, after this
7320  * the request pointer will no longer be valid.
7321  */
7322 void cfg80211_pmsr_complete(struct wireless_dev *wdev,
7323 			    struct cfg80211_pmsr_request *req,
7324 			    gfp_t gfp);
7325 
7326 /* Logging, debugging and troubleshooting/diagnostic helpers. */
7327 
7328 /* wiphy_printk helpers, similar to dev_printk */
7329 
7330 #define wiphy_printk(level, wiphy, format, args...)		\
7331 	dev_printk(level, &(wiphy)->dev, format, ##args)
7332 #define wiphy_emerg(wiphy, format, args...)			\
7333 	dev_emerg(&(wiphy)->dev, format, ##args)
7334 #define wiphy_alert(wiphy, format, args...)			\
7335 	dev_alert(&(wiphy)->dev, format, ##args)
7336 #define wiphy_crit(wiphy, format, args...)			\
7337 	dev_crit(&(wiphy)->dev, format, ##args)
7338 #define wiphy_err(wiphy, format, args...)			\
7339 	dev_err(&(wiphy)->dev, format, ##args)
7340 #define wiphy_warn(wiphy, format, args...)			\
7341 	dev_warn(&(wiphy)->dev, format, ##args)
7342 #define wiphy_notice(wiphy, format, args...)			\
7343 	dev_notice(&(wiphy)->dev, format, ##args)
7344 #define wiphy_info(wiphy, format, args...)			\
7345 	dev_info(&(wiphy)->dev, format, ##args)
7346 
7347 #define wiphy_err_ratelimited(wiphy, format, args...)		\
7348 	dev_err_ratelimited(&(wiphy)->dev, format, ##args)
7349 #define wiphy_warn_ratelimited(wiphy, format, args...)		\
7350 	dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
7351 
7352 #define wiphy_debug(wiphy, format, args...)			\
7353 	wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
7354 
7355 #define wiphy_dbg(wiphy, format, args...)			\
7356 	dev_dbg(&(wiphy)->dev, format, ##args)
7357 
7358 #if defined(VERBOSE_DEBUG)
7359 #define wiphy_vdbg	wiphy_dbg
7360 #else
7361 #define wiphy_vdbg(wiphy, format, args...)				\
7362 ({									\
7363 	if (0)								\
7364 		wiphy_printk(KERN_DEBUG, wiphy, format, ##args);	\
7365 	0;								\
7366 })
7367 #endif
7368 
7369 /*
7370  * wiphy_WARN() acts like wiphy_printk(), but with the key difference
7371  * of using a WARN/WARN_ON to get the message out, including the
7372  * file/line information and a backtrace.
7373  */
7374 #define wiphy_WARN(wiphy, format, args...)			\
7375 	WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
7376 
7377 /**
7378  * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
7379  * @netdev: network device
7380  * @owe_info: peer's owe info
7381  * @gfp: allocation flags
7382  */
7383 void cfg80211_update_owe_info_event(struct net_device *netdev,
7384 				    struct cfg80211_update_owe_info *owe_info,
7385 				    gfp_t gfp);
7386 
7387 #endif /* __NET_CFG80211_H */
7388