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