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