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