2 * Driver interface definition
3 * Copyright (c) 2003-2010, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
14 * This file defines a driver interface used by both %wpa_supplicant and
15 * hostapd. The first part of the file defines data structures used in various
16 * driver operations. This is followed by the struct wpa_driver_ops that each
17 * driver wrapper will beed to define with callback functions for requesting
18 * driver operations. After this, there are definitions for driver event
19 * reporting with wpa_supplicant_event() and some convenience helper functions
20 * that can be used to report events.
26 #define WPA_SUPPLICANT_DRIVER_VERSION 4
28 #include "common/defs.h"
30 #define HOSTAPD_CHAN_DISABLED 0x00000001
31 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
32 #define HOSTAPD_CHAN_NO_IBSS 0x00000004
33 #define HOSTAPD_CHAN_RADAR 0x00000008
34 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
35 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
36 #define HOSTAPD_CHAN_HT40 0x00000040
39 * struct hostapd_channel_data - Channel information
41 struct hostapd_channel_data {
43 * chan - Channel number (IEEE 802.11)
48 * freq - Frequency in MHz
53 * flag - Channel flags (HOSTAPD_CHAN_*)
58 * max_tx_power - maximum transmit power in dBm
63 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
66 * struct hostapd_hw_modes - Supported hardware mode information
68 struct hostapd_hw_modes {
70 * mode - Hardware mode
72 enum hostapd_hw_mode mode;
75 * num_channels - Number of entries in the channels array
80 * channels - Array of supported channels
82 struct hostapd_channel_data *channels;
85 * num_rates - Number of entries in the rates array
90 * rates - Array of supported rates in 100 kbps units
95 * ht_capab - HT (IEEE 802.11n) capabilities
100 * mcs_set - MCS (IEEE 802.11n) rate parameters
105 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
109 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
113 #define IEEE80211_MODE_INFRA 0
114 #define IEEE80211_MODE_IBSS 1
115 #define IEEE80211_MODE_AP 2
117 #define IEEE80211_CAP_ESS 0x0001
118 #define IEEE80211_CAP_IBSS 0x0002
119 #define IEEE80211_CAP_PRIVACY 0x0010
121 #define WPA_SCAN_QUAL_INVALID BIT(0)
122 #define WPA_SCAN_NOISE_INVALID BIT(1)
123 #define WPA_SCAN_LEVEL_INVALID BIT(2)
124 #define WPA_SCAN_LEVEL_DBM BIT(3)
125 #define WPA_SCAN_AUTHENTICATED BIT(4)
126 #define WPA_SCAN_ASSOCIATED BIT(5)
129 * struct wpa_scan_res - Scan result for an BSS/IBSS
130 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
132 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
133 * @beacon_int: beacon interval in TUs (host byte order)
134 * @caps: capability information field in host byte order
135 * @qual: signal quality
136 * @noise: noise level
137 * @level: signal level
139 * @age: Age of the information in milliseconds (i.e., how many milliseconds
140 * ago the last Beacon or Probe Response frame was received)
141 * @ie_len: length of the following IE field in octets
142 * @beacon_ie_len: length of the following Beacon IE field in octets
144 * This structure is used as a generic format for scan results from the
145 * driver. Each driver interface implementation is responsible for converting
146 * the driver or OS specific scan results into this format.
148 * If the driver does not support reporting all IEs, the IE data structure is
149 * constructed of the IEs that are available. This field will also need to
150 * include SSID in IE format. All drivers are encouraged to be extended to
151 * report all IEs to make it easier to support future additions.
153 struct wpa_scan_res {
165 size_t beacon_ie_len;
167 * Followed by ie_len octets of IEs from Probe Response frame (or if
168 * the driver does not indicate source of IEs, these may also be from
169 * Beacon frame). After the first set of IEs, another set of IEs may
170 * follow (with beacon_ie_len octets of data) if the driver provides
176 * struct wpa_scan_results - Scan results
177 * @res: Array of pointers to allocated variable length scan result entries
178 * @num: Number of entries in the scan result array
180 struct wpa_scan_results {
181 struct wpa_scan_res **res;
186 * struct wpa_interface_info - Network interface information
187 * @next: Pointer to the next interface or NULL if this is the last one
188 * @ifname: Interface name that can be used with init() or init2()
189 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
191 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
192 * is not an allocated copy, i.e., get_interfaces() caller will not free
195 struct wpa_interface_info {
196 struct wpa_interface_info *next;
199 const char *drv_name;
202 #define WPAS_MAX_SCAN_SSIDS 16
205 * struct wpa_driver_scan_params - Scan parameters
206 * Data for struct wpa_driver_ops::scan2().
208 struct wpa_driver_scan_params {
210 * ssids - SSIDs to scan for
212 struct wpa_driver_scan_ssid {
214 * ssid - specific SSID to scan for (ProbeReq)
215 * %NULL or zero-length SSID is used to indicate active scan
216 * with wildcard SSID.
220 * ssid_len: Length of the SSID in octets
223 } ssids[WPAS_MAX_SCAN_SSIDS];
226 * num_ssids - Number of entries in ssids array
227 * Zero indicates a request for a passive scan.
232 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
237 * extra_ies_len - Length of extra_ies in octets
239 size_t extra_ies_len;
242 * freqs - Array of frequencies to scan or %NULL for all frequencies
244 * The frequency is set in MHz. The array is zero-terminated.
249 * filter_ssids - Filter for reporting SSIDs
251 * This optional parameter can be used to request the driver wrapper to
252 * filter scan results to include only the specified SSIDs. %NULL
253 * indicates that no filtering is to be done. This can be used to
254 * reduce memory needs for scan results in environments that have large
255 * number of APs with different SSIDs.
257 * The driver wrapper is allowed to take this allocated buffer into its
258 * own use by setting the pointer to %NULL. In that case, the driver
259 * wrapper is responsible for freeing the buffer with os_free() once it
260 * is not needed anymore.
262 struct wpa_driver_scan_filter {
268 * num_filter_ssids - Number of entries in filter_ssids array
270 size_t num_filter_ssids;
273 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
275 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
276 * Mbps from the support rates element(s) in the Probe Request frames
277 * and not to transmit the frames at any of those rates.
283 * struct wpa_driver_auth_params - Authentication parameters
284 * Data for struct wpa_driver_ops::authenticate().
286 struct wpa_driver_auth_params {
294 const u8 *wep_key[4];
295 size_t wep_key_len[4];
297 int local_state_change;
300 * p2p - Whether this connection is a P2P group
307 WPS_MODE_NONE /* no WPS provisioning being used */,
308 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
309 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
314 * struct wpa_driver_associate_params - Association parameters
315 * Data for struct wpa_driver_ops::associate().
317 struct wpa_driver_associate_params {
319 * bssid - BSSID of the selected AP
320 * This can be %NULL, if ap_scan=2 mode is used and the driver is
321 * responsible for selecting with which BSS to associate. */
325 * ssid - The selected SSID
330 * ssid_len - Length of the SSID (1..32)
335 * freq - Frequency of the channel the selected AP is using
336 * Frequency that the selected AP is using (in MHz as
337 * reported in the scan results)
342 * wpa_ie - WPA information element for (Re)Association Request
343 * WPA information element to be included in (Re)Association
344 * Request (including information element id and length). Use
345 * of this WPA IE is optional. If the driver generates the WPA
346 * IE, it can use pairwise_suite, group_suite, and
347 * key_mgmt_suite to select proper algorithms. In this case,
348 * the driver has to notify wpa_supplicant about the used WPA
349 * IE by generating an event that the interface code will
350 * convert into EVENT_ASSOCINFO data (see below).
352 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
353 * instead. The driver can determine which version is used by
354 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
357 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
362 * wpa_ie_len - length of the wpa_ie
367 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
369 unsigned int wpa_proto;
372 * pairwise_suite - Selected pairwise cipher suite
374 * This is usually ignored if @wpa_ie is used.
376 enum wpa_cipher pairwise_suite;
379 * group_suite - Selected group cipher suite
381 * This is usually ignored if @wpa_ie is used.
383 enum wpa_cipher group_suite;
386 * key_mgmt_suite - Selected key management suite
388 * This is usually ignored if @wpa_ie is used.
390 enum wpa_key_mgmt key_mgmt_suite;
393 * auth_alg - Allowed authentication algorithms
394 * Bit field of WPA_AUTH_ALG_*
399 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
404 * wep_key - WEP keys for static WEP configuration
406 const u8 *wep_key[4];
409 * wep_key_len - WEP key length for static WEP configuration
411 size_t wep_key_len[4];
414 * wep_tx_keyidx - WEP TX key index for static WEP configuration
419 * mgmt_frame_protection - IEEE 802.11w management frame protection
421 enum mfp_options mgmt_frame_protection;
424 * ft_ies - IEEE 802.11r / FT information elements
425 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
426 * for fast transition, this parameter is set to include the IEs that
427 * are to be sent in the next FT Authentication Request message.
428 * update_ft_ies() handler is called to update the IEs for further
429 * FT messages in the sequence.
431 * The driver should use these IEs only if the target AP is advertising
432 * the same mobility domain as the one included in the MDIE here.
434 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
435 * AP after the initial association. These IEs can only be used if the
436 * target AP is advertising support for FT and is using the same MDIE
437 * and SSID as the current AP.
439 * The driver is responsible for reporting the FT IEs received from the
440 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
441 * type. update_ft_ies() handler will then be called with the FT IEs to
442 * include in the next frame in the authentication sequence.
447 * ft_ies_len - Length of ft_ies in bytes
452 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
454 * This value is provided to allow the driver interface easier access
455 * to the current mobility domain. This value is set to %NULL if no
456 * mobility domain is currently active.
461 * passphrase - RSN passphrase for PSK
463 * This value is made available only for WPA/WPA2-Personal (PSK) and
464 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
465 * the 8..63 character ASCII passphrase, if available. Please note that
466 * this can be %NULL if passphrase was not used to generate the PSK. In
467 * that case, the psk field must be used to fetch the PSK.
469 const char *passphrase;
472 * psk - RSN PSK (alternative for passphrase for PSK)
474 * This value is made available only for WPA/WPA2-Personal (PSK) and
475 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
476 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
477 * be prepared to handle %NULL value as an error.
482 * drop_unencrypted - Enable/disable unencrypted frame filtering
484 * Configure the driver to drop all non-EAPOL frames (both receive and
485 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
486 * still be allowed for key negotiation.
488 int drop_unencrypted;
491 * prev_bssid - Previously used BSSID in this ESS
493 * When not %NULL, this is a request to use reassociation instead of
496 const u8 *prev_bssid;
501 * If the driver needs to do special configuration for WPS association,
502 * this variable provides more information on what type of association
503 * is being requested. Most drivers should not need ot use this.
508 * p2p - Whether this connection is a P2P group
513 * uapsd - UAPSD parameters for the network
514 * -1 = do not change defaults
515 * AP mode: 1 = enabled, 0 = disabled
516 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
523 HIDDEN_SSID_ZERO_LEN,
524 HIDDEN_SSID_ZERO_CONTENTS
527 struct wpa_driver_ap_params {
529 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
534 * head_len - Length of the head buffer in octets
539 * tail - Beacon tail following TIM IE
544 * tail_len - Length of the tail buffer in octets
549 * dtim_period - DTIM period
554 * beacon_int - Beacon interval
559 * ssid - The SSID to use in Beacon/Probe Response frames
564 * ssid_len - Length of the SSID (1..32)
569 * hide_ssid - Whether to hide the SSID
571 enum hide_ssid hide_ssid;
574 * pairwise_ciphers - WPA_CIPHER_* bitfield
576 unsigned int pairwise_ciphers;
579 * group_cipher - WPA_CIPHER_*
581 unsigned int group_cipher;
584 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
586 unsigned int key_mgmt_suites;
589 * auth_algs - WPA_AUTH_ALG_* bitfield
591 unsigned int auth_algs;
594 * wpa_version - WPA_PROTO_* bitfield
596 unsigned int wpa_version;
599 * privacy - Whether privacy is used in the BSS
604 * beacon_ies - WPS/P2P IE(s) for Beacon frames
606 * This is used to add IEs like WPS IE and P2P IE by drivers that do
607 * not use the full Beacon template.
609 const struct wpabuf *beacon_ies;
612 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
614 * This is used to add IEs like WPS IE and P2P IE by drivers that
615 * reply to Probe Request frames internally.
617 const struct wpabuf *proberesp_ies;
620 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
622 * This is used to add IEs like WPS IE by drivers that reply to
623 * (Re)Association Request frames internally.
625 const struct wpabuf *assocresp_ies;
628 * isolate - Whether to isolate frames between associated stations
630 * If this is non-zero, the AP is requested to disable forwarding of
631 * frames between association stations.
636 * cts_protect - Whether CTS protection is enabled
641 * preamble - Whether short preamble is enabled
646 * short_slot_time - Whether short slot time is enabled
648 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
649 * not set (e.g., when 802.11g mode is not in use)
654 * ht_opmode - HT operation mode or -1 if HT not in use
659 * interworking - Whether Interworking is enabled
664 * hessid - Homogeneous ESS identifier or %NULL if not set
669 * access_network_type - Access Network Type (0..15)
671 * This is used for filtering Probe Request frames when Interworking is
674 u8 access_network_type;
678 * struct wpa_driver_capa - Driver capability information
680 struct wpa_driver_capa {
681 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
682 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
683 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
684 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
685 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
686 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
687 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
688 unsigned int key_mgmt;
690 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
691 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
692 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
693 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
696 #define WPA_DRIVER_AUTH_OPEN 0x00000001
697 #define WPA_DRIVER_AUTH_SHARED 0x00000002
698 #define WPA_DRIVER_AUTH_LEAP 0x00000004
701 /* Driver generated WPA/RSN IE */
702 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
703 /* Driver needs static WEP key setup after association command */
704 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
705 /* unused: 0x00000004 */
706 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
707 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
708 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
709 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
710 /* Driver provides separate commands for authentication and association (SME in
711 * wpa_supplicant). */
712 #define WPA_DRIVER_FLAGS_SME 0x00000020
713 /* Driver supports AP mode */
714 #define WPA_DRIVER_FLAGS_AP 0x00000040
715 /* Driver needs static WEP key setup after association has been completed */
716 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
717 /* Driver takes care of P2P management operations */
718 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
719 /* Driver supports concurrent P2P operations */
720 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
722 * Driver uses the initial interface as a dedicated management interface, i.e.,
723 * it cannot be used for P2P group operations or non-P2P purposes.
725 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
726 /* This interface is P2P capable (P2P Device, GO, or P2P Client */
727 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
728 /* Driver supports concurrent operations on multiple channels */
729 #define WPA_DRIVER_FLAGS_MULTI_CHANNEL_CONCURRENT 0x00001000
731 * Driver uses the initial interface for P2P management interface and non-P2P
732 * purposes (e.g., connect to infra AP), but this interface cannot be used for
733 * P2P group operations.
735 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
737 * Driver is known to use sane error codes, i.e., when it indicates that
738 * something (e.g., association) fails, there was indeed a failure and the
739 * operation does not end up getting completed successfully later.
741 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
742 /* Driver supports off-channel TX */
743 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
744 /* Driver indicates TX status events for EAPOL Data frames */
745 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
746 /* Driver indicates TX status events for Deauth/Disassoc frames */
747 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
748 /* Driver supports roaming (BSS selection) in firmware */
749 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
750 /* Driver supports operating as a TDLS peer */
751 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
752 /* Driver requires external TDLS setup/teardown/discovery */
753 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
757 int max_sched_scan_ssids;
758 int sched_scan_supported;
762 * max_remain_on_chan - Maximum remain-on-channel duration in msec
764 unsigned int max_remain_on_chan;
767 * max_stations - Maximum number of associated stations the driver
768 * supports in AP mode
770 unsigned int max_stations;
776 struct hostap_sta_driver_data {
777 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
778 unsigned long current_tx_rate;
779 unsigned long inactive_msec;
781 unsigned long num_ps_buf_frames;
782 unsigned long tx_retry_failed;
783 unsigned long tx_retry_count;
788 struct hostapd_sta_add_params {
792 const u8 *supp_rates;
793 size_t supp_rates_len;
795 const struct ieee80211_ht_capabilities *ht_capabilities;
796 u32 flags; /* bitmask of WPA_STA_* flags */
799 struct hostapd_freq_params {
804 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
805 * secondary channel below primary, 1 = HT40
806 * enabled, secondary channel above primary */
809 enum wpa_driver_if_type {
811 * WPA_IF_STATION - Station mode interface
816 * WPA_IF_AP_VLAN - AP mode VLAN interface
818 * This interface shares its address and Beacon frame with the main
824 * WPA_IF_AP_BSS - AP mode BSS interface
826 * This interface has its own address and Beacon frame.
831 * WPA_IF_P2P_GO - P2P Group Owner
836 * WPA_IF_P2P_CLIENT - P2P Client
841 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
842 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
847 struct wpa_init_params {
853 const char *test_socket;
854 int use_pae_group_addr;
858 u8 *own_addr; /* buffer for writing own MAC address */
862 struct wpa_bss_params {
863 /** Interface name (for multi-SSID/VLAN support) */
865 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
874 enum mfp_options ieee80211w;
877 #define WPA_STA_AUTHORIZED BIT(0)
878 #define WPA_STA_WMM BIT(1)
879 #define WPA_STA_SHORT_PREAMBLE BIT(2)
880 #define WPA_STA_MFP BIT(3)
883 * struct p2p_params - P2P parameters for driver-based P2P management
886 const char *dev_name;
888 #define DRV_MAX_SEC_DEV_TYPES 5
889 u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8];
890 size_t num_sec_dev_types;
904 * struct wpa_signal_info - Information about channel signal quality
906 struct wpa_signal_info {
915 * struct wpa_driver_ops - Driver interface API definition
917 * This structure defines the API that each driver interface needs to implement
918 * for core wpa_supplicant code. All driver specific functionality is captured
921 struct wpa_driver_ops {
922 /** Name of the driver interface */
924 /** One line description of the driver interface */
928 * get_bssid - Get the current BSSID
929 * @priv: private driver interface data
930 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
932 * Returns: 0 on success, -1 on failure
934 * Query kernel driver for the current BSSID and copy it to bssid.
935 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
938 int (*get_bssid)(void *priv, u8 *bssid);
941 * get_ssid - Get the current SSID
942 * @priv: private driver interface data
943 * @ssid: buffer for SSID (at least 32 bytes)
945 * Returns: Length of the SSID on success, -1 on failure
947 * Query kernel driver for the current SSID and copy it to ssid.
948 * Returning zero is recommended if the STA is not associated.
950 * Note: SSID is an array of octets, i.e., it is not nul terminated and
951 * can, at least in theory, contain control characters (including nul)
952 * and as such, should be processed as binary data, not a printable
955 int (*get_ssid)(void *priv, u8 *ssid);
958 * set_key - Configure encryption key
959 * @ifname: Interface name (for multi-SSID/VLAN support)
960 * @priv: private driver interface data
961 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
962 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
963 * %WPA_ALG_NONE clears the key.
964 * @addr: Address of the peer STA (BSSID of the current AP when setting
965 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
966 * broadcast keys, %NULL for default keys that are used both for
967 * broadcast and unicast; when clearing keys, %NULL is used to
968 * indicate that both the broadcast-only and default key of the
969 * specified key index is to be cleared
970 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
972 * @set_tx: configure this key as the default Tx key (only used when
973 * driver does not support separate unicast/individual key
974 * @seq: sequence number/packet number, seq_len octets, the next
975 * packet number to be used for in replay protection; configured
976 * for Rx keys (in most cases, this is only used with broadcast
977 * keys and set to zero for unicast keys); %NULL if not set
978 * @seq_len: length of the seq, depends on the algorithm:
979 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
980 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
982 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
983 * TKIP: 32, CCMP: 16, IGTK: 16)
985 * Returns: 0 on success, -1 on failure
987 * Configure the given key for the kernel driver. If the driver
988 * supports separate individual keys (4 default keys + 1 individual),
989 * addr can be used to determine whether the key is default or
990 * individual. If only 4 keys are supported, the default key with key
991 * index 0 is used as the individual key. STA must be configured to use
992 * it as the default Tx key (set_tx is set) and accept Rx for all the
993 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
994 * broadcast keys, so key index 0 is available for this kind of
997 * Please note that TKIP keys include separate TX and RX MIC keys and
998 * some drivers may expect them in different order than wpa_supplicant
999 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1000 * will trigger Michael MIC errors. This can be fixed by changing the
1001 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1002 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1003 * example on how this can be done.
1005 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1006 const u8 *addr, int key_idx, int set_tx,
1007 const u8 *seq, size_t seq_len,
1008 const u8 *key, size_t key_len);
1011 * init - Initialize driver interface
1012 * @ctx: context to be used when calling wpa_supplicant functions,
1013 * e.g., wpa_supplicant_event()
1014 * @ifname: interface name, e.g., wlan0
1016 * Returns: Pointer to private data, %NULL on failure
1018 * Initialize driver interface, including event processing for kernel
1019 * driver events (e.g., associated, scan results, Michael MIC failure).
1020 * This function can allocate a private configuration data area for
1021 * @ctx, file descriptor, interface name, etc. information that may be
1022 * needed in future driver operations. If this is not used, non-NULL
1023 * value will need to be returned because %NULL is used to indicate
1024 * failure. The returned value will be used as 'void *priv' data for
1025 * all other driver_ops functions.
1027 * The main event loop (eloop.c) of wpa_supplicant can be used to
1028 * register callback for read sockets (eloop_register_read_sock()).
1030 * See below for more information about events and
1031 * wpa_supplicant_event() function.
1033 void * (*init)(void *ctx, const char *ifname);
1036 * deinit - Deinitialize driver interface
1037 * @priv: private driver interface data from init()
1039 * Shut down driver interface and processing of driver events. Free
1040 * private data buffer if one was allocated in init() handler.
1042 void (*deinit)(void *priv);
1045 * set_param - Set driver configuration parameters
1046 * @priv: private driver interface data from init()
1047 * @param: driver specific configuration parameters
1049 * Returns: 0 on success, -1 on failure
1051 * Optional handler for notifying driver interface about configuration
1052 * parameters (driver_param).
1054 int (*set_param)(void *priv, const char *param);
1057 * set_countermeasures - Enable/disable TKIP countermeasures
1058 * @priv: private driver interface data
1059 * @enabled: 1 = countermeasures enabled, 0 = disabled
1061 * Returns: 0 on success, -1 on failure
1063 * Configure TKIP countermeasures. When these are enabled, the driver
1064 * should drop all received and queued frames that are using TKIP.
1066 int (*set_countermeasures)(void *priv, int enabled);
1069 * deauthenticate - Request driver to deauthenticate
1070 * @priv: private driver interface data
1071 * @addr: peer address (BSSID of the AP)
1072 * @reason_code: 16-bit reason code to be sent in the deauthentication
1075 * Returns: 0 on success, -1 on failure
1077 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1080 * disassociate - Request driver to disassociate
1081 * @priv: private driver interface data
1082 * @addr: peer address (BSSID of the AP)
1083 * @reason_code: 16-bit reason code to be sent in the disassociation
1086 * Returns: 0 on success, -1 on failure
1088 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
1091 * associate - Request driver to associate
1092 * @priv: private driver interface data
1093 * @params: association parameters
1095 * Returns: 0 on success, -1 on failure
1097 int (*associate)(void *priv,
1098 struct wpa_driver_associate_params *params);
1101 * add_pmkid - Add PMKSA cache entry to the driver
1102 * @priv: private driver interface data
1103 * @bssid: BSSID for the PMKSA cache entry
1104 * @pmkid: PMKID for the PMKSA cache entry
1106 * Returns: 0 on success, -1 on failure
1108 * This function is called when a new PMK is received, as a result of
1109 * either normal authentication or RSN pre-authentication.
1111 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1112 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1113 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1114 * driver_ops function does not need to be implemented. Likewise, if
1115 * the driver does not support WPA, this function is not needed.
1117 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1120 * remove_pmkid - Remove PMKSA cache entry to the driver
1121 * @priv: private driver interface data
1122 * @bssid: BSSID for the PMKSA cache entry
1123 * @pmkid: PMKID for the PMKSA cache entry
1125 * Returns: 0 on success, -1 on failure
1127 * This function is called when the supplicant drops a PMKSA cache
1128 * entry for any reason.
1130 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1131 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1132 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1133 * from wpa_supplicant, this driver_ops function does not need to be
1134 * implemented. Likewise, if the driver does not support WPA, this
1135 * function is not needed.
1137 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1140 * flush_pmkid - Flush PMKSA cache
1141 * @priv: private driver interface data
1143 * Returns: 0 on success, -1 on failure
1145 * This function is called when the supplicant drops all PMKSA cache
1146 * entries for any reason.
1148 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1149 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1150 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1151 * from wpa_supplicant, this driver_ops function does not need to be
1152 * implemented. Likewise, if the driver does not support WPA, this
1153 * function is not needed.
1155 int (*flush_pmkid)(void *priv);
1158 * get_capa - Get driver capabilities
1159 * @priv: private driver interface data
1161 * Returns: 0 on success, -1 on failure
1163 * Get driver/firmware/hardware capabilities.
1165 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1168 * poll - Poll driver for association information
1169 * @priv: private driver interface data
1171 * This is an option callback that can be used when the driver does not
1172 * provide event mechanism for association events. This is called when
1173 * receiving WPA EAPOL-Key messages that require association
1174 * information. The driver interface is supposed to generate associnfo
1175 * event before returning from this callback function. In addition, the
1176 * driver interface should generate an association event after having
1177 * sent out associnfo.
1179 void (*poll)(void *priv);
1182 * get_ifname - Get interface name
1183 * @priv: private driver interface data
1185 * Returns: Pointer to the interface name. This can differ from the
1186 * interface name used in init() call. Init() is called first.
1188 * This optional function can be used to allow the driver interface to
1189 * replace the interface name with something else, e.g., based on an
1190 * interface mapping from a more descriptive name.
1192 const char * (*get_ifname)(void *priv);
1195 * get_mac_addr - Get own MAC address
1196 * @priv: private driver interface data
1198 * Returns: Pointer to own MAC address or %NULL on failure
1200 * This optional function can be used to get the own MAC address of the
1201 * device from the driver interface code. This is only needed if the
1202 * l2_packet implementation for the OS does not provide easy access to
1204 const u8 * (*get_mac_addr)(void *priv);
1207 * send_eapol - Optional function for sending EAPOL packets
1208 * @priv: private driver interface data
1209 * @dest: Destination MAC address
1211 * @data: EAPOL packet starting with IEEE 802.1X header
1212 * @data_len: Size of the EAPOL packet
1214 * Returns: 0 on success, -1 on failure
1216 * This optional function can be used to override l2_packet operations
1217 * with driver specific functionality. If this function pointer is set,
1218 * l2_packet module is not used at all and the driver interface code is
1219 * responsible for receiving and sending all EAPOL packets. The
1220 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1221 * event. The driver interface is required to implement get_mac_addr()
1222 * handler if send_eapol() is used.
1224 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1225 const u8 *data, size_t data_len);
1228 * set_operstate - Sets device operating state to DORMANT or UP
1229 * @priv: private driver interface data
1230 * @state: 0 = dormant, 1 = up
1231 * Returns: 0 on success, -1 on failure
1233 * This is an optional function that can be used on operating systems
1234 * that support a concept of controlling network device state from user
1235 * space applications. This function, if set, gets called with
1236 * state = 1 when authentication has been completed and with state = 0
1237 * when connection is lost.
1239 int (*set_operstate)(void *priv, int state);
1242 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1243 * @priv: Private driver interface data
1244 * @addr: Address of the station for which to set protection (may be
1245 * %NULL for group keys)
1246 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1247 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1248 * Returns: 0 on success, -1 on failure
1250 * This is an optional function that can be used to set the driver to
1251 * require protection for Tx and/or Rx frames. This uses the layer
1252 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1253 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1254 * set protection operation; instead, they set protection implicitly
1255 * based on configured keys.
1257 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1261 * get_hw_feature_data - Get hardware support data (channels and rates)
1262 * @priv: Private driver interface data
1263 * @num_modes: Variable for returning the number of returned modes
1264 * flags: Variable for returning hardware feature flags
1265 * Returns: Pointer to allocated hardware data on success or %NULL on
1266 * failure. Caller is responsible for freeing this.
1268 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1273 * send_mlme - Send management frame from MLME
1274 * @priv: Private driver interface data
1275 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1276 * @data_len: Size of the management frame
1277 * Returns: 0 on success, -1 on failure
1279 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
1282 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1283 * @priv: Private driver interface data
1284 * @md: Mobility domain (2 octets) (also included inside ies)
1285 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1286 * @ies_len: Length of FT IEs in bytes
1287 * Returns: 0 on success, -1 on failure
1289 * The supplicant uses this callback to let the driver know that keying
1290 * material for FT is available and that the driver can use the
1291 * provided IEs in the next message in FT authentication sequence.
1293 * This function is only needed for driver that support IEEE 802.11r
1294 * (Fast BSS Transition).
1296 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1300 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1301 * @priv: Private driver interface data
1302 * @action: Action field value
1303 * @target_ap: Target AP address
1304 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1305 * @ies_len: Length of FT IEs in bytes
1306 * Returns: 0 on success, -1 on failure
1308 * The supplicant uses this callback to request the driver to transmit
1309 * an FT Action frame (action category 6) for over-the-DS fast BSS
1312 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1313 const u8 *ies, size_t ies_len);
1316 * get_scan_results2 - Fetch the latest scan results
1317 * @priv: private driver interface data
1319 * Returns: Allocated buffer of scan results (caller is responsible for
1320 * freeing the data structure) on success, NULL on failure
1322 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1325 * set_country - Set country
1326 * @priv: Private driver interface data
1327 * @alpha2: country to which to switch to
1328 * Returns: 0 on success, -1 on failure
1330 * This function is for drivers which support some form
1331 * of setting a regulatory domain.
1333 int (*set_country)(void *priv, const char *alpha2);
1336 * global_init - Global driver initialization
1337 * Returns: Pointer to private data (global), %NULL on failure
1339 * This optional function is called to initialize the driver wrapper
1340 * for global data, i.e., data that applies to all interfaces. If this
1341 * function is implemented, global_deinit() will also need to be
1342 * implemented to free the private data. The driver will also likely
1343 * use init2() function instead of init() to get the pointer to global
1344 * data available to per-interface initializer.
1346 void * (*global_init)(void);
1349 * global_deinit - Global driver deinitialization
1350 * @priv: private driver global data from global_init()
1352 * Terminate any global driver related functionality and free the
1353 * global data structure.
1355 void (*global_deinit)(void *priv);
1358 * init2 - Initialize driver interface (with global data)
1359 * @ctx: context to be used when calling wpa_supplicant functions,
1360 * e.g., wpa_supplicant_event()
1361 * @ifname: interface name, e.g., wlan0
1362 * @global_priv: private driver global data from global_init()
1363 * Returns: Pointer to private data, %NULL on failure
1365 * This function can be used instead of init() if the driver wrapper
1368 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1371 * get_interfaces - Get information about available interfaces
1372 * @global_priv: private driver global data from global_init()
1373 * Returns: Allocated buffer of interface information (caller is
1374 * responsible for freeing the data structure) on success, NULL on
1377 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1380 * scan2 - Request the driver to initiate scan
1381 * @priv: private driver interface data
1382 * @params: Scan parameters
1384 * Returns: 0 on success, -1 on failure
1386 * Once the scan results are ready, the driver should report scan
1387 * results event for wpa_supplicant which will eventually request the
1388 * results with wpa_driver_get_scan_results2().
1390 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1393 * authenticate - Request driver to authenticate
1394 * @priv: private driver interface data
1395 * @params: authentication parameters
1396 * Returns: 0 on success, -1 on failure
1398 * This is an optional function that can be used with drivers that
1399 * support separate authentication and association steps, i.e., when
1400 * wpa_supplicant can act as the SME. If not implemented, associate()
1401 * function is expected to take care of IEEE 802.11 authentication,
1404 int (*authenticate)(void *priv,
1405 struct wpa_driver_auth_params *params);
1408 * set_ap - Set Beacon and Probe Response information for AP mode
1409 * @priv: Private driver interface data
1410 * @params: Parameters to use in AP mode
1412 * This function is used to configure Beacon template and/or extra IEs
1413 * to add for Beacon and Probe Response frames for the driver in
1414 * AP mode. The driver is responsible for building the full Beacon
1415 * frame by concatenating the head part with TIM IE generated by the
1416 * driver/firmware and finishing with the tail part. Depending on the
1417 * driver architectue, this can be done either by using the full
1418 * template or the set of additional IEs (e.g., WPS and P2P IE).
1419 * Similarly, Probe Response processing depends on the driver design.
1420 * If the driver (or firmware) takes care of replying to Probe Request
1421 * frames, the extra IEs provided here needs to be added to the Probe
1424 * Returns: 0 on success, -1 on failure
1426 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1429 * hapd_init - Initialize driver interface (hostapd only)
1430 * @hapd: Pointer to hostapd context
1431 * @params: Configuration for the driver wrapper
1432 * Returns: Pointer to private data, %NULL on failure
1434 * This function is used instead of init() or init2() when the driver
1435 * wrapper is used with hostapd.
1437 void * (*hapd_init)(struct hostapd_data *hapd,
1438 struct wpa_init_params *params);
1441 * hapd_deinit - Deinitialize driver interface (hostapd only)
1442 * @priv: Private driver interface data from hapd_init()
1444 void (*hapd_deinit)(void *priv);
1447 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1448 * @priv: Private driver interface data
1449 * @params: BSS parameters
1450 * Returns: 0 on success, -1 on failure
1452 * This is an optional function to configure the kernel driver to
1453 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1454 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1455 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1456 * for Beacon frames.
1458 * DEPRECATED - use set_ap() instead
1460 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1463 * set_privacy - Enable/disable privacy (AP only)
1464 * @priv: Private driver interface data
1465 * @enabled: 1 = privacy enabled, 0 = disabled
1466 * Returns: 0 on success, -1 on failure
1468 * This is an optional function to configure privacy field in the
1469 * kernel driver for Beacon frames. This can be left undefined (set to
1470 * %NULL) if the driver uses the Beacon template from set_ap().
1472 * DEPRECATED - use set_ap() instead
1474 int (*set_privacy)(void *priv, int enabled);
1477 * get_seqnum - Fetch the current TSC/packet number (AP only)
1478 * @ifname: The interface name (main or virtual)
1479 * @priv: Private driver interface data
1480 * @addr: MAC address of the station or %NULL for group keys
1482 * @seq: Buffer for returning the latest used TSC/packet number
1483 * Returns: 0 on success, -1 on failure
1485 * This function is used to fetch the last used TSC/packet number for
1486 * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so
1487 * there is no strict requirement on implementing support for unicast
1488 * keys (i.e., addr != %NULL).
1490 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1494 * flush - Flush all association stations (AP only)
1495 * @priv: Private driver interface data
1496 * Returns: 0 on success, -1 on failure
1498 * This function requests the driver to disassociate all associated
1499 * stations. This function does not need to be implemented if the
1500 * driver does not process association frames internally.
1502 int (*flush)(void *priv);
1505 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1506 * @priv: Private driver interface data
1507 * @elem: Information elements
1508 * @elem_len: Length of the elem buffer in octets
1509 * Returns: 0 on success, -1 on failure
1511 * This is an optional function to add information elements in the
1512 * kernel driver for Beacon and Probe Response frames. This can be left
1513 * undefined (set to %NULL) if the driver uses the Beacon template from
1516 * DEPRECATED - use set_ap() instead
1518 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1521 * read_sta_data - Fetch station data (AP only)
1522 * @priv: Private driver interface data
1523 * @data: Buffer for returning station information
1524 * @addr: MAC address of the station
1525 * Returns: 0 on success, -1 on failure
1527 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1531 * hapd_send_eapol - Send an EAPOL packet (AP only)
1532 * @priv: private driver interface data
1533 * @addr: Destination MAC address
1534 * @data: EAPOL packet starting with IEEE 802.1X header
1535 * @data_len: Length of the EAPOL packet in octets
1536 * @encrypt: Whether the frame should be encrypted
1537 * @own_addr: Source MAC address
1538 * @flags: WPA_STA_* flags for the destination station
1540 * Returns: 0 on success, -1 on failure
1542 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1543 size_t data_len, int encrypt,
1544 const u8 *own_addr, u32 flags);
1547 * sta_deauth - Deauthenticate a station (AP only)
1548 * @priv: Private driver interface data
1549 * @own_addr: Source address and BSSID for the Deauthentication frame
1550 * @addr: MAC address of the station to deauthenticate
1551 * @reason: Reason code for the Deauthentiation frame
1552 * Returns: 0 on success, -1 on failure
1554 * This function requests a specific station to be deauthenticated and
1555 * a Deauthentication frame to be sent to it.
1557 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1561 * sta_disassoc - Disassociate a station (AP only)
1562 * @priv: Private driver interface data
1563 * @own_addr: Source address and BSSID for the Disassociation frame
1564 * @addr: MAC address of the station to disassociate
1565 * @reason: Reason code for the Disassociation frame
1566 * Returns: 0 on success, -1 on failure
1568 * This function requests a specific station to be disassociated and
1569 * a Disassociation frame to be sent to it.
1571 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1575 * sta_remove - Remove a station entry (AP only)
1576 * @priv: Private driver interface data
1577 * @addr: MAC address of the station to be removed
1578 * Returns: 0 on success, -1 on failure
1580 int (*sta_remove)(void *priv, const u8 *addr);
1583 * hapd_get_ssid - Get the current SSID (AP only)
1584 * @priv: Private driver interface data
1585 * @buf: Buffer for returning the SSID
1586 * @len: Maximum length of the buffer
1587 * Returns: Length of the SSID on success, -1 on failure
1589 * This function need not be implemented if the driver uses Beacon
1590 * template from set_ap() and does not reply to Probe Request frames.
1592 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1595 * hapd_set_ssid - Set SSID (AP only)
1596 * @priv: Private driver interface data
1598 * @len: Length of the SSID in octets
1599 * Returns: 0 on success, -1 on failure
1601 * DEPRECATED - use set_ap() instead
1603 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1606 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1607 * @priv: Private driver interface data
1608 * @enabled: 1 = countermeasures enabled, 0 = disabled
1609 * Returns: 0 on success, -1 on failure
1611 * This need not be implemented if the driver does not take care of
1612 * association processing.
1614 int (*hapd_set_countermeasures)(void *priv, int enabled);
1617 * sta_add - Add a station entry
1618 * @priv: Private driver interface data
1619 * @params: Station parameters
1620 * Returns: 0 on success, -1 on failure
1622 * This function is used to add a station entry to the driver once the
1623 * station has completed association. This is only used if the driver
1624 * does not take care of association processing.
1626 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1629 * get_inact_sec - Get station inactivity duration (AP only)
1630 * @priv: Private driver interface data
1631 * @addr: Station address
1632 * Returns: Number of seconds station has been inactive, -1 on failure
1634 int (*get_inact_sec)(void *priv, const u8 *addr);
1637 * sta_clear_stats - Clear station statistics (AP only)
1638 * @priv: Private driver interface data
1639 * @addr: Station address
1640 * Returns: 0 on success, -1 on failure
1642 int (*sta_clear_stats)(void *priv, const u8 *addr);
1645 * set_freq - Set channel/frequency (AP only)
1646 * @priv: Private driver interface data
1647 * @freq: Channel parameters
1648 * Returns: 0 on success, -1 on failure
1650 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1653 * set_rts - Set RTS threshold
1654 * @priv: Private driver interface data
1655 * @rts: RTS threshold in octets
1656 * Returns: 0 on success, -1 on failure
1658 int (*set_rts)(void *priv, int rts);
1661 * set_frag - Set fragmentation threshold
1662 * @priv: Private driver interface data
1663 * @frag: Fragmentation threshold in octets
1664 * Returns: 0 on success, -1 on failure
1666 int (*set_frag)(void *priv, int frag);
1669 * sta_set_flags - Set station flags (AP only)
1670 * @priv: Private driver interface data
1671 * @addr: Station address
1672 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1673 * @flags_or: Bitmap of WPA_STA_* flags to add
1674 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1675 * Returns: 0 on success, -1 on failure
1677 int (*sta_set_flags)(void *priv, const u8 *addr,
1678 int total_flags, int flags_or, int flags_and);
1681 * set_rate_sets - Set supported and basic rate sets (AP only)
1682 * @priv: Private driver interface data
1683 * @supp_rates: -1 terminated array of supported rates in 100 kbps
1684 * @basic_rates: -1 terminated array of basic rates in 100 kbps
1685 * @mode: hardware mode (HOSTAPD_MODE_*)
1686 * Returns: 0 on success, -1 on failure
1688 int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
1692 * set_tx_queue_params - Set TX queue parameters
1693 * @priv: Private driver interface data
1694 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
1698 * @burst_time: Maximum length for bursting in 0.1 msec units
1700 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1701 int cw_max, int burst_time);
1704 * valid_bss_mask - Validate BSSID mask
1705 * @priv: Private driver interface data
1708 * Returns: 0 if mask is valid, -1 if mask is not valid, 1 if mask can
1709 * be used, but the main interface address must be the first address in
1710 * the block if mask is applied
1712 int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
1715 * if_add - Add a virtual interface
1716 * @priv: Private driver interface data
1717 * @type: Interface type
1718 * @ifname: Interface name for the new virtual interface
1719 * @addr: Local address to use for the interface or %NULL to use the
1720 * parent interface address
1721 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1722 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1723 * not allowed (applies only to %WPA_IF_AP_BSS type)
1724 * @force_ifname: Buffer for returning an interface name that the
1725 * driver ended up using if it differs from the requested ifname
1726 * @if_addr: Buffer for returning the allocated interface address
1727 * (this may differ from the requested addr if the driver cannot
1728 * change interface address)
1729 * @bridge: Bridge interface to use or %NULL if no bridge configured
1730 * Returns: 0 on success, -1 on failure
1732 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1733 const char *ifname, const u8 *addr, void *bss_ctx,
1734 void **drv_priv, char *force_ifname, u8 *if_addr,
1735 const char *bridge);
1738 * if_remove - Remove a virtual interface
1739 * @priv: Private driver interface data
1740 * @type: Interface type
1741 * @ifname: Interface name of the virtual interface to be removed
1742 * Returns: 0 on success, -1 on failure
1744 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1745 const char *ifname);
1748 * set_sta_vlan - Bind a station into a specific interface (AP only)
1749 * @priv: Private driver interface data
1750 * @ifname: Interface (main or virtual BSS or VLAN)
1751 * @addr: MAC address of the associated station
1753 * Returns: 0 on success, -1 on failure
1755 * This function is used to bind a station to a specific virtual
1756 * interface. It is only used if when virtual interfaces are supported,
1757 * e.g., to assign stations to different VLAN interfaces based on
1758 * information from a RADIUS server. This allows separate broadcast
1759 * domains to be used with a single BSS.
1761 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1765 * commit - Optional commit changes handler (AP only)
1766 * @priv: driver private data
1767 * Returns: 0 on success, -1 on failure
1769 * This optional handler function can be registered if the driver
1770 * interface implementation needs to commit changes (e.g., by setting
1771 * network interface up) at the end of initial configuration. If set,
1772 * this handler will be called after initial setup has been completed.
1774 int (*commit)(void *priv);
1777 * send_ether - Send an ethernet packet (AP only)
1778 * @priv: private driver interface data
1779 * @dst: Destination MAC address
1780 * @src: Source MAC address
1782 * @data: EAPOL packet starting with IEEE 802.1X header
1783 * @data_len: Length of the EAPOL packet in octets
1784 * Returns: 0 on success, -1 on failure
1786 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1787 const u8 *data, size_t data_len);
1790 * set_radius_acl_auth - Notification of RADIUS ACL change
1791 * @priv: Private driver interface data
1792 * @mac: MAC address of the station
1793 * @accepted: Whether the station was accepted
1794 * @session_timeout: Session timeout for the station
1795 * Returns: 0 on success, -1 on failure
1797 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1798 u32 session_timeout);
1801 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1802 * @priv: Private driver interface data
1803 * @mac: MAC address of the station
1804 * Returns: 0 on success, -1 on failure
1806 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1809 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
1810 * @priv: Private driver interface data
1811 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
1812 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
1814 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
1815 * to remove extra IE(s)
1816 * Returns: 0 on success, -1 on failure
1818 * This is an optional function to add WPS IE in the kernel driver for
1819 * Beacon and Probe Response frames. This can be left undefined (set
1820 * to %NULL) if the driver uses the Beacon template from set_ap()
1821 * and does not process Probe Request frames. If the driver takes care
1822 * of (Re)Association frame processing, the assocresp buffer includes
1823 * WPS IE(s) that need to be added to (Re)Association Response frames
1824 * whenever a (Re)Association Request frame indicated use of WPS.
1826 * This will also be used to add P2P IE(s) into Beacon/Probe Response
1827 * frames when operating as a GO. The driver is responsible for adding
1828 * timing related attributes (e.g., NoA) in addition to the IEs
1829 * included here by appending them after these buffers. This call is
1830 * also used to provide Probe Response IEs for P2P Listen state
1831 * operations for drivers that generate the Probe Response frames
1834 * DEPRECATED - use set_ap() instead
1836 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
1837 const struct wpabuf *proberesp,
1838 const struct wpabuf *assocresp);
1841 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1842 * @priv: Private driver interface data
1843 * @authorized: Whether the port is authorized
1844 * Returns: 0 on success, -1 on failure
1846 int (*set_supp_port)(void *priv, int authorized);
1849 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1850 * @priv: Private driver interface data
1851 * @addr: MAC address of the associated station
1852 * @aid: Association ID
1853 * @val: 1 = bind to 4-address WDS; 0 = unbind
1854 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
1855 * to indicate that bridge is not to be used
1856 * Returns: 0 on success, -1 on failure
1858 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
1859 const char *bridge_ifname);
1862 * send_action - Transmit an Action frame
1863 * @priv: Private driver interface data
1864 * @freq: Frequency (in MHz) of the channel
1865 * @wait: Time to wait off-channel for a response (in ms), or zero
1866 * @dst: Destination MAC address (Address 1)
1867 * @src: Source MAC address (Address 2)
1868 * @bssid: BSSID (Address 3)
1870 * @data_len: data length in octets
1871 * Returns: 0 on success, -1 on failure
1873 * This command can be used to request the driver to transmit an action
1874 * frame to the specified destination.
1876 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
1877 * be transmitted on the given channel and the device will wait for a
1878 * response on that channel for the given wait time.
1880 * If the flag is not set, the wait time will be ignored. In this case,
1881 * if a remain-on-channel duration is in progress, the frame must be
1882 * transmitted on that channel; alternatively the frame may be sent on
1883 * the current operational channel (if in associated state in station
1884 * mode or while operating as an AP.)
1886 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
1887 const u8 *dst, const u8 *src, const u8 *bssid,
1888 const u8 *data, size_t data_len);
1891 * send_action_cancel_wait - Cancel action frame TX wait
1892 * @priv: Private driver interface data
1894 * This command cancels the wait time associated with sending an action
1895 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
1896 * set in the driver flags.
1898 void (*send_action_cancel_wait)(void *priv);
1901 * remain_on_channel - Remain awake on a channel
1902 * @priv: Private driver interface data
1903 * @freq: Frequency (in MHz) of the channel
1904 * @duration: Duration in milliseconds
1905 * Returns: 0 on success, -1 on failure
1907 * This command is used to request the driver to remain awake on the
1908 * specified channel for the specified duration and report received
1909 * Action frames with EVENT_RX_ACTION events. Optionally, received
1910 * Probe Request frames may also be requested to be reported by calling
1911 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
1913 * The driver may not be at the requested channel when this function
1914 * returns, i.e., the return code is only indicating whether the
1915 * request was accepted. The caller will need to wait until the
1916 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
1917 * completed the channel change. This may take some time due to other
1918 * need for the radio and the caller should be prepared to timing out
1919 * its wait since there are no guarantees on when this request can be
1922 int (*remain_on_channel)(void *priv, unsigned int freq,
1923 unsigned int duration);
1926 * cancel_remain_on_channel - Cancel remain-on-channel operation
1927 * @priv: Private driver interface data
1929 * This command can be used to cancel a remain-on-channel operation
1930 * before its originally requested duration has passed. This could be
1931 * used, e.g., when remain_on_channel() is used to request extra time
1932 * to receive a response to an Action frame and the response is
1933 * received when there is still unneeded time remaining on the
1934 * remain-on-channel operation.
1936 int (*cancel_remain_on_channel)(void *priv);
1939 * probe_req_report - Request Probe Request frames to be indicated
1940 * @priv: Private driver interface data
1941 * @report: Whether to report received Probe Request frames
1942 * Returns: 0 on success, -1 on failure (or if not supported)
1944 * This command can be used to request the driver to indicate when
1945 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
1946 * Since this operation may require extra resources, e.g., due to less
1947 * optimal hardware/firmware RX filtering, many drivers may disable
1948 * Probe Request reporting at least in station mode. This command is
1949 * used to notify the driver when the Probe Request frames need to be
1950 * reported, e.g., during remain-on-channel operations.
1952 int (*probe_req_report)(void *priv, int report);
1955 * disable_11b_rates - Set whether IEEE 802.11b rates are used for TX
1956 * @priv: Private driver interface data
1957 * @disabled: Whether IEEE 802.11b rates are disabled
1958 * Returns: 0 on success, -1 on failure (or if not supported)
1960 * This command is used to disable IEEE 802.11b rates (1, 2, 5.5, and
1961 * 11 Mbps) as TX rates for data and management frames. This can be
1962 * used to optimize channel use when there is no need to support IEEE
1963 * 802.11b-only devices.
1965 int (*disable_11b_rates)(void *priv, int disabled);
1968 * deinit_ap - Deinitialize AP mode
1969 * @priv: Private driver interface data
1970 * Returns: 0 on success, -1 on failure (or if not supported)
1972 * This optional function can be used to disable AP mode related
1973 * configuration and change the driver mode to station mode to allow
1974 * normal station operations like scanning to be completed.
1976 int (*deinit_ap)(void *priv);
1979 * suspend - Notification on system suspend/hibernate event
1980 * @priv: Private driver interface data
1982 void (*suspend)(void *priv);
1985 * resume - Notification on system resume/thaw event
1986 * @priv: Private driver interface data
1988 void (*resume)(void *priv);
1991 * signal_monitor - Set signal monitoring parameters
1992 * @priv: Private driver interface data
1993 * @threshold: Threshold value for signal change events; 0 = disabled
1994 * @hysteresis: Minimum change in signal strength before indicating a
1996 * Returns: 0 on success, -1 on failure (or if not supported)
1998 * This function can be used to configure monitoring of signal strength
1999 * with the current AP. Whenever signal strength drops below the
2000 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2001 * should be generated assuming the signal strength has changed at
2002 * least %hysteresis from the previously indicated signal change event.
2004 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2007 * send_frame - Send IEEE 802.11 frame (testing use only)
2008 * @priv: Private driver interface data
2009 * @data: IEEE 802.11 frame with IEEE 802.11 header
2010 * @data_len: Size of the frame
2011 * @encrypt: Whether to encrypt the frame (if keys are set)
2012 * Returns: 0 on success, -1 on failure
2014 * This function is only used for debugging purposes and is not
2015 * required to be implemented for normal operations.
2017 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2021 * shared_freq - Get operating frequency of shared interface(s)
2022 * @priv: Private driver interface data
2023 * Returns: Operating frequency in MHz, 0 if no shared operation in
2024 * use, or -1 on failure
2026 * This command can be used to request the current operating frequency
2027 * of any virtual interface that shares the same radio to provide
2028 * information for channel selection for other virtual interfaces.
2030 int (*shared_freq)(void *priv);
2033 * get_noa - Get current Notice of Absence attribute payload
2034 * @priv: Private driver interface data
2035 * @buf: Buffer for returning NoA
2036 * @buf_len: Buffer length in octets
2037 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2038 * advertized, or -1 on failure
2040 * This function is used to fetch the current Notice of Absence
2041 * attribute value from GO.
2043 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2046 * set_noa - Set Notice of Absence parameters for GO (testing)
2047 * @priv: Private driver interface data
2049 * @start: Start time in ms from next TBTT
2050 * @duration: Duration in ms
2051 * Returns: 0 on success or -1 on failure
2053 * This function is used to set Notice of Absence parameters for GO. It
2054 * is used only for testing. To disable NoA, all parameters are set to
2057 int (*set_noa)(void *priv, u8 count, int start, int duration);
2060 * set_p2p_powersave - Set P2P power save options
2061 * @priv: Private driver interface data
2062 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2063 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2064 * @ctwindow: 0.. = change (msec), -1 = no change
2065 * Returns: 0 on success or -1 on failure
2067 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2071 * ampdu - Enable/disable aggregation
2072 * @priv: Private driver interface data
2073 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2074 * Returns: 0 on success or -1 on failure
2076 int (*ampdu)(void *priv, int ampdu);
2079 * get_radio_name - Get physical radio name for the device
2080 * @priv: Private driver interface data
2081 * Returns: Radio name or %NULL if not known
2083 * The returned data must not be modified by the caller. It is assumed
2084 * that any interface that has the same radio name as another is
2085 * sharing the same physical radio. This information can be used to
2086 * share scan results etc. information between the virtual interfaces
2087 * to speed up various operations.
2089 const char * (*get_radio_name)(void *priv);
2092 * p2p_find - Start P2P Device Discovery
2093 * @priv: Private driver interface data
2094 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2095 * @type: Device Discovery type (enum p2p_discovery_type)
2096 * Returns: 0 on success, -1 on failure
2098 * This function is only used if the driver implements P2P management,
2099 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2100 * struct wpa_driver_capa.
2102 int (*p2p_find)(void *priv, unsigned int timeout, int type);
2105 * p2p_stop_find - Stop P2P Device Discovery
2106 * @priv: Private driver interface data
2107 * Returns: 0 on success, -1 on failure
2109 * This function is only used if the driver implements P2P management,
2110 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2111 * struct wpa_driver_capa.
2113 int (*p2p_stop_find)(void *priv);
2116 * p2p_listen - Start P2P Listen state for specified duration
2117 * @priv: Private driver interface data
2118 * @timeout: Listen state duration in milliseconds
2119 * Returns: 0 on success, -1 on failure
2121 * This function can be used to request the P2P module to keep the
2122 * device discoverable on the listen channel for an extended set of
2123 * time. At least in its current form, this is mainly used for testing
2124 * purposes and may not be of much use for normal P2P operations.
2126 * This function is only used if the driver implements P2P management,
2127 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2128 * struct wpa_driver_capa.
2130 int (*p2p_listen)(void *priv, unsigned int timeout);
2133 * p2p_connect - Start P2P group formation (GO negotiation)
2134 * @priv: Private driver interface data
2135 * @peer_addr: MAC address of the peer P2P client
2136 * @wps_method: enum p2p_wps_method value indicating config method
2137 * @go_intent: Local GO intent value (1..15)
2138 * @own_interface_addr: Intended interface address to use with the
2140 * @force_freq: The only allowed channel frequency in MHz or 0
2141 * @persistent_group: Whether to create persistent group
2142 * Returns: 0 on success, -1 on failure
2144 * This function is only used if the driver implements P2P management,
2145 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2146 * struct wpa_driver_capa.
2148 int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method,
2149 int go_intent, const u8 *own_interface_addr,
2150 unsigned int force_freq, int persistent_group);
2153 * wps_success_cb - Report successfully completed WPS provisioning
2154 * @priv: Private driver interface data
2155 * @peer_addr: Peer address
2156 * Returns: 0 on success, -1 on failure
2158 * This function is used to report successfully completed WPS
2159 * provisioning during group formation in both GO/Registrar and
2160 * client/Enrollee roles.
2162 * This function is only used if the driver implements P2P management,
2163 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2164 * struct wpa_driver_capa.
2166 int (*wps_success_cb)(void *priv, const u8 *peer_addr);
2169 * p2p_group_formation_failed - Report failed WPS provisioning
2170 * @priv: Private driver interface data
2171 * Returns: 0 on success, -1 on failure
2173 * This function is used to report failed group formation. This can
2174 * happen either due to failed WPS provisioning or due to 15 second
2175 * timeout during the provisioning phase.
2177 * This function is only used if the driver implements P2P management,
2178 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2179 * struct wpa_driver_capa.
2181 int (*p2p_group_formation_failed)(void *priv);
2184 * p2p_set_params - Set P2P parameters
2185 * @priv: Private driver interface data
2186 * @params: P2P parameters
2187 * Returns: 0 on success, -1 on failure
2189 * This function is only used if the driver implements P2P management,
2190 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2191 * struct wpa_driver_capa.
2193 int (*p2p_set_params)(void *priv, const struct p2p_params *params);
2196 * p2p_prov_disc_req - Send Provision Discovery Request
2197 * @priv: Private driver interface data
2198 * @peer_addr: MAC address of the peer P2P client
2199 * @config_methods: WPS Config Methods value (only one bit set)
2200 * Returns: 0 on success, -1 on failure
2202 * This function can be used to request a discovered P2P peer to
2203 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2204 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2205 * Provision Discovery Request frame is transmitted once immediately
2206 * and if no response is received, the frame will be sent again
2207 * whenever the target device is discovered during device dsicovery
2208 * (start with a p2p_find() call). Response from the peer is indicated
2209 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
2211 * This function is only used if the driver implements P2P management,
2212 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2213 * struct wpa_driver_capa.
2215 int (*p2p_prov_disc_req)(void *priv, const u8 *peer_addr,
2216 u16 config_methods);
2219 * p2p_sd_request - Schedule a service discovery query
2220 * @priv: Private driver interface data
2221 * @dst: Destination peer or %NULL to apply for all peers
2222 * @tlvs: P2P Service Query TLV(s)
2223 * Returns: Reference to the query or 0 on failure
2225 * Response to the query is indicated with the
2226 * EVENT_P2P_SD_RESPONSE driver event.
2228 * This function is only used if the driver implements P2P management,
2229 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2230 * struct wpa_driver_capa.
2232 u64 (*p2p_sd_request)(void *priv, const u8 *dst,
2233 const struct wpabuf *tlvs);
2236 * p2p_sd_cancel_request - Cancel a pending service discovery query
2237 * @priv: Private driver interface data
2238 * @req: Query reference from p2p_sd_request()
2239 * Returns: 0 on success, -1 on failure
2241 * This function is only used if the driver implements P2P management,
2242 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2243 * struct wpa_driver_capa.
2245 int (*p2p_sd_cancel_request)(void *priv, u64 req);
2248 * p2p_sd_response - Send response to a service discovery query
2249 * @priv: Private driver interface data
2250 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2251 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2252 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2253 * @resp_tlvs: P2P Service Response TLV(s)
2254 * Returns: 0 on success, -1 on failure
2256 * This function is called as a response to the request indicated with
2257 * the EVENT_P2P_SD_REQUEST driver event.
2259 * This function is only used if the driver implements P2P management,
2260 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2261 * struct wpa_driver_capa.
2263 int (*p2p_sd_response)(void *priv, int freq, const u8 *dst,
2265 const struct wpabuf *resp_tlvs);
2268 * p2p_service_update - Indicate a change in local services
2269 * @priv: Private driver interface data
2270 * Returns: 0 on success, -1 on failure
2272 * This function needs to be called whenever there is a change in
2273 * availability of the local services. This will increment the
2274 * Service Update Indicator value which will be used in SD Request and
2277 * This function is only used if the driver implements P2P management,
2278 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2279 * struct wpa_driver_capa.
2281 int (*p2p_service_update)(void *priv);
2284 * p2p_reject - Reject peer device (explicitly block connections)
2285 * @priv: Private driver interface data
2286 * @addr: MAC address of the peer
2287 * Returns: 0 on success, -1 on failure
2289 int (*p2p_reject)(void *priv, const u8 *addr);
2292 * p2p_invite - Invite a P2P Device into a group
2293 * @priv: Private driver interface data
2294 * @peer: Device Address of the peer P2P Device
2295 * @role: Local role in the group
2296 * @bssid: Group BSSID or %NULL if not known
2298 * @ssid_len: Length of ssid in octets
2299 * @go_dev_addr: Forced GO Device Address or %NULL if none
2300 * @persistent_group: Whether this is to reinvoke a persistent group
2301 * Returns: 0 on success, -1 on failure
2303 int (*p2p_invite)(void *priv, const u8 *peer, int role,
2304 const u8 *bssid, const u8 *ssid, size_t ssid_len,
2305 const u8 *go_dev_addr, int persistent_group);
2308 * send_tdls_mgmt - for sending TDLS management packets
2309 * @priv: private driver interface data
2310 * @dst: Destination (peer) MAC address
2311 * @action_code: TDLS action code for the mssage
2312 * @dialog_token: Dialog Token to use in the message (if needed)
2313 * @status_code: Status Code or Reason Code to use (if needed)
2314 * @buf: TDLS IEs to add to the message
2315 * @len: Length of buf in octets
2316 * Returns: 0 on success, -1 on failure
2318 * This optional function can be used to send packet to driver which is
2319 * responsible for receiving and sending all TDLS packets.
2321 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2322 u8 dialog_token, u16 status_code,
2323 const u8 *buf, size_t len);
2325 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2328 * signal_poll - Get current connection information
2329 * @priv: Private driver interface data
2330 * @signal_info: Connection info structure
2332 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2335 * set_authmode - Set authentication algorithm(s) for static WEP
2336 * @priv: Private driver interface data
2337 * @authmode: 1=Open System, 2=Shared Key, 3=both
2338 * Returns: 0 on success, -1 on failure
2340 * This function can be used to set authentication algorithms for AP
2341 * mode when static WEP is used. If the driver uses user space MLME/SME
2342 * implementation, there is no need to implement this function.
2344 * DEPRECATED - use set_ap() instead
2346 int (*set_authmode)(void *priv, int authmode);
2349 * set_rekey_info - Set rekey information
2350 * @priv: Private driver interface data
2353 * @replay_ctr: Current EAPOL-Key Replay Counter
2355 * This optional function can be used to provide information for the
2356 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2357 * while the host (including wpa_supplicant) is sleeping.
2359 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2360 const u8 *replay_ctr);
2363 * sta_assoc - Station association indication
2364 * @priv: Private driver interface data
2365 * @own_addr: Source address and BSSID for association frame
2366 * @addr: MAC address of the station to associate
2367 * @reassoc: flag to indicate re-association
2368 * @status: association response status code
2369 * @ie: assoc response ie buffer
2370 * @len: ie buffer length
2371 * Returns: 0 on success, -1 on failure
2373 * This function indicates the driver to send (Re)Association
2374 * Response frame to the station.
2376 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2377 int reassoc, u16 status, const u8 *ie, size_t len);
2380 * sta_auth - Station authentication indication
2381 * @priv: Private driver interface data
2382 * @own_addr: Source address and BSSID for authentication frame
2383 * @addr: MAC address of the station to associate
2384 * @seq: authentication sequence number
2385 * @status: authentication response status code
2386 * @ie: authentication frame ie buffer
2387 * @len: ie buffer length
2389 * This function indicates the driver to send Authentication frame
2392 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2393 u16 seq, u16 status, const u8 *ie, size_t len);
2396 * add_tspec - Add traffic stream
2397 * @priv: Private driver interface data
2398 * @addr: MAC address of the station to associate
2399 * @tspec_ie: tspec ie buffer
2400 * @tspec_ielen: tspec ie length
2401 * Returns: 0 on success, -1 on failure
2403 * This function adds the traffic steam for the station
2404 * and fills the medium_time in tspec_ie.
2406 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2407 size_t tspec_ielen);
2410 * add_sta_node - Add a station node in the driver
2411 * @priv: Private driver interface data
2412 * @addr: MAC address of the station to add
2413 * @auth_alg: authentication algorithm used by the station
2414 * Returns: 0 on success, -1 on failure
2416 * This function adds the station node in the driver, when
2417 * the station gets added by FT-over-DS.
2419 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2422 * sched_scan - Request the driver to initiate scheduled scan
2423 * @priv: Private driver interface data
2424 * @params: Scan parameters
2425 * @interval: Interval between scan cycles in milliseconds
2426 * Returns: 0 on success, -1 on failure
2428 * This operation should be used for scheduled scan offload to
2429 * the hardware. Every time scan results are available, the
2430 * driver should report scan results event for wpa_supplicant
2431 * which will eventually request the results with
2432 * wpa_driver_get_scan_results2(). This operation is optional
2433 * and if not provided or if it returns -1, we fall back to
2434 * normal host-scheduled scans.
2436 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2440 * stop_sched_scan - Request the driver to stop a scheduled scan
2441 * @priv: Private driver interface data
2442 * Returns: 0 on success, -1 on failure
2444 * This should cause the scheduled scan to be stopped and
2445 * results should stop being sent. Must be supported if
2446 * sched_scan is supported.
2448 int (*stop_sched_scan)(void *priv);
2451 * poll_client - Probe (null data or such) the given station
2452 * @priv: Private driver interface data
2453 * @own_addr: MAC address of sending interface
2454 * @addr: MAC address of the station to probe
2455 * @qos: Indicates whether station is QoS station
2457 * This function is used to verify whether an associated station is
2458 * still present. This function does not need to be implemented if the
2459 * driver provides such inactivity polling mechanism.
2461 void (*poll_client)(void *priv, const u8 *own_addr,
2462 const u8 *addr, int qos);
2467 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2469 enum wpa_event_type {
2471 * EVENT_ASSOC - Association completed
2473 * This event needs to be delivered when the driver completes IEEE
2474 * 802.11 association or reassociation successfully.
2475 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2476 * after this event has been generated. In addition, optional
2477 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2478 * more information about the association. If the driver interface gets
2479 * both of these events at the same time, it can also include the
2480 * assoc_info data in EVENT_ASSOC call.
2485 * EVENT_DISASSOC - Association lost
2487 * This event should be called when association is lost either due to
2488 * receiving deauthenticate or disassociate frame from the AP or when
2489 * sending either of these frames to the current AP. If the driver
2490 * supports separate deauthentication event, EVENT_DISASSOC should only
2491 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2492 * In AP mode, union wpa_event_data::disassoc_info is required.
2497 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2499 * This event must be delivered when a Michael MIC error is detected by
2500 * the local driver. Additional data for event processing is
2501 * provided with union wpa_event_data::michael_mic_failure. This
2502 * information is used to request new encyption key and to initiate
2503 * TKIP countermeasures if needed.
2505 EVENT_MICHAEL_MIC_FAILURE,
2508 * EVENT_SCAN_RESULTS - Scan results available
2510 * This event must be called whenever scan results are available to be
2511 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2512 * is expected to be used some time after struct wpa_driver_ops::scan()
2513 * is called. If the driver provides an unsolicited event when the scan
2514 * has been completed, this event can be used to trigger
2515 * EVENT_SCAN_RESULTS call. If such event is not available from the
2516 * driver, the driver wrapper code is expected to use a registered
2517 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2518 * scan is expected to be completed. Optional information about
2519 * completed scan can be provided with union wpa_event_data::scan_info.
2524 * EVENT_ASSOCINFO - Report optional extra information for association
2526 * This event can be used to report extra association information for
2527 * EVENT_ASSOC processing. This extra information includes IEs from
2528 * association frames and Beacon/Probe Response frames in union
2529 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2530 * EVENT_ASSOC. Alternatively, the driver interface can include
2531 * assoc_info data in the EVENT_ASSOC call if it has all the
2532 * information available at the same point.
2537 * EVENT_INTERFACE_STATUS - Report interface status changes
2539 * This optional event can be used to report changes in interface
2540 * status (interface added/removed) using union
2541 * wpa_event_data::interface_status. This can be used to trigger
2542 * wpa_supplicant to stop and re-start processing for the interface,
2543 * e.g., when a cardbus card is ejected/inserted.
2545 EVENT_INTERFACE_STATUS,
2548 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2550 * This event can be used to inform wpa_supplicant about candidates for
2551 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2552 * for scan request (ap_scan=2 mode), this event is required for
2553 * pre-authentication. If wpa_supplicant is performing scan request
2554 * (ap_scan=1), this event is optional since scan results can be used
2555 * to add pre-authentication candidates. union
2556 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2557 * candidate and priority of the candidate, e.g., based on the signal
2558 * strength, in order to try to pre-authenticate first with candidates
2559 * that are most likely targets for re-association.
2561 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2562 * on the candidate list. In addition, it can be called for the current
2563 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2564 * will automatically skip pre-authentication in cases where a valid
2565 * PMKSA exists. When more than one candidate exists, this event should
2566 * be generated once for each candidate.
2568 * Driver will be notified about successful pre-authentication with
2569 * struct wpa_driver_ops::add_pmkid() calls.
2571 EVENT_PMKID_CANDIDATE,
2574 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2576 * This event can be used to inform wpa_supplicant about desire to set
2577 * up secure direct link connection between two stations as defined in
2578 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2579 * STAKey negotiation. The caller will need to set peer address for the
2585 * EVENT_TDLS - Request TDLS operation
2587 * This event can be used to request a TDLS operation to be performed.
2592 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2594 * The driver is expected to report the received FT IEs from
2595 * FT authentication sequence from the AP. The FT IEs are included in
2596 * the extra information in union wpa_event_data::ft_ies.
2601 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2603 * The driver can use this event to inform wpa_supplicant about a STA
2604 * in an IBSS with which protected frames could be exchanged. This
2605 * event starts RSN authentication with the other STA to authenticate
2606 * the STA and set up encryption keys with it.
2608 EVENT_IBSS_RSN_START,
2611 * EVENT_AUTH - Authentication result
2613 * This event should be called when authentication attempt has been
2614 * completed. This is only used if the driver supports separate
2615 * authentication step (struct wpa_driver_ops::authenticate).
2616 * Information about authentication result is included in
2617 * union wpa_event_data::auth.
2622 * EVENT_DEAUTH - Authentication lost
2624 * This event should be called when authentication is lost either due
2625 * to receiving deauthenticate frame from the AP or when sending that
2626 * frame to the current AP.
2627 * In AP mode, union wpa_event_data::deauth_info is required.
2632 * EVENT_ASSOC_REJECT - Association rejected
2634 * This event should be called when (re)association attempt has been
2635 * rejected by the AP. Information about the association response is
2636 * included in union wpa_event_data::assoc_reject.
2641 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2643 EVENT_AUTH_TIMED_OUT,
2646 * EVENT_ASSOC_TIMED_OUT - Association timed out
2648 EVENT_ASSOC_TIMED_OUT,
2651 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2656 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2658 EVENT_WPS_BUTTON_PUSHED,
2661 * EVENT_TX_STATUS - Report TX status
2666 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2668 EVENT_RX_FROM_UNKNOWN,
2671 * EVENT_RX_MGMT - Report RX of a management frame
2676 * EVENT_RX_ACTION - Action frame received
2678 * This event is used to indicate when an Action frame has been
2679 * received. Information about the received frame is included in
2680 * union wpa_event_data::rx_action.
2685 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2687 * This event is used to indicate when the driver has started the
2688 * requested remain-on-channel duration. Information about the
2689 * operation is included in union wpa_event_data::remain_on_channel.
2691 EVENT_REMAIN_ON_CHANNEL,
2694 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2696 * This event is used to indicate when the driver has completed
2697 * remain-on-channel duration, i.e., may noot be available on the
2698 * requested channel anymore. Information about the
2699 * operation is included in union wpa_event_data::remain_on_channel.
2701 EVENT_CANCEL_REMAIN_ON_CHANNEL,
2704 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2706 * This event is used only by driver_test.c and userspace MLME.
2711 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2713 * This event is used to indicate when a Probe Request frame has been
2714 * received. Information about the received frame is included in
2715 * union wpa_event_data::rx_probe_req. The driver is required to report
2716 * these events only after successfully completed probe_req_report()
2717 * commands to request the events (i.e., report parameter is non-zero)
2718 * in station mode. In AP mode, Probe Request frames should always be
2724 * EVENT_NEW_STA - New wired device noticed
2726 * This event is used to indicate that a new device has been detected
2727 * in a network that does not use association-like functionality (i.e.,
2728 * mainly wired Ethernet). This can be used to start EAPOL
2729 * authenticator when receiving a frame from a device. The address of
2730 * the device is included in union wpa_event_data::new_sta.
2735 * EVENT_EAPOL_RX - Report received EAPOL frame
2737 * When in AP mode with hostapd, this event is required to be used to
2738 * deliver the receive EAPOL frames from the driver. With
2739 * %wpa_supplicant, this event is used only if the send_eapol() handler
2740 * is used to override the use of l2_packet for EAPOL frame TX.
2745 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
2747 * This event is used to indicate changes in the signal strength
2748 * observed in frames received from the current AP if signal strength
2749 * monitoring has been enabled with signal_monitor().
2751 EVENT_SIGNAL_CHANGE,
2754 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
2756 * This event is used to indicate that the interface was enabled after
2757 * having been previously disabled, e.g., due to rfkill.
2759 EVENT_INTERFACE_ENABLED,
2762 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
2764 * This event is used to indicate that the interface was disabled,
2765 * e.g., due to rfkill.
2767 EVENT_INTERFACE_DISABLED,
2770 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
2772 * This event is used to indicate that the channel list has changed,
2773 * e.g., because of a regulatory domain change triggered by scan
2774 * results including an AP advertising a country code.
2776 EVENT_CHANNEL_LIST_CHANGED,
2779 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
2781 * This event is used to indicate that the driver cannot maintain this
2782 * interface in its operation mode anymore. The most likely use for
2783 * this is to indicate that AP mode operation is not available due to
2784 * operating channel would need to be changed to a DFS channel when
2785 * the driver does not support radar detection and another virtual
2786 * interfaces caused the operating channel to change. Other similar
2787 * resource conflicts could also trigger this for station mode
2790 EVENT_INTERFACE_UNAVAILABLE,
2793 * EVENT_BEST_CHANNEL
2795 * Driver generates this event whenever it detects a better channel
2796 * (e.g., based on RSSI or channel use). This information can be used
2797 * to improve channel selection for a new AP/P2P group.
2802 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
2804 * This event should be called when a Deauthentication frame is dropped
2805 * due to it not being protected (MFP/IEEE 802.11w).
2806 * union wpa_event_data::unprot_deauth is required to provide more
2807 * details of the frame.
2809 EVENT_UNPROT_DEAUTH,
2812 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
2814 * This event should be called when a Disassociation frame is dropped
2815 * due to it not being protected (MFP/IEEE 802.11w).
2816 * union wpa_event_data::unprot_disassoc is required to provide more
2817 * details of the frame.
2819 EVENT_UNPROT_DISASSOC,
2822 * EVENT_STATION_LOW_ACK
2824 * Driver generates this event whenever it detected that a particular
2825 * station was lost. Detection can be through massive transmission
2826 * failures for example.
2828 EVENT_STATION_LOW_ACK,
2831 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
2833 * This event is used only if the driver implements P2P management
2834 * internally. Event data is stored in
2835 * union wpa_event_data::p2p_dev_found.
2837 EVENT_P2P_DEV_FOUND,
2840 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
2842 * This event is used only if the driver implements P2P management
2843 * internally. Event data is stored in
2844 * union wpa_event_data::p2p_go_neg_req_rx.
2846 EVENT_P2P_GO_NEG_REQ_RX,
2849 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
2851 * This event is used only if the driver implements P2P management
2852 * internally. Event data is stored in
2853 * union wpa_event_data::p2p_go_neg_completed.
2855 EVENT_P2P_GO_NEG_COMPLETED,
2857 EVENT_P2P_PROV_DISC_REQUEST,
2858 EVENT_P2P_PROV_DISC_RESPONSE,
2859 EVENT_P2P_SD_REQUEST,
2860 EVENT_P2P_SD_RESPONSE,
2863 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
2865 EVENT_IBSS_PEER_LOST,
2868 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
2870 * This event carries the new replay counter to notify wpa_supplicant
2871 * of the current EAPOL-Key Replay Counter in case the driver/firmware
2872 * completed Group Key Handshake while the host (including
2873 * wpa_supplicant was sleeping).
2875 EVENT_DRIVER_GTK_REKEY,
2878 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
2880 EVENT_SCHED_SCAN_STOPPED,
2883 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
2885 * This event indicates that the station responded to the poll
2886 * initiated with @poll_client.
2888 EVENT_DRIVER_CLIENT_POLL_OK
2893 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
2895 union wpa_event_data {
2897 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
2899 * This structure is optional for EVENT_ASSOC calls and required for
2900 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
2901 * driver interface does not need to generate separate EVENT_ASSOCINFO
2906 * reassoc - Flag to indicate association or reassociation
2911 * req_ies - (Re)Association Request IEs
2913 * If the driver generates WPA/RSN IE, this event data must be
2914 * returned for WPA handshake to have needed information. If
2915 * wpa_supplicant-generated WPA/RSN IE is used, this
2916 * information event is optional.
2918 * This should start with the first IE (fixed fields before IEs
2919 * are not included).
2924 * req_ies_len - Length of req_ies in bytes
2929 * resp_ies - (Re)Association Response IEs
2931 * Optional association data from the driver. This data is not
2932 * required WPA, but may be useful for some protocols and as
2933 * such, should be reported if this is available to the driver
2936 * This should start with the first IE (fixed fields before IEs
2937 * are not included).
2942 * resp_ies_len - Length of resp_ies in bytes
2944 size_t resp_ies_len;
2947 * beacon_ies - Beacon or Probe Response IEs
2949 * Optional Beacon/ProbeResp data: IEs included in Beacon or
2950 * Probe Response frames from the current AP (i.e., the one
2951 * that the client just associated with). This information is
2952 * used to update WPA/RSN IE for the AP. If this field is not
2953 * set, the results from previous scan will be used. If no
2954 * data for the new AP is found, scan results will be requested
2955 * again (without scan request). At this point, the driver is
2956 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
2959 * This should start with the first IE (fixed fields before IEs
2960 * are not included).
2962 const u8 *beacon_ies;
2965 * beacon_ies_len - Length of beacon_ies */
2966 size_t beacon_ies_len;
2969 * freq - Frequency of the operational channel in MHz
2974 * addr - Station address (for AP mode)
2980 * struct disassoc_info - Data for EVENT_DISASSOC events
2982 struct disassoc_info {
2984 * addr - Station address (for AP mode)
2989 * reason_code - Reason Code (host byte order) used in
2990 * Deauthentication frame
2995 * ie - Optional IE(s) in Disassociation frame
3000 * ie_len - Length of ie buffer in octets
3006 * struct deauth_info - Data for EVENT_DEAUTH events
3008 struct deauth_info {
3010 * addr - Station address (for AP mode)
3015 * reason_code - Reason Code (host byte order) used in
3016 * Deauthentication frame
3021 * ie - Optional IE(s) in Deauthentication frame
3026 * ie_len - Length of ie buffer in octets
3032 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3034 struct michael_mic_failure {
3037 } michael_mic_failure;
3040 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3042 struct interface_status {
3045 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3050 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3052 struct pmkid_candidate {
3053 /** BSSID of the PMKID candidate */
3055 /** Smaller the index, higher the priority */
3057 /** Whether RSN IE includes pre-authenticate flag */
3062 * struct stkstart - Data for EVENT_STKSTART
3069 * struct tdls - Data for EVENT_TDLS
3075 TDLS_REQUEST_TEARDOWN
3077 u16 reason_code; /* for teardown */
3081 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3083 * During FT (IEEE 802.11r) authentication sequence, the driver is
3084 * expected to use this event to report received FT IEs (MDIE, FTIE,
3085 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3086 * IEs for the next message will be delivered through the
3087 * struct wpa_driver_ops::update_ft_ies() callback.
3093 u8 target_ap[ETH_ALEN];
3094 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3096 /** Length of ric_ies buffer in octets */
3101 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3103 struct ibss_rsn_start {
3108 * struct auth_info - Data for EVENT_AUTH events
3114 u16 auth_transaction;
3121 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3123 struct assoc_reject {
3125 * bssid - BSSID of the AP that rejected association
3130 * resp_ies - (Re)Association Response IEs
3132 * Optional association data from the driver. This data is not
3133 * required WPA, but may be useful for some protocols and as
3134 * such, should be reported if this is available to the driver
3137 * This should start with the first IE (fixed fields before IEs
3138 * are not included).
3143 * resp_ies_len - Length of resp_ies in bytes
3145 size_t resp_ies_len;
3148 * status_code - Status Code from (Re)association Response
3153 struct timeout_event {
3158 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3167 * struct tx_status - Data for EVENT_TX_STATUS events
3179 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3181 struct rx_from_unknown {
3188 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3198 * struct rx_action - Data for EVENT_RX_ACTION events
3202 * da - Destination address of the received Action frame
3207 * sa - Source address of the received Action frame
3212 * bssid - Address 3 of the received Action frame
3217 * category - Action frame category
3222 * data - Action frame body after category field
3227 * len - Length of data in octets
3232 * freq - Frequency (in MHz) on which the frame was received
3238 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3240 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3242 struct remain_on_channel {
3244 * freq - Channel frequency in MHz
3249 * duration - Duration to remain on the channel in milliseconds
3251 unsigned int duration;
3252 } remain_on_channel;
3255 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3256 * @aborted: Whether the scan was aborted
3257 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3258 * @num_freqs: Number of entries in freqs array
3259 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3261 * @num_ssids: Number of entries in ssids array
3267 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3272 * struct mlme_rx - Data for EVENT_MLME_RX events
3283 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3285 struct rx_probe_req {
3287 * sa - Source address of the received Probe Request frame
3292 * da - Destination address of the received Probe Request frame
3293 * or %NULL if not available
3298 * bssid - BSSID of the received Probe Request frame or %NULL
3304 * ie - IEs from the Probe Request body
3309 * ie_len - Length of ie buffer in octets
3315 * struct new_sta - Data for EVENT_NEW_STA events
3322 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3331 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3333 struct wpa_signal_info signal_change;
3336 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3337 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3338 * @freq_5: Best 5 GHz band channel frequency in MHz
3339 * @freq_overall: Best channel frequency in MHz
3341 * 0 can be used to indicate no preference in either band.
3343 struct best_channel {
3349 struct unprot_deauth {
3355 struct unprot_disassoc {
3362 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3363 * @addr: station address
3370 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3372 struct p2p_dev_found {
3375 const u8 *pri_dev_type;
3376 const char *dev_name;
3383 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3385 struct p2p_go_neg_req_rx {
3388 } p2p_go_neg_req_rx;
3391 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3393 struct p2p_go_neg_completed {
3394 struct p2p_go_neg_results *res;
3395 } p2p_go_neg_completed;
3397 struct p2p_prov_disc_req {
3401 const u8 *pri_dev_type;
3402 const char *dev_name;
3403 u16 supp_config_methods;
3406 } p2p_prov_disc_req;
3408 struct p2p_prov_disc_resp {
3411 } p2p_prov_disc_resp;
3422 struct p2p_sd_resp {
3430 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3432 struct ibss_peer_lost {
3437 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3439 struct driver_gtk_rekey {
3441 const u8 *replay_ctr;
3445 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
3446 * @addr: station address
3448 struct client_poll {
3454 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3455 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3456 * with struct wpa_driver_ops::init()
3457 * @event: event type (defined above)
3458 * @data: possible extra data for the event
3460 * Driver wrapper code should call this function whenever an event is received
3463 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
3464 union wpa_event_data *data);
3468 * The following inline functions are provided for convenience to simplify
3469 * event indication for some of the common events.
3472 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
3473 size_t ielen, int reassoc)
3475 union wpa_event_data event;
3476 os_memset(&event, 0, sizeof(event));
3477 event.assoc_info.reassoc = reassoc;
3478 event.assoc_info.req_ies = ie;
3479 event.assoc_info.req_ies_len = ielen;
3480 event.assoc_info.addr = addr;
3481 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
3484 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
3486 union wpa_event_data event;
3487 os_memset(&event, 0, sizeof(event));
3488 event.disassoc_info.addr = addr;
3489 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
3492 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
3495 union wpa_event_data event;
3496 os_memset(&event, 0, sizeof(event));
3497 event.eapol_rx.src = src;
3498 event.eapol_rx.data = data;
3499 event.eapol_rx.data_len = data_len;
3500 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
3503 static inline void wpa_scan_results_free(struct wpa_scan_results *res)
3510 for (i = 0; i < res->num; i++)
3511 os_free(res->res[i]);
3516 #endif /* DRIVER_H */