• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Driver interface definition
3  * Copyright (c) 2003-2017, Jouni Malinen <j@w1.fi>
4  *
5  * This software may be distributed under the terms of the BSD license.
6  * See README for more details.
7  *
8  * This file defines a driver interface used by both %wpa_supplicant and
9  * hostapd. The first part of the file defines data structures used in various
10  * driver operations. This is followed by the struct wpa_driver_ops that each
11  * driver wrapper will beed to define with callback functions for requesting
12  * driver operations. After this, there are definitions for driver event
13  * reporting with wpa_supplicant_event() and some convenience helper functions
14  * that can be used to report events.
15  */
16 
17 #ifndef DRIVER_H
18 #define DRIVER_H
19 
20 #define WPA_SUPPLICANT_DRIVER_VERSION 4
21 
22 #include "common/defs.h"
23 #include "common/ieee802_11_defs.h"
24 #include "common/wpa_common.h"
25 #ifdef CONFIG_MACSEC
26 #include "pae/ieee802_1x_kay.h"
27 #endif /* CONFIG_MACSEC */
28 #include "utils/list.h"
29 
30 #define HOSTAPD_CHAN_DISABLED 0x00000001
31 #define HOSTAPD_CHAN_NO_IR 0x00000002
32 #define HOSTAPD_CHAN_RADAR 0x00000008
33 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
34 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
35 #define HOSTAPD_CHAN_HT40 0x00000040
36 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
37 
38 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
39 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
40 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
41 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
42 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
43 
44 #define HOSTAPD_CHAN_VHT_80MHZ_SUBCHANNEL 0x00000800
45 #define HOSTAPD_CHAN_VHT_160MHZ_SUBCHANNEL 0x00001000
46 
47 #define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
48 #define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
49 
50 /* Allowed bandwidth mask */
51 enum hostapd_chan_width_attr {
52 	HOSTAPD_CHAN_WIDTH_10   = BIT(0),
53 	HOSTAPD_CHAN_WIDTH_20   = BIT(1),
54 	HOSTAPD_CHAN_WIDTH_40P  = BIT(2),
55 	HOSTAPD_CHAN_WIDTH_40M  = BIT(3),
56 	HOSTAPD_CHAN_WIDTH_80   = BIT(4),
57 	HOSTAPD_CHAN_WIDTH_160  = BIT(5),
58 	HOSTAPD_CHAN_WIDTH_320  = BIT(6),
59 };
60 
61 /* Filter gratuitous ARP */
62 #define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0)
63 /* Filter unsolicited Neighbor Advertisement */
64 #define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1)
65 /* Filter unicast IP packets encrypted using the GTK */
66 #define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2)
67 
68 #define HOSTAPD_DFS_REGION_FCC	1
69 #define HOSTAPD_DFS_REGION_ETSI	2
70 #define HOSTAPD_DFS_REGION_JP	3
71 
72 /**
73  * enum reg_change_initiator - Regulatory change initiator
74  */
75 enum reg_change_initiator {
76 	REGDOM_SET_BY_CORE,
77 	REGDOM_SET_BY_USER,
78 	REGDOM_SET_BY_DRIVER,
79 	REGDOM_SET_BY_COUNTRY_IE,
80 	REGDOM_BEACON_HINT,
81 };
82 
83 /**
84  * enum reg_type - Regulatory change types
85  */
86 enum reg_type {
87 	REGDOM_TYPE_UNKNOWN,
88 	REGDOM_TYPE_COUNTRY,
89 	REGDOM_TYPE_WORLD,
90 	REGDOM_TYPE_CUSTOM_WORLD,
91 	REGDOM_TYPE_INTERSECTION,
92 };
93 
94 /**
95  * struct hostapd_wmm_rule - WMM regulatory rule
96  * @min_cwmin: Lower bound of CW_min value
97  * @min_cwmax: Lower bound of CW_max value
98  * @min_aifs: Lower bound of AIFS value
99  * @max_txop: Upper bound of TXOP, value in units of 32 usec
100  */
101 struct hostapd_wmm_rule {
102 	int min_cwmin;
103 	int min_cwmax;
104 	int min_aifs;
105 	int max_txop;
106 };
107 
108 /**
109  * struct hostapd_channel_data - Channel information
110  */
111 struct hostapd_channel_data {
112 	/**
113 	 * chan - Channel number (IEEE 802.11)
114 	 */
115 	short chan;
116 
117 	/**
118 	 * freq - Frequency in MHz
119 	 */
120 	int freq;
121 
122 	/**
123 	 * flag - Channel flags (HOSTAPD_CHAN_*)
124 	 */
125 	int flag;
126 
127 	/**
128 	 * allowed_bw - Allowed channel width bitmask
129 	 *
130 	 * See enum hostapd_chan_width_attr.
131 	 */
132 	u32 allowed_bw;
133 
134 	/**
135 	 * max_tx_power - Regulatory transmit power limit in dBm
136 	 */
137 	u8 max_tx_power;
138 
139 	/**
140 	 * survey_list - Linked list of surveys (struct freq_survey)
141 	 */
142 	struct dl_list survey_list;
143 
144 	/**
145 	 * min_nf - Minimum observed noise floor, in dBm, based on all
146 	 * surveyed channel data
147 	 */
148 	s8 min_nf;
149 
150 #ifdef CONFIG_ACS
151 	/**
152 	 * interference_factor - Computed interference factor on this
153 	 * channel (used internally in src/ap/acs.c; driver wrappers do not
154 	 * need to set this)
155 	 */
156 	long double interference_factor;
157 #endif /* CONFIG_ACS */
158 
159 	/**
160 	 * dfs_cac_ms - DFS CAC time in milliseconds
161 	 */
162 	unsigned int dfs_cac_ms;
163 
164 	/**
165 	 * wmm_rules_valid - Indicates wmm_rules state
166 	 */
167 	int wmm_rules_valid;
168 
169 	/**
170 	 * wmm_rules - WMM regulatory rules
171 	 */
172 	struct hostapd_wmm_rule wmm_rules[WMM_AC_NUM];
173 
174 	/**
175 	 * punct_bitmap - RU puncturing bitmap
176 	 */
177 	u16 punct_bitmap;
178 };
179 
180 #define HE_MAC_CAPAB_0		0
181 #define HE_MAX_MAC_CAPAB_SIZE	6
182 #define HE_MAX_PHY_CAPAB_SIZE	11
183 #define HE_MAX_MCS_CAPAB_SIZE	12
184 #define HE_MAX_PPET_CAPAB_SIZE	25
185 
186 /**
187  * struct he_capabilities - IEEE 802.11ax HE capabilities
188  */
189 struct he_capabilities {
190 	u8 he_supported;
191 	u8 phy_cap[HE_MAX_PHY_CAPAB_SIZE];
192 	u8 mac_cap[HE_MAX_MAC_CAPAB_SIZE];
193 	u8 mcs[HE_MAX_MCS_CAPAB_SIZE];
194 	u8 ppet[HE_MAX_PPET_CAPAB_SIZE];
195 	u16 he_6ghz_capa;
196 };
197 
198 /* struct eht_capabilities - IEEE 802.11be EHT capabilities */
199 struct eht_capabilities {
200 	bool eht_supported;
201 	u16 mac_cap;
202 	u8 phy_cap[EHT_PHY_CAPAB_LEN];
203 	u8 mcs[EHT_MCS_NSS_CAPAB_LEN];
204 	u8 ppet[EHT_PPE_THRESH_CAPAB_LEN];
205 };
206 
207 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
208 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
209 #define HOSTAPD_MODE_FLAG_HE_INFO_KNOWN BIT(2)
210 
211 
212 enum ieee80211_op_mode {
213 	IEEE80211_MODE_INFRA = 0,
214 	IEEE80211_MODE_IBSS = 1,
215 	IEEE80211_MODE_AP = 2,
216 	IEEE80211_MODE_MESH = 5,
217 
218 	/* only add new entries before IEEE80211_MODE_NUM */
219 	IEEE80211_MODE_NUM
220 };
221 
222 /**
223  * struct ieee80211_edmg_config - EDMG configuration
224  *
225  * This structure describes most essential parameters needed
226  * for IEEE 802.11ay EDMG configuration
227  *
228  * @channels: Bitmap that indicates the 2.16 GHz channel(s)
229  *	that are allowed to be used for transmissions.
230  *	Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
231  *	Set to 0 to indicate EDMG not supported.
232  * @bw_config: Channel BW Configuration subfield encodes
233  *	the allowed channel bandwidth configurations
234  */
235 struct ieee80211_edmg_config {
236 	u8 channels;
237 	enum edmg_bw_config bw_config;
238 };
239 
240 /**
241  * struct hostapd_hw_modes - Supported hardware mode information
242  */
243 struct hostapd_hw_modes {
244 	/**
245 	 * mode - Hardware mode
246 	 */
247 	enum hostapd_hw_mode mode;
248 
249 	/**
250 	 * num_channels - Number of entries in the channels array
251 	 */
252 	int num_channels;
253 
254 	/**
255 	 * channels - Array of supported channels
256 	 */
257 	struct hostapd_channel_data *channels;
258 
259 	/**
260 	 * num_rates - Number of entries in the rates array
261 	 */
262 	int num_rates;
263 
264 	/**
265 	 * rates - Array of supported rates in 100 kbps units
266 	 */
267 	int *rates;
268 
269 	/**
270 	 * ht_capab - HT (IEEE 802.11n) capabilities
271 	 */
272 	u16 ht_capab;
273 
274 	/**
275 	 * mcs_set - MCS (IEEE 802.11n) rate parameters
276 	 */
277 	u8 mcs_set[16];
278 
279 	/**
280 	 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
281 	 */
282 	u8 a_mpdu_params;
283 
284 	/**
285 	 * vht_capab - VHT (IEEE 802.11ac) capabilities
286 	 */
287 	u32 vht_capab;
288 
289 	/**
290 	 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
291 	 */
292 	u8 vht_mcs_set[8];
293 
294 	unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
295 
296 	/**
297 	 * he_capab - HE (IEEE 802.11ax) capabilities
298 	 */
299 	struct he_capabilities he_capab[IEEE80211_MODE_NUM];
300 
301 	/**
302 	 * This structure describes the most essential parameters needed
303 	 * for IEEE 802.11ay EDMG configuration.
304 	 */
305 	struct ieee80211_edmg_config edmg;
306 
307 	/**
308 	 * eht_capab - EHT (IEEE 802.11be) capabilities
309 	 */
310 	struct eht_capabilities eht_capab[IEEE80211_MODE_NUM];
311 };
312 
313 
314 #define IEEE80211_CAP_ESS	0x0001
315 #define IEEE80211_CAP_IBSS	0x0002
316 #define IEEE80211_CAP_PRIVACY	0x0010
317 #define IEEE80211_CAP_RRM	0x1000
318 
319 /* DMG (60 GHz) IEEE 802.11ad */
320 /* type - bits 0..1 */
321 #define IEEE80211_CAP_DMG_MASK	0x0003
322 #define IEEE80211_CAP_DMG_IBSS	0x0001 /* Tx by: STA */
323 #define IEEE80211_CAP_DMG_PBSS	0x0002 /* Tx by: PCP */
324 #define IEEE80211_CAP_DMG_AP	0x0003 /* Tx by: AP */
325 
326 #define WPA_SCAN_QUAL_INVALID		BIT(0)
327 #define WPA_SCAN_NOISE_INVALID		BIT(1)
328 #define WPA_SCAN_LEVEL_INVALID		BIT(2)
329 #define WPA_SCAN_LEVEL_DBM		BIT(3)
330 #define WPA_SCAN_ASSOCIATED		BIT(5)
331 
332 /**
333  * struct wpa_scan_res - Scan result for an BSS/IBSS
334  * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
335  * @bssid: BSSID
336  * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
337  * @max_cw: the max channel width of the connection (calculated during scan
338  * result processing)
339  * @beacon_int: beacon interval in TUs (host byte order)
340  * @caps: capability information field in host byte order
341  * @qual: signal quality
342  * @noise: noise level
343  * @level: signal level
344  * @tsf: Timestamp
345  * @age: Age of the information in milliseconds (i.e., how many milliseconds
346  * ago the last Beacon or Probe Response frame was received)
347  * @est_throughput: Estimated throughput in kbps (this is calculated during
348  * scan result processing if left zero by the driver wrapper)
349  * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
350  * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
351  * of TSF of the BSS specified by %tsf_bssid.
352  * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
353  * @beacon_newer: Whether the Beacon frame data is known to be newer
354  * @ie_len: length of the following IE field in octets
355  * @beacon_ie_len: length of the following Beacon IE field in octets
356  *
357  * This structure is used as a generic format for scan results from the
358  * driver. Each driver interface implementation is responsible for converting
359  * the driver or OS specific scan results into this format.
360  *
361  * If the driver does not support reporting all IEs, the IE data structure is
362  * constructed of the IEs that are available. This field will also need to
363  * include SSID in IE format. All drivers are encouraged to be extended to
364  * report all IEs to make it easier to support future additions.
365  *
366  * This structure data is followed by ie_len octets of IEs from Probe Response
367  * frame (or if the driver does not indicate source of IEs, these may also be
368  * from Beacon frame). After the first set of IEs, another set of IEs may follow
369  * (with beacon_ie_len octets of data) if the driver provides both IE sets.
370  */
371 struct wpa_scan_res {
372 	unsigned int flags;
373 	u8 bssid[ETH_ALEN];
374 	int freq;
375 	enum chan_width max_cw;
376 	u16 beacon_int;
377 	u16 caps;
378 	int qual;
379 	int noise;
380 	int level;
381 	u64 tsf;
382 	unsigned int age;
383 	unsigned int est_throughput;
384 	int snr;
385 	u64 parent_tsf;
386 	u8 tsf_bssid[ETH_ALEN];
387 	bool beacon_newer;
388 	size_t ie_len;
389 	size_t beacon_ie_len;
390 	/* Followed by ie_len + beacon_ie_len octets of IE data */
391 };
392 
393 /**
394  * struct wpa_scan_results - Scan results
395  * @res: Array of pointers to allocated variable length scan result entries
396  * @num: Number of entries in the scan result array
397  * @fetch_time: Time when the results were fetched from the driver
398  */
399 struct wpa_scan_results {
400 	struct wpa_scan_res **res;
401 	size_t num;
402 	struct os_reltime fetch_time;
403 };
404 
405 /**
406  * struct wpa_interface_info - Network interface information
407  * @next: Pointer to the next interface or NULL if this is the last one
408  * @ifname: Interface name that can be used with init() or init2()
409  * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
410  *	not available
411  * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
412  *	is not an allocated copy, i.e., get_interfaces() caller will not free
413  *	this)
414  */
415 struct wpa_interface_info {
416 	struct wpa_interface_info *next;
417 	char *ifname;
418 	char *desc;
419 	const char *drv_name;
420 };
421 
422 #define WPAS_MAX_SCAN_SSIDS 16
423 
424 /**
425  * struct wpa_driver_scan_ssid - SSIDs to scan for
426  * @ssid - specific SSID to scan for (ProbeReq)
427  *	%NULL or zero-length SSID is used to indicate active scan
428  *	with wildcard SSID.
429  * @ssid_len - Length of the SSID in octets
430  */
431 struct wpa_driver_scan_ssid {
432 	const u8 *ssid;
433 	size_t ssid_len;
434 };
435 
436 struct t2lm_mapping {
437 	/**
438 	 * downlink - Bitmap of TIDs mapped with a link in downlink direction
439 	 */
440 	u8 downlink;
441 
442 	/**
443 	 * uplink - Bitmap of TIDs mapped with a link in uplink direction
444 	 */
445 	u8 uplink;
446 };
447 
448 /**
449  * struct wpa_driver_scan_params - Scan parameters
450  * Data for struct wpa_driver_ops::scan2().
451  */
452 struct wpa_driver_scan_params {
453 	/**
454 	 * ssids - SSIDs to scan for
455 	 */
456 	struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
457 
458 	/**
459 	 * num_ssids - Number of entries in ssids array
460 	 * Zero indicates a request for a passive scan.
461 	 */
462 	size_t num_ssids;
463 
464 	/**
465 	 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
466 	 */
467 	const u8 *extra_ies;
468 
469 	/**
470 	 * extra_ies_len - Length of extra_ies in octets
471 	 */
472 	size_t extra_ies_len;
473 
474 	/**
475 	 * freqs - Array of frequencies to scan or %NULL for all frequencies
476 	 *
477 	 * The frequency is set in MHz. The array is zero-terminated.
478 	 */
479 	int *freqs;
480 
481 	/**
482 	 * filter_ssids - Filter for reporting SSIDs
483 	 *
484 	 * This optional parameter can be used to request the driver wrapper to
485 	 * filter scan results to include only the specified SSIDs. %NULL
486 	 * indicates that no filtering is to be done. This can be used to
487 	 * reduce memory needs for scan results in environments that have large
488 	 * number of APs with different SSIDs.
489 	 *
490 	 * The driver wrapper is allowed to take this allocated buffer into its
491 	 * own use by setting the pointer to %NULL. In that case, the driver
492 	 * wrapper is responsible for freeing the buffer with os_free() once it
493 	 * is not needed anymore.
494 	 */
495 	struct wpa_driver_scan_filter {
496 		u8 ssid[SSID_MAX_LEN];
497 		size_t ssid_len;
498 	} *filter_ssids;
499 
500 	/**
501 	 * num_filter_ssids - Number of entries in filter_ssids array
502 	 */
503 	size_t num_filter_ssids;
504 
505 	/**
506 	 * filter_rssi - Filter by RSSI
507 	 *
508 	 * The driver may filter scan results in firmware to reduce host
509 	 * wakeups and thereby save power. Specify the RSSI threshold in s32
510 	 * dBm.
511 	 */
512 	s32 filter_rssi;
513 
514 	/**
515 	 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
516 	 *
517 	 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
518 	 * Mbps from the support rates element(s) in the Probe Request frames
519 	 * and not to transmit the frames at any of those rates.
520 	 */
521 	unsigned int p2p_probe:1;
522 
523 	/**
524 	 * only_new_results - Request driver to report only new results
525 	 *
526 	 * This is used to request the driver to report only BSSes that have
527 	 * been detected after this scan request has been started, i.e., to
528 	 * flush old cached BSS entries.
529 	 */
530 	unsigned int only_new_results:1;
531 
532 	/**
533 	 * low_priority - Requests driver to use a lower scan priority
534 	 *
535 	 * This is used to request the driver to use a lower scan priority
536 	 * if it supports such a thing.
537 	 */
538 	unsigned int low_priority:1;
539 
540 	/**
541 	 * mac_addr_rand - Requests driver to randomize MAC address
542 	 */
543 	unsigned int mac_addr_rand:1;
544 
545 	/**
546 	 * mac_addr - MAC address used with randomization. The address cannot be
547 	 * a multicast one, i.e., bit 0 of byte 0 should not be set.
548 	 */
549 	u8 *mac_addr;
550 
551 	/**
552 	 * mac_addr_mask - MAC address mask used with randomization.
553 	 *
554 	 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
555 	 * the mask should be taken as is from mac_addr. The mask should not
556 	 * allow the generation of a multicast address, i.e., bit 0 of byte 0
557 	 * must be set.
558 	 */
559 	const u8 *mac_addr_mask;
560 
561 	/**
562 	 * sched_scan_plans - Scan plans for scheduled scan
563 	 *
564 	 * Each scan plan consists of the number of iterations to scan and the
565 	 * interval between scans. When a scan plan finishes (i.e., it was run
566 	 * for the specified number of iterations), the next scan plan is
567 	 * executed. The scan plans are executed in the order they appear in
568 	 * the array (lower index first). The last scan plan will run infinitely
569 	 * (until requested to stop), thus must not specify the number of
570 	 * iterations. All other scan plans must specify the number of
571 	 * iterations.
572 	 */
573 	struct sched_scan_plan {
574 		 u32 interval; /* In seconds */
575 		 u32 iterations; /* Zero to run infinitely */
576 	 } *sched_scan_plans;
577 
578 	/**
579 	 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
580 	 */
581 	 unsigned int sched_scan_plans_num;
582 
583 	/**
584 	 * sched_scan_start_delay - Delay to use before starting the first scan
585 	 *
586 	 * Delay (in seconds) before scheduling first scan plan cycle. The
587 	 * driver may ignore this parameter and start immediately (or at any
588 	 * other time), if this feature is not supported.
589 	 */
590 	 u32 sched_scan_start_delay;
591 
592 	/**
593 	 * bssid - Specific BSSID to scan for
594 	 *
595 	 * This optional parameter can be used to replace the default wildcard
596 	 * BSSID with a specific BSSID to scan for if results are needed from
597 	 * only a single BSS.
598 	 */
599 	const u8 *bssid;
600 
601 	/**
602 	 * scan_cookie - Unique identification representing the scan request
603 	 *
604 	 * This scan_cookie carries a unique identification representing the
605 	 * scan request if the host driver/kernel supports concurrent scan
606 	 * requests. This cookie is returned from the corresponding driver
607 	 * interface.
608 	 *
609 	 * Note: Unlike other parameters in this structure, scan_cookie is used
610 	 * only to return information instead of setting parameters for the
611 	 * scan.
612 	 */
613 	u64 scan_cookie;
614 
615 	 /**
616 	  * duration - Dwell time on each channel
617 	  *
618 	  * This optional parameter can be used to set the dwell time on each
619 	  * channel. In TUs.
620 	  */
621 	 u16 duration;
622 
623 	 /**
624 	  * duration_mandatory - Whether the specified duration is mandatory
625 	  *
626 	  * If this is set, the duration specified by the %duration field is
627 	  * mandatory (and the driver should reject the scan request if it is
628 	  * unable to comply with the specified duration), otherwise it is the
629 	  * maximum duration and the actual duration may be shorter.
630 	  */
631 	 unsigned int duration_mandatory:1;
632 
633 	/**
634 	 * relative_rssi_set - Whether relative RSSI parameters are set
635 	 */
636 	unsigned int relative_rssi_set:1;
637 
638 	/**
639 	 * relative_rssi - Relative RSSI for reporting better BSSs
640 	 *
641 	 * Amount of RSSI by which a BSS should be better than the current
642 	 * connected BSS to report the new BSS to user space.
643 	 */
644 	s8 relative_rssi;
645 
646 	/**
647 	 * relative_adjust_band - Band to which RSSI should be adjusted
648 	 *
649 	 * The relative_adjust_rssi should be added to the band specified
650 	 * by relative_adjust_band.
651 	 */
652 	enum set_band relative_adjust_band;
653 
654 	/**
655 	 * relative_adjust_rssi - RSSI to be added to relative_adjust_band
656 	 *
657 	 * An amount of relative_band_rssi should be added to the BSSs that
658 	 * belong to the band specified by relative_adjust_band while comparing
659 	 * with other bands for BSS reporting.
660 	 */
661 	s8 relative_adjust_rssi;
662 
663 	/**
664 	 * oce_scan
665 	 *
666 	 * Enable the following OCE scan features: (WFA OCE TechSpec v1.0)
667 	 * - Accept broadcast Probe Response frame.
668 	 * - Probe Request frame deferral and suppression.
669 	 * - Max Channel Time - driver fills FILS request params IE with
670 	 *   Maximum Channel Time.
671 	 * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps.
672 	 */
673 	unsigned int oce_scan:1;
674 
675 	/**
676 	 * p2p_include_6ghz - Include 6 GHz channels for P2P full scan
677 	 *
678 	 */
679 	unsigned int p2p_include_6ghz:1;
680 
681 	/**
682 	 * non_coloc_6ghz - Force scanning of non-PSC 6 GHz channels
683 	 *
684 	 * If this is set, the driver should scan non-PSC channels from the
685 	 * scan request even if neighbor reports from 2.4/5 GHz APs did not
686 	 * report a co-located AP on these channels. The default is to scan
687 	 * non-PSC channels only if a co-located AP was reported on the channel.
688 	 */
689 	unsigned int non_coloc_6ghz:1;
690 
691 	/**
692 	 * min_probe_req_content - Minimize probe request content to only have
693 	 * minimal requirement elements, e.g., supported rates etc., and no
694 	 * additional elements other then those provided by user space.
695 	 */
696 	unsigned int min_probe_req_content:1;
697 
698 	/*
699 	 * NOTE: Whenever adding new parameters here, please make sure
700 	 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
701 	 * matching changes.
702 	 */
703 };
704 
705 /**
706  * struct wpa_driver_auth_params - Authentication parameters
707  * Data for struct wpa_driver_ops::authenticate().
708  */
709 struct wpa_driver_auth_params {
710 	int freq;
711 	const u8 *bssid;
712 	const u8 *ssid;
713 	size_t ssid_len;
714 	int auth_alg;
715 	const u8 *ie;
716 	size_t ie_len;
717 	const u8 *wep_key[4];
718 	size_t wep_key_len[4];
719 	int wep_tx_keyidx;
720 	int local_state_change;
721 
722 	/**
723 	 * p2p - Whether this connection is a P2P group
724 	 */
725 	int p2p;
726 
727 	/**
728 	 * auth_data - Additional elements for Authentication frame
729 	 *
730 	 * This buffer starts with the Authentication transaction sequence
731 	 * number field. If no special handling of such elements is needed, this
732 	 * pointer is %NULL. This is used with SAE and FILS.
733 	 */
734 	const u8 *auth_data;
735 
736 	/**
737 	 * auth_data_len - Length of auth_data buffer in octets
738 	 */
739 	size_t auth_data_len;
740 
741 	/**
742 	 * mld - Establish an MLD connection
743 	 */
744 	bool mld;
745 
746 	/**
747 	 * mld_link_id - The link ID of the MLD AP to which we are associating
748 	 */
749 	u8 mld_link_id;
750 
751 	/**
752 	 * The MLD AP address
753 	 */
754 	const u8 *ap_mld_addr;
755 };
756 
757 /**
758  * enum wps_mode - WPS mode
759  */
760 enum wps_mode {
761 	/**
762 	 * WPS_MODE_NONE - No WPS provisioning being used
763 	 */
764 	WPS_MODE_NONE,
765 
766 	/**
767 	 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
768 	 */
769 	WPS_MODE_OPEN,
770 
771 	/**
772 	 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
773 	 */
774 	WPS_MODE_PRIVACY
775 };
776 
777 /**
778  * struct hostapd_freq_params - Channel parameters
779  */
780 struct hostapd_freq_params {
781 	/**
782 	 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
783 	 */
784 	enum hostapd_hw_mode mode;
785 
786 	/**
787 	 * freq - Primary channel center frequency in MHz
788 	 */
789 	int freq;
790 
791 	/**
792 	 * channel - Channel number
793 	 */
794 	int channel;
795 
796 	/**
797 	 * ht_enabled - Whether HT is enabled
798 	 */
799 	int ht_enabled;
800 
801 	/**
802 	 * sec_channel_offset - Secondary channel offset for HT40
803 	 *
804 	 * 0 = HT40 disabled,
805 	 * -1 = HT40 enabled, secondary channel below primary,
806 	 * 1 = HT40 enabled, secondary channel above primary
807 	 */
808 	int sec_channel_offset;
809 
810 	/**
811 	 * vht_enabled - Whether VHT is enabled
812 	 */
813 	int vht_enabled;
814 
815 	/**
816 	 * he_enabled - Whether HE is enabled
817 	 */
818 	int he_enabled;
819 
820 	/**
821 	 * center_freq1 - Segment 0 center frequency in MHz
822 	 *
823 	 * Valid for both HT and VHT.
824 	 */
825 	int center_freq1;
826 
827 	/**
828 	 * center_freq2 - Segment 1 center frequency in MHz
829 	 *
830 	 * Non-zero only for bandwidth 80 and an 80+80 channel
831 	 */
832 	int center_freq2;
833 
834 	/**
835 	 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
836 	 */
837 	int bandwidth;
838 
839 	/**
840 	 * This structure describes the most essential parameters needed
841 	 * for IEEE 802.11ay EDMG configuration.
842 	 */
843 	struct ieee80211_edmg_config edmg;
844 
845 	/**
846 	 * radar_background - Whether radar/CAC background is requested
847 	 */
848 	bool radar_background;
849 
850 	/**
851 	 * eht_enabled - Whether EHT is enabled
852 	 */
853 	bool eht_enabled;
854 
855 	/**
856 	 * link_id: If >=0 indicates the link of the AP MLD to configure
857 	 */
858 	int link_id;
859 };
860 
861 /**
862  * struct wpa_driver_sta_auth_params - Authentication parameters
863  * Data for struct wpa_driver_ops::sta_auth().
864  */
865 struct wpa_driver_sta_auth_params {
866 
867 	/**
868 	 * own_addr - Source address and BSSID for authentication frame
869 	 */
870 	const u8 *own_addr;
871 
872 	/**
873 	 * addr - MAC address of the station to associate
874 	 */
875 	const u8 *addr;
876 
877 	/**
878 	 * seq - authentication sequence number
879 	 */
880 	u16 seq;
881 
882 	/**
883 	 * status - authentication response status code
884 	 */
885 	u16 status;
886 
887 	/**
888 	 * ie - authentication frame ie buffer
889 	 */
890 	const u8 *ie;
891 
892 	/**
893 	 * len - ie buffer length
894 	 */
895 	size_t len;
896 
897 	/**
898 	 * fils_auth - Indicates whether FILS authentication is being performed
899 	 */
900 	int fils_auth;
901 
902 	/**
903 	 * fils_anonce - ANonce (required for FILS)
904 	 */
905 	u8 fils_anonce[WPA_NONCE_LEN];
906 
907 	/**
908 	 * fils_snonce - SNonce (required for FILS)
909 	*/
910 	u8 fils_snonce[WPA_NONCE_LEN];
911 
912 	/**
913 	 * fils_kek - key for encryption (required for FILS)
914 	 */
915 	u8 fils_kek[WPA_KEK_MAX_LEN];
916 
917 	/**
918 	 * fils_kek_len - Length of the fils_kek in octets (required for FILS)
919 	 */
920 	size_t fils_kek_len;
921 };
922 
923 struct wpa_driver_mld_params {
924 	/**
925 	 * mld_addr - AP's MLD address
926 	 */
927 	const u8 *mld_addr;
928 
929 	/**
930 	 * valid_links - The valid links including the association link
931 	 */
932 	u16 valid_links;
933 
934 	/**
935 	 * assoc_link_id - The link on which the association is performed
936 	 */
937 	u8 assoc_link_id;
938 
939 	/**
940 	 * mld_links - Link information
941 	 *
942 	 * Should include information on all the requested links for association
943 	 * including the link on which the association should take place.
944 	 * For the association link, the ies and ies_len should be NULL and
945 	 * 0 respectively.
946 	 */
947 	struct {
948 		int freq;
949 		const u8 *bssid;
950 		const u8 *ies;
951 		size_t ies_len;
952 	} mld_links[MAX_NUM_MLD_LINKS];
953 };
954 
955 /**
956  * struct wpa_driver_associate_params - Association parameters
957  * Data for struct wpa_driver_ops::associate().
958  */
959 struct wpa_driver_associate_params {
960 	/**
961 	 * bssid - BSSID of the selected AP
962 	 * This can be %NULL, if ap_scan=2 mode is used and the driver is
963 	 * responsible for selecting with which BSS to associate. */
964 	const u8 *bssid;
965 
966 	/**
967 	 * bssid_hint - BSSID of a proposed AP
968 	 *
969 	 * This indicates which BSS has been found a suitable candidate for
970 	 * initial association for drivers that use driver/firmwate-based BSS
971 	 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
972 	 * the driver from selecting other BSSes in the ESS.
973 	 */
974 	const u8 *bssid_hint;
975 
976 	/**
977 	 * ssid - The selected SSID
978 	 */
979 	const u8 *ssid;
980 
981 	/**
982 	 * ssid_len - Length of the SSID (1..32)
983 	 */
984 	size_t ssid_len;
985 
986 	/**
987 	 * freq - channel parameters
988 	 */
989 	struct hostapd_freq_params freq;
990 
991 	/**
992 	 * freq_hint - Frequency of the channel the proposed AP is using
993 	 *
994 	 * This provides a channel on which a suitable BSS has been found as a
995 	 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
996 	 * limit the driver from selecting other channels for
997 	 * driver/firmware-based BSS selection.
998 	 */
999 	int freq_hint;
1000 
1001 	/**
1002 	 * bg_scan_period - Background scan period in seconds, 0 to disable
1003 	 * background scan, or -1 to indicate no change to default driver
1004 	 * configuration
1005 	 */
1006 	int bg_scan_period;
1007 
1008 	/**
1009 	 * beacon_int - Beacon interval for IBSS or 0 to use driver default
1010 	 */
1011 	int beacon_int;
1012 
1013 	/**
1014 	 * wpa_ie - WPA information element for (Re)Association Request
1015 	 * WPA information element to be included in (Re)Association
1016 	 * Request (including information element id and length). Use
1017 	 * of this WPA IE is optional. If the driver generates the WPA
1018 	 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and
1019 	 * key_mgmt_suite to select proper algorithms. In this case,
1020 	 * the driver has to notify wpa_supplicant about the used WPA
1021 	 * IE by generating an event that the interface code will
1022 	 * convert into EVENT_ASSOCINFO data (see below).
1023 	 *
1024 	 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
1025 	 * instead. The driver can determine which version is used by
1026 	 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
1027 	 * WPA2/RSN).
1028 	 *
1029 	 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
1030 	 */
1031 	const u8 *wpa_ie;
1032 
1033 	/**
1034 	 * wpa_ie_len - length of the wpa_ie
1035 	 */
1036 	size_t wpa_ie_len;
1037 
1038 	/**
1039 	 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
1040 	 */
1041 	unsigned int wpa_proto;
1042 
1043 	/**
1044 	 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
1045 	 *
1046 	 * This is usually ignored if @wpa_ie is used.
1047 	 */
1048 	unsigned int pairwise_suite;
1049 
1050 	/**
1051 	 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
1052 	 *
1053 	 * This is usually ignored if @wpa_ie is used.
1054 	 */
1055 	unsigned int group_suite;
1056 
1057 	/**
1058 	 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*)
1059 	 *
1060 	 * This is usually ignored if @wpa_ie is used.
1061 	 */
1062 	unsigned int mgmt_group_suite;
1063 
1064 	/**
1065 	 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
1066 	 *
1067 	 * This is usually ignored if @wpa_ie is used.
1068 	 */
1069 	unsigned int key_mgmt_suite;
1070 
1071 	/**
1072 	 * allowed_key_mgmts - Bitfield of allowed key management suites
1073 	 * (WPA_KEY_MGMT_*) other than @key_mgmt_suite for the current
1074 	 * connection
1075 	 *
1076 	 * SME in the driver may choose key_mgmt from this list for the initial
1077 	 * connection or roaming. The driver which doesn't support this
1078 	 * ignores this parameter.
1079 	 */
1080 	unsigned int allowed_key_mgmts;
1081 
1082 	/**
1083 	 * auth_alg - Allowed authentication algorithms
1084 	 * Bit field of WPA_AUTH_ALG_*
1085 	 */
1086 	int auth_alg;
1087 
1088 	/**
1089 	 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
1090 	 */
1091 	int mode;
1092 
1093 	/**
1094 	 * wep_key - WEP keys for static WEP configuration
1095 	 */
1096 	const u8 *wep_key[4];
1097 
1098 	/**
1099 	 * wep_key_len - WEP key length for static WEP configuration
1100 	 */
1101 	size_t wep_key_len[4];
1102 
1103 	/**
1104 	 * wep_tx_keyidx - WEP TX key index for static WEP configuration
1105 	 */
1106 	int wep_tx_keyidx;
1107 
1108 	/**
1109 	 * mgmt_frame_protection - IEEE 802.11w management frame protection
1110 	 */
1111 	enum mfp_options mgmt_frame_protection;
1112 
1113 	/**
1114 	 * passphrase - RSN passphrase for PSK
1115 	 *
1116 	 * This value is made available only for WPA/WPA2-Personal (PSK) and
1117 	 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
1118 	 * is the 8..63 character ASCII passphrase, if available. Please note
1119 	 * that this can be %NULL if passphrase was not used to generate the
1120 	 * PSK. In that case, the psk field must be used to fetch the PSK.
1121 	 */
1122 	const char *passphrase;
1123 
1124 	/**
1125 	 * psk - RSN PSK (alternative for passphrase for PSK)
1126 	 *
1127 	 * This value is made available only for WPA/WPA2-Personal (PSK) and
1128 	 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
1129 	 * is the 32-octet (256-bit) PSK, if available. The driver wrapper
1130 	 * should be prepared to handle %NULL value as an error.
1131 	 */
1132 	const u8 *psk;
1133 
1134 	/**
1135 	 * sae_password - Password for SAE authentication
1136 	 *
1137 	 * This value is made available only for WPA3-Personal (SAE) and only
1138 	 * for drivers that set WPA_DRIVER_FLAGS2_SAE_OFFLOAD.
1139 	 */
1140 	const char *sae_password;
1141 
1142 	/**
1143 	 * sae_password_id - Password Identifier for SAE authentication
1144 	 *
1145 	 * This value is made available only for WPA3-Personal (SAE) and only
1146 	 * for drivers that set WPA_DRIVER_FLAGS2_SAE_OFFLOAD. If %NULL, SAE
1147 	 * password identifier is not used.
1148 	 */
1149 	const char *sae_password_id;
1150 
1151 	/**
1152 	 * drop_unencrypted - Enable/disable unencrypted frame filtering
1153 	 *
1154 	 * Configure the driver to drop all non-EAPOL frames (both receive and
1155 	 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
1156 	 * still be allowed for key negotiation.
1157 	 */
1158 	int drop_unencrypted;
1159 
1160 	/**
1161 	 * prev_bssid - Previously used BSSID in this ESS
1162 	 *
1163 	 * When not %NULL, this is a request to use reassociation instead of
1164 	 * association.
1165 	 */
1166 	const u8 *prev_bssid;
1167 
1168 	/**
1169 	 * wps - WPS mode
1170 	 *
1171 	 * If the driver needs to do special configuration for WPS association,
1172 	 * this variable provides more information on what type of association
1173 	 * is being requested. Most drivers should not need to use this.
1174 	 */
1175 	enum wps_mode wps;
1176 
1177 	/**
1178 	 * p2p - Whether this connection is a P2P group
1179 	 */
1180 	int p2p;
1181 
1182 	/**
1183 	 * uapsd - UAPSD parameters for the network
1184 	 * -1 = do not change defaults
1185 	 * AP mode: 1 = enabled, 0 = disabled
1186 	 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
1187 	 */
1188 	int uapsd;
1189 
1190 	/**
1191 	 * fixed_bssid - Whether to force this BSSID in IBSS mode
1192 	 * 1 = Fix this BSSID and prevent merges.
1193 	 * 0 = Do not fix BSSID.
1194 	 */
1195 	int fixed_bssid;
1196 
1197 	/**
1198 	 * fixed_freq - Fix control channel in IBSS mode
1199 	 * 0 = don't fix control channel (default)
1200 	 * 1 = fix control channel; this prevents IBSS merging with another
1201 	 *	channel
1202 	 */
1203 	int fixed_freq;
1204 
1205 	/**
1206 	 * disable_ht - Disable HT (IEEE 802.11n) for this connection
1207 	 */
1208 	int disable_ht;
1209 
1210 	/**
1211 	 * htcaps - HT Capabilities over-rides
1212 	 *
1213 	 * Only bits set in the mask will be used, and not all values are used
1214 	 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
1215 	 *
1216 	 * Pointer to struct ieee80211_ht_capabilities.
1217 	 */
1218 	const u8 *htcaps;
1219 
1220 	/**
1221 	 * htcaps_mask - HT Capabilities over-rides mask
1222 	 *
1223 	 * Pointer to struct ieee80211_ht_capabilities.
1224 	 */
1225 	const u8 *htcaps_mask;
1226 
1227 #ifdef CONFIG_VHT_OVERRIDES
1228 	/**
1229 	 * disable_vht - Disable VHT for this connection
1230 	 */
1231 	int disable_vht;
1232 
1233 	/**
1234 	 * VHT capability overrides.
1235 	 */
1236 	const struct ieee80211_vht_capabilities *vhtcaps;
1237 	const struct ieee80211_vht_capabilities *vhtcaps_mask;
1238 #endif /* CONFIG_VHT_OVERRIDES */
1239 
1240 #ifdef CONFIG_HE_OVERRIDES
1241 	/**
1242 	 * disable_he - Disable HE for this connection
1243 	 */
1244 	int disable_he;
1245 #endif /* CONFIG_HE_OVERRIDES */
1246 
1247 	/**
1248 	 * req_key_mgmt_offload - Request key management offload for connection
1249 	 *
1250 	 * Request key management offload for this connection if the device
1251 	 * supports it.
1252 	 */
1253 	int req_key_mgmt_offload;
1254 
1255 	/**
1256 	 * req_handshake_offload - Request EAPOL handshake offload
1257 	 *
1258 	 * Request EAPOL handshake offload for this connection if the device
1259 	 * supports it.
1260 	 */
1261 	int req_handshake_offload;
1262 
1263 	/**
1264 	 * Flag for indicating whether this association includes support for
1265 	 * RRM (Radio Resource Measurements)
1266 	 */
1267 	int rrm_used;
1268 
1269 	/**
1270 	 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
1271 	 * AP as usual. Valid for DMG network only.
1272 	 */
1273 	int pbss;
1274 
1275 	/**
1276 	 * fils_kek - KEK for FILS association frame protection (AES-SIV)
1277 	 */
1278 	const u8 *fils_kek;
1279 
1280 	/**
1281 	 * fils_kek_len: Length of fils_kek in bytes
1282 	 */
1283 	size_t fils_kek_len;
1284 
1285 	/**
1286 	 * fils_nonces - Nonces for FILS association frame protection
1287 	 * (AES-SIV AAD)
1288 	 */
1289 	const u8 *fils_nonces;
1290 
1291 	/**
1292 	 * fils_nonces_len: Length of fils_nonce in bytes
1293 	 */
1294 	size_t fils_nonces_len;
1295 
1296 	/**
1297 	 * fils_erp_username - Username part of keyName-NAI
1298 	 */
1299 	const u8 *fils_erp_username;
1300 
1301 	/**
1302 	 * fils_erp_username_len - Length of fils_erp_username in bytes
1303 	 */
1304 	size_t fils_erp_username_len;
1305 
1306 	/**
1307 	 * fils_erp_realm - Realm/domain name to use in FILS ERP
1308 	 */
1309 	const u8 *fils_erp_realm;
1310 
1311 	/**
1312 	 * fils_erp_realm_len - Length of fils_erp_realm in bytes
1313 	 */
1314 	size_t fils_erp_realm_len;
1315 
1316 	/**
1317 	 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
1318 	 * messages
1319 	 */
1320 	u16 fils_erp_next_seq_num;
1321 
1322 	/**
1323 	 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
1324 	 * specified by fils_erp_username@fils_erp_realm.
1325 	 */
1326 	const u8 *fils_erp_rrk;
1327 
1328 	/**
1329 	 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
1330 	 */
1331 	size_t fils_erp_rrk_len;
1332 
1333 	/**
1334 	 * sae_pwe - SAE mechanism for PWE derivation
1335 	 * 0 = hunting-and-pecking loop only
1336 	 * 1 = hash-to-element only
1337 	 * 2 = both hunting-and-pecking loop and hash-to-element enabled
1338 	 */
1339 	enum sae_pwe sae_pwe;
1340 
1341 #if defined(CONFIG_DRIVER_NL80211_BRCM) || defined(CONFIG_DRIVER_NL80211_SYNA)
1342 	/**
1343 	 * td_policy - Transition Disable Policy
1344 	 */
1345 	u32 td_policy;
1346 #endif /* CONFIG_DRIVER_NL80211_BRCM || CONFIG_DRIVER_NL80211_SYNA */
1347 
1348 	/**
1349 	 * disable_eht - Disable EHT for this connection
1350 	 */
1351 	int disable_eht;
1352 
1353 	/*
1354 	 * mld_params - MLD association parameters
1355 	 */
1356 	struct wpa_driver_mld_params mld_params;
1357 };
1358 
1359 enum hide_ssid {
1360 	NO_SSID_HIDING,
1361 	HIDDEN_SSID_ZERO_LEN,
1362 	HIDDEN_SSID_ZERO_CONTENTS
1363 };
1364 
1365 enum ch_switch_state {
1366 	CH_SW_STARTED,
1367 	CH_SW_FINISHED
1368 };
1369 
1370 struct wowlan_triggers {
1371 	u8 any;
1372 	u8 disconnect;
1373 	u8 magic_pkt;
1374 	u8 gtk_rekey_failure;
1375 	u8 eap_identity_req;
1376 	u8 four_way_handshake;
1377 	u8 rfkill_release;
1378 };
1379 
1380 struct wpa_driver_ap_params {
1381 	/**
1382 	 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
1383 	 */
1384 	u8 *head;
1385 
1386 	/**
1387 	 * head_len - Length of the head buffer in octets
1388 	 */
1389 	size_t head_len;
1390 
1391 	/**
1392 	 * tail - Beacon tail following TIM IE
1393 	 */
1394 	u8 *tail;
1395 
1396 	/**
1397 	 * tail_len - Length of the tail buffer in octets
1398 	 */
1399 	size_t tail_len;
1400 
1401 	/**
1402 	 * dtim_period - DTIM period
1403 	 */
1404 	int dtim_period;
1405 
1406 	/**
1407 	 * beacon_int - Beacon interval
1408 	 */
1409 	int beacon_int;
1410 
1411 	/**
1412 	 * basic_rates: -1 terminated array of basic rates in 100 kbps
1413 	 *
1414 	 * This parameter can be used to set a specific basic rate set for the
1415 	 * BSS. If %NULL, default basic rate set is used.
1416 	 */
1417 	int *basic_rates;
1418 
1419 	/**
1420 	 * beacon_rate: Beacon frame data rate
1421 	 *
1422 	 * This parameter can be used to set a specific Beacon frame data rate
1423 	 * for the BSS. The interpretation of this value depends on the
1424 	 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS,
1425 	 * HE: HE-MCS). If beacon_rate == 0 and rate_type == 0
1426 	 * (BEACON_RATE_LEGACY), the default Beacon frame data rate is used.
1427 	 */
1428 	unsigned int beacon_rate;
1429 
1430 	/**
1431 	 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT/HE)
1432 	 */
1433 	enum beacon_rate_type rate_type;
1434 
1435 	/**
1436 	 * proberesp - Probe Response template
1437 	 *
1438 	 * This is used by drivers that reply to Probe Requests internally in
1439 	 * AP mode and require the full Probe Response template.
1440 	 */
1441 	u8 *proberesp;
1442 
1443 	/**
1444 	 * proberesp_len - Length of the proberesp buffer in octets
1445 	 */
1446 	size_t proberesp_len;
1447 
1448 	/**
1449 	 * ssid - The SSID to use in Beacon/Probe Response frames
1450 	 */
1451 	const u8 *ssid;
1452 
1453 	/**
1454 	 * ssid_len - Length of the SSID (1..32)
1455 	 */
1456 	size_t ssid_len;
1457 
1458 	/**
1459 	 * hide_ssid - Whether to hide the SSID
1460 	 */
1461 	enum hide_ssid hide_ssid;
1462 
1463 	/**
1464 	 * pairwise_ciphers - WPA_CIPHER_* bitfield
1465 	 */
1466 	unsigned int pairwise_ciphers;
1467 
1468 	/**
1469 	 * group_cipher - WPA_CIPHER_*
1470 	 */
1471 	unsigned int group_cipher;
1472 
1473 	/**
1474 	 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1475 	 */
1476 	unsigned int key_mgmt_suites;
1477 
1478 	/**
1479 	 * auth_algs - WPA_AUTH_ALG_* bitfield
1480 	 */
1481 	unsigned int auth_algs;
1482 
1483 	/**
1484 	 * wpa_version - WPA_PROTO_* bitfield
1485 	 */
1486 	unsigned int wpa_version;
1487 
1488 	/**
1489 	 * privacy - Whether privacy is used in the BSS
1490 	 */
1491 	int privacy;
1492 
1493 	/**
1494 	 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1495 	 *
1496 	 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1497 	 * not use the full Beacon template.
1498 	 */
1499 	const struct wpabuf *beacon_ies;
1500 
1501 	/**
1502 	 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1503 	 *
1504 	 * This is used to add IEs like WPS IE and P2P IE by drivers that
1505 	 * reply to Probe Request frames internally.
1506 	 */
1507 	const struct wpabuf *proberesp_ies;
1508 
1509 	/**
1510 	 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1511 	 *
1512 	 * This is used to add IEs like WPS IE by drivers that reply to
1513 	 * (Re)Association Request frames internally.
1514 	 */
1515 	const struct wpabuf *assocresp_ies;
1516 
1517 	/**
1518 	 * isolate - Whether to isolate frames between associated stations
1519 	 *
1520 	 * If this is non-zero, the AP is requested to disable forwarding of
1521 	 * frames between associated stations.
1522 	 */
1523 	int isolate;
1524 
1525 	/**
1526 	 * cts_protect - Whether CTS protection is enabled
1527 	 */
1528 	int cts_protect;
1529 
1530 	/**
1531 	 * preamble - Whether short preamble is enabled
1532 	 */
1533 	int preamble;
1534 
1535 	/**
1536 	 * short_slot_time - Whether short slot time is enabled
1537 	 *
1538 	 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1539 	 * not set (e.g., when 802.11g mode is not in use)
1540 	 */
1541 	int short_slot_time;
1542 
1543 	/**
1544 	 * ht_opmode - HT operation mode or -1 if HT not in use
1545 	 */
1546 	int ht_opmode;
1547 
1548 	/**
1549 	 * interworking - Whether Interworking is enabled
1550 	 */
1551 	int interworking;
1552 
1553 	/**
1554 	 * hessid - Homogeneous ESS identifier or %NULL if not set
1555 	 */
1556 	const u8 *hessid;
1557 
1558 	/**
1559 	 * access_network_type - Access Network Type (0..15)
1560 	 *
1561 	 * This is used for filtering Probe Request frames when Interworking is
1562 	 * enabled.
1563 	 */
1564 	u8 access_network_type;
1565 
1566 	/**
1567 	 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1568 	 *
1569 	 * This is used by driver which advertises this capability.
1570 	 */
1571 	int ap_max_inactivity;
1572 
1573 	/**
1574 	 * ctwindow - Client Traffic Window (in TUs)
1575 	 */
1576 	u8 p2p_go_ctwindow;
1577 
1578 	/**
1579 	 * disable_dgaf - Whether group-addressed frames are disabled
1580 	 */
1581 	int disable_dgaf;
1582 
1583 	/**
1584 	 * osen - Whether OSEN security is enabled
1585 	 */
1586 	int osen;
1587 
1588 	/**
1589 	 * freq - Channel parameters for dynamic bandwidth changes
1590 	 */
1591 	struct hostapd_freq_params *freq;
1592 
1593 	/**
1594 	 * reenable - Whether this is to re-enable beaconing
1595 	 */
1596 	int reenable;
1597 
1598 	/**
1599 	 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1600 	 * infrastructure BSS. Valid only for DMG network.
1601 	 */
1602 	int pbss;
1603 
1604 	/**
1605 	 * multicast_to_unicast - Whether to use multicast_to_unicast
1606 	 *
1607 	 * If this is non-zero, the AP is requested to perform multicast to
1608 	 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1609 	 * 802.1Q). If enabled, such frames are to be sent to each station
1610 	 * separately, with the DA replaced by their own MAC address rather
1611 	 * than the group address.
1612 	 *
1613 	 * Note that this may break certain expectations of the receiver, such
1614 	 * as the ability to drop unicast IP packets received within multicast
1615 	 * L2 frames, or the ability to not send ICMP destination unreachable
1616 	 * messages for packets received in L2 multicast (which is required,
1617 	 * but the receiver can't tell the difference if this new option is
1618 	 * enabled.)
1619 	 *
1620 	 * This also doesn't implement the 802.11 DMS (directed multicast
1621 	 * service).
1622 	 */
1623 	int multicast_to_unicast;
1624 
1625 	/**
1626 	 * ftm_responder - Whether FTM responder is enabled
1627 	 */
1628 	int ftm_responder;
1629 
1630 	/**
1631 	 * lci - Binary data, the content of an LCI report IE with type 8 as
1632 	 * defined in IEEE Std 802.11-2016, 9.4.2.22.10
1633 	 */
1634 	const struct wpabuf *lci;
1635 
1636 	/**
1637 	 * civic - Binary data, the content of a measurement report IE with
1638 	 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13
1639 	 */
1640 	const struct wpabuf *civic;
1641 
1642 	/**
1643 	 * he_spr_ctrl - Spatial Reuse control field of SPR element
1644 	 */
1645 	u8 he_spr_ctrl;
1646 
1647 	/**
1648 	 * he_spr_non_srg_obss_pd_max_offset - Non-SRG Maximum TX power offset
1649 	 */
1650 	u8 he_spr_non_srg_obss_pd_max_offset;
1651 
1652 	/**
1653 	 * he_spr_srg_obss_pd_min_offset - Minimum TX power offset
1654 	 */
1655 	u8 he_spr_srg_obss_pd_min_offset;
1656 
1657 	/**
1658 	 * he_spr_srg_obss_pd_max_offset - Maximum TX power offset
1659 	 */
1660 	u8 he_spr_srg_obss_pd_max_offset;
1661 
1662 	/**
1663 	 * he_spr_bss_color_bitmap - BSS color values used by members of the
1664 	 * SRG.
1665 	 */
1666 	u8 he_spr_bss_color_bitmap[8];
1667 
1668 	/**
1669 	 * he_spr_partial_bssid_bitmap - Partial BSSID values used by members
1670 	 * of the SRG.
1671 	 */
1672 	u8 he_spr_partial_bssid_bitmap[8];
1673 
1674 	/**
1675 	 * he_bss_color - Whether the BSS Color is disabled
1676 	 */
1677 	int he_bss_color_disabled;
1678 
1679 	/**
1680 	 * he_bss_color_partial - The BSS Color AID equation
1681 	 */
1682 	int he_bss_color_partial;
1683 
1684 	/**
1685 	 * he_bss_color - The BSS Color of the AP
1686 	 */
1687 	int he_bss_color;
1688 
1689 	/**
1690 	 * twt_responder - Whether Target Wait Time responder is enabled
1691 	 */
1692 	int twt_responder;
1693 
1694 	/**
1695 	 * sae_pwe - SAE mechanism for PWE derivation
1696 	 * 0 = hunting-and-pecking loop only
1697 	 * 1 = hash-to-element only
1698 	 * 2 = both hunting-and-pecking loop and hash-to-element enabled
1699 	 */
1700 	enum sae_pwe sae_pwe;
1701 
1702 	/**
1703 	 * FILS Discovery frame minimum interval in TUs
1704 	 */
1705 	u32 fd_min_int;
1706 
1707 	/**
1708 	 * FILS Discovery frame maximum interval in TUs (0 = FD frame disabled)
1709 	 */
1710 	u32 fd_max_int;
1711 
1712 	/**
1713 	 * FILS Discovery frame template data
1714 	 */
1715 	u8 *fd_frame_tmpl;
1716 
1717 	/**
1718 	 * FILS Discovery frame template length
1719 	 */
1720 	size_t fd_frame_tmpl_len;
1721 
1722 	/**
1723 	 * Unsolicited broadcast Probe Response interval in TUs
1724 	 */
1725 	unsigned int unsol_bcast_probe_resp_interval;
1726 
1727 	/**
1728 	 * Unsolicited broadcast Probe Response template data
1729 	 */
1730 	u8 *unsol_bcast_probe_resp_tmpl;
1731 
1732 	/**
1733 	 * Unsolicited broadcast Probe Response template length
1734 	 */
1735 	size_t unsol_bcast_probe_resp_tmpl_len;
1736 
1737 	/**
1738 	 * mbssid_tx_iface - Transmitting interface of the MBSSID set
1739 	 */
1740 	const char *mbssid_tx_iface;
1741 
1742 	/**
1743 	 * mbssid_index - The index of this BSS in the MBSSID set
1744 	 */
1745 	unsigned int mbssid_index;
1746 
1747 	/**
1748 	 * mbssid_elem - Buffer containing all MBSSID elements
1749 	 */
1750 	u8 *mbssid_elem;
1751 
1752 	/**
1753 	 * mbssid_elem_len - Total length of all MBSSID elements
1754 	 */
1755 	size_t mbssid_elem_len;
1756 
1757 	/**
1758 	 * mbssid_elem_count - The number of MBSSID elements
1759 	 */
1760 	u8 mbssid_elem_count;
1761 
1762 	/**
1763 	 * mbssid_elem_offset - Offsets to elements in mbssid_elem.
1764 	 * Kernel will use these offsets to generate multiple BSSID beacons.
1765 	 */
1766 	u8 **mbssid_elem_offset;
1767 
1768 	/**
1769 	 * ema - Enhanced MBSSID advertisements support.
1770 	 */
1771 	bool ema;
1772 
1773 	/**
1774 	 * punct_bitmap - Preamble puncturing bitmap
1775 	 * Each bit corresponds to a 20 MHz subchannel, the lowest bit for the
1776 	 * channel with the lowest frequency. A bit set to 1 indicates that the
1777 	 * subchannel is punctured, otherwise active.
1778 	 */
1779 	u16 punct_bitmap;
1780 
1781 	/**
1782 	 * rnr_elem - This buffer contains all of reduced neighbor report (RNR)
1783 	 * elements
1784 	 */
1785 	u8 *rnr_elem;
1786 
1787 	/**
1788 	 * rnr_elem_len - Length of rnr_elem buffer
1789 	 */
1790 	size_t rnr_elem_len;
1791 
1792 	/**
1793 	 * rnr_elem_count - Number of RNR elements
1794 	 */
1795 	unsigned int rnr_elem_count;
1796 
1797 	/**
1798 	 * rnr_elem_offset - The offsets to the elements in rnr_elem.
1799 	 * The driver will use these to include RNR elements in EMA beacons.
1800 	 */
1801 	u8 **rnr_elem_offset;
1802 
1803 	/**
1804 	 * allowed_freqs - List of allowed 20 MHz channel center frequencies in
1805 	 * MHz for AP operation. Drivers which support this parameter will
1806 	 * generate a new list based on this provided list by filtering out
1807 	 * channels that cannot be used at that time due to regulatory or other
1808 	 * constraints. The resulting list is used as the list of all allowed
1809 	 * channels whenever performing operations like ACS and DFS.
1810 	 */
1811 	int *allowed_freqs;
1812 
1813 	/*
1814 	 * mld_ap - Whether operating as an AP MLD
1815 	 */
1816 	bool mld_ap;
1817 
1818 	/**
1819 	 * mld_link_id - Link id for MLD BSS's
1820 	 */
1821 	u8 mld_link_id;
1822 
1823 	/**
1824 	 * psk - PSK passed to the driver for 4-way handshake offload
1825 	 */
1826 	u8 psk[PMK_LEN];
1827 
1828 	/**
1829 	 * psk_len - PSK length in bytes (0 = not set)
1830 	 */
1831 	size_t psk_len;
1832 
1833 	/**
1834 	 * sae_password - SAE password for SAE offload
1835 	 */
1836 	const char *sae_password;
1837 };
1838 
1839 struct wpa_driver_mesh_bss_params {
1840 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS		0x00000001
1841 #define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT	0x00000002
1842 #define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS	0x00000004
1843 #define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE		0x00000008
1844 #define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD	0x00000010
1845 #define WPA_DRIVER_MESH_CONF_FLAG_FORWARDING		0x00000020
1846 	/*
1847 	 * TODO: Other mesh configuration parameters would go here.
1848 	 * See NL80211_MESHCONF_* for all the mesh config parameters.
1849 	 */
1850 	unsigned int flags;
1851 	int auto_plinks;
1852 	int peer_link_timeout;
1853 	int max_peer_links;
1854 	int rssi_threshold;
1855 	int forwarding;
1856 	u16 ht_opmode;
1857 };
1858 
1859 struct wpa_driver_mesh_join_params {
1860 	const u8 *meshid;
1861 	int meshid_len;
1862 	const int *basic_rates;
1863 	const u8 *ies;
1864 	int ie_len;
1865 	struct hostapd_freq_params freq;
1866 	int beacon_int;
1867 	int dtim_period;
1868 	struct wpa_driver_mesh_bss_params conf;
1869 #define WPA_DRIVER_MESH_FLAG_USER_MPM	0x00000001
1870 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM	0x00000002
1871 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH	0x00000004
1872 #define WPA_DRIVER_MESH_FLAG_AMPE	0x00000008
1873 	unsigned int flags;
1874 	bool handle_dfs;
1875 };
1876 
1877 struct wpa_driver_set_key_params {
1878 	/**
1879 	 * ifname - Interface name (for multi-SSID/VLAN support) */
1880 	const char *ifname;
1881 
1882 	/**
1883 	 * alg - Encryption algorithm
1884 	 *
1885 	 * (%WPA_ALG_NONE, %WPA_ALG_WEP, %WPA_ALG_TKIP, %WPA_ALG_CCMP,
1886 	 * %WPA_ALG_BIP_AES_CMAC_128, %WPA_ALG_GCMP, %WPA_ALG_GCMP_256,
1887 	 * %WPA_ALG_CCMP_256, %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1888 	 * %WPA_ALG_BIP_CMAC_256);
1889 	 * %WPA_ALG_NONE clears the key. */
1890 	enum wpa_alg alg;
1891 
1892 	/**
1893 	 * addr - Address of the peer STA
1894 	 *
1895 	 * (BSSID of the current AP when setting pairwise key in station mode),
1896 	 * ff:ff:ff:ff:ff:ff for broadcast keys, %NULL for default keys that
1897 	 * are used both for broadcast and unicast; when clearing keys, %NULL
1898 	 * is used to indicate that both the broadcast-only and default key of
1899 	 * the specified key index is to be cleared */
1900 	const u8 *addr;
1901 
1902 	/**
1903 	 * key_idx - Key index
1904 	 *
1905 	 * (0..3), usually 0 for unicast keys; 4..5 for IGTK; 6..7 for BIGTK */
1906 	int key_idx;
1907 
1908 	/**
1909 	 * set_tx - Configure this key as the default Tx key
1910 	 *
1911 	 * Only used when driver does not support separate unicast/individual
1912 	 * key */
1913 	int set_tx;
1914 
1915 	/**
1916 	 * seq - Sequence number/packet number
1917 	 *
1918 	 * seq_len octets, the next packet number to be used for in replay
1919 	 * protection; configured for Rx keys (in most cases, this is only used
1920 	 * with broadcast keys and set to zero for unicast keys); %NULL if not
1921 	 * set */
1922 	const u8 *seq;
1923 
1924 	/**
1925 	 * seq_len - Length of the seq, depends on the algorithm
1926 	 *
1927 	 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets */
1928 	size_t seq_len;
1929 
1930 	/**
1931 	 * key - Key buffer
1932 	 *
1933 	 * TKIP: 16-byte temporal key, 8-byte Tx Mic key, 8-byte Rx Mic Key */
1934 	const u8 *key;
1935 
1936 	/**
1937 	 * key_len - Length of the key buffer in octets
1938 	 *
1939 	 * WEP: 5 or 13, TKIP: 32, CCMP/GCMP: 16, IGTK: 16 */
1940 	size_t key_len;
1941 
1942 	/**
1943 	 * vlan_id - VLAN index (0..4095) for VLAN offload cases */
1944 	int vlan_id;
1945 
1946 	/**
1947 	 * key_flag - Additional key flags
1948 	 *
1949 	 * %KEY_FLAG_MODIFY
1950 	 *  Set when an already installed key must be updated.
1951 	 *  So far the only use-case is changing RX/TX status for
1952 	 *  pairwise keys. Must not be set when deleting a key.
1953 	 * %KEY_FLAG_DEFAULT
1954 	 *  Set when the key is also a default key. Must not be set when
1955 	 *  deleting a key.
1956 	 * %KEY_FLAG_RX
1957 	 *  The key is valid for RX. Must not be set when deleting a key.
1958 	 * %KEY_FLAG_TX
1959 	 *  The key is valid for TX. Must not be set when deleting a key.
1960 	 * %KEY_FLAG_GROUP
1961 	 *  The key is a broadcast or group key.
1962 	 * %KEY_FLAG_PAIRWISE
1963 	 *  The key is a pairwise key.
1964 	 * %KEY_FLAG_PMK
1965 	 *  The key is a Pairwise Master Key (PMK).
1966 	 *
1967 	 * Valid and pre-defined combinations are:
1968 	 * %KEY_FLAG_GROUP_RX_TX
1969 	 *  WEP key not to be installed as default key.
1970 	 * %KEY_FLAG_GROUP_RX_TX_DEFAULT
1971 	 *  Default WEP or WPA-NONE key.
1972 	 * %KEY_FLAG_GROUP_RX
1973 	 *  GTK key valid for RX only.
1974 	 * %KEY_FLAG_GROUP_TX_DEFAULT
1975 	 *  GTK key valid for TX only, immediately taking over TX.
1976 	 * %KEY_FLAG_PAIRWISE_RX_TX
1977 	 *  Pairwise key immediately becoming the active pairwise key.
1978 	 * %KEY_FLAG_PAIRWISE_RX
1979 	 *  Pairwise key not yet valid for TX. (Only usable when Extended
1980 	 *  Key ID is supported by the driver.)
1981 	 * %KEY_FLAG_PAIRWISE_RX_TX_MODIFY
1982 	 *  Enable TX for a pairwise key installed with
1983 	 *  KEY_FLAG_PAIRWISE_RX.
1984 	 *
1985 	 * Not a valid standalone key type but pre-defined to be combined
1986 	 * with other key_flags:
1987 	 * %KEY_FLAG_RX_TX
1988 	 *  RX/TX key. */
1989 	enum key_flag key_flag;
1990 
1991 	/**
1992 	 * link_id - MLO Link ID
1993 	 *
1994 	 * Set to a valid Link ID (0-14) when applicable, otherwise -1. */
1995 	int link_id;
1996 };
1997 
1998 enum wpa_driver_if_type {
1999 	/**
2000 	 * WPA_IF_STATION - Station mode interface
2001 	 */
2002 	WPA_IF_STATION,
2003 
2004 	/**
2005 	 * WPA_IF_AP_VLAN - AP mode VLAN interface
2006 	 *
2007 	 * This interface shares its address and Beacon frame with the main
2008 	 * BSS.
2009 	 */
2010 	WPA_IF_AP_VLAN,
2011 
2012 	/**
2013 	 * WPA_IF_AP_BSS - AP mode BSS interface
2014 	 *
2015 	 * This interface has its own address and Beacon frame.
2016 	 */
2017 	WPA_IF_AP_BSS,
2018 
2019 	/**
2020 	 * WPA_IF_P2P_GO - P2P Group Owner
2021 	 */
2022 	WPA_IF_P2P_GO,
2023 
2024 	/**
2025 	 * WPA_IF_P2P_CLIENT - P2P Client
2026 	 */
2027 	WPA_IF_P2P_CLIENT,
2028 
2029 	/**
2030 	 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
2031 	 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
2032 	 */
2033 	WPA_IF_P2P_GROUP,
2034 
2035 	/**
2036 	 * WPA_IF_P2P_DEVICE - P2P Device interface is used to identify the
2037 	 * abstracted P2P Device function in the driver
2038 	 */
2039 	WPA_IF_P2P_DEVICE,
2040 
2041 	/*
2042 	 * WPA_IF_MESH - Mesh interface
2043 	 */
2044 	WPA_IF_MESH,
2045 
2046 	/*
2047 	 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
2048 	 */
2049 	WPA_IF_TDLS,
2050 
2051 	/*
2052 	 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
2053 	 */
2054 	WPA_IF_IBSS,
2055 
2056 	/*
2057 	 * WPA_IF_NAN - NAN Device
2058 	 */
2059 	WPA_IF_NAN,
2060 
2061 	/* keep last */
2062 	WPA_IF_MAX
2063 };
2064 
2065 /**
2066  * struct wpa_driver_capa - Driver capability information
2067  */
2068 struct wpa_driver_capa {
2069 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA		0x00000001
2070 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2		0x00000002
2071 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK	0x00000004
2072 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK	0x00000008
2073 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE	0x00000010
2074 #define WPA_DRIVER_CAPA_KEY_MGMT_FT		0x00000020
2075 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK		0x00000040
2076 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK	0x00000080
2077 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B	0x00000100
2078 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192	0x00000200
2079 #define WPA_DRIVER_CAPA_KEY_MGMT_OWE		0x00000400
2080 #define WPA_DRIVER_CAPA_KEY_MGMT_DPP		0x00000800
2081 #define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256    0x00001000
2082 #define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384    0x00002000
2083 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
2084 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
2085 #define WPA_DRIVER_CAPA_KEY_MGMT_SAE 		0x00010000
2086 #define WPA_DRIVER_CAPA_KEY_MGMT_802_1X_SHA256	0x00020000
2087 #define WPA_DRIVER_CAPA_KEY_MGMT_PSK_SHA256	0x00040000
2088 #define WPA_DRIVER_CAPA_KEY_MGMT_TPK_HANDSHAKE	0x00080000
2089 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_SAE		0x00100000
2090 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_802_1X_SHA384	0x00200000
2091 #define WPA_DRIVER_CAPA_KEY_MGMT_CCKM		0x00400000
2092 #define WPA_DRIVER_CAPA_KEY_MGMT_OSEN		0x00800000
2093 #define WPA_DRIVER_CAPA_KEY_MGMT_SAE_EXT_KEY	0x01000000
2094 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_SAE_EXT_KEY	0x02000000
2095 	/** Bitfield of supported key management suites */
2096 	unsigned int key_mgmt;
2097 	unsigned int key_mgmt_iftype[WPA_IF_MAX];
2098 
2099 #define WPA_DRIVER_CAPA_ENC_WEP40	0x00000001
2100 #define WPA_DRIVER_CAPA_ENC_WEP104	0x00000002
2101 #define WPA_DRIVER_CAPA_ENC_TKIP	0x00000004
2102 #define WPA_DRIVER_CAPA_ENC_CCMP	0x00000008
2103 #define WPA_DRIVER_CAPA_ENC_WEP128	0x00000010
2104 #define WPA_DRIVER_CAPA_ENC_GCMP	0x00000020
2105 #define WPA_DRIVER_CAPA_ENC_GCMP_256	0x00000040
2106 #define WPA_DRIVER_CAPA_ENC_CCMP_256	0x00000080
2107 #define WPA_DRIVER_CAPA_ENC_BIP		0x00000100
2108 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128	0x00000200
2109 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256	0x00000400
2110 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256	0x00000800
2111 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED	0x00001000
2112 	/** Bitfield of supported cipher suites */
2113 	unsigned int enc;
2114 
2115 #define WPA_DRIVER_AUTH_OPEN		0x00000001
2116 #define WPA_DRIVER_AUTH_SHARED		0x00000002
2117 #define WPA_DRIVER_AUTH_LEAP		0x00000004
2118 	/** Bitfield of supported IEEE 802.11 authentication algorithms */
2119 	unsigned int auth;
2120 
2121 /** Driver generated WPA/RSN IE */
2122 #define WPA_DRIVER_FLAGS_DRIVER_IE	0x00000001
2123 /** Driver needs static WEP key setup after association command */
2124 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
2125 /** Driver takes care of all DFS operations */
2126 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD			0x00000004
2127 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
2128  * struct wpa_driver_ops::set_key using key_flag = KEY_FLAG_PMK */
2129 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X		0x00000008
2130 /** Driver is for a wired Ethernet interface */
2131 #define WPA_DRIVER_FLAGS_WIRED		0x00000010
2132 /** Driver provides separate commands for authentication and association (SME in
2133  * wpa_supplicant). */
2134 #define WPA_DRIVER_FLAGS_SME		0x00000020
2135 /** Driver supports AP mode */
2136 #define WPA_DRIVER_FLAGS_AP		0x00000040
2137 /** Driver needs static WEP key setup after association has been completed */
2138 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE	0x00000080
2139 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
2140 #define WPA_DRIVER_FLAGS_HT_2040_COEX			0x00000100
2141 /** Driver supports concurrent P2P operations */
2142 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT	0x00000200
2143 /**
2144  * Driver uses the initial interface as a dedicated management interface, i.e.,
2145  * it cannot be used for P2P group operations or non-P2P purposes.
2146  */
2147 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE	0x00000400
2148 /** This interface is P2P capable (P2P GO or P2P Client) */
2149 #define WPA_DRIVER_FLAGS_P2P_CAPABLE	0x00000800
2150 /** Driver supports station and key removal when stopping an AP */
2151 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT		0x00001000
2152 /**
2153  * Driver uses the initial interface for P2P management interface and non-P2P
2154  * purposes (e.g., connect to infra AP), but this interface cannot be used for
2155  * P2P group operations.
2156  */
2157 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P		0x00002000
2158 /**
2159  * Driver is known to use valid error codes, i.e., when it indicates that
2160  * something (e.g., association) fails, there was indeed a failure and the
2161  * operation does not end up getting completed successfully later.
2162  */
2163 #define WPA_DRIVER_FLAGS_VALID_ERROR_CODES		0x00004000
2164 /** Driver supports off-channel TX */
2165 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX			0x00008000
2166 /** Driver indicates TX status events for EAPOL Data frames */
2167 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS		0x00010000
2168 /** Driver indicates TX status events for Deauth/Disassoc frames */
2169 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS		0x00020000
2170 /** Driver supports roaming (BSS selection) in firmware */
2171 #define WPA_DRIVER_FLAGS_BSS_SELECTION			0x00040000
2172 /** Driver supports operating as a TDLS peer */
2173 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT			0x00080000
2174 /** Driver requires external TDLS setup/teardown/discovery */
2175 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP		0x00100000
2176 /** Driver indicates support for Probe Response offloading in AP mode */
2177 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD		0x00200000
2178 /** Driver supports U-APSD in AP mode */
2179 #define WPA_DRIVER_FLAGS_AP_UAPSD			0x00400000
2180 /** Driver supports inactivity timer in AP mode */
2181 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER		0x00800000
2182 /** Driver expects user space implementation of MLME in AP mode */
2183 #define WPA_DRIVER_FLAGS_AP_MLME			0x01000000
2184 /** Driver supports SAE with user space SME */
2185 #define WPA_DRIVER_FLAGS_SAE				0x02000000
2186 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
2187 #define WPA_DRIVER_FLAGS_OBSS_SCAN			0x04000000
2188 /** Driver supports IBSS (Ad-hoc) mode */
2189 #define WPA_DRIVER_FLAGS_IBSS				0x08000000
2190 /** Driver supports radar detection */
2191 #define WPA_DRIVER_FLAGS_RADAR				0x10000000
2192 /** Driver supports a dedicated interface for P2P Device */
2193 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE		0x20000000
2194 /** Driver supports QoS Mapping */
2195 #define WPA_DRIVER_FLAGS_QOS_MAPPING			0x40000000
2196 /** Driver supports CSA in AP mode */
2197 #define WPA_DRIVER_FLAGS_AP_CSA				0x80000000
2198 /** Driver supports mesh */
2199 #define WPA_DRIVER_FLAGS_MESH			0x0000000100000000ULL
2200 /** Driver support ACS offload */
2201 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD		0x0000000200000000ULL
2202 /** Driver supports key management offload */
2203 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD	0x0000000400000000ULL
2204 /** Driver supports TDLS channel switching */
2205 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH	0x0000000800000000ULL
2206 /** Driver supports IBSS with HT datarates */
2207 #define WPA_DRIVER_FLAGS_HT_IBSS		0x0000001000000000ULL
2208 /** Driver supports IBSS with VHT datarates */
2209 #define WPA_DRIVER_FLAGS_VHT_IBSS		0x0000002000000000ULL
2210 /** Driver supports automatic band selection */
2211 #define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY	0x0000004000000000ULL
2212 /** Driver supports simultaneous off-channel operations */
2213 #define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS	0x0000008000000000ULL
2214 /** Driver supports full AP client state */
2215 #define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE	0x0000010000000000ULL
2216 /** Driver supports P2P Listen offload */
2217 #define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD     0x0000020000000000ULL
2218 /** Driver supports FILS */
2219 #define WPA_DRIVER_FLAGS_SUPPORT_FILS		0x0000040000000000ULL
2220 /** Driver supports Beacon frame TX rate configuration (legacy rates) */
2221 #define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY	0x0000080000000000ULL
2222 /** Driver supports Beacon frame TX rate configuration (HT rates) */
2223 #define WPA_DRIVER_FLAGS_BEACON_RATE_HT		0x0000100000000000ULL
2224 /** Driver supports Beacon frame TX rate configuration (VHT rates) */
2225 #define WPA_DRIVER_FLAGS_BEACON_RATE_VHT	0x0000200000000000ULL
2226 /** Driver supports mgmt_tx with random TX address in non-connected state */
2227 #define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA	0x0000400000000000ULL
2228 /** Driver supports mgmt_tx with random TX addr in connected state */
2229 #define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED	0x0000800000000000ULL
2230 /** Driver supports better BSS reporting with sched_scan in connected mode */
2231 #define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI	0x0001000000000000ULL
2232 /** Driver supports HE capabilities */
2233 #define WPA_DRIVER_FLAGS_HE_CAPABILITIES	0x0002000000000000ULL
2234 /** Driver supports FILS shared key offload */
2235 #define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD	0x0004000000000000ULL
2236 /** Driver supports all OCE STA specific mandatory features */
2237 #define WPA_DRIVER_FLAGS_OCE_STA		0x0008000000000000ULL
2238 /** Driver supports all OCE AP specific mandatory features */
2239 #define WPA_DRIVER_FLAGS_OCE_AP			0x0010000000000000ULL
2240 /**
2241  * Driver supports all OCE STA-CFON specific mandatory features only.
2242  * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
2243  * userspace shall assume that this driver may not support all OCE AP
2244  * functionality but can support only OCE STA-CFON functionality.
2245  */
2246 #define WPA_DRIVER_FLAGS_OCE_STA_CFON		0x0020000000000000ULL
2247 /** Driver supports MFP-optional in the connect command */
2248 #define WPA_DRIVER_FLAGS_MFP_OPTIONAL		0x0040000000000000ULL
2249 /** Driver is a self-managed regulatory device */
2250 #define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY       0x0080000000000000ULL
2251 /** Driver supports FTM responder functionality */
2252 #define WPA_DRIVER_FLAGS_FTM_RESPONDER		0x0100000000000000ULL
2253 /** Driver support 4-way handshake offload for WPA-Personal */
2254 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK	0x0200000000000000ULL
2255 /** Driver supports a separate control port TX for EAPOL frames */
2256 #define WPA_DRIVER_FLAGS_CONTROL_PORT		0x0400000000000000ULL
2257 /** Driver supports VLAN offload */
2258 #define WPA_DRIVER_FLAGS_VLAN_OFFLOAD		0x0800000000000000ULL
2259 /** Driver supports UPDATE_FT_IES command */
2260 #define WPA_DRIVER_FLAGS_UPDATE_FT_IES		0x1000000000000000ULL
2261 /** Driver can correctly rekey PTKs without Extended Key ID */
2262 #define WPA_DRIVER_FLAGS_SAFE_PTK0_REKEYS	0x2000000000000000ULL
2263 /** Driver supports Beacon protection */
2264 #define WPA_DRIVER_FLAGS_BEACON_PROTECTION	0x4000000000000000ULL
2265 /** Driver supports Extended Key ID */
2266 #define WPA_DRIVER_FLAGS_EXTENDED_KEY_ID	0x8000000000000000ULL
2267 	u64 flags;
2268 
2269 /** Driver supports a separate control port RX for EAPOL frames */
2270 #define WPA_DRIVER_FLAGS2_CONTROL_PORT_RX	0x0000000000000001ULL
2271 /** Driver supports TX status reports for EAPOL frames through control port */
2272 #define WPA_DRIVER_FLAGS2_CONTROL_PORT_TX_STATUS 0x0000000000000002ULL
2273 /** Driver supports secure LTF in AP mode */
2274 #define WPA_DRIVER_FLAGS2_SEC_LTF_AP		0x0000000000000004ULL
2275 /** Driver supports secure RTT measurement exchange in AP mode */
2276 #define WPA_DRIVER_FLAGS2_SEC_RTT_AP		0x0000000000000008ULL
2277 /**
2278  * Driver supports protection of range negotiation and measurement management
2279  * frames in AP mode
2280  */
2281 #define WPA_DRIVER_FLAGS2_PROT_RANGE_NEG_AP	0x0000000000000010ULL
2282 /** Driver supports Beacon frame TX rate configuration (HE rates) */
2283 #define WPA_DRIVER_FLAGS2_BEACON_RATE_HE	0x0000000000000020ULL
2284 /** Driver supports Beacon protection only in client mode */
2285 #define WPA_DRIVER_FLAGS2_BEACON_PROTECTION_CLIENT 0x0000000000000040ULL
2286 /** Driver supports Operating Channel Validation */
2287 #define WPA_DRIVER_FLAGS2_OCV			0x0000000000000080ULL
2288 /** Driver expects user space implementation of SME in AP mode */
2289 #define WPA_DRIVER_FLAGS2_AP_SME		0x0000000000000100ULL
2290 /** Driver handles SA Query procedures in AP mode */
2291 #define WPA_DRIVER_FLAGS2_SA_QUERY_OFFLOAD_AP	0x0000000000000200ULL
2292 /** Driver supports background radar/CAC detection */
2293 #define WPA_DRIVER_FLAGS2_RADAR_BACKGROUND	0x0000000000000400ULL
2294 /** Driver supports secure LTF in STA mode */
2295 #define WPA_DRIVER_FLAGS2_SEC_LTF_STA		0x0000000000000800ULL
2296 /** Driver supports secure RTT measurement exchange in STA mode */
2297 #define WPA_DRIVER_FLAGS2_SEC_RTT_STA		0x0000000000001000ULL
2298 /**
2299  * Driver supports protection of range negotiation and measurement management
2300  * frames in STA mode
2301  */
2302 #define WPA_DRIVER_FLAGS2_PROT_RANGE_NEG_STA	0x0000000000002000ULL
2303 /** Driver supports MLO in station/AP mode */
2304 #define WPA_DRIVER_FLAGS2_MLO			0x0000000000004000ULL
2305 /** Driver supports minimal scan request probe content  */
2306 #define WPA_DRIVER_FLAGS2_SCAN_MIN_PREQ         0x0000000000008000ULL
2307 /** Driver supports SAE authentication offload in STA mode */
2308 #define WPA_DRIVER_FLAGS2_SAE_OFFLOAD_STA	0x0000000000010000ULL
2309 /** Driver support AP_PSK authentication offload */
2310 #define WPA_DRIVER_FLAGS2_4WAY_HANDSHAKE_AP_PSK	0x0000000000020000ULL
2311 /** Driver supports OWE STA offload */
2312 #define WPA_DRIVER_FLAGS2_OWE_OFFLOAD_STA	0x0000000000040000ULL
2313 /** Driver supports OWE AP offload */
2314 #define WPA_DRIVER_FLAGS2_OWE_OFFLOAD_AP	0x0000000000080000ULL
2315 /** Driver support AP SAE authentication offload */
2316 #define WPA_DRIVER_FLAGS2_SAE_OFFLOAD_AP	0x0000000000100000ULL
2317 	u64 flags2;
2318 
2319 #define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
2320 	(drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
2321 
2322 	unsigned int wmm_ac_supported:1;
2323 
2324 	unsigned int mac_addr_rand_scan_supported:1;
2325 	unsigned int mac_addr_rand_sched_scan_supported:1;
2326 
2327 	/** Maximum number of supported active probe SSIDs */
2328 	int max_scan_ssids;
2329 
2330 	/** Maximum number of supported active probe SSIDs for sched_scan */
2331 	int max_sched_scan_ssids;
2332 
2333 	/** Maximum number of supported scan plans for scheduled scan */
2334 	unsigned int max_sched_scan_plans;
2335 
2336 	/** Maximum interval in a scan plan. In seconds */
2337 	u32 max_sched_scan_plan_interval;
2338 
2339 	/** Maximum number of iterations in a single scan plan */
2340 	u32 max_sched_scan_plan_iterations;
2341 
2342 	/** Whether sched_scan (offloaded scanning) is supported */
2343 	int sched_scan_supported;
2344 
2345 	/** Maximum number of supported match sets for sched_scan */
2346 	int max_match_sets;
2347 
2348 	/**
2349 	 * max_remain_on_chan - Maximum remain-on-channel duration in msec
2350 	 */
2351 	unsigned int max_remain_on_chan;
2352 
2353 	/**
2354 	 * max_stations - Maximum number of associated stations the driver
2355 	 * supports in AP mode
2356 	 */
2357 	unsigned int max_stations;
2358 
2359 	/**
2360 	 * probe_resp_offloads - Bitmap of supported protocols by the driver
2361 	 * for Probe Response offloading.
2362 	 */
2363 /** Driver Probe Response offloading support for WPS ver. 1 */
2364 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS		0x00000001
2365 /** Driver Probe Response offloading support for WPS ver. 2 */
2366 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2		0x00000002
2367 /** Driver Probe Response offloading support for P2P */
2368 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P		0x00000004
2369 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
2370 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING	0x00000008
2371 	unsigned int probe_resp_offloads;
2372 
2373 	unsigned int max_acl_mac_addrs;
2374 
2375 	/**
2376 	 * Number of supported concurrent channels
2377 	 */
2378 	unsigned int num_multichan_concurrent;
2379 
2380 	/**
2381 	 * extended_capa - extended capabilities in driver/device
2382 	 *
2383 	 * Must be allocated and freed by driver and the pointers must be
2384 	 * valid for the lifetime of the driver, i.e., freed in deinit()
2385 	 */
2386 	const u8 *extended_capa, *extended_capa_mask;
2387 	unsigned int extended_capa_len;
2388 
2389 	struct wowlan_triggers wowlan_triggers;
2390 
2391 /** Driver adds the DS Params Set IE in Probe Request frames */
2392 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES	0x00000001
2393 /** Driver adds the WFA TPC IE in Probe Request frames */
2394 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES		0x00000002
2395 /** Driver handles quiet period requests */
2396 #define WPA_DRIVER_FLAGS_QUIET				0x00000004
2397 /**
2398  * Driver is capable of inserting the current TX power value into the body of
2399  * transmitted frames.
2400  * Background: Some Action frames include a TPC Report IE. This IE contains a
2401  * TX power field, which has to be updated by lower layers. One such Action
2402  * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
2403  * of spectrum management). Note that this insertion takes place at a fixed
2404  * offset, namely the 6th byte in the Action frame body.
2405  */
2406 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION		0x00000008
2407 /**
2408  * Driver supports RRM. With this support, the driver will accept to use RRM in
2409  * (Re)Association Request frames, without supporting quiet period.
2410  */
2411 #define WPA_DRIVER_FLAGS_SUPPORT_RRM			0x00000010
2412 
2413 /** Driver supports setting the scan dwell time */
2414 #define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL		0x00000020
2415 /** Driver supports Beacon Report Measurement */
2416 #define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT		0x00000040
2417 
2418 	u32 rrm_flags;
2419 
2420 	/* Driver concurrency capabilities */
2421 	unsigned int conc_capab;
2422 	/* Maximum number of concurrent channels on 2.4 GHz */
2423 	unsigned int max_conc_chan_2_4;
2424 	/* Maximum number of concurrent channels on 5 GHz */
2425 	unsigned int max_conc_chan_5_0;
2426 
2427 	/* Maximum number of supported CSA counters */
2428 	u16 max_csa_counters;
2429 
2430 	/* Maximum number of supported AKM suites in commands */
2431 	unsigned int max_num_akms;
2432 
2433 	/* Maximum number of interfaces supported for MBSSID advertisement */
2434 	unsigned int mbssid_max_interfaces;
2435 	/* Maximum profile periodicity for enhanced MBSSID advertisement */
2436 	unsigned int ema_max_periodicity;
2437 };
2438 
2439 
2440 struct hostapd_data;
2441 
2442 enum guard_interval {
2443 	GUARD_INTERVAL_0_4 = 1,
2444 	GUARD_INTERVAL_0_8 = 2,
2445 	GUARD_INTERVAL_1_6 = 3,
2446 	GUARD_INTERVAL_3_2 = 4,
2447 };
2448 
2449 #define STA_DRV_DATA_TX_MCS BIT(0)
2450 #define STA_DRV_DATA_RX_MCS BIT(1)
2451 #define STA_DRV_DATA_TX_VHT_MCS BIT(2)
2452 #define STA_DRV_DATA_RX_VHT_MCS BIT(3)
2453 #define STA_DRV_DATA_TX_VHT_NSS BIT(4)
2454 #define STA_DRV_DATA_RX_VHT_NSS BIT(5)
2455 #define STA_DRV_DATA_TX_SHORT_GI BIT(6)
2456 #define STA_DRV_DATA_RX_SHORT_GI BIT(7)
2457 #define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
2458 #define STA_DRV_DATA_CONN_TIME BIT(9)
2459 #define STA_DRV_DATA_TX_HE_MCS BIT(10)
2460 #define STA_DRV_DATA_RX_HE_MCS BIT(11)
2461 #define STA_DRV_DATA_TX_HE_NSS BIT(12)
2462 #define STA_DRV_DATA_RX_HE_NSS BIT(13)
2463 #define STA_DRV_DATA_TX_HE_DCM BIT(14)
2464 #define STA_DRV_DATA_RX_HE_DCM BIT(15)
2465 #define STA_DRV_DATA_TX_HE_GI BIT(16)
2466 #define STA_DRV_DATA_RX_HE_GI BIT(17)
2467 
2468 struct hostap_sta_driver_data {
2469 	unsigned long rx_packets, tx_packets;
2470 	unsigned long long rx_bytes, tx_bytes;
2471 	unsigned long long rx_airtime, tx_airtime;
2472 	unsigned long long beacons_count;
2473 	int bytes_64bit; /* whether 64-bit byte counters are supported */
2474 	unsigned long current_tx_rate; /* in kbps */
2475 	unsigned long current_rx_rate; /* in kbps */
2476 	unsigned long inactive_msec;
2477 	unsigned long connected_sec;
2478 	unsigned long flags; /* bitfield of STA_DRV_DATA_* */
2479 	unsigned long num_ps_buf_frames;
2480 	unsigned long tx_retry_failed;
2481 	unsigned long tx_retry_count;
2482 	s8 last_ack_rssi;
2483 	unsigned long backlog_packets;
2484 	unsigned long backlog_bytes;
2485 	unsigned long fcs_error_count;
2486 	unsigned long beacon_loss_count;
2487 	unsigned long expected_throughput;
2488 	unsigned long rx_drop_misc;
2489 	unsigned long rx_mpdus;
2490 	int signal; /* dBm; or -WPA_INVALID_NOISE */
2491 	u8 rx_hemcs;
2492 	u8 tx_hemcs;
2493 	u8 rx_vhtmcs;
2494 	u8 tx_vhtmcs;
2495 	u8 rx_mcs;
2496 	u8 tx_mcs;
2497 	u8 rx_he_nss;
2498 	u8 tx_he_nss;
2499 	u8 rx_vht_nss;
2500 	u8 tx_vht_nss;
2501 	s8 avg_signal; /* dBm */
2502 	s8 avg_beacon_signal; /* dBm */
2503 	s8 avg_ack_signal; /* dBm */
2504 	enum guard_interval rx_guard_interval, tx_guard_interval;
2505 	u8 rx_dcm, tx_dcm;
2506 };
2507 
2508 struct hostapd_sta_add_params {
2509 	const u8 *addr;
2510 	u16 aid;
2511 	u16 capability;
2512 	const u8 *supp_rates;
2513 	size_t supp_rates_len;
2514 	u16 listen_interval;
2515 	const struct ieee80211_ht_capabilities *ht_capabilities;
2516 	const struct ieee80211_vht_capabilities *vht_capabilities;
2517 	int vht_opmode_enabled;
2518 	u8 vht_opmode;
2519 	const struct ieee80211_he_capabilities *he_capab;
2520 	size_t he_capab_len;
2521 	const struct ieee80211_he_6ghz_band_cap *he_6ghz_capab;
2522 	const struct ieee80211_eht_capabilities *eht_capab;
2523 	size_t eht_capab_len;
2524 	u32 flags; /* bitmask of WPA_STA_* flags */
2525 	u32 flags_mask; /* unset bits in flags */
2526 #ifdef CONFIG_MESH
2527 	enum mesh_plink_state plink_state;
2528 	u16 peer_aid;
2529 #endif /* CONFIG_MESH */
2530 	int set; /* Set STA parameters instead of add */
2531 	u8 qosinfo;
2532 	const u8 *ext_capab;
2533 	size_t ext_capab_len;
2534 	const u8 *supp_channels;
2535 	size_t supp_channels_len;
2536 	const u8 *supp_oper_classes;
2537 	size_t supp_oper_classes_len;
2538 	int support_p2p_ps;
2539 
2540 	bool mld_link_sta;
2541 	s8 mld_link_id;
2542 	const u8 *mld_link_addr;
2543 };
2544 
2545 struct mac_address {
2546 	u8 addr[ETH_ALEN];
2547 };
2548 
2549 struct hostapd_acl_params {
2550 	u8 acl_policy;
2551 	unsigned int num_mac_acl;
2552 	struct mac_address mac_acl[0];
2553 };
2554 
2555 struct wpa_init_params {
2556 	void *global_priv;
2557 	const u8 *bssid;
2558 	const char *ifname;
2559 	const char *driver_params;
2560 	int use_pae_group_addr;
2561 	char **bridge;
2562 	size_t num_bridge;
2563 
2564 	u8 *own_addr; /* buffer for writing own MAC address */
2565 };
2566 
2567 
2568 struct wpa_bss_params {
2569 	/** Interface name (for multi-SSID/VLAN support) */
2570 	const char *ifname;
2571 	/** Whether IEEE 802.1X or WPA/WPA2 is enabled */
2572 	int enabled;
2573 
2574 	int wpa;
2575 	int ieee802_1x;
2576 	int wpa_group;
2577 	int wpa_pairwise;
2578 	int wpa_key_mgmt;
2579 	int rsn_preauth;
2580 	enum mfp_options ieee80211w;
2581 };
2582 
2583 #define WPA_STA_AUTHORIZED BIT(0)
2584 #define WPA_STA_WMM BIT(1)
2585 #define WPA_STA_SHORT_PREAMBLE BIT(2)
2586 #define WPA_STA_MFP BIT(3)
2587 #define WPA_STA_TDLS_PEER BIT(4)
2588 #define WPA_STA_AUTHENTICATED BIT(5)
2589 #define WPA_STA_ASSOCIATED BIT(6)
2590 
2591 enum tdls_oper {
2592 	TDLS_DISCOVERY_REQ,
2593 	TDLS_SETUP,
2594 	TDLS_TEARDOWN,
2595 	TDLS_ENABLE_LINK,
2596 	TDLS_DISABLE_LINK,
2597 	TDLS_ENABLE,
2598 	TDLS_DISABLE
2599 };
2600 
2601 enum wnm_oper {
2602 	WNM_SLEEP_ENTER_CONFIRM,
2603 	WNM_SLEEP_ENTER_FAIL,
2604 	WNM_SLEEP_EXIT_CONFIRM,
2605 	WNM_SLEEP_EXIT_FAIL,
2606 	WNM_SLEEP_TFS_REQ_IE_ADD,   /* STA requests driver to add TFS req IE */
2607 	WNM_SLEEP_TFS_REQ_IE_NONE,  /* STA requests empty TFS req IE */
2608 	WNM_SLEEP_TFS_REQ_IE_SET,   /* AP requests driver to set TFS req IE for
2609 				     * a STA */
2610 	WNM_SLEEP_TFS_RESP_IE_ADD,  /* AP requests driver to add TFS resp IE
2611 				     * for a STA */
2612 	WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
2613 	WNM_SLEEP_TFS_RESP_IE_SET,  /* AP requests driver to set TFS resp IE
2614 				     * for a STA */
2615 	WNM_SLEEP_TFS_IE_DEL        /* AP delete the TFS IE */
2616 };
2617 
2618 /* enum smps_mode - SMPS mode definitions */
2619 enum smps_mode {
2620 	SMPS_AUTOMATIC,
2621 	SMPS_OFF,
2622 	SMPS_DYNAMIC,
2623 	SMPS_STATIC,
2624 
2625 	/* Keep last */
2626 	SMPS_INVALID,
2627 };
2628 
2629 #define WPA_INVALID_NOISE 9999
2630 
2631 /**
2632  * struct wpa_signal_info - Information about channel signal quality
2633  * @frequency: control frequency
2634  * @above_threshold: true if the above threshold was crossed
2635  *	(relevant for a CQM event)
2636  * @data: STA information
2637  * @current_noise: %WPA_INVALID_NOISE if not supported
2638  * @chanwidth: channel width
2639  * @center_frq1: center frequency for the first segment
2640  * @center_frq2: center frequency for the second segment (if relevant)
2641  */
2642 struct wpa_signal_info {
2643 	u32 frequency;
2644 	int above_threshold;
2645 	struct hostap_sta_driver_data data;
2646 	int current_noise;
2647 	enum chan_width chanwidth;
2648 	int center_frq1;
2649 	int center_frq2;
2650 };
2651 
2652 struct wpa_mlo_signal_info {
2653 	u16 valid_links;
2654 	struct wpa_signal_info links[MAX_NUM_MLD_LINKS];
2655 };
2656 
2657 /**
2658  * struct wpa_channel_info - Information about the current channel
2659  * @frequency: Center frequency of the primary 20 MHz channel
2660  * @chanwidth: Width of the current operating channel
2661  * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
2662  *	This field is only filled in when using a 40 MHz channel.
2663  * @center_frq1: Center frequency of frequency segment 0
2664  * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
2665  * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
2666  *	derived from center_frq2 for convenience.
2667  */
2668 struct wpa_channel_info {
2669 	u32 frequency;
2670 	enum chan_width chanwidth;
2671 	int sec_channel;
2672 	int center_frq1;
2673 	int center_frq2;
2674 	u8 seg1_idx;
2675 };
2676 
2677 /**
2678  * struct beacon_data - Beacon data
2679  * @head: Head portion of Beacon frame (before TIM IE)
2680  * @tail: Tail portion of Beacon frame (after TIM IE)
2681  * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
2682  * @proberesp_ies: Extra information element(s) to add into Probe Response
2683  *	frames or %NULL
2684  * @assocresp_ies: Extra information element(s) to add into (Re)Association
2685  *	Response frames or %NULL
2686  * @probe_resp: Probe Response frame template
2687  * @head_len: Length of @head
2688  * @tail_len: Length of @tail
2689  * @beacon_ies_len: Length of beacon_ies in octets
2690  * @proberesp_ies_len: Length of proberesp_ies in octets
2691  * @proberesp_ies_len: Length of proberesp_ies in octets
2692  * @probe_resp_len: Length of probe response template (@probe_resp)
2693  */
2694 struct beacon_data {
2695 	u8 *head, *tail;
2696 	u8 *beacon_ies;
2697 	u8 *proberesp_ies;
2698 	u8 *assocresp_ies;
2699 	u8 *probe_resp;
2700 
2701 	size_t head_len, tail_len;
2702 	size_t beacon_ies_len;
2703 	size_t proberesp_ies_len;
2704 	size_t assocresp_ies_len;
2705 	size_t probe_resp_len;
2706 };
2707 
2708 /**
2709  * struct csa_settings - Settings for channel switch command
2710  * @cs_count: Count in Beacon frames (TBTT) to perform the switch
2711  * @block_tx: 1 - block transmission for CSA period
2712  * @freq_params: Next channel frequency parameter
2713  * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
2714  * @beacon_after: Next beacon/probe resp/asooc resp info
2715  * @counter_offset_beacon: Offset to the count field in beacon's tail
2716  * @counter_offset_presp: Offset to the count field in probe resp.
2717  * @punct_bitmap - Preamble puncturing bitmap
2718  */
2719 struct csa_settings {
2720 	u8 cs_count;
2721 	u8 block_tx;
2722 
2723 	struct hostapd_freq_params freq_params;
2724 	struct beacon_data beacon_csa;
2725 	struct beacon_data beacon_after;
2726 
2727 	u16 counter_offset_beacon[2];
2728 	u16 counter_offset_presp[2];
2729 
2730 	u16 punct_bitmap;
2731 };
2732 
2733 /**
2734  * struct cca_settings - Settings for color switch command
2735  * @cca_count: Count in Beacon frames (TBTT) to perform the switch
2736  * @cca_color: The new color that we are switching to
2737  * @beacon_cca: Beacon/Probe Response/(Re)Association Response frame info for
2738  * color switch period
2739  * @beacon_after: Next Beacon/Probe Response/(Re)Association Response frame info
2740  * @counter_offset_beacon: Offset to the count field in Beacon frame tail
2741  * @counter_offset_presp: Offset to the count field in Probe Response frame
2742  */
2743 struct cca_settings {
2744 	u8 cca_count;
2745 	u8 cca_color;
2746 
2747 	struct beacon_data beacon_cca;
2748 	struct beacon_data beacon_after;
2749 
2750 	u16 counter_offset_beacon;
2751 	u16 counter_offset_presp;
2752 };
2753 
2754 /* TDLS peer capabilities for send_tdls_mgmt() */
2755 enum tdls_peer_capability {
2756 	TDLS_PEER_HT = BIT(0),
2757 	TDLS_PEER_VHT = BIT(1),
2758 	TDLS_PEER_WMM = BIT(2),
2759 	TDLS_PEER_HE = BIT(3),
2760 };
2761 
2762 /* valid info in the wmm_params struct */
2763 enum wmm_params_valid_info {
2764 	WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
2765 };
2766 
2767 /**
2768  * struct wmm_params - WMM parameterss configured for this association
2769  * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
2770  *	of the struct contain valid information.
2771  * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
2772  *	%WMM_PARAMS_UAPSD_QUEUES_INFO is set)
2773  */
2774 struct wmm_params {
2775 	u8 info_bitmap;
2776 	u8 uapsd_queues;
2777 };
2778 
2779 #ifdef CONFIG_MACSEC
2780 struct macsec_init_params {
2781 	bool always_include_sci;
2782 	bool use_es;
2783 	bool use_scb;
2784 };
2785 #endif /* CONFIG_MACSEC */
2786 
2787 enum drv_br_port_attr {
2788 	DRV_BR_PORT_ATTR_PROXYARP,
2789 	DRV_BR_PORT_ATTR_HAIRPIN_MODE,
2790 	DRV_BR_PORT_ATTR_MCAST2UCAST,
2791 };
2792 
2793 enum drv_br_net_param {
2794 	DRV_BR_NET_PARAM_GARP_ACCEPT,
2795 	DRV_BR_MULTICAST_SNOOPING,
2796 };
2797 
2798 struct drv_acs_params {
2799 	/* Selected mode (HOSTAPD_MODE_*) */
2800 	enum hostapd_hw_mode hw_mode;
2801 
2802 	/* Indicates whether HT is enabled */
2803 	int ht_enabled;
2804 
2805 	/* Indicates whether HT40 is enabled */
2806 	int ht40_enabled;
2807 
2808 	/* Indicates whether VHT is enabled */
2809 	int vht_enabled;
2810 
2811 	/* Configured ACS channel width */
2812 	u16 ch_width;
2813 
2814 	/* ACS frequency list info */
2815 	const int *freq_list;
2816 
2817 	/* Indicates whether EDMG is enabled */
2818 	int edmg_enabled;
2819 
2820 	/* Indicates whether EHT is enabled */
2821 	bool eht_enabled;
2822 };
2823 
2824 struct wpa_bss_trans_info {
2825 	u8 mbo_transition_reason;
2826 	u8 n_candidates;
2827 	u8 *bssid;
2828 };
2829 
2830 struct wpa_bss_candidate_info {
2831 	u8 num;
2832 	struct candidate_list {
2833 		u8 bssid[ETH_ALEN];
2834 		u8 is_accept;
2835 		u32 reject_reason;
2836 	} *candidates;
2837 };
2838 
2839 struct wpa_pmkid_params {
2840 	const u8 *bssid;
2841 	const u8 *ssid;
2842 	size_t ssid_len;
2843 	const u8 *fils_cache_id;
2844 	const u8 *pmkid;
2845 	const u8 *pmk;
2846 	size_t pmk_len;
2847 	u32 pmk_lifetime;
2848 	u8 pmk_reauth_threshold;
2849 };
2850 
2851 /* Mask used to specify which connection parameters have to be updated */
2852 enum wpa_drv_update_connect_params_mask {
2853 	WPA_DRV_UPDATE_ASSOC_IES	= BIT(0),
2854 	WPA_DRV_UPDATE_FILS_ERP_INFO	= BIT(1),
2855 	WPA_DRV_UPDATE_AUTH_TYPE	= BIT(2),
2856 #if defined(CONFIG_DRIVER_NL80211_BRCM) || defined(CONFIG_DRIVER_NL80211_SYNA)
2857 	WPA_DRV_UPDATE_TD_POLICY	= BIT(3),
2858 #endif /* CONFIG_DRIVER_NL80211_BRCM || CONFIG_DRIVER_NL80211_SYNA */
2859 };
2860 
2861 /**
2862  * struct external_auth - External authentication trigger parameters
2863  *
2864  * These are used across the external authentication request and event
2865  * interfaces.
2866  * @action: Action type / trigger for external authentication. Only significant
2867  *	for the event interface.
2868  * @bssid: BSSID of the peer with which the authentication has to happen. Used
2869  *	by both the request and event interface.
2870  * @ssid: SSID of the AP. Used by both the request and event interface.
2871  * @ssid_len: SSID length in octets.
2872  * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
2873  *	the request interface.
2874  * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
2875  *	use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
2876  *	the real status code for failures. Used only for the request interface
2877  *	from user space to the driver.
2878  * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
2879  * @mld_addr: AP's MLD address or %NULL if MLO is not used
2880  */
2881 struct external_auth {
2882 	enum {
2883 		EXT_AUTH_START,
2884 		EXT_AUTH_ABORT,
2885 	} action;
2886 	const u8 *bssid;
2887 	const u8 *ssid;
2888 	size_t ssid_len;
2889 	unsigned int key_mgmt_suite;
2890 	u16 status;
2891 	const u8 *pmkid;
2892 	const u8 *mld_addr;
2893 };
2894 
2895 #define WPAS_MAX_PASN_PEERS 10
2896 
2897 enum pasn_status {
2898 	PASN_STATUS_SUCCESS = 0,
2899 	PASN_STATUS_FAILURE = 1,
2900 };
2901 
2902 /**
2903  * struct pasn_peer - PASN peer parameters
2904  *
2905  * Used to process the PASN authentication event from the driver to
2906  * userspace and to send a response back.
2907  * @own_addr: Own MAC address specified by the driver to use for PASN
2908  *	handshake.
2909  * @peer_addr: MAC address of the peer with which PASN authentication is to be
2910  *	performed.
2911  * @network_id: Unique id for the network.
2912  *	This identifier is used as a unique identifier for each network
2913  *	block when using the control interface. Each network is allocated an
2914  *	id when it is being created, either when reading the configuration
2915  *	file or when a new network is added through the control interface.
2916  * @akmp: Authentication key management protocol type supported.
2917  * @cipher: Cipher suite.
2918  * @group: Finite cyclic group. Default group used is 19 (ECC).
2919  * @ltf_keyseed_required: Indicates whether LTF keyseed generation is required
2920  * @status: PASN response status, %PASN_STATUS_SUCCESS for successful
2921  *	authentication, use %PASN_STATUS_FAILURE if PASN authentication
2922  *	fails or if wpa_supplicant fails to set the security ranging context to
2923  *	the driver
2924  */
2925 struct pasn_peer {
2926 	u8 own_addr[ETH_ALEN];
2927 	u8 peer_addr[ETH_ALEN];
2928 	int network_id;
2929 	int akmp;
2930 	int cipher;
2931 	int group;
2932 	bool ltf_keyseed_required;
2933 	enum pasn_status status;
2934 };
2935 
2936 /**
2937  * struct pasn_auth - PASN authentication trigger parameters
2938  *
2939  * These are used across the PASN authentication event from the driver to
2940  * userspace and to send a response to it.
2941  * @action: Action type. Only significant for the event interface.
2942  * @num_peers: The number of peers for which the PASN handshake is requested
2943  *	for.
2944  * @peer: Holds the peer details.
2945  */
2946 struct pasn_auth {
2947 	enum {
2948 		PASN_ACTION_AUTH,
2949 		PASN_ACTION_DELETE_SECURE_RANGING_CONTEXT,
2950 	} action;
2951 	unsigned int num_peers;
2952 	struct pasn_peer peer[WPAS_MAX_PASN_PEERS];
2953 };
2954 
2955 /**
2956  * struct secure_ranging_params - Parameters required to set secure ranging
2957  *	context for a peer.
2958  *
2959  * @action: Add or delete a security context to the driver.
2960  * @own_addr: Own MAC address used during key derivation.
2961  * @peer_addr: Address of the peer device.
2962  * @cipher: Cipher suite.
2963  * @tk_len: Length of temporal key.
2964  * @tk: Temporal key buffer.
2965  * @ltf_keyseed_len: Length of LTF keyseed.
2966  * @ltf_keyeed: LTF keyseed buffer.
2967  */
2968 struct secure_ranging_params {
2969 	u32 action;
2970 	const u8 *own_addr;
2971 	const u8 *peer_addr;
2972 	u32 cipher;
2973 	u8 tk_len;
2974 	const u8 *tk;
2975 	u8 ltf_keyseed_len;
2976 	const u8 *ltf_keyseed;
2977 };
2978 
2979 /* enum nested_attr - Used to specify if subcommand uses nested attributes */
2980 enum nested_attr {
2981 	NESTED_ATTR_NOT_USED = 0,
2982 	NESTED_ATTR_USED = 1,
2983 	NESTED_ATTR_UNSPECIFIED = 2,
2984 };
2985 
2986 /* Preferred channel list information */
2987 
2988 /* GO role */
2989 #define WEIGHTED_PCL_GO BIT(0)
2990 /* P2P Client role */
2991 #define WEIGHTED_PCL_CLI BIT(1)
2992 /* Must be considered for operating channel */
2993 #define WEIGHTED_PCL_MUST_CONSIDER BIT(2)
2994 /* Should be excluded in GO negotiation */
2995 #define WEIGHTED_PCL_EXCLUDE BIT(3)
2996 
2997 /* Preferred channel list with weight */
2998 struct weighted_pcl {
2999 	u32 freq; /* MHz */
3000 	u8 weight;
3001 	u32 flag; /* bitmap for WEIGHTED_PCL_* */
3002 };
3003 
3004 struct driver_sta_mlo_info {
3005 	bool default_map;
3006 	u16 req_links; /* bitmap of requested link IDs */
3007 	u16 valid_links; /* bitmap of accepted link IDs */
3008 	u8 assoc_link_id;
3009 	u8 ap_mld_addr[ETH_ALEN];
3010 	struct {
3011 		u8 addr[ETH_ALEN];
3012 		u8 bssid[ETH_ALEN];
3013 		unsigned int freq;
3014 		struct t2lm_mapping t2lmap;
3015 	} links[MAX_NUM_MLD_LINKS];
3016 };
3017 
3018 /**
3019  * struct wpa_driver_ops - Driver interface API definition
3020  *
3021  * This structure defines the API that each driver interface needs to implement
3022  * for core wpa_supplicant code. All driver specific functionality is captured
3023  * in this wrapper.
3024  */
3025 struct wpa_driver_ops {
3026 	/** Name of the driver interface */
3027 	const char *name;
3028 	/** One line description of the driver interface */
3029 	const char *desc;
3030 
3031 	/**
3032 	 * get_bssid - Get the current BSSID
3033 	 * @priv: private driver interface data
3034 	 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
3035 	 *
3036 	 * Returns: 0 on success, -1 on failure
3037 	 *
3038 	 * Query kernel driver for the current BSSID and copy it to bssid.
3039 	 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
3040 	 * associated.
3041 	 */
3042 	int (*get_bssid)(void *priv, u8 *bssid);
3043 
3044 	/**
3045 	 * get_ssid - Get the current SSID
3046 	 * @priv: private driver interface data
3047 	 * @ssid: buffer for SSID (at least 32 bytes)
3048 	 *
3049 	 * Returns: Length of the SSID on success, -1 on failure
3050 	 *
3051 	 * Query kernel driver for the current SSID and copy it to ssid.
3052 	 * Returning zero is recommended if the STA is not associated.
3053 	 *
3054 	 * Note: SSID is an array of octets, i.e., it is not nul terminated and
3055 	 * can, at least in theory, contain control characters (including nul)
3056 	 * and as such, should be processed as binary data, not a printable
3057 	 * string.
3058 	 */
3059 	int (*get_ssid)(void *priv, u8 *ssid);
3060 
3061 	/**
3062 	 * set_key - Configure encryption key
3063 	 * @priv: private driver interface data
3064 	 * @params: Key parameters
3065 	 * Returns: 0 on success, -1 on failure
3066 	 *
3067 	 * Configure the given key for the kernel driver. If the driver
3068 	 * supports separate individual keys (4 default keys + 1 individual),
3069 	 * addr can be used to determine whether the key is default or
3070 	 * individual. If only 4 keys are supported, the default key with key
3071 	 * index 0 is used as the individual key. STA must be configured to use
3072 	 * it as the default Tx key (set_tx is set) and accept Rx for all the
3073 	 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
3074 	 * broadcast keys, so key index 0 is available for this kind of
3075 	 * configuration.
3076 	 *
3077 	 * Please note that TKIP keys include separate TX and RX MIC keys and
3078 	 * some drivers may expect them in different order than wpa_supplicant
3079 	 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
3080 	 * will trigger Michael MIC errors. This can be fixed by changing the
3081 	 * order of MIC keys by swapping the bytes 16..23 and 24..31 of the key
3082 	 * in driver_*.c set_key() implementation, see driver_ndis.c for an
3083 	 * example on how this can be done.
3084 	 */
3085 	int (*set_key)(void *priv, struct wpa_driver_set_key_params *params);
3086 
3087 	/**
3088 	 * init - Initialize driver interface
3089 	 * @ctx: context to be used when calling wpa_supplicant functions,
3090 	 * e.g., wpa_supplicant_event()
3091 	 * @ifname: interface name, e.g., wlan0
3092 	 *
3093 	 * Returns: Pointer to private data, %NULL on failure
3094 	 *
3095 	 * Initialize driver interface, including event processing for kernel
3096 	 * driver events (e.g., associated, scan results, Michael MIC failure).
3097 	 * This function can allocate a private configuration data area for
3098 	 * @ctx, file descriptor, interface name, etc. information that may be
3099 	 * needed in future driver operations. If this is not used, non-NULL
3100 	 * value will need to be returned because %NULL is used to indicate
3101 	 * failure. The returned value will be used as 'void *priv' data for
3102 	 * all other driver_ops functions.
3103 	 *
3104 	 * The main event loop (eloop.c) of wpa_supplicant can be used to
3105 	 * register callback for read sockets (eloop_register_read_sock()).
3106 	 *
3107 	 * See below for more information about events and
3108 	 * wpa_supplicant_event() function.
3109 	 */
3110 	void * (*init)(void *ctx, const char *ifname);
3111 
3112 	/**
3113 	 * deinit - Deinitialize driver interface
3114 	 * @priv: private driver interface data from init()
3115 	 *
3116 	 * Shut down driver interface and processing of driver events. Free
3117 	 * private data buffer if one was allocated in init() handler.
3118 	 */
3119 	void (*deinit)(void *priv);
3120 
3121 	/**
3122 	 * set_param - Set driver configuration parameters
3123 	 * @priv: private driver interface data from init()
3124 	 * @param: driver specific configuration parameters
3125 	 *
3126 	 * Returns: 0 on success, -1 on failure
3127 	 *
3128 	 * Optional handler for notifying driver interface about configuration
3129 	 * parameters (driver_param).
3130 	 */
3131 	int (*set_param)(void *priv, const char *param);
3132 
3133 	/**
3134 	 * set_countermeasures - Enable/disable TKIP countermeasures
3135 	 * @priv: private driver interface data
3136 	 * @enabled: 1 = countermeasures enabled, 0 = disabled
3137 	 *
3138 	 * Returns: 0 on success, -1 on failure
3139 	 *
3140 	 * Configure TKIP countermeasures. When these are enabled, the driver
3141 	 * should drop all received and queued frames that are using TKIP.
3142 	 */
3143 	int (*set_countermeasures)(void *priv, int enabled);
3144 
3145 	/**
3146 	 * deauthenticate - Request driver to deauthenticate
3147 	 * @priv: private driver interface data
3148 	 * @addr: peer address (BSSID of the AP)
3149 	 * @reason_code: 16-bit reason code to be sent in the deauthentication
3150 	 *	frame
3151 	 *
3152 	 * Returns: 0 on success, -1 on failure
3153 	 */
3154 	int (*deauthenticate)(void *priv, const u8 *addr, u16 reason_code);
3155 
3156 	/**
3157 	 * associate - Request driver to associate
3158 	 * @priv: private driver interface data
3159 	 * @params: association parameters
3160 	 *
3161 	 * Returns: 0 on success, -1 on failure
3162 	 */
3163 	int (*associate)(void *priv,
3164 			 struct wpa_driver_associate_params *params);
3165 
3166 	/**
3167 	 * add_pmkid - Add PMKSA cache entry to the driver
3168 	 * @priv: private driver interface data
3169 	 * @params: PMKSA parameters
3170 	 *
3171 	 * Returns: 0 on success, -1 on failure
3172 	 *
3173 	 * This function is called when a new PMK is received, as a result of
3174 	 * either normal authentication or RSN pre-authentication. The PMKSA
3175 	 * parameters are either a set of bssid, pmkid, and pmk; or a set of
3176 	 * ssid, fils_cache_id, pmkid, and pmk.
3177 	 *
3178 	 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
3179 	 * associate(), add_pmkid() can be used to add new PMKSA cache entries
3180 	 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
3181 	 * driver_ops function does not need to be implemented. Likewise, if
3182 	 * the driver does not support WPA, this function is not needed.
3183 	 */
3184 	int (*add_pmkid)(void *priv, struct wpa_pmkid_params *params);
3185 
3186 	/**
3187 	 * remove_pmkid - Remove PMKSA cache entry to the driver
3188 	 * @priv: private driver interface data
3189 	 * @params: PMKSA parameters
3190 	 *
3191 	 * Returns: 0 on success, -1 on failure
3192 	 *
3193 	 * This function is called when the supplicant drops a PMKSA cache
3194 	 * entry for any reason. The PMKSA parameters are either a set of
3195 	 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
3196 	 *
3197 	 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
3198 	 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
3199 	 * between the driver and wpa_supplicant. If the driver uses wpa_ie
3200 	 * from wpa_supplicant, this driver_ops function does not need to be
3201 	 * implemented. Likewise, if the driver does not support WPA, this
3202 	 * function is not needed.
3203 	 */
3204 	int (*remove_pmkid)(void *priv, struct wpa_pmkid_params *params);
3205 
3206 	/**
3207 	 * flush_pmkid - Flush PMKSA cache
3208 	 * @priv: private driver interface data
3209 	 *
3210 	 * Returns: 0 on success, -1 on failure
3211 	 *
3212 	 * This function is called when the supplicant drops all PMKSA cache
3213 	 * entries for any reason.
3214 	 *
3215 	 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
3216 	 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
3217 	 * between the driver and wpa_supplicant. If the driver uses wpa_ie
3218 	 * from wpa_supplicant, this driver_ops function does not need to be
3219 	 * implemented. Likewise, if the driver does not support WPA, this
3220 	 * function is not needed.
3221 	 */
3222 	int (*flush_pmkid)(void *priv);
3223 
3224 	/**
3225 	 * get_capa - Get driver capabilities
3226 	 * @priv: private driver interface data
3227 	 *
3228 	 * Returns: 0 on success, -1 on failure
3229 	 *
3230 	 * Get driver/firmware/hardware capabilities.
3231 	 */
3232 	int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
3233 
3234 	/**
3235 	 * poll - Poll driver for association information
3236 	 * @priv: private driver interface data
3237 	 *
3238 	 * This is an optional callback that can be used when the driver does
3239 	 * not provide event mechanism for association events. This is called
3240 	 * when receiving WPA/RSN EAPOL-Key messages that require association
3241 	 * information. The driver interface is supposed to generate associnfo
3242 	 * event before returning from this callback function. In addition, the
3243 	 * driver interface should generate an association event after having
3244 	 * sent out associnfo.
3245 	 */
3246 	void (*poll)(void *priv);
3247 
3248 	/**
3249 	 * get_ifindex - Get interface index
3250 	 * @priv: private driver interface data
3251 	 *
3252 	 * Returns: Interface index
3253 	 */
3254 	unsigned int (*get_ifindex)(void *priv);
3255 
3256 	/**
3257 	 * get_ifname - Get interface name
3258 	 * @priv: private driver interface data
3259 	 *
3260 	 * Returns: Pointer to the interface name. This can differ from the
3261 	 * interface name used in init() call. Init() is called first.
3262 	 *
3263 	 * This optional function can be used to allow the driver interface to
3264 	 * replace the interface name with something else, e.g., based on an
3265 	 * interface mapping from a more descriptive name.
3266 	 */
3267 	const char * (*get_ifname)(void *priv);
3268 
3269 	/**
3270 	 * get_mac_addr - Get own MAC address
3271 	 * @priv: private driver interface data
3272 	 *
3273 	 * Returns: Pointer to own MAC address or %NULL on failure
3274 	 *
3275 	 * This optional function can be used to get the own MAC address of the
3276 	 * device from the driver interface code. This is only needed if the
3277 	 * l2_packet implementation for the OS does not provide easy access to
3278 	 * a MAC address. */
3279 	const u8 * (*get_mac_addr)(void *priv);
3280 
3281 	/**
3282 	 * set_operstate - Sets device operating state to DORMANT or UP
3283 	 * @priv: private driver interface data
3284 	 * @state: 0 = dormant, 1 = up
3285 	 * Returns: 0 on success, -1 on failure
3286 	 *
3287 	 * This is an optional function that can be used on operating systems
3288 	 * that support a concept of controlling network device state from user
3289 	 * space applications. This function, if set, gets called with
3290 	 * state = 1 when authentication has been completed and with state = 0
3291 	 * when connection is lost.
3292 	 */
3293 	int (*set_operstate)(void *priv, int state);
3294 
3295 	/**
3296 	 * mlme_setprotection - MLME-SETPROTECTION.request primitive
3297 	 * @priv: Private driver interface data
3298 	 * @addr: Address of the station for which to set protection (may be
3299 	 * %NULL for group keys)
3300 	 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
3301 	 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
3302 	 * Returns: 0 on success, -1 on failure
3303 	 *
3304 	 * This is an optional function that can be used to set the driver to
3305 	 * require protection for Tx and/or Rx frames. This uses the layer
3306 	 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
3307 	 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
3308 	 * set protection operation; instead, they set protection implicitly
3309 	 * based on configured keys.
3310 	 */
3311 	int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
3312 				  int key_type);
3313 
3314 	/**
3315 	 * get_hw_feature_data - Get hardware support data (channels and rates)
3316 	 * @priv: Private driver interface data
3317 	 * @num_modes: Variable for returning the number of returned modes
3318 	 * flags: Variable for returning hardware feature flags
3319 	 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
3320 	 * Returns: Pointer to allocated hardware data on success or %NULL on
3321 	 * failure. Caller is responsible for freeing this.
3322 	 */
3323 	struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
3324 							 u16 *num_modes,
3325 							 u16 *flags, u8 *dfs);
3326 
3327 	/**
3328 	 * send_mlme - Send management frame from MLME
3329 	 * @priv: Private driver interface data
3330 	 * @data: IEEE 802.11 management frame with IEEE 802.11 header
3331 	 * @data_len: Size of the management frame
3332 	 * @noack: Do not wait for this frame to be acked (disable retries)
3333 	 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
3334 	 * driver decide
3335 	 * @csa_offs: Array of CSA offsets or %NULL
3336 	 * @csa_offs_len: Number of elements in csa_offs
3337 	 * @no_encrypt: Do not encrypt frame even if appropriate key exists
3338 	 *	(used only for testing purposes)
3339 	 * @wait: Time to wait off-channel for a response (in ms), or zero
3340 	 * @link_id: Link ID to use for TX, or -1 if not set
3341 	 * Returns: 0 on success, -1 on failure
3342 	 */
3343 	int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
3344 			 int noack, unsigned int freq, const u16 *csa_offs,
3345 			 size_t csa_offs_len, int no_encrypt,
3346 			 unsigned int wait, int link_id);
3347 
3348 	/**
3349 	 * update_ft_ies - Update FT (IEEE 802.11r) IEs
3350 	 * @priv: Private driver interface data
3351 	 * @md: Mobility domain (2 octets) (also included inside ies)
3352 	 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
3353 	 * @ies_len: Length of FT IEs in bytes
3354 	 * Returns: 0 on success, -1 on failure
3355 	 *
3356 	 * The supplicant uses this callback to let the driver know that keying
3357 	 * material for FT is available and that the driver can use the
3358 	 * provided IEs in the next message in FT authentication sequence.
3359 	 *
3360 	 * This function is only needed for driver that support IEEE 802.11r
3361 	 * (Fast BSS Transition).
3362 	 */
3363 	int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
3364 			     size_t ies_len);
3365 
3366 	/**
3367 	 * get_scan_results2 - Fetch the latest scan results
3368 	 * @priv: private driver interface data
3369 	 *
3370 	 * Returns: Allocated buffer of scan results (caller is responsible for
3371 	 * freeing the data structure) on success, NULL on failure
3372 	 */
3373 	 struct wpa_scan_results * (*get_scan_results2)(void *priv);
3374 
3375 	/**
3376 	 * set_country - Set country
3377 	 * @priv: Private driver interface data
3378 	 * @alpha2: country to which to switch to
3379 	 * Returns: 0 on success, -1 on failure
3380 	 *
3381 	 * This function is for drivers which support some form
3382 	 * of setting a regulatory domain.
3383 	 */
3384 	int (*set_country)(void *priv, const char *alpha2);
3385 
3386 	/**
3387 	 * get_country - Get country
3388 	 * @priv: Private driver interface data
3389 	 * @alpha2: Buffer for returning country code (at least 3 octets)
3390 	 * Returns: 0 on success, -1 on failure
3391 	 */
3392 	int (*get_country)(void *priv, char *alpha2);
3393 
3394 	/**
3395 	 * global_init - Global driver initialization
3396 	 * @ctx: wpa_global pointer
3397 	 * Returns: Pointer to private data (global), %NULL on failure
3398 	 *
3399 	 * This optional function is called to initialize the driver wrapper
3400 	 * for global data, i.e., data that applies to all interfaces. If this
3401 	 * function is implemented, global_deinit() will also need to be
3402 	 * implemented to free the private data. The driver will also likely
3403 	 * use init2() function instead of init() to get the pointer to global
3404 	 * data available to per-interface initializer.
3405 	 */
3406 	void * (*global_init)(void *ctx);
3407 
3408 	/**
3409 	 * global_deinit - Global driver deinitialization
3410 	 * @priv: private driver global data from global_init()
3411 	 *
3412 	 * Terminate any global driver related functionality and free the
3413 	 * global data structure.
3414 	 */
3415 	void (*global_deinit)(void *priv);
3416 
3417 	/**
3418 	 * init2 - Initialize driver interface (with global data)
3419 	 * @ctx: context to be used when calling wpa_supplicant functions,
3420 	 * e.g., wpa_supplicant_event()
3421 	 * @ifname: interface name, e.g., wlan0
3422 	 * @global_priv: private driver global data from global_init()
3423 	 * Returns: Pointer to private data, %NULL on failure
3424 	 *
3425 	 * This function can be used instead of init() if the driver wrapper
3426 	 * uses global data.
3427 	 */
3428 	void * (*init2)(void *ctx, const char *ifname, void *global_priv);
3429 
3430 	/**
3431 	 * get_interfaces - Get information about available interfaces
3432 	 * @global_priv: private driver global data from global_init()
3433 	 * Returns: Allocated buffer of interface information (caller is
3434 	 * responsible for freeing the data structure) on success, NULL on
3435 	 * failure
3436 	 */
3437 	struct wpa_interface_info * (*get_interfaces)(void *global_priv);
3438 
3439 	/**
3440 	 * scan2 - Request the driver to initiate scan
3441 	 * @priv: private driver interface data
3442 	 * @params: Scan parameters
3443 	 *
3444 	 * Returns: 0 on success, -1 on failure
3445 	 *
3446 	 * Once the scan results are ready, the driver should report scan
3447 	 * results event for wpa_supplicant which will eventually request the
3448 	 * results with wpa_driver_get_scan_results2().
3449 	 */
3450 	int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
3451 
3452 	/**
3453 	 * authenticate - Request driver to authenticate
3454 	 * @priv: private driver interface data
3455 	 * @params: authentication parameters
3456 	 * Returns: 0 on success, -1 on failure
3457 	 *
3458 	 * This is an optional function that can be used with drivers that
3459 	 * support separate authentication and association steps, i.e., when
3460 	 * wpa_supplicant can act as the SME. If not implemented, associate()
3461 	 * function is expected to take care of IEEE 802.11 authentication,
3462 	 * too.
3463 	 */
3464 	int (*authenticate)(void *priv,
3465 			    struct wpa_driver_auth_params *params);
3466 
3467 	/**
3468 	 * set_ap - Set Beacon and Probe Response information for AP mode
3469 	 * @priv: Private driver interface data
3470 	 * @params: Parameters to use in AP mode
3471 	 *
3472 	 * This function is used to configure Beacon template and/or extra IEs
3473 	 * to add for Beacon and Probe Response frames for the driver in
3474 	 * AP mode. The driver is responsible for building the full Beacon
3475 	 * frame by concatenating the head part with TIM IE generated by the
3476 	 * driver/firmware and finishing with the tail part. Depending on the
3477 	 * driver architectue, this can be done either by using the full
3478 	 * template or the set of additional IEs (e.g., WPS and P2P IE).
3479 	 * Similarly, Probe Response processing depends on the driver design.
3480 	 * If the driver (or firmware) takes care of replying to Probe Request
3481 	 * frames, the extra IEs provided here needs to be added to the Probe
3482 	 * Response frames.
3483 	 *
3484 	 * Returns: 0 on success, -1 on failure
3485 	 */
3486 	int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
3487 
3488 	/**
3489 	 * set_acl - Set ACL in AP mode
3490 	 * @priv: Private driver interface data
3491 	 * @params: Parameters to configure ACL
3492 	 * Returns: 0 on success, -1 on failure
3493 	 *
3494 	 * This is used only for the drivers which support MAC address ACL.
3495 	 */
3496 	int (*set_acl)(void *priv, struct hostapd_acl_params *params);
3497 
3498 	/**
3499 	 * hapd_init - Initialize driver interface (hostapd only)
3500 	 * @hapd: Pointer to hostapd context
3501 	 * @params: Configuration for the driver wrapper
3502 	 * Returns: Pointer to private data, %NULL on failure
3503 	 *
3504 	 * This function is used instead of init() or init2() when the driver
3505 	 * wrapper is used with hostapd.
3506 	 */
3507 	void * (*hapd_init)(struct hostapd_data *hapd,
3508 			    struct wpa_init_params *params);
3509 
3510 	/**
3511 	 * hapd_deinit - Deinitialize driver interface (hostapd only)
3512 	 * @priv: Private driver interface data from hapd_init()
3513 	 */
3514 	void (*hapd_deinit)(void *priv);
3515 
3516 	/**
3517 	 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
3518 	 * @priv: Private driver interface data
3519 	 * @params: BSS parameters
3520 	 * Returns: 0 on success, -1 on failure
3521 	 *
3522 	 * This is an optional function to configure the kernel driver to
3523 	 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
3524 	 * can be left undefined (set to %NULL) if IEEE 802.1X support is
3525 	 * always enabled and the driver uses set_ap() to set WPA/RSN IE
3526 	 * for Beacon frames.
3527 	 *
3528 	 * DEPRECATED - use set_ap() instead
3529 	 */
3530 	int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
3531 
3532 	/**
3533 	 * set_privacy - Enable/disable privacy (AP only)
3534 	 * @priv: Private driver interface data
3535 	 * @enabled: 1 = privacy enabled, 0 = disabled
3536 	 * Returns: 0 on success, -1 on failure
3537 	 *
3538 	 * This is an optional function to configure privacy field in the
3539 	 * kernel driver for Beacon frames. This can be left undefined (set to
3540 	 * %NULL) if the driver uses the Beacon template from set_ap().
3541 	 *
3542 	 * DEPRECATED - use set_ap() instead
3543 	 */
3544 	int (*set_privacy)(void *priv, int enabled);
3545 
3546 	/**
3547 	 * get_seqnum - Fetch the current TSC/packet number (AP only)
3548 	 * @ifname: The interface name (main or virtual)
3549 	 * @priv: Private driver interface data
3550 	 * @addr: MAC address of the station or %NULL for group keys
3551 	 * @idx: Key index
3552 	 * @link_id: Link ID for a group key, or -1 if not set
3553 	 * @seq: Buffer for returning the latest used TSC/packet number
3554 	 * Returns: 0 on success, -1 on failure
3555 	 *
3556 	 * This function is used to fetch the last used TSC/packet number for
3557 	 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
3558 	 * keys, so there is no strict requirement on implementing support for
3559 	 * unicast keys (i.e., addr != %NULL).
3560 	 */
3561 	int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
3562 			  int idx, int link_id, u8 *seq);
3563 
3564 	/**
3565 	 * flush - Flush all association stations (AP only)
3566 	 * @priv: Private driver interface data
3567 	 * Returns: 0 on success, -1 on failure
3568 	 *
3569 	 * This function requests the driver to disassociate all associated
3570 	 * stations. This function does not need to be implemented if the
3571 	 * driver does not process association frames internally.
3572 	 */
3573 	int (*flush)(void *priv);
3574 
3575 	/**
3576 	 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
3577 	 * @priv: Private driver interface data
3578 	 * @elem: Information elements
3579 	 * @elem_len: Length of the elem buffer in octets
3580 	 * Returns: 0 on success, -1 on failure
3581 	 *
3582 	 * This is an optional function to add information elements in the
3583 	 * kernel driver for Beacon and Probe Response frames. This can be left
3584 	 * undefined (set to %NULL) if the driver uses the Beacon template from
3585 	 * set_ap().
3586 	 *
3587 	 * DEPRECATED - use set_ap() instead
3588 	 */
3589 	int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
3590 
3591 	/**
3592 	 * read_sta_data - Fetch station data
3593 	 * @priv: Private driver interface data
3594 	 * @data: Buffer for returning station information
3595 	 * @addr: MAC address of the station
3596 	 * Returns: 0 on success, -1 on failure
3597 	 */
3598 	int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
3599 			     const u8 *addr);
3600 
3601 	/**
3602 	 * tx_control_port - Send a frame over the 802.1X controlled port
3603 	 * @priv: Private driver interface data
3604 	 * @dest: Destination MAC address
3605 	 * @proto: Ethertype in host byte order
3606 	 * @buf: Frame payload starting from IEEE 802.1X header
3607 	 * @len: Frame payload length
3608 	 * @no_encrypt: Do not encrypt frame
3609 	 * @link_id: Link ID to use for TX, or -1 if not set
3610 	 *
3611 	 * Returns 0 on success, else an error
3612 	 *
3613 	 * This is like a normal Ethernet send except that the driver is aware
3614 	 * (by other means than the Ethertype) that this frame is special,
3615 	 * and more importantly it gains an ordering between the transmission of
3616 	 * the frame and other driver management operations such as key
3617 	 * installations. This can be used to work around known limitations in
3618 	 * IEEE 802.11 protocols such as race conditions between rekeying 4-way
3619 	 * handshake message 4/4 and a PTK being overwritten.
3620 	 *
3621 	 * This function is only used for a given interface if the driver
3622 	 * instance reports WPA_DRIVER_FLAGS_CONTROL_PORT capability. Otherwise,
3623 	 * API users will fall back to sending the frame via a normal socket.
3624 	 */
3625 	int (*tx_control_port)(void *priv, const u8 *dest,
3626 			       u16 proto, const u8 *buf, size_t len,
3627 			       int no_encrypt, int link_id);
3628 
3629 	/**
3630 	 * hapd_send_eapol - Send an EAPOL packet (AP only)
3631 	 * @priv: private driver interface data
3632 	 * @addr: Destination MAC address
3633 	 * @data: EAPOL packet starting with IEEE 802.1X header
3634 	 * @data_len: Length of the EAPOL packet in octets
3635 	 * @encrypt: Whether the frame should be encrypted
3636 	 * @own_addr: Source MAC address
3637 	 * @flags: WPA_STA_* flags for the destination station
3638 	 * @link_id: Link ID to use for TX, or -1 if not set
3639 	 *
3640 	 * Returns: 0 on success, -1 on failure
3641 	 */
3642 	int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
3643 			       size_t data_len, int encrypt,
3644 			       const u8 *own_addr, u32 flags, int link_id);
3645 
3646 	/**
3647 	 * sta_deauth - Deauthenticate a station (AP only)
3648 	 * @priv: Private driver interface data
3649 	 * @own_addr: Source address and BSSID for the Deauthentication frame
3650 	 * @addr: MAC address of the station to deauthenticate
3651 	 * @reason: Reason code for the Deauthentication frame
3652 	 * @link_id: Link ID to use for Deauthentication frame, or -1 if not set
3653 	 * Returns: 0 on success, -1 on failure
3654 	 *
3655 	 * This function requests a specific station to be deauthenticated and
3656 	 * a Deauthentication frame to be sent to it.
3657 	 */
3658 	int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
3659 			  u16 reason, int link_id);
3660 
3661 	/**
3662 	 * sta_disassoc - Disassociate a station (AP only)
3663 	 * @priv: Private driver interface data
3664 	 * @own_addr: Source address and BSSID for the Disassociation frame
3665 	 * @addr: MAC address of the station to disassociate
3666 	 * @reason: Reason code for the Disassociation frame
3667 	 * Returns: 0 on success, -1 on failure
3668 	 *
3669 	 * This function requests a specific station to be disassociated and
3670 	 * a Disassociation frame to be sent to it.
3671 	 */
3672 	int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
3673 			    u16 reason);
3674 
3675 	/**
3676 	 * sta_remove - Remove a station entry (AP only)
3677 	 * @priv: Private driver interface data
3678 	 * @addr: MAC address of the station to be removed
3679 	 * Returns: 0 on success, -1 on failure
3680 	 */
3681 	int (*sta_remove)(void *priv, const u8 *addr);
3682 
3683 	/**
3684 	 * hapd_get_ssid - Get the current SSID (AP only)
3685 	 * @priv: Private driver interface data
3686 	 * @buf: Buffer for returning the SSID
3687 	 * @len: Maximum length of the buffer
3688 	 * Returns: Length of the SSID on success, -1 on failure
3689 	 *
3690 	 * This function need not be implemented if the driver uses Beacon
3691 	 * template from set_ap() and does not reply to Probe Request frames.
3692 	 */
3693 	int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
3694 
3695 	/**
3696 	 * hapd_set_ssid - Set SSID (AP only)
3697 	 * @priv: Private driver interface data
3698 	 * @buf: SSID
3699 	 * @len: Length of the SSID in octets
3700 	 * Returns: 0 on success, -1 on failure
3701 	 *
3702 	 * DEPRECATED - use set_ap() instead
3703 	 */
3704 	int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
3705 
3706 	/**
3707 	 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
3708 	 * @priv: Private driver interface data
3709 	 * @enabled: 1 = countermeasures enabled, 0 = disabled
3710 	 * Returns: 0 on success, -1 on failure
3711 	 *
3712 	 * This need not be implemented if the driver does not take care of
3713 	 * association processing.
3714 	 */
3715 	int (*hapd_set_countermeasures)(void *priv, int enabled);
3716 
3717 	/**
3718 	 * sta_add - Add a station entry
3719 	 * @priv: Private driver interface data
3720 	 * @params: Station parameters
3721 	 * Returns: 0 on success, -1 on failure
3722 	 *
3723 	 * This function is used to add or set (params->set 1) a station
3724 	 * entry in the driver. Adding STA entries is used only if the driver
3725 	 * does not take care of association processing.
3726 	 *
3727 	 * With drivers that don't support full AP client state, this function
3728 	 * is used to add a station entry to the driver once the station has
3729 	 * completed association.
3730 	 *
3731 	 * With TDLS, this function is used to add or set (params->set 1)
3732 	 * TDLS peer entries (even with drivers that do not support full AP
3733 	 * client state).
3734 	 */
3735 	int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
3736 
3737 	/**
3738 	 * get_inact_sec - Get station inactivity duration (AP only)
3739 	 * @priv: Private driver interface data
3740 	 * @addr: Station address
3741 	 * Returns: Number of seconds station has been inactive, -1 on failure
3742 	 */
3743 	int (*get_inact_sec)(void *priv, const u8 *addr);
3744 
3745 	/**
3746 	 * sta_clear_stats - Clear station statistics (AP only)
3747 	 * @priv: Private driver interface data
3748 	 * @addr: Station address
3749 	 * Returns: 0 on success, -1 on failure
3750 	 */
3751 	int (*sta_clear_stats)(void *priv, const u8 *addr);
3752 
3753 	/**
3754 	 * set_freq - Set channel/frequency (AP only)
3755 	 * @priv: Private driver interface data
3756 	 * @freq: Channel parameters
3757 	 * Returns: 0 on success, -1 on failure
3758 	 */
3759 	int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
3760 
3761 	/**
3762 	 * set_rts - Set RTS threshold
3763 	 * @priv: Private driver interface data
3764 	 * @rts: RTS threshold in octets
3765 	 * Returns: 0 on success, -1 on failure
3766 	 */
3767 	int (*set_rts)(void *priv, int rts);
3768 
3769 	/**
3770 	 * set_frag - Set fragmentation threshold
3771 	 * @priv: Private driver interface data
3772 	 * @frag: Fragmentation threshold in octets
3773 	 * Returns: 0 on success, -1 on failure
3774 	 */
3775 	int (*set_frag)(void *priv, int frag);
3776 
3777 	/**
3778 	 * sta_set_flags - Set station flags (AP only)
3779 	 * @priv: Private driver interface data
3780 	 * @addr: Station address
3781 	 * @total_flags: Bitmap of all WPA_STA_* flags currently set
3782 	 * @flags_or: Bitmap of WPA_STA_* flags to add
3783 	 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
3784 	 * Returns: 0 on success, -1 on failure
3785 	 */
3786 	int (*sta_set_flags)(void *priv, const u8 *addr,
3787 			     unsigned int total_flags, unsigned int flags_or,
3788 			     unsigned int flags_and);
3789 
3790 	/**
3791 	 * sta_set_airtime_weight - Set station airtime weight (AP only)
3792 	 * @priv: Private driver interface data
3793 	 * @addr: Station address
3794 	 * @weight: New weight for station airtime assignment
3795 	 * Returns: 0 on success, -1 on failure
3796 	 */
3797 	int (*sta_set_airtime_weight)(void *priv, const u8 *addr,
3798 				      unsigned int weight);
3799 
3800 	/**
3801 	 * set_tx_queue_params - Set TX queue parameters
3802 	 * @priv: Private driver interface data
3803 	 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
3804 	 * @aifs: AIFS
3805 	 * @cw_min: cwMin
3806 	 * @cw_max: cwMax
3807 	 * @burst_time: Maximum length for bursting in 0.1 msec units
3808 	 * @link_id: Link ID to use, or -1 for non MLD.
3809 	 */
3810 	int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
3811 				   int cw_max, int burst_time, int link_id);
3812 
3813 	/**
3814 	 * if_add - Add a virtual interface
3815 	 * @priv: Private driver interface data
3816 	 * @type: Interface type
3817 	 * @ifname: Interface name for the new virtual interface
3818 	 * @addr: Local address to use for the interface or %NULL to use the
3819 	 *	parent interface address
3820 	 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
3821 	 * @drv_priv: Pointer for overwriting the driver context or %NULL if
3822 	 *	not allowed (applies only to %WPA_IF_AP_BSS type)
3823 	 * @force_ifname: Buffer for returning an interface name that the
3824 	 *	driver ended up using if it differs from the requested ifname
3825 	 * @if_addr: Buffer for returning the allocated interface address
3826 	 *	(this may differ from the requested addr if the driver cannot
3827 	 *	change interface address)
3828 	 * @bridge: Bridge interface to use or %NULL if no bridge configured
3829 	 * @use_existing: Whether to allow existing interface to be used
3830 	 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
3831 	 * Returns: 0 on success, -1 on failure
3832 	 */
3833 	int (*if_add)(void *priv, enum wpa_driver_if_type type,
3834 		      const char *ifname, const u8 *addr, void *bss_ctx,
3835 		      void **drv_priv, char *force_ifname, u8 *if_addr,
3836 		      const char *bridge, int use_existing, int setup_ap);
3837 
3838 	/**
3839 	 * if_remove - Remove a virtual interface
3840 	 * @priv: Private driver interface data
3841 	 * @type: Interface type
3842 	 * @ifname: Interface name of the virtual interface to be removed
3843 	 * Returns: 0 on success, -1 on failure
3844 	 */
3845 	int (*if_remove)(void *priv, enum wpa_driver_if_type type,
3846 			 const char *ifname);
3847 
3848 	/**
3849 	 * set_sta_vlan - Bind a station into a specific interface (AP only)
3850 	 * @priv: Private driver interface data
3851 	 * @ifname: Interface (main or virtual BSS or VLAN)
3852 	 * @addr: MAC address of the associated station
3853 	 * @vlan_id: VLAN ID
3854 	 * @link_id: The link ID or -1 for non-MLO
3855 	 * Returns: 0 on success, -1 on failure
3856 	 *
3857 	 * This function is used to bind a station to a specific virtual
3858 	 * interface. It is only used if when virtual interfaces are supported,
3859 	 * e.g., to assign stations to different VLAN interfaces based on
3860 	 * information from a RADIUS server. This allows separate broadcast
3861 	 * domains to be used with a single BSS.
3862 	 */
3863 	int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
3864 			    int vlan_id, int link_id);
3865 
3866 	/**
3867 	 * commit - Optional commit changes handler (AP only)
3868 	 * @priv: driver private data
3869 	 * Returns: 0 on success, -1 on failure
3870 	 *
3871 	 * This optional handler function can be registered if the driver
3872 	 * interface implementation needs to commit changes (e.g., by setting
3873 	 * network interface up) at the end of initial configuration. If set,
3874 	 * this handler will be called after initial setup has been completed.
3875 	 */
3876 	int (*commit)(void *priv);
3877 
3878 	/**
3879 	 * set_radius_acl_auth - Notification of RADIUS ACL change
3880 	 * @priv: Private driver interface data
3881 	 * @mac: MAC address of the station
3882 	 * @accepted: Whether the station was accepted
3883 	 * @session_timeout: Session timeout for the station
3884 	 * Returns: 0 on success, -1 on failure
3885 	 */
3886 	int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
3887 				   u32 session_timeout);
3888 
3889 	/**
3890 	 * set_radius_acl_expire - Notification of RADIUS ACL expiration
3891 	 * @priv: Private driver interface data
3892 	 * @mac: MAC address of the station
3893 	 * Returns: 0 on success, -1 on failure
3894 	 */
3895 	int (*set_radius_acl_expire)(void *priv, const u8 *mac);
3896 
3897 	/**
3898 	 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
3899 	 * @priv: Private driver interface data
3900 	 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
3901 	 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
3902 	 *	extra IE(s)
3903 	 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
3904 	 *	to remove extra IE(s)
3905 	 * Returns: 0 on success, -1 on failure
3906 	 *
3907 	 * This is an optional function to add WPS IE in the kernel driver for
3908 	 * Beacon and Probe Response frames. This can be left undefined (set
3909 	 * to %NULL) if the driver uses the Beacon template from set_ap()
3910 	 * and does not process Probe Request frames. If the driver takes care
3911 	 * of (Re)Association frame processing, the assocresp buffer includes
3912 	 * WPS IE(s) that need to be added to (Re)Association Response frames
3913 	 * whenever a (Re)Association Request frame indicated use of WPS.
3914 	 *
3915 	 * This will also be used to add P2P IE(s) into Beacon/Probe Response
3916 	 * frames when operating as a GO. The driver is responsible for adding
3917 	 * timing related attributes (e.g., NoA) in addition to the IEs
3918 	 * included here by appending them after these buffers. This call is
3919 	 * also used to provide Probe Response IEs for P2P Listen state
3920 	 * operations for drivers that generate the Probe Response frames
3921 	 * internally.
3922 	 *
3923 	 * DEPRECATED - use set_ap() instead
3924 	 */
3925 	int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
3926 			     const struct wpabuf *proberesp,
3927 			     const struct wpabuf *assocresp);
3928 
3929 	/**
3930 	 * set_supp_port - Set IEEE 802.1X Supplicant Port status
3931 	 * @priv: Private driver interface data
3932 	 * @authorized: Whether the port is authorized
3933 	 * Returns: 0 on success, -1 on failure
3934 	 */
3935 	int (*set_supp_port)(void *priv, int authorized);
3936 
3937 	/**
3938 	 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
3939 	 * @priv: Private driver interface data
3940 	 * @addr: MAC address of the associated station
3941 	 * @aid: Association ID
3942 	 * @val: 1 = bind to 4-address WDS; 0 = unbind
3943 	 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
3944 	 *	to indicate that bridge is not to be used
3945 	 * @ifname_wds: Buffer to return the interface name for the new WDS
3946 	 *	station or %NULL to indicate name is not returned.
3947 	 * Returns: 0 on success, -1 on failure
3948 	 */
3949 	int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
3950 			   const char *bridge_ifname, char *ifname_wds);
3951 
3952 	/**
3953 	 * send_action - Transmit an Action frame
3954 	 * @priv: Private driver interface data
3955 	 * @freq: Frequency (in MHz) of the channel
3956 	 * @wait: Time to wait off-channel for a response (in ms), or zero
3957 	 * @dst: Destination MAC address (Address 1)
3958 	 * @src: Source MAC address (Address 2)
3959 	 * @bssid: BSSID (Address 3)
3960 	 * @data: Frame body
3961 	 * @data_len: data length in octets
3962 	 @ @no_cck: Whether CCK rates must not be used to transmit this frame
3963 	 * Returns: 0 on success, -1 on failure
3964 	 *
3965 	 * This command can be used to request the driver to transmit an action
3966 	 * frame to the specified destination.
3967 	 *
3968 	 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3969 	 * be transmitted on the given channel and the device will wait for a
3970 	 * response on that channel for the given wait time.
3971 	 *
3972 	 * If the flag is not set, the wait time will be ignored. In this case,
3973 	 * if a remain-on-channel duration is in progress, the frame must be
3974 	 * transmitted on that channel; alternatively the frame may be sent on
3975 	 * the current operational channel (if in associated state in station
3976 	 * mode or while operating as an AP.)
3977 	 *
3978 	 * If @src differs from the device MAC address, use of a random
3979 	 * transmitter address is requested for this message exchange.
3980 	 */
3981 	int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
3982 			   const u8 *dst, const u8 *src, const u8 *bssid,
3983 			   const u8 *data, size_t data_len, int no_cck);
3984 
3985 	/**
3986 	 * send_action_cancel_wait - Cancel action frame TX wait
3987 	 * @priv: Private driver interface data
3988 	 *
3989 	 * This command cancels the wait time associated with sending an action
3990 	 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3991 	 * set in the driver flags.
3992 	 */
3993 	void (*send_action_cancel_wait)(void *priv);
3994 
3995 	/**
3996 	 * remain_on_channel - Remain awake on a channel
3997 	 * @priv: Private driver interface data
3998 	 * @freq: Frequency (in MHz) of the channel
3999 	 * @duration: Duration in milliseconds
4000 	 * Returns: 0 on success, -1 on failure
4001 	 *
4002 	 * This command is used to request the driver to remain awake on the
4003 	 * specified channel for the specified duration and report received
4004 	 * Action frames with EVENT_RX_MGMT events. Optionally, received
4005 	 * Probe Request frames may also be requested to be reported by calling
4006 	 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
4007 	 *
4008 	 * The driver may not be at the requested channel when this function
4009 	 * returns, i.e., the return code is only indicating whether the
4010 	 * request was accepted. The caller will need to wait until the
4011 	 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
4012 	 * completed the channel change. This may take some time due to other
4013 	 * need for the radio and the caller should be prepared to timing out
4014 	 * its wait since there are no guarantees on when this request can be
4015 	 * executed.
4016 	 */
4017 	int (*remain_on_channel)(void *priv, unsigned int freq,
4018 				 unsigned int duration);
4019 
4020 	/**
4021 	 * cancel_remain_on_channel - Cancel remain-on-channel operation
4022 	 * @priv: Private driver interface data
4023 	 *
4024 	 * This command can be used to cancel a remain-on-channel operation
4025 	 * before its originally requested duration has passed. This could be
4026 	 * used, e.g., when remain_on_channel() is used to request extra time
4027 	 * to receive a response to an Action frame and the response is
4028 	 * received when there is still unneeded time remaining on the
4029 	 * remain-on-channel operation.
4030 	 */
4031 	int (*cancel_remain_on_channel)(void *priv);
4032 
4033 	/**
4034 	 * probe_req_report - Request Probe Request frames to be indicated
4035 	 * @priv: Private driver interface data
4036 	 * @report: Whether to report received Probe Request frames
4037 	 * Returns: 0 on success, -1 on failure (or if not supported)
4038 	 *
4039 	 * This command can be used to request the driver to indicate when
4040 	 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
4041 	 * Since this operation may require extra resources, e.g., due to less
4042 	 * optimal hardware/firmware RX filtering, many drivers may disable
4043 	 * Probe Request reporting at least in station mode. This command is
4044 	 * used to notify the driver when the Probe Request frames need to be
4045 	 * reported, e.g., during remain-on-channel operations.
4046 	 */
4047 	int (*probe_req_report)(void *priv, int report);
4048 
4049 	/**
4050 	 * deinit_ap - Deinitialize AP mode
4051 	 * @priv: Private driver interface data
4052 	 * Returns: 0 on success, -1 on failure (or if not supported)
4053 	 *
4054 	 * This optional function can be used to disable AP mode related
4055 	 * configuration. If the interface was not dynamically added,
4056 	 * change the driver mode to station mode to allow normal station
4057 	 * operations like scanning to be completed.
4058 	 */
4059 	int (*deinit_ap)(void *priv);
4060 
4061 	/**
4062 	 * deinit_p2p_cli - Deinitialize P2P client mode
4063 	 * @priv: Private driver interface data
4064 	 * Returns: 0 on success, -1 on failure (or if not supported)
4065 	 *
4066 	 * This optional function can be used to disable P2P client mode. If the
4067 	 * interface was not dynamically added, change the interface type back
4068 	 * to station mode.
4069 	 */
4070 	int (*deinit_p2p_cli)(void *priv);
4071 
4072 	/**
4073 	 * suspend - Notification on system suspend/hibernate event
4074 	 * @priv: Private driver interface data
4075 	 */
4076 	void (*suspend)(void *priv);
4077 
4078 	/**
4079 	 * resume - Notification on system resume/thaw event
4080 	 * @priv: Private driver interface data
4081 	 */
4082 	void (*resume)(void *priv);
4083 
4084 	/**
4085 	 * signal_monitor - Set signal monitoring parameters
4086 	 * @priv: Private driver interface data
4087 	 * @threshold: Threshold value for signal change events; 0 = disabled
4088 	 * @hysteresis: Minimum change in signal strength before indicating a
4089 	 *	new event
4090 	 * Returns: 0 on success, -1 on failure (or if not supported)
4091 	 *
4092 	 * This function can be used to configure monitoring of signal strength
4093 	 * with the current AP. Whenever signal strength drops below the
4094 	 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
4095 	 * should be generated assuming the signal strength has changed at
4096 	 * least %hysteresis from the previously indicated signal change event.
4097 	 */
4098 	int (*signal_monitor)(void *priv, int threshold, int hysteresis);
4099 
4100 	/**
4101 	 * get_noa - Get current Notice of Absence attribute payload
4102 	 * @priv: Private driver interface data
4103 	 * @buf: Buffer for returning NoA
4104 	 * @buf_len: Buffer length in octets
4105 	 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
4106 	 * advertized, or -1 on failure
4107 	 *
4108 	 * This function is used to fetch the current Notice of Absence
4109 	 * attribute value from GO.
4110 	 */
4111 	int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
4112 
4113 	/**
4114 	 * set_noa - Set Notice of Absence parameters for GO (testing)
4115 	 * @priv: Private driver interface data
4116 	 * @count: Count
4117 	 * @start: Start time in ms from next TBTT
4118 	 * @duration: Duration in ms
4119 	 * Returns: 0 on success or -1 on failure
4120 	 *
4121 	 * This function is used to set Notice of Absence parameters for GO. It
4122 	 * is used only for testing. To disable NoA, all parameters are set to
4123 	 * 0.
4124 	 */
4125 	int (*set_noa)(void *priv, u8 count, int start, int duration);
4126 
4127 	/**
4128 	 * set_p2p_powersave - Set P2P power save options
4129 	 * @priv: Private driver interface data
4130 	 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
4131 	 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
4132 	 * @ctwindow: 0.. = change (msec), -1 = no change
4133 	 * Returns: 0 on success or -1 on failure
4134 	 */
4135 	int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
4136 				 int ctwindow);
4137 
4138 	/**
4139 	 * ampdu - Enable/disable aggregation
4140 	 * @priv: Private driver interface data
4141 	 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
4142 	 * Returns: 0 on success or -1 on failure
4143 	 */
4144 	int (*ampdu)(void *priv, int ampdu);
4145 
4146 	/**
4147 	 * get_radio_name - Get physical radio name for the device
4148 	 * @priv: Private driver interface data
4149 	 * Returns: Radio name or %NULL if not known
4150 	 *
4151 	 * The returned data must not be modified by the caller. It is assumed
4152 	 * that any interface that has the same radio name as another is
4153 	 * sharing the same physical radio. This information can be used to
4154 	 * share scan results etc. information between the virtual interfaces
4155 	 * to speed up various operations.
4156 	 */
4157 	const char * (*get_radio_name)(void *priv);
4158 
4159 	/**
4160 	 * send_tdls_mgmt - for sending TDLS management packets
4161 	 * @priv: private driver interface data
4162 	 * @dst: Destination (peer) MAC address
4163 	 * @action_code: TDLS action code for the mssage
4164 	 * @dialog_token: Dialog Token to use in the message (if needed)
4165 	 * @status_code: Status Code or Reason Code to use (if needed)
4166 	 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
4167 	 * @initiator: Is the current end the TDLS link initiator
4168 	 * @buf: TDLS IEs to add to the message
4169 	 * @len: Length of buf in octets
4170 	 * @link_id: If >= 0 indicates the link of the AP MLD to specify the
4171 	 * operating channel on which to send a TDLS Discovery Response frame.
4172 	 * Returns: 0 on success, negative (<0) on failure
4173 	 *
4174 	 * This optional function can be used to send packet to driver which is
4175 	 * responsible for receiving and sending all TDLS packets.
4176 	 */
4177 	int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
4178 			      u8 dialog_token, u16 status_code, u32 peer_capab,
4179 			      int initiator, const u8 *buf, size_t len,
4180 			      int link_id);
4181 
4182 	/**
4183 	 * tdls_oper - Ask the driver to perform high-level TDLS operations
4184 	 * @priv: Private driver interface data
4185 	 * @oper: TDLS high-level operation. See %enum tdls_oper
4186 	 * @peer: Destination (peer) MAC address
4187 	 * Returns: 0 on success, negative (<0) on failure
4188 	 *
4189 	 * This optional function can be used to send high-level TDLS commands
4190 	 * to the driver.
4191 	 */
4192 	int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
4193 
4194 	/**
4195 	 * wnm_oper - Notify driver of the WNM frame reception
4196 	 * @priv: Private driver interface data
4197 	 * @oper: WNM operation. See %enum wnm_oper
4198 	 * @peer: Destination (peer) MAC address
4199 	 * @buf: Buffer for the driver to fill in (for getting IE)
4200 	 * @buf_len: Return the len of buf
4201 	 * Returns: 0 on success, negative (<0) on failure
4202 	 */
4203 	int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
4204 			u8 *buf, u16 *buf_len);
4205 
4206 	/**
4207 	 * set_qos_map - Set QoS Map
4208 	 * @priv: Private driver interface data
4209 	 * @qos_map_set: QoS Map
4210 	 * @qos_map_set_len: Length of QoS Map
4211 	 */
4212 	int (*set_qos_map)(void *priv, const u8 *qos_map_set,
4213 			   u8 qos_map_set_len);
4214 
4215 	/**
4216 	 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
4217 	 * @priv: Private driver interface data
4218 	 * @version: IP version of the IP address, 4 or 6
4219 	 * @ipaddr: IP address for the neigh entry
4220 	 * @prefixlen: IP address prefix length
4221 	 * @addr: Corresponding MAC address
4222 	 * Returns: 0 on success, negative (<0) on failure
4223 	 */
4224 	int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
4225 			       int prefixlen, const u8 *addr);
4226 
4227 	/**
4228 	 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
4229 	 * @priv: Private driver interface data
4230 	 * @version: IP version of the IP address, 4 or 6
4231 	 * @ipaddr: IP address for the neigh entry
4232 	 * Returns: 0 on success, negative (<0) on failure
4233 	 */
4234 	int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
4235 
4236 	/**
4237 	 * br_port_set_attr - Set a bridge port attribute
4238 	 * @attr: Bridge port attribute to set
4239 	 * @val: Value to be set
4240 	 * Returns: 0 on success, negative (<0) on failure
4241 	 */
4242 	int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
4243 				unsigned int val);
4244 
4245 	/**
4246 	 * br_port_set_attr - Set a bridge network parameter
4247 	 * @param: Bridge parameter to set
4248 	 * @val: Value to be set
4249 	 * Returns: 0 on success, negative (<0) on failure
4250 	 */
4251 	int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
4252 				unsigned int val);
4253 
4254 	/**
4255 	 * get_wowlan - Get wake-on-wireless status
4256 	 * @priv: Private driver interface data
4257 	 */
4258 	int (*get_wowlan)(void *priv);
4259 
4260 	/**
4261 	 * set_wowlan - Set wake-on-wireless triggers
4262 	 * @priv: Private driver interface data
4263 	 * @triggers: wowlan triggers
4264 	 */
4265 	int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
4266 
4267 	/**
4268 	 * signal_poll - Get current connection information
4269 	 * @priv: Private driver interface data
4270 	 * @signal_info: Connection info structure
4271 	 */
4272 	int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
4273 
4274 	/**
4275 	 * mlo_signal_poll - Get current MLO connection information
4276 	 * @priv: Private driver interface data
4277 	 * @mlo_signal_info: MLO connection info structure
4278 	 */
4279 	int (*mlo_signal_poll)(void *priv,
4280 			       struct wpa_mlo_signal_info *mlo_signal_info);
4281 
4282 	/**
4283 	 * channel_info - Get parameters of the current operating channel
4284 	 * @priv: Private driver interface data
4285 	 * @channel_info: Channel info structure
4286 	 * Returns: 0 on success, negative (<0) on failure
4287 	 */
4288 	int (*channel_info)(void *priv, struct wpa_channel_info *channel_info);
4289 
4290 	/**
4291 	 * set_authmode - Set authentication algorithm(s) for static WEP
4292 	 * @priv: Private driver interface data
4293 	 * @authmode: 1=Open System, 2=Shared Key, 3=both
4294 	 * Returns: 0 on success, -1 on failure
4295 	 *
4296 	 * This function can be used to set authentication algorithms for AP
4297 	 * mode when static WEP is used. If the driver uses user space MLME/SME
4298 	 * implementation, there is no need to implement this function.
4299 	 *
4300 	 * DEPRECATED - use set_ap() instead
4301 	 */
4302 	int (*set_authmode)(void *priv, int authmode);
4303 
4304 #ifdef ANDROID
4305 	/**
4306 	 * driver_cmd - Execute driver-specific command
4307 	 * @priv: Private driver interface data
4308 	 * @cmd: Command to execute
4309 	 * @buf: Return buffer
4310 	 * @buf_len: Buffer length
4311 	 * Returns: 0 on success, -1 on failure
4312 	 */
4313 	int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
4314 #endif /* ANDROID */
4315 
4316 	/**
4317 	 * vendor_cmd - Execute vendor specific command
4318 	 * @priv: Private driver interface data
4319 	 * @vendor_id: Vendor id
4320 	 * @subcmd: Vendor command id
4321 	 * @nested_attr_flag: Specifies if vendor subcommand uses nested
4322 	 *	attributes or not
4323 	 * @data: Vendor command parameters (%NULL if no parameters)
4324 	 * @data_len: Data length
4325 	 * @buf: Return buffer (%NULL to ignore reply)
4326 	 * Returns: 0 on success, negative (<0) on failure
4327 	 *
4328 	 * This function handles vendor specific commands that are passed to
4329 	 * the driver/device. The command is identified by vendor id and
4330 	 * command id. The nested_attr_flag specifies whether the subcommand
4331 	 * uses nested attributes or not. Parameters can be passed
4332 	 * as argument to the command in the data buffer. Reply (if any) will be
4333 	 * filled in the supplied return buffer.
4334 	 *
4335 	 * The exact driver behavior is driver interface and vendor specific. As
4336 	 * an example, this will be converted to a vendor specific cfg80211
4337 	 * command in case of the nl80211 driver interface.
4338 	 */
4339 	int (*vendor_cmd)(void *priv, unsigned int vendor_id,
4340 			  unsigned int subcmd, const u8 *data, size_t data_len,
4341 			  enum nested_attr nested_attr_flag,
4342 			  struct wpabuf *buf);
4343 
4344 	/**
4345 	 * set_rekey_info - Set rekey information
4346 	 * @priv: Private driver interface data
4347 	 * @kek: Current KEK
4348 	 * @kek_len: KEK length in octets
4349 	 * @kck: Current KCK
4350 	 * @kck_len: KCK length in octets
4351 	 * @replay_ctr: Current EAPOL-Key Replay Counter
4352 	 *
4353 	 * This optional function can be used to provide information for the
4354 	 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
4355 	 * while the host (including wpa_supplicant) is sleeping.
4356 	 */
4357 	void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
4358 			       const u8 *kck, size_t kck_len,
4359 			       const u8 *replay_ctr);
4360 
4361 	/**
4362 	 * sta_assoc - Station association indication
4363 	 * @priv: Private driver interface data
4364 	 * @own_addr: Source address and BSSID for association frame
4365 	 * @addr: MAC address of the station to associate
4366 	 * @reassoc: flag to indicate re-association
4367 	 * @status: association response status code
4368 	 * @ie: assoc response ie buffer
4369 	 * @len: ie buffer length
4370 	 * Returns: 0 on success, -1 on failure
4371 	 *
4372 	 * This function indicates the driver to send (Re)Association
4373 	 * Response frame to the station.
4374 	 */
4375 	 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
4376 			  int reassoc, u16 status, const u8 *ie, size_t len);
4377 
4378 	/**
4379 	 * sta_auth - Station authentication indication
4380 	 * @priv: private driver interface data
4381 	 * @params: Station authentication parameters
4382 	 *
4383 	 * Returns: 0 on success, -1 on failure
4384 	 */
4385 	 int (*sta_auth)(void *priv,
4386 			 struct wpa_driver_sta_auth_params *params);
4387 
4388 	/**
4389 	 * add_tspec - Add traffic stream
4390 	 * @priv: Private driver interface data
4391 	 * @addr: MAC address of the station to associate
4392 	 * @tspec_ie: tspec ie buffer
4393 	 * @tspec_ielen: tspec ie length
4394 	 * Returns: 0 on success, -1 on failure
4395 	 *
4396 	 * This function adds the traffic steam for the station
4397 	 * and fills the medium_time in tspec_ie.
4398 	 */
4399 	 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
4400 			  size_t tspec_ielen);
4401 
4402 	/**
4403 	 * add_sta_node - Add a station node in the driver
4404 	 * @priv: Private driver interface data
4405 	 * @addr: MAC address of the station to add
4406 	 * @auth_alg: authentication algorithm used by the station
4407 	 * Returns: 0 on success, -1 on failure
4408 	 *
4409 	 * This function adds the station node in the driver, when
4410 	 * the station gets added by FT-over-DS.
4411 	 */
4412 	int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
4413 
4414 	/**
4415 	 * sched_scan - Request the driver to initiate scheduled scan
4416 	 * @priv: Private driver interface data
4417 	 * @params: Scan parameters
4418 	 * Returns: 0 on success, -1 on failure
4419 	 *
4420 	 * This operation should be used for scheduled scan offload to
4421 	 * the hardware. Every time scan results are available, the
4422 	 * driver should report scan results event for wpa_supplicant
4423 	 * which will eventually request the results with
4424 	 * wpa_driver_get_scan_results2(). This operation is optional
4425 	 * and if not provided or if it returns -1, we fall back to
4426 	 * normal host-scheduled scans.
4427 	 */
4428 	int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
4429 
4430 	/**
4431 	 * stop_sched_scan - Request the driver to stop a scheduled scan
4432 	 * @priv: Private driver interface data
4433 	 * Returns: 0 on success, -1 on failure
4434 	 *
4435 	 * This should cause the scheduled scan to be stopped and
4436 	 * results should stop being sent. Must be supported if
4437 	 * sched_scan is supported.
4438 	 */
4439 	int (*stop_sched_scan)(void *priv);
4440 
4441 	/**
4442 	 * poll_client - Probe (null data or such) the given station
4443 	 * @priv: Private driver interface data
4444 	 * @own_addr: MAC address of sending interface
4445 	 * @addr: MAC address of the station to probe
4446 	 * @qos: Indicates whether station is QoS station
4447 	 *
4448 	 * This function is used to verify whether an associated station is
4449 	 * still present. This function does not need to be implemented if the
4450 	 * driver provides such inactivity polling mechanism.
4451 	 */
4452 	void (*poll_client)(void *priv, const u8 *own_addr,
4453 			    const u8 *addr, int qos);
4454 
4455 	/**
4456 	 * radio_disable - Disable/enable radio
4457 	 * @priv: Private driver interface data
4458 	 * @disabled: 1=disable 0=enable radio
4459 	 * Returns: 0 on success, -1 on failure
4460 	 *
4461 	 * This optional command is for testing purposes. It can be used to
4462 	 * disable the radio on a testbed device to simulate out-of-radio-range
4463 	 * conditions.
4464 	 */
4465 	int (*radio_disable)(void *priv, int disabled);
4466 
4467 	/**
4468 	 * switch_channel - Announce channel switch and migrate the GO to the
4469 	 * given frequency
4470 	 * @priv: Private driver interface data
4471 	 * @settings: Settings for CSA period and new channel
4472 	 * Returns: 0 on success, -1 on failure
4473 	 *
4474 	 * This function is used to move the GO to the legacy STA channel to
4475 	 * avoid frequency conflict in single channel concurrency.
4476 	 */
4477 	int (*switch_channel)(void *priv, struct csa_settings *settings);
4478 
4479 	/**
4480 	 * switch_color - Announce color switch and migrate the BSS to the
4481 	 * given color
4482 	 * @priv: Private driver interface data
4483 	 * @settings: Settings for CCA period and new color
4484 	 * Returns: 0 on success, -1 on failure
4485 	 *
4486 	 * This function is used to move the BSS to its new color.
4487 	 */
4488 	int (*switch_color)(void *priv, struct cca_settings *settings);
4489 
4490 	/**
4491 	 * add_tx_ts - Add traffic stream
4492 	 * @priv: Private driver interface data
4493 	 * @tsid: Traffic stream ID
4494 	 * @addr: Receiver address
4495 	 * @user_prio: User priority of the traffic stream
4496 	 * @admitted_time: Admitted time for this TS in units of
4497 	 *	32 microsecond periods (per second).
4498 	 * Returns: 0 on success, -1 on failure
4499 	 */
4500 	int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
4501 			 u16 admitted_time);
4502 
4503 	/**
4504 	 * del_tx_ts - Delete traffic stream
4505 	 * @priv: Private driver interface data
4506 	 * @tsid: Traffic stream ID
4507 	 * @addr: Receiver address
4508 	 * Returns: 0 on success, -1 on failure
4509 	 */
4510 	int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
4511 
4512 	/**
4513 	 * Enable channel-switching with TDLS peer
4514 	 * @priv: Private driver interface data
4515 	 * @addr: MAC address of the TDLS peer
4516 	 * @oper_class: Operating class of the switch channel
4517 	 * @params: Channel specification
4518 	 * Returns: 0 on success, -1 on failure
4519 	 *
4520 	 * The function indicates to driver that it can start switching to a
4521 	 * different channel with a specified TDLS peer. The switching is
4522 	 * assumed on until canceled with tdls_disable_channel_switch().
4523 	 */
4524 	int (*tdls_enable_channel_switch)(
4525 		void *priv, const u8 *addr, u8 oper_class,
4526 		const struct hostapd_freq_params *params);
4527 
4528 	/**
4529 	 * Disable channel switching with TDLS peer
4530 	 * @priv: Private driver interface data
4531 	 * @addr: MAC address of the TDLS peer
4532 	 * Returns: 0 on success, -1 on failure
4533 	 *
4534 	 * This function indicates to the driver that it should stop switching
4535 	 * with a given TDLS peer.
4536 	 */
4537 	int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
4538 
4539 	/**
4540 	 * start_dfs_cac - Listen for radar interference on the channel
4541 	 * @priv: Private driver interface data
4542 	 * @freq: Channel parameters
4543 	 * Returns: 0 on success, -1 on failure
4544 	 */
4545 	int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
4546 
4547 	/**
4548 	 * stop_ap - Removes beacon from AP
4549 	 * @priv: Private driver interface data
4550 	 * Returns: 0 on success, -1 on failure (or if not supported)
4551 	 *
4552 	 * This optional function can be used to disable AP mode related
4553 	 * configuration. Unlike deinit_ap, it does not change to station
4554 	 * mode.
4555 	 */
4556 	int (*stop_ap)(void *priv);
4557 
4558 	/**
4559 	 * get_survey - Retrieve survey data
4560 	 * @priv: Private driver interface data
4561 	 * @freq: If set, survey data for the specified frequency is only
4562 	 *	being requested. If not set, all survey data is requested.
4563 	 * Returns: 0 on success, -1 on failure
4564 	 *
4565 	 * Use this to retrieve:
4566 	 *
4567 	 * - the observed channel noise floor
4568 	 * - the amount of time we have spent on the channel
4569 	 * - the amount of time during which we have spent on the channel that
4570 	 *   the radio has determined the medium is busy and we cannot
4571 	 *   transmit
4572 	 * - the amount of time we have spent receiving data
4573 	 * - the amount of time we have spent transmitting data
4574 	 *
4575 	 * This data can be used for spectrum heuristics. One example is
4576 	 * Automatic Channel Selection (ACS). The channel survey data is
4577 	 * kept on a linked list on the channel data, one entry is added
4578 	 * for each survey. The min_nf of the channel is updated for each
4579 	 * survey.
4580 	 */
4581 	int (*get_survey)(void *priv, unsigned int freq);
4582 
4583 	/**
4584 	 * status - Get driver interface status information
4585 	 * @priv: Private driver interface data
4586 	 * @buf: Buffer for printing the status information
4587 	 * @buflen: Maximum length of the buffer
4588 	 * Returns: Length of written status information or -1 on failure
4589 	 */
4590 	int (*status)(void *priv, char *buf, size_t buflen);
4591 
4592 	/**
4593 	 * roaming - Set roaming policy for driver-based BSS selection
4594 	 * @priv: Private driver interface data
4595 	 * @allowed: Whether roaming within ESS is allowed
4596 	 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
4597 	 * Returns: Length of written status information or -1 on failure
4598 	 *
4599 	 * This optional callback can be used to update roaming policy from the
4600 	 * associate() command (bssid being set there indicates that the driver
4601 	 * should not roam before getting this roaming() call to allow roaming.
4602 	 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
4603 	 * capability, roaming policy is handled within wpa_supplicant and there
4604 	 * is no need to implement or react to this callback.
4605 	 */
4606 	int (*roaming)(void *priv, int allowed, const u8 *bssid);
4607 
4608 	/**
4609 	 * disable_fils - Enable/disable FILS feature
4610 	 * @priv: Private driver interface data
4611 	 * @disable: 0-enable and 1-disable FILS feature
4612 	 * Returns: 0 on success, -1 on failure
4613 	 *
4614 	 * This callback can be used to configure driver and below layers to
4615 	 * enable/disable all FILS features.
4616 	 */
4617 	int (*disable_fils)(void *priv, int disable);
4618 
4619 	/**
4620 	 * set_mac_addr - Set MAC address
4621 	 * @priv: Private driver interface data
4622 	 * @addr: MAC address to use or %NULL for setting back to permanent
4623 	 * Returns: 0 on success, -1 on failure
4624 	 */
4625 	int (*set_mac_addr)(void *priv, const u8 *addr);
4626 
4627 #ifdef CONFIG_MACSEC
4628 	int (*macsec_init)(void *priv, struct macsec_init_params *params);
4629 
4630 	int (*macsec_deinit)(void *priv);
4631 
4632 	/**
4633 	 * macsec_get_capability - Inform MKA of this driver's capability
4634 	 * @priv: Private driver interface data
4635 	 * @cap: Driver's capability
4636 	 * Returns: 0 on success, -1 on failure
4637 	 */
4638 	int (*macsec_get_capability)(void *priv, enum macsec_cap *cap);
4639 
4640 	/**
4641 	 * enable_protect_frames - Set protect frames status
4642 	 * @priv: Private driver interface data
4643 	 * @enabled: true = protect frames enabled
4644 	 *           false = protect frames disabled
4645 	 * Returns: 0 on success, -1 on failure (or if not supported)
4646 	 */
4647 	int (*enable_protect_frames)(void *priv, bool enabled);
4648 
4649 	/**
4650 	 * enable_encrypt - Set encryption status
4651 	 * @priv: Private driver interface data
4652 	 * @enabled: true = encrypt outgoing traffic
4653 	 *           false = integrity-only protection on outgoing traffic
4654 	 * Returns: 0 on success, -1 on failure (or if not supported)
4655 	 */
4656 	int (*enable_encrypt)(void *priv, bool enabled);
4657 
4658 	/**
4659 	 * set_replay_protect - Set replay protect status and window size
4660 	 * @priv: Private driver interface data
4661 	 * @enabled: true = replay protect enabled
4662 	 *           false = replay protect disabled
4663 	 * @window: replay window size, valid only when replay protect enabled
4664 	 * Returns: 0 on success, -1 on failure (or if not supported)
4665 	 */
4666 	int (*set_replay_protect)(void *priv, bool enabled, u32 window);
4667 
4668 	/**
4669 	 * set_offload - Set MACsec hardware offload
4670 	 * @priv: Private driver interface data
4671 	 * @offload: 0 = MACSEC_OFFLOAD_OFF
4672 	 *           1 = MACSEC_OFFLOAD_PHY
4673 	 *           2 = MACSEC_OFFLOAD_MAC
4674 	 * Returns: 0 on success, -1 on failure (or if not supported)
4675 	 */
4676 	int (*set_offload)(void *priv, u8 offload);
4677 
4678 	/**
4679 	 * set_current_cipher_suite - Set current cipher suite
4680 	 * @priv: Private driver interface data
4681 	 * @cs: EUI64 identifier
4682 	 * Returns: 0 on success, -1 on failure (or if not supported)
4683 	 */
4684 	int (*set_current_cipher_suite)(void *priv, u64 cs);
4685 
4686 	/**
4687 	 * enable_controlled_port - Set controlled port status
4688 	 * @priv: Private driver interface data
4689 	 * @enabled: true = controlled port enabled
4690 	 *           false = controlled port disabled
4691 	 * Returns: 0 on success, -1 on failure (or if not supported)
4692 	 */
4693 	int (*enable_controlled_port)(void *priv, bool enabled);
4694 
4695 	/**
4696 	 * get_receive_lowest_pn - Get receive lowest pn
4697 	 * @priv: Private driver interface data
4698 	 * @sa: secure association
4699 	 * Returns: 0 on success, -1 on failure (or if not supported)
4700 	 */
4701 	int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa);
4702 
4703 	/**
4704 	 * get_transmit_next_pn - Get transmit next pn
4705 	 * @priv: Private driver interface data
4706 	 * @sa: secure association
4707 	 * Returns: 0 on success, -1 on failure (or if not supported)
4708 	 */
4709 	int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa);
4710 
4711 	/**
4712 	 * set_transmit_next_pn - Set transmit next pn
4713 	 * @priv: Private driver interface data
4714 	 * @sa: secure association
4715 	 * Returns: 0 on success, -1 on failure (or if not supported)
4716 	 */
4717 	int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa);
4718 
4719 	/**
4720 	 * set_receive_lowest_pn - Set receive lowest PN
4721 	 * @priv: Private driver interface data
4722 	 * @sa: secure association
4723 	 * Returns: 0 on success, -1 on failure (or if not supported)
4724 	 */
4725 	int (*set_receive_lowest_pn)(void *priv, struct receive_sa *sa);
4726 
4727 	/**
4728 	 * create_receive_sc - create secure channel for receiving
4729 	 * @priv: Private driver interface data
4730 	 * @sc: secure channel
4731 	 * @conf_offset: confidentiality offset (0, 30, or 50)
4732 	 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
4733 	 *	2 = Strict)
4734 	 * Returns: 0 on success, -1 on failure (or if not supported)
4735 	 */
4736 	int (*create_receive_sc)(void *priv, struct receive_sc *sc,
4737 				 unsigned int conf_offset,
4738 				 int validation);
4739 
4740 	/**
4741 	 * delete_receive_sc - delete secure connection for receiving
4742 	 * @priv: private driver interface data from init()
4743 	 * @sc: secure channel
4744 	 * Returns: 0 on success, -1 on failure
4745 	 */
4746 	int (*delete_receive_sc)(void *priv, struct receive_sc *sc);
4747 
4748 	/**
4749 	 * create_receive_sa - create secure association for receive
4750 	 * @priv: private driver interface data from init()
4751 	 * @sa: secure association
4752 	 * Returns: 0 on success, -1 on failure
4753 	 */
4754 	int (*create_receive_sa)(void *priv, struct receive_sa *sa);
4755 
4756 	/**
4757 	 * delete_receive_sa - Delete secure association for receive
4758 	 * @priv: Private driver interface data from init()
4759 	 * @sa: Secure association
4760 	 * Returns: 0 on success, -1 on failure
4761 	 */
4762 	int (*delete_receive_sa)(void *priv, struct receive_sa *sa);
4763 
4764 	/**
4765 	 * enable_receive_sa - enable the SA for receive
4766 	 * @priv: private driver interface data from init()
4767 	 * @sa: secure association
4768 	 * Returns: 0 on success, -1 on failure
4769 	 */
4770 	int (*enable_receive_sa)(void *priv, struct receive_sa *sa);
4771 
4772 	/**
4773 	 * disable_receive_sa - disable SA for receive
4774 	 * @priv: private driver interface data from init()
4775 	 * @sa: secure association
4776 	 * Returns: 0 on success, -1 on failure
4777 	 */
4778 	int (*disable_receive_sa)(void *priv, struct receive_sa *sa);
4779 
4780 	/**
4781 	 * create_transmit_sc - create secure connection for transmit
4782 	 * @priv: private driver interface data from init()
4783 	 * @sc: secure channel
4784 	 * @conf_offset: confidentiality offset (0, 30, or 50)
4785 	 * Returns: 0 on success, -1 on failure
4786 	 */
4787 	int (*create_transmit_sc)(void *priv, struct transmit_sc *sc,
4788 				  unsigned int conf_offset);
4789 
4790 	/**
4791 	 * delete_transmit_sc - delete secure connection for transmit
4792 	 * @priv: private driver interface data from init()
4793 	 * @sc: secure channel
4794 	 * Returns: 0 on success, -1 on failure
4795 	 */
4796 	int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc);
4797 
4798 	/**
4799 	 * create_transmit_sa - create secure association for transmit
4800 	 * @priv: private driver interface data from init()
4801 	 * @sa: secure association
4802 	 * Returns: 0 on success, -1 on failure
4803 	 */
4804 	int (*create_transmit_sa)(void *priv, struct transmit_sa *sa);
4805 
4806 	/**
4807 	 * delete_transmit_sa - Delete secure association for transmit
4808 	 * @priv: Private driver interface data from init()
4809 	 * @sa: Secure association
4810 	 * Returns: 0 on success, -1 on failure
4811 	 */
4812 	int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa);
4813 
4814 	/**
4815 	 * enable_transmit_sa - enable SA for transmit
4816 	 * @priv: private driver interface data from init()
4817 	 * @sa: secure association
4818 	 * Returns: 0 on success, -1 on failure
4819 	 */
4820 	int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa);
4821 
4822 	/**
4823 	 * disable_transmit_sa - disable SA for transmit
4824 	 * @priv: private driver interface data from init()
4825 	 * @sa: secure association
4826 	 * Returns: 0 on success, -1 on failure
4827 	 */
4828 	int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa);
4829 #endif /* CONFIG_MACSEC */
4830 
4831 	/**
4832 	 * init_mesh - Driver specific initialization for mesh
4833 	 * @priv: Private driver interface data
4834 	 * Returns: 0 on success, -1 on failure
4835 	 */
4836 	int (*init_mesh)(void *priv);
4837 
4838 	/**
4839 	 * join_mesh - Join a mesh network
4840 	 * @priv: Private driver interface data
4841 	 * @params: Mesh configuration parameters
4842 	 * Returns: 0 on success, -1 on failure
4843 	 */
4844 	int (*join_mesh)(void *priv,
4845 			 struct wpa_driver_mesh_join_params *params);
4846 
4847 	/**
4848 	 * leave_mesh - Leave a mesh network
4849 	 * @priv: Private driver interface data
4850 	 * Returns 0 on success, -1 on failure
4851 	 */
4852 	int (*leave_mesh)(void *priv);
4853 
4854 	/**
4855 	 * probe_mesh_link - Inject a frame over direct mesh link to a given
4856 	 *	peer skipping the next_hop lookup from mpath table.
4857 	 * @priv: Private driver interface data
4858 	 * @addr: Peer MAC address
4859 	 * @eth: Ethernet frame to be sent
4860 	 * @len: Ethernet frame lengtn in bytes
4861 	 * Returns 0 on success, -1 on failure
4862 	 */
4863 	int (*probe_mesh_link)(void *priv, const u8 *addr, const u8 *eth,
4864 			       size_t len);
4865 
4866 	/**
4867 	 * do_acs - Automatically select channel
4868 	 * @priv: Private driver interface data
4869 	 * @params: Parameters for ACS
4870 	 * Returns 0 on success, -1 on failure
4871 	 *
4872 	 * This command can be used to offload ACS to the driver if the driver
4873 	 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
4874 	 */
4875 	int (*do_acs)(void *priv, struct drv_acs_params *params);
4876 
4877 	/**
4878 	 * set_band - Notify driver of band(s) selection
4879 	 * @priv: Private driver interface data
4880 	 * @band_mask: The selected band(s) bit mask (from enum set_band)
4881 	 * Returns 0 on success, -1 on failure
4882 	 */
4883 	int (*set_band)(void *priv, u32 band_mask);
4884 
4885 	/**
4886 	 * get_pref_freq_list - Get preferred frequency list for an interface
4887 	 * @priv: Private driver interface data
4888 	 * @if_type: Interface type
4889 	 * @num: Number of channels
4890 	 * @freq_list: Weighted preferred channel list
4891 	 * Returns 0 on success, -1 on failure
4892 	 *
4893 	 * This command can be used to query the preferred frequency list from
4894 	 * the driver specific to a particular interface type. The freq_list
4895 	 * array needs to have room for *num entries. *num will be updated to
4896 	 * indicate the number of entries fetched from the driver.
4897 	 */
4898 	int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
4899 				  unsigned int *num,
4900 				  struct weighted_pcl *freq_list);
4901 
4902 	/**
4903 	 * set_prob_oper_freq - Indicate probable P2P operating channel
4904 	 * @priv: Private driver interface data
4905 	 * @freq: Channel frequency in MHz
4906 	 * Returns 0 on success, -1 on failure
4907 	 *
4908 	 * This command can be used to inform the driver of the operating
4909 	 * frequency that an ongoing P2P group formation is likely to come up
4910 	 * on. Local device is assuming P2P Client role.
4911 	 */
4912 	int (*set_prob_oper_freq)(void *priv, unsigned int freq);
4913 
4914 	/**
4915 	 * abort_scan - Request the driver to abort an ongoing scan
4916 	 * @priv: Private driver interface data
4917 	 * @scan_cookie: Cookie identifying the scan request. This is used only
4918 	 *	when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
4919 	 *	was used to trigger scan. Otherwise, 0 is used.
4920 	 * Returns 0 on success, -1 on failure
4921 	 */
4922 	int (*abort_scan)(void *priv, u64 scan_cookie);
4923 
4924 	/**
4925 	 * configure_data_frame_filters - Request to configure frame filters
4926 	 * @priv: Private driver interface data
4927 	 * @filter_flags: The type of frames to filter (bitfield of
4928 	 * WPA_DATA_FRAME_FILTER_FLAG_*)
4929 	 * Returns: 0 on success or -1 on failure
4930 	 */
4931 	int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
4932 
4933 	/**
4934 	 * get_ext_capab - Get extended capabilities for the specified interface
4935 	 * @priv: Private driver interface data
4936 	 * @type: Interface type for which to get extended capabilities
4937 	 * @ext_capab: Extended capabilities fetched
4938 	 * @ext_capab_mask: Extended capabilities mask
4939 	 * @ext_capab_len: Length of the extended capabilities
4940 	 * Returns: 0 on success or -1 on failure
4941 	 */
4942 	int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
4943 			     const u8 **ext_capab, const u8 **ext_capab_mask,
4944 			     unsigned int *ext_capab_len);
4945 
4946 	/**
4947 	 * get_mld_capab - Get MLD capabilities for the specified interface
4948 	 * @priv: Private driver interface data
4949 	 * @type: Interface type for which to get MLD capabilities
4950 	 * @eml_capa: EML capabilities
4951 	 * @mld_capa_and_ops: MLD Capabilities and Operations
4952 	 * Returns: 0 on success or -1 on failure
4953 	 */
4954 	int (*get_mld_capab)(void *priv, enum wpa_driver_if_type type,
4955 			     u16 *eml_capa, u16 *mld_capa_and_ops);
4956 
4957 	/**
4958 	 * p2p_lo_start - Start offloading P2P listen to device
4959 	 * @priv: Private driver interface data
4960 	 * @freq: Listening frequency (MHz) for P2P listen
4961 	 * @period: Length of the listen operation in milliseconds
4962 	 * @interval: Interval for running the listen operation in milliseconds
4963 	 * @count: Number of times to run the listen operation
4964 	 * @device_types: Device primary and secondary types
4965 	 * @dev_types_len: Number of bytes for device_types
4966 	 * @ies: P2P IE and WSC IE for Probe Response frames
4967 	 * @ies_len: Length of ies in bytes
4968 	 * Returns: 0 on success or -1 on failure
4969 	 */
4970 	int (*p2p_lo_start)(void *priv, unsigned int freq,
4971 			    unsigned int period, unsigned int interval,
4972 			    unsigned int count,
4973 			    const u8 *device_types, size_t dev_types_len,
4974 			    const u8 *ies, size_t ies_len);
4975 
4976 	/**
4977 	 * p2p_lo_stop - Stop P2P listen offload
4978 	 * @priv: Private driver interface data
4979 	 * Returns: 0 on success or -1 on failure
4980 	 */
4981 	int (*p2p_lo_stop)(void *priv);
4982 
4983 	/**
4984 	 * set_default_scan_ies - Set default scan IEs
4985 	 * @priv: Private driver interface data
4986 	 * @ies: Scan default IEs buffer
4987 	 * @ies_len: Length of IEs in bytes
4988 	 * Returns: 0 on success or -1 on failure
4989 	 *
4990 	 * The driver can use these by default when there are no scan IEs coming
4991 	 * in the subsequent scan requests. Also in case of one or more of IEs
4992 	 * given in set_default_scan_ies() are missing in the subsequent scan
4993 	 * request, the driver should merge the missing scan IEs in the scan
4994 	 * request from the IEs set by set_default_scan_ies() in the Probe
4995 	 * Request frames sent.
4996 	 */
4997 	int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);
4998 
4999 	/**
5000 	 * set_tdls_mode - Set TDLS trigger mode to the host driver
5001 	 * @priv: Private driver interface data
5002 	 * @tdls_external_control: Represents if TDLS external trigger control
5003 	 *  mode is enabled/disabled.
5004 	 *
5005 	 * This optional callback can be used to configure the TDLS external
5006 	 * trigger control mode to the host driver.
5007 	 */
5008 	int (*set_tdls_mode)(void *priv, int tdls_external_control);
5009 
5010 	/**
5011 	 * get_bss_transition_status - Get candidate BSS's transition status
5012 	 * @priv: Private driver interface data
5013 	 * @params: Candidate BSS list
5014 	 *
5015 	 * Get the accept or reject reason code for a list of BSS transition
5016 	 * candidates.
5017 	 */
5018 	struct wpa_bss_candidate_info *
5019 	(*get_bss_transition_status)(void *priv,
5020 				     struct wpa_bss_trans_info *params);
5021 	/**
5022 	 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
5023 	 * @priv: Private driver interface data
5024 	 * @ignore_disallow: 0 to not ignore, 1 to ignore
5025 	 * Returns: 0 on success, -1 on failure
5026 	 */
5027 	int (*ignore_assoc_disallow)(void *priv, int ignore_disallow);
5028 
5029 	/**
5030 	 * set_bssid_tmp_disallow - Set disallowed BSSIDs to the driver
5031 	 * @priv: Private driver interface data
5032 	 * @num_bssid: Number of temporarily disallowed BSSIDs
5033 	 * @bssids: List of temporarily disallowed BSSIDs
5034 	 */
5035 	int (*set_bssid_tmp_disallow)(void *priv, unsigned int num_bssid,
5036 				      const u8 *bssid);
5037 
5038 	/**
5039 	 * update_connect_params - Update the connection parameters
5040 	 * @priv: Private driver interface data
5041 	 * @params: Association parameters
5042 	 * @mask: Bit mask indicating which parameters in @params have to be
5043 	 *	updated
5044 	 * Returns: 0 on success, -1 on failure
5045 	 *
5046 	 * Update the connection parameters when in connected state so that the
5047 	 * driver uses the updated parameters for subsequent roaming. This is
5048 	 * used only with drivers that implement internal BSS selection and
5049 	 * roaming.
5050 	 */
5051 	int (*update_connect_params)(
5052 		void *priv, struct wpa_driver_associate_params *params,
5053 		enum wpa_drv_update_connect_params_mask mask);
5054 
5055 	/**
5056 	 * send_external_auth_status - Indicate the status of external
5057 	 * authentication processing to the host driver.
5058 	 * @priv: Private driver interface data
5059 	 * @params: Status of authentication processing.
5060 	 * Returns: 0 on success, -1 on failure
5061 	 */
5062 	int (*send_external_auth_status)(void *priv,
5063 					 struct external_auth *params);
5064 
5065 	/**
5066 	 * set_4addr_mode - Set 4-address mode
5067 	 * @priv: Private driver interface data
5068 	 * @bridge_ifname: Bridge interface name
5069 	 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
5070 	 * Returns: 0 on success, < 0 on failure
5071 	 */
5072 	int (*set_4addr_mode)(void *priv, const char *bridge_ifname, int val);
5073 
5074 	/**
5075 	 * update_dh_ie - Update DH IE
5076 	 * @priv: Private driver interface data
5077 	 * @peer_mac: Peer MAC address
5078 	 * @reason_code: Reacon code
5079 	 * @ie: DH IE
5080 	 * @ie_len: DH IE length in bytes
5081 	 * Returns: 0 on success, -1 on failure
5082 	 *
5083 	 * This callback is used to let the driver know the DH processing result
5084 	 * and DH IE for a pending association.
5085 	 */
5086 	int (*update_dh_ie)(void *priv, const u8 *peer_mac, u16 reason_code,
5087 			    const u8 *ie, size_t ie_len);
5088 
5089 	/**
5090 	 * dpp_listen - Notify driver about start/stop of DPP listen
5091 	 * @priv: Private driver interface data
5092 	 * @enable: Whether listen state is enabled (or disabled)
5093 	 * Returns: 0 on success, -1 on failure
5094 	 *
5095 	 * This optional callback can be used to update RX frame filtering to
5096 	 * explicitly allow reception of broadcast Public Action frames.
5097 	 */
5098 	int (*dpp_listen)(void *priv, bool enable);
5099 
5100 	/**
5101 	 * set_secure_ranging_ctx - Add or delete secure ranging parameters of
5102 	 * the specified peer to the driver.
5103 	 * @priv: Private driver interface data
5104 	 * @params: Secure ranging parameters
5105 	 * Returns: 0 on success, -1 on failure
5106 	 *
5107 	 */
5108 	int (*set_secure_ranging_ctx)(void *priv,
5109 				      struct secure_ranging_params *params);
5110 
5111 	/**
5112 	 * send_pasn_resp - Send PASN response for a set of peers to the
5113 	 * driver.
5114 	 * @priv: Private driver interface data
5115 	 * @params: Parameters holding peers and respective status.
5116 	 * Returns: 0 on success, -1 on failure
5117 	 */
5118 	int (*send_pasn_resp)(void *priv, struct pasn_auth *params);
5119 
5120 	/**
5121 	 * get_sta_mlo_info - Get the current multi-link association info
5122 	 * @priv: Private driver interface data
5123 	 * @mlo: Pointer to fill multi-link association info
5124 	 * Returns: 0 on success, -1 on failure
5125 	 *
5126 	 * This callback is used to fetch multi-link of the current association.
5127 	 */
5128 	int (*get_sta_mlo_info)(void *priv,
5129 				struct driver_sta_mlo_info *mlo_info);
5130 
5131 	/**
5132 	 * link_add - Add a link to the AP MLD interface
5133 	 * @priv: Private driver interface data
5134 	 * @link_id: The link ID
5135 	 * @addr: The MAC address to use for the link
5136 	 * Returns: 0 on success, negative value on failure
5137 	 */
5138 	int (*link_add)(void *priv, u8 link_id, const u8 *addr);
5139 
5140 #ifdef CONFIG_TESTING_OPTIONS
5141 	int (*register_frame)(void *priv, u16 type,
5142 			      const u8 *match, size_t match_len,
5143 			      bool multicast);
5144 #endif /* CONFIG_TESTING_OPTIONS */
5145 };
5146 
5147 /**
5148  * enum wpa_event_type - Event type for wpa_supplicant_event() calls
5149  */
5150 enum wpa_event_type {
5151 	/**
5152 	 * EVENT_ASSOC - Association completed
5153 	 *
5154 	 * This event needs to be delivered when the driver completes IEEE
5155 	 * 802.11 association or reassociation successfully.
5156 	 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
5157 	 * after this event has been generated. In addition, optional
5158 	 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
5159 	 * more information about the association. If the driver interface gets
5160 	 * both of these events at the same time, it can also include the
5161 	 * assoc_info data in EVENT_ASSOC call.
5162 	 */
5163 	EVENT_ASSOC,
5164 
5165 	/**
5166 	 * EVENT_DISASSOC - Association lost
5167 	 *
5168 	 * This event should be called when association is lost either due to
5169 	 * receiving deauthenticate or disassociate frame from the AP or when
5170 	 * sending either of these frames to the current AP. If the driver
5171 	 * supports separate deauthentication event, EVENT_DISASSOC should only
5172 	 * be used for disassociation and EVENT_DEAUTH for deauthentication.
5173 	 * In AP mode, union wpa_event_data::disassoc_info is required.
5174 	 */
5175 	EVENT_DISASSOC,
5176 
5177 	/**
5178 	 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
5179 	 *
5180 	 * This event must be delivered when a Michael MIC error is detected by
5181 	 * the local driver. Additional data for event processing is
5182 	 * provided with union wpa_event_data::michael_mic_failure. This
5183 	 * information is used to request new encryption key and to initiate
5184 	 * TKIP countermeasures if needed.
5185 	 */
5186 	EVENT_MICHAEL_MIC_FAILURE,
5187 
5188 	/**
5189 	 * EVENT_SCAN_RESULTS - Scan results available
5190 	 *
5191 	 * This event must be called whenever scan results are available to be
5192 	 * fetched with struct wpa_driver_ops::get_scan_results(). This event
5193 	 * is expected to be used some time after struct wpa_driver_ops::scan()
5194 	 * is called. If the driver provides an unsolicited event when the scan
5195 	 * has been completed, this event can be used to trigger
5196 	 * EVENT_SCAN_RESULTS call. If such event is not available from the
5197 	 * driver, the driver wrapper code is expected to use a registered
5198 	 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
5199 	 * scan is expected to be completed. Optional information about
5200 	 * completed scan can be provided with union wpa_event_data::scan_info.
5201 	 */
5202 	EVENT_SCAN_RESULTS,
5203 
5204 	/**
5205 	 * EVENT_ASSOCINFO - Report optional extra information for association
5206 	 *
5207 	 * This event can be used to report extra association information for
5208 	 * EVENT_ASSOC processing. This extra information includes IEs from
5209 	 * association frames and Beacon/Probe Response frames in union
5210 	 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
5211 	 * EVENT_ASSOC. Alternatively, the driver interface can include
5212 	 * assoc_info data in the EVENT_ASSOC call if it has all the
5213 	 * information available at the same point.
5214 	 */
5215 	EVENT_ASSOCINFO,
5216 
5217 	/**
5218 	 * EVENT_INTERFACE_STATUS - Report interface status changes
5219 	 *
5220 	 * This optional event can be used to report changes in interface
5221 	 * status (interface added/removed) using union
5222 	 * wpa_event_data::interface_status. This can be used to trigger
5223 	 * wpa_supplicant to stop and re-start processing for the interface,
5224 	 * e.g., when a cardbus card is ejected/inserted.
5225 	 */
5226 	EVENT_INTERFACE_STATUS,
5227 
5228 	/**
5229 	 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
5230 	 *
5231 	 * This event can be used to inform wpa_supplicant about candidates for
5232 	 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
5233 	 * for scan request (ap_scan=2 mode), this event is required for
5234 	 * pre-authentication. If wpa_supplicant is performing scan request
5235 	 * (ap_scan=1), this event is optional since scan results can be used
5236 	 * to add pre-authentication candidates. union
5237 	 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
5238 	 * candidate and priority of the candidate, e.g., based on the signal
5239 	 * strength, in order to try to pre-authenticate first with candidates
5240 	 * that are most likely targets for re-association.
5241 	 *
5242 	 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
5243 	 * on the candidate list. In addition, it can be called for the current
5244 	 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
5245 	 * will automatically skip pre-authentication in cases where a valid
5246 	 * PMKSA exists. When more than one candidate exists, this event should
5247 	 * be generated once for each candidate.
5248 	 *
5249 	 * Driver will be notified about successful pre-authentication with
5250 	 * struct wpa_driver_ops::add_pmkid() calls.
5251 	 */
5252 	EVENT_PMKID_CANDIDATE,
5253 
5254 	/**
5255 	 * EVENT_TDLS - Request TDLS operation
5256 	 *
5257 	 * This event can be used to request a TDLS operation to be performed.
5258 	 */
5259 	EVENT_TDLS,
5260 
5261 	/**
5262 	 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
5263 	 *
5264 	 * The driver is expected to report the received FT IEs from
5265 	 * FT authentication sequence from the AP. The FT IEs are included in
5266 	 * the extra information in union wpa_event_data::ft_ies.
5267 	 */
5268 	EVENT_FT_RESPONSE,
5269 
5270 	/**
5271 	 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
5272 	 *
5273 	 * The driver can use this event to inform wpa_supplicant about a STA
5274 	 * in an IBSS with which protected frames could be exchanged. This
5275 	 * event starts RSN authentication with the other STA to authenticate
5276 	 * the STA and set up encryption keys with it.
5277 	 */
5278 	EVENT_IBSS_RSN_START,
5279 
5280 	/**
5281 	 * EVENT_AUTH - Authentication result
5282 	 *
5283 	 * This event should be called when authentication attempt has been
5284 	 * completed. This is only used if the driver supports separate
5285 	 * authentication step (struct wpa_driver_ops::authenticate).
5286 	 * Information about authentication result is included in
5287 	 * union wpa_event_data::auth.
5288 	 */
5289 	EVENT_AUTH,
5290 
5291 	/**
5292 	 * EVENT_DEAUTH - Authentication lost
5293 	 *
5294 	 * This event should be called when authentication is lost either due
5295 	 * to receiving deauthenticate frame from the AP or when sending that
5296 	 * frame to the current AP.
5297 	 * In AP mode, union wpa_event_data::deauth_info is required.
5298 	 */
5299 	EVENT_DEAUTH,
5300 
5301 	/**
5302 	 * EVENT_ASSOC_REJECT - Association rejected
5303 	 *
5304 	 * This event should be called when (re)association attempt has been
5305 	 * rejected by the AP. Information about the association response is
5306 	 * included in union wpa_event_data::assoc_reject.
5307 	 */
5308 	EVENT_ASSOC_REJECT,
5309 
5310 	/**
5311 	 * EVENT_AUTH_TIMED_OUT - Authentication timed out
5312 	 */
5313 	EVENT_AUTH_TIMED_OUT,
5314 
5315 	/**
5316 	 * EVENT_ASSOC_TIMED_OUT - Association timed out
5317 	 */
5318 	EVENT_ASSOC_TIMED_OUT,
5319 
5320 	/**
5321 	 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
5322 	 */
5323 	EVENT_WPS_BUTTON_PUSHED,
5324 
5325 	/**
5326 	 * EVENT_TX_STATUS - Report TX status
5327 	 */
5328 	EVENT_TX_STATUS,
5329 
5330 	/**
5331 	 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
5332 	 */
5333 	EVENT_RX_FROM_UNKNOWN,
5334 
5335 	/**
5336 	 * EVENT_RX_MGMT - Report RX of a management frame
5337 	 */
5338 	EVENT_RX_MGMT,
5339 
5340 	/**
5341 	 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
5342 	 *
5343 	 * This event is used to indicate when the driver has started the
5344 	 * requested remain-on-channel duration. Information about the
5345 	 * operation is included in union wpa_event_data::remain_on_channel.
5346 	 */
5347 	EVENT_REMAIN_ON_CHANNEL,
5348 
5349 	/**
5350 	 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
5351 	 *
5352 	 * This event is used to indicate when the driver has completed
5353 	 * remain-on-channel duration, i.e., may noot be available on the
5354 	 * requested channel anymore. Information about the
5355 	 * operation is included in union wpa_event_data::remain_on_channel.
5356 	 */
5357 	EVENT_CANCEL_REMAIN_ON_CHANNEL,
5358 
5359 	/**
5360 	 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
5361 	 *
5362 	 * This event is used to indicate when a Probe Request frame has been
5363 	 * received. Information about the received frame is included in
5364 	 * union wpa_event_data::rx_probe_req. The driver is required to report
5365 	 * these events only after successfully completed probe_req_report()
5366 	 * commands to request the events (i.e., report parameter is non-zero)
5367 	 * in station mode. In AP mode, Probe Request frames should always be
5368 	 * reported.
5369 	 */
5370 	EVENT_RX_PROBE_REQ,
5371 
5372 	/**
5373 	 * EVENT_NEW_STA - New wired device noticed
5374 	 *
5375 	 * This event is used to indicate that a new device has been detected
5376 	 * in a network that does not use association-like functionality (i.e.,
5377 	 * mainly wired Ethernet). This can be used to start EAPOL
5378 	 * authenticator when receiving a frame from a device. The address of
5379 	 * the device is included in union wpa_event_data::new_sta.
5380 	 */
5381 	EVENT_NEW_STA,
5382 
5383 	/**
5384 	 * EVENT_EAPOL_RX - Report received EAPOL frame
5385 	 *
5386 	 * When in AP mode with hostapd, this event is required to be used to
5387 	 * deliver the receive EAPOL frames from the driver.
5388 	 */
5389 	EVENT_EAPOL_RX,
5390 
5391 	/**
5392 	 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
5393 	 *
5394 	 * This event is used to indicate changes in the signal strength
5395 	 * observed in frames received from the current AP if signal strength
5396 	 * monitoring has been enabled with signal_monitor().
5397 	 */
5398 	EVENT_SIGNAL_CHANGE,
5399 
5400 	/**
5401 	 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
5402 	 *
5403 	 * This event is used to indicate that the interface was enabled after
5404 	 * having been previously disabled, e.g., due to rfkill.
5405 	 */
5406 	EVENT_INTERFACE_ENABLED,
5407 
5408 	/**
5409 	 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
5410 	 *
5411 	 * This event is used to indicate that the interface was disabled,
5412 	 * e.g., due to rfkill.
5413 	 */
5414 	EVENT_INTERFACE_DISABLED,
5415 
5416 	/**
5417 	 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
5418 	 *
5419 	 * This event is used to indicate that the channel list has changed,
5420 	 * e.g., because of a regulatory domain change triggered by scan
5421 	 * results including an AP advertising a country code.
5422 	 */
5423 	EVENT_CHANNEL_LIST_CHANGED,
5424 
5425 	/**
5426 	 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
5427 	 *
5428 	 * This event is used to indicate that the driver cannot maintain this
5429 	 * interface in its operation mode anymore. The most likely use for
5430 	 * this is to indicate that AP mode operation is not available due to
5431 	 * operating channel would need to be changed to a DFS channel when
5432 	 * the driver does not support radar detection and another virtual
5433 	 * interfaces caused the operating channel to change. Other similar
5434 	 * resource conflicts could also trigger this for station mode
5435 	 * interfaces. This event can be propagated when channel switching
5436 	 * fails.
5437 	 */
5438 	EVENT_INTERFACE_UNAVAILABLE,
5439 
5440 	/**
5441 	 * EVENT_BEST_CHANNEL
5442 	 *
5443 	 * Driver generates this event whenever it detects a better channel
5444 	 * (e.g., based on RSSI or channel use). This information can be used
5445 	 * to improve channel selection for a new AP/P2P group.
5446 	 */
5447 	EVENT_BEST_CHANNEL,
5448 
5449 	/**
5450 	 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
5451 	 *
5452 	 * This event should be called when a Deauthentication frame is dropped
5453 	 * due to it not being protected (MFP/IEEE 802.11w).
5454 	 * union wpa_event_data::unprot_deauth is required to provide more
5455 	 * details of the frame.
5456 	 */
5457 	EVENT_UNPROT_DEAUTH,
5458 
5459 	/**
5460 	 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
5461 	 *
5462 	 * This event should be called when a Disassociation frame is dropped
5463 	 * due to it not being protected (MFP/IEEE 802.11w).
5464 	 * union wpa_event_data::unprot_disassoc is required to provide more
5465 	 * details of the frame.
5466 	 */
5467 	EVENT_UNPROT_DISASSOC,
5468 
5469 	/**
5470 	 * EVENT_STATION_LOW_ACK
5471 	 *
5472 	 * Driver generates this event whenever it detected that a particular
5473 	 * station was lost. Detection can be through massive transmission
5474 	 * failures for example.
5475 	 */
5476 	EVENT_STATION_LOW_ACK,
5477 
5478 	/**
5479 	 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
5480 	 */
5481 	EVENT_IBSS_PEER_LOST,
5482 
5483 	/**
5484 	 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
5485 	 *
5486 	 * This event carries the new replay counter to notify wpa_supplicant
5487 	 * of the current EAPOL-Key Replay Counter in case the driver/firmware
5488 	 * completed Group Key Handshake while the host (including
5489 	 * wpa_supplicant was sleeping).
5490 	 */
5491 	EVENT_DRIVER_GTK_REKEY,
5492 
5493 	/**
5494 	 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
5495 	 */
5496 	EVENT_SCHED_SCAN_STOPPED,
5497 
5498 	/**
5499 	 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
5500 	 *
5501 	 * This event indicates that the station responded to the poll
5502 	 * initiated with @poll_client.
5503 	 */
5504 	EVENT_DRIVER_CLIENT_POLL_OK,
5505 
5506 	/**
5507 	 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
5508 	 */
5509 	EVENT_EAPOL_TX_STATUS,
5510 
5511 	/**
5512 	 * EVENT_CH_SWITCH - AP or GO decided to switch channels
5513 	 *
5514 	 * Described in wpa_event_data.ch_switch
5515 	 * */
5516 	EVENT_CH_SWITCH,
5517 
5518 	/**
5519 	 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
5520 	 *
5521 	 * This is a pre-switch event indicating the shortly following switch
5522 	 * of operating channels.
5523 	 *
5524 	 * Described in wpa_event_data.ch_switch
5525 	 */
5526 	EVENT_CH_SWITCH_STARTED,
5527 	/**
5528 	 * EVENT_WNM - Request WNM operation
5529 	 *
5530 	 * This event can be used to request a WNM operation to be performed.
5531 	 */
5532 	EVENT_WNM,
5533 
5534 	/**
5535 	 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
5536 	 *
5537 	 * This event indicates that the driver reported a connection failure
5538 	 * with the specified client (for example, max client reached, etc.) in
5539 	 * AP mode.
5540 	 */
5541 	EVENT_CONNECT_FAILED_REASON,
5542 
5543 	/**
5544 	 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
5545 	 *
5546 	 * A radar has been detected on the supplied frequency, hostapd should
5547 	 * react accordingly (e.g., change channel).
5548 	 */
5549 	EVENT_DFS_RADAR_DETECTED,
5550 
5551 	/**
5552 	 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
5553 	 *
5554 	 * After a successful CAC, the channel can be marked clear and used.
5555 	 */
5556 	EVENT_DFS_CAC_FINISHED,
5557 
5558 	/**
5559 	 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
5560 	 *
5561 	 * The CAC was not successful, and the channel remains in the previous
5562 	 * state. This may happen due to a radar being detected or other
5563 	 * external influences.
5564 	 */
5565 	EVENT_DFS_CAC_ABORTED,
5566 
5567 	/**
5568 	 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
5569 	 *
5570 	 * The channel which was previously unavailable is now available again.
5571 	 */
5572 	EVENT_DFS_NOP_FINISHED,
5573 
5574 	/**
5575 	 * EVENT_SURVEY - Received survey data
5576 	 *
5577 	 * This event gets triggered when a driver query is issued for survey
5578 	 * data and the requested data becomes available. The returned data is
5579 	 * stored in struct survey_results. The results provide at most one
5580 	 * survey entry for each frequency and at minimum will provide one
5581 	 * survey entry for one frequency. The survey data can be os_malloc()'d
5582 	 * and then os_free()'d, so the event callback must only copy data.
5583 	 */
5584 	EVENT_SURVEY,
5585 
5586 	/**
5587 	 * EVENT_SCAN_STARTED - Scan started
5588 	 *
5589 	 * This indicates that driver has started a scan operation either based
5590 	 * on a request from wpa_supplicant/hostapd or from another application.
5591 	 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
5592 	 * completed (either successfully or by getting cancelled).
5593 	 */
5594 	EVENT_SCAN_STARTED,
5595 
5596 	/**
5597 	 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
5598 	 *
5599 	 * This event indicates a set of frequency ranges that should be avoided
5600 	 * to reduce issues due to interference or internal co-existence
5601 	 * information in the driver.
5602 	 */
5603 	EVENT_AVOID_FREQUENCIES,
5604 
5605 	/**
5606 	 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
5607 	 */
5608 	EVENT_NEW_PEER_CANDIDATE,
5609 
5610 	/**
5611 	 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
5612 	 *
5613 	 * Indicates a pair of primary and secondary channels chosen by ACS
5614 	 * in device.
5615 	 */
5616 	EVENT_ACS_CHANNEL_SELECTED,
5617 
5618 	/**
5619 	 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
5620 	 * been started.
5621 	 *
5622 	 * This event indicates that channel availability check has been started
5623 	 * on a DFS frequency by a driver that supports DFS Offload.
5624 	 */
5625 	EVENT_DFS_CAC_STARTED,
5626 
5627 	/**
5628 	 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
5629 	 */
5630 	EVENT_P2P_LO_STOP,
5631 
5632 	/**
5633 	 * EVENT_BEACON_LOSS - Beacon loss detected
5634 	 *
5635 	 * This event indicates that no Beacon frames has been received from
5636 	 * the current AP. This may indicate that the AP is not anymore in
5637 	 * range.
5638 	 */
5639 	EVENT_BEACON_LOSS,
5640 
5641 	/**
5642 	 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
5643 	 * done previously (Pre-CAC) on the channel has expired. This would
5644 	 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
5645 	 * channel will be moved from available to usable. A new CAC has to be
5646 	 * performed before start operating on this channel.
5647 	 */
5648 	EVENT_DFS_PRE_CAC_EXPIRED,
5649 
5650 	/**
5651 	 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
5652 	 * that do not define separate commands for authentication and
5653 	 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
5654 	 * authentication to wpa_supplicant. This event carries all the
5655 	 * necessary information from the host driver for the authentication to
5656 	 * happen.
5657 	 */
5658 	EVENT_EXTERNAL_AUTH,
5659 
5660 	/**
5661 	 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
5662 	 *
5663 	 * This event should be indicated when the driver completes the 4-way
5664 	 * handshake. This event should be preceded by an EVENT_ASSOC that
5665 	 * indicates the completion of IEEE 802.11 association.
5666 	 */
5667 	EVENT_PORT_AUTHORIZED,
5668 
5669 	/**
5670 	 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
5671 	 * change event.
5672 	 */
5673 	EVENT_STATION_OPMODE_CHANGED,
5674 
5675 	/**
5676 	 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
5677 	 *
5678 	 * This event is emitted when the MAC changes while the interface is
5679 	 * enabled. When an interface was disabled and becomes enabled, it
5680 	 * must be always assumed that the MAC possibly changed.
5681 	 */
5682 	EVENT_INTERFACE_MAC_CHANGED,
5683 
5684 	/**
5685 	 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
5686 	 *
5687 	 * This event is emitted when an interface is added/removed for WDS STA.
5688 	 */
5689 	EVENT_WDS_STA_INTERFACE_STATUS,
5690 
5691 	/**
5692 	  * EVENT_UPDATE_DH - Notification of updated DH information
5693 	  */
5694 	EVENT_UPDATE_DH,
5695 
5696 	/**
5697 	 * EVENT_UNPROT_BEACON - Unprotected Beacon frame received
5698 	 *
5699 	 * This event should be called when a Beacon frame is dropped due to it
5700 	 * not being protected correctly. union wpa_event_data::unprot_beacon
5701 	 * is required to provide more details of the frame.
5702 	 */
5703 	EVENT_UNPROT_BEACON,
5704 
5705 	/**
5706 	 * EVENT_TX_WAIT_EXPIRE - TX wait timed out
5707 	 *
5708 	 * This event is used to indicate when the driver has completed
5709 	 * wait for a response frame based on a TX request that specified a
5710 	 * non-zero wait time and that has not been explicitly cancelled.
5711 	 */
5712 	EVENT_TX_WAIT_EXPIRE,
5713 
5714 	/**
5715 	  * EVENT_BSS_COLOR_COLLISION - Notification of a BSS color collision
5716 	  */
5717 	EVENT_BSS_COLOR_COLLISION,
5718 
5719 	/**
5720 	 * EVENT_CCA_STARTED_NOTIFY - Notification that CCA has started
5721 	 */
5722 	EVENT_CCA_STARTED_NOTIFY,
5723 
5724 	/**
5725 	 * EVENT_CCA_ABORTED_NOTIFY - Notification that CCA has aborted
5726 	 */
5727 	EVENT_CCA_ABORTED_NOTIFY,
5728 
5729 	/**
5730 	 * EVENT_CCA_NOTIFY - Notification that CCA has completed
5731 	 */
5732 	EVENT_CCA_NOTIFY,
5733 
5734 	/**
5735 	 * EVENT_PASN_AUTH - This event is used by the driver that requests
5736 	 * PASN authentication and secure ranging context for multiple peers.
5737 	 */
5738 	EVENT_PASN_AUTH,
5739 
5740 	/**
5741 	 * EVENT_LINK_CH_SWITCH - MLD AP link decided to switch channels
5742 	 *
5743 	 * Described in wpa_event_data.ch_switch.
5744 	 *
5745 	 */
5746 	EVENT_LINK_CH_SWITCH,
5747 
5748 	/**
5749 	 * EVENT_LINK_CH_SWITCH_STARTED - MLD AP link started to switch channels
5750 	 *
5751 	 * This is a pre-switch event indicating the shortly following switch
5752 	 * of operating channels.
5753 	 *
5754 	 * Described in wpa_event_data.ch_switch.
5755 	 */
5756 	EVENT_LINK_CH_SWITCH_STARTED,
5757 
5758 	/**
5759 	 * EVENT_TID_LINK_MAP - MLD event to set TID-to-link mapping
5760 	 *
5761 	 * This event is used by the driver to indicate the received TID-to-link
5762 	 * mapping response from the associated AP MLD.
5763 	 *
5764 	 * Described in wpa_event_data.t2l_map_info.
5765 	 */
5766 	EVENT_TID_LINK_MAP,
5767 
5768 	/**
5769 	 * EVENT_LINK_RECONFIG - Notification that AP links removed
5770 	 */
5771 	EVENT_LINK_RECONFIG,
5772 };
5773 
5774 
5775 /**
5776  * struct freq_survey - Channel survey info
5777  *
5778  * @ifidx: Interface index in which this survey was observed
5779  * @freq: Center of frequency of the surveyed channel
5780  * @nf: Channel noise floor in dBm
5781  * @channel_time: Amount of time in ms the radio spent on the channel
5782  * @channel_time_busy: Amount of time in ms the radio detected some signal
5783  *     that indicated to the radio the channel was not clear
5784  * @channel_time_rx: Amount of time the radio spent receiving data
5785  * @channel_time_tx: Amount of time the radio spent transmitting data
5786  * @filled: bitmask indicating which fields have been reported, see
5787  *     SURVEY_HAS_* defines.
5788  * @list: Internal list pointers
5789  */
5790 struct freq_survey {
5791 	u32 ifidx;
5792 	unsigned int freq;
5793 	s8 nf;
5794 	u64 channel_time;
5795 	u64 channel_time_busy;
5796 	u64 channel_time_rx;
5797 	u64 channel_time_tx;
5798 	unsigned int filled;
5799 	struct dl_list list;
5800 };
5801 
5802 #define SURVEY_HAS_NF BIT(0)
5803 #define SURVEY_HAS_CHAN_TIME BIT(1)
5804 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
5805 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
5806 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
5807 
5808 /**
5809  * enum sta_connect_fail_reason_codes - STA connect failure reason code values
5810  * @STA_CONNECT_FAIL_REASON_UNSPECIFIED: No reason code specified for
5811  *	connection failure.
5812  * @STA_CONNECT_FAIL_REASON_NO_BSS_FOUND: No Probe Response frame received
5813  *	for unicast Probe Request frame.
5814  * @STA_CONNECT_FAIL_REASON_AUTH_TX_FAIL: STA failed to send auth request.
5815  * @STA_CONNECT_FAIL_REASON_AUTH_NO_ACK_RECEIVED: AP didn't send ACK for
5816  *	auth request.
5817  * @STA_CONNECT_FAIL_REASON_AUTH_NO_RESP_RECEIVED: Auth response is not
5818  *	received from AP.
5819  * @STA_CONNECT_FAIL_REASON_ASSOC_REQ_TX_FAIL: STA failed to send
5820  *	Association Request frame.
5821  * @STA_CONNECT_FAIL_REASON_ASSOC_NO_ACK_RECEIVED: AP didn't send ACK for
5822  *	Association Request frame.
5823  * @STA_CONNECT_FAIL_REASON_ASSOC_NO_RESP_RECEIVED: Association Response
5824  *	frame is not received from AP.
5825  */
5826 enum sta_connect_fail_reason_codes {
5827 	STA_CONNECT_FAIL_REASON_UNSPECIFIED = 0,
5828 	STA_CONNECT_FAIL_REASON_NO_BSS_FOUND = 1,
5829 	STA_CONNECT_FAIL_REASON_AUTH_TX_FAIL = 2,
5830 	STA_CONNECT_FAIL_REASON_AUTH_NO_ACK_RECEIVED = 3,
5831 	STA_CONNECT_FAIL_REASON_AUTH_NO_RESP_RECEIVED = 4,
5832 	STA_CONNECT_FAIL_REASON_ASSOC_REQ_TX_FAIL = 5,
5833 	STA_CONNECT_FAIL_REASON_ASSOC_NO_ACK_RECEIVED = 6,
5834 	STA_CONNECT_FAIL_REASON_ASSOC_NO_RESP_RECEIVED = 7,
5835 };
5836 
5837 /**
5838  * union wpa_event_data - Additional data for wpa_supplicant_event() calls
5839  */
5840 union wpa_event_data {
5841 	/**
5842 	 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
5843 	 *
5844 	 * This structure is optional for EVENT_ASSOC calls and required for
5845 	 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
5846 	 * driver interface does not need to generate separate EVENT_ASSOCINFO
5847 	 * calls.
5848 	 */
5849 	struct assoc_info {
5850 		/**
5851 		 * reassoc - Flag to indicate association or reassociation
5852 		 */
5853 		int reassoc;
5854 
5855 		/**
5856 		 * req_ies - (Re)Association Request IEs
5857 		 *
5858 		 * If the driver generates WPA/RSN IE, this event data must be
5859 		 * returned for WPA handshake to have needed information. If
5860 		 * wpa_supplicant-generated WPA/RSN IE is used, this
5861 		 * information event is optional.
5862 		 *
5863 		 * This should start with the first IE (fixed fields before IEs
5864 		 * are not included).
5865 		 */
5866 		const u8 *req_ies;
5867 
5868 		/**
5869 		 * req_ies_len - Length of req_ies in bytes
5870 		 */
5871 		size_t req_ies_len;
5872 
5873 		/**
5874 		 * resp_ies - (Re)Association Response IEs
5875 		 *
5876 		 * Optional association data from the driver. This data is not
5877 		 * required WPA, but may be useful for some protocols and as
5878 		 * such, should be reported if this is available to the driver
5879 		 * interface.
5880 		 *
5881 		 * This should start with the first IE (fixed fields before IEs
5882 		 * are not included).
5883 		 */
5884 		const u8 *resp_ies;
5885 
5886 		/**
5887 		 * resp_ies_len - Length of resp_ies in bytes
5888 		 */
5889 		size_t resp_ies_len;
5890 
5891 		/**
5892 		 * resp_frame - (Re)Association Response frame
5893 		 */
5894 		const u8 *resp_frame;
5895 
5896 		/**
5897 		 * resp_frame_len - (Re)Association Response frame length
5898 		 */
5899 		size_t resp_frame_len;
5900 
5901 		/**
5902 		 * beacon_ies - Beacon or Probe Response IEs
5903 		 *
5904 		 * Optional Beacon/ProbeResp data: IEs included in Beacon or
5905 		 * Probe Response frames from the current AP (i.e., the one
5906 		 * that the client just associated with). This information is
5907 		 * used to update WPA/RSN IE for the AP. If this field is not
5908 		 * set, the results from previous scan will be used. If no
5909 		 * data for the new AP is found, scan results will be requested
5910 		 * again (without scan request). At this point, the driver is
5911 		 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
5912 		 * used).
5913 		 *
5914 		 * This should start with the first IE (fixed fields before IEs
5915 		 * are not included).
5916 		 */
5917 		const u8 *beacon_ies;
5918 
5919 		/**
5920 		 * beacon_ies_len - Length of beacon_ies */
5921 		size_t beacon_ies_len;
5922 
5923 		/**
5924 		 * freq - Frequency of the operational channel in MHz
5925 		 */
5926 		unsigned int freq;
5927 
5928 		/**
5929 		 * wmm_params - WMM parameters used in this association.
5930 		 */
5931 		struct wmm_params wmm_params;
5932 
5933 		/**
5934 		 * addr - Station address (for AP mode)
5935 		 */
5936 		const u8 *addr;
5937 
5938 		/**
5939 		 * The following is the key management offload information
5940 		 * @authorized
5941 		 * @key_replay_ctr
5942 		 * @key_replay_ctr_len
5943 		 * @ptk_kck
5944 		 * @ptk_kek_len
5945 		 * @ptk_kek
5946 		 * @ptk_kek_len
5947 		 */
5948 
5949 		/**
5950 		 * authorized - Status of key management offload,
5951 		 * 1 = successful
5952 		 */
5953 		int authorized;
5954 
5955 		/**
5956 		 * key_replay_ctr - Key replay counter value last used
5957 		 * in a valid EAPOL-Key frame
5958 		 */
5959 		const u8 *key_replay_ctr;
5960 
5961 		/**
5962 		 * key_replay_ctr_len - The length of key_replay_ctr
5963 		 */
5964 		size_t key_replay_ctr_len;
5965 
5966 		/**
5967 		 * ptk_kck - The derived PTK KCK
5968 		 */
5969 		const u8 *ptk_kck;
5970 
5971 		/**
5972 		 * ptk_kek_len - The length of ptk_kck
5973 		 */
5974 		size_t ptk_kck_len;
5975 
5976 		/**
5977 		 * ptk_kek - The derived PTK KEK
5978 		 * This is used in key management offload and also in FILS SK
5979 		 * offload.
5980 		 */
5981 		const u8 *ptk_kek;
5982 
5983 		/**
5984 		 * ptk_kek_len - The length of ptk_kek
5985 		 */
5986 		size_t ptk_kek_len;
5987 
5988 		/**
5989 		 * subnet_status - The subnet status:
5990 		 * 0 = unknown, 1 = unchanged, 2 = changed
5991 		 */
5992 		u8 subnet_status;
5993 
5994 		/**
5995 		 * The following information is used in FILS SK offload
5996 		 * @fils_erp_next_seq_num
5997 		 * @fils_pmk
5998 		 * @fils_pmk_len
5999 		 * @fils_pmkid
6000 		 */
6001 
6002 		/**
6003 		 * fils_erp_next_seq_num - The next sequence number to use in
6004 		 * FILS ERP messages
6005 		 */
6006 		u16 fils_erp_next_seq_num;
6007 
6008 		/**
6009 		 * fils_pmk - A new PMK if generated in case of FILS
6010 		 * authentication
6011 		 */
6012 		const u8 *fils_pmk;
6013 
6014 		/**
6015 		 * fils_pmk_len - Length of fils_pmk
6016 		 */
6017 		size_t fils_pmk_len;
6018 
6019 		/**
6020 		 * fils_pmkid - PMKID used or generated in FILS authentication
6021 		 */
6022 		const u8 *fils_pmkid;
6023 
6024 		/**
6025 		 * link_addr - Link address of the STA
6026 		 */
6027 		const u8 *link_addr;
6028 
6029 		/**
6030 		 * assoc_link_id - Association link id of the MLO association or
6031 		 *	-1 if MLO is not used
6032 		 */
6033 		int assoc_link_id;
6034 	} assoc_info;
6035 
6036 	/**
6037 	 * struct disassoc_info - Data for EVENT_DISASSOC events
6038 	 */
6039 	struct disassoc_info {
6040 		/**
6041 		 * addr - Station address (for AP mode)
6042 		 */
6043 		const u8 *addr;
6044 
6045 		/**
6046 		 * reason_code - Reason Code (host byte order) used in
6047 		 *	Deauthentication frame
6048 		 */
6049 		u16 reason_code;
6050 
6051 		/**
6052 		 * ie - Optional IE(s) in Disassociation frame
6053 		 */
6054 		const u8 *ie;
6055 
6056 		/**
6057 		 * ie_len - Length of ie buffer in octets
6058 		 */
6059 		size_t ie_len;
6060 
6061 		/**
6062 		 * locally_generated - Whether the frame was locally generated
6063 		 */
6064 		int locally_generated;
6065 	} disassoc_info;
6066 
6067 	/**
6068 	 * struct deauth_info - Data for EVENT_DEAUTH events
6069 	 */
6070 	struct deauth_info {
6071 		/**
6072 		 * addr - Station address (for AP mode)
6073 		 */
6074 		const u8 *addr;
6075 
6076 		/**
6077 		 * reason_code - Reason Code (host byte order) used in
6078 		 *	Deauthentication frame
6079 		 */
6080 		u16 reason_code;
6081 
6082 		/**
6083 		 * ie - Optional IE(s) in Deauthentication frame
6084 		 */
6085 		const u8 *ie;
6086 
6087 		/**
6088 		 * ie_len - Length of ie buffer in octets
6089 		 */
6090 		size_t ie_len;
6091 
6092 		/**
6093 		 * locally_generated - Whether the frame was locally generated
6094 		 */
6095 		int locally_generated;
6096 	} deauth_info;
6097 
6098 	/**
6099 	 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
6100 	 */
6101 	struct michael_mic_failure {
6102 		int unicast;
6103 		const u8 *src;
6104 	} michael_mic_failure;
6105 
6106 	/**
6107 	 * struct interface_status - Data for EVENT_INTERFACE_STATUS
6108 	 */
6109 	struct interface_status {
6110 		unsigned int ifindex;
6111 		char ifname[100];
6112 		enum {
6113 			EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
6114 		} ievent;
6115 	} interface_status;
6116 
6117 	/**
6118 	 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
6119 	 */
6120 	struct pmkid_candidate {
6121 		/** BSSID of the PMKID candidate */
6122 		u8 bssid[ETH_ALEN];
6123 		/** Smaller the index, higher the priority */
6124 		int index;
6125 		/** Whether RSN IE includes pre-authenticate flag */
6126 		int preauth;
6127 	} pmkid_candidate;
6128 
6129 	/**
6130 	 * struct tdls - Data for EVENT_TDLS
6131 	 */
6132 	struct tdls {
6133 		u8 peer[ETH_ALEN];
6134 		enum {
6135 			TDLS_REQUEST_SETUP,
6136 			TDLS_REQUEST_TEARDOWN,
6137 			TDLS_REQUEST_DISCOVER,
6138 		} oper;
6139 		u16 reason_code; /* for teardown */
6140 	} tdls;
6141 
6142 	/**
6143 	 * struct wnm - Data for EVENT_WNM
6144 	 */
6145 	struct wnm {
6146 		u8 addr[ETH_ALEN];
6147 		enum {
6148 			WNM_OPER_SLEEP,
6149 		} oper;
6150 		enum {
6151 			WNM_SLEEP_ENTER,
6152 			WNM_SLEEP_EXIT
6153 		} sleep_action;
6154 		int sleep_intval;
6155 		u16 reason_code;
6156 		u8 *buf;
6157 		u16 buf_len;
6158 	} wnm;
6159 
6160 	/**
6161 	 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
6162 	 *
6163 	 * During FT (IEEE 802.11r) authentication sequence, the driver is
6164 	 * expected to use this event to report received FT IEs (MDIE, FTIE,
6165 	 * RSN IE, TIE, possible resource request) to the supplicant. The FT
6166 	 * IEs for the next message will be delivered through the
6167 	 * struct wpa_driver_ops::update_ft_ies() callback.
6168 	 */
6169 	struct ft_ies {
6170 		const u8 *ies;
6171 		size_t ies_len;
6172 		int ft_action;
6173 		u8 target_ap[ETH_ALEN];
6174 		/** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
6175 		const u8 *ric_ies;
6176 		/** Length of ric_ies buffer in octets */
6177 		size_t ric_ies_len;
6178 	} ft_ies;
6179 
6180 	/**
6181 	 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
6182 	 */
6183 	struct ibss_rsn_start {
6184 		u8 peer[ETH_ALEN];
6185 	} ibss_rsn_start;
6186 
6187 	/**
6188 	 * struct auth_info - Data for EVENT_AUTH events
6189 	 */
6190 	struct auth_info {
6191 		u8 peer[ETH_ALEN];
6192 		u8 bssid[ETH_ALEN];
6193 		u16 auth_type;
6194 		u16 auth_transaction;
6195 		u16 status_code;
6196 		const u8 *ies;
6197 		size_t ies_len;
6198 	} auth;
6199 
6200 	/**
6201 	 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
6202 	 */
6203 	struct assoc_reject {
6204 		/**
6205 		 * bssid - BSSID of the AP that rejected association
6206 		 */
6207 		const u8 *bssid;
6208 
6209 		/**
6210 		 * resp_ies - (Re)Association Response IEs
6211 		 *
6212 		 * Optional association data from the driver. This data is not
6213 		 * required WPA, but may be useful for some protocols and as
6214 		 * such, should be reported if this is available to the driver
6215 		 * interface.
6216 		 *
6217 		 * This should start with the first IE (fixed fields before IEs
6218 		 * are not included).
6219 		 */
6220 		const u8 *resp_ies;
6221 
6222 		/**
6223 		 * resp_ies_len - Length of resp_ies in bytes
6224 		 */
6225 		size_t resp_ies_len;
6226 
6227 		/**
6228 		 * status_code - Status Code from (Re)association Response
6229 		 */
6230 		u16 status_code;
6231 
6232 		/**
6233 		 * timed_out - Whether failure is due to timeout (etc.) rather
6234 		 * than explicit rejection response from the AP.
6235 		 */
6236 		int timed_out;
6237 
6238 		/**
6239 		 * timeout_reason - Reason for the timeout
6240 		 */
6241 		const char *timeout_reason;
6242 
6243 		/**
6244 		 * fils_erp_next_seq_num - The next sequence number to use in
6245 		 * FILS ERP messages
6246 		 */
6247 		u16 fils_erp_next_seq_num;
6248 
6249 		/**
6250 		 * reason_code - Connection failure reason code from the driver
6251 		 */
6252 		enum sta_connect_fail_reason_codes reason_code;
6253 	} assoc_reject;
6254 
6255 	struct timeout_event {
6256 		u8 addr[ETH_ALEN];
6257 	} timeout_event;
6258 
6259 	/**
6260 	 * struct tx_status - Data for EVENT_TX_STATUS events
6261 	 */
6262 	struct tx_status {
6263 		u16 type;
6264 		u16 stype;
6265 		const u8 *dst;
6266 		const u8 *data;
6267 		size_t data_len;
6268 		int ack;
6269 		int link_id;
6270 	} tx_status;
6271 
6272 	/**
6273 	 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
6274 	 */
6275 	struct rx_from_unknown {
6276 		const u8 *bssid;
6277 		const u8 *addr;
6278 		int wds;
6279 	} rx_from_unknown;
6280 
6281 	/**
6282 	 * struct rx_mgmt - Data for EVENT_RX_MGMT events
6283 	 */
6284 	struct rx_mgmt {
6285 		const u8 *frame;
6286 		size_t frame_len;
6287 		u32 datarate;
6288 
6289 		/**
6290 		 * drv_priv - Pointer to store driver private BSS information
6291 		 *
6292 		 * If not set to NULL, this is used for comparison with
6293 		 * hostapd_data->drv_priv to determine which BSS should process
6294 		 * the frame.
6295 		 */
6296 		void *drv_priv;
6297 
6298 		/**
6299 		 * freq - Frequency (in MHz) on which the frame was received
6300 		 */
6301 		int freq;
6302 
6303 		/**
6304 		 * ssi_signal - Signal strength in dBm (or 0 if not available)
6305 		 */
6306 		int ssi_signal;
6307 
6308 		/**
6309 		 * link_id - MLO link on which the frame was received or -1 for
6310 		 * non MLD.
6311 		 */
6312 		int link_id;
6313 	} rx_mgmt;
6314 
6315 	/**
6316 	 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
6317 	 *
6318 	 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
6319 	 */
6320 	struct remain_on_channel {
6321 		/**
6322 		 * freq - Channel frequency in MHz
6323 		 */
6324 		unsigned int freq;
6325 
6326 		/**
6327 		 * duration - Duration to remain on the channel in milliseconds
6328 		 */
6329 		unsigned int duration;
6330 	} remain_on_channel;
6331 
6332 	/**
6333 	 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
6334 	 * @aborted: Whether the scan was aborted
6335 	 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
6336 	 * @num_freqs: Number of entries in freqs array
6337 	 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
6338 	 *	SSID)
6339 	 * @num_ssids: Number of entries in ssids array
6340 	 * @external_scan: Whether the scan info is for an external scan
6341 	 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
6342 	 * 	0 if the source of the scan event is a vendor scan
6343 	 * @scan_start_tsf: Time when the scan started in terms of TSF of the
6344 	 *	BSS that the interface that requested the scan is connected to
6345 	 *	(if available).
6346 	 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
6347 	 *	is set.
6348 	 */
6349 	struct scan_info {
6350 		int aborted;
6351 		const int *freqs;
6352 		size_t num_freqs;
6353 		struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
6354 		size_t num_ssids;
6355 		int external_scan;
6356 		int nl_scan_event;
6357 		u64 scan_start_tsf;
6358 		u8 scan_start_tsf_bssid[ETH_ALEN];
6359 	} scan_info;
6360 
6361 	/**
6362 	 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
6363 	 */
6364 	struct rx_probe_req {
6365 		/**
6366 		 * sa - Source address of the received Probe Request frame
6367 		 */
6368 		const u8 *sa;
6369 
6370 		/**
6371 		 * da - Destination address of the received Probe Request frame
6372 		 *	or %NULL if not available
6373 		 */
6374 		const u8 *da;
6375 
6376 		/**
6377 		 * bssid - BSSID of the received Probe Request frame or %NULL
6378 		 *	if not available
6379 		 */
6380 		const u8 *bssid;
6381 
6382 		/**
6383 		 * ie - IEs from the Probe Request body
6384 		 */
6385 		const u8 *ie;
6386 
6387 		/**
6388 		 * ie_len - Length of ie buffer in octets
6389 		 */
6390 		size_t ie_len;
6391 
6392 		/**
6393 		 * signal - signal strength in dBm (or 0 if not available)
6394 		 */
6395 		int ssi_signal;
6396 	} rx_probe_req;
6397 
6398 	/**
6399 	 * struct new_sta - Data for EVENT_NEW_STA events
6400 	 */
6401 	struct new_sta {
6402 		const u8 *addr;
6403 	} new_sta;
6404 
6405 	/**
6406 	 * struct eapol_rx - Data for EVENT_EAPOL_RX events
6407 	 */
6408 	struct eapol_rx {
6409 		const u8 *src;
6410 		const u8 *data;
6411 		size_t data_len;
6412 		enum frame_encryption encrypted;
6413 		int link_id;
6414 	} eapol_rx;
6415 
6416 	/**
6417 	 * signal_change - Data for EVENT_SIGNAL_CHANGE events
6418 	 */
6419 	struct wpa_signal_info signal_change;
6420 
6421 	/**
6422 	 * struct best_channel - Data for EVENT_BEST_CHANNEL events
6423 	 * @freq_24: Best 2.4 GHz band channel frequency in MHz
6424 	 * @freq_5: Best 5 GHz band channel frequency in MHz
6425 	 * @freq_overall: Best channel frequency in MHz
6426 	 *
6427 	 * 0 can be used to indicate no preference in either band.
6428 	 */
6429 	struct best_channel {
6430 		int freq_24;
6431 		int freq_5;
6432 		int freq_overall;
6433 	} best_chan;
6434 
6435 	struct unprot_deauth {
6436 		const u8 *sa;
6437 		const u8 *da;
6438 		u16 reason_code;
6439 	} unprot_deauth;
6440 
6441 	struct unprot_disassoc {
6442 		const u8 *sa;
6443 		const u8 *da;
6444 		u16 reason_code;
6445 	} unprot_disassoc;
6446 
6447 	/**
6448 	 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
6449 	 * @addr: station address
6450 	 * @num_packets: Number of packets lost (consecutive packets not
6451 	 * acknowledged)
6452 	 */
6453 	struct low_ack {
6454 		u8 addr[ETH_ALEN];
6455 		u32 num_packets;
6456 	} low_ack;
6457 
6458 	/**
6459 	 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
6460 	 */
6461 	struct ibss_peer_lost {
6462 		u8 peer[ETH_ALEN];
6463 	} ibss_peer_lost;
6464 
6465 	/**
6466 	 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
6467 	 */
6468 	struct driver_gtk_rekey {
6469 		const u8 *bssid;
6470 		const u8 *replay_ctr;
6471 	} driver_gtk_rekey;
6472 
6473 	/**
6474 	 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
6475 	 * @addr: station address
6476 	 */
6477 	struct client_poll {
6478 		u8 addr[ETH_ALEN];
6479 	} client_poll;
6480 
6481 	/**
6482 	 * struct eapol_tx_status
6483 	 * @dst: Original destination
6484 	 * @data: Data starting with IEEE 802.1X header (!)
6485 	 * @data_len: Length of data
6486 	 * @ack: Indicates ack or lost frame
6487 	 * @link_id: MLD link id used to transmit the frame or -1 for non MLO
6488 	 *
6489 	 * This corresponds to hapd_send_eapol if the frame sent
6490 	 * there isn't just reported as EVENT_TX_STATUS.
6491 	 */
6492 	struct eapol_tx_status {
6493 		const u8 *dst;
6494 		const u8 *data;
6495 		int data_len;
6496 		int ack;
6497 		int link_id;
6498 	} eapol_tx_status;
6499 
6500 	/**
6501 	 * struct ch_switch
6502 	 * @freq: Frequency of new channel in MHz
6503 	 * @ht_enabled: Whether this is an HT channel
6504 	 * @ch_offset: Secondary channel offset
6505 	 * @ch_width: Channel width
6506 	 * @cf1: Center frequency 1
6507 	 * @cf2: Center frequency 2
6508 	 * @link_id: Link ID of the MLO link
6509 	 * @punct_bitmap: Puncturing bitmap
6510 	 */
6511 	struct ch_switch {
6512 		int freq;
6513 		int ht_enabled;
6514 		int ch_offset;
6515 		enum chan_width ch_width;
6516 		int cf1;
6517 		int cf2;
6518 		int link_id;
6519 		u16 punct_bitmap;
6520 	} ch_switch;
6521 
6522 	/**
6523 	 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
6524 	 * @addr: Remote client address
6525 	 * @code: Reason code for connection failure
6526 	 */
6527 	struct connect_failed_reason {
6528 		u8 addr[ETH_ALEN];
6529 		enum {
6530 			MAX_CLIENT_REACHED,
6531 			BLOCKED_CLIENT
6532 		} code;
6533 	} connect_failed_reason;
6534 
6535 	/**
6536 	 * struct dfs_event - Data for radar detected events
6537 	 * @freq: Frequency of the channel in MHz
6538 	 */
6539 	struct dfs_event {
6540 		int freq;
6541 		int ht_enabled;
6542 		int chan_offset;
6543 		enum chan_width chan_width;
6544 		int cf1;
6545 		int cf2;
6546 	} dfs_event;
6547 
6548 	/**
6549 	 * survey_results - Survey result data for EVENT_SURVEY
6550 	 * @freq_filter: Requested frequency survey filter, 0 if request
6551 	 *	was for all survey data
6552 	 * @survey_list: Linked list of survey data (struct freq_survey)
6553 	 */
6554 	struct survey_results {
6555 		unsigned int freq_filter;
6556 		struct dl_list survey_list; /* struct freq_survey */
6557 	} survey_results;
6558 
6559 	/**
6560 	 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
6561 	 * @initiator: Initiator of the regulatory change
6562 	 * @type: Regulatory change type
6563 	 * @alpha2: Country code (or "" if not available)
6564 	 */
6565 	struct channel_list_changed {
6566 		enum reg_change_initiator initiator;
6567 		enum reg_type type;
6568 		char alpha2[3];
6569 	} channel_list_changed;
6570 
6571 	/**
6572 	 * freq_range - List of frequency ranges
6573 	 *
6574 	 * This is used as the data with EVENT_AVOID_FREQUENCIES.
6575 	 */
6576 	struct wpa_freq_range_list freq_range;
6577 
6578 	/**
6579 	 * struct mesh_peer
6580 	 *
6581 	 * @peer: Peer address
6582 	 * @ies: Beacon IEs
6583 	 * @ie_len: Length of @ies
6584 	 *
6585 	 * Notification of new candidate mesh peer.
6586 	 */
6587 	struct mesh_peer {
6588 		const u8 *peer;
6589 		const u8 *ies;
6590 		size_t ie_len;
6591 	} mesh_peer;
6592 
6593 	/**
6594 	 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
6595 	 * @pri_freq: Selected primary frequency
6596 	 * @sec_freq: Selected secondary frequency
6597 	 * @edmg_channel: Selected EDMG channel
6598 	 * @vht_seg0_center_ch: VHT mode Segment0 center channel
6599 	 *	The value is the index of the channel center frequency for
6600 	 *	20 MHz, 40 MHz, and 80 MHz channels. The value is the center
6601 	 *	frequency index of the primary 80 MHz segment for 160 MHz and
6602 	 *	80+80 MHz channels.
6603 	 * @vht_seg1_center_ch: VHT mode Segment1 center channel
6604 	 *	The value is zero for 20 MHz, 40 MHz, and 80 MHz channels. The
6605 	 *	value is the index of the channel center frequency for 160 MHz
6606 	 *	channels and the center frequency index of the secondary 80 MHz
6607 	 *	segment for 80+80 MHz channels.
6608 	 * @ch_width: Selected Channel width by driver. Driver may choose to
6609 	 *	change hostapd configured ACS channel width due driver internal
6610 	 *	channel restrictions.
6611 	 * hw_mode: Selected band (used with hw_mode=any)
6612 	 */
6613 	struct acs_selected_channels {
6614 		unsigned int pri_freq;
6615 		unsigned int sec_freq;
6616 		u8 edmg_channel;
6617 		u8 vht_seg0_center_ch;
6618 		u8 vht_seg1_center_ch;
6619 		u16 ch_width;
6620 		enum hostapd_hw_mode hw_mode;
6621 		u16 puncture_bitmap;
6622 	} acs_selected_channels;
6623 
6624 	/**
6625 	 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
6626 	 * @reason_code: Reason for stopping offload
6627 	 *	P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
6628 	 *	scheduled.
6629 	 *	P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
6630 	 *	be stopped.
6631 	 *	P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
6632 	 *	parameters.
6633 	 *	P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
6634 	 *	supported by device.
6635 	 */
6636 	struct p2p_lo_stop {
6637 		enum {
6638 			P2P_LO_STOPPED_REASON_COMPLETE = 0,
6639 			P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
6640 			P2P_LO_STOPPED_REASON_INVALID_PARAM,
6641 			P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
6642 		} reason_code;
6643 	} p2p_lo_stop;
6644 
6645 	/* For EVENT_EXTERNAL_AUTH */
6646 	struct external_auth external_auth;
6647 
6648 	/**
6649 	 * struct sta_opmode - Station's operation mode change event
6650 	 * @addr: The station MAC address
6651 	 * @smps_mode: SMPS mode of the station
6652 	 * @chan_width: Channel width of the station
6653 	 * @rx_nss: RX_NSS of the station
6654 	 *
6655 	 * This is used as data with EVENT_STATION_OPMODE_CHANGED.
6656 	 */
6657 	struct sta_opmode {
6658 		const u8 *addr;
6659 		enum smps_mode smps_mode;
6660 		enum chan_width chan_width;
6661 		u8 rx_nss;
6662 	} sta_opmode;
6663 
6664 	/**
6665 	 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
6666 	 */
6667 	struct wds_sta_interface {
6668 		const u8 *sta_addr;
6669 		const char *ifname;
6670 		enum {
6671 			INTERFACE_ADDED,
6672 			INTERFACE_REMOVED
6673 		} istatus;
6674 	} wds_sta_interface;
6675 
6676 	/**
6677 	 * struct update_dh - Data for EVENT_UPDATE_DH
6678 	 */
6679 	struct update_dh {
6680 		const u8 *peer;
6681 		const u8 *ie;
6682 		size_t ie_len;
6683 		int assoc_link_id;
6684 		const u8 *link_addr;
6685 	} update_dh;
6686 
6687 	/**
6688 	 * struct unprot_beacon - Data for EVENT_UNPROT_BEACON
6689 	 */
6690 	struct unprot_beacon {
6691 		const u8 *sa;
6692 	} unprot_beacon;
6693 
6694 	/**
6695 	 * struct bss_color_collision - Data for EVENT_BSS_COLOR_COLLISION
6696 	 */
6697 	struct bss_color_collision {
6698 		u64 bitmap;
6699 	} bss_color_collision;
6700 
6701 	/**
6702 	 * struct pasn_auth - Data for EVENT_PASN_AUTH
6703 	 */
6704 	struct pasn_auth pasn_auth;
6705 
6706 	/**
6707 	 * struct port_authorized - Data for EVENT_PORT_AUTHORIZED
6708 	 * @td_bitmap: For STA mode, transition disable bitmap, if received in
6709 	 *	EAPOL-Key msg 3/4
6710 	 * @td_bitmap_len: For STA mode, length of td_bitmap
6711 	 * @sta_addr: For AP mode, the MAC address of the associated STA
6712 	 *
6713 	 * This event is used to indicate that the port is authorized and
6714 	 * open for normal data in STA and AP modes when 4-way handshake is
6715 	 * offloaded to the driver.
6716 	 */
6717 	struct port_authorized {
6718 		const u8 *td_bitmap;
6719 		size_t td_bitmap_len;
6720 		const u8 *sta_addr;
6721 	} port_authorized;
6722 
6723 	/**
6724 	 * struct tid_link_map_info - Data for EVENT_TID_LINK_MAP
6725 	 */
6726 	struct tid_link_map_info {
6727 		bool default_map;
6728 		u8 valid_links;
6729 		struct t2lm_mapping t2lmap[MAX_NUM_MLD_LINKS];
6730 	} t2l_map_info;
6731 };
6732 
6733 /**
6734  * wpa_supplicant_event - Report a driver event for wpa_supplicant
6735  * @ctx: Context pointer (wpa_s); this is the ctx variable registered
6736  *	with struct wpa_driver_ops::init()
6737  * @event: event type (defined above)
6738  * @data: possible extra data for the event
6739  *
6740  * Driver wrapper code should call this function whenever an event is received
6741  * from the driver.
6742  */
6743 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
6744 			  union wpa_event_data *data);
6745 
6746 /**
6747  * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
6748  * @ctx: Context pointer (wpa_s); this is the ctx variable registered
6749  *	with struct wpa_driver_ops::init()
6750  * @event: event type (defined above)
6751  * @data: possible extra data for the event
6752  *
6753  * Same as wpa_supplicant_event(), but we search for the interface in
6754  * wpa_global.
6755  */
6756 void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
6757 				 union wpa_event_data *data);
6758 
6759 /*
6760  * The following inline functions are provided for convenience to simplify
6761  * event indication for some of the common events.
6762  */
6763 
drv_event_assoc(void * ctx,const u8 * addr,const u8 * req_ies,size_t req_ielen,const u8 * resp_ies,size_t resp_ielen,const u8 * link_addr,int assoc_link_id,int reassoc)6764 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *req_ies,
6765 				   size_t req_ielen, const u8 *resp_ies,
6766 				   size_t resp_ielen, const u8 *link_addr,
6767 				   int assoc_link_id, int reassoc)
6768 {
6769 	union wpa_event_data event;
6770 	os_memset(&event, 0, sizeof(event));
6771 	event.assoc_info.reassoc = reassoc;
6772 	event.assoc_info.req_ies = req_ies;
6773 	event.assoc_info.req_ies_len = req_ielen;
6774 	event.assoc_info.resp_ies = resp_ies;
6775 	event.assoc_info.resp_ies_len = resp_ielen;
6776 	event.assoc_info.addr = addr;
6777 	event.assoc_info.link_addr = link_addr;
6778 	event.assoc_info.assoc_link_id = assoc_link_id;
6779 	wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
6780 }
6781 
drv_event_disassoc(void * ctx,const u8 * addr)6782 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
6783 {
6784 	union wpa_event_data event;
6785 	os_memset(&event, 0, sizeof(event));
6786 	event.disassoc_info.addr = addr;
6787 	wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
6788 }
6789 
drv_event_eapol_rx(void * ctx,const u8 * src,const u8 * data,size_t data_len)6790 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
6791 				      size_t data_len)
6792 {
6793 	union wpa_event_data event;
6794 	os_memset(&event, 0, sizeof(event));
6795 	event.eapol_rx.src = src;
6796 	event.eapol_rx.data = data;
6797 	event.eapol_rx.data_len = data_len;
6798 	event.eapol_rx.encrypted = FRAME_ENCRYPTION_UNKNOWN;
6799 	event.eapol_rx.link_id = -1;
6800 	wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
6801 }
6802 
drv_event_eapol_rx2(void * ctx,const u8 * src,const u8 * data,size_t data_len,enum frame_encryption encrypted,int link_id)6803 static inline void drv_event_eapol_rx2(void *ctx, const u8 *src, const u8 *data,
6804 				       size_t data_len,
6805 				       enum frame_encryption encrypted,
6806 				       int link_id)
6807 {
6808 	union wpa_event_data event;
6809 	os_memset(&event, 0, sizeof(event));
6810 	event.eapol_rx.src = src;
6811 	event.eapol_rx.data = data;
6812 	event.eapol_rx.data_len = data_len;
6813 	event.eapol_rx.encrypted = encrypted;
6814 	event.eapol_rx.link_id = link_id;
6815 	wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
6816 }
6817 
6818 /* driver_common.c */
6819 void wpa_scan_results_free(struct wpa_scan_results *res);
6820 
6821 /* Convert wpa_event_type to a string for logging */
6822 const char * event_to_string(enum wpa_event_type event);
6823 
6824 /* Convert chan_width to a string for logging and control interfaces */
6825 const char * channel_width_to_string(enum chan_width width);
6826 
6827 int channel_width_to_int(enum chan_width width);
6828 
6829 int ht_supported(const struct hostapd_hw_modes *mode);
6830 int vht_supported(const struct hostapd_hw_modes *mode);
6831 bool he_supported(const struct hostapd_hw_modes *hw_mode,
6832 		  enum ieee80211_op_mode op_mode);
6833 
6834 struct wowlan_triggers *
6835 wpa_get_wowlan_triggers(const char *wowlan_triggers,
6836 			const struct wpa_driver_capa *capa);
6837 /* Convert driver flag to string */
6838 const char * driver_flag_to_string(u64 flag);
6839 const char * driver_flag2_to_string(u64 flag2);
6840 
6841 /* NULL terminated array of linked in driver wrappers */
6842 extern const struct wpa_driver_ops *const wpa_drivers[];
6843 
6844 
6845 /* Available drivers */
6846 
6847 #ifdef CONFIG_DRIVER_WEXT
6848 extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
6849 #endif /* CONFIG_DRIVER_WEXT */
6850 #ifdef CONFIG_DRIVER_NL80211
6851 /* driver_nl80211.c */
6852 extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
6853 #endif /* CONFIG_DRIVER_NL80211 */
6854 #ifdef CONFIG_DRIVER_HOSTAP
6855 extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
6856 #endif /* CONFIG_DRIVER_HOSTAP */
6857 #ifdef CONFIG_DRIVER_BSD
6858 extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
6859 #endif /* CONFIG_DRIVER_BSD */
6860 #ifdef CONFIG_DRIVER_OPENBSD
6861 /* driver_openbsd.c */
6862 extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
6863 #endif /* CONFIG_DRIVER_OPENBSD */
6864 #ifdef CONFIG_DRIVER_NDIS
6865 extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
6866 #endif /* CONFIG_DRIVER_NDIS */
6867 #ifdef CONFIG_DRIVER_WIRED
6868 extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
6869 #endif /* CONFIG_DRIVER_WIRED */
6870 #ifdef CONFIG_DRIVER_MACSEC_QCA
6871 /* driver_macsec_qca.c */
6872 extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
6873 #endif /* CONFIG_DRIVER_MACSEC_QCA */
6874 #ifdef CONFIG_DRIVER_MACSEC_LINUX
6875 /* driver_macsec_linux.c */
6876 extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops;
6877 #endif /* CONFIG_DRIVER_MACSEC_LINUX */
6878 #ifdef CONFIG_DRIVER_ROBOSWITCH
6879 /* driver_roboswitch.c */
6880 extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
6881 #endif /* CONFIG_DRIVER_ROBOSWITCH */
6882 #ifdef CONFIG_DRIVER_ATHEROS
6883 /* driver_atheros.c */
6884 extern const struct wpa_driver_ops wpa_driver_atheros_ops;
6885 #endif /* CONFIG_DRIVER_ATHEROS */
6886 #ifdef CONFIG_DRIVER_NONE
6887 extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
6888 #endif /* CONFIG_DRIVER_NONE */
6889 
6890 #endif /* DRIVER_H */
6891