2 * Driver interface definition
3 * Copyright (c) 2003-2012, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
8 * This file defines a driver interface used by both %wpa_supplicant and
9 * hostapd. The first part of the file defines data structures used in various
10 * driver operations. This is followed by the struct wpa_driver_ops that each
11 * driver wrapper will beed to define with callback functions for requesting
12 * driver operations. After this, there are definitions for driver event
13 * reporting with wpa_supplicant_event() and some convenience helper functions
14 * that can be used to report events.
20 #define WPA_SUPPLICANT_DRIVER_VERSION 4
22 #include "common/defs.h"
24 #define HOSTAPD_CHAN_DISABLED 0x00000001
25 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
26 #define HOSTAPD_CHAN_NO_IBSS 0x00000004
27 #define HOSTAPD_CHAN_RADAR 0x00000008
28 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
29 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
30 #define HOSTAPD_CHAN_HT40 0x00000040
33 * struct hostapd_channel_data - Channel information
35 struct hostapd_channel_data {
37 * chan - Channel number (IEEE 802.11)
42 * freq - Frequency in MHz
47 * flag - Channel flags (HOSTAPD_CHAN_*)
52 * max_tx_power - maximum transmit power in dBm
57 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
60 * struct hostapd_hw_modes - Supported hardware mode information
62 struct hostapd_hw_modes {
64 * mode - Hardware mode
66 enum hostapd_hw_mode mode;
69 * num_channels - Number of entries in the channels array
74 * channels - Array of supported channels
76 struct hostapd_channel_data *channels;
79 * num_rates - Number of entries in the rates array
84 * rates - Array of supported rates in 100 kbps units
89 * ht_capab - HT (IEEE 802.11n) capabilities
94 * mcs_set - MCS (IEEE 802.11n) rate parameters
99 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
103 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
107 #define IEEE80211_MODE_INFRA 0
108 #define IEEE80211_MODE_IBSS 1
109 #define IEEE80211_MODE_AP 2
111 #define IEEE80211_CAP_ESS 0x0001
112 #define IEEE80211_CAP_IBSS 0x0002
113 #define IEEE80211_CAP_PRIVACY 0x0010
115 #define WPA_SCAN_QUAL_INVALID BIT(0)
116 #define WPA_SCAN_NOISE_INVALID BIT(1)
117 #define WPA_SCAN_LEVEL_INVALID BIT(2)
118 #define WPA_SCAN_LEVEL_DBM BIT(3)
119 #define WPA_SCAN_AUTHENTICATED BIT(4)
120 #define WPA_SCAN_ASSOCIATED BIT(5)
123 * struct wpa_scan_res - Scan result for an BSS/IBSS
124 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
126 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
127 * @beacon_int: beacon interval in TUs (host byte order)
128 * @caps: capability information field in host byte order
129 * @qual: signal quality
130 * @noise: noise level
131 * @level: signal level
133 * @age: Age of the information in milliseconds (i.e., how many milliseconds
134 * ago the last Beacon or Probe Response frame was received)
135 * @ie_len: length of the following IE field in octets
136 * @beacon_ie_len: length of the following Beacon IE field in octets
138 * This structure is used as a generic format for scan results from the
139 * driver. Each driver interface implementation is responsible for converting
140 * the driver or OS specific scan results into this format.
142 * If the driver does not support reporting all IEs, the IE data structure is
143 * constructed of the IEs that are available. This field will also need to
144 * include SSID in IE format. All drivers are encouraged to be extended to
145 * report all IEs to make it easier to support future additions.
147 struct wpa_scan_res {
159 size_t beacon_ie_len;
161 * Followed by ie_len octets of IEs from Probe Response frame (or if
162 * the driver does not indicate source of IEs, these may also be from
163 * Beacon frame). After the first set of IEs, another set of IEs may
164 * follow (with beacon_ie_len octets of data) if the driver provides
170 * struct wpa_scan_results - Scan results
171 * @res: Array of pointers to allocated variable length scan result entries
172 * @num: Number of entries in the scan result array
174 struct wpa_scan_results {
175 struct wpa_scan_res **res;
180 * struct wpa_interface_info - Network interface information
181 * @next: Pointer to the next interface or NULL if this is the last one
182 * @ifname: Interface name that can be used with init() or init2()
183 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
185 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
186 * is not an allocated copy, i.e., get_interfaces() caller will not free
189 struct wpa_interface_info {
190 struct wpa_interface_info *next;
193 const char *drv_name;
196 #define WPAS_MAX_SCAN_SSIDS 16
199 * struct wpa_driver_scan_params - Scan parameters
200 * Data for struct wpa_driver_ops::scan2().
202 struct wpa_driver_scan_params {
204 * ssids - SSIDs to scan for
206 struct wpa_driver_scan_ssid {
208 * ssid - specific SSID to scan for (ProbeReq)
209 * %NULL or zero-length SSID is used to indicate active scan
210 * with wildcard SSID.
214 * ssid_len: Length of the SSID in octets
217 } ssids[WPAS_MAX_SCAN_SSIDS];
220 * num_ssids - Number of entries in ssids array
221 * Zero indicates a request for a passive scan.
226 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
231 * extra_ies_len - Length of extra_ies in octets
233 size_t extra_ies_len;
236 * freqs - Array of frequencies to scan or %NULL for all frequencies
238 * The frequency is set in MHz. The array is zero-terminated.
243 * filter_ssids - Filter for reporting SSIDs
245 * This optional parameter can be used to request the driver wrapper to
246 * filter scan results to include only the specified SSIDs. %NULL
247 * indicates that no filtering is to be done. This can be used to
248 * reduce memory needs for scan results in environments that have large
249 * number of APs with different SSIDs.
251 * The driver wrapper is allowed to take this allocated buffer into its
252 * own use by setting the pointer to %NULL. In that case, the driver
253 * wrapper is responsible for freeing the buffer with os_free() once it
254 * is not needed anymore.
256 struct wpa_driver_scan_filter {
262 * num_filter_ssids - Number of entries in filter_ssids array
264 size_t num_filter_ssids;
267 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
269 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
270 * Mbps from the support rates element(s) in the Probe Request frames
271 * and not to transmit the frames at any of those rates.
277 * struct wpa_driver_auth_params - Authentication parameters
278 * Data for struct wpa_driver_ops::authenticate().
280 struct wpa_driver_auth_params {
288 const u8 *wep_key[4];
289 size_t wep_key_len[4];
291 int local_state_change;
294 * p2p - Whether this connection is a P2P group
301 WPS_MODE_NONE /* no WPS provisioning being used */,
302 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
303 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
308 * struct wpa_driver_associate_params - Association parameters
309 * Data for struct wpa_driver_ops::associate().
311 struct wpa_driver_associate_params {
313 * bssid - BSSID of the selected AP
314 * This can be %NULL, if ap_scan=2 mode is used and the driver is
315 * responsible for selecting with which BSS to associate. */
319 * ssid - The selected SSID
324 * ssid_len - Length of the SSID (1..32)
329 * freq - Frequency of the channel the selected AP is using
330 * Frequency that the selected AP is using (in MHz as
331 * reported in the scan results)
336 * bg_scan_period - Background scan period in seconds, 0 to disable
337 * background scan, or -1 to indicate no change to default driver
343 * wpa_ie - WPA information element for (Re)Association Request
344 * WPA information element to be included in (Re)Association
345 * Request (including information element id and length). Use
346 * of this WPA IE is optional. If the driver generates the WPA
347 * IE, it can use pairwise_suite, group_suite, and
348 * key_mgmt_suite to select proper algorithms. In this case,
349 * the driver has to notify wpa_supplicant about the used WPA
350 * IE by generating an event that the interface code will
351 * convert into EVENT_ASSOCINFO data (see below).
353 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
354 * instead. The driver can determine which version is used by
355 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
358 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
363 * wpa_ie_len - length of the wpa_ie
368 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
370 unsigned int wpa_proto;
373 * pairwise_suite - Selected pairwise cipher suite
375 * This is usually ignored if @wpa_ie is used.
377 enum wpa_cipher pairwise_suite;
380 * group_suite - Selected group cipher suite
382 * This is usually ignored if @wpa_ie is used.
384 enum wpa_cipher group_suite;
387 * key_mgmt_suite - Selected key management suite
389 * This is usually ignored if @wpa_ie is used.
391 enum wpa_key_mgmt key_mgmt_suite;
394 * auth_alg - Allowed authentication algorithms
395 * Bit field of WPA_AUTH_ALG_*
400 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
405 * wep_key - WEP keys for static WEP configuration
407 const u8 *wep_key[4];
410 * wep_key_len - WEP key length for static WEP configuration
412 size_t wep_key_len[4];
415 * wep_tx_keyidx - WEP TX key index for static WEP configuration
420 * mgmt_frame_protection - IEEE 802.11w management frame protection
422 enum mfp_options mgmt_frame_protection;
425 * ft_ies - IEEE 802.11r / FT information elements
426 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
427 * for fast transition, this parameter is set to include the IEs that
428 * are to be sent in the next FT Authentication Request message.
429 * update_ft_ies() handler is called to update the IEs for further
430 * FT messages in the sequence.
432 * The driver should use these IEs only if the target AP is advertising
433 * the same mobility domain as the one included in the MDIE here.
435 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
436 * AP after the initial association. These IEs can only be used if the
437 * target AP is advertising support for FT and is using the same MDIE
438 * and SSID as the current AP.
440 * The driver is responsible for reporting the FT IEs received from the
441 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
442 * type. update_ft_ies() handler will then be called with the FT IEs to
443 * include in the next frame in the authentication sequence.
448 * ft_ies_len - Length of ft_ies in bytes
453 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
455 * This value is provided to allow the driver interface easier access
456 * to the current mobility domain. This value is set to %NULL if no
457 * mobility domain is currently active.
462 * passphrase - RSN passphrase for PSK
464 * This value is made available only for WPA/WPA2-Personal (PSK) and
465 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
466 * the 8..63 character ASCII passphrase, if available. Please note that
467 * this can be %NULL if passphrase was not used to generate the PSK. In
468 * that case, the psk field must be used to fetch the PSK.
470 const char *passphrase;
473 * psk - RSN PSK (alternative for passphrase for PSK)
475 * This value is made available only for WPA/WPA2-Personal (PSK) and
476 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
477 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
478 * be prepared to handle %NULL value as an error.
483 * drop_unencrypted - Enable/disable unencrypted frame filtering
485 * Configure the driver to drop all non-EAPOL frames (both receive and
486 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
487 * still be allowed for key negotiation.
489 int drop_unencrypted;
492 * prev_bssid - Previously used BSSID in this ESS
494 * When not %NULL, this is a request to use reassociation instead of
497 const u8 *prev_bssid;
502 * If the driver needs to do special configuration for WPS association,
503 * this variable provides more information on what type of association
504 * is being requested. Most drivers should not need ot use this.
509 * p2p - Whether this connection is a P2P group
514 * uapsd - UAPSD parameters for the network
515 * -1 = do not change defaults
516 * AP mode: 1 = enabled, 0 = disabled
517 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
522 * fixed_bssid - Whether to force this BSSID in IBSS mode
523 * 1 = Fix this BSSID and prevent merges.
524 * 0 = Do not fix BSSID.
529 * disable_ht - Disable HT (IEEE 802.11n) for this connection
534 * HT Capabilities over-rides. Only bits set in the mask will be used,
535 * and not all values are used by the kernel anyway. Currently, MCS,
536 * MPDU and MSDU fields are used.
538 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */
539 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */
544 HIDDEN_SSID_ZERO_LEN,
545 HIDDEN_SSID_ZERO_CONTENTS
548 struct wpa_driver_ap_params {
550 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
555 * head_len - Length of the head buffer in octets
560 * tail - Beacon tail following TIM IE
565 * tail_len - Length of the tail buffer in octets
570 * dtim_period - DTIM period
575 * beacon_int - Beacon interval
580 * basic_rates: -1 terminated array of basic rates in 100 kbps
582 * This parameter can be used to set a specific basic rate set for the
583 * BSS. If %NULL, default basic rate set is used.
588 * proberesp - Probe Response template
590 * This is used by drivers that reply to Probe Requests internally in
591 * AP mode and require the full Probe Response template.
596 * proberesp_len - Length of the proberesp buffer in octets
598 size_t proberesp_len;
601 * ssid - The SSID to use in Beacon/Probe Response frames
606 * ssid_len - Length of the SSID (1..32)
611 * hide_ssid - Whether to hide the SSID
613 enum hide_ssid hide_ssid;
616 * pairwise_ciphers - WPA_CIPHER_* bitfield
618 unsigned int pairwise_ciphers;
621 * group_cipher - WPA_CIPHER_*
623 unsigned int group_cipher;
626 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
628 unsigned int key_mgmt_suites;
631 * auth_algs - WPA_AUTH_ALG_* bitfield
633 unsigned int auth_algs;
636 * wpa_version - WPA_PROTO_* bitfield
638 unsigned int wpa_version;
641 * privacy - Whether privacy is used in the BSS
646 * beacon_ies - WPS/P2P IE(s) for Beacon frames
648 * This is used to add IEs like WPS IE and P2P IE by drivers that do
649 * not use the full Beacon template.
651 const struct wpabuf *beacon_ies;
654 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
656 * This is used to add IEs like WPS IE and P2P IE by drivers that
657 * reply to Probe Request frames internally.
659 const struct wpabuf *proberesp_ies;
662 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
664 * This is used to add IEs like WPS IE by drivers that reply to
665 * (Re)Association Request frames internally.
667 const struct wpabuf *assocresp_ies;
670 * isolate - Whether to isolate frames between associated stations
672 * If this is non-zero, the AP is requested to disable forwarding of
673 * frames between associated stations.
678 * cts_protect - Whether CTS protection is enabled
683 * preamble - Whether short preamble is enabled
688 * short_slot_time - Whether short slot time is enabled
690 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
691 * not set (e.g., when 802.11g mode is not in use)
696 * ht_opmode - HT operation mode or -1 if HT not in use
701 * interworking - Whether Interworking is enabled
706 * hessid - Homogeneous ESS identifier or %NULL if not set
711 * access_network_type - Access Network Type (0..15)
713 * This is used for filtering Probe Request frames when Interworking is
716 u8 access_network_type;
719 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
721 * This is used by driver which advertises this capability.
723 int ap_max_inactivity;
727 * struct wpa_driver_capa - Driver capability information
729 struct wpa_driver_capa {
730 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
731 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
732 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
733 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
734 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
735 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
736 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
737 unsigned int key_mgmt;
739 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
740 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
741 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
742 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
743 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
746 #define WPA_DRIVER_AUTH_OPEN 0x00000001
747 #define WPA_DRIVER_AUTH_SHARED 0x00000002
748 #define WPA_DRIVER_AUTH_LEAP 0x00000004
751 /* Driver generated WPA/RSN IE */
752 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
753 /* Driver needs static WEP key setup after association command */
754 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
755 /* unused: 0x00000004 */
756 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
757 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
758 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
759 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
760 /* Driver provides separate commands for authentication and association (SME in
761 * wpa_supplicant). */
762 #define WPA_DRIVER_FLAGS_SME 0x00000020
763 /* Driver supports AP mode */
764 #define WPA_DRIVER_FLAGS_AP 0x00000040
765 /* Driver needs static WEP key setup after association has been completed */
766 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
767 /* Driver takes care of P2P management operations */
768 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
769 /* Driver supports concurrent P2P operations */
770 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
772 * Driver uses the initial interface as a dedicated management interface, i.e.,
773 * it cannot be used for P2P group operations or non-P2P purposes.
775 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
776 /* This interface is P2P capable (P2P Device, GO, or P2P Client */
777 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
778 /* Driver supports concurrent operations on multiple channels */
779 #define WPA_DRIVER_FLAGS_MULTI_CHANNEL_CONCURRENT 0x00001000
781 * Driver uses the initial interface for P2P management interface and non-P2P
782 * purposes (e.g., connect to infra AP), but this interface cannot be used for
783 * P2P group operations.
785 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
787 * Driver is known to use sane error codes, i.e., when it indicates that
788 * something (e.g., association) fails, there was indeed a failure and the
789 * operation does not end up getting completed successfully later.
791 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
792 /* Driver supports off-channel TX */
793 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
794 /* Driver indicates TX status events for EAPOL Data frames */
795 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
796 /* Driver indicates TX status events for Deauth/Disassoc frames */
797 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
798 /* Driver supports roaming (BSS selection) in firmware */
799 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
800 /* Driver supports operating as a TDLS peer */
801 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
802 /* Driver requires external TDLS setup/teardown/discovery */
803 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
804 /* Driver indicates support for Probe Response offloading in AP mode */
805 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
806 /* Driver supports U-APSD in AP mode */
807 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
808 /* Driver supports inactivity timer in AP mode */
809 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
813 int max_sched_scan_ssids;
814 int sched_scan_supported;
818 * max_remain_on_chan - Maximum remain-on-channel duration in msec
820 unsigned int max_remain_on_chan;
823 * max_stations - Maximum number of associated stations the driver
824 * supports in AP mode
826 unsigned int max_stations;
829 * probe_resp_offloads - Bitmap of supported protocols by the driver
830 * for Probe Response offloading.
832 /* Driver Probe Response offloading support for WPS ver. 1 */
833 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
834 /* Driver Probe Response offloading support for WPS ver. 2 */
835 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
836 /* Driver Probe Response offloading support for P2P */
837 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
838 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
839 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
840 unsigned int probe_resp_offloads;
846 struct hostap_sta_driver_data {
847 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
848 unsigned long current_tx_rate;
849 unsigned long inactive_msec;
851 unsigned long num_ps_buf_frames;
852 unsigned long tx_retry_failed;
853 unsigned long tx_retry_count;
858 struct hostapd_sta_add_params {
862 const u8 *supp_rates;
863 size_t supp_rates_len;
865 const struct ieee80211_ht_capabilities *ht_capabilities;
866 u32 flags; /* bitmask of WPA_STA_* flags */
867 int set; /* Set STA parameters instead of add */
871 struct hostapd_freq_params {
876 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
877 * secondary channel below primary, 1 = HT40
878 * enabled, secondary channel above primary */
881 enum wpa_driver_if_type {
883 * WPA_IF_STATION - Station mode interface
888 * WPA_IF_AP_VLAN - AP mode VLAN interface
890 * This interface shares its address and Beacon frame with the main
896 * WPA_IF_AP_BSS - AP mode BSS interface
898 * This interface has its own address and Beacon frame.
903 * WPA_IF_P2P_GO - P2P Group Owner
908 * WPA_IF_P2P_CLIENT - P2P Client
913 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
914 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
919 struct wpa_init_params {
925 const char *test_socket;
926 int use_pae_group_addr;
930 u8 *own_addr; /* buffer for writing own MAC address */
934 struct wpa_bss_params {
935 /** Interface name (for multi-SSID/VLAN support) */
937 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
946 enum mfp_options ieee80211w;
949 #define WPA_STA_AUTHORIZED BIT(0)
950 #define WPA_STA_WMM BIT(1)
951 #define WPA_STA_SHORT_PREAMBLE BIT(2)
952 #define WPA_STA_MFP BIT(3)
953 #define WPA_STA_TDLS_PEER BIT(4)
956 * struct p2p_params - P2P parameters for driver-based P2P management
959 const char *dev_name;
961 #define DRV_MAX_SEC_DEV_TYPES 5
962 u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8];
963 size_t num_sec_dev_types;
977 * struct wpa_signal_info - Information about channel signal quality
979 struct wpa_signal_info {
988 * struct wpa_driver_ops - Driver interface API definition
990 * This structure defines the API that each driver interface needs to implement
991 * for core wpa_supplicant code. All driver specific functionality is captured
994 struct wpa_driver_ops {
995 /** Name of the driver interface */
997 /** One line description of the driver interface */
1001 * get_bssid - Get the current BSSID
1002 * @priv: private driver interface data
1003 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1005 * Returns: 0 on success, -1 on failure
1007 * Query kernel driver for the current BSSID and copy it to bssid.
1008 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1011 int (*get_bssid)(void *priv, u8 *bssid);
1014 * get_ssid - Get the current SSID
1015 * @priv: private driver interface data
1016 * @ssid: buffer for SSID (at least 32 bytes)
1018 * Returns: Length of the SSID on success, -1 on failure
1020 * Query kernel driver for the current SSID and copy it to ssid.
1021 * Returning zero is recommended if the STA is not associated.
1023 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1024 * can, at least in theory, contain control characters (including nul)
1025 * and as such, should be processed as binary data, not a printable
1028 int (*get_ssid)(void *priv, u8 *ssid);
1031 * set_key - Configure encryption key
1032 * @ifname: Interface name (for multi-SSID/VLAN support)
1033 * @priv: private driver interface data
1034 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1035 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
1036 * %WPA_ALG_NONE clears the key.
1037 * @addr: Address of the peer STA (BSSID of the current AP when setting
1038 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1039 * broadcast keys, %NULL for default keys that are used both for
1040 * broadcast and unicast; when clearing keys, %NULL is used to
1041 * indicate that both the broadcast-only and default key of the
1042 * specified key index is to be cleared
1043 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1045 * @set_tx: configure this key as the default Tx key (only used when
1046 * driver does not support separate unicast/individual key
1047 * @seq: sequence number/packet number, seq_len octets, the next
1048 * packet number to be used for in replay protection; configured
1049 * for Rx keys (in most cases, this is only used with broadcast
1050 * keys and set to zero for unicast keys); %NULL if not set
1051 * @seq_len: length of the seq, depends on the algorithm:
1052 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
1053 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1055 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1056 * TKIP: 32, CCMP: 16, IGTK: 16)
1058 * Returns: 0 on success, -1 on failure
1060 * Configure the given key for the kernel driver. If the driver
1061 * supports separate individual keys (4 default keys + 1 individual),
1062 * addr can be used to determine whether the key is default or
1063 * individual. If only 4 keys are supported, the default key with key
1064 * index 0 is used as the individual key. STA must be configured to use
1065 * it as the default Tx key (set_tx is set) and accept Rx for all the
1066 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1067 * broadcast keys, so key index 0 is available for this kind of
1070 * Please note that TKIP keys include separate TX and RX MIC keys and
1071 * some drivers may expect them in different order than wpa_supplicant
1072 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1073 * will trigger Michael MIC errors. This can be fixed by changing the
1074 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1075 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1076 * example on how this can be done.
1078 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1079 const u8 *addr, int key_idx, int set_tx,
1080 const u8 *seq, size_t seq_len,
1081 const u8 *key, size_t key_len);
1084 * init - Initialize driver interface
1085 * @ctx: context to be used when calling wpa_supplicant functions,
1086 * e.g., wpa_supplicant_event()
1087 * @ifname: interface name, e.g., wlan0
1089 * Returns: Pointer to private data, %NULL on failure
1091 * Initialize driver interface, including event processing for kernel
1092 * driver events (e.g., associated, scan results, Michael MIC failure).
1093 * This function can allocate a private configuration data area for
1094 * @ctx, file descriptor, interface name, etc. information that may be
1095 * needed in future driver operations. If this is not used, non-NULL
1096 * value will need to be returned because %NULL is used to indicate
1097 * failure. The returned value will be used as 'void *priv' data for
1098 * all other driver_ops functions.
1100 * The main event loop (eloop.c) of wpa_supplicant can be used to
1101 * register callback for read sockets (eloop_register_read_sock()).
1103 * See below for more information about events and
1104 * wpa_supplicant_event() function.
1106 void * (*init)(void *ctx, const char *ifname);
1109 * deinit - Deinitialize driver interface
1110 * @priv: private driver interface data from init()
1112 * Shut down driver interface and processing of driver events. Free
1113 * private data buffer if one was allocated in init() handler.
1115 void (*deinit)(void *priv);
1118 * set_param - Set driver configuration parameters
1119 * @priv: private driver interface data from init()
1120 * @param: driver specific configuration parameters
1122 * Returns: 0 on success, -1 on failure
1124 * Optional handler for notifying driver interface about configuration
1125 * parameters (driver_param).
1127 int (*set_param)(void *priv, const char *param);
1130 * set_countermeasures - Enable/disable TKIP countermeasures
1131 * @priv: private driver interface data
1132 * @enabled: 1 = countermeasures enabled, 0 = disabled
1134 * Returns: 0 on success, -1 on failure
1136 * Configure TKIP countermeasures. When these are enabled, the driver
1137 * should drop all received and queued frames that are using TKIP.
1139 int (*set_countermeasures)(void *priv, int enabled);
1142 * deauthenticate - Request driver to deauthenticate
1143 * @priv: private driver interface data
1144 * @addr: peer address (BSSID of the AP)
1145 * @reason_code: 16-bit reason code to be sent in the deauthentication
1148 * Returns: 0 on success, -1 on failure
1150 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1153 * disassociate - Request driver to disassociate
1154 * @priv: private driver interface data
1155 * @addr: peer address (BSSID of the AP)
1156 * @reason_code: 16-bit reason code to be sent in the disassociation
1159 * Returns: 0 on success, -1 on failure
1161 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
1164 * associate - Request driver to associate
1165 * @priv: private driver interface data
1166 * @params: association parameters
1168 * Returns: 0 on success, -1 on failure
1170 int (*associate)(void *priv,
1171 struct wpa_driver_associate_params *params);
1174 * add_pmkid - Add PMKSA cache entry to the driver
1175 * @priv: private driver interface data
1176 * @bssid: BSSID for the PMKSA cache entry
1177 * @pmkid: PMKID for the PMKSA cache entry
1179 * Returns: 0 on success, -1 on failure
1181 * This function is called when a new PMK is received, as a result of
1182 * either normal authentication or RSN pre-authentication.
1184 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1185 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1186 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1187 * driver_ops function does not need to be implemented. Likewise, if
1188 * the driver does not support WPA, this function is not needed.
1190 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1193 * remove_pmkid - Remove PMKSA cache entry to the driver
1194 * @priv: private driver interface data
1195 * @bssid: BSSID for the PMKSA cache entry
1196 * @pmkid: PMKID for the PMKSA cache entry
1198 * Returns: 0 on success, -1 on failure
1200 * This function is called when the supplicant drops a PMKSA cache
1201 * entry for any reason.
1203 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1204 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1205 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1206 * from wpa_supplicant, this driver_ops function does not need to be
1207 * implemented. Likewise, if the driver does not support WPA, this
1208 * function is not needed.
1210 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1213 * flush_pmkid - Flush PMKSA cache
1214 * @priv: private driver interface data
1216 * Returns: 0 on success, -1 on failure
1218 * This function is called when the supplicant drops all PMKSA cache
1219 * entries for any reason.
1221 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1222 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1223 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1224 * from wpa_supplicant, this driver_ops function does not need to be
1225 * implemented. Likewise, if the driver does not support WPA, this
1226 * function is not needed.
1228 int (*flush_pmkid)(void *priv);
1231 * get_capa - Get driver capabilities
1232 * @priv: private driver interface data
1234 * Returns: 0 on success, -1 on failure
1236 * Get driver/firmware/hardware capabilities.
1238 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1241 * poll - Poll driver for association information
1242 * @priv: private driver interface data
1244 * This is an option callback that can be used when the driver does not
1245 * provide event mechanism for association events. This is called when
1246 * receiving WPA EAPOL-Key messages that require association
1247 * information. The driver interface is supposed to generate associnfo
1248 * event before returning from this callback function. In addition, the
1249 * driver interface should generate an association event after having
1250 * sent out associnfo.
1252 void (*poll)(void *priv);
1255 * get_ifname - Get interface name
1256 * @priv: private driver interface data
1258 * Returns: Pointer to the interface name. This can differ from the
1259 * interface name used in init() call. Init() is called first.
1261 * This optional function can be used to allow the driver interface to
1262 * replace the interface name with something else, e.g., based on an
1263 * interface mapping from a more descriptive name.
1265 const char * (*get_ifname)(void *priv);
1268 * get_mac_addr - Get own MAC address
1269 * @priv: private driver interface data
1271 * Returns: Pointer to own MAC address or %NULL on failure
1273 * This optional function can be used to get the own MAC address of the
1274 * device from the driver interface code. This is only needed if the
1275 * l2_packet implementation for the OS does not provide easy access to
1277 const u8 * (*get_mac_addr)(void *priv);
1280 * send_eapol - Optional function for sending EAPOL packets
1281 * @priv: private driver interface data
1282 * @dest: Destination MAC address
1284 * @data: EAPOL packet starting with IEEE 802.1X header
1285 * @data_len: Size of the EAPOL packet
1287 * Returns: 0 on success, -1 on failure
1289 * This optional function can be used to override l2_packet operations
1290 * with driver specific functionality. If this function pointer is set,
1291 * l2_packet module is not used at all and the driver interface code is
1292 * responsible for receiving and sending all EAPOL packets. The
1293 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1294 * event. The driver interface is required to implement get_mac_addr()
1295 * handler if send_eapol() is used.
1297 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1298 const u8 *data, size_t data_len);
1301 * set_operstate - Sets device operating state to DORMANT or UP
1302 * @priv: private driver interface data
1303 * @state: 0 = dormant, 1 = up
1304 * Returns: 0 on success, -1 on failure
1306 * This is an optional function that can be used on operating systems
1307 * that support a concept of controlling network device state from user
1308 * space applications. This function, if set, gets called with
1309 * state = 1 when authentication has been completed and with state = 0
1310 * when connection is lost.
1312 int (*set_operstate)(void *priv, int state);
1315 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1316 * @priv: Private driver interface data
1317 * @addr: Address of the station for which to set protection (may be
1318 * %NULL for group keys)
1319 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1320 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1321 * Returns: 0 on success, -1 on failure
1323 * This is an optional function that can be used to set the driver to
1324 * require protection for Tx and/or Rx frames. This uses the layer
1325 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1326 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1327 * set protection operation; instead, they set protection implicitly
1328 * based on configured keys.
1330 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1334 * get_hw_feature_data - Get hardware support data (channels and rates)
1335 * @priv: Private driver interface data
1336 * @num_modes: Variable for returning the number of returned modes
1337 * flags: Variable for returning hardware feature flags
1338 * Returns: Pointer to allocated hardware data on success or %NULL on
1339 * failure. Caller is responsible for freeing this.
1341 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1346 * send_mlme - Send management frame from MLME
1347 * @priv: Private driver interface data
1348 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1349 * @data_len: Size of the management frame
1350 * @noack: Do not wait for this frame to be acked (disable retries)
1351 * Returns: 0 on success, -1 on failure
1353 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1357 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1358 * @priv: Private driver interface data
1359 * @md: Mobility domain (2 octets) (also included inside ies)
1360 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1361 * @ies_len: Length of FT IEs in bytes
1362 * Returns: 0 on success, -1 on failure
1364 * The supplicant uses this callback to let the driver know that keying
1365 * material for FT is available and that the driver can use the
1366 * provided IEs in the next message in FT authentication sequence.
1368 * This function is only needed for driver that support IEEE 802.11r
1369 * (Fast BSS Transition).
1371 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1375 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1376 * @priv: Private driver interface data
1377 * @action: Action field value
1378 * @target_ap: Target AP address
1379 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1380 * @ies_len: Length of FT IEs in bytes
1381 * Returns: 0 on success, -1 on failure
1383 * The supplicant uses this callback to request the driver to transmit
1384 * an FT Action frame (action category 6) for over-the-DS fast BSS
1387 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1388 const u8 *ies, size_t ies_len);
1391 * get_scan_results2 - Fetch the latest scan results
1392 * @priv: private driver interface data
1394 * Returns: Allocated buffer of scan results (caller is responsible for
1395 * freeing the data structure) on success, NULL on failure
1397 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1400 * set_country - Set country
1401 * @priv: Private driver interface data
1402 * @alpha2: country to which to switch to
1403 * Returns: 0 on success, -1 on failure
1405 * This function is for drivers which support some form
1406 * of setting a regulatory domain.
1408 int (*set_country)(void *priv, const char *alpha2);
1411 * global_init - Global driver initialization
1412 * Returns: Pointer to private data (global), %NULL on failure
1414 * This optional function is called to initialize the driver wrapper
1415 * for global data, i.e., data that applies to all interfaces. If this
1416 * function is implemented, global_deinit() will also need to be
1417 * implemented to free the private data. The driver will also likely
1418 * use init2() function instead of init() to get the pointer to global
1419 * data available to per-interface initializer.
1421 void * (*global_init)(void);
1424 * global_deinit - Global driver deinitialization
1425 * @priv: private driver global data from global_init()
1427 * Terminate any global driver related functionality and free the
1428 * global data structure.
1430 void (*global_deinit)(void *priv);
1433 * init2 - Initialize driver interface (with global data)
1434 * @ctx: context to be used when calling wpa_supplicant functions,
1435 * e.g., wpa_supplicant_event()
1436 * @ifname: interface name, e.g., wlan0
1437 * @global_priv: private driver global data from global_init()
1438 * Returns: Pointer to private data, %NULL on failure
1440 * This function can be used instead of init() if the driver wrapper
1443 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1446 * get_interfaces - Get information about available interfaces
1447 * @global_priv: private driver global data from global_init()
1448 * Returns: Allocated buffer of interface information (caller is
1449 * responsible for freeing the data structure) on success, NULL on
1452 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1455 * scan2 - Request the driver to initiate scan
1456 * @priv: private driver interface data
1457 * @params: Scan parameters
1459 * Returns: 0 on success, -1 on failure
1461 * Once the scan results are ready, the driver should report scan
1462 * results event for wpa_supplicant which will eventually request the
1463 * results with wpa_driver_get_scan_results2().
1465 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1468 * authenticate - Request driver to authenticate
1469 * @priv: private driver interface data
1470 * @params: authentication parameters
1471 * Returns: 0 on success, -1 on failure
1473 * This is an optional function that can be used with drivers that
1474 * support separate authentication and association steps, i.e., when
1475 * wpa_supplicant can act as the SME. If not implemented, associate()
1476 * function is expected to take care of IEEE 802.11 authentication,
1479 int (*authenticate)(void *priv,
1480 struct wpa_driver_auth_params *params);
1483 * set_ap - Set Beacon and Probe Response information for AP mode
1484 * @priv: Private driver interface data
1485 * @params: Parameters to use in AP mode
1487 * This function is used to configure Beacon template and/or extra IEs
1488 * to add for Beacon and Probe Response frames for the driver in
1489 * AP mode. The driver is responsible for building the full Beacon
1490 * frame by concatenating the head part with TIM IE generated by the
1491 * driver/firmware and finishing with the tail part. Depending on the
1492 * driver architectue, this can be done either by using the full
1493 * template or the set of additional IEs (e.g., WPS and P2P IE).
1494 * Similarly, Probe Response processing depends on the driver design.
1495 * If the driver (or firmware) takes care of replying to Probe Request
1496 * frames, the extra IEs provided here needs to be added to the Probe
1499 * Returns: 0 on success, -1 on failure
1501 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1504 * hapd_init - Initialize driver interface (hostapd only)
1505 * @hapd: Pointer to hostapd context
1506 * @params: Configuration for the driver wrapper
1507 * Returns: Pointer to private data, %NULL on failure
1509 * This function is used instead of init() or init2() when the driver
1510 * wrapper is used with hostapd.
1512 void * (*hapd_init)(struct hostapd_data *hapd,
1513 struct wpa_init_params *params);
1516 * hapd_deinit - Deinitialize driver interface (hostapd only)
1517 * @priv: Private driver interface data from hapd_init()
1519 void (*hapd_deinit)(void *priv);
1522 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1523 * @priv: Private driver interface data
1524 * @params: BSS parameters
1525 * Returns: 0 on success, -1 on failure
1527 * This is an optional function to configure the kernel driver to
1528 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1529 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1530 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1531 * for Beacon frames.
1533 * DEPRECATED - use set_ap() instead
1535 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1538 * set_privacy - Enable/disable privacy (AP only)
1539 * @priv: Private driver interface data
1540 * @enabled: 1 = privacy enabled, 0 = disabled
1541 * Returns: 0 on success, -1 on failure
1543 * This is an optional function to configure privacy field in the
1544 * kernel driver for Beacon frames. This can be left undefined (set to
1545 * %NULL) if the driver uses the Beacon template from set_ap().
1547 * DEPRECATED - use set_ap() instead
1549 int (*set_privacy)(void *priv, int enabled);
1552 * get_seqnum - Fetch the current TSC/packet number (AP only)
1553 * @ifname: The interface name (main or virtual)
1554 * @priv: Private driver interface data
1555 * @addr: MAC address of the station or %NULL for group keys
1557 * @seq: Buffer for returning the latest used TSC/packet number
1558 * Returns: 0 on success, -1 on failure
1560 * This function is used to fetch the last used TSC/packet number for
1561 * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so
1562 * there is no strict requirement on implementing support for unicast
1563 * keys (i.e., addr != %NULL).
1565 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1569 * flush - Flush all association stations (AP only)
1570 * @priv: Private driver interface data
1571 * Returns: 0 on success, -1 on failure
1573 * This function requests the driver to disassociate all associated
1574 * stations. This function does not need to be implemented if the
1575 * driver does not process association frames internally.
1577 int (*flush)(void *priv);
1580 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1581 * @priv: Private driver interface data
1582 * @elem: Information elements
1583 * @elem_len: Length of the elem buffer in octets
1584 * Returns: 0 on success, -1 on failure
1586 * This is an optional function to add information elements in the
1587 * kernel driver for Beacon and Probe Response frames. This can be left
1588 * undefined (set to %NULL) if the driver uses the Beacon template from
1591 * DEPRECATED - use set_ap() instead
1593 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1596 * read_sta_data - Fetch station data (AP only)
1597 * @priv: Private driver interface data
1598 * @data: Buffer for returning station information
1599 * @addr: MAC address of the station
1600 * Returns: 0 on success, -1 on failure
1602 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1606 * hapd_send_eapol - Send an EAPOL packet (AP only)
1607 * @priv: private driver interface data
1608 * @addr: Destination MAC address
1609 * @data: EAPOL packet starting with IEEE 802.1X header
1610 * @data_len: Length of the EAPOL packet in octets
1611 * @encrypt: Whether the frame should be encrypted
1612 * @own_addr: Source MAC address
1613 * @flags: WPA_STA_* flags for the destination station
1615 * Returns: 0 on success, -1 on failure
1617 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1618 size_t data_len, int encrypt,
1619 const u8 *own_addr, u32 flags);
1622 * sta_deauth - Deauthenticate a station (AP only)
1623 * @priv: Private driver interface data
1624 * @own_addr: Source address and BSSID for the Deauthentication frame
1625 * @addr: MAC address of the station to deauthenticate
1626 * @reason: Reason code for the Deauthentiation frame
1627 * Returns: 0 on success, -1 on failure
1629 * This function requests a specific station to be deauthenticated and
1630 * a Deauthentication frame to be sent to it.
1632 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1636 * sta_disassoc - Disassociate a station (AP only)
1637 * @priv: Private driver interface data
1638 * @own_addr: Source address and BSSID for the Disassociation frame
1639 * @addr: MAC address of the station to disassociate
1640 * @reason: Reason code for the Disassociation frame
1641 * Returns: 0 on success, -1 on failure
1643 * This function requests a specific station to be disassociated and
1644 * a Disassociation frame to be sent to it.
1646 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1650 * sta_remove - Remove a station entry (AP only)
1651 * @priv: Private driver interface data
1652 * @addr: MAC address of the station to be removed
1653 * Returns: 0 on success, -1 on failure
1655 int (*sta_remove)(void *priv, const u8 *addr);
1658 * hapd_get_ssid - Get the current SSID (AP only)
1659 * @priv: Private driver interface data
1660 * @buf: Buffer for returning the SSID
1661 * @len: Maximum length of the buffer
1662 * Returns: Length of the SSID on success, -1 on failure
1664 * This function need not be implemented if the driver uses Beacon
1665 * template from set_ap() and does not reply to Probe Request frames.
1667 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1670 * hapd_set_ssid - Set SSID (AP only)
1671 * @priv: Private driver interface data
1673 * @len: Length of the SSID in octets
1674 * Returns: 0 on success, -1 on failure
1676 * DEPRECATED - use set_ap() instead
1678 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1681 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1682 * @priv: Private driver interface data
1683 * @enabled: 1 = countermeasures enabled, 0 = disabled
1684 * Returns: 0 on success, -1 on failure
1686 * This need not be implemented if the driver does not take care of
1687 * association processing.
1689 int (*hapd_set_countermeasures)(void *priv, int enabled);
1692 * sta_add - Add a station entry
1693 * @priv: Private driver interface data
1694 * @params: Station parameters
1695 * Returns: 0 on success, -1 on failure
1697 * This function is used to add a station entry to the driver once the
1698 * station has completed association. This is only used if the driver
1699 * does not take care of association processing.
1701 * With TDLS, this function is also used to add or set (params->set 1)
1702 * TDLS peer entries.
1704 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1707 * get_inact_sec - Get station inactivity duration (AP only)
1708 * @priv: Private driver interface data
1709 * @addr: Station address
1710 * Returns: Number of seconds station has been inactive, -1 on failure
1712 int (*get_inact_sec)(void *priv, const u8 *addr);
1715 * sta_clear_stats - Clear station statistics (AP only)
1716 * @priv: Private driver interface data
1717 * @addr: Station address
1718 * Returns: 0 on success, -1 on failure
1720 int (*sta_clear_stats)(void *priv, const u8 *addr);
1723 * set_freq - Set channel/frequency (AP only)
1724 * @priv: Private driver interface data
1725 * @freq: Channel parameters
1726 * Returns: 0 on success, -1 on failure
1728 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1731 * set_rts - Set RTS threshold
1732 * @priv: Private driver interface data
1733 * @rts: RTS threshold in octets
1734 * Returns: 0 on success, -1 on failure
1736 int (*set_rts)(void *priv, int rts);
1739 * set_frag - Set fragmentation threshold
1740 * @priv: Private driver interface data
1741 * @frag: Fragmentation threshold in octets
1742 * Returns: 0 on success, -1 on failure
1744 int (*set_frag)(void *priv, int frag);
1747 * sta_set_flags - Set station flags (AP only)
1748 * @priv: Private driver interface data
1749 * @addr: Station address
1750 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1751 * @flags_or: Bitmap of WPA_STA_* flags to add
1752 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1753 * Returns: 0 on success, -1 on failure
1755 int (*sta_set_flags)(void *priv, const u8 *addr,
1756 int total_flags, int flags_or, int flags_and);
1759 * set_tx_queue_params - Set TX queue parameters
1760 * @priv: Private driver interface data
1761 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
1765 * @burst_time: Maximum length for bursting in 0.1 msec units
1767 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1768 int cw_max, int burst_time);
1771 * if_add - Add a virtual interface
1772 * @priv: Private driver interface data
1773 * @type: Interface type
1774 * @ifname: Interface name for the new virtual interface
1775 * @addr: Local address to use for the interface or %NULL to use the
1776 * parent interface address
1777 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1778 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1779 * not allowed (applies only to %WPA_IF_AP_BSS type)
1780 * @force_ifname: Buffer for returning an interface name that the
1781 * driver ended up using if it differs from the requested ifname
1782 * @if_addr: Buffer for returning the allocated interface address
1783 * (this may differ from the requested addr if the driver cannot
1784 * change interface address)
1785 * @bridge: Bridge interface to use or %NULL if no bridge configured
1786 * Returns: 0 on success, -1 on failure
1788 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1789 const char *ifname, const u8 *addr, void *bss_ctx,
1790 void **drv_priv, char *force_ifname, u8 *if_addr,
1791 const char *bridge);
1794 * if_remove - Remove a virtual interface
1795 * @priv: Private driver interface data
1796 * @type: Interface type
1797 * @ifname: Interface name of the virtual interface to be removed
1798 * Returns: 0 on success, -1 on failure
1800 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1801 const char *ifname);
1804 * set_sta_vlan - Bind a station into a specific interface (AP only)
1805 * @priv: Private driver interface data
1806 * @ifname: Interface (main or virtual BSS or VLAN)
1807 * @addr: MAC address of the associated station
1809 * Returns: 0 on success, -1 on failure
1811 * This function is used to bind a station to a specific virtual
1812 * interface. It is only used if when virtual interfaces are supported,
1813 * e.g., to assign stations to different VLAN interfaces based on
1814 * information from a RADIUS server. This allows separate broadcast
1815 * domains to be used with a single BSS.
1817 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1821 * commit - Optional commit changes handler (AP only)
1822 * @priv: driver private data
1823 * Returns: 0 on success, -1 on failure
1825 * This optional handler function can be registered if the driver
1826 * interface implementation needs to commit changes (e.g., by setting
1827 * network interface up) at the end of initial configuration. If set,
1828 * this handler will be called after initial setup has been completed.
1830 int (*commit)(void *priv);
1833 * send_ether - Send an ethernet packet (AP only)
1834 * @priv: private driver interface data
1835 * @dst: Destination MAC address
1836 * @src: Source MAC address
1838 * @data: EAPOL packet starting with IEEE 802.1X header
1839 * @data_len: Length of the EAPOL packet in octets
1840 * Returns: 0 on success, -1 on failure
1842 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1843 const u8 *data, size_t data_len);
1846 * set_radius_acl_auth - Notification of RADIUS ACL change
1847 * @priv: Private driver interface data
1848 * @mac: MAC address of the station
1849 * @accepted: Whether the station was accepted
1850 * @session_timeout: Session timeout for the station
1851 * Returns: 0 on success, -1 on failure
1853 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1854 u32 session_timeout);
1857 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1858 * @priv: Private driver interface data
1859 * @mac: MAC address of the station
1860 * Returns: 0 on success, -1 on failure
1862 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1865 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
1866 * @priv: Private driver interface data
1867 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
1868 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
1870 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
1871 * to remove extra IE(s)
1872 * Returns: 0 on success, -1 on failure
1874 * This is an optional function to add WPS IE in the kernel driver for
1875 * Beacon and Probe Response frames. This can be left undefined (set
1876 * to %NULL) if the driver uses the Beacon template from set_ap()
1877 * and does not process Probe Request frames. If the driver takes care
1878 * of (Re)Association frame processing, the assocresp buffer includes
1879 * WPS IE(s) that need to be added to (Re)Association Response frames
1880 * whenever a (Re)Association Request frame indicated use of WPS.
1882 * This will also be used to add P2P IE(s) into Beacon/Probe Response
1883 * frames when operating as a GO. The driver is responsible for adding
1884 * timing related attributes (e.g., NoA) in addition to the IEs
1885 * included here by appending them after these buffers. This call is
1886 * also used to provide Probe Response IEs for P2P Listen state
1887 * operations for drivers that generate the Probe Response frames
1890 * DEPRECATED - use set_ap() instead
1892 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
1893 const struct wpabuf *proberesp,
1894 const struct wpabuf *assocresp);
1897 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1898 * @priv: Private driver interface data
1899 * @authorized: Whether the port is authorized
1900 * Returns: 0 on success, -1 on failure
1902 int (*set_supp_port)(void *priv, int authorized);
1905 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1906 * @priv: Private driver interface data
1907 * @addr: MAC address of the associated station
1908 * @aid: Association ID
1909 * @val: 1 = bind to 4-address WDS; 0 = unbind
1910 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
1911 * to indicate that bridge is not to be used
1912 * Returns: 0 on success, -1 on failure
1914 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
1915 const char *bridge_ifname);
1918 * send_action - Transmit an Action frame
1919 * @priv: Private driver interface data
1920 * @freq: Frequency (in MHz) of the channel
1921 * @wait: Time to wait off-channel for a response (in ms), or zero
1922 * @dst: Destination MAC address (Address 1)
1923 * @src: Source MAC address (Address 2)
1924 * @bssid: BSSID (Address 3)
1926 * @data_len: data length in octets
1927 @ @no_cck: Whether CCK rates must not be used to transmit this frame
1928 * Returns: 0 on success, -1 on failure
1930 * This command can be used to request the driver to transmit an action
1931 * frame to the specified destination.
1933 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
1934 * be transmitted on the given channel and the device will wait for a
1935 * response on that channel for the given wait time.
1937 * If the flag is not set, the wait time will be ignored. In this case,
1938 * if a remain-on-channel duration is in progress, the frame must be
1939 * transmitted on that channel; alternatively the frame may be sent on
1940 * the current operational channel (if in associated state in station
1941 * mode or while operating as an AP.)
1943 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
1944 const u8 *dst, const u8 *src, const u8 *bssid,
1945 const u8 *data, size_t data_len, int no_cck);
1948 * send_action_cancel_wait - Cancel action frame TX wait
1949 * @priv: Private driver interface data
1951 * This command cancels the wait time associated with sending an action
1952 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
1953 * set in the driver flags.
1955 void (*send_action_cancel_wait)(void *priv);
1958 * remain_on_channel - Remain awake on a channel
1959 * @priv: Private driver interface data
1960 * @freq: Frequency (in MHz) of the channel
1961 * @duration: Duration in milliseconds
1962 * Returns: 0 on success, -1 on failure
1964 * This command is used to request the driver to remain awake on the
1965 * specified channel for the specified duration and report received
1966 * Action frames with EVENT_RX_ACTION events. Optionally, received
1967 * Probe Request frames may also be requested to be reported by calling
1968 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
1970 * The driver may not be at the requested channel when this function
1971 * returns, i.e., the return code is only indicating whether the
1972 * request was accepted. The caller will need to wait until the
1973 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
1974 * completed the channel change. This may take some time due to other
1975 * need for the radio and the caller should be prepared to timing out
1976 * its wait since there are no guarantees on when this request can be
1979 int (*remain_on_channel)(void *priv, unsigned int freq,
1980 unsigned int duration);
1983 * cancel_remain_on_channel - Cancel remain-on-channel operation
1984 * @priv: Private driver interface data
1986 * This command can be used to cancel a remain-on-channel operation
1987 * before its originally requested duration has passed. This could be
1988 * used, e.g., when remain_on_channel() is used to request extra time
1989 * to receive a response to an Action frame and the response is
1990 * received when there is still unneeded time remaining on the
1991 * remain-on-channel operation.
1993 int (*cancel_remain_on_channel)(void *priv);
1996 * probe_req_report - Request Probe Request frames to be indicated
1997 * @priv: Private driver interface data
1998 * @report: Whether to report received Probe Request frames
1999 * Returns: 0 on success, -1 on failure (or if not supported)
2001 * This command can be used to request the driver to indicate when
2002 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2003 * Since this operation may require extra resources, e.g., due to less
2004 * optimal hardware/firmware RX filtering, many drivers may disable
2005 * Probe Request reporting at least in station mode. This command is
2006 * used to notify the driver when the Probe Request frames need to be
2007 * reported, e.g., during remain-on-channel operations.
2009 int (*probe_req_report)(void *priv, int report);
2012 * deinit_ap - Deinitialize AP mode
2013 * @priv: Private driver interface data
2014 * Returns: 0 on success, -1 on failure (or if not supported)
2016 * This optional function can be used to disable AP mode related
2017 * configuration and change the driver mode to station mode to allow
2018 * normal station operations like scanning to be completed.
2020 int (*deinit_ap)(void *priv);
2023 * deinit_p2p_cli - Deinitialize P2P client mode
2024 * @priv: Private driver interface data
2025 * Returns: 0 on success, -1 on failure (or if not supported)
2027 * This optional function can be used to disable P2P client mode. It
2028 * can be used to change the interface type back to station mode.
2030 int (*deinit_p2p_cli)(void *priv);
2033 * suspend - Notification on system suspend/hibernate event
2034 * @priv: Private driver interface data
2036 void (*suspend)(void *priv);
2039 * resume - Notification on system resume/thaw event
2040 * @priv: Private driver interface data
2042 void (*resume)(void *priv);
2045 * signal_monitor - Set signal monitoring parameters
2046 * @priv: Private driver interface data
2047 * @threshold: Threshold value for signal change events; 0 = disabled
2048 * @hysteresis: Minimum change in signal strength before indicating a
2050 * Returns: 0 on success, -1 on failure (or if not supported)
2052 * This function can be used to configure monitoring of signal strength
2053 * with the current AP. Whenever signal strength drops below the
2054 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2055 * should be generated assuming the signal strength has changed at
2056 * least %hysteresis from the previously indicated signal change event.
2058 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2061 * send_frame - Send IEEE 802.11 frame (testing use only)
2062 * @priv: Private driver interface data
2063 * @data: IEEE 802.11 frame with IEEE 802.11 header
2064 * @data_len: Size of the frame
2065 * @encrypt: Whether to encrypt the frame (if keys are set)
2066 * Returns: 0 on success, -1 on failure
2068 * This function is only used for debugging purposes and is not
2069 * required to be implemented for normal operations.
2071 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2075 * shared_freq - Get operating frequency of shared interface(s)
2076 * @priv: Private driver interface data
2077 * Returns: Operating frequency in MHz, 0 if no shared operation in
2078 * use, or -1 on failure
2080 * This command can be used to request the current operating frequency
2081 * of any virtual interface that shares the same radio to provide
2082 * information for channel selection for other virtual interfaces.
2084 int (*shared_freq)(void *priv);
2087 * get_noa - Get current Notice of Absence attribute payload
2088 * @priv: Private driver interface data
2089 * @buf: Buffer for returning NoA
2090 * @buf_len: Buffer length in octets
2091 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2092 * advertized, or -1 on failure
2094 * This function is used to fetch the current Notice of Absence
2095 * attribute value from GO.
2097 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2100 * set_noa - Set Notice of Absence parameters for GO (testing)
2101 * @priv: Private driver interface data
2103 * @start: Start time in ms from next TBTT
2104 * @duration: Duration in ms
2105 * Returns: 0 on success or -1 on failure
2107 * This function is used to set Notice of Absence parameters for GO. It
2108 * is used only for testing. To disable NoA, all parameters are set to
2111 int (*set_noa)(void *priv, u8 count, int start, int duration);
2114 * set_p2p_powersave - Set P2P power save options
2115 * @priv: Private driver interface data
2116 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2117 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2118 * @ctwindow: 0.. = change (msec), -1 = no change
2119 * Returns: 0 on success or -1 on failure
2121 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2125 * ampdu - Enable/disable aggregation
2126 * @priv: Private driver interface data
2127 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2128 * Returns: 0 on success or -1 on failure
2130 int (*ampdu)(void *priv, int ampdu);
2133 * get_radio_name - Get physical radio name for the device
2134 * @priv: Private driver interface data
2135 * Returns: Radio name or %NULL if not known
2137 * The returned data must not be modified by the caller. It is assumed
2138 * that any interface that has the same radio name as another is
2139 * sharing the same physical radio. This information can be used to
2140 * share scan results etc. information between the virtual interfaces
2141 * to speed up various operations.
2143 const char * (*get_radio_name)(void *priv);
2146 * p2p_find - Start P2P Device Discovery
2147 * @priv: Private driver interface data
2148 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2149 * @type: Device Discovery type (enum p2p_discovery_type)
2150 * Returns: 0 on success, -1 on failure
2152 * This function is only used if the driver implements P2P management,
2153 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2154 * struct wpa_driver_capa.
2156 int (*p2p_find)(void *priv, unsigned int timeout, int type);
2159 * p2p_stop_find - Stop P2P Device Discovery
2160 * @priv: Private driver interface data
2161 * Returns: 0 on success, -1 on failure
2163 * This function is only used if the driver implements P2P management,
2164 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2165 * struct wpa_driver_capa.
2167 int (*p2p_stop_find)(void *priv);
2170 * p2p_listen - Start P2P Listen state for specified duration
2171 * @priv: Private driver interface data
2172 * @timeout: Listen state duration in milliseconds
2173 * Returns: 0 on success, -1 on failure
2175 * This function can be used to request the P2P module to keep the
2176 * device discoverable on the listen channel for an extended set of
2177 * time. At least in its current form, this is mainly used for testing
2178 * purposes and may not be of much use for normal P2P operations.
2180 * This function is only used if the driver implements P2P management,
2181 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2182 * struct wpa_driver_capa.
2184 int (*p2p_listen)(void *priv, unsigned int timeout);
2187 * p2p_connect - Start P2P group formation (GO negotiation)
2188 * @priv: Private driver interface data
2189 * @peer_addr: MAC address of the peer P2P client
2190 * @wps_method: enum p2p_wps_method value indicating config method
2191 * @go_intent: Local GO intent value (1..15)
2192 * @own_interface_addr: Intended interface address to use with the
2194 * @force_freq: The only allowed channel frequency in MHz or 0
2195 * @persistent_group: Whether to create persistent group
2196 * Returns: 0 on success, -1 on failure
2198 * This function is only used if the driver implements P2P management,
2199 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2200 * struct wpa_driver_capa.
2202 int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method,
2203 int go_intent, const u8 *own_interface_addr,
2204 unsigned int force_freq, int persistent_group);
2207 * wps_success_cb - Report successfully completed WPS provisioning
2208 * @priv: Private driver interface data
2209 * @peer_addr: Peer address
2210 * Returns: 0 on success, -1 on failure
2212 * This function is used to report successfully completed WPS
2213 * provisioning during group formation in both GO/Registrar and
2214 * client/Enrollee roles.
2216 * This function is only used if the driver implements P2P management,
2217 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2218 * struct wpa_driver_capa.
2220 int (*wps_success_cb)(void *priv, const u8 *peer_addr);
2223 * p2p_group_formation_failed - Report failed WPS provisioning
2224 * @priv: Private driver interface data
2225 * Returns: 0 on success, -1 on failure
2227 * This function is used to report failed group formation. This can
2228 * happen either due to failed WPS provisioning or due to 15 second
2229 * timeout during the provisioning phase.
2231 * This function is only used if the driver implements P2P management,
2232 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2233 * struct wpa_driver_capa.
2235 int (*p2p_group_formation_failed)(void *priv);
2238 * p2p_set_params - Set P2P parameters
2239 * @priv: Private driver interface data
2240 * @params: P2P parameters
2241 * Returns: 0 on success, -1 on failure
2243 * This function is only used if the driver implements P2P management,
2244 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2245 * struct wpa_driver_capa.
2247 int (*p2p_set_params)(void *priv, const struct p2p_params *params);
2250 * p2p_prov_disc_req - Send Provision Discovery Request
2251 * @priv: Private driver interface data
2252 * @peer_addr: MAC address of the peer P2P client
2253 * @config_methods: WPS Config Methods value (only one bit set)
2254 * Returns: 0 on success, -1 on failure
2256 * This function can be used to request a discovered P2P peer to
2257 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2258 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2259 * Provision Discovery Request frame is transmitted once immediately
2260 * and if no response is received, the frame will be sent again
2261 * whenever the target device is discovered during device dsicovery
2262 * (start with a p2p_find() call). Response from the peer is indicated
2263 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
2265 * This function is only used if the driver implements P2P management,
2266 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2267 * struct wpa_driver_capa.
2269 int (*p2p_prov_disc_req)(void *priv, const u8 *peer_addr,
2270 u16 config_methods, int join);
2273 * p2p_sd_request - Schedule a service discovery query
2274 * @priv: Private driver interface data
2275 * @dst: Destination peer or %NULL to apply for all peers
2276 * @tlvs: P2P Service Query TLV(s)
2277 * Returns: Reference to the query or 0 on failure
2279 * Response to the query is indicated with the
2280 * EVENT_P2P_SD_RESPONSE driver event.
2282 * This function is only used if the driver implements P2P management,
2283 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2284 * struct wpa_driver_capa.
2286 u64 (*p2p_sd_request)(void *priv, const u8 *dst,
2287 const struct wpabuf *tlvs);
2290 * p2p_sd_cancel_request - Cancel a pending service discovery query
2291 * @priv: Private driver interface data
2292 * @req: Query reference from p2p_sd_request()
2293 * Returns: 0 on success, -1 on failure
2295 * This function is only used if the driver implements P2P management,
2296 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2297 * struct wpa_driver_capa.
2299 int (*p2p_sd_cancel_request)(void *priv, u64 req);
2302 * p2p_sd_response - Send response to a service discovery query
2303 * @priv: Private driver interface data
2304 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2305 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2306 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2307 * @resp_tlvs: P2P Service Response TLV(s)
2308 * Returns: 0 on success, -1 on failure
2310 * This function is called as a response to the request indicated with
2311 * the EVENT_P2P_SD_REQUEST driver event.
2313 * This function is only used if the driver implements P2P management,
2314 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2315 * struct wpa_driver_capa.
2317 int (*p2p_sd_response)(void *priv, int freq, const u8 *dst,
2319 const struct wpabuf *resp_tlvs);
2322 * p2p_service_update - Indicate a change in local services
2323 * @priv: Private driver interface data
2324 * Returns: 0 on success, -1 on failure
2326 * This function needs to be called whenever there is a change in
2327 * availability of the local services. This will increment the
2328 * Service Update Indicator value which will be used in SD Request and
2331 * This function is only used if the driver implements P2P management,
2332 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2333 * struct wpa_driver_capa.
2335 int (*p2p_service_update)(void *priv);
2338 * p2p_reject - Reject peer device (explicitly block connections)
2339 * @priv: Private driver interface data
2340 * @addr: MAC address of the peer
2341 * Returns: 0 on success, -1 on failure
2343 int (*p2p_reject)(void *priv, const u8 *addr);
2346 * p2p_invite - Invite a P2P Device into a group
2347 * @priv: Private driver interface data
2348 * @peer: Device Address of the peer P2P Device
2349 * @role: Local role in the group
2350 * @bssid: Group BSSID or %NULL if not known
2352 * @ssid_len: Length of ssid in octets
2353 * @go_dev_addr: Forced GO Device Address or %NULL if none
2354 * @persistent_group: Whether this is to reinvoke a persistent group
2355 * Returns: 0 on success, -1 on failure
2357 int (*p2p_invite)(void *priv, const u8 *peer, int role,
2358 const u8 *bssid, const u8 *ssid, size_t ssid_len,
2359 const u8 *go_dev_addr, int persistent_group);
2362 * send_tdls_mgmt - for sending TDLS management packets
2363 * @priv: private driver interface data
2364 * @dst: Destination (peer) MAC address
2365 * @action_code: TDLS action code for the mssage
2366 * @dialog_token: Dialog Token to use in the message (if needed)
2367 * @status_code: Status Code or Reason Code to use (if needed)
2368 * @buf: TDLS IEs to add to the message
2369 * @len: Length of buf in octets
2370 * Returns: 0 on success, negative (<0) on failure
2372 * This optional function can be used to send packet to driver which is
2373 * responsible for receiving and sending all TDLS packets.
2375 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2376 u8 dialog_token, u16 status_code,
2377 const u8 *buf, size_t len);
2380 * tdls_oper - Ask the driver to perform high-level TDLS operations
2381 * @priv: Private driver interface data
2382 * @oper: TDLS high-level operation. See %enum tdls_oper
2383 * @peer: Destination (peer) MAC address
2384 * Returns: 0 on success, negative (<0) on failure
2386 * This optional function can be used to send high-level TDLS commands
2389 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2392 * signal_poll - Get current connection information
2393 * @priv: Private driver interface data
2394 * @signal_info: Connection info structure
2396 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2399 * set_authmode - Set authentication algorithm(s) for static WEP
2400 * @priv: Private driver interface data
2401 * @authmode: 1=Open System, 2=Shared Key, 3=both
2402 * Returns: 0 on success, -1 on failure
2404 * This function can be used to set authentication algorithms for AP
2405 * mode when static WEP is used. If the driver uses user space MLME/SME
2406 * implementation, there is no need to implement this function.
2408 * DEPRECATED - use set_ap() instead
2410 int (*set_authmode)(void *priv, int authmode);
2413 * set_rekey_info - Set rekey information
2414 * @priv: Private driver interface data
2417 * @replay_ctr: Current EAPOL-Key Replay Counter
2419 * This optional function can be used to provide information for the
2420 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2421 * while the host (including wpa_supplicant) is sleeping.
2423 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2424 const u8 *replay_ctr);
2427 * sta_assoc - Station association indication
2428 * @priv: Private driver interface data
2429 * @own_addr: Source address and BSSID for association frame
2430 * @addr: MAC address of the station to associate
2431 * @reassoc: flag to indicate re-association
2432 * @status: association response status code
2433 * @ie: assoc response ie buffer
2434 * @len: ie buffer length
2435 * Returns: 0 on success, -1 on failure
2437 * This function indicates the driver to send (Re)Association
2438 * Response frame to the station.
2440 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2441 int reassoc, u16 status, const u8 *ie, size_t len);
2444 * sta_auth - Station authentication indication
2445 * @priv: Private driver interface data
2446 * @own_addr: Source address and BSSID for authentication frame
2447 * @addr: MAC address of the station to associate
2448 * @seq: authentication sequence number
2449 * @status: authentication response status code
2450 * @ie: authentication frame ie buffer
2451 * @len: ie buffer length
2453 * This function indicates the driver to send Authentication frame
2456 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2457 u16 seq, u16 status, const u8 *ie, size_t len);
2460 * add_tspec - Add traffic stream
2461 * @priv: Private driver interface data
2462 * @addr: MAC address of the station to associate
2463 * @tspec_ie: tspec ie buffer
2464 * @tspec_ielen: tspec ie length
2465 * Returns: 0 on success, -1 on failure
2467 * This function adds the traffic steam for the station
2468 * and fills the medium_time in tspec_ie.
2470 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2471 size_t tspec_ielen);
2474 * add_sta_node - Add a station node in the driver
2475 * @priv: Private driver interface data
2476 * @addr: MAC address of the station to add
2477 * @auth_alg: authentication algorithm used by the station
2478 * Returns: 0 on success, -1 on failure
2480 * This function adds the station node in the driver, when
2481 * the station gets added by FT-over-DS.
2483 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2486 * sched_scan - Request the driver to initiate scheduled scan
2487 * @priv: Private driver interface data
2488 * @params: Scan parameters
2489 * @interval: Interval between scan cycles in milliseconds
2490 * Returns: 0 on success, -1 on failure
2492 * This operation should be used for scheduled scan offload to
2493 * the hardware. Every time scan results are available, the
2494 * driver should report scan results event for wpa_supplicant
2495 * which will eventually request the results with
2496 * wpa_driver_get_scan_results2(). This operation is optional
2497 * and if not provided or if it returns -1, we fall back to
2498 * normal host-scheduled scans.
2500 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2504 * stop_sched_scan - Request the driver to stop a scheduled scan
2505 * @priv: Private driver interface data
2506 * Returns: 0 on success, -1 on failure
2508 * This should cause the scheduled scan to be stopped and
2509 * results should stop being sent. Must be supported if
2510 * sched_scan is supported.
2512 int (*stop_sched_scan)(void *priv);
2515 * poll_client - Probe (null data or such) the given station
2516 * @priv: Private driver interface data
2517 * @own_addr: MAC address of sending interface
2518 * @addr: MAC address of the station to probe
2519 * @qos: Indicates whether station is QoS station
2521 * This function is used to verify whether an associated station is
2522 * still present. This function does not need to be implemented if the
2523 * driver provides such inactivity polling mechanism.
2525 void (*poll_client)(void *priv, const u8 *own_addr,
2526 const u8 *addr, int qos);
2529 * radio_disable - Disable/enable radio
2530 * @priv: Private driver interface data
2531 * @disabled: 1=disable 0=enable radio
2532 * Returns: 0 on success, -1 on failure
2534 * This optional command is for testing purposes. It can be used to
2535 * disable the radio on a testbed device to simulate out-of-radio-range
2538 int (*radio_disable)(void *priv, int disabled);
2541 * switch_channel - Announce channel switch and migrate the GO to the
2543 * @priv: Private driver interface data
2544 * @freq: Frequency in MHz
2545 * Returns: 0 on success, -1 on failure
2547 * This function is used to move the GO to the legacy STA channel to
2548 * avoid frequency conflict in single channel concurrency.
2550 int (*switch_channel)(void *priv, unsigned int freq);
2555 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2557 enum wpa_event_type {
2559 * EVENT_ASSOC - Association completed
2561 * This event needs to be delivered when the driver completes IEEE
2562 * 802.11 association or reassociation successfully.
2563 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2564 * after this event has been generated. In addition, optional
2565 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2566 * more information about the association. If the driver interface gets
2567 * both of these events at the same time, it can also include the
2568 * assoc_info data in EVENT_ASSOC call.
2573 * EVENT_DISASSOC - Association lost
2575 * This event should be called when association is lost either due to
2576 * receiving deauthenticate or disassociate frame from the AP or when
2577 * sending either of these frames to the current AP. If the driver
2578 * supports separate deauthentication event, EVENT_DISASSOC should only
2579 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2580 * In AP mode, union wpa_event_data::disassoc_info is required.
2585 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2587 * This event must be delivered when a Michael MIC error is detected by
2588 * the local driver. Additional data for event processing is
2589 * provided with union wpa_event_data::michael_mic_failure. This
2590 * information is used to request new encyption key and to initiate
2591 * TKIP countermeasures if needed.
2593 EVENT_MICHAEL_MIC_FAILURE,
2596 * EVENT_SCAN_RESULTS - Scan results available
2598 * This event must be called whenever scan results are available to be
2599 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2600 * is expected to be used some time after struct wpa_driver_ops::scan()
2601 * is called. If the driver provides an unsolicited event when the scan
2602 * has been completed, this event can be used to trigger
2603 * EVENT_SCAN_RESULTS call. If such event is not available from the
2604 * driver, the driver wrapper code is expected to use a registered
2605 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2606 * scan is expected to be completed. Optional information about
2607 * completed scan can be provided with union wpa_event_data::scan_info.
2612 * EVENT_ASSOCINFO - Report optional extra information for association
2614 * This event can be used to report extra association information for
2615 * EVENT_ASSOC processing. This extra information includes IEs from
2616 * association frames and Beacon/Probe Response frames in union
2617 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2618 * EVENT_ASSOC. Alternatively, the driver interface can include
2619 * assoc_info data in the EVENT_ASSOC call if it has all the
2620 * information available at the same point.
2625 * EVENT_INTERFACE_STATUS - Report interface status changes
2627 * This optional event can be used to report changes in interface
2628 * status (interface added/removed) using union
2629 * wpa_event_data::interface_status. This can be used to trigger
2630 * wpa_supplicant to stop and re-start processing for the interface,
2631 * e.g., when a cardbus card is ejected/inserted.
2633 EVENT_INTERFACE_STATUS,
2636 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2638 * This event can be used to inform wpa_supplicant about candidates for
2639 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2640 * for scan request (ap_scan=2 mode), this event is required for
2641 * pre-authentication. If wpa_supplicant is performing scan request
2642 * (ap_scan=1), this event is optional since scan results can be used
2643 * to add pre-authentication candidates. union
2644 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2645 * candidate and priority of the candidate, e.g., based on the signal
2646 * strength, in order to try to pre-authenticate first with candidates
2647 * that are most likely targets for re-association.
2649 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2650 * on the candidate list. In addition, it can be called for the current
2651 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2652 * will automatically skip pre-authentication in cases where a valid
2653 * PMKSA exists. When more than one candidate exists, this event should
2654 * be generated once for each candidate.
2656 * Driver will be notified about successful pre-authentication with
2657 * struct wpa_driver_ops::add_pmkid() calls.
2659 EVENT_PMKID_CANDIDATE,
2662 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2664 * This event can be used to inform wpa_supplicant about desire to set
2665 * up secure direct link connection between two stations as defined in
2666 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2667 * STAKey negotiation. The caller will need to set peer address for the
2673 * EVENT_TDLS - Request TDLS operation
2675 * This event can be used to request a TDLS operation to be performed.
2680 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2682 * The driver is expected to report the received FT IEs from
2683 * FT authentication sequence from the AP. The FT IEs are included in
2684 * the extra information in union wpa_event_data::ft_ies.
2689 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2691 * The driver can use this event to inform wpa_supplicant about a STA
2692 * in an IBSS with which protected frames could be exchanged. This
2693 * event starts RSN authentication with the other STA to authenticate
2694 * the STA and set up encryption keys with it.
2696 EVENT_IBSS_RSN_START,
2699 * EVENT_AUTH - Authentication result
2701 * This event should be called when authentication attempt has been
2702 * completed. This is only used if the driver supports separate
2703 * authentication step (struct wpa_driver_ops::authenticate).
2704 * Information about authentication result is included in
2705 * union wpa_event_data::auth.
2710 * EVENT_DEAUTH - Authentication lost
2712 * This event should be called when authentication is lost either due
2713 * to receiving deauthenticate frame from the AP or when sending that
2714 * frame to the current AP.
2715 * In AP mode, union wpa_event_data::deauth_info is required.
2720 * EVENT_ASSOC_REJECT - Association rejected
2722 * This event should be called when (re)association attempt has been
2723 * rejected by the AP. Information about the association response is
2724 * included in union wpa_event_data::assoc_reject.
2729 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2731 EVENT_AUTH_TIMED_OUT,
2734 * EVENT_ASSOC_TIMED_OUT - Association timed out
2736 EVENT_ASSOC_TIMED_OUT,
2739 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2744 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2746 EVENT_WPS_BUTTON_PUSHED,
2749 * EVENT_TX_STATUS - Report TX status
2754 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2756 EVENT_RX_FROM_UNKNOWN,
2759 * EVENT_RX_MGMT - Report RX of a management frame
2764 * EVENT_RX_ACTION - Action frame received
2766 * This event is used to indicate when an Action frame has been
2767 * received. Information about the received frame is included in
2768 * union wpa_event_data::rx_action.
2773 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2775 * This event is used to indicate when the driver has started the
2776 * requested remain-on-channel duration. Information about the
2777 * operation is included in union wpa_event_data::remain_on_channel.
2779 EVENT_REMAIN_ON_CHANNEL,
2782 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2784 * This event is used to indicate when the driver has completed
2785 * remain-on-channel duration, i.e., may noot be available on the
2786 * requested channel anymore. Information about the
2787 * operation is included in union wpa_event_data::remain_on_channel.
2789 EVENT_CANCEL_REMAIN_ON_CHANNEL,
2792 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2794 * This event is used only by driver_test.c and userspace MLME.
2799 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2801 * This event is used to indicate when a Probe Request frame has been
2802 * received. Information about the received frame is included in
2803 * union wpa_event_data::rx_probe_req. The driver is required to report
2804 * these events only after successfully completed probe_req_report()
2805 * commands to request the events (i.e., report parameter is non-zero)
2806 * in station mode. In AP mode, Probe Request frames should always be
2812 * EVENT_NEW_STA - New wired device noticed
2814 * This event is used to indicate that a new device has been detected
2815 * in a network that does not use association-like functionality (i.e.,
2816 * mainly wired Ethernet). This can be used to start EAPOL
2817 * authenticator when receiving a frame from a device. The address of
2818 * the device is included in union wpa_event_data::new_sta.
2823 * EVENT_EAPOL_RX - Report received EAPOL frame
2825 * When in AP mode with hostapd, this event is required to be used to
2826 * deliver the receive EAPOL frames from the driver. With
2827 * %wpa_supplicant, this event is used only if the send_eapol() handler
2828 * is used to override the use of l2_packet for EAPOL frame TX.
2833 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
2835 * This event is used to indicate changes in the signal strength
2836 * observed in frames received from the current AP if signal strength
2837 * monitoring has been enabled with signal_monitor().
2839 EVENT_SIGNAL_CHANGE,
2842 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
2844 * This event is used to indicate that the interface was enabled after
2845 * having been previously disabled, e.g., due to rfkill.
2847 EVENT_INTERFACE_ENABLED,
2850 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
2852 * This event is used to indicate that the interface was disabled,
2853 * e.g., due to rfkill.
2855 EVENT_INTERFACE_DISABLED,
2858 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
2860 * This event is used to indicate that the channel list has changed,
2861 * e.g., because of a regulatory domain change triggered by scan
2862 * results including an AP advertising a country code.
2864 EVENT_CHANNEL_LIST_CHANGED,
2867 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
2869 * This event is used to indicate that the driver cannot maintain this
2870 * interface in its operation mode anymore. The most likely use for
2871 * this is to indicate that AP mode operation is not available due to
2872 * operating channel would need to be changed to a DFS channel when
2873 * the driver does not support radar detection and another virtual
2874 * interfaces caused the operating channel to change. Other similar
2875 * resource conflicts could also trigger this for station mode
2878 EVENT_INTERFACE_UNAVAILABLE,
2881 * EVENT_BEST_CHANNEL
2883 * Driver generates this event whenever it detects a better channel
2884 * (e.g., based on RSSI or channel use). This information can be used
2885 * to improve channel selection for a new AP/P2P group.
2890 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
2892 * This event should be called when a Deauthentication frame is dropped
2893 * due to it not being protected (MFP/IEEE 802.11w).
2894 * union wpa_event_data::unprot_deauth is required to provide more
2895 * details of the frame.
2897 EVENT_UNPROT_DEAUTH,
2900 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
2902 * This event should be called when a Disassociation frame is dropped
2903 * due to it not being protected (MFP/IEEE 802.11w).
2904 * union wpa_event_data::unprot_disassoc is required to provide more
2905 * details of the frame.
2907 EVENT_UNPROT_DISASSOC,
2910 * EVENT_STATION_LOW_ACK
2912 * Driver generates this event whenever it detected that a particular
2913 * station was lost. Detection can be through massive transmission
2914 * failures for example.
2916 EVENT_STATION_LOW_ACK,
2919 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
2921 * This event is used only if the driver implements P2P management
2922 * internally. Event data is stored in
2923 * union wpa_event_data::p2p_dev_found.
2925 EVENT_P2P_DEV_FOUND,
2928 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
2930 * This event is used only if the driver implements P2P management
2931 * internally. Event data is stored in
2932 * union wpa_event_data::p2p_go_neg_req_rx.
2934 EVENT_P2P_GO_NEG_REQ_RX,
2937 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
2939 * This event is used only if the driver implements P2P management
2940 * internally. Event data is stored in
2941 * union wpa_event_data::p2p_go_neg_completed.
2943 EVENT_P2P_GO_NEG_COMPLETED,
2945 EVENT_P2P_PROV_DISC_REQUEST,
2946 EVENT_P2P_PROV_DISC_RESPONSE,
2947 EVENT_P2P_SD_REQUEST,
2948 EVENT_P2P_SD_RESPONSE,
2951 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
2953 EVENT_IBSS_PEER_LOST,
2956 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
2958 * This event carries the new replay counter to notify wpa_supplicant
2959 * of the current EAPOL-Key Replay Counter in case the driver/firmware
2960 * completed Group Key Handshake while the host (including
2961 * wpa_supplicant was sleeping).
2963 EVENT_DRIVER_GTK_REKEY,
2966 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
2968 EVENT_SCHED_SCAN_STOPPED,
2971 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
2973 * This event indicates that the station responded to the poll
2974 * initiated with @poll_client.
2976 EVENT_DRIVER_CLIENT_POLL_OK,
2979 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
2981 EVENT_EAPOL_TX_STATUS
2986 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
2988 union wpa_event_data {
2990 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
2992 * This structure is optional for EVENT_ASSOC calls and required for
2993 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
2994 * driver interface does not need to generate separate EVENT_ASSOCINFO
2999 * reassoc - Flag to indicate association or reassociation
3004 * req_ies - (Re)Association Request IEs
3006 * If the driver generates WPA/RSN IE, this event data must be
3007 * returned for WPA handshake to have needed information. If
3008 * wpa_supplicant-generated WPA/RSN IE is used, this
3009 * information event is optional.
3011 * This should start with the first IE (fixed fields before IEs
3012 * are not included).
3017 * req_ies_len - Length of req_ies in bytes
3022 * resp_ies - (Re)Association Response IEs
3024 * Optional association data from the driver. This data is not
3025 * required WPA, but may be useful for some protocols and as
3026 * such, should be reported if this is available to the driver
3029 * This should start with the first IE (fixed fields before IEs
3030 * are not included).
3035 * resp_ies_len - Length of resp_ies in bytes
3037 size_t resp_ies_len;
3040 * beacon_ies - Beacon or Probe Response IEs
3042 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3043 * Probe Response frames from the current AP (i.e., the one
3044 * that the client just associated with). This information is
3045 * used to update WPA/RSN IE for the AP. If this field is not
3046 * set, the results from previous scan will be used. If no
3047 * data for the new AP is found, scan results will be requested
3048 * again (without scan request). At this point, the driver is
3049 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3052 * This should start with the first IE (fixed fields before IEs
3053 * are not included).
3055 const u8 *beacon_ies;
3058 * beacon_ies_len - Length of beacon_ies */
3059 size_t beacon_ies_len;
3062 * freq - Frequency of the operational channel in MHz
3067 * addr - Station address (for AP mode)
3073 * struct disassoc_info - Data for EVENT_DISASSOC events
3075 struct disassoc_info {
3077 * addr - Station address (for AP mode)
3082 * reason_code - Reason Code (host byte order) used in
3083 * Deauthentication frame
3088 * ie - Optional IE(s) in Disassociation frame
3093 * ie_len - Length of ie buffer in octets
3098 * locally_generated - Whether the frame was locally generated
3100 int locally_generated;
3104 * struct deauth_info - Data for EVENT_DEAUTH events
3106 struct deauth_info {
3108 * addr - Station address (for AP mode)
3113 * reason_code - Reason Code (host byte order) used in
3114 * Deauthentication frame
3119 * ie - Optional IE(s) in Deauthentication frame
3124 * ie_len - Length of ie buffer in octets
3129 * locally_generated - Whether the frame was locally generated
3131 int locally_generated;
3135 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3137 struct michael_mic_failure {
3140 } michael_mic_failure;
3143 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3145 struct interface_status {
3148 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3153 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3155 struct pmkid_candidate {
3156 /** BSSID of the PMKID candidate */
3158 /** Smaller the index, higher the priority */
3160 /** Whether RSN IE includes pre-authenticate flag */
3165 * struct stkstart - Data for EVENT_STKSTART
3172 * struct tdls - Data for EVENT_TDLS
3178 TDLS_REQUEST_TEARDOWN
3180 u16 reason_code; /* for teardown */
3184 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3186 * During FT (IEEE 802.11r) authentication sequence, the driver is
3187 * expected to use this event to report received FT IEs (MDIE, FTIE,
3188 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3189 * IEs for the next message will be delivered through the
3190 * struct wpa_driver_ops::update_ft_ies() callback.
3196 u8 target_ap[ETH_ALEN];
3197 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3199 /** Length of ric_ies buffer in octets */
3204 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3206 struct ibss_rsn_start {
3211 * struct auth_info - Data for EVENT_AUTH events
3217 u16 auth_transaction;
3224 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3226 struct assoc_reject {
3228 * bssid - BSSID of the AP that rejected association
3233 * resp_ies - (Re)Association Response IEs
3235 * Optional association data from the driver. This data is not
3236 * required WPA, but may be useful for some protocols and as
3237 * such, should be reported if this is available to the driver
3240 * This should start with the first IE (fixed fields before IEs
3241 * are not included).
3246 * resp_ies_len - Length of resp_ies in bytes
3248 size_t resp_ies_len;
3251 * status_code - Status Code from (Re)association Response
3256 struct timeout_event {
3261 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3270 * struct tx_status - Data for EVENT_TX_STATUS events
3282 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3284 struct rx_from_unknown {
3291 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3297 int ssi_signal; /* dBm */
3301 * struct rx_action - Data for EVENT_RX_ACTION events
3305 * da - Destination address of the received Action frame
3310 * sa - Source address of the received Action frame
3315 * bssid - Address 3 of the received Action frame
3320 * category - Action frame category
3325 * data - Action frame body after category field
3330 * len - Length of data in octets
3335 * freq - Frequency (in MHz) on which the frame was received
3341 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3343 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3345 struct remain_on_channel {
3347 * freq - Channel frequency in MHz
3352 * duration - Duration to remain on the channel in milliseconds
3354 unsigned int duration;
3355 } remain_on_channel;
3358 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3359 * @aborted: Whether the scan was aborted
3360 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3361 * @num_freqs: Number of entries in freqs array
3362 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3364 * @num_ssids: Number of entries in ssids array
3370 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3375 * struct mlme_rx - Data for EVENT_MLME_RX events
3386 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3388 struct rx_probe_req {
3390 * sa - Source address of the received Probe Request frame
3395 * da - Destination address of the received Probe Request frame
3396 * or %NULL if not available
3401 * bssid - BSSID of the received Probe Request frame or %NULL
3407 * ie - IEs from the Probe Request body
3412 * ie_len - Length of ie buffer in octets
3417 * signal - signal strength in dBm (or 0 if not available)
3423 * struct new_sta - Data for EVENT_NEW_STA events
3430 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3439 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3441 struct wpa_signal_info signal_change;
3444 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3445 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3446 * @freq_5: Best 5 GHz band channel frequency in MHz
3447 * @freq_overall: Best channel frequency in MHz
3449 * 0 can be used to indicate no preference in either band.
3451 struct best_channel {
3457 struct unprot_deauth {
3463 struct unprot_disassoc {
3470 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3471 * @addr: station address
3478 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3480 struct p2p_dev_found {
3483 const u8 *pri_dev_type;
3484 const char *dev_name;
3491 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3493 struct p2p_go_neg_req_rx {
3496 } p2p_go_neg_req_rx;
3499 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3501 struct p2p_go_neg_completed {
3502 struct p2p_go_neg_results *res;
3503 } p2p_go_neg_completed;
3505 struct p2p_prov_disc_req {
3509 const u8 *pri_dev_type;
3510 const char *dev_name;
3511 u16 supp_config_methods;
3514 } p2p_prov_disc_req;
3516 struct p2p_prov_disc_resp {
3519 } p2p_prov_disc_resp;
3530 struct p2p_sd_resp {
3538 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3540 struct ibss_peer_lost {
3545 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3547 struct driver_gtk_rekey {
3549 const u8 *replay_ctr;
3553 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
3554 * @addr: station address
3556 struct client_poll {
3561 * struct eapol_tx_status
3562 * @dst: Original destination
3563 * @data: Data starting with IEEE 802.1X header (!)
3564 * @data_len: Length of data
3565 * @ack: Indicates ack or lost frame
3567 * This corresponds to hapd_send_eapol if the frame sent
3568 * there isn't just reported as EVENT_TX_STATUS.
3570 struct eapol_tx_status {
3579 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3580 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3581 * with struct wpa_driver_ops::init()
3582 * @event: event type (defined above)
3583 * @data: possible extra data for the event
3585 * Driver wrapper code should call this function whenever an event is received
3588 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
3589 union wpa_event_data *data);
3593 * The following inline functions are provided for convenience to simplify
3594 * event indication for some of the common events.
3597 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
3598 size_t ielen, int reassoc)
3600 union wpa_event_data event;
3601 os_memset(&event, 0, sizeof(event));
3602 event.assoc_info.reassoc = reassoc;
3603 event.assoc_info.req_ies = ie;
3604 event.assoc_info.req_ies_len = ielen;
3605 event.assoc_info.addr = addr;
3606 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
3609 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
3611 union wpa_event_data event;
3612 os_memset(&event, 0, sizeof(event));
3613 event.disassoc_info.addr = addr;
3614 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
3617 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
3620 union wpa_event_data event;
3621 os_memset(&event, 0, sizeof(event));
3622 event.eapol_rx.src = src;
3623 event.eapol_rx.data = data;
3624 event.eapol_rx.data_len = data_len;
3625 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
3628 /* driver_common.c */
3629 void wpa_scan_results_free(struct wpa_scan_results *res);
3631 /* Convert wpa_event_type to a string for logging */
3632 const char * event_to_string(enum wpa_event_type event);
3634 #endif /* DRIVER_H */