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"
24 #define HOSTAPD_CHAN_DISABLED 0x00000001
25 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
26 #define HOSTAPD_CHAN_NO_IBSS 0x00000004
27 #define HOSTAPD_CHAN_RADAR 0x00000008
28 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
29 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
30 #define HOSTAPD_CHAN_HT40 0x00000040
33 * struct hostapd_channel_data - Channel information
35 struct hostapd_channel_data {
37 * chan - Channel number (IEEE 802.11)
42 * freq - Frequency in MHz
47 * flag - Channel flags (HOSTAPD_CHAN_*)
52 * max_tx_power - maximum transmit power in dBm
57 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
60 * struct hostapd_hw_modes - Supported hardware mode information
62 struct hostapd_hw_modes {
64 * mode - Hardware mode
66 enum hostapd_hw_mode mode;
69 * num_channels - Number of entries in the channels array
74 * channels - Array of supported channels
76 struct hostapd_channel_data *channels;
79 * num_rates - Number of entries in the rates array
84 * rates - Array of supported rates in 100 kbps units
89 * ht_capab - HT (IEEE 802.11n) capabilities
94 * mcs_set - MCS (IEEE 802.11n) rate parameters
99 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
103 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
107 #define IEEE80211_MODE_INFRA 0
108 #define IEEE80211_MODE_IBSS 1
109 #define IEEE80211_MODE_AP 2
111 #define IEEE80211_CAP_ESS 0x0001
112 #define IEEE80211_CAP_IBSS 0x0002
113 #define IEEE80211_CAP_PRIVACY 0x0010
115 #define WPA_SCAN_QUAL_INVALID BIT(0)
116 #define WPA_SCAN_NOISE_INVALID BIT(1)
117 #define WPA_SCAN_LEVEL_INVALID BIT(2)
118 #define WPA_SCAN_LEVEL_DBM BIT(3)
119 #define WPA_SCAN_AUTHENTICATED BIT(4)
120 #define WPA_SCAN_ASSOCIATED BIT(5)
123 * struct wpa_scan_res - Scan result for an BSS/IBSS
124 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
126 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
127 * @beacon_int: beacon interval in TUs (host byte order)
128 * @caps: capability information field in host byte order
129 * @qual: signal quality
130 * @noise: noise level
131 * @level: signal level
133 * @age: Age of the information in milliseconds (i.e., how many milliseconds
134 * ago the last Beacon or Probe Response frame was received)
135 * @ie_len: length of the following IE field in octets
136 * @beacon_ie_len: length of the following Beacon IE field in octets
138 * This structure is used as a generic format for scan results from the
139 * driver. Each driver interface implementation is responsible for converting
140 * the driver or OS specific scan results into this format.
142 * If the driver does not support reporting all IEs, the IE data structure is
143 * constructed of the IEs that are available. This field will also need to
144 * include SSID in IE format. All drivers are encouraged to be extended to
145 * report all IEs to make it easier to support future additions.
147 struct wpa_scan_res {
159 size_t beacon_ie_len;
161 * Followed by ie_len octets of IEs from Probe Response frame (or if
162 * the driver does not indicate source of IEs, these may also be from
163 * Beacon frame). After the first set of IEs, another set of IEs may
164 * follow (with beacon_ie_len octets of data) if the driver provides
170 * struct wpa_scan_results - Scan results
171 * @res: Array of pointers to allocated variable length scan result entries
172 * @num: Number of entries in the scan result array
174 struct wpa_scan_results {
175 struct wpa_scan_res **res;
180 * struct wpa_interface_info - Network interface information
181 * @next: Pointer to the next interface or NULL if this is the last one
182 * @ifname: Interface name that can be used with init() or init2()
183 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
185 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
186 * is not an allocated copy, i.e., get_interfaces() caller will not free
189 struct wpa_interface_info {
190 struct wpa_interface_info *next;
193 const char *drv_name;
196 #define WPAS_MAX_SCAN_SSIDS 16
199 * struct wpa_driver_scan_params - Scan parameters
200 * Data for struct wpa_driver_ops::scan2().
202 struct wpa_driver_scan_params {
204 * ssids - SSIDs to scan for
206 struct wpa_driver_scan_ssid {
208 * ssid - specific SSID to scan for (ProbeReq)
209 * %NULL or zero-length SSID is used to indicate active scan
210 * with wildcard SSID.
214 * ssid_len: Length of the SSID in octets
217 } ssids[WPAS_MAX_SCAN_SSIDS];
220 * num_ssids - Number of entries in ssids array
221 * Zero indicates a request for a passive scan.
226 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
231 * extra_ies_len - Length of extra_ies in octets
233 size_t extra_ies_len;
236 * freqs - Array of frequencies to scan or %NULL for all frequencies
238 * The frequency is set in MHz. The array is zero-terminated.
243 * filter_ssids - Filter for reporting SSIDs
245 * This optional parameter can be used to request the driver wrapper to
246 * filter scan results to include only the specified SSIDs. %NULL
247 * indicates that no filtering is to be done. This can be used to
248 * reduce memory needs for scan results in environments that have large
249 * number of APs with different SSIDs.
251 * The driver wrapper is allowed to take this allocated buffer into its
252 * own use by setting the pointer to %NULL. In that case, the driver
253 * wrapper is responsible for freeing the buffer with os_free() once it
254 * is not needed anymore.
256 struct wpa_driver_scan_filter {
262 * num_filter_ssids - Number of entries in filter_ssids array
264 size_t num_filter_ssids;
267 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
269 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
270 * Mbps from the support rates element(s) in the Probe Request frames
271 * and not to transmit the frames at any of those rates.
277 * struct wpa_driver_auth_params - Authentication parameters
278 * Data for struct wpa_driver_ops::authenticate().
280 struct wpa_driver_auth_params {
288 const u8 *wep_key[4];
289 size_t wep_key_len[4];
291 int local_state_change;
294 * p2p - Whether this connection is a P2P group
301 WPS_MODE_NONE /* no WPS provisioning being used */,
302 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
303 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
308 * struct wpa_driver_associate_params - Association parameters
309 * Data for struct wpa_driver_ops::associate().
311 struct wpa_driver_associate_params {
313 * bssid - BSSID of the selected AP
314 * This can be %NULL, if ap_scan=2 mode is used and the driver is
315 * responsible for selecting with which BSS to associate. */
319 * ssid - The selected SSID
324 * ssid_len - Length of the SSID (1..32)
329 * freq - Frequency of the channel the selected AP is using
330 * Frequency that the selected AP is using (in MHz as
331 * reported in the scan results)
336 * bg_scan_period - Background scan period in seconds, 0 to disable
337 * background scan, or -1 to indicate no change to default driver
343 * wpa_ie - WPA information element for (Re)Association Request
344 * WPA information element to be included in (Re)Association
345 * Request (including information element id and length). Use
346 * of this WPA IE is optional. If the driver generates the WPA
347 * IE, it can use pairwise_suite, group_suite, and
348 * key_mgmt_suite to select proper algorithms. In this case,
349 * the driver has to notify wpa_supplicant about the used WPA
350 * IE by generating an event that the interface code will
351 * convert into EVENT_ASSOCINFO data (see below).
353 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
354 * instead. The driver can determine which version is used by
355 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
358 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
363 * wpa_ie_len - length of the wpa_ie
368 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
370 unsigned int wpa_proto;
373 * pairwise_suite - Selected pairwise cipher suite
375 * This is usually ignored if @wpa_ie is used.
377 enum wpa_cipher pairwise_suite;
380 * group_suite - Selected group cipher suite
382 * This is usually ignored if @wpa_ie is used.
384 enum wpa_cipher group_suite;
387 * key_mgmt_suite - Selected key management suite
389 * This is usually ignored if @wpa_ie is used.
391 enum wpa_key_mgmt key_mgmt_suite;
394 * auth_alg - Allowed authentication algorithms
395 * Bit field of WPA_AUTH_ALG_*
400 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
405 * wep_key - WEP keys for static WEP configuration
407 const u8 *wep_key[4];
410 * wep_key_len - WEP key length for static WEP configuration
412 size_t wep_key_len[4];
415 * wep_tx_keyidx - WEP TX key index for static WEP configuration
420 * mgmt_frame_protection - IEEE 802.11w management frame protection
422 enum mfp_options mgmt_frame_protection;
425 * ft_ies - IEEE 802.11r / FT information elements
426 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
427 * for fast transition, this parameter is set to include the IEs that
428 * are to be sent in the next FT Authentication Request message.
429 * update_ft_ies() handler is called to update the IEs for further
430 * FT messages in the sequence.
432 * The driver should use these IEs only if the target AP is advertising
433 * the same mobility domain as the one included in the MDIE here.
435 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
436 * AP after the initial association. These IEs can only be used if the
437 * target AP is advertising support for FT and is using the same MDIE
438 * and SSID as the current AP.
440 * The driver is responsible for reporting the FT IEs received from the
441 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
442 * type. update_ft_ies() handler will then be called with the FT IEs to
443 * include in the next frame in the authentication sequence.
448 * ft_ies_len - Length of ft_ies in bytes
453 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
455 * This value is provided to allow the driver interface easier access
456 * to the current mobility domain. This value is set to %NULL if no
457 * mobility domain is currently active.
462 * passphrase - RSN passphrase for PSK
464 * This value is made available only for WPA/WPA2-Personal (PSK) and
465 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
466 * the 8..63 character ASCII passphrase, if available. Please note that
467 * this can be %NULL if passphrase was not used to generate the PSK. In
468 * that case, the psk field must be used to fetch the PSK.
470 const char *passphrase;
473 * psk - RSN PSK (alternative for passphrase for PSK)
475 * This value is made available only for WPA/WPA2-Personal (PSK) and
476 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
477 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
478 * be prepared to handle %NULL value as an error.
483 * drop_unencrypted - Enable/disable unencrypted frame filtering
485 * Configure the driver to drop all non-EAPOL frames (both receive and
486 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
487 * still be allowed for key negotiation.
489 int drop_unencrypted;
492 * prev_bssid - Previously used BSSID in this ESS
494 * When not %NULL, this is a request to use reassociation instead of
497 const u8 *prev_bssid;
502 * If the driver needs to do special configuration for WPS association,
503 * this variable provides more information on what type of association
504 * is being requested. Most drivers should not need ot use this.
509 * p2p - Whether this connection is a P2P group
514 * uapsd - UAPSD parameters for the network
515 * -1 = do not change defaults
516 * AP mode: 1 = enabled, 0 = disabled
517 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
522 * fixed_bssid - Whether to force this BSSID in IBSS mode
523 * 1 = Fix this BSSID and prevent merges.
524 * 0 = Do not fix BSSID.
529 * disable_ht - Disable HT (IEEE 802.11n) for this connection
534 * HT Capabilities over-rides. Only bits set in the mask will be used,
535 * and not all values are used by the kernel anyway. Currently, MCS,
536 * MPDU and MSDU fields are used.
538 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */
539 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */
544 HIDDEN_SSID_ZERO_LEN,
545 HIDDEN_SSID_ZERO_CONTENTS
548 struct wpa_driver_ap_params {
550 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
555 * head_len - Length of the head buffer in octets
560 * tail - Beacon tail following TIM IE
565 * tail_len - Length of the tail buffer in octets
570 * dtim_period - DTIM period
575 * beacon_int - Beacon interval
580 * basic_rates: -1 terminated array of basic rates in 100 kbps
582 * This parameter can be used to set a specific basic rate set for the
583 * BSS. If %NULL, default basic rate set is used.
588 * proberesp - Probe Response template
590 * This is used by drivers that reply to Probe Requests internally in
591 * AP mode and require the full Probe Response template.
596 * proberesp_len - Length of the proberesp buffer in octets
598 size_t proberesp_len;
601 * ssid - The SSID to use in Beacon/Probe Response frames
606 * ssid_len - Length of the SSID (1..32)
611 * hide_ssid - Whether to hide the SSID
613 enum hide_ssid hide_ssid;
616 * pairwise_ciphers - WPA_CIPHER_* bitfield
618 unsigned int pairwise_ciphers;
621 * group_cipher - WPA_CIPHER_*
623 unsigned int group_cipher;
626 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
628 unsigned int key_mgmt_suites;
631 * auth_algs - WPA_AUTH_ALG_* bitfield
633 unsigned int auth_algs;
636 * wpa_version - WPA_PROTO_* bitfield
638 unsigned int wpa_version;
641 * privacy - Whether privacy is used in the BSS
646 * beacon_ies - WPS/P2P IE(s) for Beacon frames
648 * This is used to add IEs like WPS IE and P2P IE by drivers that do
649 * not use the full Beacon template.
651 const struct wpabuf *beacon_ies;
654 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
656 * This is used to add IEs like WPS IE and P2P IE by drivers that
657 * reply to Probe Request frames internally.
659 const struct wpabuf *proberesp_ies;
662 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
664 * This is used to add IEs like WPS IE by drivers that reply to
665 * (Re)Association Request frames internally.
667 const struct wpabuf *assocresp_ies;
670 * isolate - Whether to isolate frames between associated stations
672 * If this is non-zero, the AP is requested to disable forwarding of
673 * frames between associated stations.
678 * cts_protect - Whether CTS protection is enabled
683 * preamble - Whether short preamble is enabled
688 * short_slot_time - Whether short slot time is enabled
690 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
691 * not set (e.g., when 802.11g mode is not in use)
696 * ht_opmode - HT operation mode or -1 if HT not in use
701 * interworking - Whether Interworking is enabled
706 * hessid - Homogeneous ESS identifier or %NULL if not set
711 * access_network_type - Access Network Type (0..15)
713 * This is used for filtering Probe Request frames when Interworking is
716 u8 access_network_type;
719 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
721 * This is used by driver which advertises this capability.
723 int ap_max_inactivity;
727 * struct wpa_driver_capa - Driver capability information
729 struct wpa_driver_capa {
730 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
731 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
732 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
733 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
734 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
735 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
736 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
737 unsigned int key_mgmt;
739 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
740 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
741 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
742 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
745 #define WPA_DRIVER_AUTH_OPEN 0x00000001
746 #define WPA_DRIVER_AUTH_SHARED 0x00000002
747 #define WPA_DRIVER_AUTH_LEAP 0x00000004
750 /* Driver generated WPA/RSN IE */
751 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
752 /* Driver needs static WEP key setup after association command */
753 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
754 /* unused: 0x00000004 */
755 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
756 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
757 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
758 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
759 /* Driver provides separate commands for authentication and association (SME in
760 * wpa_supplicant). */
761 #define WPA_DRIVER_FLAGS_SME 0x00000020
762 /* Driver supports AP mode */
763 #define WPA_DRIVER_FLAGS_AP 0x00000040
764 /* Driver needs static WEP key setup after association has been completed */
765 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
766 /* Driver takes care of P2P management operations */
767 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
768 /* Driver supports concurrent P2P operations */
769 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
771 * Driver uses the initial interface as a dedicated management interface, i.e.,
772 * it cannot be used for P2P group operations or non-P2P purposes.
774 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
775 /* This interface is P2P capable (P2P Device, GO, or P2P Client */
776 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
777 /* Driver supports concurrent operations on multiple channels */
778 #define WPA_DRIVER_FLAGS_MULTI_CHANNEL_CONCURRENT 0x00001000
780 * Driver uses the initial interface for P2P management interface and non-P2P
781 * purposes (e.g., connect to infra AP), but this interface cannot be used for
782 * P2P group operations.
784 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
786 * Driver is known to use sane error codes, i.e., when it indicates that
787 * something (e.g., association) fails, there was indeed a failure and the
788 * operation does not end up getting completed successfully later.
790 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
791 /* Driver supports off-channel TX */
792 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
793 /* Driver indicates TX status events for EAPOL Data frames */
794 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
795 /* Driver indicates TX status events for Deauth/Disassoc frames */
796 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
797 /* Driver supports roaming (BSS selection) in firmware */
798 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
799 /* Driver supports operating as a TDLS peer */
800 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
801 /* Driver requires external TDLS setup/teardown/discovery */
802 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
803 /* Driver indicates support for Probe Response offloading in AP mode */
804 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
805 /* Driver supports U-APSD in AP mode */
806 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
807 /* Driver supports inactivity timer in AP mode */
808 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
812 int max_sched_scan_ssids;
813 int sched_scan_supported;
817 * max_remain_on_chan - Maximum remain-on-channel duration in msec
819 unsigned int max_remain_on_chan;
822 * max_stations - Maximum number of associated stations the driver
823 * supports in AP mode
825 unsigned int max_stations;
828 * probe_resp_offloads - Bitmap of supported protocols by the driver
829 * for Probe Response offloading.
831 /* Driver Probe Response offloading support for WPS ver. 1 */
832 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
833 /* Driver Probe Response offloading support for WPS ver. 2 */
834 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
835 /* Driver Probe Response offloading support for P2P */
836 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
837 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
838 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
839 unsigned int probe_resp_offloads;
845 struct hostap_sta_driver_data {
846 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
847 unsigned long current_tx_rate;
848 unsigned long inactive_msec;
850 unsigned long num_ps_buf_frames;
851 unsigned long tx_retry_failed;
852 unsigned long tx_retry_count;
857 struct hostapd_sta_add_params {
861 const u8 *supp_rates;
862 size_t supp_rates_len;
864 const struct ieee80211_ht_capabilities *ht_capabilities;
865 u32 flags; /* bitmask of WPA_STA_* flags */
866 int set; /* Set STA parameters instead of add */
870 struct hostapd_freq_params {
875 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
876 * secondary channel below primary, 1 = HT40
877 * enabled, secondary channel above primary */
880 enum wpa_driver_if_type {
882 * WPA_IF_STATION - Station mode interface
887 * WPA_IF_AP_VLAN - AP mode VLAN interface
889 * This interface shares its address and Beacon frame with the main
895 * WPA_IF_AP_BSS - AP mode BSS interface
897 * This interface has its own address and Beacon frame.
902 * WPA_IF_P2P_GO - P2P Group Owner
907 * WPA_IF_P2P_CLIENT - P2P Client
912 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
913 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
918 struct wpa_init_params {
924 const char *test_socket;
925 int use_pae_group_addr;
929 u8 *own_addr; /* buffer for writing own MAC address */
933 struct wpa_bss_params {
934 /** Interface name (for multi-SSID/VLAN support) */
936 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
945 enum mfp_options ieee80211w;
948 #define WPA_STA_AUTHORIZED BIT(0)
949 #define WPA_STA_WMM BIT(1)
950 #define WPA_STA_SHORT_PREAMBLE BIT(2)
951 #define WPA_STA_MFP BIT(3)
952 #define WPA_STA_TDLS_PEER BIT(4)
955 * struct p2p_params - P2P parameters for driver-based P2P management
958 const char *dev_name;
960 #define DRV_MAX_SEC_DEV_TYPES 5
961 u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8];
962 size_t num_sec_dev_types;
976 * struct wpa_signal_info - Information about channel signal quality
978 struct wpa_signal_info {
987 * struct wpa_driver_ops - Driver interface API definition
989 * This structure defines the API that each driver interface needs to implement
990 * for core wpa_supplicant code. All driver specific functionality is captured
993 struct wpa_driver_ops {
994 /** Name of the driver interface */
996 /** One line description of the driver interface */
1000 * get_bssid - Get the current BSSID
1001 * @priv: private driver interface data
1002 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1004 * Returns: 0 on success, -1 on failure
1006 * Query kernel driver for the current BSSID and copy it to bssid.
1007 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1010 int (*get_bssid)(void *priv, u8 *bssid);
1013 * get_ssid - Get the current SSID
1014 * @priv: private driver interface data
1015 * @ssid: buffer for SSID (at least 32 bytes)
1017 * Returns: Length of the SSID on success, -1 on failure
1019 * Query kernel driver for the current SSID and copy it to ssid.
1020 * Returning zero is recommended if the STA is not associated.
1022 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1023 * can, at least in theory, contain control characters (including nul)
1024 * and as such, should be processed as binary data, not a printable
1027 int (*get_ssid)(void *priv, u8 *ssid);
1030 * set_key - Configure encryption key
1031 * @ifname: Interface name (for multi-SSID/VLAN support)
1032 * @priv: private driver interface data
1033 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1034 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
1035 * %WPA_ALG_NONE clears the key.
1036 * @addr: Address of the peer STA (BSSID of the current AP when setting
1037 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1038 * broadcast keys, %NULL for default keys that are used both for
1039 * broadcast and unicast; when clearing keys, %NULL is used to
1040 * indicate that both the broadcast-only and default key of the
1041 * specified key index is to be cleared
1042 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1044 * @set_tx: configure this key as the default Tx key (only used when
1045 * driver does not support separate unicast/individual key
1046 * @seq: sequence number/packet number, seq_len octets, the next
1047 * packet number to be used for in replay protection; configured
1048 * for Rx keys (in most cases, this is only used with broadcast
1049 * keys and set to zero for unicast keys); %NULL if not set
1050 * @seq_len: length of the seq, depends on the algorithm:
1051 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
1052 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1054 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1055 * TKIP: 32, CCMP: 16, IGTK: 16)
1057 * Returns: 0 on success, -1 on failure
1059 * Configure the given key for the kernel driver. If the driver
1060 * supports separate individual keys (4 default keys + 1 individual),
1061 * addr can be used to determine whether the key is default or
1062 * individual. If only 4 keys are supported, the default key with key
1063 * index 0 is used as the individual key. STA must be configured to use
1064 * it as the default Tx key (set_tx is set) and accept Rx for all the
1065 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1066 * broadcast keys, so key index 0 is available for this kind of
1069 * Please note that TKIP keys include separate TX and RX MIC keys and
1070 * some drivers may expect them in different order than wpa_supplicant
1071 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1072 * will trigger Michael MIC errors. This can be fixed by changing the
1073 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1074 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1075 * example on how this can be done.
1077 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1078 const u8 *addr, int key_idx, int set_tx,
1079 const u8 *seq, size_t seq_len,
1080 const u8 *key, size_t key_len);
1083 * init - Initialize driver interface
1084 * @ctx: context to be used when calling wpa_supplicant functions,
1085 * e.g., wpa_supplicant_event()
1086 * @ifname: interface name, e.g., wlan0
1088 * Returns: Pointer to private data, %NULL on failure
1090 * Initialize driver interface, including event processing for kernel
1091 * driver events (e.g., associated, scan results, Michael MIC failure).
1092 * This function can allocate a private configuration data area for
1093 * @ctx, file descriptor, interface name, etc. information that may be
1094 * needed in future driver operations. If this is not used, non-NULL
1095 * value will need to be returned because %NULL is used to indicate
1096 * failure. The returned value will be used as 'void *priv' data for
1097 * all other driver_ops functions.
1099 * The main event loop (eloop.c) of wpa_supplicant can be used to
1100 * register callback for read sockets (eloop_register_read_sock()).
1102 * See below for more information about events and
1103 * wpa_supplicant_event() function.
1105 void * (*init)(void *ctx, const char *ifname);
1108 * deinit - Deinitialize driver interface
1109 * @priv: private driver interface data from init()
1111 * Shut down driver interface and processing of driver events. Free
1112 * private data buffer if one was allocated in init() handler.
1114 void (*deinit)(void *priv);
1117 * set_param - Set driver configuration parameters
1118 * @priv: private driver interface data from init()
1119 * @param: driver specific configuration parameters
1121 * Returns: 0 on success, -1 on failure
1123 * Optional handler for notifying driver interface about configuration
1124 * parameters (driver_param).
1126 int (*set_param)(void *priv, const char *param);
1129 * set_countermeasures - Enable/disable TKIP countermeasures
1130 * @priv: private driver interface data
1131 * @enabled: 1 = countermeasures enabled, 0 = disabled
1133 * Returns: 0 on success, -1 on failure
1135 * Configure TKIP countermeasures. When these are enabled, the driver
1136 * should drop all received and queued frames that are using TKIP.
1138 int (*set_countermeasures)(void *priv, int enabled);
1141 * deauthenticate - Request driver to deauthenticate
1142 * @priv: private driver interface data
1143 * @addr: peer address (BSSID of the AP)
1144 * @reason_code: 16-bit reason code to be sent in the deauthentication
1147 * Returns: 0 on success, -1 on failure
1149 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1152 * disassociate - Request driver to disassociate
1153 * @priv: private driver interface data
1154 * @addr: peer address (BSSID of the AP)
1155 * @reason_code: 16-bit reason code to be sent in the disassociation
1158 * Returns: 0 on success, -1 on failure
1160 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
1163 * associate - Request driver to associate
1164 * @priv: private driver interface data
1165 * @params: association parameters
1167 * Returns: 0 on success, -1 on failure
1169 int (*associate)(void *priv,
1170 struct wpa_driver_associate_params *params);
1173 * add_pmkid - Add PMKSA cache entry to the driver
1174 * @priv: private driver interface data
1175 * @bssid: BSSID for the PMKSA cache entry
1176 * @pmkid: PMKID for the PMKSA cache entry
1178 * Returns: 0 on success, -1 on failure
1180 * This function is called when a new PMK is received, as a result of
1181 * either normal authentication or RSN pre-authentication.
1183 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1184 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1185 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1186 * driver_ops function does not need to be implemented. Likewise, if
1187 * the driver does not support WPA, this function is not needed.
1189 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1192 * remove_pmkid - Remove PMKSA cache entry to the driver
1193 * @priv: private driver interface data
1194 * @bssid: BSSID for the PMKSA cache entry
1195 * @pmkid: PMKID for the PMKSA cache entry
1197 * Returns: 0 on success, -1 on failure
1199 * This function is called when the supplicant drops a PMKSA cache
1200 * entry for any reason.
1202 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1203 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1204 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1205 * from wpa_supplicant, this driver_ops function does not need to be
1206 * implemented. Likewise, if the driver does not support WPA, this
1207 * function is not needed.
1209 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1212 * flush_pmkid - Flush PMKSA cache
1213 * @priv: private driver interface data
1215 * Returns: 0 on success, -1 on failure
1217 * This function is called when the supplicant drops all PMKSA cache
1218 * entries for any reason.
1220 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1221 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1222 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1223 * from wpa_supplicant, this driver_ops function does not need to be
1224 * implemented. Likewise, if the driver does not support WPA, this
1225 * function is not needed.
1227 int (*flush_pmkid)(void *priv);
1230 * get_capa - Get driver capabilities
1231 * @priv: private driver interface data
1233 * Returns: 0 on success, -1 on failure
1235 * Get driver/firmware/hardware capabilities.
1237 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1240 * poll - Poll driver for association information
1241 * @priv: private driver interface data
1243 * This is an option callback that can be used when the driver does not
1244 * provide event mechanism for association events. This is called when
1245 * receiving WPA EAPOL-Key messages that require association
1246 * information. The driver interface is supposed to generate associnfo
1247 * event before returning from this callback function. In addition, the
1248 * driver interface should generate an association event after having
1249 * sent out associnfo.
1251 void (*poll)(void *priv);
1254 * get_ifname - Get interface name
1255 * @priv: private driver interface data
1257 * Returns: Pointer to the interface name. This can differ from the
1258 * interface name used in init() call. Init() is called first.
1260 * This optional function can be used to allow the driver interface to
1261 * replace the interface name with something else, e.g., based on an
1262 * interface mapping from a more descriptive name.
1264 const char * (*get_ifname)(void *priv);
1267 * get_mac_addr - Get own MAC address
1268 * @priv: private driver interface data
1270 * Returns: Pointer to own MAC address or %NULL on failure
1272 * This optional function can be used to get the own MAC address of the
1273 * device from the driver interface code. This is only needed if the
1274 * l2_packet implementation for the OS does not provide easy access to
1276 const u8 * (*get_mac_addr)(void *priv);
1279 * send_eapol - Optional function for sending EAPOL packets
1280 * @priv: private driver interface data
1281 * @dest: Destination MAC address
1283 * @data: EAPOL packet starting with IEEE 802.1X header
1284 * @data_len: Size of the EAPOL packet
1286 * Returns: 0 on success, -1 on failure
1288 * This optional function can be used to override l2_packet operations
1289 * with driver specific functionality. If this function pointer is set,
1290 * l2_packet module is not used at all and the driver interface code is
1291 * responsible for receiving and sending all EAPOL packets. The
1292 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1293 * event. The driver interface is required to implement get_mac_addr()
1294 * handler if send_eapol() is used.
1296 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1297 const u8 *data, size_t data_len);
1300 * set_operstate - Sets device operating state to DORMANT or UP
1301 * @priv: private driver interface data
1302 * @state: 0 = dormant, 1 = up
1303 * Returns: 0 on success, -1 on failure
1305 * This is an optional function that can be used on operating systems
1306 * that support a concept of controlling network device state from user
1307 * space applications. This function, if set, gets called with
1308 * state = 1 when authentication has been completed and with state = 0
1309 * when connection is lost.
1311 int (*set_operstate)(void *priv, int state);
1314 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1315 * @priv: Private driver interface data
1316 * @addr: Address of the station for which to set protection (may be
1317 * %NULL for group keys)
1318 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1319 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1320 * Returns: 0 on success, -1 on failure
1322 * This is an optional function that can be used to set the driver to
1323 * require protection for Tx and/or Rx frames. This uses the layer
1324 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1325 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1326 * set protection operation; instead, they set protection implicitly
1327 * based on configured keys.
1329 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1333 * get_hw_feature_data - Get hardware support data (channels and rates)
1334 * @priv: Private driver interface data
1335 * @num_modes: Variable for returning the number of returned modes
1336 * flags: Variable for returning hardware feature flags
1337 * Returns: Pointer to allocated hardware data on success or %NULL on
1338 * failure. Caller is responsible for freeing this.
1340 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1345 * send_mlme - Send management frame from MLME
1346 * @priv: Private driver interface data
1347 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1348 * @data_len: Size of the management frame
1349 * @noack: Do not wait for this frame to be acked (disable retries)
1350 * Returns: 0 on success, -1 on failure
1352 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1356 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1357 * @priv: Private driver interface data
1358 * @md: Mobility domain (2 octets) (also included inside ies)
1359 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1360 * @ies_len: Length of FT IEs in bytes
1361 * Returns: 0 on success, -1 on failure
1363 * The supplicant uses this callback to let the driver know that keying
1364 * material for FT is available and that the driver can use the
1365 * provided IEs in the next message in FT authentication sequence.
1367 * This function is only needed for driver that support IEEE 802.11r
1368 * (Fast BSS Transition).
1370 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1374 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1375 * @priv: Private driver interface data
1376 * @action: Action field value
1377 * @target_ap: Target AP address
1378 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1379 * @ies_len: Length of FT IEs in bytes
1380 * Returns: 0 on success, -1 on failure
1382 * The supplicant uses this callback to request the driver to transmit
1383 * an FT Action frame (action category 6) for over-the-DS fast BSS
1386 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1387 const u8 *ies, size_t ies_len);
1390 * get_scan_results2 - Fetch the latest scan results
1391 * @priv: private driver interface data
1393 * Returns: Allocated buffer of scan results (caller is responsible for
1394 * freeing the data structure) on success, NULL on failure
1396 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1399 * set_country - Set country
1400 * @priv: Private driver interface data
1401 * @alpha2: country to which to switch to
1402 * Returns: 0 on success, -1 on failure
1404 * This function is for drivers which support some form
1405 * of setting a regulatory domain.
1407 int (*set_country)(void *priv, const char *alpha2);
1410 * global_init - Global driver initialization
1411 * Returns: Pointer to private data (global), %NULL on failure
1413 * This optional function is called to initialize the driver wrapper
1414 * for global data, i.e., data that applies to all interfaces. If this
1415 * function is implemented, global_deinit() will also need to be
1416 * implemented to free the private data. The driver will also likely
1417 * use init2() function instead of init() to get the pointer to global
1418 * data available to per-interface initializer.
1420 void * (*global_init)(void);
1423 * global_deinit - Global driver deinitialization
1424 * @priv: private driver global data from global_init()
1426 * Terminate any global driver related functionality and free the
1427 * global data structure.
1429 void (*global_deinit)(void *priv);
1432 * init2 - Initialize driver interface (with global data)
1433 * @ctx: context to be used when calling wpa_supplicant functions,
1434 * e.g., wpa_supplicant_event()
1435 * @ifname: interface name, e.g., wlan0
1436 * @global_priv: private driver global data from global_init()
1437 * Returns: Pointer to private data, %NULL on failure
1439 * This function can be used instead of init() if the driver wrapper
1442 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1445 * get_interfaces - Get information about available interfaces
1446 * @global_priv: private driver global data from global_init()
1447 * Returns: Allocated buffer of interface information (caller is
1448 * responsible for freeing the data structure) on success, NULL on
1451 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1454 * scan2 - Request the driver to initiate scan
1455 * @priv: private driver interface data
1456 * @params: Scan parameters
1458 * Returns: 0 on success, -1 on failure
1460 * Once the scan results are ready, the driver should report scan
1461 * results event for wpa_supplicant which will eventually request the
1462 * results with wpa_driver_get_scan_results2().
1464 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1467 * authenticate - Request driver to authenticate
1468 * @priv: private driver interface data
1469 * @params: authentication parameters
1470 * Returns: 0 on success, -1 on failure
1472 * This is an optional function that can be used with drivers that
1473 * support separate authentication and association steps, i.e., when
1474 * wpa_supplicant can act as the SME. If not implemented, associate()
1475 * function is expected to take care of IEEE 802.11 authentication,
1478 int (*authenticate)(void *priv,
1479 struct wpa_driver_auth_params *params);
1482 * set_ap - Set Beacon and Probe Response information for AP mode
1483 * @priv: Private driver interface data
1484 * @params: Parameters to use in AP mode
1486 * This function is used to configure Beacon template and/or extra IEs
1487 * to add for Beacon and Probe Response frames for the driver in
1488 * AP mode. The driver is responsible for building the full Beacon
1489 * frame by concatenating the head part with TIM IE generated by the
1490 * driver/firmware and finishing with the tail part. Depending on the
1491 * driver architectue, this can be done either by using the full
1492 * template or the set of additional IEs (e.g., WPS and P2P IE).
1493 * Similarly, Probe Response processing depends on the driver design.
1494 * If the driver (or firmware) takes care of replying to Probe Request
1495 * frames, the extra IEs provided here needs to be added to the Probe
1498 * Returns: 0 on success, -1 on failure
1500 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1503 * hapd_init - Initialize driver interface (hostapd only)
1504 * @hapd: Pointer to hostapd context
1505 * @params: Configuration for the driver wrapper
1506 * Returns: Pointer to private data, %NULL on failure
1508 * This function is used instead of init() or init2() when the driver
1509 * wrapper is used with hostapd.
1511 void * (*hapd_init)(struct hostapd_data *hapd,
1512 struct wpa_init_params *params);
1515 * hapd_deinit - Deinitialize driver interface (hostapd only)
1516 * @priv: Private driver interface data from hapd_init()
1518 void (*hapd_deinit)(void *priv);
1521 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1522 * @priv: Private driver interface data
1523 * @params: BSS parameters
1524 * Returns: 0 on success, -1 on failure
1526 * This is an optional function to configure the kernel driver to
1527 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1528 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1529 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1530 * for Beacon frames.
1532 * DEPRECATED - use set_ap() instead
1534 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1537 * set_privacy - Enable/disable privacy (AP only)
1538 * @priv: Private driver interface data
1539 * @enabled: 1 = privacy enabled, 0 = disabled
1540 * Returns: 0 on success, -1 on failure
1542 * This is an optional function to configure privacy field in the
1543 * kernel driver for Beacon frames. This can be left undefined (set to
1544 * %NULL) if the driver uses the Beacon template from set_ap().
1546 * DEPRECATED - use set_ap() instead
1548 int (*set_privacy)(void *priv, int enabled);
1551 * get_seqnum - Fetch the current TSC/packet number (AP only)
1552 * @ifname: The interface name (main or virtual)
1553 * @priv: Private driver interface data
1554 * @addr: MAC address of the station or %NULL for group keys
1556 * @seq: Buffer for returning the latest used TSC/packet number
1557 * Returns: 0 on success, -1 on failure
1559 * This function is used to fetch the last used TSC/packet number for
1560 * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so
1561 * there is no strict requirement on implementing support for unicast
1562 * keys (i.e., addr != %NULL).
1564 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1568 * flush - Flush all association stations (AP only)
1569 * @priv: Private driver interface data
1570 * Returns: 0 on success, -1 on failure
1572 * This function requests the driver to disassociate all associated
1573 * stations. This function does not need to be implemented if the
1574 * driver does not process association frames internally.
1576 int (*flush)(void *priv);
1579 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1580 * @priv: Private driver interface data
1581 * @elem: Information elements
1582 * @elem_len: Length of the elem buffer in octets
1583 * Returns: 0 on success, -1 on failure
1585 * This is an optional function to add information elements in the
1586 * kernel driver for Beacon and Probe Response frames. This can be left
1587 * undefined (set to %NULL) if the driver uses the Beacon template from
1590 * DEPRECATED - use set_ap() instead
1592 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1595 * read_sta_data - Fetch station data (AP only)
1596 * @priv: Private driver interface data
1597 * @data: Buffer for returning station information
1598 * @addr: MAC address of the station
1599 * Returns: 0 on success, -1 on failure
1601 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1605 * hapd_send_eapol - Send an EAPOL packet (AP only)
1606 * @priv: private driver interface data
1607 * @addr: Destination MAC address
1608 * @data: EAPOL packet starting with IEEE 802.1X header
1609 * @data_len: Length of the EAPOL packet in octets
1610 * @encrypt: Whether the frame should be encrypted
1611 * @own_addr: Source MAC address
1612 * @flags: WPA_STA_* flags for the destination station
1614 * Returns: 0 on success, -1 on failure
1616 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1617 size_t data_len, int encrypt,
1618 const u8 *own_addr, u32 flags);
1621 * sta_deauth - Deauthenticate a station (AP only)
1622 * @priv: Private driver interface data
1623 * @own_addr: Source address and BSSID for the Deauthentication frame
1624 * @addr: MAC address of the station to deauthenticate
1625 * @reason: Reason code for the Deauthentiation frame
1626 * Returns: 0 on success, -1 on failure
1628 * This function requests a specific station to be deauthenticated and
1629 * a Deauthentication frame to be sent to it.
1631 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1635 * sta_disassoc - Disassociate a station (AP only)
1636 * @priv: Private driver interface data
1637 * @own_addr: Source address and BSSID for the Disassociation frame
1638 * @addr: MAC address of the station to disassociate
1639 * @reason: Reason code for the Disassociation frame
1640 * Returns: 0 on success, -1 on failure
1642 * This function requests a specific station to be disassociated and
1643 * a Disassociation frame to be sent to it.
1645 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1649 * sta_remove - Remove a station entry (AP only)
1650 * @priv: Private driver interface data
1651 * @addr: MAC address of the station to be removed
1652 * Returns: 0 on success, -1 on failure
1654 int (*sta_remove)(void *priv, const u8 *addr);
1657 * hapd_get_ssid - Get the current SSID (AP only)
1658 * @priv: Private driver interface data
1659 * @buf: Buffer for returning the SSID
1660 * @len: Maximum length of the buffer
1661 * Returns: Length of the SSID on success, -1 on failure
1663 * This function need not be implemented if the driver uses Beacon
1664 * template from set_ap() and does not reply to Probe Request frames.
1666 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1669 * hapd_set_ssid - Set SSID (AP only)
1670 * @priv: Private driver interface data
1672 * @len: Length of the SSID in octets
1673 * Returns: 0 on success, -1 on failure
1675 * DEPRECATED - use set_ap() instead
1677 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1680 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1681 * @priv: Private driver interface data
1682 * @enabled: 1 = countermeasures enabled, 0 = disabled
1683 * Returns: 0 on success, -1 on failure
1685 * This need not be implemented if the driver does not take care of
1686 * association processing.
1688 int (*hapd_set_countermeasures)(void *priv, int enabled);
1691 * sta_add - Add a station entry
1692 * @priv: Private driver interface data
1693 * @params: Station parameters
1694 * Returns: 0 on success, -1 on failure
1696 * This function is used to add a station entry to the driver once the
1697 * station has completed association. This is only used if the driver
1698 * does not take care of association processing.
1700 * With TDLS, this function is also used to add or set (params->set 1)
1701 * TDLS peer entries.
1703 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1706 * get_inact_sec - Get station inactivity duration (AP only)
1707 * @priv: Private driver interface data
1708 * @addr: Station address
1709 * Returns: Number of seconds station has been inactive, -1 on failure
1711 int (*get_inact_sec)(void *priv, const u8 *addr);
1714 * sta_clear_stats - Clear station statistics (AP only)
1715 * @priv: Private driver interface data
1716 * @addr: Station address
1717 * Returns: 0 on success, -1 on failure
1719 int (*sta_clear_stats)(void *priv, const u8 *addr);
1722 * set_freq - Set channel/frequency (AP only)
1723 * @priv: Private driver interface data
1724 * @freq: Channel parameters
1725 * Returns: 0 on success, -1 on failure
1727 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1730 * set_rts - Set RTS threshold
1731 * @priv: Private driver interface data
1732 * @rts: RTS threshold in octets
1733 * Returns: 0 on success, -1 on failure
1735 int (*set_rts)(void *priv, int rts);
1738 * set_frag - Set fragmentation threshold
1739 * @priv: Private driver interface data
1740 * @frag: Fragmentation threshold in octets
1741 * Returns: 0 on success, -1 on failure
1743 int (*set_frag)(void *priv, int frag);
1746 * sta_set_flags - Set station flags (AP only)
1747 * @priv: Private driver interface data
1748 * @addr: Station address
1749 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1750 * @flags_or: Bitmap of WPA_STA_* flags to add
1751 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1752 * Returns: 0 on success, -1 on failure
1754 int (*sta_set_flags)(void *priv, const u8 *addr,
1755 int total_flags, int flags_or, int flags_and);
1758 * set_tx_queue_params - Set TX queue parameters
1759 * @priv: Private driver interface data
1760 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
1764 * @burst_time: Maximum length for bursting in 0.1 msec units
1766 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1767 int cw_max, int burst_time);
1770 * if_add - Add a virtual interface
1771 * @priv: Private driver interface data
1772 * @type: Interface type
1773 * @ifname: Interface name for the new virtual interface
1774 * @addr: Local address to use for the interface or %NULL to use the
1775 * parent interface address
1776 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1777 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1778 * not allowed (applies only to %WPA_IF_AP_BSS type)
1779 * @force_ifname: Buffer for returning an interface name that the
1780 * driver ended up using if it differs from the requested ifname
1781 * @if_addr: Buffer for returning the allocated interface address
1782 * (this may differ from the requested addr if the driver cannot
1783 * change interface address)
1784 * @bridge: Bridge interface to use or %NULL if no bridge configured
1785 * Returns: 0 on success, -1 on failure
1787 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1788 const char *ifname, const u8 *addr, void *bss_ctx,
1789 void **drv_priv, char *force_ifname, u8 *if_addr,
1790 const char *bridge);
1793 * if_remove - Remove a virtual interface
1794 * @priv: Private driver interface data
1795 * @type: Interface type
1796 * @ifname: Interface name of the virtual interface to be removed
1797 * Returns: 0 on success, -1 on failure
1799 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1800 const char *ifname);
1803 * set_sta_vlan - Bind a station into a specific interface (AP only)
1804 * @priv: Private driver interface data
1805 * @ifname: Interface (main or virtual BSS or VLAN)
1806 * @addr: MAC address of the associated station
1808 * Returns: 0 on success, -1 on failure
1810 * This function is used to bind a station to a specific virtual
1811 * interface. It is only used if when virtual interfaces are supported,
1812 * e.g., to assign stations to different VLAN interfaces based on
1813 * information from a RADIUS server. This allows separate broadcast
1814 * domains to be used with a single BSS.
1816 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1820 * commit - Optional commit changes handler (AP only)
1821 * @priv: driver private data
1822 * Returns: 0 on success, -1 on failure
1824 * This optional handler function can be registered if the driver
1825 * interface implementation needs to commit changes (e.g., by setting
1826 * network interface up) at the end of initial configuration. If set,
1827 * this handler will be called after initial setup has been completed.
1829 int (*commit)(void *priv);
1832 * send_ether - Send an ethernet packet (AP only)
1833 * @priv: private driver interface data
1834 * @dst: Destination MAC address
1835 * @src: Source MAC address
1837 * @data: EAPOL packet starting with IEEE 802.1X header
1838 * @data_len: Length of the EAPOL packet in octets
1839 * Returns: 0 on success, -1 on failure
1841 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1842 const u8 *data, size_t data_len);
1845 * set_radius_acl_auth - Notification of RADIUS ACL change
1846 * @priv: Private driver interface data
1847 * @mac: MAC address of the station
1848 * @accepted: Whether the station was accepted
1849 * @session_timeout: Session timeout for the station
1850 * Returns: 0 on success, -1 on failure
1852 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1853 u32 session_timeout);
1856 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1857 * @priv: Private driver interface data
1858 * @mac: MAC address of the station
1859 * Returns: 0 on success, -1 on failure
1861 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1864 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
1865 * @priv: Private driver interface data
1866 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
1867 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
1869 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
1870 * to remove extra IE(s)
1871 * Returns: 0 on success, -1 on failure
1873 * This is an optional function to add WPS IE in the kernel driver for
1874 * Beacon and Probe Response frames. This can be left undefined (set
1875 * to %NULL) if the driver uses the Beacon template from set_ap()
1876 * and does not process Probe Request frames. If the driver takes care
1877 * of (Re)Association frame processing, the assocresp buffer includes
1878 * WPS IE(s) that need to be added to (Re)Association Response frames
1879 * whenever a (Re)Association Request frame indicated use of WPS.
1881 * This will also be used to add P2P IE(s) into Beacon/Probe Response
1882 * frames when operating as a GO. The driver is responsible for adding
1883 * timing related attributes (e.g., NoA) in addition to the IEs
1884 * included here by appending them after these buffers. This call is
1885 * also used to provide Probe Response IEs for P2P Listen state
1886 * operations for drivers that generate the Probe Response frames
1889 * DEPRECATED - use set_ap() instead
1891 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
1892 const struct wpabuf *proberesp,
1893 const struct wpabuf *assocresp);
1896 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1897 * @priv: Private driver interface data
1898 * @authorized: Whether the port is authorized
1899 * Returns: 0 on success, -1 on failure
1901 int (*set_supp_port)(void *priv, int authorized);
1904 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1905 * @priv: Private driver interface data
1906 * @addr: MAC address of the associated station
1907 * @aid: Association ID
1908 * @val: 1 = bind to 4-address WDS; 0 = unbind
1909 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
1910 * to indicate that bridge is not to be used
1911 * Returns: 0 on success, -1 on failure
1913 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
1914 const char *bridge_ifname);
1917 * send_action - Transmit an Action frame
1918 * @priv: Private driver interface data
1919 * @freq: Frequency (in MHz) of the channel
1920 * @wait: Time to wait off-channel for a response (in ms), or zero
1921 * @dst: Destination MAC address (Address 1)
1922 * @src: Source MAC address (Address 2)
1923 * @bssid: BSSID (Address 3)
1925 * @data_len: data length in octets
1926 @ @no_cck: Whether CCK rates must not be used to transmit this frame
1927 * Returns: 0 on success, -1 on failure
1929 * This command can be used to request the driver to transmit an action
1930 * frame to the specified destination.
1932 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
1933 * be transmitted on the given channel and the device will wait for a
1934 * response on that channel for the given wait time.
1936 * If the flag is not set, the wait time will be ignored. In this case,
1937 * if a remain-on-channel duration is in progress, the frame must be
1938 * transmitted on that channel; alternatively the frame may be sent on
1939 * the current operational channel (if in associated state in station
1940 * mode or while operating as an AP.)
1942 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
1943 const u8 *dst, const u8 *src, const u8 *bssid,
1944 const u8 *data, size_t data_len, int no_cck);
1947 * send_action_cancel_wait - Cancel action frame TX wait
1948 * @priv: Private driver interface data
1950 * This command cancels the wait time associated with sending an action
1951 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
1952 * set in the driver flags.
1954 void (*send_action_cancel_wait)(void *priv);
1957 * remain_on_channel - Remain awake on a channel
1958 * @priv: Private driver interface data
1959 * @freq: Frequency (in MHz) of the channel
1960 * @duration: Duration in milliseconds
1961 * Returns: 0 on success, -1 on failure
1963 * This command is used to request the driver to remain awake on the
1964 * specified channel for the specified duration and report received
1965 * Action frames with EVENT_RX_ACTION events. Optionally, received
1966 * Probe Request frames may also be requested to be reported by calling
1967 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
1969 * The driver may not be at the requested channel when this function
1970 * returns, i.e., the return code is only indicating whether the
1971 * request was accepted. The caller will need to wait until the
1972 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
1973 * completed the channel change. This may take some time due to other
1974 * need for the radio and the caller should be prepared to timing out
1975 * its wait since there are no guarantees on when this request can be
1978 int (*remain_on_channel)(void *priv, unsigned int freq,
1979 unsigned int duration);
1982 * cancel_remain_on_channel - Cancel remain-on-channel operation
1983 * @priv: Private driver interface data
1985 * This command can be used to cancel a remain-on-channel operation
1986 * before its originally requested duration has passed. This could be
1987 * used, e.g., when remain_on_channel() is used to request extra time
1988 * to receive a response to an Action frame and the response is
1989 * received when there is still unneeded time remaining on the
1990 * remain-on-channel operation.
1992 int (*cancel_remain_on_channel)(void *priv);
1995 * probe_req_report - Request Probe Request frames to be indicated
1996 * @priv: Private driver interface data
1997 * @report: Whether to report received Probe Request frames
1998 * Returns: 0 on success, -1 on failure (or if not supported)
2000 * This command can be used to request the driver to indicate when
2001 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2002 * Since this operation may require extra resources, e.g., due to less
2003 * optimal hardware/firmware RX filtering, many drivers may disable
2004 * Probe Request reporting at least in station mode. This command is
2005 * used to notify the driver when the Probe Request frames need to be
2006 * reported, e.g., during remain-on-channel operations.
2008 int (*probe_req_report)(void *priv, int report);
2011 * deinit_ap - Deinitialize AP mode
2012 * @priv: Private driver interface data
2013 * Returns: 0 on success, -1 on failure (or if not supported)
2015 * This optional function can be used to disable AP mode related
2016 * configuration and change the driver mode to station mode to allow
2017 * normal station operations like scanning to be completed.
2019 int (*deinit_ap)(void *priv);
2022 * suspend - Notification on system suspend/hibernate event
2023 * @priv: Private driver interface data
2025 void (*suspend)(void *priv);
2028 * resume - Notification on system resume/thaw event
2029 * @priv: Private driver interface data
2031 void (*resume)(void *priv);
2034 * signal_monitor - Set signal monitoring parameters
2035 * @priv: Private driver interface data
2036 * @threshold: Threshold value for signal change events; 0 = disabled
2037 * @hysteresis: Minimum change in signal strength before indicating a
2039 * Returns: 0 on success, -1 on failure (or if not supported)
2041 * This function can be used to configure monitoring of signal strength
2042 * with the current AP. Whenever signal strength drops below the
2043 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2044 * should be generated assuming the signal strength has changed at
2045 * least %hysteresis from the previously indicated signal change event.
2047 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2050 * send_frame - Send IEEE 802.11 frame (testing use only)
2051 * @priv: Private driver interface data
2052 * @data: IEEE 802.11 frame with IEEE 802.11 header
2053 * @data_len: Size of the frame
2054 * @encrypt: Whether to encrypt the frame (if keys are set)
2055 * Returns: 0 on success, -1 on failure
2057 * This function is only used for debugging purposes and is not
2058 * required to be implemented for normal operations.
2060 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2064 * shared_freq - Get operating frequency of shared interface(s)
2065 * @priv: Private driver interface data
2066 * Returns: Operating frequency in MHz, 0 if no shared operation in
2067 * use, or -1 on failure
2069 * This command can be used to request the current operating frequency
2070 * of any virtual interface that shares the same radio to provide
2071 * information for channel selection for other virtual interfaces.
2073 int (*shared_freq)(void *priv);
2076 * get_noa - Get current Notice of Absence attribute payload
2077 * @priv: Private driver interface data
2078 * @buf: Buffer for returning NoA
2079 * @buf_len: Buffer length in octets
2080 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2081 * advertized, or -1 on failure
2083 * This function is used to fetch the current Notice of Absence
2084 * attribute value from GO.
2086 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2089 * set_noa - Set Notice of Absence parameters for GO (testing)
2090 * @priv: Private driver interface data
2092 * @start: Start time in ms from next TBTT
2093 * @duration: Duration in ms
2094 * Returns: 0 on success or -1 on failure
2096 * This function is used to set Notice of Absence parameters for GO. It
2097 * is used only for testing. To disable NoA, all parameters are set to
2100 int (*set_noa)(void *priv, u8 count, int start, int duration);
2103 * set_p2p_powersave - Set P2P power save options
2104 * @priv: Private driver interface data
2105 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2106 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2107 * @ctwindow: 0.. = change (msec), -1 = no change
2108 * Returns: 0 on success or -1 on failure
2110 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2114 * ampdu - Enable/disable aggregation
2115 * @priv: Private driver interface data
2116 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2117 * Returns: 0 on success or -1 on failure
2119 int (*ampdu)(void *priv, int ampdu);
2122 * get_radio_name - Get physical radio name for the device
2123 * @priv: Private driver interface data
2124 * Returns: Radio name or %NULL if not known
2126 * The returned data must not be modified by the caller. It is assumed
2127 * that any interface that has the same radio name as another is
2128 * sharing the same physical radio. This information can be used to
2129 * share scan results etc. information between the virtual interfaces
2130 * to speed up various operations.
2132 const char * (*get_radio_name)(void *priv);
2135 * p2p_find - Start P2P Device Discovery
2136 * @priv: Private driver interface data
2137 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2138 * @type: Device Discovery type (enum p2p_discovery_type)
2139 * Returns: 0 on success, -1 on failure
2141 * This function is only used if the driver implements P2P management,
2142 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2143 * struct wpa_driver_capa.
2145 int (*p2p_find)(void *priv, unsigned int timeout, int type);
2148 * p2p_stop_find - Stop P2P Device Discovery
2149 * @priv: Private driver interface data
2150 * Returns: 0 on success, -1 on failure
2152 * This function is only used if the driver implements P2P management,
2153 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2154 * struct wpa_driver_capa.
2156 int (*p2p_stop_find)(void *priv);
2159 * p2p_listen - Start P2P Listen state for specified duration
2160 * @priv: Private driver interface data
2161 * @timeout: Listen state duration in milliseconds
2162 * Returns: 0 on success, -1 on failure
2164 * This function can be used to request the P2P module to keep the
2165 * device discoverable on the listen channel for an extended set of
2166 * time. At least in its current form, this is mainly used for testing
2167 * purposes and may not be of much use for normal P2P operations.
2169 * This function is only used if the driver implements P2P management,
2170 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2171 * struct wpa_driver_capa.
2173 int (*p2p_listen)(void *priv, unsigned int timeout);
2176 * p2p_connect - Start P2P group formation (GO negotiation)
2177 * @priv: Private driver interface data
2178 * @peer_addr: MAC address of the peer P2P client
2179 * @wps_method: enum p2p_wps_method value indicating config method
2180 * @go_intent: Local GO intent value (1..15)
2181 * @own_interface_addr: Intended interface address to use with the
2183 * @force_freq: The only allowed channel frequency in MHz or 0
2184 * @persistent_group: Whether to create persistent group
2185 * Returns: 0 on success, -1 on failure
2187 * This function is only used if the driver implements P2P management,
2188 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2189 * struct wpa_driver_capa.
2191 int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method,
2192 int go_intent, const u8 *own_interface_addr,
2193 unsigned int force_freq, int persistent_group);
2196 * wps_success_cb - Report successfully completed WPS provisioning
2197 * @priv: Private driver interface data
2198 * @peer_addr: Peer address
2199 * Returns: 0 on success, -1 on failure
2201 * This function is used to report successfully completed WPS
2202 * provisioning during group formation in both GO/Registrar and
2203 * client/Enrollee roles.
2205 * This function is only used if the driver implements P2P management,
2206 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2207 * struct wpa_driver_capa.
2209 int (*wps_success_cb)(void *priv, const u8 *peer_addr);
2212 * p2p_group_formation_failed - Report failed WPS provisioning
2213 * @priv: Private driver interface data
2214 * Returns: 0 on success, -1 on failure
2216 * This function is used to report failed group formation. This can
2217 * happen either due to failed WPS provisioning or due to 15 second
2218 * timeout during the provisioning phase.
2220 * This function is only used if the driver implements P2P management,
2221 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2222 * struct wpa_driver_capa.
2224 int (*p2p_group_formation_failed)(void *priv);
2227 * p2p_set_params - Set P2P parameters
2228 * @priv: Private driver interface data
2229 * @params: P2P parameters
2230 * Returns: 0 on success, -1 on failure
2232 * This function is only used if the driver implements P2P management,
2233 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2234 * struct wpa_driver_capa.
2236 int (*p2p_set_params)(void *priv, const struct p2p_params *params);
2239 * p2p_prov_disc_req - Send Provision Discovery Request
2240 * @priv: Private driver interface data
2241 * @peer_addr: MAC address of the peer P2P client
2242 * @config_methods: WPS Config Methods value (only one bit set)
2243 * Returns: 0 on success, -1 on failure
2245 * This function can be used to request a discovered P2P peer to
2246 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2247 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2248 * Provision Discovery Request frame is transmitted once immediately
2249 * and if no response is received, the frame will be sent again
2250 * whenever the target device is discovered during device dsicovery
2251 * (start with a p2p_find() call). Response from the peer is indicated
2252 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
2254 * This function is only used if the driver implements P2P management,
2255 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2256 * struct wpa_driver_capa.
2258 int (*p2p_prov_disc_req)(void *priv, const u8 *peer_addr,
2259 u16 config_methods, int join);
2262 * p2p_sd_request - Schedule a service discovery query
2263 * @priv: Private driver interface data
2264 * @dst: Destination peer or %NULL to apply for all peers
2265 * @tlvs: P2P Service Query TLV(s)
2266 * Returns: Reference to the query or 0 on failure
2268 * Response to the query is indicated with the
2269 * EVENT_P2P_SD_RESPONSE driver event.
2271 * This function is only used if the driver implements P2P management,
2272 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2273 * struct wpa_driver_capa.
2275 u64 (*p2p_sd_request)(void *priv, const u8 *dst,
2276 const struct wpabuf *tlvs);
2279 * p2p_sd_cancel_request - Cancel a pending service discovery query
2280 * @priv: Private driver interface data
2281 * @req: Query reference from p2p_sd_request()
2282 * Returns: 0 on success, -1 on failure
2284 * This function is only used if the driver implements P2P management,
2285 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2286 * struct wpa_driver_capa.
2288 int (*p2p_sd_cancel_request)(void *priv, u64 req);
2291 * p2p_sd_response - Send response to a service discovery query
2292 * @priv: Private driver interface data
2293 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2294 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2295 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2296 * @resp_tlvs: P2P Service Response TLV(s)
2297 * Returns: 0 on success, -1 on failure
2299 * This function is called as a response to the request indicated with
2300 * the EVENT_P2P_SD_REQUEST driver event.
2302 * This function is only used if the driver implements P2P management,
2303 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2304 * struct wpa_driver_capa.
2306 int (*p2p_sd_response)(void *priv, int freq, const u8 *dst,
2308 const struct wpabuf *resp_tlvs);
2311 * p2p_service_update - Indicate a change in local services
2312 * @priv: Private driver interface data
2313 * Returns: 0 on success, -1 on failure
2315 * This function needs to be called whenever there is a change in
2316 * availability of the local services. This will increment the
2317 * Service Update Indicator value which will be used in SD Request and
2320 * This function is only used if the driver implements P2P management,
2321 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2322 * struct wpa_driver_capa.
2324 int (*p2p_service_update)(void *priv);
2327 * p2p_reject - Reject peer device (explicitly block connections)
2328 * @priv: Private driver interface data
2329 * @addr: MAC address of the peer
2330 * Returns: 0 on success, -1 on failure
2332 int (*p2p_reject)(void *priv, const u8 *addr);
2335 * p2p_invite - Invite a P2P Device into a group
2336 * @priv: Private driver interface data
2337 * @peer: Device Address of the peer P2P Device
2338 * @role: Local role in the group
2339 * @bssid: Group BSSID or %NULL if not known
2341 * @ssid_len: Length of ssid in octets
2342 * @go_dev_addr: Forced GO Device Address or %NULL if none
2343 * @persistent_group: Whether this is to reinvoke a persistent group
2344 * Returns: 0 on success, -1 on failure
2346 int (*p2p_invite)(void *priv, const u8 *peer, int role,
2347 const u8 *bssid, const u8 *ssid, size_t ssid_len,
2348 const u8 *go_dev_addr, int persistent_group);
2351 * send_tdls_mgmt - for sending TDLS management packets
2352 * @priv: private driver interface data
2353 * @dst: Destination (peer) MAC address
2354 * @action_code: TDLS action code for the mssage
2355 * @dialog_token: Dialog Token to use in the message (if needed)
2356 * @status_code: Status Code or Reason Code to use (if needed)
2357 * @buf: TDLS IEs to add to the message
2358 * @len: Length of buf in octets
2359 * Returns: 0 on success, negative (<0) on failure
2361 * This optional function can be used to send packet to driver which is
2362 * responsible for receiving and sending all TDLS packets.
2364 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2365 u8 dialog_token, u16 status_code,
2366 const u8 *buf, size_t len);
2369 * tdls_oper - Ask the driver to perform high-level TDLS operations
2370 * @priv: Private driver interface data
2371 * @oper: TDLS high-level operation. See %enum tdls_oper
2372 * @peer: Destination (peer) MAC address
2373 * Returns: 0 on success, negative (<0) on failure
2375 * This optional function can be used to send high-level TDLS commands
2378 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2381 * signal_poll - Get current connection information
2382 * @priv: Private driver interface data
2383 * @signal_info: Connection info structure
2385 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2388 * set_authmode - Set authentication algorithm(s) for static WEP
2389 * @priv: Private driver interface data
2390 * @authmode: 1=Open System, 2=Shared Key, 3=both
2391 * Returns: 0 on success, -1 on failure
2393 * This function can be used to set authentication algorithms for AP
2394 * mode when static WEP is used. If the driver uses user space MLME/SME
2395 * implementation, there is no need to implement this function.
2397 * DEPRECATED - use set_ap() instead
2399 int (*set_authmode)(void *priv, int authmode);
2402 * set_rekey_info - Set rekey information
2403 * @priv: Private driver interface data
2406 * @replay_ctr: Current EAPOL-Key Replay Counter
2408 * This optional function can be used to provide information for the
2409 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2410 * while the host (including wpa_supplicant) is sleeping.
2412 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2413 const u8 *replay_ctr);
2416 * sta_assoc - Station association indication
2417 * @priv: Private driver interface data
2418 * @own_addr: Source address and BSSID for association frame
2419 * @addr: MAC address of the station to associate
2420 * @reassoc: flag to indicate re-association
2421 * @status: association response status code
2422 * @ie: assoc response ie buffer
2423 * @len: ie buffer length
2424 * Returns: 0 on success, -1 on failure
2426 * This function indicates the driver to send (Re)Association
2427 * Response frame to the station.
2429 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2430 int reassoc, u16 status, const u8 *ie, size_t len);
2433 * sta_auth - Station authentication indication
2434 * @priv: Private driver interface data
2435 * @own_addr: Source address and BSSID for authentication frame
2436 * @addr: MAC address of the station to associate
2437 * @seq: authentication sequence number
2438 * @status: authentication response status code
2439 * @ie: authentication frame ie buffer
2440 * @len: ie buffer length
2442 * This function indicates the driver to send Authentication frame
2445 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2446 u16 seq, u16 status, const u8 *ie, size_t len);
2449 * add_tspec - Add traffic stream
2450 * @priv: Private driver interface data
2451 * @addr: MAC address of the station to associate
2452 * @tspec_ie: tspec ie buffer
2453 * @tspec_ielen: tspec ie length
2454 * Returns: 0 on success, -1 on failure
2456 * This function adds the traffic steam for the station
2457 * and fills the medium_time in tspec_ie.
2459 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2460 size_t tspec_ielen);
2463 * add_sta_node - Add a station node in the driver
2464 * @priv: Private driver interface data
2465 * @addr: MAC address of the station to add
2466 * @auth_alg: authentication algorithm used by the station
2467 * Returns: 0 on success, -1 on failure
2469 * This function adds the station node in the driver, when
2470 * the station gets added by FT-over-DS.
2472 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2475 * sched_scan - Request the driver to initiate scheduled scan
2476 * @priv: Private driver interface data
2477 * @params: Scan parameters
2478 * @interval: Interval between scan cycles in milliseconds
2479 * Returns: 0 on success, -1 on failure
2481 * This operation should be used for scheduled scan offload to
2482 * the hardware. Every time scan results are available, the
2483 * driver should report scan results event for wpa_supplicant
2484 * which will eventually request the results with
2485 * wpa_driver_get_scan_results2(). This operation is optional
2486 * and if not provided or if it returns -1, we fall back to
2487 * normal host-scheduled scans.
2489 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2493 * stop_sched_scan - Request the driver to stop a scheduled scan
2494 * @priv: Private driver interface data
2495 * Returns: 0 on success, -1 on failure
2497 * This should cause the scheduled scan to be stopped and
2498 * results should stop being sent. Must be supported if
2499 * sched_scan is supported.
2501 int (*stop_sched_scan)(void *priv);
2504 * poll_client - Probe (null data or such) the given station
2505 * @priv: Private driver interface data
2506 * @own_addr: MAC address of sending interface
2507 * @addr: MAC address of the station to probe
2508 * @qos: Indicates whether station is QoS station
2510 * This function is used to verify whether an associated station is
2511 * still present. This function does not need to be implemented if the
2512 * driver provides such inactivity polling mechanism.
2514 void (*poll_client)(void *priv, const u8 *own_addr,
2515 const u8 *addr, int qos);
2518 * radio_disable - Disable/enable radio
2519 * @priv: Private driver interface data
2520 * @disabled: 1=disable 0=enable radio
2521 * Returns: 0 on success, -1 on failure
2523 * This optional command is for testing purposes. It can be used to
2524 * disable the radio on a testbed device to simulate out-of-radio-range
2527 int (*radio_disable)(void *priv, int disabled);
2532 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2534 enum wpa_event_type {
2536 * EVENT_ASSOC - Association completed
2538 * This event needs to be delivered when the driver completes IEEE
2539 * 802.11 association or reassociation successfully.
2540 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2541 * after this event has been generated. In addition, optional
2542 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2543 * more information about the association. If the driver interface gets
2544 * both of these events at the same time, it can also include the
2545 * assoc_info data in EVENT_ASSOC call.
2550 * EVENT_DISASSOC - Association lost
2552 * This event should be called when association is lost either due to
2553 * receiving deauthenticate or disassociate frame from the AP or when
2554 * sending either of these frames to the current AP. If the driver
2555 * supports separate deauthentication event, EVENT_DISASSOC should only
2556 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2557 * In AP mode, union wpa_event_data::disassoc_info is required.
2562 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2564 * This event must be delivered when a Michael MIC error is detected by
2565 * the local driver. Additional data for event processing is
2566 * provided with union wpa_event_data::michael_mic_failure. This
2567 * information is used to request new encyption key and to initiate
2568 * TKIP countermeasures if needed.
2570 EVENT_MICHAEL_MIC_FAILURE,
2573 * EVENT_SCAN_RESULTS - Scan results available
2575 * This event must be called whenever scan results are available to be
2576 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2577 * is expected to be used some time after struct wpa_driver_ops::scan()
2578 * is called. If the driver provides an unsolicited event when the scan
2579 * has been completed, this event can be used to trigger
2580 * EVENT_SCAN_RESULTS call. If such event is not available from the
2581 * driver, the driver wrapper code is expected to use a registered
2582 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2583 * scan is expected to be completed. Optional information about
2584 * completed scan can be provided with union wpa_event_data::scan_info.
2589 * EVENT_ASSOCINFO - Report optional extra information for association
2591 * This event can be used to report extra association information for
2592 * EVENT_ASSOC processing. This extra information includes IEs from
2593 * association frames and Beacon/Probe Response frames in union
2594 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2595 * EVENT_ASSOC. Alternatively, the driver interface can include
2596 * assoc_info data in the EVENT_ASSOC call if it has all the
2597 * information available at the same point.
2602 * EVENT_INTERFACE_STATUS - Report interface status changes
2604 * This optional event can be used to report changes in interface
2605 * status (interface added/removed) using union
2606 * wpa_event_data::interface_status. This can be used to trigger
2607 * wpa_supplicant to stop and re-start processing for the interface,
2608 * e.g., when a cardbus card is ejected/inserted.
2610 EVENT_INTERFACE_STATUS,
2613 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2615 * This event can be used to inform wpa_supplicant about candidates for
2616 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2617 * for scan request (ap_scan=2 mode), this event is required for
2618 * pre-authentication. If wpa_supplicant is performing scan request
2619 * (ap_scan=1), this event is optional since scan results can be used
2620 * to add pre-authentication candidates. union
2621 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2622 * candidate and priority of the candidate, e.g., based on the signal
2623 * strength, in order to try to pre-authenticate first with candidates
2624 * that are most likely targets for re-association.
2626 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2627 * on the candidate list. In addition, it can be called for the current
2628 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2629 * will automatically skip pre-authentication in cases where a valid
2630 * PMKSA exists. When more than one candidate exists, this event should
2631 * be generated once for each candidate.
2633 * Driver will be notified about successful pre-authentication with
2634 * struct wpa_driver_ops::add_pmkid() calls.
2636 EVENT_PMKID_CANDIDATE,
2639 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2641 * This event can be used to inform wpa_supplicant about desire to set
2642 * up secure direct link connection between two stations as defined in
2643 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2644 * STAKey negotiation. The caller will need to set peer address for the
2650 * EVENT_TDLS - Request TDLS operation
2652 * This event can be used to request a TDLS operation to be performed.
2657 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2659 * The driver is expected to report the received FT IEs from
2660 * FT authentication sequence from the AP. The FT IEs are included in
2661 * the extra information in union wpa_event_data::ft_ies.
2666 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2668 * The driver can use this event to inform wpa_supplicant about a STA
2669 * in an IBSS with which protected frames could be exchanged. This
2670 * event starts RSN authentication with the other STA to authenticate
2671 * the STA and set up encryption keys with it.
2673 EVENT_IBSS_RSN_START,
2676 * EVENT_AUTH - Authentication result
2678 * This event should be called when authentication attempt has been
2679 * completed. This is only used if the driver supports separate
2680 * authentication step (struct wpa_driver_ops::authenticate).
2681 * Information about authentication result is included in
2682 * union wpa_event_data::auth.
2687 * EVENT_DEAUTH - Authentication lost
2689 * This event should be called when authentication is lost either due
2690 * to receiving deauthenticate frame from the AP or when sending that
2691 * frame to the current AP.
2692 * In AP mode, union wpa_event_data::deauth_info is required.
2697 * EVENT_ASSOC_REJECT - Association rejected
2699 * This event should be called when (re)association attempt has been
2700 * rejected by the AP. Information about the association response is
2701 * included in union wpa_event_data::assoc_reject.
2706 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2708 EVENT_AUTH_TIMED_OUT,
2711 * EVENT_ASSOC_TIMED_OUT - Association timed out
2713 EVENT_ASSOC_TIMED_OUT,
2716 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2721 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2723 EVENT_WPS_BUTTON_PUSHED,
2726 * EVENT_TX_STATUS - Report TX status
2731 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2733 EVENT_RX_FROM_UNKNOWN,
2736 * EVENT_RX_MGMT - Report RX of a management frame
2741 * EVENT_RX_ACTION - Action frame received
2743 * This event is used to indicate when an Action frame has been
2744 * received. Information about the received frame is included in
2745 * union wpa_event_data::rx_action.
2750 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2752 * This event is used to indicate when the driver has started the
2753 * requested remain-on-channel duration. Information about the
2754 * operation is included in union wpa_event_data::remain_on_channel.
2756 EVENT_REMAIN_ON_CHANNEL,
2759 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2761 * This event is used to indicate when the driver has completed
2762 * remain-on-channel duration, i.e., may noot be available on the
2763 * requested channel anymore. Information about the
2764 * operation is included in union wpa_event_data::remain_on_channel.
2766 EVENT_CANCEL_REMAIN_ON_CHANNEL,
2769 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2771 * This event is used only by driver_test.c and userspace MLME.
2776 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2778 * This event is used to indicate when a Probe Request frame has been
2779 * received. Information about the received frame is included in
2780 * union wpa_event_data::rx_probe_req. The driver is required to report
2781 * these events only after successfully completed probe_req_report()
2782 * commands to request the events (i.e., report parameter is non-zero)
2783 * in station mode. In AP mode, Probe Request frames should always be
2789 * EVENT_NEW_STA - New wired device noticed
2791 * This event is used to indicate that a new device has been detected
2792 * in a network that does not use association-like functionality (i.e.,
2793 * mainly wired Ethernet). This can be used to start EAPOL
2794 * authenticator when receiving a frame from a device. The address of
2795 * the device is included in union wpa_event_data::new_sta.
2800 * EVENT_EAPOL_RX - Report received EAPOL frame
2802 * When in AP mode with hostapd, this event is required to be used to
2803 * deliver the receive EAPOL frames from the driver. With
2804 * %wpa_supplicant, this event is used only if the send_eapol() handler
2805 * is used to override the use of l2_packet for EAPOL frame TX.
2810 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
2812 * This event is used to indicate changes in the signal strength
2813 * observed in frames received from the current AP if signal strength
2814 * monitoring has been enabled with signal_monitor().
2816 EVENT_SIGNAL_CHANGE,
2819 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
2821 * This event is used to indicate that the interface was enabled after
2822 * having been previously disabled, e.g., due to rfkill.
2824 EVENT_INTERFACE_ENABLED,
2827 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
2829 * This event is used to indicate that the interface was disabled,
2830 * e.g., due to rfkill.
2832 EVENT_INTERFACE_DISABLED,
2835 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
2837 * This event is used to indicate that the channel list has changed,
2838 * e.g., because of a regulatory domain change triggered by scan
2839 * results including an AP advertising a country code.
2841 EVENT_CHANNEL_LIST_CHANGED,
2844 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
2846 * This event is used to indicate that the driver cannot maintain this
2847 * interface in its operation mode anymore. The most likely use for
2848 * this is to indicate that AP mode operation is not available due to
2849 * operating channel would need to be changed to a DFS channel when
2850 * the driver does not support radar detection and another virtual
2851 * interfaces caused the operating channel to change. Other similar
2852 * resource conflicts could also trigger this for station mode
2855 EVENT_INTERFACE_UNAVAILABLE,
2858 * EVENT_BEST_CHANNEL
2860 * Driver generates this event whenever it detects a better channel
2861 * (e.g., based on RSSI or channel use). This information can be used
2862 * to improve channel selection for a new AP/P2P group.
2867 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
2869 * This event should be called when a Deauthentication frame is dropped
2870 * due to it not being protected (MFP/IEEE 802.11w).
2871 * union wpa_event_data::unprot_deauth is required to provide more
2872 * details of the frame.
2874 EVENT_UNPROT_DEAUTH,
2877 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
2879 * This event should be called when a Disassociation frame is dropped
2880 * due to it not being protected (MFP/IEEE 802.11w).
2881 * union wpa_event_data::unprot_disassoc is required to provide more
2882 * details of the frame.
2884 EVENT_UNPROT_DISASSOC,
2887 * EVENT_STATION_LOW_ACK
2889 * Driver generates this event whenever it detected that a particular
2890 * station was lost. Detection can be through massive transmission
2891 * failures for example.
2893 EVENT_STATION_LOW_ACK,
2896 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
2898 * This event is used only if the driver implements P2P management
2899 * internally. Event data is stored in
2900 * union wpa_event_data::p2p_dev_found.
2902 EVENT_P2P_DEV_FOUND,
2905 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
2907 * This event is used only if the driver implements P2P management
2908 * internally. Event data is stored in
2909 * union wpa_event_data::p2p_go_neg_req_rx.
2911 EVENT_P2P_GO_NEG_REQ_RX,
2914 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
2916 * This event is used only if the driver implements P2P management
2917 * internally. Event data is stored in
2918 * union wpa_event_data::p2p_go_neg_completed.
2920 EVENT_P2P_GO_NEG_COMPLETED,
2922 EVENT_P2P_PROV_DISC_REQUEST,
2923 EVENT_P2P_PROV_DISC_RESPONSE,
2924 EVENT_P2P_SD_REQUEST,
2925 EVENT_P2P_SD_RESPONSE,
2928 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
2930 EVENT_IBSS_PEER_LOST,
2933 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
2935 * This event carries the new replay counter to notify wpa_supplicant
2936 * of the current EAPOL-Key Replay Counter in case the driver/firmware
2937 * completed Group Key Handshake while the host (including
2938 * wpa_supplicant was sleeping).
2940 EVENT_DRIVER_GTK_REKEY,
2943 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
2945 EVENT_SCHED_SCAN_STOPPED,
2948 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
2950 * This event indicates that the station responded to the poll
2951 * initiated with @poll_client.
2953 EVENT_DRIVER_CLIENT_POLL_OK,
2956 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
2958 EVENT_EAPOL_TX_STATUS
2963 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
2965 union wpa_event_data {
2967 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
2969 * This structure is optional for EVENT_ASSOC calls and required for
2970 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
2971 * driver interface does not need to generate separate EVENT_ASSOCINFO
2976 * reassoc - Flag to indicate association or reassociation
2981 * req_ies - (Re)Association Request IEs
2983 * If the driver generates WPA/RSN IE, this event data must be
2984 * returned for WPA handshake to have needed information. If
2985 * wpa_supplicant-generated WPA/RSN IE is used, this
2986 * information event is optional.
2988 * This should start with the first IE (fixed fields before IEs
2989 * are not included).
2994 * req_ies_len - Length of req_ies in bytes
2999 * resp_ies - (Re)Association Response IEs
3001 * Optional association data from the driver. This data is not
3002 * required WPA, but may be useful for some protocols and as
3003 * such, should be reported if this is available to the driver
3006 * This should start with the first IE (fixed fields before IEs
3007 * are not included).
3012 * resp_ies_len - Length of resp_ies in bytes
3014 size_t resp_ies_len;
3017 * beacon_ies - Beacon or Probe Response IEs
3019 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3020 * Probe Response frames from the current AP (i.e., the one
3021 * that the client just associated with). This information is
3022 * used to update WPA/RSN IE for the AP. If this field is not
3023 * set, the results from previous scan will be used. If no
3024 * data for the new AP is found, scan results will be requested
3025 * again (without scan request). At this point, the driver is
3026 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3029 * This should start with the first IE (fixed fields before IEs
3030 * are not included).
3032 const u8 *beacon_ies;
3035 * beacon_ies_len - Length of beacon_ies */
3036 size_t beacon_ies_len;
3039 * freq - Frequency of the operational channel in MHz
3044 * addr - Station address (for AP mode)
3050 * struct disassoc_info - Data for EVENT_DISASSOC events
3052 struct disassoc_info {
3054 * addr - Station address (for AP mode)
3059 * reason_code - Reason Code (host byte order) used in
3060 * Deauthentication frame
3065 * ie - Optional IE(s) in Disassociation frame
3070 * ie_len - Length of ie buffer in octets
3075 * locally_generated - Whether the frame was locally generated
3077 int locally_generated;
3081 * struct deauth_info - Data for EVENT_DEAUTH events
3083 struct deauth_info {
3085 * addr - Station address (for AP mode)
3090 * reason_code - Reason Code (host byte order) used in
3091 * Deauthentication frame
3096 * ie - Optional IE(s) in Deauthentication frame
3101 * ie_len - Length of ie buffer in octets
3106 * locally_generated - Whether the frame was locally generated
3108 int locally_generated;
3112 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3114 struct michael_mic_failure {
3117 } michael_mic_failure;
3120 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3122 struct interface_status {
3125 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3130 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3132 struct pmkid_candidate {
3133 /** BSSID of the PMKID candidate */
3135 /** Smaller the index, higher the priority */
3137 /** Whether RSN IE includes pre-authenticate flag */
3142 * struct stkstart - Data for EVENT_STKSTART
3149 * struct tdls - Data for EVENT_TDLS
3155 TDLS_REQUEST_TEARDOWN
3157 u16 reason_code; /* for teardown */
3161 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3163 * During FT (IEEE 802.11r) authentication sequence, the driver is
3164 * expected to use this event to report received FT IEs (MDIE, FTIE,
3165 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3166 * IEs for the next message will be delivered through the
3167 * struct wpa_driver_ops::update_ft_ies() callback.
3173 u8 target_ap[ETH_ALEN];
3174 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3176 /** Length of ric_ies buffer in octets */
3181 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3183 struct ibss_rsn_start {
3188 * struct auth_info - Data for EVENT_AUTH events
3194 u16 auth_transaction;
3201 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3203 struct assoc_reject {
3205 * bssid - BSSID of the AP that rejected association
3210 * resp_ies - (Re)Association Response IEs
3212 * Optional association data from the driver. This data is not
3213 * required WPA, but may be useful for some protocols and as
3214 * such, should be reported if this is available to the driver
3217 * This should start with the first IE (fixed fields before IEs
3218 * are not included).
3223 * resp_ies_len - Length of resp_ies in bytes
3225 size_t resp_ies_len;
3228 * status_code - Status Code from (Re)association Response
3233 struct timeout_event {
3238 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3247 * struct tx_status - Data for EVENT_TX_STATUS events
3259 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3261 struct rx_from_unknown {
3268 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3274 int ssi_signal; /* dBm */
3278 * struct rx_action - Data for EVENT_RX_ACTION events
3282 * da - Destination address of the received Action frame
3287 * sa - Source address of the received Action frame
3292 * bssid - Address 3 of the received Action frame
3297 * category - Action frame category
3302 * data - Action frame body after category field
3307 * len - Length of data in octets
3312 * freq - Frequency (in MHz) on which the frame was received
3318 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3320 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3322 struct remain_on_channel {
3324 * freq - Channel frequency in MHz
3329 * duration - Duration to remain on the channel in milliseconds
3331 unsigned int duration;
3332 } remain_on_channel;
3335 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3336 * @aborted: Whether the scan was aborted
3337 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3338 * @num_freqs: Number of entries in freqs array
3339 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3341 * @num_ssids: Number of entries in ssids array
3347 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3352 * struct mlme_rx - Data for EVENT_MLME_RX events
3363 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3365 struct rx_probe_req {
3367 * sa - Source address of the received Probe Request frame
3372 * da - Destination address of the received Probe Request frame
3373 * or %NULL if not available
3378 * bssid - BSSID of the received Probe Request frame or %NULL
3384 * ie - IEs from the Probe Request body
3389 * ie_len - Length of ie buffer in octets
3394 * signal - signal strength in dBm (or 0 if not available)
3400 * struct new_sta - Data for EVENT_NEW_STA events
3407 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3416 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3418 struct wpa_signal_info signal_change;
3421 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3422 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3423 * @freq_5: Best 5 GHz band channel frequency in MHz
3424 * @freq_overall: Best channel frequency in MHz
3426 * 0 can be used to indicate no preference in either band.
3428 struct best_channel {
3434 struct unprot_deauth {
3440 struct unprot_disassoc {
3447 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3448 * @addr: station address
3455 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3457 struct p2p_dev_found {
3460 const u8 *pri_dev_type;
3461 const char *dev_name;
3468 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3470 struct p2p_go_neg_req_rx {
3473 } p2p_go_neg_req_rx;
3476 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3478 struct p2p_go_neg_completed {
3479 struct p2p_go_neg_results *res;
3480 } p2p_go_neg_completed;
3482 struct p2p_prov_disc_req {
3486 const u8 *pri_dev_type;
3487 const char *dev_name;
3488 u16 supp_config_methods;
3491 } p2p_prov_disc_req;
3493 struct p2p_prov_disc_resp {
3496 } p2p_prov_disc_resp;
3507 struct p2p_sd_resp {
3515 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3517 struct ibss_peer_lost {
3522 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3524 struct driver_gtk_rekey {
3526 const u8 *replay_ctr;
3530 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
3531 * @addr: station address
3533 struct client_poll {
3538 * struct eapol_tx_status
3539 * @dst: Original destination
3540 * @data: Data starting with IEEE 802.1X header (!)
3541 * @data_len: Length of data
3542 * @ack: Indicates ack or lost frame
3544 * This corresponds to hapd_send_eapol if the frame sent
3545 * there isn't just reported as EVENT_TX_STATUS.
3547 struct eapol_tx_status {
3556 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3557 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3558 * with struct wpa_driver_ops::init()
3559 * @event: event type (defined above)
3560 * @data: possible extra data for the event
3562 * Driver wrapper code should call this function whenever an event is received
3565 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
3566 union wpa_event_data *data);
3570 * The following inline functions are provided for convenience to simplify
3571 * event indication for some of the common events.
3574 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
3575 size_t ielen, int reassoc)
3577 union wpa_event_data event;
3578 os_memset(&event, 0, sizeof(event));
3579 event.assoc_info.reassoc = reassoc;
3580 event.assoc_info.req_ies = ie;
3581 event.assoc_info.req_ies_len = ielen;
3582 event.assoc_info.addr = addr;
3583 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
3586 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
3588 union wpa_event_data event;
3589 os_memset(&event, 0, sizeof(event));
3590 event.disassoc_info.addr = addr;
3591 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
3594 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
3597 union wpa_event_data event;
3598 os_memset(&event, 0, sizeof(event));
3599 event.eapol_rx.src = src;
3600 event.eapol_rx.data = data;
3601 event.eapol_rx.data_len = data_len;
3602 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
3605 /* driver_common.c */
3606 void wpa_scan_results_free(struct wpa_scan_results *res);
3608 /* Convert wpa_event_type to a string for logging */
3609 const char * event_to_string(enum wpa_event_type event);
3611 #endif /* DRIVER_H */