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