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
104 * vht_capab - VHT (IEEE 802.11ac) capabilities
109 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
113 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
117 #define IEEE80211_MODE_INFRA 0
118 #define IEEE80211_MODE_IBSS 1
119 #define IEEE80211_MODE_AP 2
121 #define IEEE80211_CAP_ESS 0x0001
122 #define IEEE80211_CAP_IBSS 0x0002
123 #define IEEE80211_CAP_PRIVACY 0x0010
125 #define WPA_SCAN_QUAL_INVALID BIT(0)
126 #define WPA_SCAN_NOISE_INVALID BIT(1)
127 #define WPA_SCAN_LEVEL_INVALID BIT(2)
128 #define WPA_SCAN_LEVEL_DBM BIT(3)
129 #define WPA_SCAN_AUTHENTICATED BIT(4)
130 #define WPA_SCAN_ASSOCIATED BIT(5)
133 * struct wpa_scan_res - Scan result for an BSS/IBSS
134 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
136 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
137 * @beacon_int: beacon interval in TUs (host byte order)
138 * @caps: capability information field in host byte order
139 * @qual: signal quality
140 * @noise: noise level
141 * @level: signal level
143 * @age: Age of the information in milliseconds (i.e., how many milliseconds
144 * ago the last Beacon or Probe Response frame was received)
145 * @ie_len: length of the following IE field in octets
146 * @beacon_ie_len: length of the following Beacon IE field in octets
148 * This structure is used as a generic format for scan results from the
149 * driver. Each driver interface implementation is responsible for converting
150 * the driver or OS specific scan results into this format.
152 * If the driver does not support reporting all IEs, the IE data structure is
153 * constructed of the IEs that are available. This field will also need to
154 * include SSID in IE format. All drivers are encouraged to be extended to
155 * report all IEs to make it easier to support future additions.
157 struct wpa_scan_res {
169 size_t beacon_ie_len;
171 * Followed by ie_len octets of IEs from Probe Response frame (or if
172 * the driver does not indicate source of IEs, these may also be from
173 * Beacon frame). After the first set of IEs, another set of IEs may
174 * follow (with beacon_ie_len octets of data) if the driver provides
180 * struct wpa_scan_results - Scan results
181 * @res: Array of pointers to allocated variable length scan result entries
182 * @num: Number of entries in the scan result array
184 struct wpa_scan_results {
185 struct wpa_scan_res **res;
190 * struct wpa_interface_info - Network interface information
191 * @next: Pointer to the next interface or NULL if this is the last one
192 * @ifname: Interface name that can be used with init() or init2()
193 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
195 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
196 * is not an allocated copy, i.e., get_interfaces() caller will not free
199 struct wpa_interface_info {
200 struct wpa_interface_info *next;
203 const char *drv_name;
206 #define WPAS_MAX_SCAN_SSIDS 16
209 * struct wpa_driver_scan_params - Scan parameters
210 * Data for struct wpa_driver_ops::scan2().
212 struct wpa_driver_scan_params {
214 * ssids - SSIDs to scan for
216 struct wpa_driver_scan_ssid {
218 * ssid - specific SSID to scan for (ProbeReq)
219 * %NULL or zero-length SSID is used to indicate active scan
220 * with wildcard SSID.
224 * ssid_len: Length of the SSID in octets
227 } ssids[WPAS_MAX_SCAN_SSIDS];
230 * num_ssids - Number of entries in ssids array
231 * Zero indicates a request for a passive scan.
236 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
241 * extra_ies_len - Length of extra_ies in octets
243 size_t extra_ies_len;
246 * freqs - Array of frequencies to scan or %NULL for all frequencies
248 * The frequency is set in MHz. The array is zero-terminated.
253 * filter_ssids - Filter for reporting SSIDs
255 * This optional parameter can be used to request the driver wrapper to
256 * filter scan results to include only the specified SSIDs. %NULL
257 * indicates that no filtering is to be done. This can be used to
258 * reduce memory needs for scan results in environments that have large
259 * number of APs with different SSIDs.
261 * The driver wrapper is allowed to take this allocated buffer into its
262 * own use by setting the pointer to %NULL. In that case, the driver
263 * wrapper is responsible for freeing the buffer with os_free() once it
264 * is not needed anymore.
266 struct wpa_driver_scan_filter {
272 * num_filter_ssids - Number of entries in filter_ssids array
274 size_t num_filter_ssids;
277 * filter_rssi - Filter by RSSI
279 * The driver may filter scan results in firmware to reduce host
280 * wakeups and thereby save power. Specify the RSSI threshold in s32
286 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
288 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
289 * Mbps from the support rates element(s) in the Probe Request frames
290 * and not to transmit the frames at any of those rates.
296 * struct wpa_driver_auth_params - Authentication parameters
297 * Data for struct wpa_driver_ops::authenticate().
299 struct wpa_driver_auth_params {
307 const u8 *wep_key[4];
308 size_t wep_key_len[4];
310 int local_state_change;
313 * p2p - Whether this connection is a P2P group
320 WPS_MODE_NONE /* no WPS provisioning being used */,
321 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
322 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
327 * struct wpa_driver_associate_params - Association parameters
328 * Data for struct wpa_driver_ops::associate().
330 struct wpa_driver_associate_params {
332 * bssid - BSSID of the selected AP
333 * This can be %NULL, if ap_scan=2 mode is used and the driver is
334 * responsible for selecting with which BSS to associate. */
338 * ssid - The selected SSID
343 * ssid_len - Length of the SSID (1..32)
348 * freq - Frequency of the channel the selected AP is using
349 * Frequency that the selected AP is using (in MHz as
350 * reported in the scan results)
355 * bg_scan_period - Background scan period in seconds, 0 to disable
356 * background scan, or -1 to indicate no change to default driver
362 * wpa_ie - WPA information element for (Re)Association Request
363 * WPA information element to be included in (Re)Association
364 * Request (including information element id and length). Use
365 * of this WPA IE is optional. If the driver generates the WPA
366 * IE, it can use pairwise_suite, group_suite, and
367 * key_mgmt_suite to select proper algorithms. In this case,
368 * the driver has to notify wpa_supplicant about the used WPA
369 * IE by generating an event that the interface code will
370 * convert into EVENT_ASSOCINFO data (see below).
372 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
373 * instead. The driver can determine which version is used by
374 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
377 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
382 * wpa_ie_len - length of the wpa_ie
387 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
389 unsigned int wpa_proto;
392 * pairwise_suite - Selected pairwise cipher suite
394 * This is usually ignored if @wpa_ie is used.
396 enum wpa_cipher pairwise_suite;
399 * group_suite - Selected group cipher suite
401 * This is usually ignored if @wpa_ie is used.
403 enum wpa_cipher group_suite;
406 * key_mgmt_suite - Selected key management suite
408 * This is usually ignored if @wpa_ie is used.
410 enum wpa_key_mgmt key_mgmt_suite;
413 * auth_alg - Allowed authentication algorithms
414 * Bit field of WPA_AUTH_ALG_*
419 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
424 * wep_key - WEP keys for static WEP configuration
426 const u8 *wep_key[4];
429 * wep_key_len - WEP key length for static WEP configuration
431 size_t wep_key_len[4];
434 * wep_tx_keyidx - WEP TX key index for static WEP configuration
439 * mgmt_frame_protection - IEEE 802.11w management frame protection
441 enum mfp_options mgmt_frame_protection;
444 * ft_ies - IEEE 802.11r / FT information elements
445 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
446 * for fast transition, this parameter is set to include the IEs that
447 * are to be sent in the next FT Authentication Request message.
448 * update_ft_ies() handler is called to update the IEs for further
449 * FT messages in the sequence.
451 * The driver should use these IEs only if the target AP is advertising
452 * the same mobility domain as the one included in the MDIE here.
454 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
455 * AP after the initial association. These IEs can only be used if the
456 * target AP is advertising support for FT and is using the same MDIE
457 * and SSID as the current AP.
459 * The driver is responsible for reporting the FT IEs received from the
460 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
461 * type. update_ft_ies() handler will then be called with the FT IEs to
462 * include in the next frame in the authentication sequence.
467 * ft_ies_len - Length of ft_ies in bytes
472 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
474 * This value is provided to allow the driver interface easier access
475 * to the current mobility domain. This value is set to %NULL if no
476 * mobility domain is currently active.
481 * passphrase - RSN passphrase for PSK
483 * This value is made available only for WPA/WPA2-Personal (PSK) and
484 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
485 * the 8..63 character ASCII passphrase, if available. Please note that
486 * this can be %NULL if passphrase was not used to generate the PSK. In
487 * that case, the psk field must be used to fetch the PSK.
489 const char *passphrase;
492 * psk - RSN PSK (alternative for passphrase for PSK)
494 * This value is made available only for WPA/WPA2-Personal (PSK) and
495 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
496 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
497 * be prepared to handle %NULL value as an error.
502 * drop_unencrypted - Enable/disable unencrypted frame filtering
504 * Configure the driver to drop all non-EAPOL frames (both receive and
505 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
506 * still be allowed for key negotiation.
508 int drop_unencrypted;
511 * prev_bssid - Previously used BSSID in this ESS
513 * When not %NULL, this is a request to use reassociation instead of
516 const u8 *prev_bssid;
521 * If the driver needs to do special configuration for WPS association,
522 * this variable provides more information on what type of association
523 * is being requested. Most drivers should not need ot use this.
528 * p2p - Whether this connection is a P2P group
533 * uapsd - UAPSD parameters for the network
534 * -1 = do not change defaults
535 * AP mode: 1 = enabled, 0 = disabled
536 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
541 * fixed_bssid - Whether to force this BSSID in IBSS mode
542 * 1 = Fix this BSSID and prevent merges.
543 * 0 = Do not fix BSSID.
548 * disable_ht - Disable HT (IEEE 802.11n) for this connection
553 * HT Capabilities over-rides. Only bits set in the mask will be used,
554 * and not all values are used by the kernel anyway. Currently, MCS,
555 * MPDU and MSDU fields are used.
557 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */
558 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */
563 HIDDEN_SSID_ZERO_LEN,
564 HIDDEN_SSID_ZERO_CONTENTS
567 struct wpa_driver_ap_params {
569 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
574 * head_len - Length of the head buffer in octets
579 * tail - Beacon tail following TIM IE
584 * tail_len - Length of the tail buffer in octets
589 * dtim_period - DTIM period
594 * beacon_int - Beacon interval
599 * basic_rates: -1 terminated array of basic rates in 100 kbps
601 * This parameter can be used to set a specific basic rate set for the
602 * BSS. If %NULL, default basic rate set is used.
607 * proberesp - Probe Response template
609 * This is used by drivers that reply to Probe Requests internally in
610 * AP mode and require the full Probe Response template.
615 * proberesp_len - Length of the proberesp buffer in octets
617 size_t proberesp_len;
620 * ssid - The SSID to use in Beacon/Probe Response frames
625 * ssid_len - Length of the SSID (1..32)
630 * hide_ssid - Whether to hide the SSID
632 enum hide_ssid hide_ssid;
635 * pairwise_ciphers - WPA_CIPHER_* bitfield
637 unsigned int pairwise_ciphers;
640 * group_cipher - WPA_CIPHER_*
642 unsigned int group_cipher;
645 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
647 unsigned int key_mgmt_suites;
650 * auth_algs - WPA_AUTH_ALG_* bitfield
652 unsigned int auth_algs;
655 * wpa_version - WPA_PROTO_* bitfield
657 unsigned int wpa_version;
660 * privacy - Whether privacy is used in the BSS
665 * beacon_ies - WPS/P2P IE(s) for Beacon frames
667 * This is used to add IEs like WPS IE and P2P IE by drivers that do
668 * not use the full Beacon template.
670 const struct wpabuf *beacon_ies;
673 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
675 * This is used to add IEs like WPS IE and P2P IE by drivers that
676 * reply to Probe Request frames internally.
678 const struct wpabuf *proberesp_ies;
681 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
683 * This is used to add IEs like WPS IE by drivers that reply to
684 * (Re)Association Request frames internally.
686 const struct wpabuf *assocresp_ies;
689 * isolate - Whether to isolate frames between associated stations
691 * If this is non-zero, the AP is requested to disable forwarding of
692 * frames between associated stations.
697 * cts_protect - Whether CTS protection is enabled
702 * preamble - Whether short preamble is enabled
707 * short_slot_time - Whether short slot time is enabled
709 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
710 * not set (e.g., when 802.11g mode is not in use)
715 * ht_opmode - HT operation mode or -1 if HT not in use
720 * interworking - Whether Interworking is enabled
725 * hessid - Homogeneous ESS identifier or %NULL if not set
730 * access_network_type - Access Network Type (0..15)
732 * This is used for filtering Probe Request frames when Interworking is
735 u8 access_network_type;
738 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
740 * This is used by driver which advertises this capability.
742 int ap_max_inactivity;
745 * disable_dgaf - Whether group-addressed frames are disabled
751 * struct wpa_driver_capa - Driver capability information
753 struct wpa_driver_capa {
754 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
755 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
756 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
757 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
758 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
759 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
760 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
761 unsigned int key_mgmt;
763 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
764 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
765 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
766 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
767 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
770 #define WPA_DRIVER_AUTH_OPEN 0x00000001
771 #define WPA_DRIVER_AUTH_SHARED 0x00000002
772 #define WPA_DRIVER_AUTH_LEAP 0x00000004
775 /* Driver generated WPA/RSN IE */
776 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
777 /* Driver needs static WEP key setup after association command */
778 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
779 /* unused: 0x00000004 */
780 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
781 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
782 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
783 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
784 /* Driver provides separate commands for authentication and association (SME in
785 * wpa_supplicant). */
786 #define WPA_DRIVER_FLAGS_SME 0x00000020
787 /* Driver supports AP mode */
788 #define WPA_DRIVER_FLAGS_AP 0x00000040
789 /* Driver needs static WEP key setup after association has been completed */
790 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
791 /* Driver takes care of P2P management operations */
792 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
793 /* Driver supports concurrent P2P operations */
794 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
796 * Driver uses the initial interface as a dedicated management interface, i.e.,
797 * it cannot be used for P2P group operations or non-P2P purposes.
799 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
800 /* This interface is P2P capable (P2P Device, GO, or P2P Client */
801 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
802 /* Driver supports concurrent operations on multiple channels */
803 #define WPA_DRIVER_FLAGS_MULTI_CHANNEL_CONCURRENT 0x00001000
805 * Driver uses the initial interface for P2P management interface and non-P2P
806 * purposes (e.g., connect to infra AP), but this interface cannot be used for
807 * P2P group operations.
809 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
811 * Driver is known to use sane error codes, i.e., when it indicates that
812 * something (e.g., association) fails, there was indeed a failure and the
813 * operation does not end up getting completed successfully later.
815 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
816 /* Driver supports off-channel TX */
817 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
818 /* Driver indicates TX status events for EAPOL Data frames */
819 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
820 /* Driver indicates TX status events for Deauth/Disassoc frames */
821 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
822 /* Driver supports roaming (BSS selection) in firmware */
823 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
824 /* Driver supports operating as a TDLS peer */
825 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
826 /* Driver requires external TDLS setup/teardown/discovery */
827 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
828 /* Driver indicates support for Probe Response offloading in AP mode */
829 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
830 /* Driver supports U-APSD in AP mode */
831 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
832 /* Driver supports inactivity timer in AP mode */
833 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
834 /* Driver expects user space implementation of MLME in AP mode */
835 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
839 int max_sched_scan_ssids;
840 int sched_scan_supported;
844 * max_remain_on_chan - Maximum remain-on-channel duration in msec
846 unsigned int max_remain_on_chan;
849 * max_stations - Maximum number of associated stations the driver
850 * supports in AP mode
852 unsigned int max_stations;
855 * probe_resp_offloads - Bitmap of supported protocols by the driver
856 * for Probe Response offloading.
858 /* Driver Probe Response offloading support for WPS ver. 1 */
859 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
860 /* Driver Probe Response offloading support for WPS ver. 2 */
861 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
862 /* Driver Probe Response offloading support for P2P */
863 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
864 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
865 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
866 unsigned int probe_resp_offloads;
872 struct hostap_sta_driver_data {
873 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
874 unsigned long current_tx_rate;
875 unsigned long inactive_msec;
877 unsigned long num_ps_buf_frames;
878 unsigned long tx_retry_failed;
879 unsigned long tx_retry_count;
884 struct hostapd_sta_add_params {
888 const u8 *supp_rates;
889 size_t supp_rates_len;
891 const struct ieee80211_ht_capabilities *ht_capabilities;
892 u32 flags; /* bitmask of WPA_STA_* flags */
893 int set; /* Set STA parameters instead of add */
897 struct hostapd_freq_params {
902 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
903 * secondary channel below primary, 1 = HT40
904 * enabled, secondary channel above primary */
907 enum wpa_driver_if_type {
909 * WPA_IF_STATION - Station mode interface
914 * WPA_IF_AP_VLAN - AP mode VLAN interface
916 * This interface shares its address and Beacon frame with the main
922 * WPA_IF_AP_BSS - AP mode BSS interface
924 * This interface has its own address and Beacon frame.
929 * WPA_IF_P2P_GO - P2P Group Owner
934 * WPA_IF_P2P_CLIENT - P2P Client
939 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
940 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
945 struct wpa_init_params {
951 const char *test_socket;
952 int use_pae_group_addr;
956 u8 *own_addr; /* buffer for writing own MAC address */
960 struct wpa_bss_params {
961 /** Interface name (for multi-SSID/VLAN support) */
963 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
972 enum mfp_options ieee80211w;
975 #define WPA_STA_AUTHORIZED BIT(0)
976 #define WPA_STA_WMM BIT(1)
977 #define WPA_STA_SHORT_PREAMBLE BIT(2)
978 #define WPA_STA_MFP BIT(3)
979 #define WPA_STA_TDLS_PEER BIT(4)
982 * struct p2p_params - P2P parameters for driver-based P2P management
985 const char *dev_name;
987 #define DRV_MAX_SEC_DEV_TYPES 5
988 u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8];
989 size_t num_sec_dev_types;
1003 * struct wpa_signal_info - Information about channel signal quality
1005 struct wpa_signal_info {
1007 int above_threshold;
1014 * struct wpa_driver_ops - Driver interface API definition
1016 * This structure defines the API that each driver interface needs to implement
1017 * for core wpa_supplicant code. All driver specific functionality is captured
1020 struct wpa_driver_ops {
1021 /** Name of the driver interface */
1023 /** One line description of the driver interface */
1027 * get_bssid - Get the current BSSID
1028 * @priv: private driver interface data
1029 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1031 * Returns: 0 on success, -1 on failure
1033 * Query kernel driver for the current BSSID and copy it to bssid.
1034 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1037 int (*get_bssid)(void *priv, u8 *bssid);
1040 * get_ssid - Get the current SSID
1041 * @priv: private driver interface data
1042 * @ssid: buffer for SSID (at least 32 bytes)
1044 * Returns: Length of the SSID on success, -1 on failure
1046 * Query kernel driver for the current SSID and copy it to ssid.
1047 * Returning zero is recommended if the STA is not associated.
1049 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1050 * can, at least in theory, contain control characters (including nul)
1051 * and as such, should be processed as binary data, not a printable
1054 int (*get_ssid)(void *priv, u8 *ssid);
1057 * set_key - Configure encryption key
1058 * @ifname: Interface name (for multi-SSID/VLAN support)
1059 * @priv: private driver interface data
1060 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1061 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
1062 * %WPA_ALG_NONE clears the key.
1063 * @addr: Address of the peer STA (BSSID of the current AP when setting
1064 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1065 * broadcast keys, %NULL for default keys that are used both for
1066 * broadcast and unicast; when clearing keys, %NULL is used to
1067 * indicate that both the broadcast-only and default key of the
1068 * specified key index is to be cleared
1069 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1071 * @set_tx: configure this key as the default Tx key (only used when
1072 * driver does not support separate unicast/individual key
1073 * @seq: sequence number/packet number, seq_len octets, the next
1074 * packet number to be used for in replay protection; configured
1075 * for Rx keys (in most cases, this is only used with broadcast
1076 * keys and set to zero for unicast keys); %NULL if not set
1077 * @seq_len: length of the seq, depends on the algorithm:
1078 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
1079 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1081 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1082 * TKIP: 32, CCMP: 16, IGTK: 16)
1084 * Returns: 0 on success, -1 on failure
1086 * Configure the given key for the kernel driver. If the driver
1087 * supports separate individual keys (4 default keys + 1 individual),
1088 * addr can be used to determine whether the key is default or
1089 * individual. If only 4 keys are supported, the default key with key
1090 * index 0 is used as the individual key. STA must be configured to use
1091 * it as the default Tx key (set_tx is set) and accept Rx for all the
1092 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1093 * broadcast keys, so key index 0 is available for this kind of
1096 * Please note that TKIP keys include separate TX and RX MIC keys and
1097 * some drivers may expect them in different order than wpa_supplicant
1098 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1099 * will trigger Michael MIC errors. This can be fixed by changing the
1100 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1101 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1102 * example on how this can be done.
1104 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1105 const u8 *addr, int key_idx, int set_tx,
1106 const u8 *seq, size_t seq_len,
1107 const u8 *key, size_t key_len);
1110 * init - Initialize driver interface
1111 * @ctx: context to be used when calling wpa_supplicant functions,
1112 * e.g., wpa_supplicant_event()
1113 * @ifname: interface name, e.g., wlan0
1115 * Returns: Pointer to private data, %NULL on failure
1117 * Initialize driver interface, including event processing for kernel
1118 * driver events (e.g., associated, scan results, Michael MIC failure).
1119 * This function can allocate a private configuration data area for
1120 * @ctx, file descriptor, interface name, etc. information that may be
1121 * needed in future driver operations. If this is not used, non-NULL
1122 * value will need to be returned because %NULL is used to indicate
1123 * failure. The returned value will be used as 'void *priv' data for
1124 * all other driver_ops functions.
1126 * The main event loop (eloop.c) of wpa_supplicant can be used to
1127 * register callback for read sockets (eloop_register_read_sock()).
1129 * See below for more information about events and
1130 * wpa_supplicant_event() function.
1132 void * (*init)(void *ctx, const char *ifname);
1135 * deinit - Deinitialize driver interface
1136 * @priv: private driver interface data from init()
1138 * Shut down driver interface and processing of driver events. Free
1139 * private data buffer if one was allocated in init() handler.
1141 void (*deinit)(void *priv);
1144 * set_param - Set driver configuration parameters
1145 * @priv: private driver interface data from init()
1146 * @param: driver specific configuration parameters
1148 * Returns: 0 on success, -1 on failure
1150 * Optional handler for notifying driver interface about configuration
1151 * parameters (driver_param).
1153 int (*set_param)(void *priv, const char *param);
1156 * set_countermeasures - Enable/disable TKIP countermeasures
1157 * @priv: private driver interface data
1158 * @enabled: 1 = countermeasures enabled, 0 = disabled
1160 * Returns: 0 on success, -1 on failure
1162 * Configure TKIP countermeasures. When these are enabled, the driver
1163 * should drop all received and queued frames that are using TKIP.
1165 int (*set_countermeasures)(void *priv, int enabled);
1168 * deauthenticate - Request driver to deauthenticate
1169 * @priv: private driver interface data
1170 * @addr: peer address (BSSID of the AP)
1171 * @reason_code: 16-bit reason code to be sent in the deauthentication
1174 * Returns: 0 on success, -1 on failure
1176 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1179 * disassociate - Request driver to disassociate
1180 * @priv: private driver interface data
1181 * @addr: peer address (BSSID of the AP)
1182 * @reason_code: 16-bit reason code to be sent in the disassociation
1185 * Returns: 0 on success, -1 on failure
1187 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
1190 * associate - Request driver to associate
1191 * @priv: private driver interface data
1192 * @params: association parameters
1194 * Returns: 0 on success, -1 on failure
1196 int (*associate)(void *priv,
1197 struct wpa_driver_associate_params *params);
1200 * add_pmkid - Add PMKSA cache entry to the driver
1201 * @priv: private driver interface data
1202 * @bssid: BSSID for the PMKSA cache entry
1203 * @pmkid: PMKID for the PMKSA cache entry
1205 * Returns: 0 on success, -1 on failure
1207 * This function is called when a new PMK is received, as a result of
1208 * either normal authentication or RSN pre-authentication.
1210 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1211 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1212 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1213 * driver_ops function does not need to be implemented. Likewise, if
1214 * the driver does not support WPA, this function is not needed.
1216 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1219 * remove_pmkid - Remove PMKSA cache entry to the driver
1220 * @priv: private driver interface data
1221 * @bssid: BSSID for the PMKSA cache entry
1222 * @pmkid: PMKID for the PMKSA cache entry
1224 * Returns: 0 on success, -1 on failure
1226 * This function is called when the supplicant drops a PMKSA cache
1227 * entry for any reason.
1229 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1230 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1231 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1232 * from wpa_supplicant, this driver_ops function does not need to be
1233 * implemented. Likewise, if the driver does not support WPA, this
1234 * function is not needed.
1236 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1239 * flush_pmkid - Flush PMKSA cache
1240 * @priv: private driver interface data
1242 * Returns: 0 on success, -1 on failure
1244 * This function is called when the supplicant drops all PMKSA cache
1245 * entries for any reason.
1247 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1248 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1249 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1250 * from wpa_supplicant, this driver_ops function does not need to be
1251 * implemented. Likewise, if the driver does not support WPA, this
1252 * function is not needed.
1254 int (*flush_pmkid)(void *priv);
1257 * get_capa - Get driver capabilities
1258 * @priv: private driver interface data
1260 * Returns: 0 on success, -1 on failure
1262 * Get driver/firmware/hardware capabilities.
1264 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1267 * poll - Poll driver for association information
1268 * @priv: private driver interface data
1270 * This is an option callback that can be used when the driver does not
1271 * provide event mechanism for association events. This is called when
1272 * receiving WPA EAPOL-Key messages that require association
1273 * information. The driver interface is supposed to generate associnfo
1274 * event before returning from this callback function. In addition, the
1275 * driver interface should generate an association event after having
1276 * sent out associnfo.
1278 void (*poll)(void *priv);
1281 * get_ifname - Get interface name
1282 * @priv: private driver interface data
1284 * Returns: Pointer to the interface name. This can differ from the
1285 * interface name used in init() call. Init() is called first.
1287 * This optional function can be used to allow the driver interface to
1288 * replace the interface name with something else, e.g., based on an
1289 * interface mapping from a more descriptive name.
1291 const char * (*get_ifname)(void *priv);
1294 * get_mac_addr - Get own MAC address
1295 * @priv: private driver interface data
1297 * Returns: Pointer to own MAC address or %NULL on failure
1299 * This optional function can be used to get the own MAC address of the
1300 * device from the driver interface code. This is only needed if the
1301 * l2_packet implementation for the OS does not provide easy access to
1303 const u8 * (*get_mac_addr)(void *priv);
1306 * send_eapol - Optional function for sending EAPOL packets
1307 * @priv: private driver interface data
1308 * @dest: Destination MAC address
1310 * @data: EAPOL packet starting with IEEE 802.1X header
1311 * @data_len: Size of the EAPOL packet
1313 * Returns: 0 on success, -1 on failure
1315 * This optional function can be used to override l2_packet operations
1316 * with driver specific functionality. If this function pointer is set,
1317 * l2_packet module is not used at all and the driver interface code is
1318 * responsible for receiving and sending all EAPOL packets. The
1319 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1320 * event. The driver interface is required to implement get_mac_addr()
1321 * handler if send_eapol() is used.
1323 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1324 const u8 *data, size_t data_len);
1327 * set_operstate - Sets device operating state to DORMANT or UP
1328 * @priv: private driver interface data
1329 * @state: 0 = dormant, 1 = up
1330 * Returns: 0 on success, -1 on failure
1332 * This is an optional function that can be used on operating systems
1333 * that support a concept of controlling network device state from user
1334 * space applications. This function, if set, gets called with
1335 * state = 1 when authentication has been completed and with state = 0
1336 * when connection is lost.
1338 int (*set_operstate)(void *priv, int state);
1341 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1342 * @priv: Private driver interface data
1343 * @addr: Address of the station for which to set protection (may be
1344 * %NULL for group keys)
1345 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1346 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1347 * Returns: 0 on success, -1 on failure
1349 * This is an optional function that can be used to set the driver to
1350 * require protection for Tx and/or Rx frames. This uses the layer
1351 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1352 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1353 * set protection operation; instead, they set protection implicitly
1354 * based on configured keys.
1356 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1360 * get_hw_feature_data - Get hardware support data (channels and rates)
1361 * @priv: Private driver interface data
1362 * @num_modes: Variable for returning the number of returned modes
1363 * flags: Variable for returning hardware feature flags
1364 * Returns: Pointer to allocated hardware data on success or %NULL on
1365 * failure. Caller is responsible for freeing this.
1367 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1372 * send_mlme - Send management frame from MLME
1373 * @priv: Private driver interface data
1374 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1375 * @data_len: Size of the management frame
1376 * @noack: Do not wait for this frame to be acked (disable retries)
1377 * Returns: 0 on success, -1 on failure
1379 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1383 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1384 * @priv: Private driver interface data
1385 * @md: Mobility domain (2 octets) (also included inside ies)
1386 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1387 * @ies_len: Length of FT IEs in bytes
1388 * Returns: 0 on success, -1 on failure
1390 * The supplicant uses this callback to let the driver know that keying
1391 * material for FT is available and that the driver can use the
1392 * provided IEs in the next message in FT authentication sequence.
1394 * This function is only needed for driver that support IEEE 802.11r
1395 * (Fast BSS Transition).
1397 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1401 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1402 * @priv: Private driver interface data
1403 * @action: Action field value
1404 * @target_ap: Target AP address
1405 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1406 * @ies_len: Length of FT IEs in bytes
1407 * Returns: 0 on success, -1 on failure
1409 * The supplicant uses this callback to request the driver to transmit
1410 * an FT Action frame (action category 6) for over-the-DS fast BSS
1413 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1414 const u8 *ies, size_t ies_len);
1417 * get_scan_results2 - Fetch the latest scan results
1418 * @priv: private driver interface data
1420 * Returns: Allocated buffer of scan results (caller is responsible for
1421 * freeing the data structure) on success, NULL on failure
1423 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1426 * set_country - Set country
1427 * @priv: Private driver interface data
1428 * @alpha2: country to which to switch to
1429 * Returns: 0 on success, -1 on failure
1431 * This function is for drivers which support some form
1432 * of setting a regulatory domain.
1434 int (*set_country)(void *priv, const char *alpha2);
1437 * global_init - Global driver initialization
1438 * Returns: Pointer to private data (global), %NULL on failure
1440 * This optional function is called to initialize the driver wrapper
1441 * for global data, i.e., data that applies to all interfaces. If this
1442 * function is implemented, global_deinit() will also need to be
1443 * implemented to free the private data. The driver will also likely
1444 * use init2() function instead of init() to get the pointer to global
1445 * data available to per-interface initializer.
1447 void * (*global_init)(void);
1450 * global_deinit - Global driver deinitialization
1451 * @priv: private driver global data from global_init()
1453 * Terminate any global driver related functionality and free the
1454 * global data structure.
1456 void (*global_deinit)(void *priv);
1459 * init2 - Initialize driver interface (with global data)
1460 * @ctx: context to be used when calling wpa_supplicant functions,
1461 * e.g., wpa_supplicant_event()
1462 * @ifname: interface name, e.g., wlan0
1463 * @global_priv: private driver global data from global_init()
1464 * Returns: Pointer to private data, %NULL on failure
1466 * This function can be used instead of init() if the driver wrapper
1469 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1472 * get_interfaces - Get information about available interfaces
1473 * @global_priv: private driver global data from global_init()
1474 * Returns: Allocated buffer of interface information (caller is
1475 * responsible for freeing the data structure) on success, NULL on
1478 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1481 * scan2 - Request the driver to initiate scan
1482 * @priv: private driver interface data
1483 * @params: Scan parameters
1485 * Returns: 0 on success, -1 on failure
1487 * Once the scan results are ready, the driver should report scan
1488 * results event for wpa_supplicant which will eventually request the
1489 * results with wpa_driver_get_scan_results2().
1491 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1494 * authenticate - Request driver to authenticate
1495 * @priv: private driver interface data
1496 * @params: authentication parameters
1497 * Returns: 0 on success, -1 on failure
1499 * This is an optional function that can be used with drivers that
1500 * support separate authentication and association steps, i.e., when
1501 * wpa_supplicant can act as the SME. If not implemented, associate()
1502 * function is expected to take care of IEEE 802.11 authentication,
1505 int (*authenticate)(void *priv,
1506 struct wpa_driver_auth_params *params);
1509 * set_ap - Set Beacon and Probe Response information for AP mode
1510 * @priv: Private driver interface data
1511 * @params: Parameters to use in AP mode
1513 * This function is used to configure Beacon template and/or extra IEs
1514 * to add for Beacon and Probe Response frames for the driver in
1515 * AP mode. The driver is responsible for building the full Beacon
1516 * frame by concatenating the head part with TIM IE generated by the
1517 * driver/firmware and finishing with the tail part. Depending on the
1518 * driver architectue, this can be done either by using the full
1519 * template or the set of additional IEs (e.g., WPS and P2P IE).
1520 * Similarly, Probe Response processing depends on the driver design.
1521 * If the driver (or firmware) takes care of replying to Probe Request
1522 * frames, the extra IEs provided here needs to be added to the Probe
1525 * Returns: 0 on success, -1 on failure
1527 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1530 * hapd_init - Initialize driver interface (hostapd only)
1531 * @hapd: Pointer to hostapd context
1532 * @params: Configuration for the driver wrapper
1533 * Returns: Pointer to private data, %NULL on failure
1535 * This function is used instead of init() or init2() when the driver
1536 * wrapper is used with hostapd.
1538 void * (*hapd_init)(struct hostapd_data *hapd,
1539 struct wpa_init_params *params);
1542 * hapd_deinit - Deinitialize driver interface (hostapd only)
1543 * @priv: Private driver interface data from hapd_init()
1545 void (*hapd_deinit)(void *priv);
1548 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1549 * @priv: Private driver interface data
1550 * @params: BSS parameters
1551 * Returns: 0 on success, -1 on failure
1553 * This is an optional function to configure the kernel driver to
1554 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1555 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1556 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1557 * for Beacon frames.
1559 * DEPRECATED - use set_ap() instead
1561 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1564 * set_privacy - Enable/disable privacy (AP only)
1565 * @priv: Private driver interface data
1566 * @enabled: 1 = privacy enabled, 0 = disabled
1567 * Returns: 0 on success, -1 on failure
1569 * This is an optional function to configure privacy field in the
1570 * kernel driver for Beacon frames. This can be left undefined (set to
1571 * %NULL) if the driver uses the Beacon template from set_ap().
1573 * DEPRECATED - use set_ap() instead
1575 int (*set_privacy)(void *priv, int enabled);
1578 * get_seqnum - Fetch the current TSC/packet number (AP only)
1579 * @ifname: The interface name (main or virtual)
1580 * @priv: Private driver interface data
1581 * @addr: MAC address of the station or %NULL for group keys
1583 * @seq: Buffer for returning the latest used TSC/packet number
1584 * Returns: 0 on success, -1 on failure
1586 * This function is used to fetch the last used TSC/packet number for
1587 * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so
1588 * there is no strict requirement on implementing support for unicast
1589 * keys (i.e., addr != %NULL).
1591 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1595 * flush - Flush all association stations (AP only)
1596 * @priv: Private driver interface data
1597 * Returns: 0 on success, -1 on failure
1599 * This function requests the driver to disassociate all associated
1600 * stations. This function does not need to be implemented if the
1601 * driver does not process association frames internally.
1603 int (*flush)(void *priv);
1606 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1607 * @priv: Private driver interface data
1608 * @elem: Information elements
1609 * @elem_len: Length of the elem buffer in octets
1610 * Returns: 0 on success, -1 on failure
1612 * This is an optional function to add information elements in the
1613 * kernel driver for Beacon and Probe Response frames. This can be left
1614 * undefined (set to %NULL) if the driver uses the Beacon template from
1617 * DEPRECATED - use set_ap() instead
1619 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1622 * read_sta_data - Fetch station data (AP only)
1623 * @priv: Private driver interface data
1624 * @data: Buffer for returning station information
1625 * @addr: MAC address of the station
1626 * Returns: 0 on success, -1 on failure
1628 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1632 * hapd_send_eapol - Send an EAPOL packet (AP only)
1633 * @priv: private driver interface data
1634 * @addr: Destination MAC address
1635 * @data: EAPOL packet starting with IEEE 802.1X header
1636 * @data_len: Length of the EAPOL packet in octets
1637 * @encrypt: Whether the frame should be encrypted
1638 * @own_addr: Source MAC address
1639 * @flags: WPA_STA_* flags for the destination station
1641 * Returns: 0 on success, -1 on failure
1643 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1644 size_t data_len, int encrypt,
1645 const u8 *own_addr, u32 flags);
1648 * sta_deauth - Deauthenticate a station (AP only)
1649 * @priv: Private driver interface data
1650 * @own_addr: Source address and BSSID for the Deauthentication frame
1651 * @addr: MAC address of the station to deauthenticate
1652 * @reason: Reason code for the Deauthentiation frame
1653 * Returns: 0 on success, -1 on failure
1655 * This function requests a specific station to be deauthenticated and
1656 * a Deauthentication frame to be sent to it.
1658 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1662 * sta_disassoc - Disassociate a station (AP only)
1663 * @priv: Private driver interface data
1664 * @own_addr: Source address and BSSID for the Disassociation frame
1665 * @addr: MAC address of the station to disassociate
1666 * @reason: Reason code for the Disassociation frame
1667 * Returns: 0 on success, -1 on failure
1669 * This function requests a specific station to be disassociated and
1670 * a Disassociation frame to be sent to it.
1672 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1676 * sta_remove - Remove a station entry (AP only)
1677 * @priv: Private driver interface data
1678 * @addr: MAC address of the station to be removed
1679 * Returns: 0 on success, -1 on failure
1681 int (*sta_remove)(void *priv, const u8 *addr);
1684 * hapd_get_ssid - Get the current SSID (AP only)
1685 * @priv: Private driver interface data
1686 * @buf: Buffer for returning the SSID
1687 * @len: Maximum length of the buffer
1688 * Returns: Length of the SSID on success, -1 on failure
1690 * This function need not be implemented if the driver uses Beacon
1691 * template from set_ap() and does not reply to Probe Request frames.
1693 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1696 * hapd_set_ssid - Set SSID (AP only)
1697 * @priv: Private driver interface data
1699 * @len: Length of the SSID in octets
1700 * Returns: 0 on success, -1 on failure
1702 * DEPRECATED - use set_ap() instead
1704 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1707 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1708 * @priv: Private driver interface data
1709 * @enabled: 1 = countermeasures enabled, 0 = disabled
1710 * Returns: 0 on success, -1 on failure
1712 * This need not be implemented if the driver does not take care of
1713 * association processing.
1715 int (*hapd_set_countermeasures)(void *priv, int enabled);
1718 * sta_add - Add a station entry
1719 * @priv: Private driver interface data
1720 * @params: Station parameters
1721 * Returns: 0 on success, -1 on failure
1723 * This function is used to add a station entry to the driver once the
1724 * station has completed association. This is only used if the driver
1725 * does not take care of association processing.
1727 * With TDLS, this function is also used to add or set (params->set 1)
1728 * TDLS peer entries.
1730 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1733 * get_inact_sec - Get station inactivity duration (AP only)
1734 * @priv: Private driver interface data
1735 * @addr: Station address
1736 * Returns: Number of seconds station has been inactive, -1 on failure
1738 int (*get_inact_sec)(void *priv, const u8 *addr);
1741 * sta_clear_stats - Clear station statistics (AP only)
1742 * @priv: Private driver interface data
1743 * @addr: Station address
1744 * Returns: 0 on success, -1 on failure
1746 int (*sta_clear_stats)(void *priv, const u8 *addr);
1749 * set_freq - Set channel/frequency (AP only)
1750 * @priv: Private driver interface data
1751 * @freq: Channel parameters
1752 * Returns: 0 on success, -1 on failure
1754 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1757 * set_rts - Set RTS threshold
1758 * @priv: Private driver interface data
1759 * @rts: RTS threshold in octets
1760 * Returns: 0 on success, -1 on failure
1762 int (*set_rts)(void *priv, int rts);
1765 * set_frag - Set fragmentation threshold
1766 * @priv: Private driver interface data
1767 * @frag: Fragmentation threshold in octets
1768 * Returns: 0 on success, -1 on failure
1770 int (*set_frag)(void *priv, int frag);
1773 * sta_set_flags - Set station flags (AP only)
1774 * @priv: Private driver interface data
1775 * @addr: Station address
1776 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1777 * @flags_or: Bitmap of WPA_STA_* flags to add
1778 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1779 * Returns: 0 on success, -1 on failure
1781 int (*sta_set_flags)(void *priv, const u8 *addr,
1782 int total_flags, int flags_or, int flags_and);
1785 * set_tx_queue_params - Set TX queue parameters
1786 * @priv: Private driver interface data
1787 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
1791 * @burst_time: Maximum length for bursting in 0.1 msec units
1793 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1794 int cw_max, int burst_time);
1797 * if_add - Add a virtual interface
1798 * @priv: Private driver interface data
1799 * @type: Interface type
1800 * @ifname: Interface name for the new virtual interface
1801 * @addr: Local address to use for the interface or %NULL to use the
1802 * parent interface address
1803 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1804 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1805 * not allowed (applies only to %WPA_IF_AP_BSS type)
1806 * @force_ifname: Buffer for returning an interface name that the
1807 * driver ended up using if it differs from the requested ifname
1808 * @if_addr: Buffer for returning the allocated interface address
1809 * (this may differ from the requested addr if the driver cannot
1810 * change interface address)
1811 * @bridge: Bridge interface to use or %NULL if no bridge configured
1812 * Returns: 0 on success, -1 on failure
1814 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1815 const char *ifname, const u8 *addr, void *bss_ctx,
1816 void **drv_priv, char *force_ifname, u8 *if_addr,
1817 const char *bridge);
1820 * if_remove - Remove a virtual interface
1821 * @priv: Private driver interface data
1822 * @type: Interface type
1823 * @ifname: Interface name of the virtual interface to be removed
1824 * Returns: 0 on success, -1 on failure
1826 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1827 const char *ifname);
1830 * set_sta_vlan - Bind a station into a specific interface (AP only)
1831 * @priv: Private driver interface data
1832 * @ifname: Interface (main or virtual BSS or VLAN)
1833 * @addr: MAC address of the associated station
1835 * Returns: 0 on success, -1 on failure
1837 * This function is used to bind a station to a specific virtual
1838 * interface. It is only used if when virtual interfaces are supported,
1839 * e.g., to assign stations to different VLAN interfaces based on
1840 * information from a RADIUS server. This allows separate broadcast
1841 * domains to be used with a single BSS.
1843 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1847 * commit - Optional commit changes handler (AP only)
1848 * @priv: driver private data
1849 * Returns: 0 on success, -1 on failure
1851 * This optional handler function can be registered if the driver
1852 * interface implementation needs to commit changes (e.g., by setting
1853 * network interface up) at the end of initial configuration. If set,
1854 * this handler will be called after initial setup has been completed.
1856 int (*commit)(void *priv);
1859 * send_ether - Send an ethernet packet (AP only)
1860 * @priv: private driver interface data
1861 * @dst: Destination MAC address
1862 * @src: Source MAC address
1864 * @data: EAPOL packet starting with IEEE 802.1X header
1865 * @data_len: Length of the EAPOL packet in octets
1866 * Returns: 0 on success, -1 on failure
1868 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1869 const u8 *data, size_t data_len);
1872 * set_radius_acl_auth - Notification of RADIUS ACL change
1873 * @priv: Private driver interface data
1874 * @mac: MAC address of the station
1875 * @accepted: Whether the station was accepted
1876 * @session_timeout: Session timeout for the station
1877 * Returns: 0 on success, -1 on failure
1879 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1880 u32 session_timeout);
1883 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1884 * @priv: Private driver interface data
1885 * @mac: MAC address of the station
1886 * Returns: 0 on success, -1 on failure
1888 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1891 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
1892 * @priv: Private driver interface data
1893 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
1894 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
1896 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
1897 * to remove extra IE(s)
1898 * Returns: 0 on success, -1 on failure
1900 * This is an optional function to add WPS IE in the kernel driver for
1901 * Beacon and Probe Response frames. This can be left undefined (set
1902 * to %NULL) if the driver uses the Beacon template from set_ap()
1903 * and does not process Probe Request frames. If the driver takes care
1904 * of (Re)Association frame processing, the assocresp buffer includes
1905 * WPS IE(s) that need to be added to (Re)Association Response frames
1906 * whenever a (Re)Association Request frame indicated use of WPS.
1908 * This will also be used to add P2P IE(s) into Beacon/Probe Response
1909 * frames when operating as a GO. The driver is responsible for adding
1910 * timing related attributes (e.g., NoA) in addition to the IEs
1911 * included here by appending them after these buffers. This call is
1912 * also used to provide Probe Response IEs for P2P Listen state
1913 * operations for drivers that generate the Probe Response frames
1916 * DEPRECATED - use set_ap() instead
1918 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
1919 const struct wpabuf *proberesp,
1920 const struct wpabuf *assocresp);
1923 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1924 * @priv: Private driver interface data
1925 * @authorized: Whether the port is authorized
1926 * Returns: 0 on success, -1 on failure
1928 int (*set_supp_port)(void *priv, int authorized);
1931 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1932 * @priv: Private driver interface data
1933 * @addr: MAC address of the associated station
1934 * @aid: Association ID
1935 * @val: 1 = bind to 4-address WDS; 0 = unbind
1936 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
1937 * to indicate that bridge is not to be used
1938 * Returns: 0 on success, -1 on failure
1940 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
1941 const char *bridge_ifname);
1944 * send_action - Transmit an Action frame
1945 * @priv: Private driver interface data
1946 * @freq: Frequency (in MHz) of the channel
1947 * @wait: Time to wait off-channel for a response (in ms), or zero
1948 * @dst: Destination MAC address (Address 1)
1949 * @src: Source MAC address (Address 2)
1950 * @bssid: BSSID (Address 3)
1952 * @data_len: data length in octets
1953 @ @no_cck: Whether CCK rates must not be used to transmit this frame
1954 * Returns: 0 on success, -1 on failure
1956 * This command can be used to request the driver to transmit an action
1957 * frame to the specified destination.
1959 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
1960 * be transmitted on the given channel and the device will wait for a
1961 * response on that channel for the given wait time.
1963 * If the flag is not set, the wait time will be ignored. In this case,
1964 * if a remain-on-channel duration is in progress, the frame must be
1965 * transmitted on that channel; alternatively the frame may be sent on
1966 * the current operational channel (if in associated state in station
1967 * mode or while operating as an AP.)
1969 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
1970 const u8 *dst, const u8 *src, const u8 *bssid,
1971 const u8 *data, size_t data_len, int no_cck);
1974 * send_action_cancel_wait - Cancel action frame TX wait
1975 * @priv: Private driver interface data
1977 * This command cancels the wait time associated with sending an action
1978 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
1979 * set in the driver flags.
1981 void (*send_action_cancel_wait)(void *priv);
1984 * remain_on_channel - Remain awake on a channel
1985 * @priv: Private driver interface data
1986 * @freq: Frequency (in MHz) of the channel
1987 * @duration: Duration in milliseconds
1988 * Returns: 0 on success, -1 on failure
1990 * This command is used to request the driver to remain awake on the
1991 * specified channel for the specified duration and report received
1992 * Action frames with EVENT_RX_ACTION events. Optionally, received
1993 * Probe Request frames may also be requested to be reported by calling
1994 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
1996 * The driver may not be at the requested channel when this function
1997 * returns, i.e., the return code is only indicating whether the
1998 * request was accepted. The caller will need to wait until the
1999 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2000 * completed the channel change. This may take some time due to other
2001 * need for the radio and the caller should be prepared to timing out
2002 * its wait since there are no guarantees on when this request can be
2005 int (*remain_on_channel)(void *priv, unsigned int freq,
2006 unsigned int duration);
2009 * cancel_remain_on_channel - Cancel remain-on-channel operation
2010 * @priv: Private driver interface data
2012 * This command can be used to cancel a remain-on-channel operation
2013 * before its originally requested duration has passed. This could be
2014 * used, e.g., when remain_on_channel() is used to request extra time
2015 * to receive a response to an Action frame and the response is
2016 * received when there is still unneeded time remaining on the
2017 * remain-on-channel operation.
2019 int (*cancel_remain_on_channel)(void *priv);
2022 * probe_req_report - Request Probe Request frames to be indicated
2023 * @priv: Private driver interface data
2024 * @report: Whether to report received Probe Request frames
2025 * Returns: 0 on success, -1 on failure (or if not supported)
2027 * This command can be used to request the driver to indicate when
2028 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2029 * Since this operation may require extra resources, e.g., due to less
2030 * optimal hardware/firmware RX filtering, many drivers may disable
2031 * Probe Request reporting at least in station mode. This command is
2032 * used to notify the driver when the Probe Request frames need to be
2033 * reported, e.g., during remain-on-channel operations.
2035 int (*probe_req_report)(void *priv, int report);
2038 * deinit_ap - Deinitialize AP mode
2039 * @priv: Private driver interface data
2040 * Returns: 0 on success, -1 on failure (or if not supported)
2042 * This optional function can be used to disable AP mode related
2043 * configuration and change the driver mode to station mode to allow
2044 * normal station operations like scanning to be completed.
2046 int (*deinit_ap)(void *priv);
2049 * deinit_p2p_cli - Deinitialize P2P client mode
2050 * @priv: Private driver interface data
2051 * Returns: 0 on success, -1 on failure (or if not supported)
2053 * This optional function can be used to disable P2P client mode. It
2054 * can be used to change the interface type back to station mode.
2056 int (*deinit_p2p_cli)(void *priv);
2059 * suspend - Notification on system suspend/hibernate event
2060 * @priv: Private driver interface data
2062 void (*suspend)(void *priv);
2065 * resume - Notification on system resume/thaw event
2066 * @priv: Private driver interface data
2068 void (*resume)(void *priv);
2071 * signal_monitor - Set signal monitoring parameters
2072 * @priv: Private driver interface data
2073 * @threshold: Threshold value for signal change events; 0 = disabled
2074 * @hysteresis: Minimum change in signal strength before indicating a
2076 * Returns: 0 on success, -1 on failure (or if not supported)
2078 * This function can be used to configure monitoring of signal strength
2079 * with the current AP. Whenever signal strength drops below the
2080 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2081 * should be generated assuming the signal strength has changed at
2082 * least %hysteresis from the previously indicated signal change event.
2084 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2087 * send_frame - Send IEEE 802.11 frame (testing use only)
2088 * @priv: Private driver interface data
2089 * @data: IEEE 802.11 frame with IEEE 802.11 header
2090 * @data_len: Size of the frame
2091 * @encrypt: Whether to encrypt the frame (if keys are set)
2092 * Returns: 0 on success, -1 on failure
2094 * This function is only used for debugging purposes and is not
2095 * required to be implemented for normal operations.
2097 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2101 * shared_freq - Get operating frequency of shared interface(s)
2102 * @priv: Private driver interface data
2103 * Returns: Operating frequency in MHz, 0 if no shared operation in
2104 * use, or -1 on failure
2106 * This command can be used to request the current operating frequency
2107 * of any virtual interface that shares the same radio to provide
2108 * information for channel selection for other virtual interfaces.
2110 int (*shared_freq)(void *priv);
2113 * get_noa - Get current Notice of Absence attribute payload
2114 * @priv: Private driver interface data
2115 * @buf: Buffer for returning NoA
2116 * @buf_len: Buffer length in octets
2117 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2118 * advertized, or -1 on failure
2120 * This function is used to fetch the current Notice of Absence
2121 * attribute value from GO.
2123 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2126 * set_noa - Set Notice of Absence parameters for GO (testing)
2127 * @priv: Private driver interface data
2129 * @start: Start time in ms from next TBTT
2130 * @duration: Duration in ms
2131 * Returns: 0 on success or -1 on failure
2133 * This function is used to set Notice of Absence parameters for GO. It
2134 * is used only for testing. To disable NoA, all parameters are set to
2137 int (*set_noa)(void *priv, u8 count, int start, int duration);
2140 * set_p2p_powersave - Set P2P power save options
2141 * @priv: Private driver interface data
2142 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2143 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2144 * @ctwindow: 0.. = change (msec), -1 = no change
2145 * Returns: 0 on success or -1 on failure
2147 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2151 * ampdu - Enable/disable aggregation
2152 * @priv: Private driver interface data
2153 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2154 * Returns: 0 on success or -1 on failure
2156 int (*ampdu)(void *priv, int ampdu);
2159 * get_radio_name - Get physical radio name for the device
2160 * @priv: Private driver interface data
2161 * Returns: Radio name or %NULL if not known
2163 * The returned data must not be modified by the caller. It is assumed
2164 * that any interface that has the same radio name as another is
2165 * sharing the same physical radio. This information can be used to
2166 * share scan results etc. information between the virtual interfaces
2167 * to speed up various operations.
2169 const char * (*get_radio_name)(void *priv);
2172 * p2p_find - Start P2P Device Discovery
2173 * @priv: Private driver interface data
2174 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2175 * @type: Device Discovery type (enum p2p_discovery_type)
2176 * Returns: 0 on success, -1 on failure
2178 * This function is only used if the driver implements P2P management,
2179 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2180 * struct wpa_driver_capa.
2182 int (*p2p_find)(void *priv, unsigned int timeout, int type);
2185 * p2p_stop_find - Stop P2P Device Discovery
2186 * @priv: Private driver interface data
2187 * Returns: 0 on success, -1 on failure
2189 * This function is only used if the driver implements P2P management,
2190 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2191 * struct wpa_driver_capa.
2193 int (*p2p_stop_find)(void *priv);
2196 * p2p_listen - Start P2P Listen state for specified duration
2197 * @priv: Private driver interface data
2198 * @timeout: Listen state duration in milliseconds
2199 * Returns: 0 on success, -1 on failure
2201 * This function can be used to request the P2P module to keep the
2202 * device discoverable on the listen channel for an extended set of
2203 * time. At least in its current form, this is mainly used for testing
2204 * purposes and may not be of much use for normal P2P operations.
2206 * This function is only used if the driver implements P2P management,
2207 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2208 * struct wpa_driver_capa.
2210 int (*p2p_listen)(void *priv, unsigned int timeout);
2213 * p2p_connect - Start P2P group formation (GO negotiation)
2214 * @priv: Private driver interface data
2215 * @peer_addr: MAC address of the peer P2P client
2216 * @wps_method: enum p2p_wps_method value indicating config method
2217 * @go_intent: Local GO intent value (1..15)
2218 * @own_interface_addr: Intended interface address to use with the
2220 * @force_freq: The only allowed channel frequency in MHz or 0
2221 * @persistent_group: Whether to create persistent group
2222 * Returns: 0 on success, -1 on failure
2224 * This function is only used if the driver implements P2P management,
2225 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2226 * struct wpa_driver_capa.
2228 int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method,
2229 int go_intent, const u8 *own_interface_addr,
2230 unsigned int force_freq, int persistent_group);
2233 * wps_success_cb - Report successfully completed WPS provisioning
2234 * @priv: Private driver interface data
2235 * @peer_addr: Peer address
2236 * Returns: 0 on success, -1 on failure
2238 * This function is used to report successfully completed WPS
2239 * provisioning during group formation in both GO/Registrar and
2240 * client/Enrollee roles.
2242 * This function is only used if the driver implements P2P management,
2243 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2244 * struct wpa_driver_capa.
2246 int (*wps_success_cb)(void *priv, const u8 *peer_addr);
2249 * p2p_group_formation_failed - Report failed WPS provisioning
2250 * @priv: Private driver interface data
2251 * Returns: 0 on success, -1 on failure
2253 * This function is used to report failed group formation. This can
2254 * happen either due to failed WPS provisioning or due to 15 second
2255 * timeout during the provisioning phase.
2257 * This function is only used if the driver implements P2P management,
2258 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2259 * struct wpa_driver_capa.
2261 int (*p2p_group_formation_failed)(void *priv);
2264 * p2p_set_params - Set P2P parameters
2265 * @priv: Private driver interface data
2266 * @params: P2P parameters
2267 * Returns: 0 on success, -1 on failure
2269 * This function is only used if the driver implements P2P management,
2270 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2271 * struct wpa_driver_capa.
2273 int (*p2p_set_params)(void *priv, const struct p2p_params *params);
2276 * p2p_prov_disc_req - Send Provision Discovery Request
2277 * @priv: Private driver interface data
2278 * @peer_addr: MAC address of the peer P2P client
2279 * @config_methods: WPS Config Methods value (only one bit set)
2280 * Returns: 0 on success, -1 on failure
2282 * This function can be used to request a discovered P2P peer to
2283 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2284 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2285 * Provision Discovery Request frame is transmitted once immediately
2286 * and if no response is received, the frame will be sent again
2287 * whenever the target device is discovered during device dsicovery
2288 * (start with a p2p_find() call). Response from the peer is indicated
2289 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
2291 * This function is only used if the driver implements P2P management,
2292 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2293 * struct wpa_driver_capa.
2295 int (*p2p_prov_disc_req)(void *priv, const u8 *peer_addr,
2296 u16 config_methods, int join);
2299 * p2p_sd_request - Schedule a service discovery query
2300 * @priv: Private driver interface data
2301 * @dst: Destination peer or %NULL to apply for all peers
2302 * @tlvs: P2P Service Query TLV(s)
2303 * Returns: Reference to the query or 0 on failure
2305 * Response to the query is indicated with the
2306 * EVENT_P2P_SD_RESPONSE driver event.
2308 * This function is only used if the driver implements P2P management,
2309 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2310 * struct wpa_driver_capa.
2312 u64 (*p2p_sd_request)(void *priv, const u8 *dst,
2313 const struct wpabuf *tlvs);
2316 * p2p_sd_cancel_request - Cancel a pending service discovery query
2317 * @priv: Private driver interface data
2318 * @req: Query reference from p2p_sd_request()
2319 * Returns: 0 on success, -1 on failure
2321 * This function is only used if the driver implements P2P management,
2322 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2323 * struct wpa_driver_capa.
2325 int (*p2p_sd_cancel_request)(void *priv, u64 req);
2328 * p2p_sd_response - Send response to a service discovery query
2329 * @priv: Private driver interface data
2330 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2331 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2332 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2333 * @resp_tlvs: P2P Service Response TLV(s)
2334 * Returns: 0 on success, -1 on failure
2336 * This function is called as a response to the request indicated with
2337 * the EVENT_P2P_SD_REQUEST driver event.
2339 * This function is only used if the driver implements P2P management,
2340 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2341 * struct wpa_driver_capa.
2343 int (*p2p_sd_response)(void *priv, int freq, const u8 *dst,
2345 const struct wpabuf *resp_tlvs);
2348 * p2p_service_update - Indicate a change in local services
2349 * @priv: Private driver interface data
2350 * Returns: 0 on success, -1 on failure
2352 * This function needs to be called whenever there is a change in
2353 * availability of the local services. This will increment the
2354 * Service Update Indicator value which will be used in SD Request and
2357 * This function is only used if the driver implements P2P management,
2358 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2359 * struct wpa_driver_capa.
2361 int (*p2p_service_update)(void *priv);
2364 * p2p_reject - Reject peer device (explicitly block connections)
2365 * @priv: Private driver interface data
2366 * @addr: MAC address of the peer
2367 * Returns: 0 on success, -1 on failure
2369 int (*p2p_reject)(void *priv, const u8 *addr);
2372 * p2p_invite - Invite a P2P Device into a group
2373 * @priv: Private driver interface data
2374 * @peer: Device Address of the peer P2P Device
2375 * @role: Local role in the group
2376 * @bssid: Group BSSID or %NULL if not known
2378 * @ssid_len: Length of ssid in octets
2379 * @go_dev_addr: Forced GO Device Address or %NULL if none
2380 * @persistent_group: Whether this is to reinvoke a persistent group
2381 * Returns: 0 on success, -1 on failure
2383 int (*p2p_invite)(void *priv, const u8 *peer, int role,
2384 const u8 *bssid, const u8 *ssid, size_t ssid_len,
2385 const u8 *go_dev_addr, int persistent_group);
2388 * send_tdls_mgmt - for sending TDLS management packets
2389 * @priv: private driver interface data
2390 * @dst: Destination (peer) MAC address
2391 * @action_code: TDLS action code for the mssage
2392 * @dialog_token: Dialog Token to use in the message (if needed)
2393 * @status_code: Status Code or Reason Code to use (if needed)
2394 * @buf: TDLS IEs to add to the message
2395 * @len: Length of buf in octets
2396 * Returns: 0 on success, negative (<0) on failure
2398 * This optional function can be used to send packet to driver which is
2399 * responsible for receiving and sending all TDLS packets.
2401 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2402 u8 dialog_token, u16 status_code,
2403 const u8 *buf, size_t len);
2406 * tdls_oper - Ask the driver to perform high-level TDLS operations
2407 * @priv: Private driver interface data
2408 * @oper: TDLS high-level operation. See %enum tdls_oper
2409 * @peer: Destination (peer) MAC address
2410 * Returns: 0 on success, negative (<0) on failure
2412 * This optional function can be used to send high-level TDLS commands
2415 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2418 * signal_poll - Get current connection information
2419 * @priv: Private driver interface data
2420 * @signal_info: Connection info structure
2422 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2425 * set_authmode - Set authentication algorithm(s) for static WEP
2426 * @priv: Private driver interface data
2427 * @authmode: 1=Open System, 2=Shared Key, 3=both
2428 * Returns: 0 on success, -1 on failure
2430 * This function can be used to set authentication algorithms for AP
2431 * mode when static WEP is used. If the driver uses user space MLME/SME
2432 * implementation, there is no need to implement this function.
2434 * DEPRECATED - use set_ap() instead
2436 int (*set_authmode)(void *priv, int authmode);
2439 * set_rekey_info - Set rekey information
2440 * @priv: Private driver interface data
2443 * @replay_ctr: Current EAPOL-Key Replay Counter
2445 * This optional function can be used to provide information for the
2446 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2447 * while the host (including wpa_supplicant) is sleeping.
2449 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2450 const u8 *replay_ctr);
2453 * sta_assoc - Station association indication
2454 * @priv: Private driver interface data
2455 * @own_addr: Source address and BSSID for association frame
2456 * @addr: MAC address of the station to associate
2457 * @reassoc: flag to indicate re-association
2458 * @status: association response status code
2459 * @ie: assoc response ie buffer
2460 * @len: ie buffer length
2461 * Returns: 0 on success, -1 on failure
2463 * This function indicates the driver to send (Re)Association
2464 * Response frame to the station.
2466 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2467 int reassoc, u16 status, const u8 *ie, size_t len);
2470 * sta_auth - Station authentication indication
2471 * @priv: Private driver interface data
2472 * @own_addr: Source address and BSSID for authentication frame
2473 * @addr: MAC address of the station to associate
2474 * @seq: authentication sequence number
2475 * @status: authentication response status code
2476 * @ie: authentication frame ie buffer
2477 * @len: ie buffer length
2479 * This function indicates the driver to send Authentication frame
2482 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2483 u16 seq, u16 status, const u8 *ie, size_t len);
2486 * add_tspec - Add traffic stream
2487 * @priv: Private driver interface data
2488 * @addr: MAC address of the station to associate
2489 * @tspec_ie: tspec ie buffer
2490 * @tspec_ielen: tspec ie length
2491 * Returns: 0 on success, -1 on failure
2493 * This function adds the traffic steam for the station
2494 * and fills the medium_time in tspec_ie.
2496 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2497 size_t tspec_ielen);
2500 * add_sta_node - Add a station node in the driver
2501 * @priv: Private driver interface data
2502 * @addr: MAC address of the station to add
2503 * @auth_alg: authentication algorithm used by the station
2504 * Returns: 0 on success, -1 on failure
2506 * This function adds the station node in the driver, when
2507 * the station gets added by FT-over-DS.
2509 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2512 * sched_scan - Request the driver to initiate scheduled scan
2513 * @priv: Private driver interface data
2514 * @params: Scan parameters
2515 * @interval: Interval between scan cycles in milliseconds
2516 * Returns: 0 on success, -1 on failure
2518 * This operation should be used for scheduled scan offload to
2519 * the hardware. Every time scan results are available, the
2520 * driver should report scan results event for wpa_supplicant
2521 * which will eventually request the results with
2522 * wpa_driver_get_scan_results2(). This operation is optional
2523 * and if not provided or if it returns -1, we fall back to
2524 * normal host-scheduled scans.
2526 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2530 * stop_sched_scan - Request the driver to stop a scheduled scan
2531 * @priv: Private driver interface data
2532 * Returns: 0 on success, -1 on failure
2534 * This should cause the scheduled scan to be stopped and
2535 * results should stop being sent. Must be supported if
2536 * sched_scan is supported.
2538 int (*stop_sched_scan)(void *priv);
2541 * poll_client - Probe (null data or such) the given station
2542 * @priv: Private driver interface data
2543 * @own_addr: MAC address of sending interface
2544 * @addr: MAC address of the station to probe
2545 * @qos: Indicates whether station is QoS station
2547 * This function is used to verify whether an associated station is
2548 * still present. This function does not need to be implemented if the
2549 * driver provides such inactivity polling mechanism.
2551 void (*poll_client)(void *priv, const u8 *own_addr,
2552 const u8 *addr, int qos);
2555 * radio_disable - Disable/enable radio
2556 * @priv: Private driver interface data
2557 * @disabled: 1=disable 0=enable radio
2558 * Returns: 0 on success, -1 on failure
2560 * This optional command is for testing purposes. It can be used to
2561 * disable the radio on a testbed device to simulate out-of-radio-range
2564 int (*radio_disable)(void *priv, int disabled);
2567 * switch_channel - Announce channel switch and migrate the GO to the
2569 * @priv: Private driver interface data
2570 * @freq: Frequency in MHz
2571 * Returns: 0 on success, -1 on failure
2573 * This function is used to move the GO to the legacy STA channel to
2574 * avoid frequency conflict in single channel concurrency.
2576 int (*switch_channel)(void *priv, unsigned int freq);
2581 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2583 enum wpa_event_type {
2585 * EVENT_ASSOC - Association completed
2587 * This event needs to be delivered when the driver completes IEEE
2588 * 802.11 association or reassociation successfully.
2589 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2590 * after this event has been generated. In addition, optional
2591 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2592 * more information about the association. If the driver interface gets
2593 * both of these events at the same time, it can also include the
2594 * assoc_info data in EVENT_ASSOC call.
2599 * EVENT_DISASSOC - Association lost
2601 * This event should be called when association is lost either due to
2602 * receiving deauthenticate or disassociate frame from the AP or when
2603 * sending either of these frames to the current AP. If the driver
2604 * supports separate deauthentication event, EVENT_DISASSOC should only
2605 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2606 * In AP mode, union wpa_event_data::disassoc_info is required.
2611 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2613 * This event must be delivered when a Michael MIC error is detected by
2614 * the local driver. Additional data for event processing is
2615 * provided with union wpa_event_data::michael_mic_failure. This
2616 * information is used to request new encyption key and to initiate
2617 * TKIP countermeasures if needed.
2619 EVENT_MICHAEL_MIC_FAILURE,
2622 * EVENT_SCAN_RESULTS - Scan results available
2624 * This event must be called whenever scan results are available to be
2625 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2626 * is expected to be used some time after struct wpa_driver_ops::scan()
2627 * is called. If the driver provides an unsolicited event when the scan
2628 * has been completed, this event can be used to trigger
2629 * EVENT_SCAN_RESULTS call. If such event is not available from the
2630 * driver, the driver wrapper code is expected to use a registered
2631 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2632 * scan is expected to be completed. Optional information about
2633 * completed scan can be provided with union wpa_event_data::scan_info.
2638 * EVENT_ASSOCINFO - Report optional extra information for association
2640 * This event can be used to report extra association information for
2641 * EVENT_ASSOC processing. This extra information includes IEs from
2642 * association frames and Beacon/Probe Response frames in union
2643 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2644 * EVENT_ASSOC. Alternatively, the driver interface can include
2645 * assoc_info data in the EVENT_ASSOC call if it has all the
2646 * information available at the same point.
2651 * EVENT_INTERFACE_STATUS - Report interface status changes
2653 * This optional event can be used to report changes in interface
2654 * status (interface added/removed) using union
2655 * wpa_event_data::interface_status. This can be used to trigger
2656 * wpa_supplicant to stop and re-start processing for the interface,
2657 * e.g., when a cardbus card is ejected/inserted.
2659 EVENT_INTERFACE_STATUS,
2662 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2664 * This event can be used to inform wpa_supplicant about candidates for
2665 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2666 * for scan request (ap_scan=2 mode), this event is required for
2667 * pre-authentication. If wpa_supplicant is performing scan request
2668 * (ap_scan=1), this event is optional since scan results can be used
2669 * to add pre-authentication candidates. union
2670 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2671 * candidate and priority of the candidate, e.g., based on the signal
2672 * strength, in order to try to pre-authenticate first with candidates
2673 * that are most likely targets for re-association.
2675 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2676 * on the candidate list. In addition, it can be called for the current
2677 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2678 * will automatically skip pre-authentication in cases where a valid
2679 * PMKSA exists. When more than one candidate exists, this event should
2680 * be generated once for each candidate.
2682 * Driver will be notified about successful pre-authentication with
2683 * struct wpa_driver_ops::add_pmkid() calls.
2685 EVENT_PMKID_CANDIDATE,
2688 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2690 * This event can be used to inform wpa_supplicant about desire to set
2691 * up secure direct link connection between two stations as defined in
2692 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2693 * STAKey negotiation. The caller will need to set peer address for the
2699 * EVENT_TDLS - Request TDLS operation
2701 * This event can be used to request a TDLS operation to be performed.
2706 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2708 * The driver is expected to report the received FT IEs from
2709 * FT authentication sequence from the AP. The FT IEs are included in
2710 * the extra information in union wpa_event_data::ft_ies.
2715 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2717 * The driver can use this event to inform wpa_supplicant about a STA
2718 * in an IBSS with which protected frames could be exchanged. This
2719 * event starts RSN authentication with the other STA to authenticate
2720 * the STA and set up encryption keys with it.
2722 EVENT_IBSS_RSN_START,
2725 * EVENT_AUTH - Authentication result
2727 * This event should be called when authentication attempt has been
2728 * completed. This is only used if the driver supports separate
2729 * authentication step (struct wpa_driver_ops::authenticate).
2730 * Information about authentication result is included in
2731 * union wpa_event_data::auth.
2736 * EVENT_DEAUTH - Authentication lost
2738 * This event should be called when authentication is lost either due
2739 * to receiving deauthenticate frame from the AP or when sending that
2740 * frame to the current AP.
2741 * In AP mode, union wpa_event_data::deauth_info is required.
2746 * EVENT_ASSOC_REJECT - Association rejected
2748 * This event should be called when (re)association attempt has been
2749 * rejected by the AP. Information about the association response is
2750 * included in union wpa_event_data::assoc_reject.
2755 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2757 EVENT_AUTH_TIMED_OUT,
2760 * EVENT_ASSOC_TIMED_OUT - Association timed out
2762 EVENT_ASSOC_TIMED_OUT,
2765 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2770 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2772 EVENT_WPS_BUTTON_PUSHED,
2775 * EVENT_TX_STATUS - Report TX status
2780 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2782 EVENT_RX_FROM_UNKNOWN,
2785 * EVENT_RX_MGMT - Report RX of a management frame
2790 * EVENT_RX_ACTION - Action frame received
2792 * This event is used to indicate when an Action frame has been
2793 * received. Information about the received frame is included in
2794 * union wpa_event_data::rx_action.
2799 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2801 * This event is used to indicate when the driver has started the
2802 * requested remain-on-channel duration. Information about the
2803 * operation is included in union wpa_event_data::remain_on_channel.
2805 EVENT_REMAIN_ON_CHANNEL,
2808 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2810 * This event is used to indicate when the driver has completed
2811 * remain-on-channel duration, i.e., may noot be available on the
2812 * requested channel anymore. Information about the
2813 * operation is included in union wpa_event_data::remain_on_channel.
2815 EVENT_CANCEL_REMAIN_ON_CHANNEL,
2818 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2820 * This event is used only by driver_test.c and userspace MLME.
2825 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2827 * This event is used to indicate when a Probe Request frame has been
2828 * received. Information about the received frame is included in
2829 * union wpa_event_data::rx_probe_req. The driver is required to report
2830 * these events only after successfully completed probe_req_report()
2831 * commands to request the events (i.e., report parameter is non-zero)
2832 * in station mode. In AP mode, Probe Request frames should always be
2838 * EVENT_NEW_STA - New wired device noticed
2840 * This event is used to indicate that a new device has been detected
2841 * in a network that does not use association-like functionality (i.e.,
2842 * mainly wired Ethernet). This can be used to start EAPOL
2843 * authenticator when receiving a frame from a device. The address of
2844 * the device is included in union wpa_event_data::new_sta.
2849 * EVENT_EAPOL_RX - Report received EAPOL frame
2851 * When in AP mode with hostapd, this event is required to be used to
2852 * deliver the receive EAPOL frames from the driver. With
2853 * %wpa_supplicant, this event is used only if the send_eapol() handler
2854 * is used to override the use of l2_packet for EAPOL frame TX.
2859 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
2861 * This event is used to indicate changes in the signal strength
2862 * observed in frames received from the current AP if signal strength
2863 * monitoring has been enabled with signal_monitor().
2865 EVENT_SIGNAL_CHANGE,
2868 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
2870 * This event is used to indicate that the interface was enabled after
2871 * having been previously disabled, e.g., due to rfkill.
2873 EVENT_INTERFACE_ENABLED,
2876 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
2878 * This event is used to indicate that the interface was disabled,
2879 * e.g., due to rfkill.
2881 EVENT_INTERFACE_DISABLED,
2884 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
2886 * This event is used to indicate that the channel list has changed,
2887 * e.g., because of a regulatory domain change triggered by scan
2888 * results including an AP advertising a country code.
2890 EVENT_CHANNEL_LIST_CHANGED,
2893 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
2895 * This event is used to indicate that the driver cannot maintain this
2896 * interface in its operation mode anymore. The most likely use for
2897 * this is to indicate that AP mode operation is not available due to
2898 * operating channel would need to be changed to a DFS channel when
2899 * the driver does not support radar detection and another virtual
2900 * interfaces caused the operating channel to change. Other similar
2901 * resource conflicts could also trigger this for station mode
2904 EVENT_INTERFACE_UNAVAILABLE,
2907 * EVENT_BEST_CHANNEL
2909 * Driver generates this event whenever it detects a better channel
2910 * (e.g., based on RSSI or channel use). This information can be used
2911 * to improve channel selection for a new AP/P2P group.
2916 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
2918 * This event should be called when a Deauthentication frame is dropped
2919 * due to it not being protected (MFP/IEEE 802.11w).
2920 * union wpa_event_data::unprot_deauth is required to provide more
2921 * details of the frame.
2923 EVENT_UNPROT_DEAUTH,
2926 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
2928 * This event should be called when a Disassociation frame is dropped
2929 * due to it not being protected (MFP/IEEE 802.11w).
2930 * union wpa_event_data::unprot_disassoc is required to provide more
2931 * details of the frame.
2933 EVENT_UNPROT_DISASSOC,
2936 * EVENT_STATION_LOW_ACK
2938 * Driver generates this event whenever it detected that a particular
2939 * station was lost. Detection can be through massive transmission
2940 * failures for example.
2942 EVENT_STATION_LOW_ACK,
2945 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
2947 * This event is used only if the driver implements P2P management
2948 * internally. Event data is stored in
2949 * union wpa_event_data::p2p_dev_found.
2951 EVENT_P2P_DEV_FOUND,
2954 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
2956 * This event is used only if the driver implements P2P management
2957 * internally. Event data is stored in
2958 * union wpa_event_data::p2p_go_neg_req_rx.
2960 EVENT_P2P_GO_NEG_REQ_RX,
2963 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
2965 * This event is used only if the driver implements P2P management
2966 * internally. Event data is stored in
2967 * union wpa_event_data::p2p_go_neg_completed.
2969 EVENT_P2P_GO_NEG_COMPLETED,
2971 EVENT_P2P_PROV_DISC_REQUEST,
2972 EVENT_P2P_PROV_DISC_RESPONSE,
2973 EVENT_P2P_SD_REQUEST,
2974 EVENT_P2P_SD_RESPONSE,
2977 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
2979 EVENT_IBSS_PEER_LOST,
2982 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
2984 * This event carries the new replay counter to notify wpa_supplicant
2985 * of the current EAPOL-Key Replay Counter in case the driver/firmware
2986 * completed Group Key Handshake while the host (including
2987 * wpa_supplicant was sleeping).
2989 EVENT_DRIVER_GTK_REKEY,
2992 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
2994 EVENT_SCHED_SCAN_STOPPED,
2997 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
2999 * This event indicates that the station responded to the poll
3000 * initiated with @poll_client.
3002 EVENT_DRIVER_CLIENT_POLL_OK,
3005 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3007 EVENT_EAPOL_TX_STATUS,
3010 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3012 * Described in wpa_event_data.ch_switch
3019 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3021 union wpa_event_data {
3023 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3025 * This structure is optional for EVENT_ASSOC calls and required for
3026 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3027 * driver interface does not need to generate separate EVENT_ASSOCINFO
3032 * reassoc - Flag to indicate association or reassociation
3037 * req_ies - (Re)Association Request IEs
3039 * If the driver generates WPA/RSN IE, this event data must be
3040 * returned for WPA handshake to have needed information. If
3041 * wpa_supplicant-generated WPA/RSN IE is used, this
3042 * information event is optional.
3044 * This should start with the first IE (fixed fields before IEs
3045 * are not included).
3050 * req_ies_len - Length of req_ies in bytes
3055 * resp_ies - (Re)Association Response IEs
3057 * Optional association data from the driver. This data is not
3058 * required WPA, but may be useful for some protocols and as
3059 * such, should be reported if this is available to the driver
3062 * This should start with the first IE (fixed fields before IEs
3063 * are not included).
3068 * resp_ies_len - Length of resp_ies in bytes
3070 size_t resp_ies_len;
3073 * beacon_ies - Beacon or Probe Response IEs
3075 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3076 * Probe Response frames from the current AP (i.e., the one
3077 * that the client just associated with). This information is
3078 * used to update WPA/RSN IE for the AP. If this field is not
3079 * set, the results from previous scan will be used. If no
3080 * data for the new AP is found, scan results will be requested
3081 * again (without scan request). At this point, the driver is
3082 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3085 * This should start with the first IE (fixed fields before IEs
3086 * are not included).
3088 const u8 *beacon_ies;
3091 * beacon_ies_len - Length of beacon_ies */
3092 size_t beacon_ies_len;
3095 * freq - Frequency of the operational channel in MHz
3100 * addr - Station address (for AP mode)
3106 * struct disassoc_info - Data for EVENT_DISASSOC events
3108 struct disassoc_info {
3110 * addr - Station address (for AP mode)
3115 * reason_code - Reason Code (host byte order) used in
3116 * Deauthentication frame
3121 * ie - Optional IE(s) in Disassociation frame
3126 * ie_len - Length of ie buffer in octets
3131 * locally_generated - Whether the frame was locally generated
3133 int locally_generated;
3137 * struct deauth_info - Data for EVENT_DEAUTH events
3139 struct deauth_info {
3141 * addr - Station address (for AP mode)
3146 * reason_code - Reason Code (host byte order) used in
3147 * Deauthentication frame
3152 * ie - Optional IE(s) in Deauthentication frame
3157 * ie_len - Length of ie buffer in octets
3162 * locally_generated - Whether the frame was locally generated
3164 int locally_generated;
3168 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3170 struct michael_mic_failure {
3173 } michael_mic_failure;
3176 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3178 struct interface_status {
3181 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3186 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3188 struct pmkid_candidate {
3189 /** BSSID of the PMKID candidate */
3191 /** Smaller the index, higher the priority */
3193 /** Whether RSN IE includes pre-authenticate flag */
3198 * struct stkstart - Data for EVENT_STKSTART
3205 * struct tdls - Data for EVENT_TDLS
3211 TDLS_REQUEST_TEARDOWN
3213 u16 reason_code; /* for teardown */
3217 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3219 * During FT (IEEE 802.11r) authentication sequence, the driver is
3220 * expected to use this event to report received FT IEs (MDIE, FTIE,
3221 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3222 * IEs for the next message will be delivered through the
3223 * struct wpa_driver_ops::update_ft_ies() callback.
3229 u8 target_ap[ETH_ALEN];
3230 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3232 /** Length of ric_ies buffer in octets */
3237 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3239 struct ibss_rsn_start {
3244 * struct auth_info - Data for EVENT_AUTH events
3250 u16 auth_transaction;
3257 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3259 struct assoc_reject {
3261 * bssid - BSSID of the AP that rejected association
3266 * resp_ies - (Re)Association Response IEs
3268 * Optional association data from the driver. This data is not
3269 * required WPA, but may be useful for some protocols and as
3270 * such, should be reported if this is available to the driver
3273 * This should start with the first IE (fixed fields before IEs
3274 * are not included).
3279 * resp_ies_len - Length of resp_ies in bytes
3281 size_t resp_ies_len;
3284 * status_code - Status Code from (Re)association Response
3289 struct timeout_event {
3294 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3303 * struct tx_status - Data for EVENT_TX_STATUS events
3315 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3317 struct rx_from_unknown {
3324 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3330 int ssi_signal; /* dBm */
3334 * struct rx_action - Data for EVENT_RX_ACTION events
3338 * da - Destination address of the received Action frame
3343 * sa - Source address of the received Action frame
3348 * bssid - Address 3 of the received Action frame
3353 * category - Action frame category
3358 * data - Action frame body after category field
3363 * len - Length of data in octets
3368 * freq - Frequency (in MHz) on which the frame was received
3374 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3376 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3378 struct remain_on_channel {
3380 * freq - Channel frequency in MHz
3385 * duration - Duration to remain on the channel in milliseconds
3387 unsigned int duration;
3388 } remain_on_channel;
3391 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3392 * @aborted: Whether the scan was aborted
3393 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3394 * @num_freqs: Number of entries in freqs array
3395 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3397 * @num_ssids: Number of entries in ssids array
3403 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3408 * struct mlme_rx - Data for EVENT_MLME_RX events
3419 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3421 struct rx_probe_req {
3423 * sa - Source address of the received Probe Request frame
3428 * da - Destination address of the received Probe Request frame
3429 * or %NULL if not available
3434 * bssid - BSSID of the received Probe Request frame or %NULL
3440 * ie - IEs from the Probe Request body
3445 * ie_len - Length of ie buffer in octets
3450 * signal - signal strength in dBm (or 0 if not available)
3456 * struct new_sta - Data for EVENT_NEW_STA events
3463 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3472 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3474 struct wpa_signal_info signal_change;
3477 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3478 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3479 * @freq_5: Best 5 GHz band channel frequency in MHz
3480 * @freq_overall: Best channel frequency in MHz
3482 * 0 can be used to indicate no preference in either band.
3484 struct best_channel {
3490 struct unprot_deauth {
3496 struct unprot_disassoc {
3503 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3504 * @addr: station address
3511 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3513 struct p2p_dev_found {
3516 const u8 *pri_dev_type;
3517 const char *dev_name;
3524 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3526 struct p2p_go_neg_req_rx {
3529 } p2p_go_neg_req_rx;
3532 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3534 struct p2p_go_neg_completed {
3535 struct p2p_go_neg_results *res;
3536 } p2p_go_neg_completed;
3538 struct p2p_prov_disc_req {
3542 const u8 *pri_dev_type;
3543 const char *dev_name;
3544 u16 supp_config_methods;
3547 } p2p_prov_disc_req;
3549 struct p2p_prov_disc_resp {
3552 } p2p_prov_disc_resp;
3563 struct p2p_sd_resp {
3571 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3573 struct ibss_peer_lost {
3578 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3580 struct driver_gtk_rekey {
3582 const u8 *replay_ctr;
3586 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
3587 * @addr: station address
3589 struct client_poll {
3594 * struct eapol_tx_status
3595 * @dst: Original destination
3596 * @data: Data starting with IEEE 802.1X header (!)
3597 * @data_len: Length of data
3598 * @ack: Indicates ack or lost frame
3600 * This corresponds to hapd_send_eapol if the frame sent
3601 * there isn't just reported as EVENT_TX_STATUS.
3603 struct eapol_tx_status {
3612 * @freq: Frequency of new channel in MHz
3613 * @ht_enabled: Whether this is an HT channel
3614 * @ch_offset: Secondary channel offset
3624 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3625 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3626 * with struct wpa_driver_ops::init()
3627 * @event: event type (defined above)
3628 * @data: possible extra data for the event
3630 * Driver wrapper code should call this function whenever an event is received
3633 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
3634 union wpa_event_data *data);
3638 * The following inline functions are provided for convenience to simplify
3639 * event indication for some of the common events.
3642 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
3643 size_t ielen, int reassoc)
3645 union wpa_event_data event;
3646 os_memset(&event, 0, sizeof(event));
3647 event.assoc_info.reassoc = reassoc;
3648 event.assoc_info.req_ies = ie;
3649 event.assoc_info.req_ies_len = ielen;
3650 event.assoc_info.addr = addr;
3651 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
3654 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
3656 union wpa_event_data event;
3657 os_memset(&event, 0, sizeof(event));
3658 event.disassoc_info.addr = addr;
3659 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
3662 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
3665 union wpa_event_data event;
3666 os_memset(&event, 0, sizeof(event));
3667 event.eapol_rx.src = src;
3668 event.eapol_rx.data = data;
3669 event.eapol_rx.data_len = data_len;
3670 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
3673 /* driver_common.c */
3674 void wpa_scan_results_free(struct wpa_scan_results *res);
3676 /* Convert wpa_event_type to a string for logging */
3677 const char * event_to_string(enum wpa_event_type event);
3679 #endif /* DRIVER_H */