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