2 * Driver interface definition
3 * Copyright (c) 2003-2012, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
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.
20 #define WPA_SUPPLICANT_DRIVER_VERSION 4
22 #include "common/defs.h"
23 #include "utils/list.h"
25 #define HOSTAPD_CHAN_DISABLED 0x00000001
26 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
27 #define HOSTAPD_CHAN_NO_IBSS 0x00000004
28 #define HOSTAPD_CHAN_RADAR 0x00000008
29 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
30 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
31 #define HOSTAPD_CHAN_HT40 0x00000040
32 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
34 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
35 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
36 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
37 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
38 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
40 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
41 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
42 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
43 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
45 enum reg_change_initiator {
49 REGDOM_SET_BY_COUNTRY_IE,
53 * struct hostapd_channel_data - Channel information
55 struct hostapd_channel_data {
57 * chan - Channel number (IEEE 802.11)
62 * freq - Frequency in MHz
67 * flag - Channel flags (HOSTAPD_CHAN_*)
72 * max_tx_power - Regulatory transmit power limit in dBm
77 * survey_list - Linked list of surveys
79 struct dl_list survey_list;
82 * min_nf - Minimum observed noise floor, in dBm, based on all
83 * surveyed channel data
89 * interference_factor - Computed interference factor on this
90 * channel (used internally in src/ap/acs.c; driver wrappers do not
93 long double interference_factor;
94 #endif /* CONFIG_ACS */
97 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
98 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
101 * struct hostapd_hw_modes - Supported hardware mode information
103 struct hostapd_hw_modes {
105 * mode - Hardware mode
107 enum hostapd_hw_mode mode;
110 * num_channels - Number of entries in the channels array
115 * channels - Array of supported channels
117 struct hostapd_channel_data *channels;
120 * num_rates - Number of entries in the rates array
125 * rates - Array of supported rates in 100 kbps units
130 * ht_capab - HT (IEEE 802.11n) capabilities
135 * mcs_set - MCS (IEEE 802.11n) rate parameters
140 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
145 * vht_capab - VHT (IEEE 802.11ac) capabilities
150 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
154 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
158 #define IEEE80211_MODE_INFRA 0
159 #define IEEE80211_MODE_IBSS 1
160 #define IEEE80211_MODE_AP 2
162 #define IEEE80211_CAP_ESS 0x0001
163 #define IEEE80211_CAP_IBSS 0x0002
164 #define IEEE80211_CAP_PRIVACY 0x0010
166 /* DMG (60 GHz) IEEE 802.11ad */
167 /* type - bits 0..1 */
168 #define IEEE80211_CAP_DMG_MASK 0x0003
169 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
170 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
171 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
173 #define WPA_SCAN_QUAL_INVALID BIT(0)
174 #define WPA_SCAN_NOISE_INVALID BIT(1)
175 #define WPA_SCAN_LEVEL_INVALID BIT(2)
176 #define WPA_SCAN_LEVEL_DBM BIT(3)
177 #define WPA_SCAN_AUTHENTICATED BIT(4)
178 #define WPA_SCAN_ASSOCIATED BIT(5)
181 * struct wpa_scan_res - Scan result for an BSS/IBSS
182 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
184 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
185 * @beacon_int: beacon interval in TUs (host byte order)
186 * @caps: capability information field in host byte order
187 * @qual: signal quality
188 * @noise: noise level
189 * @level: signal level
191 * @age: Age of the information in milliseconds (i.e., how many milliseconds
192 * ago the last Beacon or Probe Response frame was received)
193 * @ie_len: length of the following IE field in octets
194 * @beacon_ie_len: length of the following Beacon IE field in octets
196 * This structure is used as a generic format for scan results from the
197 * driver. Each driver interface implementation is responsible for converting
198 * the driver or OS specific scan results into this format.
200 * If the driver does not support reporting all IEs, the IE data structure is
201 * constructed of the IEs that are available. This field will also need to
202 * include SSID in IE format. All drivers are encouraged to be extended to
203 * report all IEs to make it easier to support future additions.
205 struct wpa_scan_res {
217 size_t beacon_ie_len;
219 * Followed by ie_len octets of IEs from Probe Response frame (or if
220 * the driver does not indicate source of IEs, these may also be from
221 * Beacon frame). After the first set of IEs, another set of IEs may
222 * follow (with beacon_ie_len octets of data) if the driver provides
228 * struct wpa_scan_results - Scan results
229 * @res: Array of pointers to allocated variable length scan result entries
230 * @num: Number of entries in the scan result array
231 * @fetch_time: Time when the results were fetched from the driver
233 struct wpa_scan_results {
234 struct wpa_scan_res **res;
236 struct os_reltime fetch_time;
240 * struct wpa_interface_info - Network interface information
241 * @next: Pointer to the next interface or NULL if this is the last one
242 * @ifname: Interface name that can be used with init() or init2()
243 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
245 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
246 * is not an allocated copy, i.e., get_interfaces() caller will not free
249 struct wpa_interface_info {
250 struct wpa_interface_info *next;
253 const char *drv_name;
256 #define WPAS_MAX_SCAN_SSIDS 16
259 * struct wpa_driver_scan_params - Scan parameters
260 * Data for struct wpa_driver_ops::scan2().
262 struct wpa_driver_scan_params {
264 * ssids - SSIDs to scan for
266 struct wpa_driver_scan_ssid {
268 * ssid - specific SSID to scan for (ProbeReq)
269 * %NULL or zero-length SSID is used to indicate active scan
270 * with wildcard SSID.
274 * ssid_len: Length of the SSID in octets
277 } ssids[WPAS_MAX_SCAN_SSIDS];
280 * num_ssids - Number of entries in ssids array
281 * Zero indicates a request for a passive scan.
286 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
291 * extra_ies_len - Length of extra_ies in octets
293 size_t extra_ies_len;
296 * freqs - Array of frequencies to scan or %NULL for all frequencies
298 * The frequency is set in MHz. The array is zero-terminated.
303 * filter_ssids - Filter for reporting SSIDs
305 * This optional parameter can be used to request the driver wrapper to
306 * filter scan results to include only the specified SSIDs. %NULL
307 * indicates that no filtering is to be done. This can be used to
308 * reduce memory needs for scan results in environments that have large
309 * number of APs with different SSIDs.
311 * The driver wrapper is allowed to take this allocated buffer into its
312 * own use by setting the pointer to %NULL. In that case, the driver
313 * wrapper is responsible for freeing the buffer with os_free() once it
314 * is not needed anymore.
316 struct wpa_driver_scan_filter {
322 * num_filter_ssids - Number of entries in filter_ssids array
324 size_t num_filter_ssids;
327 * filter_rssi - Filter by RSSI
329 * The driver may filter scan results in firmware to reduce host
330 * wakeups and thereby save power. Specify the RSSI threshold in s32
336 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
338 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
339 * Mbps from the support rates element(s) in the Probe Request frames
340 * and not to transmit the frames at any of those rates.
346 * struct wpa_driver_auth_params - Authentication parameters
347 * Data for struct wpa_driver_ops::authenticate().
349 struct wpa_driver_auth_params {
357 const u8 *wep_key[4];
358 size_t wep_key_len[4];
360 int local_state_change;
363 * p2p - Whether this connection is a P2P group
373 WPS_MODE_NONE /* no WPS provisioning being used */,
374 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
375 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
380 * struct wpa_driver_associate_params - Association parameters
381 * Data for struct wpa_driver_ops::associate().
383 struct wpa_driver_associate_params {
385 * bssid - BSSID of the selected AP
386 * This can be %NULL, if ap_scan=2 mode is used and the driver is
387 * responsible for selecting with which BSS to associate. */
391 * ssid - The selected SSID
396 * ssid_len - Length of the SSID (1..32)
401 * freq - Frequency of the channel the selected AP is using
402 * Frequency that the selected AP is using (in MHz as
403 * reported in the scan results)
408 * bg_scan_period - Background scan period in seconds, 0 to disable
409 * background scan, or -1 to indicate no change to default driver
415 * wpa_ie - WPA information element for (Re)Association Request
416 * WPA information element to be included in (Re)Association
417 * Request (including information element id and length). Use
418 * of this WPA IE is optional. If the driver generates the WPA
419 * IE, it can use pairwise_suite, group_suite, and
420 * key_mgmt_suite to select proper algorithms. In this case,
421 * the driver has to notify wpa_supplicant about the used WPA
422 * IE by generating an event that the interface code will
423 * convert into EVENT_ASSOCINFO data (see below).
425 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
426 * instead. The driver can determine which version is used by
427 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
430 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
435 * wpa_ie_len - length of the wpa_ie
440 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
442 unsigned int wpa_proto;
445 * pairwise_suite - Selected pairwise cipher suite
447 * This is usually ignored if @wpa_ie is used.
449 enum wpa_cipher pairwise_suite;
452 * group_suite - Selected group cipher suite
454 * This is usually ignored if @wpa_ie is used.
456 enum wpa_cipher group_suite;
459 * key_mgmt_suite - Selected key management suite
461 * This is usually ignored if @wpa_ie is used.
463 enum wpa_key_mgmt key_mgmt_suite;
466 * auth_alg - Allowed authentication algorithms
467 * Bit field of WPA_AUTH_ALG_*
472 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
477 * wep_key - WEP keys for static WEP configuration
479 const u8 *wep_key[4];
482 * wep_key_len - WEP key length for static WEP configuration
484 size_t wep_key_len[4];
487 * wep_tx_keyidx - WEP TX key index for static WEP configuration
492 * mgmt_frame_protection - IEEE 802.11w management frame protection
494 enum mfp_options mgmt_frame_protection;
497 * ft_ies - IEEE 802.11r / FT information elements
498 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
499 * for fast transition, this parameter is set to include the IEs that
500 * are to be sent in the next FT Authentication Request message.
501 * update_ft_ies() handler is called to update the IEs for further
502 * FT messages in the sequence.
504 * The driver should use these IEs only if the target AP is advertising
505 * the same mobility domain as the one included in the MDIE here.
507 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
508 * AP after the initial association. These IEs can only be used if the
509 * target AP is advertising support for FT and is using the same MDIE
510 * and SSID as the current AP.
512 * The driver is responsible for reporting the FT IEs received from the
513 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
514 * type. update_ft_ies() handler will then be called with the FT IEs to
515 * include in the next frame in the authentication sequence.
520 * ft_ies_len - Length of ft_ies in bytes
525 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
527 * This value is provided to allow the driver interface easier access
528 * to the current mobility domain. This value is set to %NULL if no
529 * mobility domain is currently active.
534 * passphrase - RSN passphrase for PSK
536 * This value is made available only for WPA/WPA2-Personal (PSK) and
537 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
538 * the 8..63 character ASCII passphrase, if available. Please note that
539 * this can be %NULL if passphrase was not used to generate the PSK. In
540 * that case, the psk field must be used to fetch the PSK.
542 const char *passphrase;
545 * psk - RSN PSK (alternative for passphrase for PSK)
547 * This value is made available only for WPA/WPA2-Personal (PSK) and
548 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
549 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
550 * be prepared to handle %NULL value as an error.
555 * drop_unencrypted - Enable/disable unencrypted frame filtering
557 * Configure the driver to drop all non-EAPOL frames (both receive and
558 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
559 * still be allowed for key negotiation.
561 int drop_unencrypted;
564 * prev_bssid - Previously used BSSID in this ESS
566 * When not %NULL, this is a request to use reassociation instead of
569 const u8 *prev_bssid;
574 * If the driver needs to do special configuration for WPS association,
575 * this variable provides more information on what type of association
576 * is being requested. Most drivers should not need ot use this.
581 * p2p - Whether this connection is a P2P group
586 * uapsd - UAPSD parameters for the network
587 * -1 = do not change defaults
588 * AP mode: 1 = enabled, 0 = disabled
589 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
594 * fixed_bssid - Whether to force this BSSID in IBSS mode
595 * 1 = Fix this BSSID and prevent merges.
596 * 0 = Do not fix BSSID.
601 * disable_ht - Disable HT (IEEE 802.11n) for this connection
606 * HT Capabilities over-rides. Only bits set in the mask will be used,
607 * and not all values are used by the kernel anyway. Currently, MCS,
608 * MPDU and MSDU fields are used.
610 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */
611 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */
613 #ifdef CONFIG_VHT_OVERRIDES
615 * disable_vht - Disable VHT for this connection
620 * VHT capability overrides.
622 const struct ieee80211_vht_capabilities *vhtcaps;
623 const struct ieee80211_vht_capabilities *vhtcaps_mask;
624 #endif /* CONFIG_VHT_OVERRIDES */
629 HIDDEN_SSID_ZERO_LEN,
630 HIDDEN_SSID_ZERO_CONTENTS
633 struct wpa_driver_ap_params {
635 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
640 * head_len - Length of the head buffer in octets
645 * tail - Beacon tail following TIM IE
650 * tail_len - Length of the tail buffer in octets
655 * dtim_period - DTIM period
660 * beacon_int - Beacon interval
665 * basic_rates: -1 terminated array of basic rates in 100 kbps
667 * This parameter can be used to set a specific basic rate set for the
668 * BSS. If %NULL, default basic rate set is used.
673 * proberesp - Probe Response template
675 * This is used by drivers that reply to Probe Requests internally in
676 * AP mode and require the full Probe Response template.
681 * proberesp_len - Length of the proberesp buffer in octets
683 size_t proberesp_len;
686 * ssid - The SSID to use in Beacon/Probe Response frames
691 * ssid_len - Length of the SSID (1..32)
696 * hide_ssid - Whether to hide the SSID
698 enum hide_ssid hide_ssid;
701 * pairwise_ciphers - WPA_CIPHER_* bitfield
703 unsigned int pairwise_ciphers;
706 * group_cipher - WPA_CIPHER_*
708 unsigned int group_cipher;
711 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
713 unsigned int key_mgmt_suites;
716 * auth_algs - WPA_AUTH_ALG_* bitfield
718 unsigned int auth_algs;
721 * wpa_version - WPA_PROTO_* bitfield
723 unsigned int wpa_version;
726 * privacy - Whether privacy is used in the BSS
731 * beacon_ies - WPS/P2P IE(s) for Beacon frames
733 * This is used to add IEs like WPS IE and P2P IE by drivers that do
734 * not use the full Beacon template.
736 const struct wpabuf *beacon_ies;
739 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
741 * This is used to add IEs like WPS IE and P2P IE by drivers that
742 * reply to Probe Request frames internally.
744 const struct wpabuf *proberesp_ies;
747 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
749 * This is used to add IEs like WPS IE by drivers that reply to
750 * (Re)Association Request frames internally.
752 const struct wpabuf *assocresp_ies;
755 * isolate - Whether to isolate frames between associated stations
757 * If this is non-zero, the AP is requested to disable forwarding of
758 * frames between associated stations.
763 * cts_protect - Whether CTS protection is enabled
768 * preamble - Whether short preamble is enabled
773 * short_slot_time - Whether short slot time is enabled
775 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
776 * not set (e.g., when 802.11g mode is not in use)
781 * ht_opmode - HT operation mode or -1 if HT not in use
786 * interworking - Whether Interworking is enabled
791 * hessid - Homogeneous ESS identifier or %NULL if not set
796 * access_network_type - Access Network Type (0..15)
798 * This is used for filtering Probe Request frames when Interworking is
801 u8 access_network_type;
804 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
806 * This is used by driver which advertises this capability.
808 int ap_max_inactivity;
811 * disable_dgaf - Whether group-addressed frames are disabled
817 * struct wpa_driver_capa - Driver capability information
819 struct wpa_driver_capa {
820 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
821 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
822 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
823 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
824 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
825 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
826 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
827 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
828 unsigned int key_mgmt;
830 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
831 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
832 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
833 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
834 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
835 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
836 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
837 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
838 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
839 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
840 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
841 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
844 #define WPA_DRIVER_AUTH_OPEN 0x00000001
845 #define WPA_DRIVER_AUTH_SHARED 0x00000002
846 #define WPA_DRIVER_AUTH_LEAP 0x00000004
849 /* Driver generated WPA/RSN IE */
850 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
851 /* Driver needs static WEP key setup after association command */
852 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
853 /* unused: 0x00000004 */
854 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
855 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
856 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
857 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
858 /* Driver provides separate commands for authentication and association (SME in
859 * wpa_supplicant). */
860 #define WPA_DRIVER_FLAGS_SME 0x00000020
861 /* Driver supports AP mode */
862 #define WPA_DRIVER_FLAGS_AP 0x00000040
863 /* Driver needs static WEP key setup after association has been completed */
864 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
865 /* Driver takes care of P2P management operations */
866 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
867 /* Driver supports concurrent P2P operations */
868 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
870 * Driver uses the initial interface as a dedicated management interface, i.e.,
871 * it cannot be used for P2P group operations or non-P2P purposes.
873 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
874 /* This interface is P2P capable (P2P GO or P2P Client) */
875 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
876 /* unused: 0x00001000 */
878 * Driver uses the initial interface for P2P management interface and non-P2P
879 * purposes (e.g., connect to infra AP), but this interface cannot be used for
880 * P2P group operations.
882 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
884 * Driver is known to use sane error codes, i.e., when it indicates that
885 * something (e.g., association) fails, there was indeed a failure and the
886 * operation does not end up getting completed successfully later.
888 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
889 /* Driver supports off-channel TX */
890 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
891 /* Driver indicates TX status events for EAPOL Data frames */
892 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
893 /* Driver indicates TX status events for Deauth/Disassoc frames */
894 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
895 /* Driver supports roaming (BSS selection) in firmware */
896 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
897 /* Driver supports operating as a TDLS peer */
898 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
899 /* Driver requires external TDLS setup/teardown/discovery */
900 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
901 /* Driver indicates support for Probe Response offloading in AP mode */
902 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
903 /* Driver supports U-APSD in AP mode */
904 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
905 /* Driver supports inactivity timer in AP mode */
906 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
907 /* Driver expects user space implementation of MLME in AP mode */
908 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
909 /* Driver supports SAE with user space SME */
910 #define WPA_DRIVER_FLAGS_SAE 0x02000000
911 /* Driver makes use of OBSS scan mechanism in wpa_supplicant */
912 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
913 /* Driver supports IBSS (Ad-hoc) mode */
914 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
915 /* Driver supports radar detection */
916 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
917 /* Driver supports a dedicated interface for P2P Device */
918 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
919 /* Driver supports QoS Mapping */
920 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
924 int max_sched_scan_ssids;
925 int sched_scan_supported;
929 * max_remain_on_chan - Maximum remain-on-channel duration in msec
931 unsigned int max_remain_on_chan;
934 * max_stations - Maximum number of associated stations the driver
935 * supports in AP mode
937 unsigned int max_stations;
940 * probe_resp_offloads - Bitmap of supported protocols by the driver
941 * for Probe Response offloading.
943 /* Driver Probe Response offloading support for WPS ver. 1 */
944 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
945 /* Driver Probe Response offloading support for WPS ver. 2 */
946 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
947 /* Driver Probe Response offloading support for P2P */
948 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
949 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
950 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
951 unsigned int probe_resp_offloads;
953 unsigned int max_acl_mac_addrs;
956 * Number of supported concurrent channels
958 unsigned int num_multichan_concurrent;
961 * extended_capa - extended capabilities in driver/device
963 * Must be allocated and freed by driver and the pointers must be
964 * valid for the lifetime of the driver, i.e., freed in deinit()
966 const u8 *extended_capa, *extended_capa_mask;
967 unsigned int extended_capa_len;
973 struct hostap_sta_driver_data {
974 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
975 unsigned long current_tx_rate;
976 unsigned long inactive_msec;
978 unsigned long num_ps_buf_frames;
979 unsigned long tx_retry_failed;
980 unsigned long tx_retry_count;
985 struct hostapd_sta_add_params {
989 const u8 *supp_rates;
990 size_t supp_rates_len;
992 const struct ieee80211_ht_capabilities *ht_capabilities;
993 const struct ieee80211_vht_capabilities *vht_capabilities;
994 u32 flags; /* bitmask of WPA_STA_* flags */
995 int set; /* Set STA parameters instead of add */
998 size_t ext_capab_len;
1001 struct hostapd_freq_params {
1007 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
1008 * secondary channel below primary, 1 = HT40
1009 * enabled, secondary channel above primary */
1014 /* valid for both HT and VHT, center_freq2 is non-zero
1015 * only for bandwidth 80 and an 80+80 channel */
1016 int center_freq1, center_freq2;
1020 struct mac_address {
1024 struct hostapd_acl_params {
1026 unsigned int num_mac_acl;
1027 struct mac_address mac_acl[0];
1030 enum wpa_driver_if_type {
1032 * WPA_IF_STATION - Station mode interface
1037 * WPA_IF_AP_VLAN - AP mode VLAN interface
1039 * This interface shares its address and Beacon frame with the main
1045 * WPA_IF_AP_BSS - AP mode BSS interface
1047 * This interface has its own address and Beacon frame.
1052 * WPA_IF_P2P_GO - P2P Group Owner
1057 * WPA_IF_P2P_CLIENT - P2P Client
1062 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1063 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1068 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1069 * abstracted P2P Device function in the driver
1074 struct wpa_init_params {
1080 const char *test_socket;
1081 int use_pae_group_addr;
1085 u8 *own_addr; /* buffer for writing own MAC address */
1089 struct wpa_bss_params {
1090 /** Interface name (for multi-SSID/VLAN support) */
1092 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1101 enum mfp_options ieee80211w;
1104 #define WPA_STA_AUTHORIZED BIT(0)
1105 #define WPA_STA_WMM BIT(1)
1106 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1107 #define WPA_STA_MFP BIT(3)
1108 #define WPA_STA_TDLS_PEER BIT(4)
1111 * struct p2p_params - P2P parameters for driver-based P2P management
1114 const char *dev_name;
1116 #define DRV_MAX_SEC_DEV_TYPES 5
1117 u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8];
1118 size_t num_sec_dev_types;
1132 WNM_SLEEP_ENTER_CONFIRM,
1133 WNM_SLEEP_ENTER_FAIL,
1134 WNM_SLEEP_EXIT_CONFIRM,
1135 WNM_SLEEP_EXIT_FAIL,
1136 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1137 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1138 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1140 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1142 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1143 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1145 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1148 /* enum chan_width - Channel width definitions */
1160 * struct wpa_signal_info - Information about channel signal quality
1162 struct wpa_signal_info {
1164 int above_threshold;
1169 enum chan_width chanwidth;
1175 * struct beacon_data - Beacon data
1176 * @head: Head portion of Beacon frame (before TIM IE)
1177 * @tail: Tail portion of Beacon frame (after TIM IE)
1178 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1179 * @proberesp_ies: Extra information element(s) to add into Probe Response
1181 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1182 * Response frames or %NULL
1183 * @probe_resp: Probe Response frame template
1184 * @head_len: Length of @head
1185 * @tail_len: Length of @tail
1186 * @beacon_ies_len: Length of beacon_ies in octets
1187 * @proberesp_ies_len: Length of proberesp_ies in octets
1188 * @proberesp_ies_len: Length of proberesp_ies in octets
1189 * @probe_resp_len: Length of probe response template (@probe_resp)
1191 struct beacon_data {
1198 size_t head_len, tail_len;
1199 size_t beacon_ies_len;
1200 size_t proberesp_ies_len;
1201 size_t assocresp_ies_len;
1202 size_t probe_resp_len;
1206 * struct csa_settings - Settings for channel switch command
1207 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1208 * @block_tx: 1 - block transmission for CSA period
1209 * @freq_params: Next channel frequency parameter
1210 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1211 * @beacon_after: Next beacon/probe resp/asooc resp info
1212 * @counter_offset_beacon: Offset to the count field in beacon's tail
1213 * @counter_offset_presp: Offset to the count field in probe resp.
1215 struct csa_settings {
1219 struct hostapd_freq_params freq_params;
1220 struct beacon_data beacon_csa;
1221 struct beacon_data beacon_after;
1223 u16 counter_offset_beacon;
1224 u16 counter_offset_presp;
1228 * struct wpa_driver_ops - Driver interface API definition
1230 * This structure defines the API that each driver interface needs to implement
1231 * for core wpa_supplicant code. All driver specific functionality is captured
1234 struct wpa_driver_ops {
1235 /** Name of the driver interface */
1237 /** One line description of the driver interface */
1241 * get_bssid - Get the current BSSID
1242 * @priv: private driver interface data
1243 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1245 * Returns: 0 on success, -1 on failure
1247 * Query kernel driver for the current BSSID and copy it to bssid.
1248 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1251 int (*get_bssid)(void *priv, u8 *bssid);
1254 * get_ssid - Get the current SSID
1255 * @priv: private driver interface data
1256 * @ssid: buffer for SSID (at least 32 bytes)
1258 * Returns: Length of the SSID on success, -1 on failure
1260 * Query kernel driver for the current SSID and copy it to ssid.
1261 * Returning zero is recommended if the STA is not associated.
1263 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1264 * can, at least in theory, contain control characters (including nul)
1265 * and as such, should be processed as binary data, not a printable
1268 int (*get_ssid)(void *priv, u8 *ssid);
1271 * set_key - Configure encryption key
1272 * @ifname: Interface name (for multi-SSID/VLAN support)
1273 * @priv: private driver interface data
1274 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1275 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1276 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1277 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1278 * %WPA_ALG_BIP_CMAC_256);
1279 * %WPA_ALG_NONE clears the key.
1280 * @addr: Address of the peer STA (BSSID of the current AP when setting
1281 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1282 * broadcast keys, %NULL for default keys that are used both for
1283 * broadcast and unicast; when clearing keys, %NULL is used to
1284 * indicate that both the broadcast-only and default key of the
1285 * specified key index is to be cleared
1286 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1288 * @set_tx: configure this key as the default Tx key (only used when
1289 * driver does not support separate unicast/individual key
1290 * @seq: sequence number/packet number, seq_len octets, the next
1291 * packet number to be used for in replay protection; configured
1292 * for Rx keys (in most cases, this is only used with broadcast
1293 * keys and set to zero for unicast keys); %NULL if not set
1294 * @seq_len: length of the seq, depends on the algorithm:
1295 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1296 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1298 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1299 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1301 * Returns: 0 on success, -1 on failure
1303 * Configure the given key for the kernel driver. If the driver
1304 * supports separate individual keys (4 default keys + 1 individual),
1305 * addr can be used to determine whether the key is default or
1306 * individual. If only 4 keys are supported, the default key with key
1307 * index 0 is used as the individual key. STA must be configured to use
1308 * it as the default Tx key (set_tx is set) and accept Rx for all the
1309 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1310 * broadcast keys, so key index 0 is available for this kind of
1313 * Please note that TKIP keys include separate TX and RX MIC keys and
1314 * some drivers may expect them in different order than wpa_supplicant
1315 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1316 * will trigger Michael MIC errors. This can be fixed by changing the
1317 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1318 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1319 * example on how this can be done.
1321 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1322 const u8 *addr, int key_idx, int set_tx,
1323 const u8 *seq, size_t seq_len,
1324 const u8 *key, size_t key_len);
1327 * init - Initialize driver interface
1328 * @ctx: context to be used when calling wpa_supplicant functions,
1329 * e.g., wpa_supplicant_event()
1330 * @ifname: interface name, e.g., wlan0
1332 * Returns: Pointer to private data, %NULL on failure
1334 * Initialize driver interface, including event processing for kernel
1335 * driver events (e.g., associated, scan results, Michael MIC failure).
1336 * This function can allocate a private configuration data area for
1337 * @ctx, file descriptor, interface name, etc. information that may be
1338 * needed in future driver operations. If this is not used, non-NULL
1339 * value will need to be returned because %NULL is used to indicate
1340 * failure. The returned value will be used as 'void *priv' data for
1341 * all other driver_ops functions.
1343 * The main event loop (eloop.c) of wpa_supplicant can be used to
1344 * register callback for read sockets (eloop_register_read_sock()).
1346 * See below for more information about events and
1347 * wpa_supplicant_event() function.
1349 void * (*init)(void *ctx, const char *ifname);
1352 * deinit - Deinitialize driver interface
1353 * @priv: private driver interface data from init()
1355 * Shut down driver interface and processing of driver events. Free
1356 * private data buffer if one was allocated in init() handler.
1358 void (*deinit)(void *priv);
1361 * set_param - Set driver configuration parameters
1362 * @priv: private driver interface data from init()
1363 * @param: driver specific configuration parameters
1365 * Returns: 0 on success, -1 on failure
1367 * Optional handler for notifying driver interface about configuration
1368 * parameters (driver_param).
1370 int (*set_param)(void *priv, const char *param);
1373 * set_countermeasures - Enable/disable TKIP countermeasures
1374 * @priv: private driver interface data
1375 * @enabled: 1 = countermeasures enabled, 0 = disabled
1377 * Returns: 0 on success, -1 on failure
1379 * Configure TKIP countermeasures. When these are enabled, the driver
1380 * should drop all received and queued frames that are using TKIP.
1382 int (*set_countermeasures)(void *priv, int enabled);
1385 * deauthenticate - Request driver to deauthenticate
1386 * @priv: private driver interface data
1387 * @addr: peer address (BSSID of the AP)
1388 * @reason_code: 16-bit reason code to be sent in the deauthentication
1391 * Returns: 0 on success, -1 on failure
1393 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1396 * associate - Request driver to associate
1397 * @priv: private driver interface data
1398 * @params: association parameters
1400 * Returns: 0 on success, -1 on failure
1402 int (*associate)(void *priv,
1403 struct wpa_driver_associate_params *params);
1406 * add_pmkid - Add PMKSA cache entry to the driver
1407 * @priv: private driver interface data
1408 * @bssid: BSSID for the PMKSA cache entry
1409 * @pmkid: PMKID for the PMKSA cache entry
1411 * Returns: 0 on success, -1 on failure
1413 * This function is called when a new PMK is received, as a result of
1414 * either normal authentication or RSN pre-authentication.
1416 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1417 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1418 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1419 * driver_ops function does not need to be implemented. Likewise, if
1420 * the driver does not support WPA, this function is not needed.
1422 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1425 * remove_pmkid - Remove PMKSA cache entry to the driver
1426 * @priv: private driver interface data
1427 * @bssid: BSSID for the PMKSA cache entry
1428 * @pmkid: PMKID for the PMKSA cache entry
1430 * Returns: 0 on success, -1 on failure
1432 * This function is called when the supplicant drops a PMKSA cache
1433 * entry for any reason.
1435 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1436 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1437 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1438 * from wpa_supplicant, this driver_ops function does not need to be
1439 * implemented. Likewise, if the driver does not support WPA, this
1440 * function is not needed.
1442 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1445 * flush_pmkid - Flush PMKSA cache
1446 * @priv: private driver interface data
1448 * Returns: 0 on success, -1 on failure
1450 * This function is called when the supplicant drops all PMKSA cache
1451 * entries for any reason.
1453 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1454 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1455 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1456 * from wpa_supplicant, this driver_ops function does not need to be
1457 * implemented. Likewise, if the driver does not support WPA, this
1458 * function is not needed.
1460 int (*flush_pmkid)(void *priv);
1463 * get_capa - Get driver capabilities
1464 * @priv: private driver interface data
1466 * Returns: 0 on success, -1 on failure
1468 * Get driver/firmware/hardware capabilities.
1470 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1473 * poll - Poll driver for association information
1474 * @priv: private driver interface data
1476 * This is an option callback that can be used when the driver does not
1477 * provide event mechanism for association events. This is called when
1478 * receiving WPA EAPOL-Key messages that require association
1479 * information. The driver interface is supposed to generate associnfo
1480 * event before returning from this callback function. In addition, the
1481 * driver interface should generate an association event after having
1482 * sent out associnfo.
1484 void (*poll)(void *priv);
1487 * get_ifname - Get interface name
1488 * @priv: private driver interface data
1490 * Returns: Pointer to the interface name. This can differ from the
1491 * interface name used in init() call. Init() is called first.
1493 * This optional function can be used to allow the driver interface to
1494 * replace the interface name with something else, e.g., based on an
1495 * interface mapping from a more descriptive name.
1497 const char * (*get_ifname)(void *priv);
1500 * get_mac_addr - Get own MAC address
1501 * @priv: private driver interface data
1503 * Returns: Pointer to own MAC address or %NULL on failure
1505 * This optional function can be used to get the own MAC address of the
1506 * device from the driver interface code. This is only needed if the
1507 * l2_packet implementation for the OS does not provide easy access to
1509 const u8 * (*get_mac_addr)(void *priv);
1512 * send_eapol - Optional function for sending EAPOL packets
1513 * @priv: private driver interface data
1514 * @dest: Destination MAC address
1516 * @data: EAPOL packet starting with IEEE 802.1X header
1517 * @data_len: Size of the EAPOL packet
1519 * Returns: 0 on success, -1 on failure
1521 * This optional function can be used to override l2_packet operations
1522 * with driver specific functionality. If this function pointer is set,
1523 * l2_packet module is not used at all and the driver interface code is
1524 * responsible for receiving and sending all EAPOL packets. The
1525 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1526 * event. The driver interface is required to implement get_mac_addr()
1527 * handler if send_eapol() is used.
1529 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1530 const u8 *data, size_t data_len);
1533 * set_operstate - Sets device operating state to DORMANT or UP
1534 * @priv: private driver interface data
1535 * @state: 0 = dormant, 1 = up
1536 * Returns: 0 on success, -1 on failure
1538 * This is an optional function that can be used on operating systems
1539 * that support a concept of controlling network device state from user
1540 * space applications. This function, if set, gets called with
1541 * state = 1 when authentication has been completed and with state = 0
1542 * when connection is lost.
1544 int (*set_operstate)(void *priv, int state);
1547 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1548 * @priv: Private driver interface data
1549 * @addr: Address of the station for which to set protection (may be
1550 * %NULL for group keys)
1551 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1552 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1553 * Returns: 0 on success, -1 on failure
1555 * This is an optional function that can be used to set the driver to
1556 * require protection for Tx and/or Rx frames. This uses the layer
1557 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1558 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1559 * set protection operation; instead, they set protection implicitly
1560 * based on configured keys.
1562 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1566 * get_hw_feature_data - Get hardware support data (channels and rates)
1567 * @priv: Private driver interface data
1568 * @num_modes: Variable for returning the number of returned modes
1569 * flags: Variable for returning hardware feature flags
1570 * Returns: Pointer to allocated hardware data on success or %NULL on
1571 * failure. Caller is responsible for freeing this.
1573 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1578 * send_mlme - Send management frame from MLME
1579 * @priv: Private driver interface data
1580 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1581 * @data_len: Size of the management frame
1582 * @noack: Do not wait for this frame to be acked (disable retries)
1583 * Returns: 0 on success, -1 on failure
1585 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1589 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1590 * @priv: Private driver interface data
1591 * @md: Mobility domain (2 octets) (also included inside ies)
1592 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1593 * @ies_len: Length of FT IEs in bytes
1594 * Returns: 0 on success, -1 on failure
1596 * The supplicant uses this callback to let the driver know that keying
1597 * material for FT is available and that the driver can use the
1598 * provided IEs in the next message in FT authentication sequence.
1600 * This function is only needed for driver that support IEEE 802.11r
1601 * (Fast BSS Transition).
1603 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1607 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1608 * @priv: Private driver interface data
1609 * @action: Action field value
1610 * @target_ap: Target AP address
1611 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1612 * @ies_len: Length of FT IEs in bytes
1613 * Returns: 0 on success, -1 on failure
1615 * The supplicant uses this callback to request the driver to transmit
1616 * an FT Action frame (action category 6) for over-the-DS fast BSS
1619 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1620 const u8 *ies, size_t ies_len);
1623 * get_scan_results2 - Fetch the latest scan results
1624 * @priv: private driver interface data
1626 * Returns: Allocated buffer of scan results (caller is responsible for
1627 * freeing the data structure) on success, NULL on failure
1629 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1632 * set_country - Set country
1633 * @priv: Private driver interface data
1634 * @alpha2: country to which to switch to
1635 * Returns: 0 on success, -1 on failure
1637 * This function is for drivers which support some form
1638 * of setting a regulatory domain.
1640 int (*set_country)(void *priv, const char *alpha2);
1643 * get_country - Get country
1644 * @priv: Private driver interface data
1645 * @alpha2: Buffer for returning country code (at least 3 octets)
1646 * Returns: 0 on success, -1 on failure
1648 int (*get_country)(void *priv, char *alpha2);
1651 * global_init - Global driver initialization
1652 * Returns: Pointer to private data (global), %NULL on failure
1654 * This optional function is called to initialize the driver wrapper
1655 * for global data, i.e., data that applies to all interfaces. If this
1656 * function is implemented, global_deinit() will also need to be
1657 * implemented to free the private data. The driver will also likely
1658 * use init2() function instead of init() to get the pointer to global
1659 * data available to per-interface initializer.
1661 void * (*global_init)(void);
1664 * global_deinit - Global driver deinitialization
1665 * @priv: private driver global data from global_init()
1667 * Terminate any global driver related functionality and free the
1668 * global data structure.
1670 void (*global_deinit)(void *priv);
1673 * init2 - Initialize driver interface (with global data)
1674 * @ctx: context to be used when calling wpa_supplicant functions,
1675 * e.g., wpa_supplicant_event()
1676 * @ifname: interface name, e.g., wlan0
1677 * @global_priv: private driver global data from global_init()
1678 * Returns: Pointer to private data, %NULL on failure
1680 * This function can be used instead of init() if the driver wrapper
1683 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1686 * get_interfaces - Get information about available interfaces
1687 * @global_priv: private driver global data from global_init()
1688 * Returns: Allocated buffer of interface information (caller is
1689 * responsible for freeing the data structure) on success, NULL on
1692 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1695 * scan2 - Request the driver to initiate scan
1696 * @priv: private driver interface data
1697 * @params: Scan parameters
1699 * Returns: 0 on success, -1 on failure
1701 * Once the scan results are ready, the driver should report scan
1702 * results event for wpa_supplicant which will eventually request the
1703 * results with wpa_driver_get_scan_results2().
1705 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1708 * authenticate - Request driver to authenticate
1709 * @priv: private driver interface data
1710 * @params: authentication parameters
1711 * Returns: 0 on success, -1 on failure
1713 * This is an optional function that can be used with drivers that
1714 * support separate authentication and association steps, i.e., when
1715 * wpa_supplicant can act as the SME. If not implemented, associate()
1716 * function is expected to take care of IEEE 802.11 authentication,
1719 int (*authenticate)(void *priv,
1720 struct wpa_driver_auth_params *params);
1723 * set_ap - Set Beacon and Probe Response information for AP mode
1724 * @priv: Private driver interface data
1725 * @params: Parameters to use in AP mode
1727 * This function is used to configure Beacon template and/or extra IEs
1728 * to add for Beacon and Probe Response frames for the driver in
1729 * AP mode. The driver is responsible for building the full Beacon
1730 * frame by concatenating the head part with TIM IE generated by the
1731 * driver/firmware and finishing with the tail part. Depending on the
1732 * driver architectue, this can be done either by using the full
1733 * template or the set of additional IEs (e.g., WPS and P2P IE).
1734 * Similarly, Probe Response processing depends on the driver design.
1735 * If the driver (or firmware) takes care of replying to Probe Request
1736 * frames, the extra IEs provided here needs to be added to the Probe
1739 * Returns: 0 on success, -1 on failure
1741 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1744 * set_acl - Set ACL in AP mode
1745 * @priv: Private driver interface data
1746 * @params: Parameters to configure ACL
1747 * Returns: 0 on success, -1 on failure
1749 * This is used only for the drivers which support MAC address ACL.
1751 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1754 * hapd_init - Initialize driver interface (hostapd only)
1755 * @hapd: Pointer to hostapd context
1756 * @params: Configuration for the driver wrapper
1757 * Returns: Pointer to private data, %NULL on failure
1759 * This function is used instead of init() or init2() when the driver
1760 * wrapper is used with hostapd.
1762 void * (*hapd_init)(struct hostapd_data *hapd,
1763 struct wpa_init_params *params);
1766 * hapd_deinit - Deinitialize driver interface (hostapd only)
1767 * @priv: Private driver interface data from hapd_init()
1769 void (*hapd_deinit)(void *priv);
1772 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1773 * @priv: Private driver interface data
1774 * @params: BSS parameters
1775 * Returns: 0 on success, -1 on failure
1777 * This is an optional function to configure the kernel driver to
1778 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1779 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1780 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1781 * for Beacon frames.
1783 * DEPRECATED - use set_ap() instead
1785 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1788 * set_privacy - Enable/disable privacy (AP only)
1789 * @priv: Private driver interface data
1790 * @enabled: 1 = privacy enabled, 0 = disabled
1791 * Returns: 0 on success, -1 on failure
1793 * This is an optional function to configure privacy field in the
1794 * kernel driver for Beacon frames. This can be left undefined (set to
1795 * %NULL) if the driver uses the Beacon template from set_ap().
1797 * DEPRECATED - use set_ap() instead
1799 int (*set_privacy)(void *priv, int enabled);
1802 * get_seqnum - Fetch the current TSC/packet number (AP only)
1803 * @ifname: The interface name (main or virtual)
1804 * @priv: Private driver interface data
1805 * @addr: MAC address of the station or %NULL for group keys
1807 * @seq: Buffer for returning the latest used TSC/packet number
1808 * Returns: 0 on success, -1 on failure
1810 * This function is used to fetch the last used TSC/packet number for
1811 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1812 * keys, so there is no strict requirement on implementing support for
1813 * unicast keys (i.e., addr != %NULL).
1815 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1819 * flush - Flush all association stations (AP only)
1820 * @priv: Private driver interface data
1821 * Returns: 0 on success, -1 on failure
1823 * This function requests the driver to disassociate all associated
1824 * stations. This function does not need to be implemented if the
1825 * driver does not process association frames internally.
1827 int (*flush)(void *priv);
1830 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1831 * @priv: Private driver interface data
1832 * @elem: Information elements
1833 * @elem_len: Length of the elem buffer in octets
1834 * Returns: 0 on success, -1 on failure
1836 * This is an optional function to add information elements in the
1837 * kernel driver for Beacon and Probe Response frames. This can be left
1838 * undefined (set to %NULL) if the driver uses the Beacon template from
1841 * DEPRECATED - use set_ap() instead
1843 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1846 * read_sta_data - Fetch station data
1847 * @priv: Private driver interface data
1848 * @data: Buffer for returning station information
1849 * @addr: MAC address of the station
1850 * Returns: 0 on success, -1 on failure
1852 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1856 * hapd_send_eapol - Send an EAPOL packet (AP only)
1857 * @priv: private driver interface data
1858 * @addr: Destination MAC address
1859 * @data: EAPOL packet starting with IEEE 802.1X header
1860 * @data_len: Length of the EAPOL packet in octets
1861 * @encrypt: Whether the frame should be encrypted
1862 * @own_addr: Source MAC address
1863 * @flags: WPA_STA_* flags for the destination station
1865 * Returns: 0 on success, -1 on failure
1867 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1868 size_t data_len, int encrypt,
1869 const u8 *own_addr, u32 flags);
1872 * sta_deauth - Deauthenticate a station (AP only)
1873 * @priv: Private driver interface data
1874 * @own_addr: Source address and BSSID for the Deauthentication frame
1875 * @addr: MAC address of the station to deauthenticate
1876 * @reason: Reason code for the Deauthentiation frame
1877 * Returns: 0 on success, -1 on failure
1879 * This function requests a specific station to be deauthenticated and
1880 * a Deauthentication frame to be sent to it.
1882 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1886 * sta_disassoc - Disassociate a station (AP only)
1887 * @priv: Private driver interface data
1888 * @own_addr: Source address and BSSID for the Disassociation frame
1889 * @addr: MAC address of the station to disassociate
1890 * @reason: Reason code for the Disassociation frame
1891 * Returns: 0 on success, -1 on failure
1893 * This function requests a specific station to be disassociated and
1894 * a Disassociation frame to be sent to it.
1896 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1900 * sta_remove - Remove a station entry (AP only)
1901 * @priv: Private driver interface data
1902 * @addr: MAC address of the station to be removed
1903 * Returns: 0 on success, -1 on failure
1905 int (*sta_remove)(void *priv, const u8 *addr);
1908 * hapd_get_ssid - Get the current SSID (AP only)
1909 * @priv: Private driver interface data
1910 * @buf: Buffer for returning the SSID
1911 * @len: Maximum length of the buffer
1912 * Returns: Length of the SSID on success, -1 on failure
1914 * This function need not be implemented if the driver uses Beacon
1915 * template from set_ap() and does not reply to Probe Request frames.
1917 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1920 * hapd_set_ssid - Set SSID (AP only)
1921 * @priv: Private driver interface data
1923 * @len: Length of the SSID in octets
1924 * Returns: 0 on success, -1 on failure
1926 * DEPRECATED - use set_ap() instead
1928 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1931 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1932 * @priv: Private driver interface data
1933 * @enabled: 1 = countermeasures enabled, 0 = disabled
1934 * Returns: 0 on success, -1 on failure
1936 * This need not be implemented if the driver does not take care of
1937 * association processing.
1939 int (*hapd_set_countermeasures)(void *priv, int enabled);
1942 * sta_add - Add a station entry
1943 * @priv: Private driver interface data
1944 * @params: Station parameters
1945 * Returns: 0 on success, -1 on failure
1947 * This function is used to add a station entry to the driver once the
1948 * station has completed association. This is only used if the driver
1949 * does not take care of association processing.
1951 * With TDLS, this function is also used to add or set (params->set 1)
1952 * TDLS peer entries.
1954 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1957 * get_inact_sec - Get station inactivity duration (AP only)
1958 * @priv: Private driver interface data
1959 * @addr: Station address
1960 * Returns: Number of seconds station has been inactive, -1 on failure
1962 int (*get_inact_sec)(void *priv, const u8 *addr);
1965 * sta_clear_stats - Clear station statistics (AP only)
1966 * @priv: Private driver interface data
1967 * @addr: Station address
1968 * Returns: 0 on success, -1 on failure
1970 int (*sta_clear_stats)(void *priv, const u8 *addr);
1973 * set_freq - Set channel/frequency (AP only)
1974 * @priv: Private driver interface data
1975 * @freq: Channel parameters
1976 * Returns: 0 on success, -1 on failure
1978 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1981 * set_rts - Set RTS threshold
1982 * @priv: Private driver interface data
1983 * @rts: RTS threshold in octets
1984 * Returns: 0 on success, -1 on failure
1986 int (*set_rts)(void *priv, int rts);
1989 * set_frag - Set fragmentation threshold
1990 * @priv: Private driver interface data
1991 * @frag: Fragmentation threshold in octets
1992 * Returns: 0 on success, -1 on failure
1994 int (*set_frag)(void *priv, int frag);
1997 * sta_set_flags - Set station flags (AP only)
1998 * @priv: Private driver interface data
1999 * @addr: Station address
2000 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2001 * @flags_or: Bitmap of WPA_STA_* flags to add
2002 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2003 * Returns: 0 on success, -1 on failure
2005 int (*sta_set_flags)(void *priv, const u8 *addr,
2006 int total_flags, int flags_or, int flags_and);
2009 * set_tx_queue_params - Set TX queue parameters
2010 * @priv: Private driver interface data
2011 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2015 * @burst_time: Maximum length for bursting in 0.1 msec units
2017 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2018 int cw_max, int burst_time);
2021 * if_add - Add a virtual interface
2022 * @priv: Private driver interface data
2023 * @type: Interface type
2024 * @ifname: Interface name for the new virtual interface
2025 * @addr: Local address to use for the interface or %NULL to use the
2026 * parent interface address
2027 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2028 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2029 * not allowed (applies only to %WPA_IF_AP_BSS type)
2030 * @force_ifname: Buffer for returning an interface name that the
2031 * driver ended up using if it differs from the requested ifname
2032 * @if_addr: Buffer for returning the allocated interface address
2033 * (this may differ from the requested addr if the driver cannot
2034 * change interface address)
2035 * @bridge: Bridge interface to use or %NULL if no bridge configured
2036 * @use_existing: Whether to allow existing interface to be used
2037 * Returns: 0 on success, -1 on failure
2039 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2040 const char *ifname, const u8 *addr, void *bss_ctx,
2041 void **drv_priv, char *force_ifname, u8 *if_addr,
2042 const char *bridge, int use_existing);
2045 * if_remove - Remove a virtual interface
2046 * @priv: Private driver interface data
2047 * @type: Interface type
2048 * @ifname: Interface name of the virtual interface to be removed
2049 * Returns: 0 on success, -1 on failure
2051 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2052 const char *ifname);
2055 * set_sta_vlan - Bind a station into a specific interface (AP only)
2056 * @priv: Private driver interface data
2057 * @ifname: Interface (main or virtual BSS or VLAN)
2058 * @addr: MAC address of the associated station
2060 * Returns: 0 on success, -1 on failure
2062 * This function is used to bind a station to a specific virtual
2063 * interface. It is only used if when virtual interfaces are supported,
2064 * e.g., to assign stations to different VLAN interfaces based on
2065 * information from a RADIUS server. This allows separate broadcast
2066 * domains to be used with a single BSS.
2068 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2072 * commit - Optional commit changes handler (AP only)
2073 * @priv: driver private data
2074 * Returns: 0 on success, -1 on failure
2076 * This optional handler function can be registered if the driver
2077 * interface implementation needs to commit changes (e.g., by setting
2078 * network interface up) at the end of initial configuration. If set,
2079 * this handler will be called after initial setup has been completed.
2081 int (*commit)(void *priv);
2084 * send_ether - Send an ethernet packet (AP only)
2085 * @priv: private driver interface data
2086 * @dst: Destination MAC address
2087 * @src: Source MAC address
2089 * @data: EAPOL packet starting with IEEE 802.1X header
2090 * @data_len: Length of the EAPOL packet in octets
2091 * Returns: 0 on success, -1 on failure
2093 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2094 const u8 *data, size_t data_len);
2097 * set_radius_acl_auth - Notification of RADIUS ACL change
2098 * @priv: Private driver interface data
2099 * @mac: MAC address of the station
2100 * @accepted: Whether the station was accepted
2101 * @session_timeout: Session timeout for the station
2102 * Returns: 0 on success, -1 on failure
2104 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2105 u32 session_timeout);
2108 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2109 * @priv: Private driver interface data
2110 * @mac: MAC address of the station
2111 * Returns: 0 on success, -1 on failure
2113 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2116 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2117 * @priv: Private driver interface data
2118 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2119 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2121 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2122 * to remove extra IE(s)
2123 * Returns: 0 on success, -1 on failure
2125 * This is an optional function to add WPS IE in the kernel driver for
2126 * Beacon and Probe Response frames. This can be left undefined (set
2127 * to %NULL) if the driver uses the Beacon template from set_ap()
2128 * and does not process Probe Request frames. If the driver takes care
2129 * of (Re)Association frame processing, the assocresp buffer includes
2130 * WPS IE(s) that need to be added to (Re)Association Response frames
2131 * whenever a (Re)Association Request frame indicated use of WPS.
2133 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2134 * frames when operating as a GO. The driver is responsible for adding
2135 * timing related attributes (e.g., NoA) in addition to the IEs
2136 * included here by appending them after these buffers. This call is
2137 * also used to provide Probe Response IEs for P2P Listen state
2138 * operations for drivers that generate the Probe Response frames
2141 * DEPRECATED - use set_ap() instead
2143 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2144 const struct wpabuf *proberesp,
2145 const struct wpabuf *assocresp);
2148 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2149 * @priv: Private driver interface data
2150 * @authorized: Whether the port is authorized
2151 * Returns: 0 on success, -1 on failure
2153 int (*set_supp_port)(void *priv, int authorized);
2156 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2157 * @priv: Private driver interface data
2158 * @addr: MAC address of the associated station
2159 * @aid: Association ID
2160 * @val: 1 = bind to 4-address WDS; 0 = unbind
2161 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2162 * to indicate that bridge is not to be used
2163 * @ifname_wds: Buffer to return the interface name for the new WDS
2164 * station or %NULL to indicate name is not returned.
2165 * Returns: 0 on success, -1 on failure
2167 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2168 const char *bridge_ifname, char *ifname_wds);
2171 * send_action - Transmit an Action frame
2172 * @priv: Private driver interface data
2173 * @freq: Frequency (in MHz) of the channel
2174 * @wait: Time to wait off-channel for a response (in ms), or zero
2175 * @dst: Destination MAC address (Address 1)
2176 * @src: Source MAC address (Address 2)
2177 * @bssid: BSSID (Address 3)
2179 * @data_len: data length in octets
2180 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2181 * Returns: 0 on success, -1 on failure
2183 * This command can be used to request the driver to transmit an action
2184 * frame to the specified destination.
2186 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2187 * be transmitted on the given channel and the device will wait for a
2188 * response on that channel for the given wait time.
2190 * If the flag is not set, the wait time will be ignored. In this case,
2191 * if a remain-on-channel duration is in progress, the frame must be
2192 * transmitted on that channel; alternatively the frame may be sent on
2193 * the current operational channel (if in associated state in station
2194 * mode or while operating as an AP.)
2196 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2197 const u8 *dst, const u8 *src, const u8 *bssid,
2198 const u8 *data, size_t data_len, int no_cck);
2201 * send_action_cancel_wait - Cancel action frame TX wait
2202 * @priv: Private driver interface data
2204 * This command cancels the wait time associated with sending an action
2205 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2206 * set in the driver flags.
2208 void (*send_action_cancel_wait)(void *priv);
2211 * remain_on_channel - Remain awake on a channel
2212 * @priv: Private driver interface data
2213 * @freq: Frequency (in MHz) of the channel
2214 * @duration: Duration in milliseconds
2215 * Returns: 0 on success, -1 on failure
2217 * This command is used to request the driver to remain awake on the
2218 * specified channel for the specified duration and report received
2219 * Action frames with EVENT_RX_ACTION events. Optionally, received
2220 * Probe Request frames may also be requested to be reported by calling
2221 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2223 * The driver may not be at the requested channel when this function
2224 * returns, i.e., the return code is only indicating whether the
2225 * request was accepted. The caller will need to wait until the
2226 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2227 * completed the channel change. This may take some time due to other
2228 * need for the radio and the caller should be prepared to timing out
2229 * its wait since there are no guarantees on when this request can be
2232 int (*remain_on_channel)(void *priv, unsigned int freq,
2233 unsigned int duration);
2236 * cancel_remain_on_channel - Cancel remain-on-channel operation
2237 * @priv: Private driver interface data
2239 * This command can be used to cancel a remain-on-channel operation
2240 * before its originally requested duration has passed. This could be
2241 * used, e.g., when remain_on_channel() is used to request extra time
2242 * to receive a response to an Action frame and the response is
2243 * received when there is still unneeded time remaining on the
2244 * remain-on-channel operation.
2246 int (*cancel_remain_on_channel)(void *priv);
2249 * probe_req_report - Request Probe Request frames to be indicated
2250 * @priv: Private driver interface data
2251 * @report: Whether to report received Probe Request frames
2252 * Returns: 0 on success, -1 on failure (or if not supported)
2254 * This command can be used to request the driver to indicate when
2255 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2256 * Since this operation may require extra resources, e.g., due to less
2257 * optimal hardware/firmware RX filtering, many drivers may disable
2258 * Probe Request reporting at least in station mode. This command is
2259 * used to notify the driver when the Probe Request frames need to be
2260 * reported, e.g., during remain-on-channel operations.
2262 int (*probe_req_report)(void *priv, int report);
2265 * deinit_ap - Deinitialize AP mode
2266 * @priv: Private driver interface data
2267 * Returns: 0 on success, -1 on failure (or if not supported)
2269 * This optional function can be used to disable AP mode related
2270 * configuration. If the interface was not dynamically added,
2271 * change the driver mode to station mode to allow normal station
2272 * operations like scanning to be completed.
2274 int (*deinit_ap)(void *priv);
2277 * deinit_p2p_cli - Deinitialize P2P client mode
2278 * @priv: Private driver interface data
2279 * Returns: 0 on success, -1 on failure (or if not supported)
2281 * This optional function can be used to disable P2P client mode. If the
2282 * interface was not dynamically added, change the interface type back
2285 int (*deinit_p2p_cli)(void *priv);
2288 * suspend - Notification on system suspend/hibernate event
2289 * @priv: Private driver interface data
2291 void (*suspend)(void *priv);
2294 * resume - Notification on system resume/thaw event
2295 * @priv: Private driver interface data
2297 void (*resume)(void *priv);
2300 * signal_monitor - Set signal monitoring parameters
2301 * @priv: Private driver interface data
2302 * @threshold: Threshold value for signal change events; 0 = disabled
2303 * @hysteresis: Minimum change in signal strength before indicating a
2305 * Returns: 0 on success, -1 on failure (or if not supported)
2307 * This function can be used to configure monitoring of signal strength
2308 * with the current AP. Whenever signal strength drops below the
2309 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2310 * should be generated assuming the signal strength has changed at
2311 * least %hysteresis from the previously indicated signal change event.
2313 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2316 * send_frame - Send IEEE 802.11 frame (testing use only)
2317 * @priv: Private driver interface data
2318 * @data: IEEE 802.11 frame with IEEE 802.11 header
2319 * @data_len: Size of the frame
2320 * @encrypt: Whether to encrypt the frame (if keys are set)
2321 * Returns: 0 on success, -1 on failure
2323 * This function is only used for debugging purposes and is not
2324 * required to be implemented for normal operations.
2326 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2330 * shared_freq - Get operating frequency of shared interface(s)
2331 * @priv: Private driver interface data
2332 * Returns: Operating frequency in MHz, 0 if no shared operation in
2333 * use, or -1 on failure
2335 * This command can be used to request the current operating frequency
2336 * of any virtual interface that shares the same radio to provide
2337 * information for channel selection for other virtual interfaces.
2339 int (*shared_freq)(void *priv);
2342 * get_noa - Get current Notice of Absence attribute payload
2343 * @priv: Private driver interface data
2344 * @buf: Buffer for returning NoA
2345 * @buf_len: Buffer length in octets
2346 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2347 * advertized, or -1 on failure
2349 * This function is used to fetch the current Notice of Absence
2350 * attribute value from GO.
2352 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2355 * set_noa - Set Notice of Absence parameters for GO (testing)
2356 * @priv: Private driver interface data
2358 * @start: Start time in ms from next TBTT
2359 * @duration: Duration in ms
2360 * Returns: 0 on success or -1 on failure
2362 * This function is used to set Notice of Absence parameters for GO. It
2363 * is used only for testing. To disable NoA, all parameters are set to
2366 int (*set_noa)(void *priv, u8 count, int start, int duration);
2369 * set_p2p_powersave - Set P2P power save options
2370 * @priv: Private driver interface data
2371 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2372 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2373 * @ctwindow: 0.. = change (msec), -1 = no change
2374 * Returns: 0 on success or -1 on failure
2376 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2380 * ampdu - Enable/disable aggregation
2381 * @priv: Private driver interface data
2382 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2383 * Returns: 0 on success or -1 on failure
2385 int (*ampdu)(void *priv, int ampdu);
2388 * get_radio_name - Get physical radio name for the device
2389 * @priv: Private driver interface data
2390 * Returns: Radio name or %NULL if not known
2392 * The returned data must not be modified by the caller. It is assumed
2393 * that any interface that has the same radio name as another is
2394 * sharing the same physical radio. This information can be used to
2395 * share scan results etc. information between the virtual interfaces
2396 * to speed up various operations.
2398 const char * (*get_radio_name)(void *priv);
2401 * p2p_find - Start P2P Device Discovery
2402 * @priv: Private driver interface data
2403 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2404 * @type: Device Discovery type (enum p2p_discovery_type)
2405 * Returns: 0 on success, -1 on failure
2407 * This function is only used if the driver implements P2P management,
2408 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2409 * struct wpa_driver_capa.
2411 int (*p2p_find)(void *priv, unsigned int timeout, int type);
2414 * p2p_stop_find - Stop P2P Device Discovery
2415 * @priv: Private driver interface data
2416 * Returns: 0 on success, -1 on failure
2418 * This function is only used if the driver implements P2P management,
2419 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2420 * struct wpa_driver_capa.
2422 int (*p2p_stop_find)(void *priv);
2425 * p2p_listen - Start P2P Listen state for specified duration
2426 * @priv: Private driver interface data
2427 * @timeout: Listen state duration in milliseconds
2428 * Returns: 0 on success, -1 on failure
2430 * This function can be used to request the P2P module to keep the
2431 * device discoverable on the listen channel for an extended set of
2432 * time. At least in its current form, this is mainly used for testing
2433 * purposes and may not be of much use for normal P2P operations.
2435 * This function is only used if the driver implements P2P management,
2436 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2437 * struct wpa_driver_capa.
2439 int (*p2p_listen)(void *priv, unsigned int timeout);
2442 * p2p_connect - Start P2P group formation (GO negotiation)
2443 * @priv: Private driver interface data
2444 * @peer_addr: MAC address of the peer P2P client
2445 * @wps_method: enum p2p_wps_method value indicating config method
2446 * @go_intent: Local GO intent value (1..15)
2447 * @own_interface_addr: Intended interface address to use with the
2449 * @force_freq: The only allowed channel frequency in MHz or 0
2450 * @persistent_group: Whether to create persistent group
2451 * Returns: 0 on success, -1 on failure
2453 * This function is only used if the driver implements P2P management,
2454 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2455 * struct wpa_driver_capa.
2457 int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method,
2458 int go_intent, const u8 *own_interface_addr,
2459 unsigned int force_freq, int persistent_group);
2462 * wps_success_cb - Report successfully completed WPS provisioning
2463 * @priv: Private driver interface data
2464 * @peer_addr: Peer address
2465 * Returns: 0 on success, -1 on failure
2467 * This function is used to report successfully completed WPS
2468 * provisioning during group formation in both GO/Registrar and
2469 * client/Enrollee roles.
2471 * This function is only used if the driver implements P2P management,
2472 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2473 * struct wpa_driver_capa.
2475 int (*wps_success_cb)(void *priv, const u8 *peer_addr);
2478 * p2p_group_formation_failed - Report failed WPS provisioning
2479 * @priv: Private driver interface data
2480 * Returns: 0 on success, -1 on failure
2482 * This function is used to report failed group formation. This can
2483 * happen either due to failed WPS provisioning or due to 15 second
2484 * timeout during the provisioning phase.
2486 * This function is only used if the driver implements P2P management,
2487 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2488 * struct wpa_driver_capa.
2490 int (*p2p_group_formation_failed)(void *priv);
2493 * p2p_set_params - Set P2P parameters
2494 * @priv: Private driver interface data
2495 * @params: P2P parameters
2496 * Returns: 0 on success, -1 on failure
2498 * This function is only used if the driver implements P2P management,
2499 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2500 * struct wpa_driver_capa.
2502 int (*p2p_set_params)(void *priv, const struct p2p_params *params);
2505 * p2p_prov_disc_req - Send Provision Discovery Request
2506 * @priv: Private driver interface data
2507 * @peer_addr: MAC address of the peer P2P client
2508 * @config_methods: WPS Config Methods value (only one bit set)
2509 * Returns: 0 on success, -1 on failure
2511 * This function can be used to request a discovered P2P peer to
2512 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2513 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2514 * Provision Discovery Request frame is transmitted once immediately
2515 * and if no response is received, the frame will be sent again
2516 * whenever the target device is discovered during device dsicovery
2517 * (start with a p2p_find() call). Response from the peer is indicated
2518 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
2520 * This function is only used if the driver implements P2P management,
2521 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2522 * struct wpa_driver_capa.
2524 int (*p2p_prov_disc_req)(void *priv, const u8 *peer_addr,
2525 u16 config_methods, int join);
2528 * p2p_sd_request - Schedule a service discovery query
2529 * @priv: Private driver interface data
2530 * @dst: Destination peer or %NULL to apply for all peers
2531 * @tlvs: P2P Service Query TLV(s)
2532 * Returns: Reference to the query or 0 on failure
2534 * Response to the query is indicated with the
2535 * EVENT_P2P_SD_RESPONSE driver event.
2537 * This function is only used if the driver implements P2P management,
2538 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2539 * struct wpa_driver_capa.
2541 u64 (*p2p_sd_request)(void *priv, const u8 *dst,
2542 const struct wpabuf *tlvs);
2545 * p2p_sd_cancel_request - Cancel a pending service discovery query
2546 * @priv: Private driver interface data
2547 * @req: Query reference from p2p_sd_request()
2548 * Returns: 0 on success, -1 on failure
2550 * This function is only used if the driver implements P2P management,
2551 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2552 * struct wpa_driver_capa.
2554 int (*p2p_sd_cancel_request)(void *priv, u64 req);
2557 * p2p_sd_response - Send response to a service discovery query
2558 * @priv: Private driver interface data
2559 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2560 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2561 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2562 * @resp_tlvs: P2P Service Response TLV(s)
2563 * Returns: 0 on success, -1 on failure
2565 * This function is called as a response to the request indicated with
2566 * the EVENT_P2P_SD_REQUEST driver event.
2568 * This function is only used if the driver implements P2P management,
2569 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2570 * struct wpa_driver_capa.
2572 int (*p2p_sd_response)(void *priv, int freq, const u8 *dst,
2574 const struct wpabuf *resp_tlvs);
2577 * p2p_service_update - Indicate a change in local services
2578 * @priv: Private driver interface data
2579 * Returns: 0 on success, -1 on failure
2581 * This function needs to be called whenever there is a change in
2582 * availability of the local services. This will increment the
2583 * Service Update Indicator value which will be used in SD Request and
2586 * This function is only used if the driver implements P2P management,
2587 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2588 * struct wpa_driver_capa.
2590 int (*p2p_service_update)(void *priv);
2593 * p2p_reject - Reject peer device (explicitly block connections)
2594 * @priv: Private driver interface data
2595 * @addr: MAC address of the peer
2596 * Returns: 0 on success, -1 on failure
2598 int (*p2p_reject)(void *priv, const u8 *addr);
2601 * p2p_invite - Invite a P2P Device into a group
2602 * @priv: Private driver interface data
2603 * @peer: Device Address of the peer P2P Device
2604 * @role: Local role in the group
2605 * @bssid: Group BSSID or %NULL if not known
2607 * @ssid_len: Length of ssid in octets
2608 * @go_dev_addr: Forced GO Device Address or %NULL if none
2609 * @persistent_group: Whether this is to reinvoke a persistent group
2610 * Returns: 0 on success, -1 on failure
2612 int (*p2p_invite)(void *priv, const u8 *peer, int role,
2613 const u8 *bssid, const u8 *ssid, size_t ssid_len,
2614 const u8 *go_dev_addr, int persistent_group);
2617 * send_tdls_mgmt - for sending TDLS management packets
2618 * @priv: private driver interface data
2619 * @dst: Destination (peer) MAC address
2620 * @action_code: TDLS action code for the mssage
2621 * @dialog_token: Dialog Token to use in the message (if needed)
2622 * @status_code: Status Code or Reason Code to use (if needed)
2623 * @buf: TDLS IEs to add to the message
2624 * @len: Length of buf in octets
2625 * Returns: 0 on success, negative (<0) on failure
2627 * This optional function can be used to send packet to driver which is
2628 * responsible for receiving and sending all TDLS packets.
2630 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2631 u8 dialog_token, u16 status_code,
2632 const u8 *buf, size_t len);
2635 * tdls_oper - Ask the driver to perform high-level TDLS operations
2636 * @priv: Private driver interface data
2637 * @oper: TDLS high-level operation. See %enum tdls_oper
2638 * @peer: Destination (peer) MAC address
2639 * Returns: 0 on success, negative (<0) on failure
2641 * This optional function can be used to send high-level TDLS commands
2644 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2647 * wnm_oper - Notify driver of the WNM frame reception
2648 * @priv: Private driver interface data
2649 * @oper: WNM operation. See %enum wnm_oper
2650 * @peer: Destination (peer) MAC address
2651 * @buf: Buffer for the driver to fill in (for getting IE)
2652 * @buf_len: Return the len of buf
2653 * Returns: 0 on success, negative (<0) on failure
2655 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2656 u8 *buf, u16 *buf_len);
2659 * set_qos_map - Set QoS Map
2660 * @priv: Private driver interface data
2661 * @qos_map_set: QoS Map
2662 * @qos_map_set_len: Length of QoS Map
2664 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2665 u8 qos_map_set_len);
2668 * signal_poll - Get current connection information
2669 * @priv: Private driver interface data
2670 * @signal_info: Connection info structure
2672 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2675 * set_authmode - Set authentication algorithm(s) for static WEP
2676 * @priv: Private driver interface data
2677 * @authmode: 1=Open System, 2=Shared Key, 3=both
2678 * Returns: 0 on success, -1 on failure
2680 * This function can be used to set authentication algorithms for AP
2681 * mode when static WEP is used. If the driver uses user space MLME/SME
2682 * implementation, there is no need to implement this function.
2684 * DEPRECATED - use set_ap() instead
2686 int (*set_authmode)(void *priv, int authmode);
2690 * driver_cmd - Execute driver-specific command
2691 * @priv: Private driver interface data
2692 * @cmd: Command to execute
2693 * @buf: Return buffer
2694 * @buf_len: Buffer length
2695 * Returns: 0 on success, -1 on failure
2697 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2698 #endif /* ANDROID */
2701 * set_rekey_info - Set rekey information
2702 * @priv: Private driver interface data
2705 * @replay_ctr: Current EAPOL-Key Replay Counter
2707 * This optional function can be used to provide information for the
2708 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2709 * while the host (including wpa_supplicant) is sleeping.
2711 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2712 const u8 *replay_ctr);
2715 * sta_assoc - Station association indication
2716 * @priv: Private driver interface data
2717 * @own_addr: Source address and BSSID for association frame
2718 * @addr: MAC address of the station to associate
2719 * @reassoc: flag to indicate re-association
2720 * @status: association response status code
2721 * @ie: assoc response ie buffer
2722 * @len: ie buffer length
2723 * Returns: 0 on success, -1 on failure
2725 * This function indicates the driver to send (Re)Association
2726 * Response frame to the station.
2728 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2729 int reassoc, u16 status, const u8 *ie, size_t len);
2732 * sta_auth - Station authentication indication
2733 * @priv: Private driver interface data
2734 * @own_addr: Source address and BSSID for authentication frame
2735 * @addr: MAC address of the station to associate
2736 * @seq: authentication sequence number
2737 * @status: authentication response status code
2738 * @ie: authentication frame ie buffer
2739 * @len: ie buffer length
2741 * This function indicates the driver to send Authentication frame
2744 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2745 u16 seq, u16 status, const u8 *ie, size_t len);
2748 * add_tspec - Add traffic stream
2749 * @priv: Private driver interface data
2750 * @addr: MAC address of the station to associate
2751 * @tspec_ie: tspec ie buffer
2752 * @tspec_ielen: tspec ie length
2753 * Returns: 0 on success, -1 on failure
2755 * This function adds the traffic steam for the station
2756 * and fills the medium_time in tspec_ie.
2758 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2759 size_t tspec_ielen);
2762 * add_sta_node - Add a station node in the driver
2763 * @priv: Private driver interface data
2764 * @addr: MAC address of the station to add
2765 * @auth_alg: authentication algorithm used by the station
2766 * Returns: 0 on success, -1 on failure
2768 * This function adds the station node in the driver, when
2769 * the station gets added by FT-over-DS.
2771 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2774 * sched_scan - Request the driver to initiate scheduled scan
2775 * @priv: Private driver interface data
2776 * @params: Scan parameters
2777 * @interval: Interval between scan cycles in milliseconds
2778 * Returns: 0 on success, -1 on failure
2780 * This operation should be used for scheduled scan offload to
2781 * the hardware. Every time scan results are available, the
2782 * driver should report scan results event for wpa_supplicant
2783 * which will eventually request the results with
2784 * wpa_driver_get_scan_results2(). This operation is optional
2785 * and if not provided or if it returns -1, we fall back to
2786 * normal host-scheduled scans.
2788 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2792 * stop_sched_scan - Request the driver to stop a scheduled scan
2793 * @priv: Private driver interface data
2794 * Returns: 0 on success, -1 on failure
2796 * This should cause the scheduled scan to be stopped and
2797 * results should stop being sent. Must be supported if
2798 * sched_scan is supported.
2800 int (*stop_sched_scan)(void *priv);
2803 * poll_client - Probe (null data or such) the given station
2804 * @priv: Private driver interface data
2805 * @own_addr: MAC address of sending interface
2806 * @addr: MAC address of the station to probe
2807 * @qos: Indicates whether station is QoS station
2809 * This function is used to verify whether an associated station is
2810 * still present. This function does not need to be implemented if the
2811 * driver provides such inactivity polling mechanism.
2813 void (*poll_client)(void *priv, const u8 *own_addr,
2814 const u8 *addr, int qos);
2817 * radio_disable - Disable/enable radio
2818 * @priv: Private driver interface data
2819 * @disabled: 1=disable 0=enable radio
2820 * Returns: 0 on success, -1 on failure
2822 * This optional command is for testing purposes. It can be used to
2823 * disable the radio on a testbed device to simulate out-of-radio-range
2826 int (*radio_disable)(void *priv, int disabled);
2829 * switch_channel - Announce channel switch and migrate the GO to the
2831 * @priv: Private driver interface data
2832 * @settings: Settings for CSA period and new channel
2833 * Returns: 0 on success, -1 on failure
2835 * This function is used to move the GO to the legacy STA channel to
2836 * avoid frequency conflict in single channel concurrency.
2838 int (*switch_channel)(void *priv, struct csa_settings *settings);
2841 * start_dfs_cac - Listen for radar interference on the channel
2842 * @priv: Private driver interface data
2843 * @freq: Channel parameters
2844 * Returns: 0 on success, -1 on failure
2846 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
2849 * stop_ap - Removes beacon from AP
2850 * @priv: Private driver interface data
2851 * Returns: 0 on success, -1 on failure (or if not supported)
2853 * This optional function can be used to disable AP mode related
2854 * configuration. Unlike deinit_ap, it does not change to station
2857 int (*stop_ap)(void *priv);
2860 * get_survey - Retrieve survey data
2861 * @priv: Private driver interface data
2862 * @freq: If set, survey data for the specified frequency is only
2863 * being requested. If not set, all survey data is requested.
2864 * Returns: 0 on success, -1 on failure
2866 * Use this to retrieve:
2868 * - the observed channel noise floor
2869 * - the amount of time we have spent on the channel
2870 * - the amount of time during which we have spent on the channel that
2871 * the radio has determined the medium is busy and we cannot
2873 * - the amount of time we have spent receiving data
2874 * - the amount of time we have spent transmitting data
2876 * This data can be used for spectrum heuristics. One example is
2877 * Automatic Channel Selection (ACS). The channel survey data is
2878 * kept on a linked list on the channel data, one entry is added
2879 * for each survey. The min_nf of the channel is updated for each
2882 int (*get_survey)(void *priv, unsigned int freq);
2885 * status - Get driver interface status information
2886 * @priv: Private driver interface data
2887 * @buf: Buffer for printing tou the status information
2888 * @buflen: Maximum length of the buffer
2889 * Returns: Length of written status information or -1 on failure
2891 int (*status)(void *priv, char *buf, size_t buflen);
2896 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2898 enum wpa_event_type {
2900 * EVENT_ASSOC - Association completed
2902 * This event needs to be delivered when the driver completes IEEE
2903 * 802.11 association or reassociation successfully.
2904 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2905 * after this event has been generated. In addition, optional
2906 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2907 * more information about the association. If the driver interface gets
2908 * both of these events at the same time, it can also include the
2909 * assoc_info data in EVENT_ASSOC call.
2914 * EVENT_DISASSOC - Association lost
2916 * This event should be called when association is lost either due to
2917 * receiving deauthenticate or disassociate frame from the AP or when
2918 * sending either of these frames to the current AP. If the driver
2919 * supports separate deauthentication event, EVENT_DISASSOC should only
2920 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2921 * In AP mode, union wpa_event_data::disassoc_info is required.
2926 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2928 * This event must be delivered when a Michael MIC error is detected by
2929 * the local driver. Additional data for event processing is
2930 * provided with union wpa_event_data::michael_mic_failure. This
2931 * information is used to request new encyption key and to initiate
2932 * TKIP countermeasures if needed.
2934 EVENT_MICHAEL_MIC_FAILURE,
2937 * EVENT_SCAN_RESULTS - Scan results available
2939 * This event must be called whenever scan results are available to be
2940 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2941 * is expected to be used some time after struct wpa_driver_ops::scan()
2942 * is called. If the driver provides an unsolicited event when the scan
2943 * has been completed, this event can be used to trigger
2944 * EVENT_SCAN_RESULTS call. If such event is not available from the
2945 * driver, the driver wrapper code is expected to use a registered
2946 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2947 * scan is expected to be completed. Optional information about
2948 * completed scan can be provided with union wpa_event_data::scan_info.
2953 * EVENT_ASSOCINFO - Report optional extra information for association
2955 * This event can be used to report extra association information for
2956 * EVENT_ASSOC processing. This extra information includes IEs from
2957 * association frames and Beacon/Probe Response frames in union
2958 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2959 * EVENT_ASSOC. Alternatively, the driver interface can include
2960 * assoc_info data in the EVENT_ASSOC call if it has all the
2961 * information available at the same point.
2966 * EVENT_INTERFACE_STATUS - Report interface status changes
2968 * This optional event can be used to report changes in interface
2969 * status (interface added/removed) using union
2970 * wpa_event_data::interface_status. This can be used to trigger
2971 * wpa_supplicant to stop and re-start processing for the interface,
2972 * e.g., when a cardbus card is ejected/inserted.
2974 EVENT_INTERFACE_STATUS,
2977 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2979 * This event can be used to inform wpa_supplicant about candidates for
2980 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2981 * for scan request (ap_scan=2 mode), this event is required for
2982 * pre-authentication. If wpa_supplicant is performing scan request
2983 * (ap_scan=1), this event is optional since scan results can be used
2984 * to add pre-authentication candidates. union
2985 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2986 * candidate and priority of the candidate, e.g., based on the signal
2987 * strength, in order to try to pre-authenticate first with candidates
2988 * that are most likely targets for re-association.
2990 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2991 * on the candidate list. In addition, it can be called for the current
2992 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2993 * will automatically skip pre-authentication in cases where a valid
2994 * PMKSA exists. When more than one candidate exists, this event should
2995 * be generated once for each candidate.
2997 * Driver will be notified about successful pre-authentication with
2998 * struct wpa_driver_ops::add_pmkid() calls.
3000 EVENT_PMKID_CANDIDATE,
3003 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3005 * This event can be used to inform wpa_supplicant about desire to set
3006 * up secure direct link connection between two stations as defined in
3007 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3008 * STAKey negotiation. The caller will need to set peer address for the
3014 * EVENT_TDLS - Request TDLS operation
3016 * This event can be used to request a TDLS operation to be performed.
3021 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3023 * The driver is expected to report the received FT IEs from
3024 * FT authentication sequence from the AP. The FT IEs are included in
3025 * the extra information in union wpa_event_data::ft_ies.
3030 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3032 * The driver can use this event to inform wpa_supplicant about a STA
3033 * in an IBSS with which protected frames could be exchanged. This
3034 * event starts RSN authentication with the other STA to authenticate
3035 * the STA and set up encryption keys with it.
3037 EVENT_IBSS_RSN_START,
3040 * EVENT_AUTH - Authentication result
3042 * This event should be called when authentication attempt has been
3043 * completed. This is only used if the driver supports separate
3044 * authentication step (struct wpa_driver_ops::authenticate).
3045 * Information about authentication result is included in
3046 * union wpa_event_data::auth.
3051 * EVENT_DEAUTH - Authentication lost
3053 * This event should be called when authentication is lost either due
3054 * to receiving deauthenticate frame from the AP or when sending that
3055 * frame to the current AP.
3056 * In AP mode, union wpa_event_data::deauth_info is required.
3061 * EVENT_ASSOC_REJECT - Association rejected
3063 * This event should be called when (re)association attempt has been
3064 * rejected by the AP. Information about the association response is
3065 * included in union wpa_event_data::assoc_reject.
3070 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3072 EVENT_AUTH_TIMED_OUT,
3075 * EVENT_ASSOC_TIMED_OUT - Association timed out
3077 EVENT_ASSOC_TIMED_OUT,
3080 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
3085 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3087 EVENT_WPS_BUTTON_PUSHED,
3090 * EVENT_TX_STATUS - Report TX status
3095 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3097 EVENT_RX_FROM_UNKNOWN,
3100 * EVENT_RX_MGMT - Report RX of a management frame
3105 * EVENT_RX_ACTION - Action frame received
3107 * This event is used to indicate when an Action frame has been
3108 * received. Information about the received frame is included in
3109 * union wpa_event_data::rx_action.
3114 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3116 * This event is used to indicate when the driver has started the
3117 * requested remain-on-channel duration. Information about the
3118 * operation is included in union wpa_event_data::remain_on_channel.
3120 EVENT_REMAIN_ON_CHANNEL,
3123 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3125 * This event is used to indicate when the driver has completed
3126 * remain-on-channel duration, i.e., may noot be available on the
3127 * requested channel anymore. Information about the
3128 * operation is included in union wpa_event_data::remain_on_channel.
3130 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3133 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
3135 * This event is used only by driver_test.c and userspace MLME.
3140 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3142 * This event is used to indicate when a Probe Request frame has been
3143 * received. Information about the received frame is included in
3144 * union wpa_event_data::rx_probe_req. The driver is required to report
3145 * these events only after successfully completed probe_req_report()
3146 * commands to request the events (i.e., report parameter is non-zero)
3147 * in station mode. In AP mode, Probe Request frames should always be
3153 * EVENT_NEW_STA - New wired device noticed
3155 * This event is used to indicate that a new device has been detected
3156 * in a network that does not use association-like functionality (i.e.,
3157 * mainly wired Ethernet). This can be used to start EAPOL
3158 * authenticator when receiving a frame from a device. The address of
3159 * the device is included in union wpa_event_data::new_sta.
3164 * EVENT_EAPOL_RX - Report received EAPOL frame
3166 * When in AP mode with hostapd, this event is required to be used to
3167 * deliver the receive EAPOL frames from the driver. With
3168 * %wpa_supplicant, this event is used only if the send_eapol() handler
3169 * is used to override the use of l2_packet for EAPOL frame TX.
3174 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3176 * This event is used to indicate changes in the signal strength
3177 * observed in frames received from the current AP if signal strength
3178 * monitoring has been enabled with signal_monitor().
3180 EVENT_SIGNAL_CHANGE,
3183 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3185 * This event is used to indicate that the interface was enabled after
3186 * having been previously disabled, e.g., due to rfkill.
3188 EVENT_INTERFACE_ENABLED,
3191 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3193 * This event is used to indicate that the interface was disabled,
3194 * e.g., due to rfkill.
3196 EVENT_INTERFACE_DISABLED,
3199 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3201 * This event is used to indicate that the channel list has changed,
3202 * e.g., because of a regulatory domain change triggered by scan
3203 * results including an AP advertising a country code.
3205 EVENT_CHANNEL_LIST_CHANGED,
3208 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3210 * This event is used to indicate that the driver cannot maintain this
3211 * interface in its operation mode anymore. The most likely use for
3212 * this is to indicate that AP mode operation is not available due to
3213 * operating channel would need to be changed to a DFS channel when
3214 * the driver does not support radar detection and another virtual
3215 * interfaces caused the operating channel to change. Other similar
3216 * resource conflicts could also trigger this for station mode
3219 EVENT_INTERFACE_UNAVAILABLE,
3222 * EVENT_BEST_CHANNEL
3224 * Driver generates this event whenever it detects a better channel
3225 * (e.g., based on RSSI or channel use). This information can be used
3226 * to improve channel selection for a new AP/P2P group.
3231 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3233 * This event should be called when a Deauthentication frame is dropped
3234 * due to it not being protected (MFP/IEEE 802.11w).
3235 * union wpa_event_data::unprot_deauth is required to provide more
3236 * details of the frame.
3238 EVENT_UNPROT_DEAUTH,
3241 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3243 * This event should be called when a Disassociation frame is dropped
3244 * due to it not being protected (MFP/IEEE 802.11w).
3245 * union wpa_event_data::unprot_disassoc is required to provide more
3246 * details of the frame.
3248 EVENT_UNPROT_DISASSOC,
3251 * EVENT_STATION_LOW_ACK
3253 * Driver generates this event whenever it detected that a particular
3254 * station was lost. Detection can be through massive transmission
3255 * failures for example.
3257 EVENT_STATION_LOW_ACK,
3260 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
3262 * This event is used only if the driver implements P2P management
3263 * internally. Event data is stored in
3264 * union wpa_event_data::p2p_dev_found.
3266 EVENT_P2P_DEV_FOUND,
3269 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
3271 * This event is used only if the driver implements P2P management
3272 * internally. Event data is stored in
3273 * union wpa_event_data::p2p_go_neg_req_rx.
3275 EVENT_P2P_GO_NEG_REQ_RX,
3278 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
3280 * This event is used only if the driver implements P2P management
3281 * internally. Event data is stored in
3282 * union wpa_event_data::p2p_go_neg_completed.
3284 EVENT_P2P_GO_NEG_COMPLETED,
3286 EVENT_P2P_PROV_DISC_REQUEST,
3287 EVENT_P2P_PROV_DISC_RESPONSE,
3288 EVENT_P2P_SD_REQUEST,
3289 EVENT_P2P_SD_RESPONSE,
3292 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3294 EVENT_IBSS_PEER_LOST,
3297 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3299 * This event carries the new replay counter to notify wpa_supplicant
3300 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3301 * completed Group Key Handshake while the host (including
3302 * wpa_supplicant was sleeping).
3304 EVENT_DRIVER_GTK_REKEY,
3307 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3309 EVENT_SCHED_SCAN_STOPPED,
3312 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3314 * This event indicates that the station responded to the poll
3315 * initiated with @poll_client.
3317 EVENT_DRIVER_CLIENT_POLL_OK,
3320 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3322 EVENT_EAPOL_TX_STATUS,
3325 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3327 * Described in wpa_event_data.ch_switch
3332 * EVENT_WNM - Request WNM operation
3334 * This event can be used to request a WNM operation to be performed.
3339 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3341 * This event indicates that the driver reported a connection failure
3342 * with the specified client (for example, max client reached, etc.) in
3345 EVENT_CONNECT_FAILED_REASON,
3348 * EVENT_RADAR_DETECTED - Notify of radar detection
3350 * A radar has been detected on the supplied frequency, hostapd should
3351 * react accordingly (e.g., change channel).
3353 EVENT_DFS_RADAR_DETECTED,
3356 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3358 * After a successful CAC, the channel can be marked clear and used.
3360 EVENT_DFS_CAC_FINISHED,
3363 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3365 * The CAC was not successful, and the channel remains in the previous
3366 * state. This may happen due to a radar beeing detected or other
3367 * external influences.
3369 EVENT_DFS_CAC_ABORTED,
3372 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3374 * The channel which was previously unavailable is now available again.
3376 EVENT_DFS_NOP_FINISHED,
3379 * EVENT_SURVEY - Received survey data
3381 * This event gets triggered when a driver query is issued for survey
3382 * data and the requested data becomes available. The returned data is
3383 * stored in struct survey_results. The results provide at most one
3384 * survey entry for each frequency and at minimum will provide one survey
3385 * entry for one frequency. The survey data can be os_malloc()'d and
3386 * then os_free()'d, so the event callback must only copy data.
3393 * struct freq_survey - Channel survey info
3395 * @ifidx: Interface index in which this survey was observed
3396 * @freq: Center of frequency of the surveyed channel
3397 * @nf: Channel noise floor in dBm
3398 * @channel_time: Amount of time in ms the radio spent on the channel
3399 * @channel_time_busy: Amount of time in ms the radio detected some signal
3400 * that indicated to the radio the channel was not clear
3401 * @channel_time_rx: Amount of time the radio spent receiving data
3402 * @channel_time_tx: Amount of time the radio spent transmitting data
3403 * @filled: bitmask indicating which fields have been reported, see
3404 * SURVEY_HAS_* defines.
3405 * @list: Internal list pointers
3407 struct freq_survey {
3412 u64 channel_time_busy;
3413 u64 channel_time_rx;
3414 u64 channel_time_tx;
3415 unsigned int filled;
3416 struct dl_list list;
3419 #define SURVEY_HAS_NF BIT(0)
3420 #define SURVEY_HAS_CHAN_TIME BIT(1)
3421 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3422 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3423 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3427 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3429 union wpa_event_data {
3431 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3433 * This structure is optional for EVENT_ASSOC calls and required for
3434 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3435 * driver interface does not need to generate separate EVENT_ASSOCINFO
3440 * reassoc - Flag to indicate association or reassociation
3445 * req_ies - (Re)Association Request IEs
3447 * If the driver generates WPA/RSN IE, this event data must be
3448 * returned for WPA handshake to have needed information. If
3449 * wpa_supplicant-generated WPA/RSN IE is used, this
3450 * information event is optional.
3452 * This should start with the first IE (fixed fields before IEs
3453 * are not included).
3458 * req_ies_len - Length of req_ies in bytes
3463 * resp_ies - (Re)Association Response IEs
3465 * Optional association data from the driver. This data is not
3466 * required WPA, but may be useful for some protocols and as
3467 * such, should be reported if this is available to the driver
3470 * This should start with the first IE (fixed fields before IEs
3471 * are not included).
3476 * resp_ies_len - Length of resp_ies in bytes
3478 size_t resp_ies_len;
3481 * beacon_ies - Beacon or Probe Response IEs
3483 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3484 * Probe Response frames from the current AP (i.e., the one
3485 * that the client just associated with). This information is
3486 * used to update WPA/RSN IE for the AP. If this field is not
3487 * set, the results from previous scan will be used. If no
3488 * data for the new AP is found, scan results will be requested
3489 * again (without scan request). At this point, the driver is
3490 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3493 * This should start with the first IE (fixed fields before IEs
3494 * are not included).
3496 const u8 *beacon_ies;
3499 * beacon_ies_len - Length of beacon_ies */
3500 size_t beacon_ies_len;
3503 * freq - Frequency of the operational channel in MHz
3508 * addr - Station address (for AP mode)
3514 * struct disassoc_info - Data for EVENT_DISASSOC events
3516 struct disassoc_info {
3518 * addr - Station address (for AP mode)
3523 * reason_code - Reason Code (host byte order) used in
3524 * Deauthentication frame
3529 * ie - Optional IE(s) in Disassociation frame
3534 * ie_len - Length of ie buffer in octets
3539 * locally_generated - Whether the frame was locally generated
3541 int locally_generated;
3545 * struct deauth_info - Data for EVENT_DEAUTH events
3547 struct deauth_info {
3549 * addr - Station address (for AP mode)
3554 * reason_code - Reason Code (host byte order) used in
3555 * Deauthentication frame
3560 * ie - Optional IE(s) in Deauthentication frame
3565 * ie_len - Length of ie buffer in octets
3570 * locally_generated - Whether the frame was locally generated
3572 int locally_generated;
3576 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3578 struct michael_mic_failure {
3581 } michael_mic_failure;
3584 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3586 struct interface_status {
3589 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3594 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3596 struct pmkid_candidate {
3597 /** BSSID of the PMKID candidate */
3599 /** Smaller the index, higher the priority */
3601 /** Whether RSN IE includes pre-authenticate flag */
3606 * struct stkstart - Data for EVENT_STKSTART
3613 * struct tdls - Data for EVENT_TDLS
3619 TDLS_REQUEST_TEARDOWN
3621 u16 reason_code; /* for teardown */
3625 * struct wnm - Data for EVENT_WNM
3643 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3645 * During FT (IEEE 802.11r) authentication sequence, the driver is
3646 * expected to use this event to report received FT IEs (MDIE, FTIE,
3647 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3648 * IEs for the next message will be delivered through the
3649 * struct wpa_driver_ops::update_ft_ies() callback.
3655 u8 target_ap[ETH_ALEN];
3656 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3658 /** Length of ric_ies buffer in octets */
3663 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3665 struct ibss_rsn_start {
3670 * struct auth_info - Data for EVENT_AUTH events
3676 u16 auth_transaction;
3683 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3685 struct assoc_reject {
3687 * bssid - BSSID of the AP that rejected association
3692 * resp_ies - (Re)Association Response IEs
3694 * Optional association data from the driver. This data is not
3695 * required WPA, but may be useful for some protocols and as
3696 * such, should be reported if this is available to the driver
3699 * This should start with the first IE (fixed fields before IEs
3700 * are not included).
3705 * resp_ies_len - Length of resp_ies in bytes
3707 size_t resp_ies_len;
3710 * status_code - Status Code from (Re)association Response
3715 struct timeout_event {
3720 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3729 * struct tx_status - Data for EVENT_TX_STATUS events
3741 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3743 struct rx_from_unknown {
3750 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3756 int ssi_signal; /* dBm */
3760 * struct rx_action - Data for EVENT_RX_ACTION events
3764 * da - Destination address of the received Action frame
3769 * sa - Source address of the received Action frame
3774 * bssid - Address 3 of the received Action frame
3779 * category - Action frame category
3784 * data - Action frame body after category field
3789 * len - Length of data in octets
3794 * freq - Frequency (in MHz) on which the frame was received
3800 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3802 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3804 struct remain_on_channel {
3806 * freq - Channel frequency in MHz
3811 * duration - Duration to remain on the channel in milliseconds
3813 unsigned int duration;
3814 } remain_on_channel;
3817 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3818 * @aborted: Whether the scan was aborted
3819 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3820 * @num_freqs: Number of entries in freqs array
3821 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3823 * @num_ssids: Number of entries in ssids array
3829 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3834 * struct mlme_rx - Data for EVENT_MLME_RX events
3845 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3847 struct rx_probe_req {
3849 * sa - Source address of the received Probe Request frame
3854 * da - Destination address of the received Probe Request frame
3855 * or %NULL if not available
3860 * bssid - BSSID of the received Probe Request frame or %NULL
3866 * ie - IEs from the Probe Request body
3871 * ie_len - Length of ie buffer in octets
3876 * signal - signal strength in dBm (or 0 if not available)
3882 * struct new_sta - Data for EVENT_NEW_STA events
3889 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3898 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3900 struct wpa_signal_info signal_change;
3903 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3904 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3905 * @freq_5: Best 5 GHz band channel frequency in MHz
3906 * @freq_overall: Best channel frequency in MHz
3908 * 0 can be used to indicate no preference in either band.
3910 struct best_channel {
3916 struct unprot_deauth {
3922 struct unprot_disassoc {
3929 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3930 * @addr: station address
3937 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3939 struct p2p_dev_found {
3942 const u8 *pri_dev_type;
3943 const char *dev_name;
3950 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3952 struct p2p_go_neg_req_rx {
3955 } p2p_go_neg_req_rx;
3958 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3960 struct p2p_go_neg_completed {
3961 struct p2p_go_neg_results *res;
3962 } p2p_go_neg_completed;
3964 struct p2p_prov_disc_req {
3968 const u8 *pri_dev_type;
3969 const char *dev_name;
3970 u16 supp_config_methods;
3973 } p2p_prov_disc_req;
3975 struct p2p_prov_disc_resp {
3978 } p2p_prov_disc_resp;
3989 struct p2p_sd_resp {
3997 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3999 struct ibss_peer_lost {
4004 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4006 struct driver_gtk_rekey {
4008 const u8 *replay_ctr;
4012 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4013 * @addr: station address
4015 struct client_poll {
4020 * struct eapol_tx_status
4021 * @dst: Original destination
4022 * @data: Data starting with IEEE 802.1X header (!)
4023 * @data_len: Length of data
4024 * @ack: Indicates ack or lost frame
4026 * This corresponds to hapd_send_eapol if the frame sent
4027 * there isn't just reported as EVENT_TX_STATUS.
4029 struct eapol_tx_status {
4038 * @freq: Frequency of new channel in MHz
4039 * @ht_enabled: Whether this is an HT channel
4040 * @ch_offset: Secondary channel offset
4041 * @ch_width: Channel width
4042 * @cf1: Center frequency 1
4043 * @cf2: Center frequency 2
4049 enum chan_width ch_width;
4055 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4056 * @addr: Remote client address
4057 * @code: Reason code for connection failure
4059 struct connect_failed_reason {
4065 } connect_failed_reason;
4068 * struct dfs_event - Data for radar detected events
4069 * @freq: Frequency of the channel in MHz
4075 enum chan_width chan_width;
4081 * survey_results - Survey result data for EVENT_SURVEY
4082 * @freq_filter: Requested frequency survey filter, 0 if request
4083 * was for all survey data
4084 * @survey_list: Linked list of survey data
4086 struct survey_results {
4087 unsigned int freq_filter;
4088 struct dl_list survey_list; /* struct freq_survey */
4092 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4093 * @initiator: Initiator of the regulatory change
4095 struct channel_list_changed {
4096 enum reg_change_initiator initiator;
4097 } channel_list_changed;
4101 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4102 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4103 * with struct wpa_driver_ops::init()
4104 * @event: event type (defined above)
4105 * @data: possible extra data for the event
4107 * Driver wrapper code should call this function whenever an event is received
4110 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4111 union wpa_event_data *data);
4115 * The following inline functions are provided for convenience to simplify
4116 * event indication for some of the common events.
4119 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4120 size_t ielen, int reassoc)
4122 union wpa_event_data event;
4123 os_memset(&event, 0, sizeof(event));
4124 event.assoc_info.reassoc = reassoc;
4125 event.assoc_info.req_ies = ie;
4126 event.assoc_info.req_ies_len = ielen;
4127 event.assoc_info.addr = addr;
4128 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4131 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4133 union wpa_event_data event;
4134 os_memset(&event, 0, sizeof(event));
4135 event.disassoc_info.addr = addr;
4136 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4139 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4142 union wpa_event_data event;
4143 os_memset(&event, 0, sizeof(event));
4144 event.eapol_rx.src = src;
4145 event.eapol_rx.data = data;
4146 event.eapol_rx.data_len = data_len;
4147 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4150 /* driver_common.c */
4151 void wpa_scan_results_free(struct wpa_scan_results *res);
4153 /* Convert wpa_event_type to a string for logging */
4154 const char * event_to_string(enum wpa_event_type event);
4156 #endif /* DRIVER_H */