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