driver.h revision a54fa5fb807eaeff45464139b5a7759f060cec68
1/*
2 * Driver interface definition
3 * Copyright (c) 2003-2012, 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
24#define HOSTAPD_CHAN_DISABLED 0x00000001
25#define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
26#define HOSTAPD_CHAN_NO_IBSS 0x00000004
27#define HOSTAPD_CHAN_RADAR 0x00000008
28#define HOSTAPD_CHAN_HT40PLUS 0x00000010
29#define HOSTAPD_CHAN_HT40MINUS 0x00000020
30#define HOSTAPD_CHAN_HT40 0x00000040
31
32/**
33 * struct hostapd_channel_data - Channel information
34 */
35struct hostapd_channel_data {
36	/**
37	 * chan - Channel number (IEEE 802.11)
38	 */
39	short chan;
40
41	/**
42	 * freq - Frequency in MHz
43	 */
44	int freq;
45
46	/**
47	 * flag - Channel flags (HOSTAPD_CHAN_*)
48	 */
49	int flag;
50
51	/**
52	 * max_tx_power - maximum transmit power in dBm
53	 */
54	u8 max_tx_power;
55};
56
57#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
58
59/**
60 * struct hostapd_hw_modes - Supported hardware mode information
61 */
62struct hostapd_hw_modes {
63	/**
64	 * mode - Hardware mode
65	 */
66	enum hostapd_hw_mode mode;
67
68	/**
69	 * num_channels - Number of entries in the channels array
70	 */
71	int num_channels;
72
73	/**
74	 * channels - Array of supported channels
75	 */
76	struct hostapd_channel_data *channels;
77
78	/**
79	 * num_rates - Number of entries in the rates array
80	 */
81	int num_rates;
82
83	/**
84	 * rates - Array of supported rates in 100 kbps units
85	 */
86	int *rates;
87
88	/**
89	 * ht_capab - HT (IEEE 802.11n) capabilities
90	 */
91	u16 ht_capab;
92
93	/**
94	 * mcs_set - MCS (IEEE 802.11n) rate parameters
95	 */
96	u8 mcs_set[16];
97
98	/**
99	 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
100	 */
101	u8 a_mpdu_params;
102
103	/**
104	 * vht_capab - VHT (IEEE 802.11ac) capabilities
105	 */
106	u32 vht_capab;
107
108	/**
109	 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
110	 */
111	u8 vht_mcs_set[8];
112
113	unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
114};
115
116
117#define IEEE80211_MODE_INFRA	0
118#define IEEE80211_MODE_IBSS	1
119#define IEEE80211_MODE_AP	2
120
121#define IEEE80211_CAP_ESS	0x0001
122#define IEEE80211_CAP_IBSS	0x0002
123#define IEEE80211_CAP_PRIVACY	0x0010
124
125#define WPA_SCAN_QUAL_INVALID		BIT(0)
126#define WPA_SCAN_NOISE_INVALID		BIT(1)
127#define WPA_SCAN_LEVEL_INVALID		BIT(2)
128#define WPA_SCAN_LEVEL_DBM		BIT(3)
129#define WPA_SCAN_AUTHENTICATED		BIT(4)
130#define WPA_SCAN_ASSOCIATED		BIT(5)
131
132/**
133 * struct wpa_scan_res - Scan result for an BSS/IBSS
134 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
135 * @bssid: BSSID
136 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
137 * @beacon_int: beacon interval in TUs (host byte order)
138 * @caps: capability information field in host byte order
139 * @qual: signal quality
140 * @noise: noise level
141 * @level: signal level
142 * @tsf: Timestamp
143 * @age: Age of the information in milliseconds (i.e., how many milliseconds
144 * ago the last Beacon or Probe Response frame was received)
145 * @ie_len: length of the following IE field in octets
146 * @beacon_ie_len: length of the following Beacon IE field in octets
147 *
148 * This structure is used as a generic format for scan results from the
149 * driver. Each driver interface implementation is responsible for converting
150 * the driver or OS specific scan results into this format.
151 *
152 * If the driver does not support reporting all IEs, the IE data structure is
153 * constructed of the IEs that are available. This field will also need to
154 * include SSID in IE format. All drivers are encouraged to be extended to
155 * report all IEs to make it easier to support future additions.
156 */
157struct wpa_scan_res {
158	unsigned int flags;
159	u8 bssid[ETH_ALEN];
160	int freq;
161	u16 beacon_int;
162	u16 caps;
163	int qual;
164	int noise;
165	int level;
166	u64 tsf;
167	unsigned int age;
168	size_t ie_len;
169	size_t beacon_ie_len;
170	/*
171	 * Followed by ie_len octets of IEs from Probe Response frame (or if
172	 * the driver does not indicate source of IEs, these may also be from
173	 * Beacon frame). After the first set of IEs, another set of IEs may
174	 * follow (with beacon_ie_len octets of data) if the driver provides
175	 * both IE sets.
176	 */
177};
178
179/**
180 * struct wpa_scan_results - Scan results
181 * @res: Array of pointers to allocated variable length scan result entries
182 * @num: Number of entries in the scan result array
183 */
184struct wpa_scan_results {
185	struct wpa_scan_res **res;
186	size_t num;
187};
188
189/**
190 * struct wpa_interface_info - Network interface information
191 * @next: Pointer to the next interface or NULL if this is the last one
192 * @ifname: Interface name that can be used with init() or init2()
193 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
194 *	not available
195 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
196 *	is not an allocated copy, i.e., get_interfaces() caller will not free
197 *	this)
198 */
199struct wpa_interface_info {
200	struct wpa_interface_info *next;
201	char *ifname;
202	char *desc;
203	const char *drv_name;
204};
205
206#define WPAS_MAX_SCAN_SSIDS 16
207
208/**
209 * struct wpa_driver_scan_params - Scan parameters
210 * Data for struct wpa_driver_ops::scan2().
211 */
212struct wpa_driver_scan_params {
213	/**
214	 * ssids - SSIDs to scan for
215	 */
216	struct wpa_driver_scan_ssid {
217		/**
218		 * ssid - specific SSID to scan for (ProbeReq)
219		 * %NULL or zero-length SSID is used to indicate active scan
220		 * with wildcard SSID.
221		 */
222		const u8 *ssid;
223		/**
224		 * ssid_len: Length of the SSID in octets
225		 */
226		size_t ssid_len;
227	} ssids[WPAS_MAX_SCAN_SSIDS];
228
229	/**
230	 * num_ssids - Number of entries in ssids array
231	 * Zero indicates a request for a passive scan.
232	 */
233	size_t num_ssids;
234
235	/**
236	 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
237	 */
238	const u8 *extra_ies;
239
240	/**
241	 * extra_ies_len - Length of extra_ies in octets
242	 */
243	size_t extra_ies_len;
244
245	/**
246	 * freqs - Array of frequencies to scan or %NULL for all frequencies
247	 *
248	 * The frequency is set in MHz. The array is zero-terminated.
249	 */
250	int *freqs;
251
252	/**
253	 * filter_ssids - Filter for reporting SSIDs
254	 *
255	 * This optional parameter can be used to request the driver wrapper to
256	 * filter scan results to include only the specified SSIDs. %NULL
257	 * indicates that no filtering is to be done. This can be used to
258	 * reduce memory needs for scan results in environments that have large
259	 * number of APs with different SSIDs.
260	 *
261	 * The driver wrapper is allowed to take this allocated buffer into its
262	 * own use by setting the pointer to %NULL. In that case, the driver
263	 * wrapper is responsible for freeing the buffer with os_free() once it
264	 * is not needed anymore.
265	 */
266	struct wpa_driver_scan_filter {
267		u8 ssid[32];
268		size_t ssid_len;
269	} *filter_ssids;
270
271	/**
272	 * num_filter_ssids - Number of entries in filter_ssids array
273	 */
274	size_t num_filter_ssids;
275
276	/**
277	 * filter_rssi - Filter by RSSI
278	 *
279	 * The driver may filter scan results in firmware to reduce host
280	 * wakeups and thereby save power. Specify the RSSI threshold in s32
281	 * dBm.
282	 */
283	s32 filter_rssi;
284
285	/**
286	 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
287	 *
288	 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
289	 * Mbps from the support rates element(s) in the Probe Request frames
290	 * and not to transmit the frames at any of those rates.
291	 */
292	u8 p2p_probe;
293};
294
295/**
296 * struct wpa_driver_auth_params - Authentication parameters
297 * Data for struct wpa_driver_ops::authenticate().
298 */
299struct wpa_driver_auth_params {
300	int freq;
301	const u8 *bssid;
302	const u8 *ssid;
303	size_t ssid_len;
304	int auth_alg;
305	const u8 *ie;
306	size_t ie_len;
307	const u8 *wep_key[4];
308	size_t wep_key_len[4];
309	int wep_tx_keyidx;
310	int local_state_change;
311
312	/**
313	 * p2p - Whether this connection is a P2P group
314	 */
315	int p2p;
316
317	const u8 *sae_data;
318	size_t sae_data_len;
319
320};
321
322enum wps_mode {
323	WPS_MODE_NONE /* no WPS provisioning being used */,
324	WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
325	WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
326			  */
327};
328
329/**
330 * struct wpa_driver_associate_params - Association parameters
331 * Data for struct wpa_driver_ops::associate().
332 */
333struct wpa_driver_associate_params {
334	/**
335	 * bssid - BSSID of the selected AP
336	 * This can be %NULL, if ap_scan=2 mode is used and the driver is
337	 * responsible for selecting with which BSS to associate. */
338	const u8 *bssid;
339
340	/**
341	 * ssid - The selected SSID
342	 */
343	const u8 *ssid;
344
345	/**
346	 * ssid_len - Length of the SSID (1..32)
347	 */
348	size_t ssid_len;
349
350	/**
351	 * freq - Frequency of the channel the selected AP is using
352	 * Frequency that the selected AP is using (in MHz as
353	 * reported in the scan results)
354	 */
355	int freq;
356
357	/**
358	 * bg_scan_period - Background scan period in seconds, 0 to disable
359	 * background scan, or -1 to indicate no change to default driver
360	 * configuration
361	 */
362	int bg_scan_period;
363
364	/**
365	 * wpa_ie - WPA information element for (Re)Association Request
366	 * WPA information element to be included in (Re)Association
367	 * Request (including information element id and length). Use
368	 * of this WPA IE is optional. If the driver generates the WPA
369	 * IE, it can use pairwise_suite, group_suite, and
370	 * key_mgmt_suite to select proper algorithms. In this case,
371	 * the driver has to notify wpa_supplicant about the used WPA
372	 * IE by generating an event that the interface code will
373	 * convert into EVENT_ASSOCINFO data (see below).
374	 *
375	 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
376	 * instead. The driver can determine which version is used by
377	 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
378	 * WPA2/RSN).
379	 *
380	 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
381	 */
382	const u8 *wpa_ie;
383
384	/**
385	 * wpa_ie_len - length of the wpa_ie
386	 */
387	size_t wpa_ie_len;
388
389	/**
390	 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
391	 */
392	unsigned int wpa_proto;
393
394	/**
395	 * pairwise_suite - Selected pairwise cipher suite
396	 *
397	 * This is usually ignored if @wpa_ie is used.
398	 */
399	enum wpa_cipher pairwise_suite;
400
401	/**
402	 * group_suite - Selected group cipher suite
403	 *
404	 * This is usually ignored if @wpa_ie is used.
405	 */
406	enum wpa_cipher group_suite;
407
408	/**
409	 * key_mgmt_suite - Selected key management suite
410	 *
411	 * This is usually ignored if @wpa_ie is used.
412	 */
413	enum wpa_key_mgmt key_mgmt_suite;
414
415	/**
416	 * auth_alg - Allowed authentication algorithms
417	 * Bit field of WPA_AUTH_ALG_*
418	 */
419	int auth_alg;
420
421	/**
422	 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
423	 */
424	int mode;
425
426	/**
427	 * wep_key - WEP keys for static WEP configuration
428	 */
429	const u8 *wep_key[4];
430
431	/**
432	 * wep_key_len - WEP key length for static WEP configuration
433	 */
434	size_t wep_key_len[4];
435
436	/**
437	 * wep_tx_keyidx - WEP TX key index for static WEP configuration
438	 */
439	int wep_tx_keyidx;
440
441	/**
442	 * mgmt_frame_protection - IEEE 802.11w management frame protection
443	 */
444	enum mfp_options mgmt_frame_protection;
445
446	/**
447	 * ft_ies - IEEE 802.11r / FT information elements
448	 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
449	 * for fast transition, this parameter is set to include the IEs that
450	 * are to be sent in the next FT Authentication Request message.
451	 * update_ft_ies() handler is called to update the IEs for further
452	 * FT messages in the sequence.
453	 *
454	 * The driver should use these IEs only if the target AP is advertising
455	 * the same mobility domain as the one included in the MDIE here.
456	 *
457	 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
458	 * AP after the initial association. These IEs can only be used if the
459	 * target AP is advertising support for FT and is using the same MDIE
460	 * and SSID as the current AP.
461	 *
462	 * The driver is responsible for reporting the FT IEs received from the
463	 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
464	 * type. update_ft_ies() handler will then be called with the FT IEs to
465	 * include in the next frame in the authentication sequence.
466	 */
467	const u8 *ft_ies;
468
469	/**
470	 * ft_ies_len - Length of ft_ies in bytes
471	 */
472	size_t ft_ies_len;
473
474	/**
475	 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
476	 *
477	 * This value is provided to allow the driver interface easier access
478	 * to the current mobility domain. This value is set to %NULL if no
479	 * mobility domain is currently active.
480	 */
481	const u8 *ft_md;
482
483	/**
484	 * passphrase - RSN passphrase for PSK
485	 *
486	 * This value is made available only for WPA/WPA2-Personal (PSK) and
487	 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
488	 * the 8..63 character ASCII passphrase, if available. Please note that
489	 * this can be %NULL if passphrase was not used to generate the PSK. In
490	 * that case, the psk field must be used to fetch the PSK.
491	 */
492	const char *passphrase;
493
494	/**
495	 * psk - RSN PSK (alternative for passphrase for PSK)
496	 *
497	 * This value is made available only for WPA/WPA2-Personal (PSK) and
498	 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
499	 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
500	 * be prepared to handle %NULL value as an error.
501	 */
502	const u8 *psk;
503
504	/**
505	 * drop_unencrypted - Enable/disable unencrypted frame filtering
506	 *
507	 * Configure the driver to drop all non-EAPOL frames (both receive and
508	 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
509	 * still be allowed for key negotiation.
510	 */
511	int drop_unencrypted;
512
513	/**
514	 * prev_bssid - Previously used BSSID in this ESS
515	 *
516	 * When not %NULL, this is a request to use reassociation instead of
517	 * association.
518	 */
519	const u8 *prev_bssid;
520
521	/**
522	 * wps - WPS mode
523	 *
524	 * If the driver needs to do special configuration for WPS association,
525	 * this variable provides more information on what type of association
526	 * is being requested. Most drivers should not need ot use this.
527	 */
528	enum wps_mode wps;
529
530	/**
531	 * p2p - Whether this connection is a P2P group
532	 */
533	int p2p;
534
535	/**
536	 * uapsd - UAPSD parameters for the network
537	 * -1 = do not change defaults
538	 * AP mode: 1 = enabled, 0 = disabled
539	 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
540	 */
541	int uapsd;
542
543	/**
544	 * fixed_bssid - Whether to force this BSSID in IBSS mode
545	 * 1 = Fix this BSSID and prevent merges.
546	 * 0 = Do not fix BSSID.
547	 */
548	int fixed_bssid;
549
550	/**
551	 * disable_ht - Disable HT (IEEE 802.11n) for this connection
552	 */
553	int disable_ht;
554
555	/**
556	 * HT Capabilities over-rides. Only bits set in the mask will be used,
557	 * and not all values are used by the kernel anyway. Currently, MCS,
558	 * MPDU and MSDU fields are used.
559	 */
560	const u8 *htcaps;       /* struct ieee80211_ht_capabilities * */
561	const u8 *htcaps_mask;  /* struct ieee80211_ht_capabilities * */
562};
563
564enum hide_ssid {
565	NO_SSID_HIDING,
566	HIDDEN_SSID_ZERO_LEN,
567	HIDDEN_SSID_ZERO_CONTENTS
568};
569
570struct wpa_driver_ap_params {
571	/**
572	 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
573	 */
574	const u8 *head;
575
576	/**
577	 * head_len - Length of the head buffer in octets
578	 */
579	size_t head_len;
580
581	/**
582	 * tail - Beacon tail following TIM IE
583	 */
584	const u8 *tail;
585
586	/**
587	 * tail_len - Length of the tail buffer in octets
588	 */
589	size_t tail_len;
590
591	/**
592	 * dtim_period - DTIM period
593	 */
594	int dtim_period;
595
596	/**
597	 * beacon_int - Beacon interval
598	 */
599	int beacon_int;
600
601	/**
602	 * basic_rates: -1 terminated array of basic rates in 100 kbps
603	 *
604	 * This parameter can be used to set a specific basic rate set for the
605	 * BSS. If %NULL, default basic rate set is used.
606	 */
607	int *basic_rates;
608
609	/**
610	 * proberesp - Probe Response template
611	 *
612	 * This is used by drivers that reply to Probe Requests internally in
613	 * AP mode and require the full Probe Response template.
614	 */
615	const u8 *proberesp;
616
617	/**
618	 * proberesp_len - Length of the proberesp buffer in octets
619	 */
620	size_t proberesp_len;
621
622	/**
623	 * ssid - The SSID to use in Beacon/Probe Response frames
624	 */
625	const u8 *ssid;
626
627	/**
628	 * ssid_len - Length of the SSID (1..32)
629	 */
630	size_t ssid_len;
631
632	/**
633	 * hide_ssid - Whether to hide the SSID
634	 */
635	enum hide_ssid hide_ssid;
636
637	/**
638	 * pairwise_ciphers - WPA_CIPHER_* bitfield
639	 */
640	unsigned int pairwise_ciphers;
641
642	/**
643	 * group_cipher - WPA_CIPHER_*
644	 */
645	unsigned int group_cipher;
646
647	/**
648	 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
649	 */
650	unsigned int key_mgmt_suites;
651
652	/**
653	 * auth_algs - WPA_AUTH_ALG_* bitfield
654	 */
655	unsigned int auth_algs;
656
657	/**
658	 * wpa_version - WPA_PROTO_* bitfield
659	 */
660	unsigned int wpa_version;
661
662	/**
663	 * privacy - Whether privacy is used in the BSS
664	 */
665	int privacy;
666
667	/**
668	 * beacon_ies - WPS/P2P IE(s) for Beacon frames
669	 *
670	 * This is used to add IEs like WPS IE and P2P IE by drivers that do
671	 * not use the full Beacon template.
672	 */
673	const struct wpabuf *beacon_ies;
674
675	/**
676	 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
677	 *
678	 * This is used to add IEs like WPS IE and P2P IE by drivers that
679	 * reply to Probe Request frames internally.
680	 */
681	const struct wpabuf *proberesp_ies;
682
683	/**
684	 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
685	 *
686	 * This is used to add IEs like WPS IE by drivers that reply to
687	 * (Re)Association Request frames internally.
688	 */
689	const struct wpabuf *assocresp_ies;
690
691	/**
692	 * isolate - Whether to isolate frames between associated stations
693	 *
694	 * If this is non-zero, the AP is requested to disable forwarding of
695	 * frames between associated stations.
696	 */
697	int isolate;
698
699	/**
700	 * cts_protect - Whether CTS protection is enabled
701	 */
702	int cts_protect;
703
704	/**
705	 * preamble - Whether short preamble is enabled
706	 */
707	int preamble;
708
709	/**
710	 * short_slot_time - Whether short slot time is enabled
711	 *
712	 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
713	 * not set (e.g., when 802.11g mode is not in use)
714	 */
715	int short_slot_time;
716
717	/**
718	 * ht_opmode - HT operation mode or -1 if HT not in use
719	 */
720	int ht_opmode;
721
722	/**
723	 * interworking - Whether Interworking is enabled
724	 */
725	int interworking;
726
727	/**
728	 * hessid - Homogeneous ESS identifier or %NULL if not set
729	 */
730	const u8 *hessid;
731
732	/**
733	 * access_network_type - Access Network Type (0..15)
734	 *
735	 * This is used for filtering Probe Request frames when Interworking is
736	 * enabled.
737	 */
738	u8 access_network_type;
739
740	/**
741	 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
742	 *
743	 * This is used by driver which advertises this capability.
744	 */
745	int ap_max_inactivity;
746
747	/**
748	 * disable_dgaf - Whether group-addressed frames are disabled
749	 */
750	int disable_dgaf;
751};
752
753/**
754 * struct wpa_driver_capa - Driver capability information
755 */
756struct wpa_driver_capa {
757#define WPA_DRIVER_CAPA_KEY_MGMT_WPA		0x00000001
758#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2		0x00000002
759#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK	0x00000004
760#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK	0x00000008
761#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE	0x00000010
762#define WPA_DRIVER_CAPA_KEY_MGMT_FT		0x00000020
763#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK		0x00000040
764#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK	0x00000080
765	unsigned int key_mgmt;
766
767#define WPA_DRIVER_CAPA_ENC_WEP40	0x00000001
768#define WPA_DRIVER_CAPA_ENC_WEP104	0x00000002
769#define WPA_DRIVER_CAPA_ENC_TKIP	0x00000004
770#define WPA_DRIVER_CAPA_ENC_CCMP	0x00000008
771#define WPA_DRIVER_CAPA_ENC_WEP128	0x00000010
772#define WPA_DRIVER_CAPA_ENC_GCMP	0x00000020
773	unsigned int enc;
774
775#define WPA_DRIVER_AUTH_OPEN		0x00000001
776#define WPA_DRIVER_AUTH_SHARED		0x00000002
777#define WPA_DRIVER_AUTH_LEAP		0x00000004
778	unsigned int auth;
779
780/* Driver generated WPA/RSN IE */
781#define WPA_DRIVER_FLAGS_DRIVER_IE	0x00000001
782/* Driver needs static WEP key setup after association command */
783#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
784/* unused: 0x00000004 */
785/* Driver takes care of RSN 4-way handshake internally; PMK is configured with
786 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
787#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
788#define WPA_DRIVER_FLAGS_WIRED		0x00000010
789/* Driver provides separate commands for authentication and association (SME in
790 * wpa_supplicant). */
791#define WPA_DRIVER_FLAGS_SME		0x00000020
792/* Driver supports AP mode */
793#define WPA_DRIVER_FLAGS_AP		0x00000040
794/* Driver needs static WEP key setup after association has been completed */
795#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE	0x00000080
796/* Driver takes care of P2P management operations */
797#define WPA_DRIVER_FLAGS_P2P_MGMT	0x00000100
798/* Driver supports concurrent P2P operations */
799#define WPA_DRIVER_FLAGS_P2P_CONCURRENT	0x00000200
800/*
801 * Driver uses the initial interface as a dedicated management interface, i.e.,
802 * it cannot be used for P2P group operations or non-P2P purposes.
803 */
804#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE	0x00000400
805/* This interface is P2P capable (P2P Device, GO, or P2P Client */
806#define WPA_DRIVER_FLAGS_P2P_CAPABLE	0x00000800
807/* Driver supports concurrent operations on multiple channels */
808#define WPA_DRIVER_FLAGS_MULTI_CHANNEL_CONCURRENT	0x00001000
809/*
810 * Driver uses the initial interface for P2P management interface and non-P2P
811 * purposes (e.g., connect to infra AP), but this interface cannot be used for
812 * P2P group operations.
813 */
814#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P		0x00002000
815/*
816 * Driver is known to use sane error codes, i.e., when it indicates that
817 * something (e.g., association) fails, there was indeed a failure and the
818 * operation does not end up getting completed successfully later.
819 */
820#define WPA_DRIVER_FLAGS_SANE_ERROR_CODES		0x00004000
821/* Driver supports off-channel TX */
822#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX			0x00008000
823/* Driver indicates TX status events for EAPOL Data frames */
824#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS		0x00010000
825/* Driver indicates TX status events for Deauth/Disassoc frames */
826#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS		0x00020000
827/* Driver supports roaming (BSS selection) in firmware */
828#define WPA_DRIVER_FLAGS_BSS_SELECTION			0x00040000
829/* Driver supports operating as a TDLS peer */
830#define WPA_DRIVER_FLAGS_TDLS_SUPPORT			0x00080000
831/* Driver requires external TDLS setup/teardown/discovery */
832#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP		0x00100000
833/* Driver indicates support for Probe Response offloading in AP mode */
834#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD		0x00200000
835/* Driver supports U-APSD in AP mode */
836#define WPA_DRIVER_FLAGS_AP_UAPSD			0x00400000
837/* Driver supports inactivity timer in AP mode */
838#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER		0x00800000
839/* Driver expects user space implementation of MLME in AP mode */
840#define WPA_DRIVER_FLAGS_AP_MLME			0x01000000
841/* Driver supports SAE with user space SME */
842#define WPA_DRIVER_FLAGS_SAE				0x02000000
843/* Driver makes use of OBSS scan mechanism in wpa_supplicant */
844#define WPA_DRIVER_FLAGS_OBSS_SCAN			0x04000000
845	unsigned int flags;
846
847	int max_scan_ssids;
848	int max_sched_scan_ssids;
849	int sched_scan_supported;
850	int max_match_sets;
851
852	/**
853	 * max_remain_on_chan - Maximum remain-on-channel duration in msec
854	 */
855	unsigned int max_remain_on_chan;
856
857	/**
858	 * max_stations - Maximum number of associated stations the driver
859	 * supports in AP mode
860	 */
861	unsigned int max_stations;
862
863	/**
864	 * probe_resp_offloads - Bitmap of supported protocols by the driver
865	 * for Probe Response offloading.
866	 */
867/* Driver Probe Response offloading support for WPS ver. 1 */
868#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS		0x00000001
869/* Driver Probe Response offloading support for WPS ver. 2 */
870#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2		0x00000002
871/* Driver Probe Response offloading support for P2P */
872#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P		0x00000004
873/* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
874#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING	0x00000008
875	unsigned int probe_resp_offloads;
876};
877
878
879struct hostapd_data;
880
881struct hostap_sta_driver_data {
882	unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
883	unsigned long current_tx_rate;
884	unsigned long inactive_msec;
885	unsigned long flags;
886	unsigned long num_ps_buf_frames;
887	unsigned long tx_retry_failed;
888	unsigned long tx_retry_count;
889	int last_rssi;
890	int last_ack_rssi;
891};
892
893struct hostapd_sta_add_params {
894	const u8 *addr;
895	u16 aid;
896	u16 capability;
897	const u8 *supp_rates;
898	size_t supp_rates_len;
899	u16 listen_interval;
900	const struct ieee80211_ht_capabilities *ht_capabilities;
901	const struct ieee80211_vht_capabilities *vht_capabilities;
902	u32 flags; /* bitmask of WPA_STA_* flags */
903	int set; /* Set STA parameters instead of add */
904	u8 qosinfo;
905};
906
907struct hostapd_freq_params {
908	int mode;
909	int freq;
910	int channel;
911	/* for HT */
912	int ht_enabled;
913	int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
914				 * secondary channel below primary, 1 = HT40
915				 * enabled, secondary channel above primary */
916
917	/* for VHT */
918	int vht_enabled;
919
920	/* valid for both HT and VHT, center_freq2 is non-zero
921	 * only for bandwidth 80 and an 80+80 channel */
922	int center_freq1, center_freq2;
923	int bandwidth;
924};
925
926enum wpa_driver_if_type {
927	/**
928	 * WPA_IF_STATION - Station mode interface
929	 */
930	WPA_IF_STATION,
931
932	/**
933	 * WPA_IF_AP_VLAN - AP mode VLAN interface
934	 *
935	 * This interface shares its address and Beacon frame with the main
936	 * BSS.
937	 */
938	WPA_IF_AP_VLAN,
939
940	/**
941	 * WPA_IF_AP_BSS - AP mode BSS interface
942	 *
943	 * This interface has its own address and Beacon frame.
944	 */
945	WPA_IF_AP_BSS,
946
947	/**
948	 * WPA_IF_P2P_GO - P2P Group Owner
949	 */
950	WPA_IF_P2P_GO,
951
952	/**
953	 * WPA_IF_P2P_CLIENT - P2P Client
954	 */
955	WPA_IF_P2P_CLIENT,
956
957	/**
958	 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
959	 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
960	 */
961	WPA_IF_P2P_GROUP
962};
963
964struct wpa_init_params {
965	void *global_priv;
966	const u8 *bssid;
967	const char *ifname;
968	const u8 *ssid;
969	size_t ssid_len;
970	const char *test_socket;
971	int use_pae_group_addr;
972	char **bridge;
973	size_t num_bridge;
974
975	u8 *own_addr; /* buffer for writing own MAC address */
976};
977
978
979struct wpa_bss_params {
980	/** Interface name (for multi-SSID/VLAN support) */
981	const char *ifname;
982	/** Whether IEEE 802.1X or WPA/WPA2 is enabled */
983	int enabled;
984
985	int wpa;
986	int ieee802_1x;
987	int wpa_group;
988	int wpa_pairwise;
989	int wpa_key_mgmt;
990	int rsn_preauth;
991	enum mfp_options ieee80211w;
992};
993
994#define WPA_STA_AUTHORIZED BIT(0)
995#define WPA_STA_WMM BIT(1)
996#define WPA_STA_SHORT_PREAMBLE BIT(2)
997#define WPA_STA_MFP BIT(3)
998#define WPA_STA_TDLS_PEER BIT(4)
999
1000/**
1001 * struct p2p_params - P2P parameters for driver-based P2P management
1002 */
1003struct p2p_params {
1004	const char *dev_name;
1005	u8 pri_dev_type[8];
1006#define DRV_MAX_SEC_DEV_TYPES 5
1007	u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8];
1008	size_t num_sec_dev_types;
1009};
1010
1011enum tdls_oper {
1012	TDLS_DISCOVERY_REQ,
1013	TDLS_SETUP,
1014	TDLS_TEARDOWN,
1015	TDLS_ENABLE_LINK,
1016	TDLS_DISABLE_LINK,
1017	TDLS_ENABLE,
1018	TDLS_DISABLE
1019};
1020
1021enum wnm_oper {
1022	WNM_SLEEP_ENTER_CONFIRM,
1023	WNM_SLEEP_ENTER_FAIL,
1024	WNM_SLEEP_EXIT_CONFIRM,
1025	WNM_SLEEP_EXIT_FAIL,
1026	WNM_SLEEP_TFS_REQ_IE_ADD,   /* STA requests driver to add TFS req IE */
1027	WNM_SLEEP_TFS_REQ_IE_NONE,  /* STA requests empty TFS req IE */
1028	WNM_SLEEP_TFS_REQ_IE_SET,   /* AP requests driver to set TFS req IE for
1029				     * a STA */
1030	WNM_SLEEP_TFS_RESP_IE_ADD,  /* AP requests driver to add TFS resp IE
1031				     * for a STA */
1032	WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1033	WNM_SLEEP_TFS_RESP_IE_SET,  /* AP requests driver to set TFS resp IE
1034				     * for a STA */
1035	WNM_SLEEP_TFS_IE_DEL        /* AP delete the TFS IE */
1036};
1037
1038/**
1039 * struct wpa_signal_info - Information about channel signal quality
1040 */
1041struct wpa_signal_info {
1042	u32 frequency;
1043	int above_threshold;
1044	int current_signal;
1045	int current_noise;
1046	int current_txrate;
1047};
1048
1049/**
1050 * struct wpa_driver_ops - Driver interface API definition
1051 *
1052 * This structure defines the API that each driver interface needs to implement
1053 * for core wpa_supplicant code. All driver specific functionality is captured
1054 * in this wrapper.
1055 */
1056struct wpa_driver_ops {
1057	/** Name of the driver interface */
1058	const char *name;
1059	/** One line description of the driver interface */
1060	const char *desc;
1061
1062	/**
1063	 * get_bssid - Get the current BSSID
1064	 * @priv: private driver interface data
1065	 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1066	 *
1067	 * Returns: 0 on success, -1 on failure
1068	 *
1069	 * Query kernel driver for the current BSSID and copy it to bssid.
1070	 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1071	 * associated.
1072	 */
1073	int (*get_bssid)(void *priv, u8 *bssid);
1074
1075	/**
1076	 * get_ssid - Get the current SSID
1077	 * @priv: private driver interface data
1078	 * @ssid: buffer for SSID (at least 32 bytes)
1079	 *
1080	 * Returns: Length of the SSID on success, -1 on failure
1081	 *
1082	 * Query kernel driver for the current SSID and copy it to ssid.
1083	 * Returning zero is recommended if the STA is not associated.
1084	 *
1085	 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1086	 * can, at least in theory, contain control characters (including nul)
1087	 * and as such, should be processed as binary data, not a printable
1088	 * string.
1089	 */
1090	int (*get_ssid)(void *priv, u8 *ssid);
1091
1092	/**
1093	 * set_key - Configure encryption key
1094	 * @ifname: Interface name (for multi-SSID/VLAN support)
1095	 * @priv: private driver interface data
1096	 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1097	 *	%WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1098	 *	%WPA_ALG_GCMP);
1099	 *	%WPA_ALG_NONE clears the key.
1100	 * @addr: Address of the peer STA (BSSID of the current AP when setting
1101	 *	pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1102	 *	broadcast keys, %NULL for default keys that are used both for
1103	 *	broadcast and unicast; when clearing keys, %NULL is used to
1104	 *	indicate that both the broadcast-only and default key of the
1105	 *	specified key index is to be cleared
1106	 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1107	 *	IGTK
1108	 * @set_tx: configure this key as the default Tx key (only used when
1109	 *	driver does not support separate unicast/individual key
1110	 * @seq: sequence number/packet number, seq_len octets, the next
1111	 *	packet number to be used for in replay protection; configured
1112	 *	for Rx keys (in most cases, this is only used with broadcast
1113	 *	keys and set to zero for unicast keys); %NULL if not set
1114	 * @seq_len: length of the seq, depends on the algorithm:
1115	 *	TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1116	 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1117	 *	8-byte Rx Mic Key
1118	 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1119	 *	TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1120	 *
1121	 * Returns: 0 on success, -1 on failure
1122	 *
1123	 * Configure the given key for the kernel driver. If the driver
1124	 * supports separate individual keys (4 default keys + 1 individual),
1125	 * addr can be used to determine whether the key is default or
1126	 * individual. If only 4 keys are supported, the default key with key
1127	 * index 0 is used as the individual key. STA must be configured to use
1128	 * it as the default Tx key (set_tx is set) and accept Rx for all the
1129	 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1130	 * broadcast keys, so key index 0 is available for this kind of
1131	 * configuration.
1132	 *
1133	 * Please note that TKIP keys include separate TX and RX MIC keys and
1134	 * some drivers may expect them in different order than wpa_supplicant
1135	 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1136	 * will trigger Michael MIC errors. This can be fixed by changing the
1137	 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1138	 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1139	 * example on how this can be done.
1140	 */
1141	int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1142		       const u8 *addr, int key_idx, int set_tx,
1143		       const u8 *seq, size_t seq_len,
1144		       const u8 *key, size_t key_len);
1145
1146	/**
1147	 * init - Initialize driver interface
1148	 * @ctx: context to be used when calling wpa_supplicant functions,
1149	 * e.g., wpa_supplicant_event()
1150	 * @ifname: interface name, e.g., wlan0
1151	 *
1152	 * Returns: Pointer to private data, %NULL on failure
1153	 *
1154	 * Initialize driver interface, including event processing for kernel
1155	 * driver events (e.g., associated, scan results, Michael MIC failure).
1156	 * This function can allocate a private configuration data area for
1157	 * @ctx, file descriptor, interface name, etc. information that may be
1158	 * needed in future driver operations. If this is not used, non-NULL
1159	 * value will need to be returned because %NULL is used to indicate
1160	 * failure. The returned value will be used as 'void *priv' data for
1161	 * all other driver_ops functions.
1162	 *
1163	 * The main event loop (eloop.c) of wpa_supplicant can be used to
1164	 * register callback for read sockets (eloop_register_read_sock()).
1165	 *
1166	 * See below for more information about events and
1167	 * wpa_supplicant_event() function.
1168	 */
1169	void * (*init)(void *ctx, const char *ifname);
1170
1171	/**
1172	 * deinit - Deinitialize driver interface
1173	 * @priv: private driver interface data from init()
1174	 *
1175	 * Shut down driver interface and processing of driver events. Free
1176	 * private data buffer if one was allocated in init() handler.
1177	 */
1178	void (*deinit)(void *priv);
1179
1180	/**
1181	 * set_param - Set driver configuration parameters
1182	 * @priv: private driver interface data from init()
1183	 * @param: driver specific configuration parameters
1184	 *
1185	 * Returns: 0 on success, -1 on failure
1186	 *
1187	 * Optional handler for notifying driver interface about configuration
1188	 * parameters (driver_param).
1189	 */
1190	int (*set_param)(void *priv, const char *param);
1191
1192	/**
1193	 * set_countermeasures - Enable/disable TKIP countermeasures
1194	 * @priv: private driver interface data
1195	 * @enabled: 1 = countermeasures enabled, 0 = disabled
1196	 *
1197	 * Returns: 0 on success, -1 on failure
1198	 *
1199	 * Configure TKIP countermeasures. When these are enabled, the driver
1200	 * should drop all received and queued frames that are using TKIP.
1201	 */
1202	int (*set_countermeasures)(void *priv, int enabled);
1203
1204	/**
1205	 * deauthenticate - Request driver to deauthenticate
1206	 * @priv: private driver interface data
1207	 * @addr: peer address (BSSID of the AP)
1208	 * @reason_code: 16-bit reason code to be sent in the deauthentication
1209	 *	frame
1210	 *
1211	 * Returns: 0 on success, -1 on failure
1212	 */
1213	int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1214
1215	/**
1216	 * associate - Request driver to associate
1217	 * @priv: private driver interface data
1218	 * @params: association parameters
1219	 *
1220	 * Returns: 0 on success, -1 on failure
1221	 */
1222	int (*associate)(void *priv,
1223			 struct wpa_driver_associate_params *params);
1224
1225	/**
1226	 * add_pmkid - Add PMKSA cache entry to the driver
1227	 * @priv: private driver interface data
1228	 * @bssid: BSSID for the PMKSA cache entry
1229	 * @pmkid: PMKID for the PMKSA cache entry
1230	 *
1231	 * Returns: 0 on success, -1 on failure
1232	 *
1233	 * This function is called when a new PMK is received, as a result of
1234	 * either normal authentication or RSN pre-authentication.
1235	 *
1236	 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1237	 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1238	 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1239	 * driver_ops function does not need to be implemented. Likewise, if
1240	 * the driver does not support WPA, this function is not needed.
1241	 */
1242	int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1243
1244	/**
1245	 * remove_pmkid - Remove PMKSA cache entry to the driver
1246	 * @priv: private driver interface data
1247	 * @bssid: BSSID for the PMKSA cache entry
1248	 * @pmkid: PMKID for the PMKSA cache entry
1249	 *
1250	 * Returns: 0 on success, -1 on failure
1251	 *
1252	 * This function is called when the supplicant drops a PMKSA cache
1253	 * entry for any reason.
1254	 *
1255	 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1256	 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1257	 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1258	 * from wpa_supplicant, this driver_ops function does not need to be
1259	 * implemented. Likewise, if the driver does not support WPA, this
1260	 * function is not needed.
1261	 */
1262	int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1263
1264	/**
1265	 * flush_pmkid - Flush PMKSA cache
1266	 * @priv: private driver interface data
1267	 *
1268	 * Returns: 0 on success, -1 on failure
1269	 *
1270	 * This function is called when the supplicant drops all PMKSA cache
1271	 * entries for any reason.
1272	 *
1273	 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1274	 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1275	 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1276	 * from wpa_supplicant, this driver_ops function does not need to be
1277	 * implemented. Likewise, if the driver does not support WPA, this
1278	 * function is not needed.
1279	 */
1280	int (*flush_pmkid)(void *priv);
1281
1282	/**
1283	 * get_capa - Get driver capabilities
1284	 * @priv: private driver interface data
1285	 *
1286	 * Returns: 0 on success, -1 on failure
1287	 *
1288	 * Get driver/firmware/hardware capabilities.
1289	 */
1290	int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1291
1292	/**
1293	 * poll - Poll driver for association information
1294	 * @priv: private driver interface data
1295	 *
1296	 * This is an option callback that can be used when the driver does not
1297	 * provide event mechanism for association events. This is called when
1298	 * receiving WPA EAPOL-Key messages that require association
1299	 * information. The driver interface is supposed to generate associnfo
1300	 * event before returning from this callback function. In addition, the
1301	 * driver interface should generate an association event after having
1302	 * sent out associnfo.
1303	 */
1304	void (*poll)(void *priv);
1305
1306	/**
1307	 * get_ifname - Get interface name
1308	 * @priv: private driver interface data
1309	 *
1310	 * Returns: Pointer to the interface name. This can differ from the
1311	 * interface name used in init() call. Init() is called first.
1312	 *
1313	 * This optional function can be used to allow the driver interface to
1314	 * replace the interface name with something else, e.g., based on an
1315	 * interface mapping from a more descriptive name.
1316	 */
1317	const char * (*get_ifname)(void *priv);
1318
1319	/**
1320	 * get_mac_addr - Get own MAC address
1321	 * @priv: private driver interface data
1322	 *
1323	 * Returns: Pointer to own MAC address or %NULL on failure
1324	 *
1325	 * This optional function can be used to get the own MAC address of the
1326	 * device from the driver interface code. This is only needed if the
1327	 * l2_packet implementation for the OS does not provide easy access to
1328	 * a MAC address. */
1329	const u8 * (*get_mac_addr)(void *priv);
1330
1331	/**
1332	 * send_eapol - Optional function for sending EAPOL packets
1333	 * @priv: private driver interface data
1334	 * @dest: Destination MAC address
1335	 * @proto: Ethertype
1336	 * @data: EAPOL packet starting with IEEE 802.1X header
1337	 * @data_len: Size of the EAPOL packet
1338	 *
1339	 * Returns: 0 on success, -1 on failure
1340	 *
1341	 * This optional function can be used to override l2_packet operations
1342	 * with driver specific functionality. If this function pointer is set,
1343	 * l2_packet module is not used at all and the driver interface code is
1344	 * responsible for receiving and sending all EAPOL packets. The
1345	 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1346	 * event. The driver interface is required to implement get_mac_addr()
1347	 * handler if send_eapol() is used.
1348	 */
1349	int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1350			  const u8 *data, size_t data_len);
1351
1352	/**
1353	 * set_operstate - Sets device operating state to DORMANT or UP
1354	 * @priv: private driver interface data
1355	 * @state: 0 = dormant, 1 = up
1356	 * Returns: 0 on success, -1 on failure
1357	 *
1358	 * This is an optional function that can be used on operating systems
1359	 * that support a concept of controlling network device state from user
1360	 * space applications. This function, if set, gets called with
1361	 * state = 1 when authentication has been completed and with state = 0
1362	 * when connection is lost.
1363	 */
1364	int (*set_operstate)(void *priv, int state);
1365
1366	/**
1367	 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1368	 * @priv: Private driver interface data
1369	 * @addr: Address of the station for which to set protection (may be
1370	 * %NULL for group keys)
1371	 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1372	 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1373	 * Returns: 0 on success, -1 on failure
1374	 *
1375	 * This is an optional function that can be used to set the driver to
1376	 * require protection for Tx and/or Rx frames. This uses the layer
1377	 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1378	 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1379	 * set protection operation; instead, they set protection implicitly
1380	 * based on configured keys.
1381	 */
1382	int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1383				  int key_type);
1384
1385	/**
1386	 * get_hw_feature_data - Get hardware support data (channels and rates)
1387	 * @priv: Private driver interface data
1388	 * @num_modes: Variable for returning the number of returned modes
1389	 * flags: Variable for returning hardware feature flags
1390	 * Returns: Pointer to allocated hardware data on success or %NULL on
1391	 * failure. Caller is responsible for freeing this.
1392	 */
1393	struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1394							 u16 *num_modes,
1395							 u16 *flags);
1396
1397	/**
1398	 * send_mlme - Send management frame from MLME
1399	 * @priv: Private driver interface data
1400	 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1401	 * @data_len: Size of the management frame
1402	 * @noack: Do not wait for this frame to be acked (disable retries)
1403	 * Returns: 0 on success, -1 on failure
1404	 */
1405	int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1406			 int noack);
1407
1408	/**
1409	 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1410	 * @priv: Private driver interface data
1411	 * @md: Mobility domain (2 octets) (also included inside ies)
1412	 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1413	 * @ies_len: Length of FT IEs in bytes
1414	 * Returns: 0 on success, -1 on failure
1415	 *
1416	 * The supplicant uses this callback to let the driver know that keying
1417	 * material for FT is available and that the driver can use the
1418	 * provided IEs in the next message in FT authentication sequence.
1419	 *
1420	 * This function is only needed for driver that support IEEE 802.11r
1421	 * (Fast BSS Transition).
1422	 */
1423	int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1424			     size_t ies_len);
1425
1426	/**
1427	 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1428	 * @priv: Private driver interface data
1429	 * @action: Action field value
1430	 * @target_ap: Target AP address
1431	 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1432	 * @ies_len: Length of FT IEs in bytes
1433	 * Returns: 0 on success, -1 on failure
1434	 *
1435	 * The supplicant uses this callback to request the driver to transmit
1436	 * an FT Action frame (action category 6) for over-the-DS fast BSS
1437	 * transition.
1438	 */
1439	int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1440			      const u8 *ies, size_t ies_len);
1441
1442	/**
1443	 * get_scan_results2 - Fetch the latest scan results
1444	 * @priv: private driver interface data
1445	 *
1446	 * Returns: Allocated buffer of scan results (caller is responsible for
1447	 * freeing the data structure) on success, NULL on failure
1448	 */
1449	 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1450
1451	/**
1452	 * set_country - Set country
1453	 * @priv: Private driver interface data
1454	 * @alpha2: country to which to switch to
1455	 * Returns: 0 on success, -1 on failure
1456	 *
1457	 * This function is for drivers which support some form
1458	 * of setting a regulatory domain.
1459	 */
1460	int (*set_country)(void *priv, const char *alpha2);
1461
1462	/**
1463	 * global_init - Global driver initialization
1464	 * Returns: Pointer to private data (global), %NULL on failure
1465	 *
1466	 * This optional function is called to initialize the driver wrapper
1467	 * for global data, i.e., data that applies to all interfaces. If this
1468	 * function is implemented, global_deinit() will also need to be
1469	 * implemented to free the private data. The driver will also likely
1470	 * use init2() function instead of init() to get the pointer to global
1471	 * data available to per-interface initializer.
1472	 */
1473	void * (*global_init)(void);
1474
1475	/**
1476	 * global_deinit - Global driver deinitialization
1477	 * @priv: private driver global data from global_init()
1478	 *
1479	 * Terminate any global driver related functionality and free the
1480	 * global data structure.
1481	 */
1482	void (*global_deinit)(void *priv);
1483
1484	/**
1485	 * init2 - Initialize driver interface (with global data)
1486	 * @ctx: context to be used when calling wpa_supplicant functions,
1487	 * e.g., wpa_supplicant_event()
1488	 * @ifname: interface name, e.g., wlan0
1489	 * @global_priv: private driver global data from global_init()
1490	 * Returns: Pointer to private data, %NULL on failure
1491	 *
1492	 * This function can be used instead of init() if the driver wrapper
1493	 * uses global data.
1494	 */
1495	void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1496
1497	/**
1498	 * get_interfaces - Get information about available interfaces
1499	 * @global_priv: private driver global data from global_init()
1500	 * Returns: Allocated buffer of interface information (caller is
1501	 * responsible for freeing the data structure) on success, NULL on
1502	 * failure
1503	 */
1504	struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1505
1506	/**
1507	 * scan2 - Request the driver to initiate scan
1508	 * @priv: private driver interface data
1509	 * @params: Scan parameters
1510	 *
1511	 * Returns: 0 on success, -1 on failure
1512	 *
1513	 * Once the scan results are ready, the driver should report scan
1514	 * results event for wpa_supplicant which will eventually request the
1515	 * results with wpa_driver_get_scan_results2().
1516	 */
1517	int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1518
1519	/**
1520	 * authenticate - Request driver to authenticate
1521	 * @priv: private driver interface data
1522	 * @params: authentication parameters
1523	 * Returns: 0 on success, -1 on failure
1524	 *
1525	 * This is an optional function that can be used with drivers that
1526	 * support separate authentication and association steps, i.e., when
1527	 * wpa_supplicant can act as the SME. If not implemented, associate()
1528	 * function is expected to take care of IEEE 802.11 authentication,
1529	 * too.
1530	 */
1531	int (*authenticate)(void *priv,
1532			    struct wpa_driver_auth_params *params);
1533
1534	/**
1535	 * set_ap - Set Beacon and Probe Response information for AP mode
1536	 * @priv: Private driver interface data
1537	 * @params: Parameters to use in AP mode
1538	 *
1539	 * This function is used to configure Beacon template and/or extra IEs
1540	 * to add for Beacon and Probe Response frames for the driver in
1541	 * AP mode. The driver is responsible for building the full Beacon
1542	 * frame by concatenating the head part with TIM IE generated by the
1543	 * driver/firmware and finishing with the tail part. Depending on the
1544	 * driver architectue, this can be done either by using the full
1545	 * template or the set of additional IEs (e.g., WPS and P2P IE).
1546	 * Similarly, Probe Response processing depends on the driver design.
1547	 * If the driver (or firmware) takes care of replying to Probe Request
1548	 * frames, the extra IEs provided here needs to be added to the Probe
1549	 * Response frames.
1550	 *
1551	 * Returns: 0 on success, -1 on failure
1552	 */
1553	int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1554
1555	/**
1556	 * hapd_init - Initialize driver interface (hostapd only)
1557	 * @hapd: Pointer to hostapd context
1558	 * @params: Configuration for the driver wrapper
1559	 * Returns: Pointer to private data, %NULL on failure
1560	 *
1561	 * This function is used instead of init() or init2() when the driver
1562	 * wrapper is used with hostapd.
1563	 */
1564	void * (*hapd_init)(struct hostapd_data *hapd,
1565			    struct wpa_init_params *params);
1566
1567	/**
1568	 * hapd_deinit - Deinitialize driver interface (hostapd only)
1569	 * @priv: Private driver interface data from hapd_init()
1570	 */
1571	void (*hapd_deinit)(void *priv);
1572
1573	/**
1574	 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1575	 * @priv: Private driver interface data
1576	 * @params: BSS parameters
1577	 * Returns: 0 on success, -1 on failure
1578	 *
1579	 * This is an optional function to configure the kernel driver to
1580	 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1581	 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1582	 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1583	 * for Beacon frames.
1584	 *
1585	 * DEPRECATED - use set_ap() instead
1586	 */
1587	int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1588
1589	/**
1590	 * set_privacy - Enable/disable privacy (AP only)
1591	 * @priv: Private driver interface data
1592	 * @enabled: 1 = privacy enabled, 0 = disabled
1593	 * Returns: 0 on success, -1 on failure
1594	 *
1595	 * This is an optional function to configure privacy field in the
1596	 * kernel driver for Beacon frames. This can be left undefined (set to
1597	 * %NULL) if the driver uses the Beacon template from set_ap().
1598	 *
1599	 * DEPRECATED - use set_ap() instead
1600	 */
1601	int (*set_privacy)(void *priv, int enabled);
1602
1603	/**
1604	 * get_seqnum - Fetch the current TSC/packet number (AP only)
1605	 * @ifname: The interface name (main or virtual)
1606	 * @priv: Private driver interface data
1607	 * @addr: MAC address of the station or %NULL for group keys
1608	 * @idx: Key index
1609	 * @seq: Buffer for returning the latest used TSC/packet number
1610	 * Returns: 0 on success, -1 on failure
1611	 *
1612	 * This function is used to fetch the last used TSC/packet number for
1613	 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1614	 * keys, so there is no strict requirement on implementing support for
1615	 * unicast keys (i.e., addr != %NULL).
1616	 */
1617	int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1618			  int idx, u8 *seq);
1619
1620	/**
1621	 * flush - Flush all association stations (AP only)
1622	 * @priv: Private driver interface data
1623	 * Returns: 0 on success, -1 on failure
1624	 *
1625	 * This function requests the driver to disassociate all associated
1626	 * stations. This function does not need to be implemented if the
1627	 * driver does not process association frames internally.
1628	 */
1629	int (*flush)(void *priv);
1630
1631	/**
1632	 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1633	 * @priv: Private driver interface data
1634	 * @elem: Information elements
1635	 * @elem_len: Length of the elem buffer in octets
1636	 * Returns: 0 on success, -1 on failure
1637	 *
1638	 * This is an optional function to add information elements in the
1639	 * kernel driver for Beacon and Probe Response frames. This can be left
1640	 * undefined (set to %NULL) if the driver uses the Beacon template from
1641	 * set_ap().
1642	 *
1643	 * DEPRECATED - use set_ap() instead
1644	 */
1645	int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1646
1647	/**
1648	 * read_sta_data - Fetch station data
1649	 * @priv: Private driver interface data
1650	 * @data: Buffer for returning station information
1651	 * @addr: MAC address of the station
1652	 * Returns: 0 on success, -1 on failure
1653	 */
1654	int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1655			     const u8 *addr);
1656
1657	/**
1658	 * hapd_send_eapol - Send an EAPOL packet (AP only)
1659	 * @priv: private driver interface data
1660	 * @addr: Destination MAC address
1661	 * @data: EAPOL packet starting with IEEE 802.1X header
1662	 * @data_len: Length of the EAPOL packet in octets
1663	 * @encrypt: Whether the frame should be encrypted
1664	 * @own_addr: Source MAC address
1665	 * @flags: WPA_STA_* flags for the destination station
1666	 *
1667	 * Returns: 0 on success, -1 on failure
1668	 */
1669	int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1670			       size_t data_len, int encrypt,
1671			       const u8 *own_addr, u32 flags);
1672
1673	/**
1674	 * sta_deauth - Deauthenticate a station (AP only)
1675	 * @priv: Private driver interface data
1676	 * @own_addr: Source address and BSSID for the Deauthentication frame
1677	 * @addr: MAC address of the station to deauthenticate
1678	 * @reason: Reason code for the Deauthentiation frame
1679	 * Returns: 0 on success, -1 on failure
1680	 *
1681	 * This function requests a specific station to be deauthenticated and
1682	 * a Deauthentication frame to be sent to it.
1683	 */
1684	int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1685			  int reason);
1686
1687	/**
1688	 * sta_disassoc - Disassociate a station (AP only)
1689	 * @priv: Private driver interface data
1690	 * @own_addr: Source address and BSSID for the Disassociation frame
1691	 * @addr: MAC address of the station to disassociate
1692	 * @reason: Reason code for the Disassociation frame
1693	 * Returns: 0 on success, -1 on failure
1694	 *
1695	 * This function requests a specific station to be disassociated and
1696	 * a Disassociation frame to be sent to it.
1697	 */
1698	int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1699			    int reason);
1700
1701	/**
1702	 * sta_remove - Remove a station entry (AP only)
1703	 * @priv: Private driver interface data
1704	 * @addr: MAC address of the station to be removed
1705	 * Returns: 0 on success, -1 on failure
1706	 */
1707	int (*sta_remove)(void *priv, const u8 *addr);
1708
1709	/**
1710	 * hapd_get_ssid - Get the current SSID (AP only)
1711	 * @priv: Private driver interface data
1712	 * @buf: Buffer for returning the SSID
1713	 * @len: Maximum length of the buffer
1714	 * Returns: Length of the SSID on success, -1 on failure
1715	 *
1716	 * This function need not be implemented if the driver uses Beacon
1717	 * template from set_ap() and does not reply to Probe Request frames.
1718	 */
1719	int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1720
1721	/**
1722	 * hapd_set_ssid - Set SSID (AP only)
1723	 * @priv: Private driver interface data
1724	 * @buf: SSID
1725	 * @len: Length of the SSID in octets
1726	 * Returns: 0 on success, -1 on failure
1727	 *
1728	 * DEPRECATED - use set_ap() instead
1729	 */
1730	int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1731
1732	/**
1733	 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1734	 * @priv: Private driver interface data
1735	 * @enabled: 1 = countermeasures enabled, 0 = disabled
1736	 * Returns: 0 on success, -1 on failure
1737	 *
1738	 * This need not be implemented if the driver does not take care of
1739	 * association processing.
1740	 */
1741	int (*hapd_set_countermeasures)(void *priv, int enabled);
1742
1743	/**
1744	 * sta_add - Add a station entry
1745	 * @priv: Private driver interface data
1746	 * @params: Station parameters
1747	 * Returns: 0 on success, -1 on failure
1748	 *
1749	 * This function is used to add a station entry to the driver once the
1750	 * station has completed association. This is only used if the driver
1751	 * does not take care of association processing.
1752	 *
1753	 * With TDLS, this function is also used to add or set (params->set 1)
1754	 * TDLS peer entries.
1755	 */
1756	int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1757
1758	/**
1759	 * get_inact_sec - Get station inactivity duration (AP only)
1760	 * @priv: Private driver interface data
1761	 * @addr: Station address
1762	 * Returns: Number of seconds station has been inactive, -1 on failure
1763	 */
1764	int (*get_inact_sec)(void *priv, const u8 *addr);
1765
1766	/**
1767	 * sta_clear_stats - Clear station statistics (AP only)
1768	 * @priv: Private driver interface data
1769	 * @addr: Station address
1770	 * Returns: 0 on success, -1 on failure
1771	 */
1772	int (*sta_clear_stats)(void *priv, const u8 *addr);
1773
1774	/**
1775	 * set_freq - Set channel/frequency (AP only)
1776	 * @priv: Private driver interface data
1777	 * @freq: Channel parameters
1778	 * Returns: 0 on success, -1 on failure
1779	 */
1780	int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1781
1782	/**
1783	 * set_rts - Set RTS threshold
1784	 * @priv: Private driver interface data
1785	 * @rts: RTS threshold in octets
1786	 * Returns: 0 on success, -1 on failure
1787	 */
1788	int (*set_rts)(void *priv, int rts);
1789
1790	/**
1791	 * set_frag - Set fragmentation threshold
1792	 * @priv: Private driver interface data
1793	 * @frag: Fragmentation threshold in octets
1794	 * Returns: 0 on success, -1 on failure
1795	 */
1796	int (*set_frag)(void *priv, int frag);
1797
1798	/**
1799	 * sta_set_flags - Set station flags (AP only)
1800	 * @priv: Private driver interface data
1801	 * @addr: Station address
1802	 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1803	 * @flags_or: Bitmap of WPA_STA_* flags to add
1804	 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1805	 * Returns: 0 on success, -1 on failure
1806	 */
1807	int (*sta_set_flags)(void *priv, const u8 *addr,
1808			     int total_flags, int flags_or, int flags_and);
1809
1810	/**
1811	 * set_tx_queue_params - Set TX queue parameters
1812	 * @priv: Private driver interface data
1813	 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
1814	 * @aifs: AIFS
1815	 * @cw_min: cwMin
1816	 * @cw_max: cwMax
1817	 * @burst_time: Maximum length for bursting in 0.1 msec units
1818	 */
1819	int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1820				   int cw_max, int burst_time);
1821
1822	/**
1823	 * if_add - Add a virtual interface
1824	 * @priv: Private driver interface data
1825	 * @type: Interface type
1826	 * @ifname: Interface name for the new virtual interface
1827	 * @addr: Local address to use for the interface or %NULL to use the
1828	 *	parent interface address
1829	 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1830	 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1831	 *	not allowed (applies only to %WPA_IF_AP_BSS type)
1832	 * @force_ifname: Buffer for returning an interface name that the
1833	 *	driver ended up using if it differs from the requested ifname
1834	 * @if_addr: Buffer for returning the allocated interface address
1835	 *	(this may differ from the requested addr if the driver cannot
1836	 *	change interface address)
1837	 * @bridge: Bridge interface to use or %NULL if no bridge configured
1838	 * Returns: 0 on success, -1 on failure
1839	 */
1840	int (*if_add)(void *priv, enum wpa_driver_if_type type,
1841		      const char *ifname, const u8 *addr, void *bss_ctx,
1842		      void **drv_priv, char *force_ifname, u8 *if_addr,
1843		      const char *bridge);
1844
1845	/**
1846	 * if_remove - Remove a virtual interface
1847	 * @priv: Private driver interface data
1848	 * @type: Interface type
1849	 * @ifname: Interface name of the virtual interface to be removed
1850	 * Returns: 0 on success, -1 on failure
1851	 */
1852	int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1853			 const char *ifname);
1854
1855	/**
1856	 * set_sta_vlan - Bind a station into a specific interface (AP only)
1857	 * @priv: Private driver interface data
1858	 * @ifname: Interface (main or virtual BSS or VLAN)
1859	 * @addr: MAC address of the associated station
1860	 * @vlan_id: VLAN ID
1861	 * Returns: 0 on success, -1 on failure
1862	 *
1863	 * This function is used to bind a station to a specific virtual
1864	 * interface. It is only used if when virtual interfaces are supported,
1865	 * e.g., to assign stations to different VLAN interfaces based on
1866	 * information from a RADIUS server. This allows separate broadcast
1867	 * domains to be used with a single BSS.
1868	 */
1869	int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1870			    int vlan_id);
1871
1872	/**
1873	 * commit - Optional commit changes handler (AP only)
1874	 * @priv: driver private data
1875	 * Returns: 0 on success, -1 on failure
1876	 *
1877	 * This optional handler function can be registered if the driver
1878	 * interface implementation needs to commit changes (e.g., by setting
1879	 * network interface up) at the end of initial configuration. If set,
1880	 * this handler will be called after initial setup has been completed.
1881	 */
1882	int (*commit)(void *priv);
1883
1884	/**
1885	 * send_ether - Send an ethernet packet (AP only)
1886	 * @priv: private driver interface data
1887	 * @dst: Destination MAC address
1888	 * @src: Source MAC address
1889	 * @proto: Ethertype
1890	 * @data: EAPOL packet starting with IEEE 802.1X header
1891	 * @data_len: Length of the EAPOL packet in octets
1892	 * Returns: 0 on success, -1 on failure
1893	 */
1894	int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1895			  const u8 *data, size_t data_len);
1896
1897	/**
1898	 * set_radius_acl_auth - Notification of RADIUS ACL change
1899	 * @priv: Private driver interface data
1900	 * @mac: MAC address of the station
1901	 * @accepted: Whether the station was accepted
1902	 * @session_timeout: Session timeout for the station
1903	 * Returns: 0 on success, -1 on failure
1904	 */
1905	int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1906				   u32 session_timeout);
1907
1908	/**
1909	 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1910	 * @priv: Private driver interface data
1911	 * @mac: MAC address of the station
1912	 * Returns: 0 on success, -1 on failure
1913	 */
1914	int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1915
1916	/**
1917	 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
1918	 * @priv: Private driver interface data
1919	 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
1920	 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
1921	 *	extra IE(s)
1922	 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
1923	 *	to remove extra IE(s)
1924	 * Returns: 0 on success, -1 on failure
1925	 *
1926	 * This is an optional function to add WPS IE in the kernel driver for
1927	 * Beacon and Probe Response frames. This can be left undefined (set
1928	 * to %NULL) if the driver uses the Beacon template from set_ap()
1929	 * and does not process Probe Request frames. If the driver takes care
1930	 * of (Re)Association frame processing, the assocresp buffer includes
1931	 * WPS IE(s) that need to be added to (Re)Association Response frames
1932	 * whenever a (Re)Association Request frame indicated use of WPS.
1933	 *
1934	 * This will also be used to add P2P IE(s) into Beacon/Probe Response
1935	 * frames when operating as a GO. The driver is responsible for adding
1936	 * timing related attributes (e.g., NoA) in addition to the IEs
1937	 * included here by appending them after these buffers. This call is
1938	 * also used to provide Probe Response IEs for P2P Listen state
1939	 * operations for drivers that generate the Probe Response frames
1940	 * internally.
1941	 *
1942	 * DEPRECATED - use set_ap() instead
1943	 */
1944	int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
1945			     const struct wpabuf *proberesp,
1946			     const struct wpabuf *assocresp);
1947
1948	/**
1949	 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1950	 * @priv: Private driver interface data
1951	 * @authorized: Whether the port is authorized
1952	 * Returns: 0 on success, -1 on failure
1953	 */
1954	int (*set_supp_port)(void *priv, int authorized);
1955
1956	/**
1957	 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1958	 * @priv: Private driver interface data
1959	 * @addr: MAC address of the associated station
1960	 * @aid: Association ID
1961	 * @val: 1 = bind to 4-address WDS; 0 = unbind
1962	 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
1963	 *	to indicate that bridge is not to be used
1964	 * Returns: 0 on success, -1 on failure
1965	 */
1966	int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
1967	                   const char *bridge_ifname);
1968
1969	/**
1970	 * send_action - Transmit an Action frame
1971	 * @priv: Private driver interface data
1972	 * @freq: Frequency (in MHz) of the channel
1973	 * @wait: Time to wait off-channel for a response (in ms), or zero
1974	 * @dst: Destination MAC address (Address 1)
1975	 * @src: Source MAC address (Address 2)
1976	 * @bssid: BSSID (Address 3)
1977	 * @data: Frame body
1978	 * @data_len: data length in octets
1979	 @ @no_cck: Whether CCK rates must not be used to transmit this frame
1980	 * Returns: 0 on success, -1 on failure
1981	 *
1982	 * This command can be used to request the driver to transmit an action
1983	 * frame to the specified destination.
1984	 *
1985	 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
1986	 * be transmitted on the given channel and the device will wait for a
1987	 * response on that channel for the given wait time.
1988	 *
1989	 * If the flag is not set, the wait time will be ignored. In this case,
1990	 * if a remain-on-channel duration is in progress, the frame must be
1991	 * transmitted on that channel; alternatively the frame may be sent on
1992	 * the current operational channel (if in associated state in station
1993	 * mode or while operating as an AP.)
1994	 */
1995	int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
1996			   const u8 *dst, const u8 *src, const u8 *bssid,
1997			   const u8 *data, size_t data_len, int no_cck);
1998
1999	/**
2000	 * send_action_cancel_wait - Cancel action frame TX wait
2001	 * @priv: Private driver interface data
2002	 *
2003	 * This command cancels the wait time associated with sending an action
2004	 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2005	 * set in the driver flags.
2006	 */
2007	void (*send_action_cancel_wait)(void *priv);
2008
2009	/**
2010	 * remain_on_channel - Remain awake on a channel
2011	 * @priv: Private driver interface data
2012	 * @freq: Frequency (in MHz) of the channel
2013	 * @duration: Duration in milliseconds
2014	 * Returns: 0 on success, -1 on failure
2015	 *
2016	 * This command is used to request the driver to remain awake on the
2017	 * specified channel for the specified duration and report received
2018	 * Action frames with EVENT_RX_ACTION events. Optionally, received
2019	 * Probe Request frames may also be requested to be reported by calling
2020	 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2021	 *
2022	 * The driver may not be at the requested channel when this function
2023	 * returns, i.e., the return code is only indicating whether the
2024	 * request was accepted. The caller will need to wait until the
2025	 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2026	 * completed the channel change. This may take some time due to other
2027	 * need for the radio and the caller should be prepared to timing out
2028	 * its wait since there are no guarantees on when this request can be
2029	 * executed.
2030	 */
2031	int (*remain_on_channel)(void *priv, unsigned int freq,
2032				 unsigned int duration);
2033
2034	/**
2035	 * cancel_remain_on_channel - Cancel remain-on-channel operation
2036	 * @priv: Private driver interface data
2037	 *
2038	 * This command can be used to cancel a remain-on-channel operation
2039	 * before its originally requested duration has passed. This could be
2040	 * used, e.g., when remain_on_channel() is used to request extra time
2041	 * to receive a response to an Action frame and the response is
2042	 * received when there is still unneeded time remaining on the
2043	 * remain-on-channel operation.
2044	 */
2045	int (*cancel_remain_on_channel)(void *priv);
2046
2047	/**
2048	 * probe_req_report - Request Probe Request frames to be indicated
2049	 * @priv: Private driver interface data
2050	 * @report: Whether to report received Probe Request frames
2051	 * Returns: 0 on success, -1 on failure (or if not supported)
2052	 *
2053	 * This command can be used to request the driver to indicate when
2054	 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2055	 * Since this operation may require extra resources, e.g., due to less
2056	 * optimal hardware/firmware RX filtering, many drivers may disable
2057	 * Probe Request reporting at least in station mode. This command is
2058	 * used to notify the driver when the Probe Request frames need to be
2059	 * reported, e.g., during remain-on-channel operations.
2060	 */
2061	int (*probe_req_report)(void *priv, int report);
2062
2063	/**
2064	 * deinit_ap - Deinitialize AP mode
2065	 * @priv: Private driver interface data
2066	 * Returns: 0 on success, -1 on failure (or if not supported)
2067	 *
2068	 * This optional function can be used to disable AP mode related
2069	 * configuration and change the driver mode to station mode to allow
2070	 * normal station operations like scanning to be completed.
2071	 */
2072	int (*deinit_ap)(void *priv);
2073
2074	/**
2075	 * deinit_p2p_cli - Deinitialize P2P client mode
2076	 * @priv: Private driver interface data
2077	 * Returns: 0 on success, -1 on failure (or if not supported)
2078	 *
2079	 * This optional function can be used to disable P2P client mode. It
2080	 * can be used to change the interface type back to station mode.
2081	 */
2082	int (*deinit_p2p_cli)(void *priv);
2083
2084	/**
2085	 * suspend - Notification on system suspend/hibernate event
2086	 * @priv: Private driver interface data
2087	 */
2088	void (*suspend)(void *priv);
2089
2090	/**
2091	 * resume - Notification on system resume/thaw event
2092	 * @priv: Private driver interface data
2093	 */
2094	void (*resume)(void *priv);
2095
2096	/**
2097	 * signal_monitor - Set signal monitoring parameters
2098	 * @priv: Private driver interface data
2099	 * @threshold: Threshold value for signal change events; 0 = disabled
2100	 * @hysteresis: Minimum change in signal strength before indicating a
2101	 *	new event
2102	 * Returns: 0 on success, -1 on failure (or if not supported)
2103	 *
2104	 * This function can be used to configure monitoring of signal strength
2105	 * with the current AP. Whenever signal strength drops below the
2106	 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2107	 * should be generated assuming the signal strength has changed at
2108	 * least %hysteresis from the previously indicated signal change event.
2109	 */
2110	int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2111
2112	/**
2113	 * send_frame - Send IEEE 802.11 frame (testing use only)
2114	 * @priv: Private driver interface data
2115	 * @data: IEEE 802.11 frame with IEEE 802.11 header
2116	 * @data_len: Size of the frame
2117	 * @encrypt: Whether to encrypt the frame (if keys are set)
2118	 * Returns: 0 on success, -1 on failure
2119	 *
2120	 * This function is only used for debugging purposes and is not
2121	 * required to be implemented for normal operations.
2122	 */
2123	int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2124			  int encrypt);
2125
2126	/**
2127	 * shared_freq - Get operating frequency of shared interface(s)
2128	 * @priv: Private driver interface data
2129	 * Returns: Operating frequency in MHz, 0 if no shared operation in
2130	 * use, or -1 on failure
2131	 *
2132	 * This command can be used to request the current operating frequency
2133	 * of any virtual interface that shares the same radio to provide
2134	 * information for channel selection for other virtual interfaces.
2135	 */
2136	int (*shared_freq)(void *priv);
2137
2138	/**
2139	 * get_noa - Get current Notice of Absence attribute payload
2140	 * @priv: Private driver interface data
2141	 * @buf: Buffer for returning NoA
2142	 * @buf_len: Buffer length in octets
2143	 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2144	 * advertized, or -1 on failure
2145	 *
2146	 * This function is used to fetch the current Notice of Absence
2147	 * attribute value from GO.
2148	 */
2149	int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2150
2151	/**
2152	 * set_noa - Set Notice of Absence parameters for GO (testing)
2153	 * @priv: Private driver interface data
2154	 * @count: Count
2155	 * @start: Start time in ms from next TBTT
2156	 * @duration: Duration in ms
2157	 * Returns: 0 on success or -1 on failure
2158	 *
2159	 * This function is used to set Notice of Absence parameters for GO. It
2160	 * is used only for testing. To disable NoA, all parameters are set to
2161	 * 0.
2162	 */
2163	int (*set_noa)(void *priv, u8 count, int start, int duration);
2164
2165	/**
2166	 * set_p2p_powersave - Set P2P power save options
2167	 * @priv: Private driver interface data
2168	 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2169	 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2170	 * @ctwindow: 0.. = change (msec), -1 = no change
2171	 * Returns: 0 on success or -1 on failure
2172	 */
2173	int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2174				 int ctwindow);
2175
2176	/**
2177	 * ampdu - Enable/disable aggregation
2178	 * @priv: Private driver interface data
2179	 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2180	 * Returns: 0 on success or -1 on failure
2181	 */
2182	int (*ampdu)(void *priv, int ampdu);
2183
2184	/**
2185	 * get_radio_name - Get physical radio name for the device
2186	 * @priv: Private driver interface data
2187	 * Returns: Radio name or %NULL if not known
2188	 *
2189	 * The returned data must not be modified by the caller. It is assumed
2190	 * that any interface that has the same radio name as another is
2191	 * sharing the same physical radio. This information can be used to
2192	 * share scan results etc. information between the virtual interfaces
2193	 * to speed up various operations.
2194	 */
2195	const char * (*get_radio_name)(void *priv);
2196
2197	/**
2198	 * p2p_find - Start P2P Device Discovery
2199	 * @priv: Private driver interface data
2200	 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2201	 * @type: Device Discovery type (enum p2p_discovery_type)
2202	 * Returns: 0 on success, -1 on failure
2203	 *
2204	 * This function is only used if the driver implements P2P management,
2205	 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2206	 * struct wpa_driver_capa.
2207	 */
2208	int (*p2p_find)(void *priv, unsigned int timeout, int type);
2209
2210	/**
2211	 * p2p_stop_find - Stop P2P Device Discovery
2212	 * @priv: Private driver interface data
2213	 * Returns: 0 on success, -1 on failure
2214	 *
2215	 * This function is only used if the driver implements P2P management,
2216	 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2217	 * struct wpa_driver_capa.
2218	 */
2219	int (*p2p_stop_find)(void *priv);
2220
2221	/**
2222	 * p2p_listen - Start P2P Listen state for specified duration
2223	 * @priv: Private driver interface data
2224	 * @timeout: Listen state duration in milliseconds
2225	 * Returns: 0 on success, -1 on failure
2226	 *
2227	 * This function can be used to request the P2P module to keep the
2228	 * device discoverable on the listen channel for an extended set of
2229	 * time. At least in its current form, this is mainly used for testing
2230	 * purposes and may not be of much use for normal P2P operations.
2231	 *
2232	 * This function is only used if the driver implements P2P management,
2233	 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2234	 * struct wpa_driver_capa.
2235	 */
2236	int (*p2p_listen)(void *priv, unsigned int timeout);
2237
2238	/**
2239	 * p2p_connect - Start P2P group formation (GO negotiation)
2240	 * @priv: Private driver interface data
2241	 * @peer_addr: MAC address of the peer P2P client
2242	 * @wps_method: enum p2p_wps_method value indicating config method
2243	 * @go_intent: Local GO intent value (1..15)
2244	 * @own_interface_addr: Intended interface address to use with the
2245	 *	group
2246	 * @force_freq: The only allowed channel frequency in MHz or 0
2247	 * @persistent_group: Whether to create persistent group
2248	 * Returns: 0 on success, -1 on failure
2249	 *
2250	 * This function is only used if the driver implements P2P management,
2251	 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2252	 * struct wpa_driver_capa.
2253	 */
2254	int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method,
2255			   int go_intent, const u8 *own_interface_addr,
2256			   unsigned int force_freq, int persistent_group);
2257
2258	/**
2259	 * wps_success_cb - Report successfully completed WPS provisioning
2260	 * @priv: Private driver interface data
2261	 * @peer_addr: Peer address
2262	 * Returns: 0 on success, -1 on failure
2263	 *
2264	 * This function is used to report successfully completed WPS
2265	 * provisioning during group formation in both GO/Registrar and
2266	 * client/Enrollee roles.
2267	 *
2268	 * This function is only used if the driver implements P2P management,
2269	 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2270	 * struct wpa_driver_capa.
2271	 */
2272	int (*wps_success_cb)(void *priv, const u8 *peer_addr);
2273
2274	/**
2275	 * p2p_group_formation_failed - Report failed WPS provisioning
2276	 * @priv: Private driver interface data
2277	 * Returns: 0 on success, -1 on failure
2278	 *
2279	 * This function is used to report failed group formation. This can
2280	 * happen either due to failed WPS provisioning or due to 15 second
2281	 * timeout during the provisioning phase.
2282	 *
2283	 * This function is only used if the driver implements P2P management,
2284	 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2285	 * struct wpa_driver_capa.
2286	 */
2287	int (*p2p_group_formation_failed)(void *priv);
2288
2289	/**
2290	 * p2p_set_params - Set P2P parameters
2291	 * @priv: Private driver interface data
2292	 * @params: P2P parameters
2293	 * Returns: 0 on success, -1 on failure
2294	 *
2295	 * This function is only used if the driver implements P2P management,
2296	 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2297	 * struct wpa_driver_capa.
2298	 */
2299	int (*p2p_set_params)(void *priv, const struct p2p_params *params);
2300
2301	/**
2302	 * p2p_prov_disc_req - Send Provision Discovery Request
2303	 * @priv: Private driver interface data
2304	 * @peer_addr: MAC address of the peer P2P client
2305	 * @config_methods: WPS Config Methods value (only one bit set)
2306	 * Returns: 0 on success, -1 on failure
2307	 *
2308	 * This function can be used to request a discovered P2P peer to
2309	 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2310	 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2311	 * Provision Discovery Request frame is transmitted once immediately
2312	 * and if no response is received, the frame will be sent again
2313	 * whenever the target device is discovered during device dsicovery
2314	 * (start with a p2p_find() call). Response from the peer is indicated
2315	 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
2316	 *
2317	 * This function is only used if the driver implements P2P management,
2318	 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2319	 * struct wpa_driver_capa.
2320	 */
2321	int (*p2p_prov_disc_req)(void *priv, const u8 *peer_addr,
2322				 u16 config_methods, int join);
2323
2324	/**
2325	 * p2p_sd_request - Schedule a service discovery query
2326	 * @priv: Private driver interface data
2327	 * @dst: Destination peer or %NULL to apply for all peers
2328	 * @tlvs: P2P Service Query TLV(s)
2329	 * Returns: Reference to the query or 0 on failure
2330	 *
2331	 * Response to the query is indicated with the
2332	 * EVENT_P2P_SD_RESPONSE driver event.
2333	 *
2334	 * This function is only used if the driver implements P2P management,
2335	 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2336	 * struct wpa_driver_capa.
2337	 */
2338	u64 (*p2p_sd_request)(void *priv, const u8 *dst,
2339			      const struct wpabuf *tlvs);
2340
2341	/**
2342	 * p2p_sd_cancel_request - Cancel a pending service discovery query
2343	 * @priv: Private driver interface data
2344	 * @req: Query reference from p2p_sd_request()
2345	 * Returns: 0 on success, -1 on failure
2346	 *
2347	 * This function is only used if the driver implements P2P management,
2348	 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2349	 * struct wpa_driver_capa.
2350	 */
2351	int (*p2p_sd_cancel_request)(void *priv, u64 req);
2352
2353	/**
2354	 * p2p_sd_response - Send response to a service discovery query
2355	 * @priv: Private driver interface data
2356	 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2357	 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2358	 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2359	 * @resp_tlvs: P2P Service Response TLV(s)
2360	 * Returns: 0 on success, -1 on failure
2361	 *
2362	 * This function is called as a response to the request indicated with
2363	 * the EVENT_P2P_SD_REQUEST driver event.
2364	 *
2365	 * This function is only used if the driver implements P2P management,
2366	 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2367	 * struct wpa_driver_capa.
2368	 */
2369	int (*p2p_sd_response)(void *priv, int freq, const u8 *dst,
2370			       u8 dialog_token,
2371			       const struct wpabuf *resp_tlvs);
2372
2373	/**
2374	 * p2p_service_update - Indicate a change in local services
2375	 * @priv: Private driver interface data
2376	 * Returns: 0 on success, -1 on failure
2377	 *
2378	 * This function needs to be called whenever there is a change in
2379	 * availability of the local services. This will increment the
2380	 * Service Update Indicator value which will be used in SD Request and
2381	 * Response frames.
2382	 *
2383	 * This function is only used if the driver implements P2P management,
2384	 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2385	 * struct wpa_driver_capa.
2386	 */
2387	int (*p2p_service_update)(void *priv);
2388
2389	/**
2390	 * p2p_reject - Reject peer device (explicitly block connections)
2391	 * @priv: Private driver interface data
2392	 * @addr: MAC address of the peer
2393	 * Returns: 0 on success, -1 on failure
2394	 */
2395	int (*p2p_reject)(void *priv, const u8 *addr);
2396
2397	/**
2398	 * p2p_invite - Invite a P2P Device into a group
2399	 * @priv: Private driver interface data
2400	 * @peer: Device Address of the peer P2P Device
2401	 * @role: Local role in the group
2402	 * @bssid: Group BSSID or %NULL if not known
2403	 * @ssid: Group SSID
2404	 * @ssid_len: Length of ssid in octets
2405	 * @go_dev_addr: Forced GO Device Address or %NULL if none
2406	 * @persistent_group: Whether this is to reinvoke a persistent group
2407	 * Returns: 0 on success, -1 on failure
2408	 */
2409	int (*p2p_invite)(void *priv, const u8 *peer, int role,
2410			  const u8 *bssid, const u8 *ssid, size_t ssid_len,
2411			  const u8 *go_dev_addr, int persistent_group);
2412
2413	/**
2414	 * send_tdls_mgmt - for sending TDLS management packets
2415	 * @priv: private driver interface data
2416	 * @dst: Destination (peer) MAC address
2417	 * @action_code: TDLS action code for the mssage
2418	 * @dialog_token: Dialog Token to use in the message (if needed)
2419	 * @status_code: Status Code or Reason Code to use (if needed)
2420	 * @buf: TDLS IEs to add to the message
2421	 * @len: Length of buf in octets
2422	 * Returns: 0 on success, negative (<0) on failure
2423	 *
2424	 * This optional function can be used to send packet to driver which is
2425	 * responsible for receiving and sending all TDLS packets.
2426	 */
2427	int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2428			      u8 dialog_token, u16 status_code,
2429			      const u8 *buf, size_t len);
2430
2431	/**
2432	 * tdls_oper - Ask the driver to perform high-level TDLS operations
2433	 * @priv: Private driver interface data
2434	 * @oper: TDLS high-level operation. See %enum tdls_oper
2435	 * @peer: Destination (peer) MAC address
2436	 * Returns: 0 on success, negative (<0) on failure
2437	 *
2438	 * This optional function can be used to send high-level TDLS commands
2439	 * to the driver.
2440	 */
2441	int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2442
2443	/**
2444	 * wnm_oper - Notify driver of the WNM frame reception
2445	 * @priv: Private driver interface data
2446	 * @oper: WNM operation. See %enum wnm_oper
2447	 * @peer: Destination (peer) MAC address
2448	 * @buf: Buffer for the driver to fill in (for getting IE)
2449	 * @buf_len: Return the len of buf
2450	 * Returns: 0 on success, negative (<0) on failure
2451	 */
2452	int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2453			u8 *buf, u16 *buf_len);
2454
2455	/**
2456	 * signal_poll - Get current connection information
2457	 * @priv: Private driver interface data
2458	 * @signal_info: Connection info structure
2459         */
2460	int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2461
2462	/**
2463	 * set_authmode - Set authentication algorithm(s) for static WEP
2464	 * @priv: Private driver interface data
2465	 * @authmode: 1=Open System, 2=Shared Key, 3=both
2466	 * Returns: 0 on success, -1 on failure
2467	 *
2468	 * This function can be used to set authentication algorithms for AP
2469	 * mode when static WEP is used. If the driver uses user space MLME/SME
2470	 * implementation, there is no need to implement this function.
2471	 *
2472	 * DEPRECATED - use set_ap() instead
2473	 */
2474	int (*set_authmode)(void *priv, int authmode);
2475#ifdef ANDROID
2476	/**
2477	 * driver_cmd - execute driver-specific command
2478	 * @priv: private driver interface data
2479	 * @cmd: command to execute
2480	 * @buf: return buffer
2481	 * @buf_len: buffer length
2482	 *
2483	 * Returns: 0 on success, -1 on failure
2484	 */
2485	 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2486#endif
2487	/**
2488	 * set_rekey_info - Set rekey information
2489	 * @priv: Private driver interface data
2490	 * @kek: Current KEK
2491	 * @kck: Current KCK
2492	 * @replay_ctr: Current EAPOL-Key Replay Counter
2493	 *
2494	 * This optional function can be used to provide information for the
2495	 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2496	 * while the host (including wpa_supplicant) is sleeping.
2497	 */
2498	void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2499			       const u8 *replay_ctr);
2500
2501	/**
2502	 * sta_assoc - Station association indication
2503	 * @priv: Private driver interface data
2504	 * @own_addr: Source address and BSSID for association frame
2505	 * @addr: MAC address of the station to associate
2506	 * @reassoc: flag to indicate re-association
2507	 * @status: association response status code
2508	 * @ie: assoc response ie buffer
2509	 * @len: ie buffer length
2510	 * Returns: 0 on success, -1 on failure
2511	 *
2512	 * This function indicates the driver to send (Re)Association
2513	 * Response frame to the station.
2514	 */
2515	 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2516			  int reassoc, u16 status, const u8 *ie, size_t len);
2517
2518	/**
2519	 * sta_auth - Station authentication indication
2520	 * @priv: Private driver interface data
2521	 * @own_addr: Source address and BSSID for authentication frame
2522	 * @addr: MAC address of the station to associate
2523	 * @seq: authentication sequence number
2524	 * @status: authentication response status code
2525	 * @ie: authentication frame ie buffer
2526	 * @len: ie buffer length
2527	 *
2528	 * This function indicates the driver to send Authentication frame
2529	 * to the station.
2530	 */
2531	 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2532			 u16 seq, u16 status, const u8 *ie, size_t len);
2533
2534	/**
2535	 * add_tspec - Add traffic stream
2536	 * @priv: Private driver interface data
2537	 * @addr: MAC address of the station to associate
2538	 * @tspec_ie: tspec ie buffer
2539	 * @tspec_ielen: tspec ie length
2540	 * Returns: 0 on success, -1 on failure
2541	 *
2542	 * This function adds the traffic steam for the station
2543	 * and fills the medium_time in tspec_ie.
2544	 */
2545	 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2546			  size_t tspec_ielen);
2547
2548	/**
2549	 * add_sta_node - Add a station node in the driver
2550	 * @priv: Private driver interface data
2551	 * @addr: MAC address of the station to add
2552	 * @auth_alg: authentication algorithm used by the station
2553	 * Returns: 0 on success, -1 on failure
2554	 *
2555	 * This function adds the station node in the driver, when
2556	 * the station gets added by FT-over-DS.
2557	 */
2558	int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2559
2560	/**
2561	 * sched_scan - Request the driver to initiate scheduled scan
2562	 * @priv: Private driver interface data
2563	 * @params: Scan parameters
2564	 * @interval: Interval between scan cycles in milliseconds
2565	 * Returns: 0 on success, -1 on failure
2566	 *
2567	 * This operation should be used for scheduled scan offload to
2568	 * the hardware. Every time scan results are available, the
2569	 * driver should report scan results event for wpa_supplicant
2570	 * which will eventually request the results with
2571	 * wpa_driver_get_scan_results2(). This operation is optional
2572	 * and if not provided or if it returns -1, we fall back to
2573	 * normal host-scheduled scans.
2574	 */
2575	int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2576			  u32 interval);
2577
2578	/**
2579	 * stop_sched_scan - Request the driver to stop a scheduled scan
2580	 * @priv: Private driver interface data
2581	 * Returns: 0 on success, -1 on failure
2582	 *
2583	 * This should cause the scheduled scan to be stopped and
2584	 * results should stop being sent. Must be supported if
2585	 * sched_scan is supported.
2586	 */
2587	int (*stop_sched_scan)(void *priv);
2588
2589	/**
2590	 * poll_client - Probe (null data or such) the given station
2591	 * @priv: Private driver interface data
2592	 * @own_addr: MAC address of sending interface
2593	 * @addr: MAC address of the station to probe
2594	 * @qos: Indicates whether station is QoS station
2595	 *
2596	 * This function is used to verify whether an associated station is
2597	 * still present. This function does not need to be implemented if the
2598	 * driver provides such inactivity polling mechanism.
2599	 */
2600	void (*poll_client)(void *priv, const u8 *own_addr,
2601			    const u8 *addr, int qos);
2602
2603	/**
2604	 * radio_disable - Disable/enable radio
2605	 * @priv: Private driver interface data
2606	 * @disabled: 1=disable 0=enable radio
2607	 * Returns: 0 on success, -1 on failure
2608	 *
2609	 * This optional command is for testing purposes. It can be used to
2610	 * disable the radio on a testbed device to simulate out-of-radio-range
2611	 * conditions.
2612	 */
2613	int (*radio_disable)(void *priv, int disabled);
2614
2615	/**
2616	 * switch_channel - Announce channel switch and migrate the GO to the
2617	 * given frequency
2618	 * @priv: Private driver interface data
2619	 * @freq: Frequency in MHz
2620	 * Returns: 0 on success, -1 on failure
2621	 *
2622	 * This function is used to move the GO to the legacy STA channel to
2623	 * avoid frequency conflict in single channel concurrency.
2624	 */
2625	int (*switch_channel)(void *priv, unsigned int freq);
2626};
2627
2628
2629/**
2630 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2631 */
2632enum wpa_event_type {
2633	/**
2634	 * EVENT_ASSOC - Association completed
2635	 *
2636	 * This event needs to be delivered when the driver completes IEEE
2637	 * 802.11 association or reassociation successfully.
2638	 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2639	 * after this event has been generated. In addition, optional
2640	 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2641	 * more information about the association. If the driver interface gets
2642	 * both of these events at the same time, it can also include the
2643	 * assoc_info data in EVENT_ASSOC call.
2644	 */
2645	EVENT_ASSOC,
2646
2647	/**
2648	 * EVENT_DISASSOC - Association lost
2649	 *
2650	 * This event should be called when association is lost either due to
2651	 * receiving deauthenticate or disassociate frame from the AP or when
2652	 * sending either of these frames to the current AP. If the driver
2653	 * supports separate deauthentication event, EVENT_DISASSOC should only
2654	 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2655	 * In AP mode, union wpa_event_data::disassoc_info is required.
2656	 */
2657	EVENT_DISASSOC,
2658
2659	/**
2660	 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2661	 *
2662	 * This event must be delivered when a Michael MIC error is detected by
2663	 * the local driver. Additional data for event processing is
2664	 * provided with union wpa_event_data::michael_mic_failure. This
2665	 * information is used to request new encyption key and to initiate
2666	 * TKIP countermeasures if needed.
2667	 */
2668	EVENT_MICHAEL_MIC_FAILURE,
2669
2670	/**
2671	 * EVENT_SCAN_RESULTS - Scan results available
2672	 *
2673	 * This event must be called whenever scan results are available to be
2674	 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2675	 * is expected to be used some time after struct wpa_driver_ops::scan()
2676	 * is called. If the driver provides an unsolicited event when the scan
2677	 * has been completed, this event can be used to trigger
2678	 * EVENT_SCAN_RESULTS call. If such event is not available from the
2679	 * driver, the driver wrapper code is expected to use a registered
2680	 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2681	 * scan is expected to be completed. Optional information about
2682	 * completed scan can be provided with union wpa_event_data::scan_info.
2683	 */
2684	EVENT_SCAN_RESULTS,
2685
2686	/**
2687	 * EVENT_ASSOCINFO - Report optional extra information for association
2688	 *
2689	 * This event can be used to report extra association information for
2690	 * EVENT_ASSOC processing. This extra information includes IEs from
2691	 * association frames and Beacon/Probe Response frames in union
2692	 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2693	 * EVENT_ASSOC. Alternatively, the driver interface can include
2694	 * assoc_info data in the EVENT_ASSOC call if it has all the
2695	 * information available at the same point.
2696	 */
2697	EVENT_ASSOCINFO,
2698
2699	/**
2700	 * EVENT_INTERFACE_STATUS - Report interface status changes
2701	 *
2702	 * This optional event can be used to report changes in interface
2703	 * status (interface added/removed) using union
2704	 * wpa_event_data::interface_status. This can be used to trigger
2705	 * wpa_supplicant to stop and re-start processing for the interface,
2706	 * e.g., when a cardbus card is ejected/inserted.
2707	 */
2708	EVENT_INTERFACE_STATUS,
2709
2710	/**
2711	 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2712	 *
2713	 * This event can be used to inform wpa_supplicant about candidates for
2714	 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2715	 * for scan request (ap_scan=2 mode), this event is required for
2716	 * pre-authentication. If wpa_supplicant is performing scan request
2717	 * (ap_scan=1), this event is optional since scan results can be used
2718	 * to add pre-authentication candidates. union
2719	 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2720	 * candidate and priority of the candidate, e.g., based on the signal
2721	 * strength, in order to try to pre-authenticate first with candidates
2722	 * that are most likely targets for re-association.
2723	 *
2724	 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2725	 * on the candidate list. In addition, it can be called for the current
2726	 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2727	 * will automatically skip pre-authentication in cases where a valid
2728	 * PMKSA exists. When more than one candidate exists, this event should
2729	 * be generated once for each candidate.
2730	 *
2731	 * Driver will be notified about successful pre-authentication with
2732	 * struct wpa_driver_ops::add_pmkid() calls.
2733	 */
2734	EVENT_PMKID_CANDIDATE,
2735
2736	/**
2737	 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2738	 *
2739	 * This event can be used to inform wpa_supplicant about desire to set
2740	 * up secure direct link connection between two stations as defined in
2741	 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2742	 * STAKey negotiation. The caller will need to set peer address for the
2743	 * event.
2744	 */
2745	EVENT_STKSTART,
2746
2747	/**
2748	 * EVENT_TDLS - Request TDLS operation
2749	 *
2750	 * This event can be used to request a TDLS operation to be performed.
2751	 */
2752	EVENT_TDLS,
2753
2754	/**
2755	 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2756	 *
2757	 * The driver is expected to report the received FT IEs from
2758	 * FT authentication sequence from the AP. The FT IEs are included in
2759	 * the extra information in union wpa_event_data::ft_ies.
2760	 */
2761	EVENT_FT_RESPONSE,
2762
2763	/**
2764	 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2765	 *
2766	 * The driver can use this event to inform wpa_supplicant about a STA
2767	 * in an IBSS with which protected frames could be exchanged. This
2768	 * event starts RSN authentication with the other STA to authenticate
2769	 * the STA and set up encryption keys with it.
2770	 */
2771	EVENT_IBSS_RSN_START,
2772
2773	/**
2774	 * EVENT_AUTH - Authentication result
2775	 *
2776	 * This event should be called when authentication attempt has been
2777	 * completed. This is only used if the driver supports separate
2778	 * authentication step (struct wpa_driver_ops::authenticate).
2779	 * Information about authentication result is included in
2780	 * union wpa_event_data::auth.
2781	 */
2782	EVENT_AUTH,
2783
2784	/**
2785	 * EVENT_DEAUTH - Authentication lost
2786	 *
2787	 * This event should be called when authentication is lost either due
2788	 * to receiving deauthenticate frame from the AP or when sending that
2789	 * frame to the current AP.
2790	 * In AP mode, union wpa_event_data::deauth_info is required.
2791	 */
2792	EVENT_DEAUTH,
2793
2794	/**
2795	 * EVENT_ASSOC_REJECT - Association rejected
2796	 *
2797	 * This event should be called when (re)association attempt has been
2798	 * rejected by the AP. Information about the association response is
2799	 * included in union wpa_event_data::assoc_reject.
2800	 */
2801	EVENT_ASSOC_REJECT,
2802
2803	/**
2804	 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2805	 */
2806	EVENT_AUTH_TIMED_OUT,
2807
2808	/**
2809	 * EVENT_ASSOC_TIMED_OUT - Association timed out
2810	 */
2811	EVENT_ASSOC_TIMED_OUT,
2812
2813	/**
2814	 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2815	 */
2816	EVENT_FT_RRB_RX,
2817
2818	/**
2819	 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2820	 */
2821	EVENT_WPS_BUTTON_PUSHED,
2822
2823	/**
2824	 * EVENT_TX_STATUS - Report TX status
2825	 */
2826	EVENT_TX_STATUS,
2827
2828	/**
2829	 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2830	 */
2831	EVENT_RX_FROM_UNKNOWN,
2832
2833	/**
2834	 * EVENT_RX_MGMT - Report RX of a management frame
2835	 */
2836	EVENT_RX_MGMT,
2837
2838	/**
2839	 * EVENT_RX_ACTION - Action frame received
2840	 *
2841	 * This event is used to indicate when an Action frame has been
2842	 * received. Information about the received frame is included in
2843	 * union wpa_event_data::rx_action.
2844	 */
2845	EVENT_RX_ACTION,
2846
2847	/**
2848	 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2849	 *
2850	 * This event is used to indicate when the driver has started the
2851	 * requested remain-on-channel duration. Information about the
2852	 * operation is included in union wpa_event_data::remain_on_channel.
2853	 */
2854	EVENT_REMAIN_ON_CHANNEL,
2855
2856	/**
2857	 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2858	 *
2859	 * This event is used to indicate when the driver has completed
2860	 * remain-on-channel duration, i.e., may noot be available on the
2861	 * requested channel anymore. Information about the
2862	 * operation is included in union wpa_event_data::remain_on_channel.
2863	 */
2864	EVENT_CANCEL_REMAIN_ON_CHANNEL,
2865
2866	/**
2867	 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2868	 *
2869	 * This event is used only by driver_test.c and userspace MLME.
2870	 */
2871	EVENT_MLME_RX,
2872
2873	/**
2874	 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2875	 *
2876	 * This event is used to indicate when a Probe Request frame has been
2877	 * received. Information about the received frame is included in
2878	 * union wpa_event_data::rx_probe_req. The driver is required to report
2879	 * these events only after successfully completed probe_req_report()
2880	 * commands to request the events (i.e., report parameter is non-zero)
2881	 * in station mode. In AP mode, Probe Request frames should always be
2882	 * reported.
2883	 */
2884	EVENT_RX_PROBE_REQ,
2885
2886	/**
2887	 * EVENT_NEW_STA - New wired device noticed
2888	 *
2889	 * This event is used to indicate that a new device has been detected
2890	 * in a network that does not use association-like functionality (i.e.,
2891	 * mainly wired Ethernet). This can be used to start EAPOL
2892	 * authenticator when receiving a frame from a device. The address of
2893	 * the device is included in union wpa_event_data::new_sta.
2894	 */
2895	EVENT_NEW_STA,
2896
2897	/**
2898	 * EVENT_EAPOL_RX - Report received EAPOL frame
2899	 *
2900	 * When in AP mode with hostapd, this event is required to be used to
2901	 * deliver the receive EAPOL frames from the driver. With
2902	 * %wpa_supplicant, this event is used only if the send_eapol() handler
2903	 * is used to override the use of l2_packet for EAPOL frame TX.
2904	 */
2905	EVENT_EAPOL_RX,
2906
2907	/**
2908	 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
2909	 *
2910	 * This event is used to indicate changes in the signal strength
2911	 * observed in frames received from the current AP if signal strength
2912	 * monitoring has been enabled with signal_monitor().
2913	 */
2914	EVENT_SIGNAL_CHANGE,
2915
2916	/**
2917	 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
2918	 *
2919	 * This event is used to indicate that the interface was enabled after
2920	 * having been previously disabled, e.g., due to rfkill.
2921	 */
2922	EVENT_INTERFACE_ENABLED,
2923
2924	/**
2925	 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
2926	 *
2927	 * This event is used to indicate that the interface was disabled,
2928	 * e.g., due to rfkill.
2929	 */
2930	EVENT_INTERFACE_DISABLED,
2931
2932	/**
2933	 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
2934	 *
2935	 * This event is used to indicate that the channel list has changed,
2936	 * e.g., because of a regulatory domain change triggered by scan
2937	 * results including an AP advertising a country code.
2938	 */
2939	EVENT_CHANNEL_LIST_CHANGED,
2940
2941	/**
2942	 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
2943	 *
2944	 * This event is used to indicate that the driver cannot maintain this
2945	 * interface in its operation mode anymore. The most likely use for
2946	 * this is to indicate that AP mode operation is not available due to
2947	 * operating channel would need to be changed to a DFS channel when
2948	 * the driver does not support radar detection and another virtual
2949	 * interfaces caused the operating channel to change. Other similar
2950	 * resource conflicts could also trigger this for station mode
2951	 * interfaces.
2952	 */
2953	EVENT_INTERFACE_UNAVAILABLE,
2954
2955	/**
2956	 * EVENT_BEST_CHANNEL
2957	 *
2958	 * Driver generates this event whenever it detects a better channel
2959	 * (e.g., based on RSSI or channel use). This information can be used
2960	 * to improve channel selection for a new AP/P2P group.
2961	 */
2962	EVENT_BEST_CHANNEL,
2963
2964	/**
2965	 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
2966	 *
2967	 * This event should be called when a Deauthentication frame is dropped
2968	 * due to it not being protected (MFP/IEEE 802.11w).
2969	 * union wpa_event_data::unprot_deauth is required to provide more
2970	 * details of the frame.
2971	 */
2972	EVENT_UNPROT_DEAUTH,
2973
2974	/**
2975	 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
2976	 *
2977	 * This event should be called when a Disassociation frame is dropped
2978	 * due to it not being protected (MFP/IEEE 802.11w).
2979	 * union wpa_event_data::unprot_disassoc is required to provide more
2980	 * details of the frame.
2981	 */
2982	EVENT_UNPROT_DISASSOC,
2983
2984	/**
2985	 * EVENT_STATION_LOW_ACK
2986	 *
2987	 * Driver generates this event whenever it detected that a particular
2988	 * station was lost. Detection can be through massive transmission
2989	 * failures for example.
2990	 */
2991	EVENT_STATION_LOW_ACK,
2992
2993	/**
2994	 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
2995	 *
2996	 * This event is used only if the driver implements P2P management
2997	 * internally. Event data is stored in
2998	 * union wpa_event_data::p2p_dev_found.
2999	 */
3000	EVENT_P2P_DEV_FOUND,
3001
3002	/**
3003	 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
3004	 *
3005	 * This event is used only if the driver implements P2P management
3006	 * internally. Event data is stored in
3007	 * union wpa_event_data::p2p_go_neg_req_rx.
3008	 */
3009	EVENT_P2P_GO_NEG_REQ_RX,
3010
3011	/**
3012	 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
3013	 *
3014	 * This event is used only if the driver implements P2P management
3015	 * internally. Event data is stored in
3016	 * union wpa_event_data::p2p_go_neg_completed.
3017	 */
3018	EVENT_P2P_GO_NEG_COMPLETED,
3019
3020	EVENT_P2P_PROV_DISC_REQUEST,
3021	EVENT_P2P_PROV_DISC_RESPONSE,
3022	EVENT_P2P_SD_REQUEST,
3023	EVENT_P2P_SD_RESPONSE,
3024
3025	/**
3026	 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3027	 */
3028	EVENT_IBSS_PEER_LOST,
3029
3030	/**
3031	 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3032	 *
3033	 * This event carries the new replay counter to notify wpa_supplicant
3034	 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3035	 * completed Group Key Handshake while the host (including
3036	 * wpa_supplicant was sleeping).
3037	 */
3038	EVENT_DRIVER_GTK_REKEY,
3039
3040	/**
3041	 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3042	 */
3043	EVENT_SCHED_SCAN_STOPPED,
3044
3045	/**
3046	 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3047	 *
3048	 * This event indicates that the station responded to the poll
3049	 * initiated with @poll_client.
3050	 */
3051	EVENT_DRIVER_CLIENT_POLL_OK,
3052
3053	/**
3054	 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3055	 */
3056	EVENT_EAPOL_TX_STATUS,
3057
3058	/**
3059	 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3060	 *
3061	 * Described in wpa_event_data.ch_switch
3062	 * */
3063	EVENT_CH_SWITCH,
3064
3065	/**
3066	 * EVENT_WNM - Request WNM operation
3067	 *
3068	 * This event can be used to request a WNM operation to be performed.
3069	 */
3070	EVENT_WNM
3071};
3072
3073
3074/**
3075 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3076 */
3077union wpa_event_data {
3078	/**
3079	 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3080	 *
3081	 * This structure is optional for EVENT_ASSOC calls and required for
3082	 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3083	 * driver interface does not need to generate separate EVENT_ASSOCINFO
3084	 * calls.
3085	 */
3086	struct assoc_info {
3087		/**
3088		 * reassoc - Flag to indicate association or reassociation
3089		 */
3090		int reassoc;
3091
3092		/**
3093		 * req_ies - (Re)Association Request IEs
3094		 *
3095		 * If the driver generates WPA/RSN IE, this event data must be
3096		 * returned for WPA handshake to have needed information. If
3097		 * wpa_supplicant-generated WPA/RSN IE is used, this
3098		 * information event is optional.
3099		 *
3100		 * This should start with the first IE (fixed fields before IEs
3101		 * are not included).
3102		 */
3103		const u8 *req_ies;
3104
3105		/**
3106		 * req_ies_len - Length of req_ies in bytes
3107		 */
3108		size_t req_ies_len;
3109
3110		/**
3111		 * resp_ies - (Re)Association Response IEs
3112		 *
3113		 * Optional association data from the driver. This data is not
3114		 * required WPA, but may be useful for some protocols and as
3115		 * such, should be reported if this is available to the driver
3116		 * interface.
3117		 *
3118		 * This should start with the first IE (fixed fields before IEs
3119		 * are not included).
3120		 */
3121		const u8 *resp_ies;
3122
3123		/**
3124		 * resp_ies_len - Length of resp_ies in bytes
3125		 */
3126		size_t resp_ies_len;
3127
3128		/**
3129		 * beacon_ies - Beacon or Probe Response IEs
3130		 *
3131		 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3132		 * Probe Response frames from the current AP (i.e., the one
3133		 * that the client just associated with). This information is
3134		 * used to update WPA/RSN IE for the AP. If this field is not
3135		 * set, the results from previous scan will be used. If no
3136		 * data for the new AP is found, scan results will be requested
3137		 * again (without scan request). At this point, the driver is
3138		 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3139		 * used).
3140		 *
3141		 * This should start with the first IE (fixed fields before IEs
3142		 * are not included).
3143		 */
3144		const u8 *beacon_ies;
3145
3146		/**
3147		 * beacon_ies_len - Length of beacon_ies */
3148		size_t beacon_ies_len;
3149
3150		/**
3151		 * freq - Frequency of the operational channel in MHz
3152		 */
3153		unsigned int freq;
3154
3155		/**
3156		 * addr - Station address (for AP mode)
3157		 */
3158		const u8 *addr;
3159	} assoc_info;
3160
3161	/**
3162	 * struct disassoc_info - Data for EVENT_DISASSOC events
3163	 */
3164	struct disassoc_info {
3165		/**
3166		 * addr - Station address (for AP mode)
3167		 */
3168		const u8 *addr;
3169
3170		/**
3171		 * reason_code - Reason Code (host byte order) used in
3172		 *	Deauthentication frame
3173		 */
3174		u16 reason_code;
3175
3176		/**
3177		 * ie - Optional IE(s) in Disassociation frame
3178		 */
3179		const u8 *ie;
3180
3181		/**
3182		 * ie_len - Length of ie buffer in octets
3183		 */
3184		size_t ie_len;
3185
3186		/**
3187		 * locally_generated - Whether the frame was locally generated
3188		 */
3189		int locally_generated;
3190	} disassoc_info;
3191
3192	/**
3193	 * struct deauth_info - Data for EVENT_DEAUTH events
3194	 */
3195	struct deauth_info {
3196		/**
3197		 * addr - Station address (for AP mode)
3198		 */
3199		const u8 *addr;
3200
3201		/**
3202		 * reason_code - Reason Code (host byte order) used in
3203		 *	Deauthentication frame
3204		 */
3205		u16 reason_code;
3206
3207		/**
3208		 * ie - Optional IE(s) in Deauthentication frame
3209		 */
3210		const u8 *ie;
3211
3212		/**
3213		 * ie_len - Length of ie buffer in octets
3214		 */
3215		size_t ie_len;
3216
3217		/**
3218		 * locally_generated - Whether the frame was locally generated
3219		 */
3220		int locally_generated;
3221	} deauth_info;
3222
3223	/**
3224	 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3225	 */
3226	struct michael_mic_failure {
3227		int unicast;
3228		const u8 *src;
3229	} michael_mic_failure;
3230
3231	/**
3232	 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3233	 */
3234	struct interface_status {
3235		char ifname[100];
3236		enum {
3237			EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3238		} ievent;
3239	} interface_status;
3240
3241	/**
3242	 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3243	 */
3244	struct pmkid_candidate {
3245		/** BSSID of the PMKID candidate */
3246		u8 bssid[ETH_ALEN];
3247		/** Smaller the index, higher the priority */
3248		int index;
3249		/** Whether RSN IE includes pre-authenticate flag */
3250		int preauth;
3251	} pmkid_candidate;
3252
3253	/**
3254	 * struct stkstart - Data for EVENT_STKSTART
3255	 */
3256	struct stkstart {
3257		u8 peer[ETH_ALEN];
3258	} stkstart;
3259
3260	/**
3261	 * struct tdls - Data for EVENT_TDLS
3262	 */
3263	struct tdls {
3264		u8 peer[ETH_ALEN];
3265		enum {
3266			TDLS_REQUEST_SETUP,
3267			TDLS_REQUEST_TEARDOWN
3268		} oper;
3269		u16 reason_code; /* for teardown */
3270	} tdls;
3271
3272	/**
3273	 * struct wnm - Data for EVENT_WNM
3274	 */
3275	struct wnm {
3276		u8 addr[ETH_ALEN];
3277		enum {
3278			WNM_OPER_SLEEP,
3279		} oper;
3280		enum {
3281			WNM_SLEEP_ENTER,
3282			WNM_SLEEP_EXIT
3283		} sleep_action;
3284		int sleep_intval;
3285		u16 reason_code;
3286		u8 *buf;
3287		u16 buf_len;
3288	} wnm;
3289
3290	/**
3291	 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3292	 *
3293	 * During FT (IEEE 802.11r) authentication sequence, the driver is
3294	 * expected to use this event to report received FT IEs (MDIE, FTIE,
3295	 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3296	 * IEs for the next message will be delivered through the
3297	 * struct wpa_driver_ops::update_ft_ies() callback.
3298	 */
3299	struct ft_ies {
3300		const u8 *ies;
3301		size_t ies_len;
3302		int ft_action;
3303		u8 target_ap[ETH_ALEN];
3304		/** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3305		const u8 *ric_ies;
3306		/** Length of ric_ies buffer in octets */
3307		size_t ric_ies_len;
3308	} ft_ies;
3309
3310	/**
3311	 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3312	 */
3313	struct ibss_rsn_start {
3314		u8 peer[ETH_ALEN];
3315	} ibss_rsn_start;
3316
3317	/**
3318	 * struct auth_info - Data for EVENT_AUTH events
3319	 */
3320	struct auth_info {
3321		u8 peer[ETH_ALEN];
3322		u8 bssid[ETH_ALEN];
3323		u16 auth_type;
3324		u16 auth_transaction;
3325		u16 status_code;
3326		const u8 *ies;
3327		size_t ies_len;
3328	} auth;
3329
3330	/**
3331	 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3332	 */
3333	struct assoc_reject {
3334		/**
3335		 * bssid - BSSID of the AP that rejected association
3336		 */
3337		const u8 *bssid;
3338
3339		/**
3340		 * resp_ies - (Re)Association Response IEs
3341		 *
3342		 * Optional association data from the driver. This data is not
3343		 * required WPA, but may be useful for some protocols and as
3344		 * such, should be reported if this is available to the driver
3345		 * interface.
3346		 *
3347		 * This should start with the first IE (fixed fields before IEs
3348		 * are not included).
3349		 */
3350		const u8 *resp_ies;
3351
3352		/**
3353		 * resp_ies_len - Length of resp_ies in bytes
3354		 */
3355		size_t resp_ies_len;
3356
3357		/**
3358		 * status_code - Status Code from (Re)association Response
3359		 */
3360		u16 status_code;
3361	} assoc_reject;
3362
3363	struct timeout_event {
3364		u8 addr[ETH_ALEN];
3365	} timeout_event;
3366
3367	/**
3368	 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3369	 */
3370	struct ft_rrb_rx {
3371		const u8 *src;
3372		const u8 *data;
3373		size_t data_len;
3374	} ft_rrb_rx;
3375
3376	/**
3377	 * struct tx_status - Data for EVENT_TX_STATUS events
3378	 */
3379	struct tx_status {
3380		u16 type;
3381		u16 stype;
3382		const u8 *dst;
3383		const u8 *data;
3384		size_t data_len;
3385		int ack;
3386	} tx_status;
3387
3388	/**
3389	 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3390	 */
3391	struct rx_from_unknown {
3392		const u8 *bssid;
3393		const u8 *addr;
3394		int wds;
3395	} rx_from_unknown;
3396
3397	/**
3398	 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3399	 */
3400	struct rx_mgmt {
3401		const u8 *frame;
3402		size_t frame_len;
3403		u32 datarate;
3404		int ssi_signal; /* dBm */
3405	} rx_mgmt;
3406
3407	/**
3408	 * struct rx_action - Data for EVENT_RX_ACTION events
3409	 */
3410	struct rx_action {
3411		/**
3412		 * da - Destination address of the received Action frame
3413		 */
3414		const u8 *da;
3415
3416		/**
3417		 * sa - Source address of the received Action frame
3418		 */
3419		const u8 *sa;
3420
3421		/**
3422		 * bssid - Address 3 of the received Action frame
3423		 */
3424		const u8 *bssid;
3425
3426		/**
3427		 * category - Action frame category
3428		 */
3429		u8 category;
3430
3431		/**
3432		 * data - Action frame body after category field
3433		 */
3434		const u8 *data;
3435
3436		/**
3437		 * len - Length of data in octets
3438		 */
3439		size_t len;
3440
3441		/**
3442		 * freq - Frequency (in MHz) on which the frame was received
3443		 */
3444		int freq;
3445	} rx_action;
3446
3447	/**
3448	 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3449	 *
3450	 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3451	 */
3452	struct remain_on_channel {
3453		/**
3454		 * freq - Channel frequency in MHz
3455		 */
3456		unsigned int freq;
3457
3458		/**
3459		 * duration - Duration to remain on the channel in milliseconds
3460		 */
3461		unsigned int duration;
3462	} remain_on_channel;
3463
3464	/**
3465	 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3466	 * @aborted: Whether the scan was aborted
3467	 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3468	 * @num_freqs: Number of entries in freqs array
3469	 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3470	 *	SSID)
3471	 * @num_ssids: Number of entries in ssids array
3472	 */
3473	struct scan_info {
3474		int aborted;
3475		const int *freqs;
3476		size_t num_freqs;
3477		struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3478		size_t num_ssids;
3479	} scan_info;
3480
3481	/**
3482	 * struct mlme_rx - Data for EVENT_MLME_RX events
3483	 */
3484	struct mlme_rx {
3485		const u8 *buf;
3486		size_t len;
3487		int freq;
3488		int channel;
3489		int ssi;
3490	} mlme_rx;
3491
3492	/**
3493	 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3494	 */
3495	struct rx_probe_req {
3496		/**
3497		 * sa - Source address of the received Probe Request frame
3498		 */
3499		const u8 *sa;
3500
3501		/**
3502		 * da - Destination address of the received Probe Request frame
3503		 *	or %NULL if not available
3504		 */
3505		const u8 *da;
3506
3507		/**
3508		 * bssid - BSSID of the received Probe Request frame or %NULL
3509		 *	if not available
3510		 */
3511		const u8 *bssid;
3512
3513		/**
3514		 * ie - IEs from the Probe Request body
3515		 */
3516		const u8 *ie;
3517
3518		/**
3519		 * ie_len - Length of ie buffer in octets
3520		 */
3521		size_t ie_len;
3522
3523		/**
3524		 * signal - signal strength in dBm (or 0 if not available)
3525		 */
3526		int ssi_signal;
3527	} rx_probe_req;
3528
3529	/**
3530	 * struct new_sta - Data for EVENT_NEW_STA events
3531	 */
3532	struct new_sta {
3533		const u8 *addr;
3534	} new_sta;
3535
3536	/**
3537	 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3538	 */
3539	struct eapol_rx {
3540		const u8 *src;
3541		const u8 *data;
3542		size_t data_len;
3543	} eapol_rx;
3544
3545	/**
3546	 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3547	 */
3548	struct wpa_signal_info signal_change;
3549
3550	/**
3551	 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3552	 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3553	 * @freq_5: Best 5 GHz band channel frequency in MHz
3554	 * @freq_overall: Best channel frequency in MHz
3555	 *
3556	 * 0 can be used to indicate no preference in either band.
3557	 */
3558	struct best_channel {
3559		int freq_24;
3560		int freq_5;
3561		int freq_overall;
3562	} best_chan;
3563
3564	struct unprot_deauth {
3565		const u8 *sa;
3566		const u8 *da;
3567		u16 reason_code;
3568	} unprot_deauth;
3569
3570	struct unprot_disassoc {
3571		const u8 *sa;
3572		const u8 *da;
3573		u16 reason_code;
3574	} unprot_disassoc;
3575
3576	/**
3577	 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3578	 * @addr: station address
3579	 */
3580	struct low_ack {
3581		u8 addr[ETH_ALEN];
3582	} low_ack;
3583
3584	/**
3585	 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3586	 */
3587	struct p2p_dev_found {
3588		const u8 *addr;
3589		const u8 *dev_addr;
3590		const u8 *pri_dev_type;
3591		const char *dev_name;
3592		u16 config_methods;
3593		u8 dev_capab;
3594		u8 group_capab;
3595	} p2p_dev_found;
3596
3597	/**
3598	 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3599	 */
3600	struct p2p_go_neg_req_rx {
3601		const u8 *src;
3602		u16 dev_passwd_id;
3603	} p2p_go_neg_req_rx;
3604
3605	/**
3606	 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3607	 */
3608	struct p2p_go_neg_completed {
3609		struct p2p_go_neg_results *res;
3610	} p2p_go_neg_completed;
3611
3612	struct p2p_prov_disc_req {
3613		const u8 *peer;
3614		u16 config_methods;
3615		const u8 *dev_addr;
3616		const u8 *pri_dev_type;
3617		const char *dev_name;
3618		u16 supp_config_methods;
3619		u8 dev_capab;
3620		u8 group_capab;
3621	} p2p_prov_disc_req;
3622
3623	struct p2p_prov_disc_resp {
3624		const u8 *peer;
3625		u16 config_methods;
3626	} p2p_prov_disc_resp;
3627
3628	struct p2p_sd_req {
3629		int freq;
3630		const u8 *sa;
3631		u8 dialog_token;
3632		u16 update_indic;
3633		const u8 *tlvs;
3634		size_t tlvs_len;
3635	} p2p_sd_req;
3636
3637	struct p2p_sd_resp {
3638		const u8 *sa;
3639		u16 update_indic;
3640		const u8 *tlvs;
3641		size_t tlvs_len;
3642	} p2p_sd_resp;
3643
3644	/**
3645	 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3646	 */
3647	struct ibss_peer_lost {
3648		u8 peer[ETH_ALEN];
3649	} ibss_peer_lost;
3650
3651	/**
3652	 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3653	 */
3654	struct driver_gtk_rekey {
3655		const u8 *bssid;
3656		const u8 *replay_ctr;
3657	} driver_gtk_rekey;
3658
3659	/**
3660	 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
3661	 * @addr: station address
3662	 */
3663	struct client_poll {
3664		u8 addr[ETH_ALEN];
3665	} client_poll;
3666
3667	/**
3668	 * struct eapol_tx_status
3669	 * @dst: Original destination
3670	 * @data: Data starting with IEEE 802.1X header (!)
3671	 * @data_len: Length of data
3672	 * @ack: Indicates ack or lost frame
3673	 *
3674	 * This corresponds to hapd_send_eapol if the frame sent
3675	 * there isn't just reported as EVENT_TX_STATUS.
3676	 */
3677	struct eapol_tx_status {
3678		const u8 *dst;
3679		const u8 *data;
3680		int data_len;
3681		int ack;
3682	} eapol_tx_status;
3683
3684	/**
3685	 * struct ch_switch
3686	 * @freq: Frequency of new channel in MHz
3687	 * @ht_enabled: Whether this is an HT channel
3688	 * @ch_offset: Secondary channel offset
3689	 */
3690	struct ch_switch {
3691		int freq;
3692		int ht_enabled;
3693		int ch_offset;
3694	} ch_switch;
3695};
3696
3697/**
3698 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3699 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3700 *	with struct wpa_driver_ops::init()
3701 * @event: event type (defined above)
3702 * @data: possible extra data for the event
3703 *
3704 * Driver wrapper code should call this function whenever an event is received
3705 * from the driver.
3706 */
3707void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
3708			  union wpa_event_data *data);
3709
3710
3711/*
3712 * The following inline functions are provided for convenience to simplify
3713 * event indication for some of the common events.
3714 */
3715
3716static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
3717				   size_t ielen, int reassoc)
3718{
3719	union wpa_event_data event;
3720	os_memset(&event, 0, sizeof(event));
3721	event.assoc_info.reassoc = reassoc;
3722	event.assoc_info.req_ies = ie;
3723	event.assoc_info.req_ies_len = ielen;
3724	event.assoc_info.addr = addr;
3725	wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
3726}
3727
3728static inline void drv_event_disassoc(void *ctx, const u8 *addr)
3729{
3730	union wpa_event_data event;
3731	os_memset(&event, 0, sizeof(event));
3732	event.disassoc_info.addr = addr;
3733	wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
3734}
3735
3736static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
3737				      size_t data_len)
3738{
3739	union wpa_event_data event;
3740	os_memset(&event, 0, sizeof(event));
3741	event.eapol_rx.src = src;
3742	event.eapol_rx.data = data;
3743	event.eapol_rx.data_len = data_len;
3744	wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
3745}
3746
3747/* driver_common.c */
3748void wpa_scan_results_free(struct wpa_scan_results *res);
3749
3750/* Convert wpa_event_type to a string for logging */
3751const char * event_to_string(enum wpa_event_type event);
3752
3753#endif /* DRIVER_H */
3754