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
64 * struct hostapd_hw_modes - Supported hardware mode information
66 struct hostapd_hw_modes {
68 * mode - Hardware mode
70 enum hostapd_hw_mode mode;
73 * num_channels - Number of entries in the channels array
78 * channels - Array of supported channels
80 struct hostapd_channel_data *channels;
83 * num_rates - Number of entries in the rates array
88 * rates - Array of supported rates in 100 kbps units
93 * ht_capab - HT (IEEE 802.11n) capabilities
98 * mcs_set - MCS (IEEE 802.11n) rate parameters
103 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
109 #define IEEE80211_MODE_INFRA 0
110 #define IEEE80211_MODE_IBSS 1
111 #define IEEE80211_MODE_AP 2
113 #define IEEE80211_CAP_ESS 0x0001
114 #define IEEE80211_CAP_IBSS 0x0002
115 #define IEEE80211_CAP_PRIVACY 0x0010
117 #define WPA_SCAN_QUAL_INVALID BIT(0)
118 #define WPA_SCAN_NOISE_INVALID BIT(1)
119 #define WPA_SCAN_LEVEL_INVALID BIT(2)
120 #define WPA_SCAN_LEVEL_DBM BIT(3)
121 #define WPA_SCAN_AUTHENTICATED BIT(4)
122 #define WPA_SCAN_ASSOCIATED BIT(5)
125 * struct wpa_scan_res - Scan result for an BSS/IBSS
126 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
128 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
129 * @beacon_int: beacon interval in TUs (host byte order)
130 * @caps: capability information field in host byte order
131 * @qual: signal quality
132 * @noise: noise level
133 * @level: signal level
135 * @age: Age of the information in milliseconds (i.e., how many milliseconds
136 * ago the last Beacon or Probe Response frame was received)
137 * @ie_len: length of the following IE field in octets
138 * @beacon_ie_len: length of the following Beacon IE field in octets
140 * This structure is used as a generic format for scan results from the
141 * driver. Each driver interface implementation is responsible for converting
142 * the driver or OS specific scan results into this format.
144 * If the driver does not support reporting all IEs, the IE data structure is
145 * constructed of the IEs that are available. This field will also need to
146 * include SSID in IE format. All drivers are encouraged to be extended to
147 * report all IEs to make it easier to support future additions.
149 struct wpa_scan_res {
161 size_t beacon_ie_len;
163 * Followed by ie_len octets of IEs from Probe Response frame (or if
164 * the driver does not indicate source of IEs, these may also be from
165 * Beacon frame). After the first set of IEs, another set of IEs may
166 * follow (with beacon_ie_len octets of data) if the driver provides
172 * struct wpa_scan_results - Scan results
173 * @res: Array of pointers to allocated variable length scan result entries
174 * @num: Number of entries in the scan result array
176 struct wpa_scan_results {
177 struct wpa_scan_res **res;
182 * struct wpa_interface_info - Network interface information
183 * @next: Pointer to the next interface or NULL if this is the last one
184 * @ifname: Interface name that can be used with init() or init2()
185 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
187 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
188 * is not an allocated copy, i.e., get_interfaces() caller will not free
191 struct wpa_interface_info {
192 struct wpa_interface_info *next;
195 const char *drv_name;
198 #define WPAS_MAX_SCAN_SSIDS 16
201 * struct wpa_driver_scan_params - Scan parameters
202 * Data for struct wpa_driver_ops::scan2().
204 struct wpa_driver_scan_params {
206 * ssids - SSIDs to scan for
208 struct wpa_driver_scan_ssid {
210 * ssid - specific SSID to scan for (ProbeReq)
211 * %NULL or zero-length SSID is used to indicate active scan
212 * with wildcard SSID.
216 * ssid_len: Length of the SSID in octets
219 } ssids[WPAS_MAX_SCAN_SSIDS];
222 * num_ssids - Number of entries in ssids array
223 * Zero indicates a request for a passive scan.
228 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
233 * extra_ies_len - Length of extra_ies in octets
235 size_t extra_ies_len;
238 * freqs - Array of frequencies to scan or %NULL for all frequencies
240 * The frequency is set in MHz. The array is zero-terminated.
245 * filter_ssids - Filter for reporting SSIDs
247 * This optional parameter can be used to request the driver wrapper to
248 * filter scan results to include only the specified SSIDs. %NULL
249 * indicates that no filtering is to be done. This can be used to
250 * reduce memory needs for scan results in environments that have large
251 * number of APs with different SSIDs.
253 * The driver wrapper is allowed to take this allocated buffer into its
254 * own use by setting the pointer to %NULL. In that case, the driver
255 * wrapper is responsible for freeing the buffer with os_free() once it
256 * is not needed anymore.
258 struct wpa_driver_scan_filter {
264 * num_filter_ssids - Number of entries in filter_ssids array
266 size_t num_filter_ssids;
269 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
271 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
272 * Mbps from the support rates element(s) in the Probe Request frames
273 * and not to transmit the frames at any of those rates.
279 * struct wpa_driver_auth_params - Authentication parameters
280 * Data for struct wpa_driver_ops::authenticate().
282 struct wpa_driver_auth_params {
290 const u8 *wep_key[4];
291 size_t wep_key_len[4];
293 int local_state_change;
296 * p2p - Whether this connection is a P2P group
303 WPS_MODE_NONE /* no WPS provisioning being used */,
304 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
305 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
310 * struct wpa_driver_associate_params - Association parameters
311 * Data for struct wpa_driver_ops::associate().
313 struct wpa_driver_associate_params {
315 * bssid - BSSID of the selected AP
316 * This can be %NULL, if ap_scan=2 mode is used and the driver is
317 * responsible for selecting with which BSS to associate. */
321 * ssid - The selected SSID
326 * ssid_len - Length of the SSID (1..32)
331 * freq - Frequency of the channel the selected AP is using
332 * Frequency that the selected AP is using (in MHz as
333 * reported in the scan results)
338 * wpa_ie - WPA information element for (Re)Association Request
339 * WPA information element to be included in (Re)Association
340 * Request (including information element id and length). Use
341 * of this WPA IE is optional. If the driver generates the WPA
342 * IE, it can use pairwise_suite, group_suite, and
343 * key_mgmt_suite to select proper algorithms. In this case,
344 * the driver has to notify wpa_supplicant about the used WPA
345 * IE by generating an event that the interface code will
346 * convert into EVENT_ASSOCINFO data (see below).
348 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
349 * instead. The driver can determine which version is used by
350 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
353 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
358 * wpa_ie_len - length of the wpa_ie
363 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
365 unsigned int wpa_proto;
368 * pairwise_suite - Selected pairwise cipher suite
370 * This is usually ignored if @wpa_ie is used.
372 enum wpa_cipher pairwise_suite;
375 * group_suite - Selected group cipher suite
377 * This is usually ignored if @wpa_ie is used.
379 enum wpa_cipher group_suite;
382 * key_mgmt_suite - Selected key management suite
384 * This is usually ignored if @wpa_ie is used.
386 enum wpa_key_mgmt key_mgmt_suite;
389 * auth_alg - Allowed authentication algorithms
390 * Bit field of WPA_AUTH_ALG_*
395 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
400 * wep_key - WEP keys for static WEP configuration
402 const u8 *wep_key[4];
405 * wep_key_len - WEP key length for static WEP configuration
407 size_t wep_key_len[4];
410 * wep_tx_keyidx - WEP TX key index for static WEP configuration
415 * mgmt_frame_protection - IEEE 802.11w management frame protection
417 enum mfp_options mgmt_frame_protection;
420 * ft_ies - IEEE 802.11r / FT information elements
421 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
422 * for fast transition, this parameter is set to include the IEs that
423 * are to be sent in the next FT Authentication Request message.
424 * update_ft_ies() handler is called to update the IEs for further
425 * FT messages in the sequence.
427 * The driver should use these IEs only if the target AP is advertising
428 * the same mobility domain as the one included in the MDIE here.
430 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
431 * AP after the initial association. These IEs can only be used if the
432 * target AP is advertising support for FT and is using the same MDIE
433 * and SSID as the current AP.
435 * The driver is responsible for reporting the FT IEs received from the
436 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
437 * type. update_ft_ies() handler will then be called with the FT IEs to
438 * include in the next frame in the authentication sequence.
443 * ft_ies_len - Length of ft_ies in bytes
448 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
450 * This value is provided to allow the driver interface easier access
451 * to the current mobility domain. This value is set to %NULL if no
452 * mobility domain is currently active.
457 * passphrase - RSN passphrase for PSK
459 * This value is made available only for WPA/WPA2-Personal (PSK) and
460 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
461 * the 8..63 character ASCII passphrase, if available. Please note that
462 * this can be %NULL if passphrase was not used to generate the PSK. In
463 * that case, the psk field must be used to fetch the PSK.
465 const char *passphrase;
468 * psk - RSN PSK (alternative for passphrase for PSK)
470 * This value is made available only for WPA/WPA2-Personal (PSK) and
471 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
472 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
473 * be prepared to handle %NULL value as an error.
478 * drop_unencrypted - Enable/disable unencrypted frame filtering
480 * Configure the driver to drop all non-EAPOL frames (both receive and
481 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
482 * still be allowed for key negotiation.
484 int drop_unencrypted;
487 * prev_bssid - Previously used BSSID in this ESS
489 * When not %NULL, this is a request to use reassociation instead of
492 const u8 *prev_bssid;
497 * If the driver needs to do special configuration for WPS association,
498 * this variable provides more information on what type of association
499 * is being requested. Most drivers should not need ot use this.
504 * p2p - Whether this connection is a P2P group
509 * uapsd - UAPSD parameters for the network
510 * -1 = do not change defaults
511 * AP mode: 1 = enabled, 0 = disabled
512 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
519 HIDDEN_SSID_ZERO_LEN,
520 HIDDEN_SSID_ZERO_CONTENTS
523 struct wpa_driver_ap_params {
525 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
530 * head_len - Length of the head buffer in octets
535 * tail - Beacon tail following TIM IE
540 * tail_len - Length of the tail buffer in octets
545 * dtim_period - DTIM period
550 * beacon_int - Beacon interval
555 * ssid - The SSID to use in Beacon/Probe Response frames
560 * ssid_len - Length of the SSID (1..32)
565 * hide_ssid - Whether to hide the SSID
567 enum hide_ssid hide_ssid;
570 * pairwise_ciphers - WPA_CIPHER_* bitfield
572 unsigned int pairwise_ciphers;
575 * group_cipher - WPA_CIPHER_*
577 unsigned int group_cipher;
580 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
582 unsigned int key_mgmt_suites;
585 * auth_algs - WPA_AUTH_ALG_* bitfield
587 unsigned int auth_algs;
590 * wpa_version - WPA_PROTO_* bitfield
592 unsigned int wpa_version;
595 * privacy - Whether privacy is used in the BSS
600 * beacon_ies - WPS/P2P IE(s) for Beacon frames
602 * This is used to add IEs like WPS IE and P2P IE by drivers that do
603 * not use the full Beacon template.
605 const struct wpabuf *beacon_ies;
608 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
610 * This is used to add IEs like WPS IE and P2P IE by drivers that
611 * reply to Probe Request frames internally.
613 const struct wpabuf *proberesp_ies;
616 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
618 * This is used to add IEs like WPS IE by drivers that reply to
619 * (Re)Association Request frames internally.
621 const struct wpabuf *assocresp_ies;
624 * isolate - Whether to isolate frames between associated stations
626 * If this is non-zero, the AP is requested to disable forwarding of
627 * frames between association stations.
633 * struct wpa_driver_capa - Driver capability information
635 struct wpa_driver_capa {
636 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
637 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
638 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
639 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
640 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
641 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
642 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
643 unsigned int key_mgmt;
645 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
646 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
647 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
648 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
651 #define WPA_DRIVER_AUTH_OPEN 0x00000001
652 #define WPA_DRIVER_AUTH_SHARED 0x00000002
653 #define WPA_DRIVER_AUTH_LEAP 0x00000004
656 /* Driver generated WPA/RSN IE */
657 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
658 /* Driver needs static WEP key setup after association command */
659 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
660 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
661 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
662 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
663 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
664 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
665 /* Driver provides separate commands for authentication and association (SME in
666 * wpa_supplicant). */
667 #define WPA_DRIVER_FLAGS_SME 0x00000020
668 /* Driver supports AP mode */
669 #define WPA_DRIVER_FLAGS_AP 0x00000040
670 /* Driver needs static WEP key setup after association has been completed */
671 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
672 /* Driver takes care of P2P management operations */
673 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
674 /* Driver supports concurrent P2P operations */
675 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
677 * Driver uses the initial interface as a dedicated management interface, i.e.,
678 * it cannot be used for P2P group operations or non-P2P purposes.
680 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
681 /* This interface is P2P capable (P2P Device, GO, or P2P Client */
682 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
683 /* Driver supports concurrent operations on multiple channels */
684 #define WPA_DRIVER_FLAGS_MULTI_CHANNEL_CONCURRENT 0x00001000
686 * Driver uses the initial interface for P2P management interface and non-P2P
687 * purposes (e.g., connect to infra AP), but this interface cannot be used for
688 * P2P group operations.
690 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
692 * Driver is known to use sane error codes, i.e., when it indicates that
693 * something (e.g., association) fails, there was indeed a failure and the
694 * operation does not end up getting completed successfully later.
696 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
697 /* Driver supports off-channel TX */
698 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
699 /* Driver indicates TX status events for EAPOL Data frames */
700 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
701 /* Driver indicates TX status events for Deauth/Disassoc frames */
702 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
703 /* Driver supports roaming (BSS selection) in firmware */
704 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
708 int max_sched_scan_ssids;
709 int sched_scan_supported;
713 * max_remain_on_chan - Maximum remain-on-channel duration in msec
715 unsigned int max_remain_on_chan;
718 * max_stations - Maximum number of associated stations the driver
719 * supports in AP mode
721 unsigned int max_stations;
727 struct hostap_sta_driver_data {
728 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
729 unsigned long current_tx_rate;
730 unsigned long inactive_msec;
732 unsigned long num_ps_buf_frames;
733 unsigned long tx_retry_failed;
734 unsigned long tx_retry_count;
739 struct hostapd_sta_add_params {
743 const u8 *supp_rates;
744 size_t supp_rates_len;
746 const struct ieee80211_ht_capabilities *ht_capabilities;
747 u32 flags; /* bitmask of WPA_STA_* flags */
750 struct hostapd_freq_params {
755 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
756 * secondary channel below primary, 1 = HT40
757 * enabled, secondary channel above primary */
760 enum wpa_driver_if_type {
762 * WPA_IF_STATION - Station mode interface
767 * WPA_IF_AP_VLAN - AP mode VLAN interface
769 * This interface shares its address and Beacon frame with the main
775 * WPA_IF_AP_BSS - AP mode BSS interface
777 * This interface has its own address and Beacon frame.
782 * WPA_IF_P2P_GO - P2P Group Owner
787 * WPA_IF_P2P_CLIENT - P2P Client
792 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
793 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
798 struct wpa_init_params {
803 const char *test_socket;
804 int use_pae_group_addr;
808 u8 *own_addr; /* buffer for writing own MAC address */
812 struct wpa_bss_params {
813 /** Interface name (for multi-SSID/VLAN support) */
815 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
824 enum mfp_options ieee80211w;
827 #define WPA_STA_AUTHORIZED BIT(0)
828 #define WPA_STA_WMM BIT(1)
829 #define WPA_STA_SHORT_PREAMBLE BIT(2)
830 #define WPA_STA_MFP BIT(3)
833 * struct p2p_params - P2P parameters for driver-based P2P management
836 const char *dev_name;
838 #define DRV_MAX_SEC_DEV_TYPES 5
839 u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8];
840 size_t num_sec_dev_types;
854 * struct wpa_signal_info - Information about channel signal quality
856 struct wpa_signal_info {
865 * struct wpa_driver_ops - Driver interface API definition
867 * This structure defines the API that each driver interface needs to implement
868 * for core wpa_supplicant code. All driver specific functionality is captured
871 struct wpa_driver_ops {
872 /** Name of the driver interface */
874 /** One line description of the driver interface */
878 * get_bssid - Get the current BSSID
879 * @priv: private driver interface data
880 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
882 * Returns: 0 on success, -1 on failure
884 * Query kernel driver for the current BSSID and copy it to bssid.
885 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
888 int (*get_bssid)(void *priv, u8 *bssid);
891 * get_ssid - Get the current SSID
892 * @priv: private driver interface data
893 * @ssid: buffer for SSID (at least 32 bytes)
895 * Returns: Length of the SSID on success, -1 on failure
897 * Query kernel driver for the current SSID and copy it to ssid.
898 * Returning zero is recommended if the STA is not associated.
900 * Note: SSID is an array of octets, i.e., it is not nul terminated and
901 * can, at least in theory, contain control characters (including nul)
902 * and as such, should be processed as binary data, not a printable
905 int (*get_ssid)(void *priv, u8 *ssid);
908 * set_key - Configure encryption key
909 * @ifname: Interface name (for multi-SSID/VLAN support)
910 * @priv: private driver interface data
911 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
912 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
913 * %WPA_ALG_NONE clears the key.
914 * @addr: Address of the peer STA (BSSID of the current AP when setting
915 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
916 * broadcast keys, %NULL for default keys that are used both for
917 * broadcast and unicast; when clearing keys, %NULL is used to
918 * indicate that both the broadcast-only and default key of the
919 * specified key index is to be cleared
920 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
922 * @set_tx: configure this key as the default Tx key (only used when
923 * driver does not support separate unicast/individual key
924 * @seq: sequence number/packet number, seq_len octets, the next
925 * packet number to be used for in replay protection; configured
926 * for Rx keys (in most cases, this is only used with broadcast
927 * keys and set to zero for unicast keys); %NULL if not set
928 * @seq_len: length of the seq, depends on the algorithm:
929 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
930 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
932 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
933 * TKIP: 32, CCMP: 16, IGTK: 16)
935 * Returns: 0 on success, -1 on failure
937 * Configure the given key for the kernel driver. If the driver
938 * supports separate individual keys (4 default keys + 1 individual),
939 * addr can be used to determine whether the key is default or
940 * individual. If only 4 keys are supported, the default key with key
941 * index 0 is used as the individual key. STA must be configured to use
942 * it as the default Tx key (set_tx is set) and accept Rx for all the
943 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
944 * broadcast keys, so key index 0 is available for this kind of
947 * Please note that TKIP keys include separate TX and RX MIC keys and
948 * some drivers may expect them in different order than wpa_supplicant
949 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
950 * will trigger Michael MIC errors. This can be fixed by changing the
951 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
952 * in driver_*.c set_key() implementation, see driver_ndis.c for an
953 * example on how this can be done.
955 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
956 const u8 *addr, int key_idx, int set_tx,
957 const u8 *seq, size_t seq_len,
958 const u8 *key, size_t key_len);
961 * init - Initialize driver interface
962 * @ctx: context to be used when calling wpa_supplicant functions,
963 * e.g., wpa_supplicant_event()
964 * @ifname: interface name, e.g., wlan0
966 * Returns: Pointer to private data, %NULL on failure
968 * Initialize driver interface, including event processing for kernel
969 * driver events (e.g., associated, scan results, Michael MIC failure).
970 * This function can allocate a private configuration data area for
971 * @ctx, file descriptor, interface name, etc. information that may be
972 * needed in future driver operations. If this is not used, non-NULL
973 * value will need to be returned because %NULL is used to indicate
974 * failure. The returned value will be used as 'void *priv' data for
975 * all other driver_ops functions.
977 * The main event loop (eloop.c) of wpa_supplicant can be used to
978 * register callback for read sockets (eloop_register_read_sock()).
980 * See below for more information about events and
981 * wpa_supplicant_event() function.
983 void * (*init)(void *ctx, const char *ifname);
986 * deinit - Deinitialize driver interface
987 * @priv: private driver interface data from init()
989 * Shut down driver interface and processing of driver events. Free
990 * private data buffer if one was allocated in init() handler.
992 void (*deinit)(void *priv);
995 * set_param - Set driver configuration parameters
996 * @priv: private driver interface data from init()
997 * @param: driver specific configuration parameters
999 * Returns: 0 on success, -1 on failure
1001 * Optional handler for notifying driver interface about configuration
1002 * parameters (driver_param).
1004 int (*set_param)(void *priv, const char *param);
1007 * set_countermeasures - Enable/disable TKIP countermeasures
1008 * @priv: private driver interface data
1009 * @enabled: 1 = countermeasures enabled, 0 = disabled
1011 * Returns: 0 on success, -1 on failure
1013 * Configure TKIP countermeasures. When these are enabled, the driver
1014 * should drop all received and queued frames that are using TKIP.
1016 int (*set_countermeasures)(void *priv, int enabled);
1019 * deauthenticate - Request driver to deauthenticate
1020 * @priv: private driver interface data
1021 * @addr: peer address (BSSID of the AP)
1022 * @reason_code: 16-bit reason code to be sent in the deauthentication
1025 * Returns: 0 on success, -1 on failure
1027 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1030 * disassociate - Request driver to disassociate
1031 * @priv: private driver interface data
1032 * @addr: peer address (BSSID of the AP)
1033 * @reason_code: 16-bit reason code to be sent in the disassociation
1036 * Returns: 0 on success, -1 on failure
1038 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
1041 * associate - Request driver to associate
1042 * @priv: private driver interface data
1043 * @params: association parameters
1045 * Returns: 0 on success, -1 on failure
1047 int (*associate)(void *priv,
1048 struct wpa_driver_associate_params *params);
1051 * add_pmkid - Add PMKSA cache entry to the driver
1052 * @priv: private driver interface data
1053 * @bssid: BSSID for the PMKSA cache entry
1054 * @pmkid: PMKID for the PMKSA cache entry
1056 * Returns: 0 on success, -1 on failure
1058 * This function is called when a new PMK is received, as a result of
1059 * either normal authentication or RSN pre-authentication.
1061 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1062 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1063 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1064 * driver_ops function does not need to be implemented. Likewise, if
1065 * the driver does not support WPA, this function is not needed.
1067 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1070 * remove_pmkid - Remove PMKSA cache entry to the driver
1071 * @priv: private driver interface data
1072 * @bssid: BSSID for the PMKSA cache entry
1073 * @pmkid: PMKID for the PMKSA cache entry
1075 * Returns: 0 on success, -1 on failure
1077 * This function is called when the supplicant drops a PMKSA cache
1078 * entry for any reason.
1080 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1081 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1082 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1083 * from wpa_supplicant, this driver_ops function does not need to be
1084 * implemented. Likewise, if the driver does not support WPA, this
1085 * function is not needed.
1087 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1090 * flush_pmkid - Flush PMKSA cache
1091 * @priv: private driver interface data
1093 * Returns: 0 on success, -1 on failure
1095 * This function is called when the supplicant drops all PMKSA cache
1096 * entries for any reason.
1098 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1099 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1100 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1101 * from wpa_supplicant, this driver_ops function does not need to be
1102 * implemented. Likewise, if the driver does not support WPA, this
1103 * function is not needed.
1105 int (*flush_pmkid)(void *priv);
1108 * get_capa - Get driver capabilities
1109 * @priv: private driver interface data
1111 * Returns: 0 on success, -1 on failure
1113 * Get driver/firmware/hardware capabilities.
1115 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1118 * poll - Poll driver for association information
1119 * @priv: private driver interface data
1121 * This is an option callback that can be used when the driver does not
1122 * provide event mechanism for association events. This is called when
1123 * receiving WPA EAPOL-Key messages that require association
1124 * information. The driver interface is supposed to generate associnfo
1125 * event before returning from this callback function. In addition, the
1126 * driver interface should generate an association event after having
1127 * sent out associnfo.
1129 void (*poll)(void *priv);
1132 * get_ifname - Get interface name
1133 * @priv: private driver interface data
1135 * Returns: Pointer to the interface name. This can differ from the
1136 * interface name used in init() call. Init() is called first.
1138 * This optional function can be used to allow the driver interface to
1139 * replace the interface name with something else, e.g., based on an
1140 * interface mapping from a more descriptive name.
1142 const char * (*get_ifname)(void *priv);
1145 * get_mac_addr - Get own MAC address
1146 * @priv: private driver interface data
1148 * Returns: Pointer to own MAC address or %NULL on failure
1150 * This optional function can be used to get the own MAC address of the
1151 * device from the driver interface code. This is only needed if the
1152 * l2_packet implementation for the OS does not provide easy access to
1154 const u8 * (*get_mac_addr)(void *priv);
1157 * send_eapol - Optional function for sending EAPOL packets
1158 * @priv: private driver interface data
1159 * @dest: Destination MAC address
1161 * @data: EAPOL packet starting with IEEE 802.1X header
1162 * @data_len: Size of the EAPOL packet
1164 * Returns: 0 on success, -1 on failure
1166 * This optional function can be used to override l2_packet operations
1167 * with driver specific functionality. If this function pointer is set,
1168 * l2_packet module is not used at all and the driver interface code is
1169 * responsible for receiving and sending all EAPOL packets. The
1170 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1171 * event. The driver interface is required to implement get_mac_addr()
1172 * handler if send_eapol() is used.
1174 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1175 const u8 *data, size_t data_len);
1178 * set_operstate - Sets device operating state to DORMANT or UP
1179 * @priv: private driver interface data
1180 * @state: 0 = dormant, 1 = up
1181 * Returns: 0 on success, -1 on failure
1183 * This is an optional function that can be used on operating systems
1184 * that support a concept of controlling network device state from user
1185 * space applications. This function, if set, gets called with
1186 * state = 1 when authentication has been completed and with state = 0
1187 * when connection is lost.
1189 int (*set_operstate)(void *priv, int state);
1192 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1193 * @priv: Private driver interface data
1194 * @addr: Address of the station for which to set protection (may be
1195 * %NULL for group keys)
1196 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1197 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1198 * Returns: 0 on success, -1 on failure
1200 * This is an optional function that can be used to set the driver to
1201 * require protection for Tx and/or Rx frames. This uses the layer
1202 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1203 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1204 * set protection operation; instead, they set protection implicitly
1205 * based on configured keys.
1207 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1211 * get_hw_feature_data - Get hardware support data (channels and rates)
1212 * @priv: Private driver interface data
1213 * @num_modes: Variable for returning the number of returned modes
1214 * flags: Variable for returning hardware feature flags
1215 * Returns: Pointer to allocated hardware data on success or %NULL on
1216 * failure. Caller is responsible for freeing this.
1218 * This function is only needed for drivers that export MLME
1219 * (management frame processing) to %wpa_supplicant or hostapd.
1221 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1226 * set_channel - Set channel
1227 * @priv: Private driver interface data
1228 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
1229 * @chan: IEEE 802.11 channel number
1230 * @freq: Frequency of the channel in MHz
1231 * Returns: 0 on success, -1 on failure
1233 * This function is only needed for drivers that export MLME
1234 * (management frame processing) to wpa_supplicant.
1236 int (*set_channel)(void *priv, enum hostapd_hw_mode phymode, int chan,
1240 * set_ssid - Set SSID
1241 * @priv: Private driver interface data
1243 * @ssid_len: SSID length
1244 * Returns: 0 on success, -1 on failure
1246 * This function is only needed for drivers that export MLME
1247 * (management frame processing) to wpa_supplicant.
1249 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
1252 * set_bssid - Set BSSID
1253 * @priv: Private driver interface data
1255 * Returns: 0 on success, -1 on failure
1257 * This function is only needed for drivers that export MLME
1258 * (management frame processing) to wpa_supplicant.
1260 int (*set_bssid)(void *priv, const u8 *bssid);
1263 * send_mlme - Send management frame from MLME
1264 * @priv: Private driver interface data
1265 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1266 * @data_len: Size of the management frame
1267 * Returns: 0 on success, -1 on failure
1269 * This function is only needed for drivers that export MLME
1270 * (management frame processing) to wpa_supplicant.
1272 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
1275 * mlme_add_sta - Add a STA entry into the driver/netstack
1276 * @priv: Private driver interface data
1277 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1278 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
1279 * format (one octet per rate, 1 = 0.5 Mbps)
1280 * @supp_rates_len: Number of entries in supp_rates
1281 * Returns: 0 on success, -1 on failure
1283 * This function is only needed for drivers that export MLME
1284 * (management frame processing) to wpa_supplicant. When the MLME code
1285 * completes association with an AP, this function is called to
1286 * configure the driver/netstack with a STA entry for data frame
1287 * processing (TX rate control, encryption/decryption).
1289 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
1290 size_t supp_rates_len);
1293 * mlme_remove_sta - Remove a STA entry from the driver/netstack
1294 * @priv: Private driver interface data
1295 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1296 * Returns: 0 on success, -1 on failure
1298 * This function is only needed for drivers that export MLME
1299 * (management frame processing) to wpa_supplicant.
1301 int (*mlme_remove_sta)(void *priv, const u8 *addr);
1304 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1305 * @priv: Private driver interface data
1306 * @md: Mobility domain (2 octets) (also included inside ies)
1307 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1308 * @ies_len: Length of FT IEs in bytes
1309 * Returns: 0 on success, -1 on failure
1311 * The supplicant uses this callback to let the driver know that keying
1312 * material for FT is available and that the driver can use the
1313 * provided IEs in the next message in FT authentication sequence.
1315 * This function is only needed for driver that support IEEE 802.11r
1316 * (Fast BSS Transition).
1318 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1322 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1323 * @priv: Private driver interface data
1324 * @action: Action field value
1325 * @target_ap: Target AP address
1326 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1327 * @ies_len: Length of FT IEs in bytes
1328 * Returns: 0 on success, -1 on failure
1330 * The supplicant uses this callback to request the driver to transmit
1331 * an FT Action frame (action category 6) for over-the-DS fast BSS
1334 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1335 const u8 *ies, size_t ies_len);
1338 * get_scan_results2 - Fetch the latest scan results
1339 * @priv: private driver interface data
1341 * Returns: Allocated buffer of scan results (caller is responsible for
1342 * freeing the data structure) on success, NULL on failure
1344 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1347 * set_country - Set country
1348 * @priv: Private driver interface data
1349 * @alpha2: country to which to switch to
1350 * Returns: 0 on success, -1 on failure
1352 * This function is for drivers which support some form
1353 * of setting a regulatory domain.
1355 int (*set_country)(void *priv, const char *alpha2);
1358 * global_init - Global driver initialization
1359 * Returns: Pointer to private data (global), %NULL on failure
1361 * This optional function is called to initialize the driver wrapper
1362 * for global data, i.e., data that applies to all interfaces. If this
1363 * function is implemented, global_deinit() will also need to be
1364 * implemented to free the private data. The driver will also likely
1365 * use init2() function instead of init() to get the pointer to global
1366 * data available to per-interface initializer.
1368 void * (*global_init)(void);
1371 * global_deinit - Global driver deinitialization
1372 * @priv: private driver global data from global_init()
1374 * Terminate any global driver related functionality and free the
1375 * global data structure.
1377 void (*global_deinit)(void *priv);
1380 * init2 - Initialize driver interface (with global data)
1381 * @ctx: context to be used when calling wpa_supplicant functions,
1382 * e.g., wpa_supplicant_event()
1383 * @ifname: interface name, e.g., wlan0
1384 * @global_priv: private driver global data from global_init()
1385 * Returns: Pointer to private data, %NULL on failure
1387 * This function can be used instead of init() if the driver wrapper
1390 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1393 * get_interfaces - Get information about available interfaces
1394 * @global_priv: private driver global data from global_init()
1395 * Returns: Allocated buffer of interface information (caller is
1396 * responsible for freeing the data structure) on success, NULL on
1399 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1402 * scan2 - Request the driver to initiate scan
1403 * @priv: private driver interface data
1404 * @params: Scan parameters
1406 * Returns: 0 on success, -1 on failure
1408 * Once the scan results are ready, the driver should report scan
1409 * results event for wpa_supplicant which will eventually request the
1410 * results with wpa_driver_get_scan_results2().
1412 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1415 * authenticate - Request driver to authenticate
1416 * @priv: private driver interface data
1417 * @params: authentication parameters
1418 * Returns: 0 on success, -1 on failure
1420 * This is an optional function that can be used with drivers that
1421 * support separate authentication and association steps, i.e., when
1422 * wpa_supplicant can act as the SME. If not implemented, associate()
1423 * function is expected to take care of IEEE 802.11 authentication,
1426 int (*authenticate)(void *priv,
1427 struct wpa_driver_auth_params *params);
1430 * set_ap - Set Beacon and Probe Response information for AP mode
1431 * @priv: Private driver interface data
1432 * @params: Parameters to use in AP mode
1434 * This function is used to configure Beacon template and/or extra IEs
1435 * to add for Beacon and Probe Response frames for the driver in
1436 * AP mode. The driver is responsible for building the full Beacon
1437 * frame by concatenating the head part with TIM IE generated by the
1438 * driver/firmware and finishing with the tail part. Depending on the
1439 * driver architectue, this can be done either by using the full
1440 * template or the set of additional IEs (e.g., WPS and P2P IE).
1441 * Similarly, Probe Response processing depends on the driver design.
1442 * If the driver (or firmware) takes care of replying to Probe Request
1443 * frames, the extra IEs provided here needs to be added to the Probe
1446 * Returns: 0 on success, -1 on failure
1448 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1451 * hapd_init - Initialize driver interface (hostapd only)
1452 * @hapd: Pointer to hostapd context
1453 * @params: Configuration for the driver wrapper
1454 * Returns: Pointer to private data, %NULL on failure
1456 * This function is used instead of init() or init2() when the driver
1457 * wrapper is used with hostapd.
1459 void * (*hapd_init)(struct hostapd_data *hapd,
1460 struct wpa_init_params *params);
1463 * hapd_deinit - Deinitialize driver interface (hostapd only)
1464 * @priv: Private driver interface data from hapd_init()
1466 void (*hapd_deinit)(void *priv);
1469 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1470 * @priv: Private driver interface data
1471 * @params: BSS parameters
1472 * Returns: 0 on success, -1 on failure
1474 * This is an optional function to configure the kernel driver to
1475 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1476 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1477 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1478 * for Beacon frames.
1480 * DEPRECATED - use set_ap() instead
1482 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1485 * set_privacy - Enable/disable privacy (AP only)
1486 * @priv: Private driver interface data
1487 * @enabled: 1 = privacy enabled, 0 = disabled
1488 * Returns: 0 on success, -1 on failure
1490 * This is an optional function to configure privacy field in the
1491 * kernel driver for Beacon frames. This can be left undefined (set to
1492 * %NULL) if the driver uses the Beacon template from set_ap().
1494 * DEPRECATED - use set_ap() instead
1496 int (*set_privacy)(void *priv, int enabled);
1499 * get_seqnum - Fetch the current TSC/packet number (AP only)
1500 * @ifname: The interface name (main or virtual)
1501 * @priv: Private driver interface data
1502 * @addr: MAC address of the station or %NULL for group keys
1504 * @seq: Buffer for returning the latest used TSC/packet number
1505 * Returns: 0 on success, -1 on failure
1507 * This function is used to fetch the last used TSC/packet number for
1508 * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so
1509 * there is no strict requirement on implementing support for unicast
1510 * keys (i.e., addr != %NULL).
1512 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1516 * flush - Flush all association stations (AP only)
1517 * @priv: Private driver interface data
1518 * Returns: 0 on success, -1 on failure
1520 * This function requests the driver to disassociate all associated
1521 * stations. This function does not need to be implemented if the
1522 * driver does not process association frames internally.
1524 int (*flush)(void *priv);
1527 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1528 * @priv: Private driver interface data
1529 * @elem: Information elements
1530 * @elem_len: Length of the elem buffer in octets
1531 * Returns: 0 on success, -1 on failure
1533 * This is an optional function to add information elements in the
1534 * kernel driver for Beacon and Probe Response frames. This can be left
1535 * undefined (set to %NULL) if the driver uses the Beacon template from
1538 * DEPRECATED - use set_ap() instead
1540 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1543 * read_sta_data - Fetch station data (AP only)
1544 * @priv: Private driver interface data
1545 * @data: Buffer for returning station information
1546 * @addr: MAC address of the station
1547 * Returns: 0 on success, -1 on failure
1549 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1553 * hapd_send_eapol - Send an EAPOL packet (AP only)
1554 * @priv: private driver interface data
1555 * @addr: Destination MAC address
1556 * @data: EAPOL packet starting with IEEE 802.1X header
1557 * @data_len: Length of the EAPOL packet in octets
1558 * @encrypt: Whether the frame should be encrypted
1559 * @own_addr: Source MAC address
1560 * @flags: WPA_STA_* flags for the destination station
1562 * Returns: 0 on success, -1 on failure
1564 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1565 size_t data_len, int encrypt,
1566 const u8 *own_addr, u32 flags);
1569 * sta_deauth - Deauthenticate a station (AP only)
1570 * @priv: Private driver interface data
1571 * @own_addr: Source address and BSSID for the Deauthentication frame
1572 * @addr: MAC address of the station to deauthenticate
1573 * @reason: Reason code for the Deauthentiation frame
1574 * Returns: 0 on success, -1 on failure
1576 * This function requests a specific station to be deauthenticated and
1577 * a Deauthentication frame to be sent to it.
1579 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1583 * sta_disassoc - Disassociate a station (AP only)
1584 * @priv: Private driver interface data
1585 * @own_addr: Source address and BSSID for the Disassociation frame
1586 * @addr: MAC address of the station to disassociate
1587 * @reason: Reason code for the Disassociation frame
1588 * Returns: 0 on success, -1 on failure
1590 * This function requests a specific station to be disassociated and
1591 * a Disassociation frame to be sent to it.
1593 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1597 * sta_remove - Remove a station entry (AP only)
1598 * @priv: Private driver interface data
1599 * @addr: MAC address of the station to be removed
1600 * Returns: 0 on success, -1 on failure
1602 int (*sta_remove)(void *priv, const u8 *addr);
1605 * hapd_get_ssid - Get the current SSID (AP only)
1606 * @priv: Private driver interface data
1607 * @buf: Buffer for returning the SSID
1608 * @len: Maximum length of the buffer
1609 * Returns: Length of the SSID on success, -1 on failure
1611 * This function need not be implemented if the driver uses Beacon
1612 * template from set_ap() and does not reply to Probe Request frames.
1614 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1617 * hapd_set_ssid - Set SSID (AP only)
1618 * @priv: Private driver interface data
1620 * @len: Length of the SSID in octets
1621 * Returns: 0 on success, -1 on failure
1623 * DEPRECATED - use set_ap() instead
1625 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1628 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1629 * @priv: Private driver interface data
1630 * @enabled: 1 = countermeasures enabled, 0 = disabled
1631 * Returns: 0 on success, -1 on failure
1633 * This need not be implemented if the driver does not take care of
1634 * association processing.
1636 int (*hapd_set_countermeasures)(void *priv, int enabled);
1639 * sta_add - Add a station entry
1640 * @priv: Private driver interface data
1641 * @params: Station parameters
1642 * Returns: 0 on success, -1 on failure
1644 * This function is used to add a station entry to the driver once the
1645 * station has completed association. This is only used if the driver
1646 * does not take care of association processing.
1648 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1651 * get_inact_sec - Get station inactivity duration (AP only)
1652 * @priv: Private driver interface data
1653 * @addr: Station address
1654 * Returns: Number of seconds station has been inactive, -1 on failure
1656 int (*get_inact_sec)(void *priv, const u8 *addr);
1659 * sta_clear_stats - Clear station statistics (AP only)
1660 * @priv: Private driver interface data
1661 * @addr: Station address
1662 * Returns: 0 on success, -1 on failure
1664 int (*sta_clear_stats)(void *priv, const u8 *addr);
1667 * set_freq - Set channel/frequency (AP only)
1668 * @priv: Private driver interface data
1669 * @freq: Channel parameters
1670 * Returns: 0 on success, -1 on failure
1672 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1675 * set_rts - Set RTS threshold
1676 * @priv: Private driver interface data
1677 * @rts: RTS threshold in octets
1678 * Returns: 0 on success, -1 on failure
1680 int (*set_rts)(void *priv, int rts);
1683 * set_frag - Set fragmentation threshold
1684 * @priv: Private driver interface data
1685 * @frag: Fragmentation threshold in octets
1686 * Returns: 0 on success, -1 on failure
1688 int (*set_frag)(void *priv, int frag);
1691 * sta_set_flags - Set station flags (AP only)
1692 * @priv: Private driver interface data
1693 * @addr: Station address
1694 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1695 * @flags_or: Bitmap of WPA_STA_* flags to add
1696 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1697 * Returns: 0 on success, -1 on failure
1699 int (*sta_set_flags)(void *priv, const u8 *addr,
1700 int total_flags, int flags_or, int flags_and);
1703 * set_rate_sets - Set supported and basic rate sets (AP only)
1704 * @priv: Private driver interface data
1705 * @supp_rates: -1 terminated array of supported rates in 100 kbps
1706 * @basic_rates: -1 terminated array of basic rates in 100 kbps
1707 * @mode: hardware mode (HOSTAPD_MODE_*)
1708 * Returns: 0 on success, -1 on failure
1710 int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
1714 * set_cts_protect - Set CTS protection mode (AP only)
1715 * @priv: Private driver interface data
1716 * @value: Whether CTS protection is enabled
1717 * Returns: 0 on success, -1 on failure
1719 int (*set_cts_protect)(void *priv, int value);
1722 * set_preamble - Set preamble mode (AP only)
1723 * @priv: Private driver interface data
1724 * @value: Whether short preamble is enabled
1725 * Returns: 0 on success, -1 on failure
1727 int (*set_preamble)(void *priv, int value);
1730 * set_short_slot_time - Set short slot time (AP only)
1731 * @priv: Private driver interface data
1732 * @value: Whether short slot time is enabled
1733 * Returns: 0 on success, -1 on failure
1735 int (*set_short_slot_time)(void *priv, int value);
1738 * set_tx_queue_params - Set TX queue parameters
1739 * @priv: Private driver interface data
1740 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
1744 * @burst_time: Maximum length for bursting in 0.1 msec units
1746 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1747 int cw_max, int burst_time);
1750 * valid_bss_mask - Validate BSSID mask
1751 * @priv: Private driver interface data
1754 * Returns: 0 if mask is valid, -1 if mask is not valid, 1 if mask can
1755 * be used, but the main interface address must be the first address in
1756 * the block if mask is applied
1758 int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
1761 * if_add - Add a virtual interface
1762 * @priv: Private driver interface data
1763 * @type: Interface type
1764 * @ifname: Interface name for the new virtual interface
1765 * @addr: Local address to use for the interface or %NULL to use the
1766 * parent interface address
1767 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1768 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1769 * not allowed (applies only to %WPA_IF_AP_BSS type)
1770 * @force_ifname: Buffer for returning an interface name that the
1771 * driver ended up using if it differs from the requested ifname
1772 * @if_addr: Buffer for returning the allocated interface address
1773 * (this may differ from the requested addr if the driver cannot
1774 * change interface address)
1775 * @bridge: Bridge interface to use or %NULL if no bridge configured
1776 * Returns: 0 on success, -1 on failure
1778 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1779 const char *ifname, const u8 *addr, void *bss_ctx,
1780 void **drv_priv, char *force_ifname, u8 *if_addr,
1781 const char *bridge);
1784 * if_remove - Remove a virtual interface
1785 * @priv: Private driver interface data
1786 * @type: Interface type
1787 * @ifname: Interface name of the virtual interface to be removed
1788 * Returns: 0 on success, -1 on failure
1790 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1791 const char *ifname);
1794 * set_sta_vlan - Bind a station into a specific interface (AP only)
1795 * @priv: Private driver interface data
1796 * @ifname: Interface (main or virtual BSS or VLAN)
1797 * @addr: MAC address of the associated station
1799 * Returns: 0 on success, -1 on failure
1801 * This function is used to bind a station to a specific virtual
1802 * interface. It is only used if when virtual interfaces are supported,
1803 * e.g., to assign stations to different VLAN interfaces based on
1804 * information from a RADIUS server. This allows separate broadcast
1805 * domains to be used with a single BSS.
1807 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1811 * commit - Optional commit changes handler (AP only)
1812 * @priv: driver private data
1813 * Returns: 0 on success, -1 on failure
1815 * This optional handler function can be registered if the driver
1816 * interface implementation needs to commit changes (e.g., by setting
1817 * network interface up) at the end of initial configuration. If set,
1818 * this handler will be called after initial setup has been completed.
1820 int (*commit)(void *priv);
1823 * send_ether - Send an ethernet packet (AP only)
1824 * @priv: private driver interface data
1825 * @dst: Destination MAC address
1826 * @src: Source MAC address
1828 * @data: EAPOL packet starting with IEEE 802.1X header
1829 * @data_len: Length of the EAPOL packet in octets
1830 * Returns: 0 on success, -1 on failure
1832 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1833 const u8 *data, size_t data_len);
1836 * set_radius_acl_auth - Notification of RADIUS ACL change
1837 * @priv: Private driver interface data
1838 * @mac: MAC address of the station
1839 * @accepted: Whether the station was accepted
1840 * @session_timeout: Session timeout for the station
1841 * Returns: 0 on success, -1 on failure
1843 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1844 u32 session_timeout);
1847 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1848 * @priv: Private driver interface data
1849 * @mac: MAC address of the station
1850 * Returns: 0 on success, -1 on failure
1852 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1855 * set_ht_params - Set HT parameters (AP only)
1856 * @priv: Private driver interface data
1857 * @ht_capab: HT Capabilities IE
1858 * @ht_capab_len: Length of ht_capab in octets
1859 * @ht_oper: HT Operation IE
1860 * @ht_oper_len: Length of ht_oper in octets
1861 * Returns: 0 on success, -1 on failure
1863 int (*set_ht_params)(void *priv,
1864 const u8 *ht_capab, size_t ht_capab_len,
1865 const u8 *ht_oper, size_t ht_oper_len);
1868 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
1869 * @priv: Private driver interface data
1870 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
1871 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
1873 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
1874 * to remove extra IE(s)
1875 * Returns: 0 on success, -1 on failure
1877 * This is an optional function to add WPS IE in the kernel driver for
1878 * Beacon and Probe Response frames. This can be left undefined (set
1879 * to %NULL) if the driver uses the Beacon template from set_ap()
1880 * and does not process Probe Request frames. If the driver takes care
1881 * of (Re)Association frame processing, the assocresp buffer includes
1882 * WPS IE(s) that need to be added to (Re)Association Response frames
1883 * whenever a (Re)Association Request frame indicated use of WPS.
1885 * This will also be used to add P2P IE(s) into Beacon/Probe Response
1886 * frames when operating as a GO. The driver is responsible for adding
1887 * timing related attributes (e.g., NoA) in addition to the IEs
1888 * included here by appending them after these buffers. This call is
1889 * also used to provide Probe Response IEs for P2P Listen state
1890 * operations for drivers that generate the Probe Response frames
1893 * DEPRECATED - use set_ap() instead
1895 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
1896 const struct wpabuf *proberesp,
1897 const struct wpabuf *assocresp);
1900 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1901 * @priv: Private driver interface data
1902 * @authorized: Whether the port is authorized
1903 * Returns: 0 on success, -1 on failure
1905 int (*set_supp_port)(void *priv, int authorized);
1908 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1909 * @priv: Private driver interface data
1910 * @addr: MAC address of the associated station
1911 * @aid: Association ID
1912 * @val: 1 = bind to 4-address WDS; 0 = unbind
1913 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
1914 * to indicate that bridge is not to be used
1915 * Returns: 0 on success, -1 on failure
1917 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
1918 const char *bridge_ifname);
1921 * send_action - Transmit an Action frame
1922 * @priv: Private driver interface data
1923 * @freq: Frequency (in MHz) of the channel
1924 * @wait: Time to wait off-channel for a response (in ms), or zero
1925 * @dst: Destination MAC address (Address 1)
1926 * @src: Source MAC address (Address 2)
1927 * @bssid: BSSID (Address 3)
1929 * @data_len: data length in octets
1930 * Returns: 0 on success, -1 on failure
1932 * This command can be used to request the driver to transmit an action
1933 * frame to the specified destination.
1935 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
1936 * be transmitted on the given channel and the device will wait for a
1937 * response on that channel for the given wait time.
1939 * If the flag is not set, the wait time will be ignored. In this case,
1940 * if a remain-on-channel duration is in progress, the frame must be
1941 * transmitted on that channel; alternatively the frame may be sent on
1942 * the current operational channel (if in associated state in station
1943 * mode or while operating as an AP.)
1945 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
1946 const u8 *dst, const u8 *src, const u8 *bssid,
1947 const u8 *data, size_t data_len);
1950 * send_action_cancel_wait - Cancel action frame TX wait
1951 * @priv: Private driver interface data
1953 * This command cancels the wait time associated with sending an action
1954 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
1955 * set in the driver flags.
1957 void (*send_action_cancel_wait)(void *priv);
1960 * remain_on_channel - Remain awake on a channel
1961 * @priv: Private driver interface data
1962 * @freq: Frequency (in MHz) of the channel
1963 * @duration: Duration in milliseconds
1964 * Returns: 0 on success, -1 on failure
1966 * This command is used to request the driver to remain awake on the
1967 * specified channel for the specified duration and report received
1968 * Action frames with EVENT_RX_ACTION events. Optionally, received
1969 * Probe Request frames may also be requested to be reported by calling
1970 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
1972 * The driver may not be at the requested channel when this function
1973 * returns, i.e., the return code is only indicating whether the
1974 * request was accepted. The caller will need to wait until the
1975 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
1976 * completed the channel change. This may take some time due to other
1977 * need for the radio and the caller should be prepared to timing out
1978 * its wait since there are no guarantees on when this request can be
1981 int (*remain_on_channel)(void *priv, unsigned int freq,
1982 unsigned int duration);
1985 * cancel_remain_on_channel - Cancel remain-on-channel operation
1986 * @priv: Private driver interface data
1988 * This command can be used to cancel a remain-on-channel operation
1989 * before its originally requested duration has passed. This could be
1990 * used, e.g., when remain_on_channel() is used to request extra time
1991 * to receive a response to an Action frame and the response is
1992 * received when there is still unneeded time remaining on the
1993 * remain-on-channel operation.
1995 int (*cancel_remain_on_channel)(void *priv);
1998 * probe_req_report - Request Probe Request frames to be indicated
1999 * @priv: Private driver interface data
2000 * @report: Whether to report received Probe Request frames
2001 * Returns: 0 on success, -1 on failure (or if not supported)
2003 * This command can be used to request the driver to indicate when
2004 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2005 * Since this operation may require extra resources, e.g., due to less
2006 * optimal hardware/firmware RX filtering, many drivers may disable
2007 * Probe Request reporting at least in station mode. This command is
2008 * used to notify the driver when the Probe Request frames need to be
2009 * reported, e.g., during remain-on-channel operations.
2011 int (*probe_req_report)(void *priv, int report);
2014 * disable_11b_rates - Set whether IEEE 802.11b rates are used for TX
2015 * @priv: Private driver interface data
2016 * @disabled: Whether IEEE 802.11b rates are disabled
2017 * Returns: 0 on success, -1 on failure (or if not supported)
2019 * This command is used to disable IEEE 802.11b rates (1, 2, 5.5, and
2020 * 11 Mbps) as TX rates for data and management frames. This can be
2021 * used to optimize channel use when there is no need to support IEEE
2022 * 802.11b-only devices.
2024 int (*disable_11b_rates)(void *priv, int disabled);
2027 * deinit_ap - Deinitialize AP mode
2028 * @priv: Private driver interface data
2029 * Returns: 0 on success, -1 on failure (or if not supported)
2031 * This optional function can be used to disable AP mode related
2032 * configuration and change the driver mode to station mode to allow
2033 * normal station operations like scanning to be completed.
2035 int (*deinit_ap)(void *priv);
2038 * suspend - Notification on system suspend/hibernate event
2039 * @priv: Private driver interface data
2041 void (*suspend)(void *priv);
2044 * resume - Notification on system resume/thaw event
2045 * @priv: Private driver interface data
2047 void (*resume)(void *priv);
2050 * signal_monitor - Set signal monitoring parameters
2051 * @priv: Private driver interface data
2052 * @threshold: Threshold value for signal change events; 0 = disabled
2053 * @hysteresis: Minimum change in signal strength before indicating a
2055 * Returns: 0 on success, -1 on failure (or if not supported)
2057 * This function can be used to configure monitoring of signal strength
2058 * with the current AP. Whenever signal strength drops below the
2059 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2060 * should be generated assuming the signal strength has changed at
2061 * least %hysteresis from the previously indicated signal change event.
2063 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2066 * send_frame - Send IEEE 802.11 frame (testing use only)
2067 * @priv: Private driver interface data
2068 * @data: IEEE 802.11 frame with IEEE 802.11 header
2069 * @data_len: Size of the frame
2070 * @encrypt: Whether to encrypt the frame (if keys are set)
2071 * Returns: 0 on success, -1 on failure
2073 * This function is only used for debugging purposes and is not
2074 * required to be implemented for normal operations.
2076 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2080 * shared_freq - Get operating frequency of shared interface(s)
2081 * @priv: Private driver interface data
2082 * Returns: Operating frequency in MHz, 0 if no shared operation in
2083 * use, or -1 on failure
2085 * This command can be used to request the current operating frequency
2086 * of any virtual interface that shares the same radio to provide
2087 * information for channel selection for other virtual interfaces.
2089 int (*shared_freq)(void *priv);
2092 * get_noa - Get current Notice of Absence attribute payload
2093 * @priv: Private driver interface data
2094 * @buf: Buffer for returning NoA
2095 * @buf_len: Buffer length in octets
2096 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2097 * advertized, or -1 on failure
2099 * This function is used to fetch the current Notice of Absence
2100 * attribute value from GO.
2102 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2105 * set_noa - Set Notice of Absence parameters for GO (testing)
2106 * @priv: Private driver interface data
2108 * @start: Start time in ms from next TBTT
2109 * @duration: Duration in ms
2110 * Returns: 0 on success or -1 on failure
2112 * This function is used to set Notice of Absence parameters for GO. It
2113 * is used only for testing. To disable NoA, all parameters are set to
2116 int (*set_noa)(void *priv, u8 count, int start, int duration);
2119 * set_p2p_powersave - Set P2P power save options
2120 * @priv: Private driver interface data
2121 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2122 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2123 * @ctwindow: 0.. = change (msec), -1 = no change
2124 * Returns: 0 on success or -1 on failure
2126 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2130 * ampdu - Enable/disable aggregation
2131 * @priv: Private driver interface data
2132 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2133 * Returns: 0 on success or -1 on failure
2135 int (*ampdu)(void *priv, int ampdu);
2138 * set_intra_bss - Enables/Disables intra BSS bridging
2140 * DEPRECATED - use set_ap() parameter isolate instead
2142 int (*set_intra_bss)(void *priv, int enabled);
2145 * get_radio_name - Get physical radio name for the device
2146 * @priv: Private driver interface data
2147 * Returns: Radio name or %NULL if not known
2149 * The returned data must not be modified by the caller. It is assumed
2150 * that any interface that has the same radio name as another is
2151 * sharing the same physical radio. This information can be used to
2152 * share scan results etc. information between the virtual interfaces
2153 * to speed up various operations.
2155 const char * (*get_radio_name)(void *priv);
2158 * p2p_find - Start P2P Device Discovery
2159 * @priv: Private driver interface data
2160 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2161 * @type: Device Discovery type (enum p2p_discovery_type)
2162 * Returns: 0 on success, -1 on failure
2164 * This function is only used if the driver implements P2P management,
2165 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2166 * struct wpa_driver_capa.
2168 int (*p2p_find)(void *priv, unsigned int timeout, int type);
2171 * p2p_stop_find - Stop P2P Device Discovery
2172 * @priv: Private driver interface data
2173 * Returns: 0 on success, -1 on failure
2175 * This function is only used if the driver implements P2P management,
2176 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2177 * struct wpa_driver_capa.
2179 int (*p2p_stop_find)(void *priv);
2182 * p2p_listen - Start P2P Listen state for specified duration
2183 * @priv: Private driver interface data
2184 * @timeout: Listen state duration in milliseconds
2185 * Returns: 0 on success, -1 on failure
2187 * This function can be used to request the P2P module to keep the
2188 * device discoverable on the listen channel for an extended set of
2189 * time. At least in its current form, this is mainly used for testing
2190 * purposes and may not be of much use for normal P2P operations.
2192 * This function is only used if the driver implements P2P management,
2193 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2194 * struct wpa_driver_capa.
2196 int (*p2p_listen)(void *priv, unsigned int timeout);
2199 * p2p_connect - Start P2P group formation (GO negotiation)
2200 * @priv: Private driver interface data
2201 * @peer_addr: MAC address of the peer P2P client
2202 * @wps_method: enum p2p_wps_method value indicating config method
2203 * @go_intent: Local GO intent value (1..15)
2204 * @own_interface_addr: Intended interface address to use with the
2206 * @force_freq: The only allowed channel frequency in MHz or 0
2207 * @persistent_group: Whether to create persistent group
2208 * Returns: 0 on success, -1 on failure
2210 * This function is only used if the driver implements P2P management,
2211 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2212 * struct wpa_driver_capa.
2214 int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method,
2215 int go_intent, const u8 *own_interface_addr,
2216 unsigned int force_freq, int persistent_group);
2219 * wps_success_cb - Report successfully completed WPS provisioning
2220 * @priv: Private driver interface data
2221 * @peer_addr: Peer address
2222 * Returns: 0 on success, -1 on failure
2224 * This function is used to report successfully completed WPS
2225 * provisioning during group formation in both GO/Registrar and
2226 * client/Enrollee roles.
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 int (*wps_success_cb)(void *priv, const u8 *peer_addr);
2235 * p2p_group_formation_failed - Report failed WPS provisioning
2236 * @priv: Private driver interface data
2237 * Returns: 0 on success, -1 on failure
2239 * This function is used to report failed group formation. This can
2240 * happen either due to failed WPS provisioning or due to 15 second
2241 * timeout during the provisioning phase.
2243 * This function is only used if the driver implements P2P management,
2244 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2245 * struct wpa_driver_capa.
2247 int (*p2p_group_formation_failed)(void *priv);
2250 * p2p_set_params - Set P2P parameters
2251 * @priv: Private driver interface data
2252 * @params: P2P parameters
2253 * Returns: 0 on success, -1 on failure
2255 * This function is only used if the driver implements P2P management,
2256 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2257 * struct wpa_driver_capa.
2259 int (*p2p_set_params)(void *priv, const struct p2p_params *params);
2262 * p2p_prov_disc_req - Send Provision Discovery Request
2263 * @priv: Private driver interface data
2264 * @peer_addr: MAC address of the peer P2P client
2265 * @config_methods: WPS Config Methods value (only one bit set)
2266 * Returns: 0 on success, -1 on failure
2268 * This function can be used to request a discovered P2P peer to
2269 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2270 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2271 * Provision Discovery Request frame is transmitted once immediately
2272 * and if no response is received, the frame will be sent again
2273 * whenever the target device is discovered during device dsicovery
2274 * (start with a p2p_find() call). Response from the peer is indicated
2275 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
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_prov_disc_req)(void *priv, const u8 *peer_addr,
2282 u16 config_methods);
2285 * p2p_sd_request - Schedule a service discovery query
2286 * @priv: Private driver interface data
2287 * @dst: Destination peer or %NULL to apply for all peers
2288 * @tlvs: P2P Service Query TLV(s)
2289 * Returns: Reference to the query or 0 on failure
2291 * Response to the query is indicated with the
2292 * EVENT_P2P_SD_RESPONSE driver event.
2294 * This function is only used if the driver implements P2P management,
2295 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2296 * struct wpa_driver_capa.
2298 u64 (*p2p_sd_request)(void *priv, const u8 *dst,
2299 const struct wpabuf *tlvs);
2302 * p2p_sd_cancel_request - Cancel a pending service discovery query
2303 * @priv: Private driver interface data
2304 * @req: Query reference from p2p_sd_request()
2305 * Returns: 0 on success, -1 on failure
2307 * This function is only used if the driver implements P2P management,
2308 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2309 * struct wpa_driver_capa.
2311 int (*p2p_sd_cancel_request)(void *priv, u64 req);
2314 * p2p_sd_response - Send response to a service discovery query
2315 * @priv: Private driver interface data
2316 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2317 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2318 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2319 * @resp_tlvs: P2P Service Response TLV(s)
2320 * Returns: 0 on success, -1 on failure
2322 * This function is called as a response to the request indicated with
2323 * the EVENT_P2P_SD_REQUEST driver event.
2325 * This function is only used if the driver implements P2P management,
2326 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2327 * struct wpa_driver_capa.
2329 int (*p2p_sd_response)(void *priv, int freq, const u8 *dst,
2331 const struct wpabuf *resp_tlvs);
2334 * p2p_service_update - Indicate a change in local services
2335 * @priv: Private driver interface data
2336 * Returns: 0 on success, -1 on failure
2338 * This function needs to be called whenever there is a change in
2339 * availability of the local services. This will increment the
2340 * Service Update Indicator value which will be used in SD Request and
2343 * This function is only used if the driver implements P2P management,
2344 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2345 * struct wpa_driver_capa.
2347 int (*p2p_service_update)(void *priv);
2350 * p2p_reject - Reject peer device (explicitly block connections)
2351 * @priv: Private driver interface data
2352 * @addr: MAC address of the peer
2353 * Returns: 0 on success, -1 on failure
2355 int (*p2p_reject)(void *priv, const u8 *addr);
2358 * p2p_invite - Invite a P2P Device into a group
2359 * @priv: Private driver interface data
2360 * @peer: Device Address of the peer P2P Device
2361 * @role: Local role in the group
2362 * @bssid: Group BSSID or %NULL if not known
2364 * @ssid_len: Length of ssid in octets
2365 * @go_dev_addr: Forced GO Device Address or %NULL if none
2366 * @persistent_group: Whether this is to reinvoke a persistent group
2367 * Returns: 0 on success, -1 on failure
2369 int (*p2p_invite)(void *priv, const u8 *peer, int role,
2370 const u8 *bssid, const u8 *ssid, size_t ssid_len,
2371 const u8 *go_dev_addr, int persistent_group);
2374 * send_tdls_mgmt - for sending TDLS management packets
2375 * @priv: private driver interface data
2376 * @dst: Destination (peer) MAC address
2377 * @action_code: TDLS action code for the mssage
2378 * @dialog_token: Dialog Token to use in the message (if needed)
2379 * @status_code: Status Code or Reason Code to use (if needed)
2380 * @buf: TDLS IEs to add to the message
2381 * @len: Length of buf in octets
2382 * Returns: 0 on success, -1 on failure
2384 * This optional function can be used to send packet to driver which is
2385 * responsible for receiving and sending all TDLS packets.
2387 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2388 u8 dialog_token, u16 status_code,
2389 const u8 *buf, size_t len);
2391 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2394 * signal_poll - Get current connection information
2395 * @priv: Private driver interface data
2396 * @signal_info: Connection info structure
2398 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2401 * set_authmode - Set authentication algorithm(s) for static WEP
2402 * @priv: Private driver interface data
2403 * @authmode: 1=Open System, 2=Shared Key, 3=both
2404 * Returns: 0 on success, -1 on failure
2406 * This function can be used to set authentication algorithms for AP
2407 * mode when static WEP is used. If the driver uses user space MLME/SME
2408 * implementation, there is no need to implement this function.
2410 * DEPRECATED - use set_ap() instead
2412 int (*set_authmode)(void *priv, int authmode);
2415 * set_rekey_info - Set rekey information
2416 * @priv: Private driver interface data
2419 * @replay_ctr: Current EAPOL-Key Replay Counter
2421 * This optional function can be used to provide information for the
2422 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2423 * while the host (including wpa_supplicant) is sleeping.
2425 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2426 const u8 *replay_ctr);
2429 * sta_assoc - Station association indication
2430 * @priv: Private driver interface data
2431 * @own_addr: Source address and BSSID for association frame
2432 * @addr: MAC address of the station to associate
2433 * @reassoc: flag to indicate re-association
2434 * @status: association response status code
2435 * @ie: assoc response ie buffer
2436 * @len: ie buffer length
2437 * Returns: 0 on success, -1 on failure
2439 * This function indicates the driver to send (Re)Association
2440 * Response frame to the station.
2442 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2443 int reassoc, u16 status, const u8 *ie, size_t len);
2446 * sta_auth - Station authentication indication
2447 * @priv: Private driver interface data
2448 * @own_addr: Source address and BSSID for authentication frame
2449 * @addr: MAC address of the station to associate
2450 * @seq: authentication sequence number
2451 * @status: authentication response status code
2452 * @ie: authentication frame ie buffer
2453 * @len: ie buffer length
2455 * This function indicates the driver to send Authentication frame
2458 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2459 u16 seq, u16 status, const u8 *ie, size_t len);
2462 * add_tspec - Add traffic stream
2463 * @priv: Private driver interface data
2464 * @addr: MAC address of the station to associate
2465 * @tspec_ie: tspec ie buffer
2466 * @tspec_ielen: tspec ie length
2467 * Returns: 0 on success, -1 on failure
2469 * This function adds the traffic steam for the station
2470 * and fills the medium_time in tspec_ie.
2472 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2473 size_t tspec_ielen);
2476 * add_sta_node - Add a station node in the driver
2477 * @priv: Private driver interface data
2478 * @addr: MAC address of the station to add
2479 * @auth_alg: authentication algorithm used by the station
2480 * Returns: 0 on success, -1 on failure
2482 * This function adds the station node in the driver, when
2483 * the station gets added by FT-over-DS.
2485 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2488 * sched_scan - Request the driver to initiate scheduled scan
2489 * @priv: Private driver interface data
2490 * @params: Scan parameters
2491 * @interval: Interval between scan cycles in milliseconds
2492 * Returns: 0 on success, -1 on failure
2494 * This operation should be used for scheduled scan offload to
2495 * the hardware. Every time scan results are available, the
2496 * driver should report scan results event for wpa_supplicant
2497 * which will eventually request the results with
2498 * wpa_driver_get_scan_results2(). This operation is optional
2499 * and if not provided or if it returns -1, we fall back to
2500 * normal host-scheduled scans.
2502 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2506 * stop_sched_scan - Request the driver to stop a scheduled scan
2507 * @priv: Private driver interface data
2508 * Returns: 0 on success, -1 on failure
2510 * This should cause the scheduled scan to be stopped and
2511 * results should stop being sent. Must be supported if
2512 * sched_scan is supported.
2514 int (*stop_sched_scan)(void *priv);
2519 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2521 enum wpa_event_type {
2523 * EVENT_ASSOC - Association completed
2525 * This event needs to be delivered when the driver completes IEEE
2526 * 802.11 association or reassociation successfully.
2527 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2528 * after this event has been generated. In addition, optional
2529 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2530 * more information about the association. If the driver interface gets
2531 * both of these events at the same time, it can also include the
2532 * assoc_info data in EVENT_ASSOC call.
2537 * EVENT_DISASSOC - Association lost
2539 * This event should be called when association is lost either due to
2540 * receiving deauthenticate or disassociate frame from the AP or when
2541 * sending either of these frames to the current AP. If the driver
2542 * supports separate deauthentication event, EVENT_DISASSOC should only
2543 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2544 * In AP mode, union wpa_event_data::disassoc_info is required.
2549 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2551 * This event must be delivered when a Michael MIC error is detected by
2552 * the local driver. Additional data for event processing is
2553 * provided with union wpa_event_data::michael_mic_failure. This
2554 * information is used to request new encyption key and to initiate
2555 * TKIP countermeasures if needed.
2557 EVENT_MICHAEL_MIC_FAILURE,
2560 * EVENT_SCAN_RESULTS - Scan results available
2562 * This event must be called whenever scan results are available to be
2563 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2564 * is expected to be used some time after struct wpa_driver_ops::scan()
2565 * is called. If the driver provides an unsolicited event when the scan
2566 * has been completed, this event can be used to trigger
2567 * EVENT_SCAN_RESULTS call. If such event is not available from the
2568 * driver, the driver wrapper code is expected to use a registered
2569 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2570 * scan is expected to be completed. Optional information about
2571 * completed scan can be provided with union wpa_event_data::scan_info.
2576 * EVENT_ASSOCINFO - Report optional extra information for association
2578 * This event can be used to report extra association information for
2579 * EVENT_ASSOC processing. This extra information includes IEs from
2580 * association frames and Beacon/Probe Response frames in union
2581 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2582 * EVENT_ASSOC. Alternatively, the driver interface can include
2583 * assoc_info data in the EVENT_ASSOC call if it has all the
2584 * information available at the same point.
2589 * EVENT_INTERFACE_STATUS - Report interface status changes
2591 * This optional event can be used to report changes in interface
2592 * status (interface added/removed) using union
2593 * wpa_event_data::interface_status. This can be used to trigger
2594 * wpa_supplicant to stop and re-start processing for the interface,
2595 * e.g., when a cardbus card is ejected/inserted.
2597 EVENT_INTERFACE_STATUS,
2600 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2602 * This event can be used to inform wpa_supplicant about candidates for
2603 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2604 * for scan request (ap_scan=2 mode), this event is required for
2605 * pre-authentication. If wpa_supplicant is performing scan request
2606 * (ap_scan=1), this event is optional since scan results can be used
2607 * to add pre-authentication candidates. union
2608 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2609 * candidate and priority of the candidate, e.g., based on the signal
2610 * strength, in order to try to pre-authenticate first with candidates
2611 * that are most likely targets for re-association.
2613 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2614 * on the candidate list. In addition, it can be called for the current
2615 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2616 * will automatically skip pre-authentication in cases where a valid
2617 * PMKSA exists. When more than one candidate exists, this event should
2618 * be generated once for each candidate.
2620 * Driver will be notified about successful pre-authentication with
2621 * struct wpa_driver_ops::add_pmkid() calls.
2623 EVENT_PMKID_CANDIDATE,
2626 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2628 * This event can be used to inform wpa_supplicant about desire to set
2629 * up secure direct link connection between two stations as defined in
2630 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2631 * STAKey negotiation. The caller will need to set peer address for the
2637 * EVENT_TDLS - Request TDLS operation
2639 * This event can be used to request a TDLS operation to be performed.
2644 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2646 * The driver is expected to report the received FT IEs from
2647 * FT authentication sequence from the AP. The FT IEs are included in
2648 * the extra information in union wpa_event_data::ft_ies.
2653 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2655 * The driver can use this event to inform wpa_supplicant about a STA
2656 * in an IBSS with which protected frames could be exchanged. This
2657 * event starts RSN authentication with the other STA to authenticate
2658 * the STA and set up encryption keys with it.
2660 EVENT_IBSS_RSN_START,
2663 * EVENT_AUTH - Authentication result
2665 * This event should be called when authentication attempt has been
2666 * completed. This is only used if the driver supports separate
2667 * authentication step (struct wpa_driver_ops::authenticate).
2668 * Information about authentication result is included in
2669 * union wpa_event_data::auth.
2674 * EVENT_DEAUTH - Authentication lost
2676 * This event should be called when authentication is lost either due
2677 * to receiving deauthenticate frame from the AP or when sending that
2678 * frame to the current AP.
2679 * In AP mode, union wpa_event_data::deauth_info is required.
2684 * EVENT_ASSOC_REJECT - Association rejected
2686 * This event should be called when (re)association attempt has been
2687 * rejected by the AP. Information about the association response is
2688 * included in union wpa_event_data::assoc_reject.
2693 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2695 EVENT_AUTH_TIMED_OUT,
2698 * EVENT_ASSOC_TIMED_OUT - Association timed out
2700 EVENT_ASSOC_TIMED_OUT,
2703 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2708 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2710 EVENT_WPS_BUTTON_PUSHED,
2713 * EVENT_TX_STATUS - Report TX status
2718 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2720 EVENT_RX_FROM_UNKNOWN,
2723 * EVENT_RX_MGMT - Report RX of a management frame
2728 * EVENT_RX_ACTION - Action frame received
2730 * This event is used to indicate when an Action frame has been
2731 * received. Information about the received frame is included in
2732 * union wpa_event_data::rx_action.
2737 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2739 * This event is used to indicate when the driver has started the
2740 * requested remain-on-channel duration. Information about the
2741 * operation is included in union wpa_event_data::remain_on_channel.
2743 EVENT_REMAIN_ON_CHANNEL,
2746 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2748 * This event is used to indicate when the driver has completed
2749 * remain-on-channel duration, i.e., may noot be available on the
2750 * requested channel anymore. Information about the
2751 * operation is included in union wpa_event_data::remain_on_channel.
2753 EVENT_CANCEL_REMAIN_ON_CHANNEL,
2756 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2758 * This event is used only by driver_test.c and userspace MLME.
2763 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2765 * This event is used to indicate when a Probe Request frame has been
2766 * received. Information about the received frame is included in
2767 * union wpa_event_data::rx_probe_req. The driver is required to report
2768 * these events only after successfully completed probe_req_report()
2769 * commands to request the events (i.e., report parameter is non-zero)
2770 * in station mode. In AP mode, Probe Request frames should always be
2776 * EVENT_NEW_STA - New wired device noticed
2778 * This event is used to indicate that a new device has been detected
2779 * in a network that does not use association-like functionality (i.e.,
2780 * mainly wired Ethernet). This can be used to start EAPOL
2781 * authenticator when receiving a frame from a device. The address of
2782 * the device is included in union wpa_event_data::new_sta.
2787 * EVENT_EAPOL_RX - Report received EAPOL frame
2789 * When in AP mode with hostapd, this event is required to be used to
2790 * deliver the receive EAPOL frames from the driver. With
2791 * %wpa_supplicant, this event is used only if the send_eapol() handler
2792 * is used to override the use of l2_packet for EAPOL frame TX.
2797 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
2799 * This event is used to indicate changes in the signal strength
2800 * observed in frames received from the current AP if signal strength
2801 * monitoring has been enabled with signal_monitor().
2803 EVENT_SIGNAL_CHANGE,
2806 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
2808 * This event is used to indicate that the interface was enabled after
2809 * having been previously disabled, e.g., due to rfkill.
2811 EVENT_INTERFACE_ENABLED,
2814 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
2816 * This event is used to indicate that the interface was disabled,
2817 * e.g., due to rfkill.
2819 EVENT_INTERFACE_DISABLED,
2822 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
2824 * This event is used to indicate that the channel list has changed,
2825 * e.g., because of a regulatory domain change triggered by scan
2826 * results including an AP advertising a country code.
2828 EVENT_CHANNEL_LIST_CHANGED,
2831 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
2833 * This event is used to indicate that the driver cannot maintain this
2834 * interface in its operation mode anymore. The most likely use for
2835 * this is to indicate that AP mode operation is not available due to
2836 * operating channel would need to be changed to a DFS channel when
2837 * the driver does not support radar detection and another virtual
2838 * interfaces caused the operating channel to change. Other similar
2839 * resource conflicts could also trigger this for station mode
2842 EVENT_INTERFACE_UNAVAILABLE,
2845 * EVENT_BEST_CHANNEL
2847 * Driver generates this event whenever it detects a better channel
2848 * (e.g., based on RSSI or channel use). This information can be used
2849 * to improve channel selection for a new AP/P2P group.
2854 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
2856 * This event should be called when a Deauthentication frame is dropped
2857 * due to it not being protected (MFP/IEEE 802.11w).
2858 * union wpa_event_data::unprot_deauth is required to provide more
2859 * details of the frame.
2861 EVENT_UNPROT_DEAUTH,
2864 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
2866 * This event should be called when a Disassociation frame is dropped
2867 * due to it not being protected (MFP/IEEE 802.11w).
2868 * union wpa_event_data::unprot_disassoc is required to provide more
2869 * details of the frame.
2871 EVENT_UNPROT_DISASSOC,
2874 * EVENT_STATION_LOW_ACK
2876 * Driver generates this event whenever it detected that a particular
2877 * station was lost. Detection can be through massive transmission
2878 * failures for example.
2880 EVENT_STATION_LOW_ACK,
2883 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
2885 * This event is used only if the driver implements P2P management
2886 * internally. Event data is stored in
2887 * union wpa_event_data::p2p_dev_found.
2889 EVENT_P2P_DEV_FOUND,
2892 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
2894 * This event is used only if the driver implements P2P management
2895 * internally. Event data is stored in
2896 * union wpa_event_data::p2p_go_neg_req_rx.
2898 EVENT_P2P_GO_NEG_REQ_RX,
2901 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
2903 * This event is used only if the driver implements P2P management
2904 * internally. Event data is stored in
2905 * union wpa_event_data::p2p_go_neg_completed.
2907 EVENT_P2P_GO_NEG_COMPLETED,
2909 EVENT_P2P_PROV_DISC_REQUEST,
2910 EVENT_P2P_PROV_DISC_RESPONSE,
2911 EVENT_P2P_SD_REQUEST,
2912 EVENT_P2P_SD_RESPONSE,
2915 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
2917 EVENT_IBSS_PEER_LOST,
2920 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
2922 * This event carries the new replay counter to notify wpa_supplicant
2923 * of the current EAPOL-Key Replay Counter in case the driver/firmware
2924 * completed Group Key Handshake while the host (including
2925 * wpa_supplicant was sleeping).
2927 EVENT_DRIVER_GTK_REKEY,
2930 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
2932 EVENT_SCHED_SCAN_STOPPED
2937 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
2939 union wpa_event_data {
2941 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
2943 * This structure is optional for EVENT_ASSOC calls and required for
2944 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
2945 * driver interface does not need to generate separate EVENT_ASSOCINFO
2950 * reassoc - Flag to indicate association or reassociation
2955 * req_ies - (Re)Association Request IEs
2957 * If the driver generates WPA/RSN IE, this event data must be
2958 * returned for WPA handshake to have needed information. If
2959 * wpa_supplicant-generated WPA/RSN IE is used, this
2960 * information event is optional.
2962 * This should start with the first IE (fixed fields before IEs
2963 * are not included).
2968 * req_ies_len - Length of req_ies in bytes
2973 * resp_ies - (Re)Association Response IEs
2975 * Optional association data from the driver. This data is not
2976 * required WPA, but may be useful for some protocols and as
2977 * such, should be reported if this is available to the driver
2980 * This should start with the first IE (fixed fields before IEs
2981 * are not included).
2986 * resp_ies_len - Length of resp_ies in bytes
2988 size_t resp_ies_len;
2991 * beacon_ies - Beacon or Probe Response IEs
2993 * Optional Beacon/ProbeResp data: IEs included in Beacon or
2994 * Probe Response frames from the current AP (i.e., the one
2995 * that the client just associated with). This information is
2996 * used to update WPA/RSN IE for the AP. If this field is not
2997 * set, the results from previous scan will be used. If no
2998 * data for the new AP is found, scan results will be requested
2999 * again (without scan request). At this point, the driver is
3000 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3003 * This should start with the first IE (fixed fields before IEs
3004 * are not included).
3006 const u8 *beacon_ies;
3009 * beacon_ies_len - Length of beacon_ies */
3010 size_t beacon_ies_len;
3013 * freq - Frequency of the operational channel in MHz
3018 * addr - Station address (for AP mode)
3024 * struct disassoc_info - Data for EVENT_DISASSOC events
3026 struct disassoc_info {
3028 * addr - Station address (for AP mode)
3033 * reason_code - Reason Code (host byte order) used in
3034 * Deauthentication frame
3039 * ie - Optional IE(s) in Disassociation frame
3044 * ie_len - Length of ie buffer in octets
3050 * struct deauth_info - Data for EVENT_DEAUTH events
3052 struct deauth_info {
3054 * addr - Station address (for AP mode)
3059 * reason_code - Reason Code (host byte order) used in
3060 * Deauthentication frame
3065 * ie - Optional IE(s) in Deauthentication frame
3070 * ie_len - Length of ie buffer in octets
3076 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3078 struct michael_mic_failure {
3081 } michael_mic_failure;
3084 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3086 struct interface_status {
3089 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3094 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3096 struct pmkid_candidate {
3097 /** BSSID of the PMKID candidate */
3099 /** Smaller the index, higher the priority */
3101 /** Whether RSN IE includes pre-authenticate flag */
3106 * struct stkstart - Data for EVENT_STKSTART
3113 * struct tdls - Data for EVENT_TDLS
3119 TDLS_REQUEST_TEARDOWN
3121 u16 reason_code; /* for teardown */
3125 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3127 * During FT (IEEE 802.11r) authentication sequence, the driver is
3128 * expected to use this event to report received FT IEs (MDIE, FTIE,
3129 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3130 * IEs for the next message will be delivered through the
3131 * struct wpa_driver_ops::update_ft_ies() callback.
3137 u8 target_ap[ETH_ALEN];
3138 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3140 /** Length of ric_ies buffer in octets */
3145 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3147 struct ibss_rsn_start {
3152 * struct auth_info - Data for EVENT_AUTH events
3158 u16 auth_transaction;
3165 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3167 struct assoc_reject {
3169 * bssid - BSSID of the AP that rejected association
3174 * resp_ies - (Re)Association Response IEs
3176 * Optional association data from the driver. This data is not
3177 * required WPA, but may be useful for some protocols and as
3178 * such, should be reported if this is available to the driver
3181 * This should start with the first IE (fixed fields before IEs
3182 * are not included).
3187 * resp_ies_len - Length of resp_ies in bytes
3189 size_t resp_ies_len;
3192 * status_code - Status Code from (Re)association Response
3197 struct timeout_event {
3202 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3211 * struct tx_status - Data for EVENT_TX_STATUS events
3223 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3225 struct rx_from_unknown {
3231 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3241 * struct rx_action - Data for EVENT_RX_ACTION events
3245 * da - Destination address of the received Action frame
3250 * sa - Source address of the received Action frame
3255 * bssid - Address 3 of the received Action frame
3260 * category - Action frame category
3265 * data - Action frame body after category field
3270 * len - Length of data in octets
3275 * freq - Frequency (in MHz) on which the frame was received
3281 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3283 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3285 struct remain_on_channel {
3287 * freq - Channel frequency in MHz
3292 * duration - Duration to remain on the channel in milliseconds
3294 unsigned int duration;
3295 } remain_on_channel;
3298 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3299 * @aborted: Whether the scan was aborted
3300 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3301 * @num_freqs: Number of entries in freqs array
3302 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3304 * @num_ssids: Number of entries in ssids array
3310 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3315 * struct mlme_rx - Data for EVENT_MLME_RX events
3326 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3328 struct rx_probe_req {
3330 * sa - Source address of the received Probe Request frame
3335 * da - Destination address of the received Probe Request frame
3336 * or %NULL if not available
3341 * bssid - BSSID of the received Probe Request frame or %NULL
3347 * ie - IEs from the Probe Request body
3352 * ie_len - Length of ie buffer in octets
3358 * struct new_sta - Data for EVENT_NEW_STA events
3365 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3374 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3376 struct wpa_signal_info signal_change;
3379 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3380 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3381 * @freq_5: Best 5 GHz band channel frequency in MHz
3382 * @freq_overall: Best channel frequency in MHz
3384 * 0 can be used to indicate no preference in either band.
3386 struct best_channel {
3392 struct unprot_deauth {
3398 struct unprot_disassoc {
3405 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3406 * @addr: station address
3413 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3415 struct p2p_dev_found {
3418 const u8 *pri_dev_type;
3419 const char *dev_name;
3426 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3428 struct p2p_go_neg_req_rx {
3431 } p2p_go_neg_req_rx;
3434 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3436 struct p2p_go_neg_completed {
3437 struct p2p_go_neg_results *res;
3438 } p2p_go_neg_completed;
3440 struct p2p_prov_disc_req {
3444 const u8 *pri_dev_type;
3445 const char *dev_name;
3446 u16 supp_config_methods;
3449 } p2p_prov_disc_req;
3451 struct p2p_prov_disc_resp {
3454 } p2p_prov_disc_resp;
3465 struct p2p_sd_resp {
3473 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3475 struct ibss_peer_lost {
3480 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3482 struct driver_gtk_rekey {
3484 const u8 *replay_ctr;
3489 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3490 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3491 * with struct wpa_driver_ops::init()
3492 * @event: event type (defined above)
3493 * @data: possible extra data for the event
3495 * Driver wrapper code should call this function whenever an event is received
3498 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
3499 union wpa_event_data *data);
3503 * The following inline functions are provided for convenience to simplify
3504 * event indication for some of the common events.
3507 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
3508 size_t ielen, int reassoc)
3510 union wpa_event_data event;
3511 os_memset(&event, 0, sizeof(event));
3512 event.assoc_info.reassoc = reassoc;
3513 event.assoc_info.req_ies = ie;
3514 event.assoc_info.req_ies_len = ielen;
3515 event.assoc_info.addr = addr;
3516 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
3519 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
3521 union wpa_event_data event;
3522 os_memset(&event, 0, sizeof(event));
3523 event.disassoc_info.addr = addr;
3524 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
3527 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
3530 union wpa_event_data event;
3531 os_memset(&event, 0, sizeof(event));
3532 event.eapol_rx.src = src;
3533 event.eapol_rx.data = data;
3534 event.eapol_rx.data_len = data_len;
3535 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
3538 #endif /* DRIVER_H */