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 10
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;
270 * struct wpa_driver_auth_params - Authentication parameters
271 * Data for struct wpa_driver_ops::authenticate().
273 struct wpa_driver_auth_params {
281 const u8 *wep_key[4];
282 size_t wep_key_len[4];
284 int local_state_change;
287 * p2p - Whether this connection is a P2P group
294 WPS_MODE_NONE /* no WPS provisioning being used */,
295 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
296 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
301 * struct wpa_driver_associate_params - Association parameters
302 * Data for struct wpa_driver_ops::associate().
304 struct wpa_driver_associate_params {
306 * bssid - BSSID of the selected AP
307 * This can be %NULL, if ap_scan=2 mode is used and the driver is
308 * responsible for selecting with which BSS to associate. */
312 * ssid - The selected SSID
317 * ssid_len - Length of the SSID (1..32)
322 * freq - Frequency of the channel the selected AP is using
323 * Frequency that the selected AP is using (in MHz as
324 * reported in the scan results)
329 * wpa_ie - WPA information element for (Re)Association Request
330 * WPA information element to be included in (Re)Association
331 * Request (including information element id and length). Use
332 * of this WPA IE is optional. If the driver generates the WPA
333 * IE, it can use pairwise_suite, group_suite, and
334 * key_mgmt_suite to select proper algorithms. In this case,
335 * the driver has to notify wpa_supplicant about the used WPA
336 * IE by generating an event that the interface code will
337 * convert into EVENT_ASSOCINFO data (see below).
339 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
340 * instead. The driver can determine which version is used by
341 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
344 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
349 * wpa_ie_len - length of the wpa_ie
354 * pairwise_suite - Selected pairwise cipher suite
356 * This is usually ignored if @wpa_ie is used.
358 enum wpa_cipher pairwise_suite;
361 * group_suite - Selected group cipher suite
363 * This is usually ignored if @wpa_ie is used.
365 enum wpa_cipher group_suite;
368 * key_mgmt_suite - Selected key management suite
370 * This is usually ignored if @wpa_ie is used.
372 enum wpa_key_mgmt key_mgmt_suite;
375 * auth_alg - Allowed authentication algorithms
376 * Bit field of WPA_AUTH_ALG_*
381 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
386 * wep_key - WEP keys for static WEP configuration
388 const u8 *wep_key[4];
391 * wep_key_len - WEP key length for static WEP configuration
393 size_t wep_key_len[4];
396 * wep_tx_keyidx - WEP TX key index for static WEP configuration
401 * mgmt_frame_protection - IEEE 802.11w management frame protection
403 enum mfp_options mgmt_frame_protection;
406 * ft_ies - IEEE 802.11r / FT information elements
407 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
408 * for fast transition, this parameter is set to include the IEs that
409 * are to be sent in the next FT Authentication Request message.
410 * update_ft_ies() handler is called to update the IEs for further
411 * FT messages in the sequence.
413 * The driver should use these IEs only if the target AP is advertising
414 * the same mobility domain as the one included in the MDIE here.
416 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
417 * AP after the initial association. These IEs can only be used if the
418 * target AP is advertising support for FT and is using the same MDIE
419 * and SSID as the current AP.
421 * The driver is responsible for reporting the FT IEs received from the
422 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
423 * type. update_ft_ies() handler will then be called with the FT IEs to
424 * include in the next frame in the authentication sequence.
429 * ft_ies_len - Length of ft_ies in bytes
434 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
436 * This value is provided to allow the driver interface easier access
437 * to the current mobility domain. This value is set to %NULL if no
438 * mobility domain is currently active.
443 * passphrase - RSN passphrase for PSK
445 * This value is made available only for WPA/WPA2-Personal (PSK) and
446 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
447 * the 8..63 character ASCII passphrase, if available. Please note that
448 * this can be %NULL if passphrase was not used to generate the PSK. In
449 * that case, the psk field must be used to fetch the PSK.
451 const char *passphrase;
454 * psk - RSN PSK (alternative for passphrase for PSK)
456 * This value is made available only for WPA/WPA2-Personal (PSK) and
457 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
458 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
459 * be prepared to handle %NULL value as an error.
464 * drop_unencrypted - Enable/disable unencrypted frame filtering
466 * Configure the driver to drop all non-EAPOL frames (both receive and
467 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
468 * still be allowed for key negotiation.
470 int drop_unencrypted;
473 * prev_bssid - Previously used BSSID in this ESS
475 * When not %NULL, this is a request to use reassociation instead of
478 const u8 *prev_bssid;
483 * If the driver needs to do special configuration for WPS association,
484 * this variable provides more information on what type of association
485 * is being requested. Most drivers should not need ot use this.
490 * p2p - Whether this connection is a P2P group
495 * uapsd - UAPSD parameters for the network
496 * -1 = do not change defaults
497 * AP mode: 1 = enabled, 0 = disabled
498 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
505 HIDDEN_SSID_ZERO_LEN,
506 HIDDEN_SSID_ZERO_CONTENTS
509 struct wpa_driver_ap_params {
511 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
516 * head_len - Length of the head buffer in octets
521 * tail - Beacon tail following TIM IE
526 * tail_len - Length of the tail buffer in octets
531 * dtim_period - DTIM period
536 * beacon_int - Beacon interval
541 * ssid - The SSID to use in Beacon/Probe Response frames
546 * ssid_len - Length of the SSID (1..32)
551 * hide_ssid - Whether to hide the SSID
553 enum hide_ssid hide_ssid;
556 * pairwise_ciphers - WPA_CIPHER_* bitfield
558 unsigned int pairwise_ciphers;
561 * group_cipher - WPA_CIPHER_*
563 unsigned int group_cipher;
566 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
568 unsigned int key_mgmt_suites;
571 * auth_algs - WPA_AUTH_ALG_* bitfield
573 unsigned int auth_algs;
576 * wpa_version - WPA_PROTO_* bitfield
578 unsigned int wpa_version;
581 * privacy - Whether privacy is used in the BSS
586 * beacon_ies - WPS/P2P IE(s) for Beacon frames
588 * This is used to add IEs like WPS IE and P2P IE by drivers that do not
589 * use the full Beacon template.
591 const struct wpabuf *beacon_ies;
594 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
596 * This is used to add IEs like WPS IE and P2P IE by drivers that
597 * reply to Probe Request frames internally.
599 const struct wpabuf *proberesp_ies;
602 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
604 const struct wpabuf *assocresp_ies;
608 * struct wpa_driver_capa - Driver capability information
610 struct wpa_driver_capa {
611 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
612 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
613 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
614 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
615 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
616 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
617 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
618 unsigned int key_mgmt;
620 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
621 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
622 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
623 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
626 #define WPA_DRIVER_AUTH_OPEN 0x00000001
627 #define WPA_DRIVER_AUTH_SHARED 0x00000002
628 #define WPA_DRIVER_AUTH_LEAP 0x00000004
631 /* Driver generated WPA/RSN IE */
632 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
633 /* Driver needs static WEP key setup after association command */
634 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
635 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
636 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
637 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
638 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
639 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
640 /* Driver provides separate commands for authentication and association (SME in
641 * wpa_supplicant). */
642 #define WPA_DRIVER_FLAGS_SME 0x00000020
643 /* Driver supports AP mode */
644 #define WPA_DRIVER_FLAGS_AP 0x00000040
645 /* Driver needs static WEP key setup after association has been completed */
646 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
647 /* Driver takes care of P2P management operations */
648 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
649 /* Driver supports concurrent P2P operations */
650 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
652 * Driver uses the initial interface as a dedicated management interface, i.e.,
653 * it cannot be used for P2P group operations or non-P2P purposes.
655 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
656 /* This interface is P2P capable (P2P Device, GO, or P2P Client */
657 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
658 /* Driver supports concurrent operations on multiple channels */
659 #define WPA_DRIVER_FLAGS_MULTI_CHANNEL_CONCURRENT 0x00001000
661 * Driver uses the initial interface for P2P management interface and non-P2P
662 * purposes (e.g., connect to infra AP), but this interface cannot be used for
663 * P2P group operations.
665 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
667 * Driver is known to use sane error codes, i.e., when it indicates that
668 * something (e.g., association) fails, there was indeed a failure and the
669 * operation does not end up getting completed successfully later.
671 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
672 /* Driver supports off-channel TX */
673 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
674 /* Driver indicates TX status events for EAPOL Data frames */
675 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
676 /* Driver indicates TX status events for Deauth/Disassoc frames */
677 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
683 * max_remain_on_chan - Maximum remain-on-channel duration in msec
685 unsigned int max_remain_on_chan;
688 * max_stations - Maximum number of associated stations the driver
689 * supports in AP mode
691 unsigned int max_stations;
697 struct hostap_sta_driver_data {
698 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
699 unsigned long current_tx_rate;
700 unsigned long inactive_msec;
702 unsigned long num_ps_buf_frames;
703 unsigned long tx_retry_failed;
704 unsigned long tx_retry_count;
709 struct hostapd_sta_add_params {
713 const u8 *supp_rates;
714 size_t supp_rates_len;
716 const struct ieee80211_ht_capabilities *ht_capabilities;
717 u32 flags; /* bitmask of WPA_STA_* flags */
720 struct hostapd_freq_params {
725 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
726 * secondary channel below primary, 1 = HT40
727 * enabled, secondary channel above primary */
730 enum wpa_driver_if_type {
732 * WPA_IF_STATION - Station mode interface
737 * WPA_IF_AP_VLAN - AP mode VLAN interface
739 * This interface shares its address and Beacon frame with the main
745 * WPA_IF_AP_BSS - AP mode BSS interface
747 * This interface has its own address and Beacon frame.
752 * WPA_IF_P2P_GO - P2P Group Owner
757 * WPA_IF_P2P_CLIENT - P2P Client
762 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
763 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
768 struct wpa_init_params {
773 const char *test_socket;
774 int use_pae_group_addr;
778 u8 *own_addr; /* buffer for writing own MAC address */
782 struct wpa_bss_params {
783 /** Interface name (for multi-SSID/VLAN support) */
785 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
794 enum mfp_options ieee80211w;
797 #define WPA_STA_AUTHORIZED BIT(0)
798 #define WPA_STA_WMM BIT(1)
799 #define WPA_STA_SHORT_PREAMBLE BIT(2)
800 #define WPA_STA_MFP BIT(3)
803 * struct p2p_params - P2P parameters for driver-based P2P management
806 const char *dev_name;
808 #define DRV_MAX_SEC_DEV_TYPES 5
809 u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8];
810 size_t num_sec_dev_types;
824 * struct wpa_signal_info - Information about channel signal quality
826 struct wpa_signal_info {
835 * struct wpa_driver_ops - Driver interface API definition
837 * This structure defines the API that each driver interface needs to implement
838 * for core wpa_supplicant code. All driver specific functionality is captured
841 struct wpa_driver_ops {
842 /** Name of the driver interface */
844 /** One line description of the driver interface */
848 * get_bssid - Get the current BSSID
849 * @priv: private driver interface data
850 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
852 * Returns: 0 on success, -1 on failure
854 * Query kernel driver for the current BSSID and copy it to bssid.
855 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
858 int (*get_bssid)(void *priv, u8 *bssid);
861 * get_ssid - Get the current SSID
862 * @priv: private driver interface data
863 * @ssid: buffer for SSID (at least 32 bytes)
865 * Returns: Length of the SSID on success, -1 on failure
867 * Query kernel driver for the current SSID and copy it to ssid.
868 * Returning zero is recommended if the STA is not associated.
870 * Note: SSID is an array of octets, i.e., it is not nul terminated and
871 * can, at least in theory, contain control characters (including nul)
872 * and as such, should be processed as binary data, not a printable
875 int (*get_ssid)(void *priv, u8 *ssid);
878 * set_key - Configure encryption key
879 * @ifname: Interface name (for multi-SSID/VLAN support)
880 * @priv: private driver interface data
881 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
882 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
883 * %WPA_ALG_NONE clears the key.
884 * @addr: Address of the peer STA (BSSID of the current AP when setting
885 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
886 * broadcast keys, %NULL for default keys that are used both for
887 * broadcast and unicast; when clearing keys, %NULL is used to
888 * indicate that both the broadcast-only and default key of the
889 * specified key index is to be cleared
890 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
892 * @set_tx: configure this key as the default Tx key (only used when
893 * driver does not support separate unicast/individual key
894 * @seq: sequence number/packet number, seq_len octets, the next
895 * packet number to be used for in replay protection; configured
896 * for Rx keys (in most cases, this is only used with broadcast
897 * keys and set to zero for unicast keys); %NULL if not set
898 * @seq_len: length of the seq, depends on the algorithm:
899 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
900 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
902 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
903 * TKIP: 32, CCMP: 16, IGTK: 16)
905 * Returns: 0 on success, -1 on failure
907 * Configure the given key for the kernel driver. If the driver
908 * supports separate individual keys (4 default keys + 1 individual),
909 * addr can be used to determine whether the key is default or
910 * individual. If only 4 keys are supported, the default key with key
911 * index 0 is used as the individual key. STA must be configured to use
912 * it as the default Tx key (set_tx is set) and accept Rx for all the
913 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
914 * broadcast keys, so key index 0 is available for this kind of
917 * Please note that TKIP keys include separate TX and RX MIC keys and
918 * some drivers may expect them in different order than wpa_supplicant
919 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
920 * will trigger Michael MIC errors. This can be fixed by changing the
921 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
922 * in driver_*.c set_key() implementation, see driver_ndis.c for an
923 * example on how this can be done.
925 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
926 const u8 *addr, int key_idx, int set_tx,
927 const u8 *seq, size_t seq_len,
928 const u8 *key, size_t key_len);
931 * init - Initialize driver interface
932 * @ctx: context to be used when calling wpa_supplicant functions,
933 * e.g., wpa_supplicant_event()
934 * @ifname: interface name, e.g., wlan0
936 * Returns: Pointer to private data, %NULL on failure
938 * Initialize driver interface, including event processing for kernel
939 * driver events (e.g., associated, scan results, Michael MIC failure).
940 * This function can allocate a private configuration data area for
941 * @ctx, file descriptor, interface name, etc. information that may be
942 * needed in future driver operations. If this is not used, non-NULL
943 * value will need to be returned because %NULL is used to indicate
944 * failure. The returned value will be used as 'void *priv' data for
945 * all other driver_ops functions.
947 * The main event loop (eloop.c) of wpa_supplicant can be used to
948 * register callback for read sockets (eloop_register_read_sock()).
950 * See below for more information about events and
951 * wpa_supplicant_event() function.
953 void * (*init)(void *ctx, const char *ifname);
956 * deinit - Deinitialize driver interface
957 * @priv: private driver interface data from init()
959 * Shut down driver interface and processing of driver events. Free
960 * private data buffer if one was allocated in init() handler.
962 void (*deinit)(void *priv);
965 * set_param - Set driver configuration parameters
966 * @priv: private driver interface data from init()
967 * @param: driver specific configuration parameters
969 * Returns: 0 on success, -1 on failure
971 * Optional handler for notifying driver interface about configuration
972 * parameters (driver_param).
974 int (*set_param)(void *priv, const char *param);
977 * set_countermeasures - Enable/disable TKIP countermeasures
978 * @priv: private driver interface data
979 * @enabled: 1 = countermeasures enabled, 0 = disabled
981 * Returns: 0 on success, -1 on failure
983 * Configure TKIP countermeasures. When these are enabled, the driver
984 * should drop all received and queued frames that are using TKIP.
986 int (*set_countermeasures)(void *priv, int enabled);
989 * deauthenticate - Request driver to deauthenticate
990 * @priv: private driver interface data
991 * @addr: peer address (BSSID of the AP)
992 * @reason_code: 16-bit reason code to be sent in the deauthentication
995 * Returns: 0 on success, -1 on failure
997 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1000 * disassociate - Request driver to disassociate
1001 * @priv: private driver interface data
1002 * @addr: peer address (BSSID of the AP)
1003 * @reason_code: 16-bit reason code to be sent in the disassociation
1006 * Returns: 0 on success, -1 on failure
1008 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
1011 * associate - Request driver to associate
1012 * @priv: private driver interface data
1013 * @params: association parameters
1015 * Returns: 0 on success, -1 on failure
1017 int (*associate)(void *priv,
1018 struct wpa_driver_associate_params *params);
1021 * add_pmkid - Add PMKSA cache entry to the driver
1022 * @priv: private driver interface data
1023 * @bssid: BSSID for the PMKSA cache entry
1024 * @pmkid: PMKID for the PMKSA cache entry
1026 * Returns: 0 on success, -1 on failure
1028 * This function is called when a new PMK is received, as a result of
1029 * either normal authentication or RSN pre-authentication.
1031 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1032 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1033 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1034 * driver_ops function does not need to be implemented. Likewise, if
1035 * the driver does not support WPA, this function is not needed.
1037 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1040 * remove_pmkid - Remove PMKSA cache entry to the driver
1041 * @priv: private driver interface data
1042 * @bssid: BSSID for the PMKSA cache entry
1043 * @pmkid: PMKID for the PMKSA cache entry
1045 * Returns: 0 on success, -1 on failure
1047 * This function is called when the supplicant drops a PMKSA cache
1048 * entry for any reason.
1050 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1051 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1052 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1053 * from wpa_supplicant, this driver_ops function does not need to be
1054 * implemented. Likewise, if the driver does not support WPA, this
1055 * function is not needed.
1057 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1060 * flush_pmkid - Flush PMKSA cache
1061 * @priv: private driver interface data
1063 * Returns: 0 on success, -1 on failure
1065 * This function is called when the supplicant drops all PMKSA cache
1066 * entries for any reason.
1068 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1069 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1070 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1071 * from wpa_supplicant, this driver_ops function does not need to be
1072 * implemented. Likewise, if the driver does not support WPA, this
1073 * function is not needed.
1075 int (*flush_pmkid)(void *priv);
1078 * get_capa - Get driver capabilities
1079 * @priv: private driver interface data
1081 * Returns: 0 on success, -1 on failure
1083 * Get driver/firmware/hardware capabilities.
1085 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1088 * poll - Poll driver for association information
1089 * @priv: private driver interface data
1091 * This is an option callback that can be used when the driver does not
1092 * provide event mechanism for association events. This is called when
1093 * receiving WPA EAPOL-Key messages that require association
1094 * information. The driver interface is supposed to generate associnfo
1095 * event before returning from this callback function. In addition, the
1096 * driver interface should generate an association event after having
1097 * sent out associnfo.
1099 void (*poll)(void *priv);
1102 * get_ifname - Get interface name
1103 * @priv: private driver interface data
1105 * Returns: Pointer to the interface name. This can differ from the
1106 * interface name used in init() call. Init() is called first.
1108 * This optional function can be used to allow the driver interface to
1109 * replace the interface name with something else, e.g., based on an
1110 * interface mapping from a more descriptive name.
1112 const char * (*get_ifname)(void *priv);
1115 * get_mac_addr - Get own MAC address
1116 * @priv: private driver interface data
1118 * Returns: Pointer to own MAC address or %NULL on failure
1120 * This optional function can be used to get the own MAC address of the
1121 * device from the driver interface code. This is only needed if the
1122 * l2_packet implementation for the OS does not provide easy access to
1124 const u8 * (*get_mac_addr)(void *priv);
1127 * send_eapol - Optional function for sending EAPOL packets
1128 * @priv: private driver interface data
1129 * @dest: Destination MAC address
1131 * @data: EAPOL packet starting with IEEE 802.1X header
1132 * @data_len: Size of the EAPOL packet
1134 * Returns: 0 on success, -1 on failure
1136 * This optional function can be used to override l2_packet operations
1137 * with driver specific functionality. If this function pointer is set,
1138 * l2_packet module is not used at all and the driver interface code is
1139 * responsible for receiving and sending all EAPOL packets. The
1140 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1141 * event. The driver interface is required to implement get_mac_addr()
1142 * handler if send_eapol() is used.
1144 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1145 const u8 *data, size_t data_len);
1148 * set_operstate - Sets device operating state to DORMANT or UP
1149 * @priv: private driver interface data
1150 * @state: 0 = dormant, 1 = up
1151 * Returns: 0 on success, -1 on failure
1153 * This is an optional function that can be used on operating systems
1154 * that support a concept of controlling network device state from user
1155 * space applications. This function, if set, gets called with
1156 * state = 1 when authentication has been completed and with state = 0
1157 * when connection is lost.
1159 int (*set_operstate)(void *priv, int state);
1162 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1163 * @priv: Private driver interface data
1164 * @addr: Address of the station for which to set protection (may be
1165 * %NULL for group keys)
1166 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1167 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1168 * Returns: 0 on success, -1 on failure
1170 * This is an optional function that can be used to set the driver to
1171 * require protection for Tx and/or Rx frames. This uses the layer
1172 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1173 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1174 * set protection operation; instead, they set protection implicitly
1175 * based on configured keys.
1177 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1181 * get_hw_feature_data - Get hardware support data (channels and rates)
1182 * @priv: Private driver interface data
1183 * @num_modes: Variable for returning the number of returned modes
1184 * flags: Variable for returning hardware feature flags
1185 * Returns: Pointer to allocated hardware data on success or %NULL on
1186 * failure. Caller is responsible for freeing this.
1188 * This function is only needed for drivers that export MLME
1189 * (management frame processing) to %wpa_supplicant or hostapd.
1191 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1196 * set_channel - Set channel
1197 * @priv: Private driver interface data
1198 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
1199 * @chan: IEEE 802.11 channel number
1200 * @freq: Frequency of the channel in MHz
1201 * Returns: 0 on success, -1 on failure
1203 * This function is only needed for drivers that export MLME
1204 * (management frame processing) to wpa_supplicant.
1206 int (*set_channel)(void *priv, enum hostapd_hw_mode phymode, int chan,
1210 * set_ssid - Set SSID
1211 * @priv: Private driver interface data
1213 * @ssid_len: SSID length
1214 * Returns: 0 on success, -1 on failure
1216 * This function is only needed for drivers that export MLME
1217 * (management frame processing) to wpa_supplicant.
1219 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
1222 * set_bssid - Set BSSID
1223 * @priv: Private driver interface data
1225 * Returns: 0 on success, -1 on failure
1227 * This function is only needed for drivers that export MLME
1228 * (management frame processing) to wpa_supplicant.
1230 int (*set_bssid)(void *priv, const u8 *bssid);
1233 * send_mlme - Send management frame from MLME
1234 * @priv: Private driver interface data
1235 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1236 * @data_len: Size of the management frame
1237 * Returns: 0 on success, -1 on failure
1239 * This function is only needed for drivers that export MLME
1240 * (management frame processing) to wpa_supplicant.
1242 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
1245 * mlme_add_sta - Add a STA entry into the driver/netstack
1246 * @priv: Private driver interface data
1247 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1248 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
1249 * format (one octet per rate, 1 = 0.5 Mbps)
1250 * @supp_rates_len: Number of entries in supp_rates
1251 * Returns: 0 on success, -1 on failure
1253 * This function is only needed for drivers that export MLME
1254 * (management frame processing) to wpa_supplicant. When the MLME code
1255 * completes association with an AP, this function is called to
1256 * configure the driver/netstack with a STA entry for data frame
1257 * processing (TX rate control, encryption/decryption).
1259 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
1260 size_t supp_rates_len);
1263 * mlme_remove_sta - Remove a STA entry from the driver/netstack
1264 * @priv: Private driver interface data
1265 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1266 * Returns: 0 on success, -1 on failure
1268 * This function is only needed for drivers that export MLME
1269 * (management frame processing) to wpa_supplicant.
1271 int (*mlme_remove_sta)(void *priv, const u8 *addr);
1274 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1275 * @priv: Private driver interface data
1276 * @md: Mobility domain (2 octets) (also included inside ies)
1277 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1278 * @ies_len: Length of FT IEs in bytes
1279 * Returns: 0 on success, -1 on failure
1281 * The supplicant uses this callback to let the driver know that keying
1282 * material for FT is available and that the driver can use the
1283 * provided IEs in the next message in FT authentication sequence.
1285 * This function is only needed for driver that support IEEE 802.11r
1286 * (Fast BSS Transition).
1288 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1292 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1293 * @priv: Private driver interface data
1294 * @action: Action field value
1295 * @target_ap: Target AP address
1296 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1297 * @ies_len: Length of FT IEs in bytes
1298 * Returns: 0 on success, -1 on failure
1300 * The supplicant uses this callback to request the driver to transmit
1301 * an FT Action frame (action category 6) for over-the-DS fast BSS
1304 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1305 const u8 *ies, size_t ies_len);
1308 * get_scan_results2 - Fetch the latest scan results
1309 * @priv: private driver interface data
1311 * Returns: Allocated buffer of scan results (caller is responsible for
1312 * freeing the data structure) on success, NULL on failure
1314 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1317 * set_country - Set country
1318 * @priv: Private driver interface data
1319 * @alpha2: country to which to switch to
1320 * Returns: 0 on success, -1 on failure
1322 * This function is for drivers which support some form
1323 * of setting a regulatory domain.
1325 int (*set_country)(void *priv, const char *alpha2);
1328 * global_init - Global driver initialization
1329 * Returns: Pointer to private data (global), %NULL on failure
1331 * This optional function is called to initialize the driver wrapper
1332 * for global data, i.e., data that applies to all interfaces. If this
1333 * function is implemented, global_deinit() will also need to be
1334 * implemented to free the private data. The driver will also likely
1335 * use init2() function instead of init() to get the pointer to global
1336 * data available to per-interface initializer.
1338 void * (*global_init)(void);
1341 * global_deinit - Global driver deinitialization
1342 * @priv: private driver global data from global_init()
1344 * Terminate any global driver related functionality and free the
1345 * global data structure.
1347 void (*global_deinit)(void *priv);
1350 * init2 - Initialize driver interface (with global data)
1351 * @ctx: context to be used when calling wpa_supplicant functions,
1352 * e.g., wpa_supplicant_event()
1353 * @ifname: interface name, e.g., wlan0
1354 * @global_priv: private driver global data from global_init()
1355 * Returns: Pointer to private data, %NULL on failure
1357 * This function can be used instead of init() if the driver wrapper
1360 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1363 * get_interfaces - Get information about available interfaces
1364 * @global_priv: private driver global data from global_init()
1365 * Returns: Allocated buffer of interface information (caller is
1366 * responsible for freeing the data structure) on success, NULL on
1369 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1372 * scan2 - Request the driver to initiate scan
1373 * @priv: private driver interface data
1374 * @params: Scan parameters
1376 * Returns: 0 on success, -1 on failure
1378 * Once the scan results are ready, the driver should report scan
1379 * results event for wpa_supplicant which will eventually request the
1380 * results with wpa_driver_get_scan_results2().
1382 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1385 * authenticate - Request driver to authenticate
1386 * @priv: private driver interface data
1387 * @params: authentication parameters
1388 * Returns: 0 on success, -1 on failure
1390 * This is an optional function that can be used with drivers that
1391 * support separate authentication and association steps, i.e., when
1392 * wpa_supplicant can act as the SME. If not implemented, associate()
1393 * function is expected to take care of IEEE 802.11 authentication,
1396 int (*authenticate)(void *priv,
1397 struct wpa_driver_auth_params *params);
1400 * set_ap - Set Beacon and Probe Response information for AP mode
1401 * @priv: Private driver interface data
1402 * @params: Parameters to use in AP mode
1404 * This function is used to configure Beacon template and/or extra IEs
1405 * to add for Beacon and Probe Response frames for the driver in
1406 * AP mode. The driver is responsible for building the full Beacon
1407 * frame by concatenating the head part with TIM IE generated by the
1408 * driver/firmware and finishing with the tail part. Depending on the
1409 * driver architectue, this can be done either by using the full
1410 * template or the set of additional IEs (e.g., WPS and P2P IE).
1411 * Similarly, Probe Response processing depends on the driver design.
1412 * If the driver (or firmware) takes care of replying to Probe Request
1413 * frames, the extra IEs provided here needs to be added to the Probe
1416 * Returns: 0 on success, -1 on failure
1418 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1421 * hapd_init - Initialize driver interface (hostapd only)
1422 * @hapd: Pointer to hostapd context
1423 * @params: Configuration for the driver wrapper
1424 * Returns: Pointer to private data, %NULL on failure
1426 * This function is used instead of init() or init2() when the driver
1427 * wrapper is used withh hostapd.
1429 void * (*hapd_init)(struct hostapd_data *hapd,
1430 struct wpa_init_params *params);
1433 * hapd_deinit - Deinitialize driver interface (hostapd only)
1434 * @priv: Private driver interface data from hapd_init()
1436 void (*hapd_deinit)(void *priv);
1439 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1440 * @priv: Private driver interface data
1441 * @params: BSS parameters
1442 * Returns: 0 on success, -1 on failure
1444 * This is an optional function to configure the kernel driver to
1445 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1446 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1447 * always enabled and the driver uses set_beacon() to set WPA/RSN IE
1448 * for Beacon frames.
1450 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1453 * set_privacy - Enable/disable privacy (AP only)
1454 * @priv: Private driver interface data
1455 * @enabled: 1 = privacy enabled, 0 = disabled
1456 * Returns: 0 on success, -1 on failure
1458 * This is an optional function to configure privacy field in the
1459 * kernel driver for Beacon frames. This can be left undefined (set to
1460 * %NULL) if the driver uses the Beacon template from set_beacon().
1462 int (*set_privacy)(void *priv, int enabled);
1465 * get_seqnum - Fetch the current TSC/packet number (AP only)
1466 * @ifname: The interface name (main or virtual)
1467 * @priv: Private driver interface data
1468 * @addr: MAC address of the station or %NULL for group keys
1470 * @seq: Buffer for returning the latest used TSC/packet number
1471 * Returns: 0 on success, -1 on failure
1473 * This function is used to fetch the last used TSC/packet number for
1474 * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so
1475 * there is no strict requirement on implementing support for unicast
1476 * keys (i.e., addr != %NULL).
1478 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1482 * flush - Flush all association stations (AP only)
1483 * @priv: Private driver interface data
1484 * Returns: 0 on success, -1 on failure
1486 * This function requests the driver to disassociate all associated
1487 * stations. This function does not need to be implemented if the
1488 * driver does not process association frames internally.
1490 int (*flush)(void *priv);
1493 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1494 * @priv: Private driver interface data
1495 * @elem: Information elements
1496 * @elem_len: Length of the elem buffer in octets
1497 * Returns: 0 on success, -1 on failure
1499 * This is an optional function to add information elements in the
1500 * kernel driver for Beacon and Probe Response frames. This can be left
1501 * undefined (set to %NULL) if the driver uses the Beacon template from
1504 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1507 * read_sta_data - Fetch station data (AP only)
1508 * @priv: Private driver interface data
1509 * @data: Buffer for returning station information
1510 * @addr: MAC address of the station
1511 * Returns: 0 on success, -1 on failure
1513 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1517 * hapd_send_eapol - Send an EAPOL packet (AP only)
1518 * @priv: private driver interface data
1519 * @addr: Destination MAC address
1520 * @data: EAPOL packet starting with IEEE 802.1X header
1521 * @data_len: Length of the EAPOL packet in octets
1522 * @encrypt: Whether the frame should be encrypted
1523 * @own_addr: Source MAC address
1524 * @flags: WPA_STA_* flags for the destination station
1526 * Returns: 0 on success, -1 on failure
1528 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1529 size_t data_len, int encrypt,
1530 const u8 *own_addr, u32 flags);
1533 * sta_deauth - Deauthenticate a station (AP only)
1534 * @priv: Private driver interface data
1535 * @own_addr: Source address and BSSID for the Deauthentication frame
1536 * @addr: MAC address of the station to deauthenticate
1537 * @reason: Reason code for the Deauthentiation frame
1538 * Returns: 0 on success, -1 on failure
1540 * This function requests a specific station to be deauthenticated and
1541 * a Deauthentication frame to be sent to it.
1543 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1547 * sta_disassoc - Disassociate a station (AP only)
1548 * @priv: Private driver interface data
1549 * @own_addr: Source address and BSSID for the Disassociation frame
1550 * @addr: MAC address of the station to disassociate
1551 * @reason: Reason code for the Disassociation frame
1552 * Returns: 0 on success, -1 on failure
1554 * This function requests a specific station to be disassociated and
1555 * a Disassociation frame to be sent to it.
1557 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1561 * sta_remove - Remove a station entry (AP only)
1562 * @priv: Private driver interface data
1563 * @addr: MAC address of the station to be removed
1564 * Returns: 0 on success, -1 on failure
1566 int (*sta_remove)(void *priv, const u8 *addr);
1569 * hapd_get_ssid - Get the current SSID (AP only)
1570 * @priv: Private driver interface data
1571 * @buf: Buffer for returning the SSID
1572 * @len: Maximum length of the buffer
1573 * Returns: Length of the SSID on success, -1 on failure
1575 * This function need not be implemented if the driver uses Beacon
1576 * template from set_beacon() and does not reply to Probe Request
1579 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1582 * hapd_set_ssid - Set SSID (AP only)
1583 * @priv: Private driver interface data
1585 * @len: Length of the SSID in octets
1586 * Returns: 0 on success, -1 on failure
1588 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1591 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1592 * @priv: Private driver interface data
1593 * @enabled: 1 = countermeasures enabled, 0 = disabled
1594 * Returns: 0 on success, -1 on failure
1596 * This need not be implemented if the driver does not take care of
1597 * association processing.
1599 int (*hapd_set_countermeasures)(void *priv, int enabled);
1602 * sta_add - Add a station entry
1603 * @priv: Private driver interface data
1604 * @params: Station parameters
1605 * Returns: 0 on success, -1 on failure
1607 * This function is used to add a station entry to the driver once the
1608 * station has completed association. This is only used if the driver
1609 * does not take care of association processing.
1611 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1614 * get_inact_sec - Get station inactivity duration (AP only)
1615 * @priv: Private driver interface data
1616 * @addr: Station address
1617 * Returns: Number of seconds station has been inactive, -1 on failure
1619 int (*get_inact_sec)(void *priv, const u8 *addr);
1622 * sta_clear_stats - Clear station statistics (AP only)
1623 * @priv: Private driver interface data
1624 * @addr: Station address
1625 * Returns: 0 on success, -1 on failure
1627 int (*sta_clear_stats)(void *priv, const u8 *addr);
1630 * set_freq - Set channel/frequency (AP only)
1631 * @priv: Private driver interface data
1632 * @freq: Channel parameters
1633 * Returns: 0 on success, -1 on failure
1635 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1638 * set_rts - Set RTS threshold
1639 * @priv: Private driver interface data
1640 * @rts: RTS threshold in octets
1641 * Returns: 0 on success, -1 on failure
1643 int (*set_rts)(void *priv, int rts);
1646 * set_frag - Set fragmentation threshold
1647 * @priv: Private driver interface data
1648 * @frag: Fragmentation threshold in octets
1649 * Returns: 0 on success, -1 on failure
1651 int (*set_frag)(void *priv, int frag);
1654 * sta_set_flags - Set station flags (AP only)
1655 * @priv: Private driver interface data
1656 * @addr: Station address
1657 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1658 * @flags_or: Bitmap of WPA_STA_* flags to add
1659 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1660 * Returns: 0 on success, -1 on failure
1662 int (*sta_set_flags)(void *priv, const u8 *addr,
1663 int total_flags, int flags_or, int flags_and);
1666 * set_rate_sets - Set supported and basic rate sets (AP only)
1667 * @priv: Private driver interface data
1668 * @supp_rates: -1 terminated array of supported rates in 100 kbps
1669 * @basic_rates: -1 terminated array of basic rates in 100 kbps
1670 * @mode: hardware mode (HOSTAPD_MODE_*)
1671 * Returns: 0 on success, -1 on failure
1673 int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
1677 * set_cts_protect - Set CTS protection mode (AP only)
1678 * @priv: Private driver interface data
1679 * @value: Whether CTS protection is enabled
1680 * Returns: 0 on success, -1 on failure
1682 int (*set_cts_protect)(void *priv, int value);
1685 * set_preamble - Set preamble mode (AP only)
1686 * @priv: Private driver interface data
1687 * @value: Whether short preamble is enabled
1688 * Returns: 0 on success, -1 on failure
1690 int (*set_preamble)(void *priv, int value);
1693 * set_short_slot_time - Set short slot time (AP only)
1694 * @priv: Private driver interface data
1695 * @value: Whether short slot time is enabled
1696 * Returns: 0 on success, -1 on failure
1698 int (*set_short_slot_time)(void *priv, int value);
1701 * set_tx_queue_params - Set TX queue parameters
1702 * @priv: Private driver interface data
1703 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
1707 * @burst_time: Maximum length for bursting in 0.1 msec units
1709 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1710 int cw_max, int burst_time);
1713 * valid_bss_mask - Validate BSSID mask
1714 * @priv: Private driver interface data
1717 * Returns: 0 if mask is valid, -1 if mask is not valid, 1 if mask can
1718 * be used, but the main interface address must be the first address in
1719 * the block if mask is applied
1721 int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
1724 * if_add - Add a virtual interface
1725 * @priv: Private driver interface data
1726 * @type: Interface type
1727 * @ifname: Interface name for the new virtual interface
1728 * @addr: Local address to use for the interface or %NULL to use the
1729 * parent interface address
1730 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1731 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1732 * not allowed (applies only to %WPA_IF_AP_BSS type)
1733 * @force_ifname: Buffer for returning an interface name that the
1734 * driver ended up using if it differs from the requested ifname
1735 * @if_addr: Buffer for returning the allocated interface address
1736 * (this may differ from the requested addr if the driver cannot
1737 * change interface address)
1738 * @bridge: Bridge interface to use or %NULL if no bridge configured
1739 * Returns: 0 on success, -1 on failure
1741 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1742 const char *ifname, const u8 *addr, void *bss_ctx,
1743 void **drv_priv, char *force_ifname, u8 *if_addr,
1744 const char *bridge);
1747 * if_remove - Remove a virtual interface
1748 * @priv: Private driver interface data
1749 * @type: Interface type
1750 * @ifname: Interface name of the virtual interface to be removed
1751 * Returns: 0 on success, -1 on failure
1753 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1754 const char *ifname);
1757 * set_sta_vlan - Bind a station into a specific interface (AP only)
1758 * @priv: Private driver interface data
1759 * @ifname: Interface (main or virtual BSS or VLAN)
1760 * @addr: MAC address of the associated station
1762 * Returns: 0 on success, -1 on failure
1764 * This function is used to bind a station to a specific virtual
1765 * interface. It is only used if when virtual interfaces are supported,
1766 * e.g., to assign stations to different VLAN interfaces based on
1767 * information from a RADIUS server. This allows separate broadcast
1768 * domains to be used with a single BSS.
1770 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1774 * commit - Optional commit changes handler (AP only)
1775 * @priv: driver private data
1776 * Returns: 0 on success, -1 on failure
1778 * This optional handler function can be registered if the driver
1779 * interface implementation needs to commit changes (e.g., by setting
1780 * network interface up) at the end of initial configuration. If set,
1781 * this handler will be called after initial setup has been completed.
1783 int (*commit)(void *priv);
1786 * send_ether - Send an ethernet packet (AP only)
1787 * @priv: private driver interface data
1788 * @dst: Destination MAC address
1789 * @src: Source MAC address
1791 * @data: EAPOL packet starting with IEEE 802.1X header
1792 * @data_len: Length of the EAPOL packet in octets
1793 * Returns: 0 on success, -1 on failure
1795 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1796 const u8 *data, size_t data_len);
1799 * set_radius_acl_auth - Notification of RADIUS ACL change
1800 * @priv: Private driver interface data
1801 * @mac: MAC address of the station
1802 * @accepted: Whether the station was accepted
1803 * @session_timeout: Session timeout for the station
1804 * Returns: 0 on success, -1 on failure
1806 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1807 u32 session_timeout);
1810 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1811 * @priv: Private driver interface data
1812 * @mac: MAC address of the station
1813 * Returns: 0 on success, -1 on failure
1815 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1818 * set_ht_params - Set HT parameters (AP only)
1819 * @priv: Private driver interface data
1820 * @ht_capab: HT Capabilities IE
1821 * @ht_capab_len: Length of ht_capab in octets
1822 * @ht_oper: HT Operation IE
1823 * @ht_oper_len: Length of ht_oper in octets
1824 * Returns: 0 on success, -1 on failure
1826 int (*set_ht_params)(void *priv,
1827 const u8 *ht_capab, size_t ht_capab_len,
1828 const u8 *ht_oper, size_t ht_oper_len);
1831 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
1832 * @priv: Private driver interface data
1833 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
1834 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
1836 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
1837 * to remove extra IE(s)
1838 * Returns: 0 on success, -1 on failure
1840 * This is an optional function to add WPS IE in the kernel driver for
1841 * Beacon and Probe Response frames. This can be left undefined (set
1842 * to %NULL) if the driver uses the Beacon template from set_beacon()
1843 * and does not process Probe Request frames. If the driver takes care
1844 * of (Re)Association frame processing, the assocresp buffer includes
1845 * WPS IE(s) that need to be added to (Re)Association Response frames
1846 * whenever a (Re)Association Request frame indicated use of WPS.
1848 * This will also be used to add P2P IE(s) into Beacon/Probe Response
1849 * frames when operating as a GO. The driver is responsible for adding
1850 * timing related attributes (e.g., NoA) in addition to the IEs
1851 * included here by appending them after these buffers. This call is
1852 * also used to provide Probe Response IEs for P2P Listen state
1853 * operations for drivers that generate the Probe Response frames
1856 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
1857 const struct wpabuf *proberesp,
1858 const struct wpabuf *assocresp);
1861 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1862 * @priv: Private driver interface data
1863 * @authorized: Whether the port is authorized
1864 * Returns: 0 on success, -1 on failure
1866 int (*set_supp_port)(void *priv, int authorized);
1869 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1870 * @priv: Private driver interface data
1871 * @addr: MAC address of the associated station
1872 * @aid: Association ID
1873 * @val: 1 = bind to 4-address WDS; 0 = unbind
1874 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
1875 * to indicate that bridge is not to be used
1876 * Returns: 0 on success, -1 on failure
1878 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
1879 const char *bridge_ifname);
1882 * send_action - Transmit an Action frame
1883 * @priv: Private driver interface data
1884 * @freq: Frequency (in MHz) of the channel
1885 * @wait: Time to wait off-channel for a response (in ms), or zero
1886 * @dst: Destination MAC address (Address 1)
1887 * @src: Source MAC address (Address 2)
1888 * @bssid: BSSID (Address 3)
1890 * @data_len: data length in octets
1891 * Returns: 0 on success, -1 on failure
1893 * This command can be used to request the driver to transmit an action
1894 * frame to the specified destination.
1896 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
1897 * be transmitted on the given channel and the device will wait for a
1898 * response on that channel for the given wait time.
1900 * If the flag is not set, the wait time will be ignored. In this case,
1901 * if a remain-on-channel duration is in progress, the frame must be
1902 * transmitted on that channel; alternatively the frame may be sent on
1903 * the current operational channel (if in associated state in station
1904 * mode or while operating as an AP.)
1906 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
1907 const u8 *dst, const u8 *src, const u8 *bssid,
1908 const u8 *data, size_t data_len);
1911 * send_action_cancel_wait - Cancel action frame TX wait
1912 * @priv: Private driver interface data
1914 * This command cancels the wait time associated with sending an action
1915 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
1916 * set in the driver flags.
1918 void (*send_action_cancel_wait)(void *priv);
1921 * remain_on_channel - Remain awake on a channel
1922 * @priv: Private driver interface data
1923 * @freq: Frequency (in MHz) of the channel
1924 * @duration: Duration in milliseconds
1925 * Returns: 0 on success, -1 on failure
1927 * This command is used to request the driver to remain awake on the
1928 * specified channel for the specified duration and report received
1929 * Action frames with EVENT_RX_ACTION events. Optionally, received
1930 * Probe Request frames may also be requested to be reported by calling
1931 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
1933 * The driver may not be at the requested channel when this function
1934 * returns, i.e., the return code is only indicating whether the
1935 * request was accepted. The caller will need to wait until the
1936 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
1937 * completed the channel change. This may take some time due to other
1938 * need for the radio and the caller should be prepared to timing out
1939 * its wait since there are no guarantees on when this request can be
1942 int (*remain_on_channel)(void *priv, unsigned int freq,
1943 unsigned int duration);
1946 * cancel_remain_on_channel - Cancel remain-on-channel operation
1947 * @priv: Private driver interface data
1949 * This command can be used to cancel a remain-on-channel operation
1950 * before its originally requested duration has passed. This could be
1951 * used, e.g., when remain_on_channel() is used to request extra time
1952 * to receive a response to an Action frame and the response is
1953 * received when there is still unneeded time remaining on the
1954 * remain-on-channel operation.
1956 int (*cancel_remain_on_channel)(void *priv);
1959 * probe_req_report - Request Probe Request frames to be indicated
1960 * @priv: Private driver interface data
1961 * @report: Whether to report received Probe Request frames
1962 * Returns: 0 on success, -1 on failure (or if not supported)
1964 * This command can be used to request the driver to indicate when
1965 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
1966 * Since this operation may require extra resources, e.g., due to less
1967 * optimal hardware/firmware RX filtering, many drivers may disable
1968 * Probe Request reporting at least in station mode. This command is
1969 * used to notify the driver when the Probe Request frames need to be
1970 * reported, e.g., during remain-on-channel operations.
1972 int (*probe_req_report)(void *priv, int report);
1975 * disable_11b_rates - Set whether IEEE 802.11b rates are used for TX
1976 * @priv: Private driver interface data
1977 * @disabled: Whether IEEE 802.11b rates are disabled
1978 * Returns: 0 on success, -1 on failure (or if not supported)
1980 * This command is used to disable IEEE 802.11b rates (1, 2, 5.5, and
1981 * 11 Mbps) as TX rates for data and management frames. This can be
1982 * used to optimize channel use when there is no need to support IEEE
1983 * 802.11b-only devices.
1985 int (*disable_11b_rates)(void *priv, int disabled);
1988 * deinit_ap - Deinitialize AP mode
1989 * @priv: Private driver interface data
1990 * Returns: 0 on success, -1 on failure (or if not supported)
1992 * This optional function can be used to disable AP mode related
1993 * configuration and change the driver mode to station mode to allow
1994 * normal station operations like scanning to be completed.
1996 int (*deinit_ap)(void *priv);
1999 * suspend - Notification on system suspend/hibernate event
2000 * @priv: Private driver interface data
2002 void (*suspend)(void *priv);
2005 * resume - Notification on system resume/thaw event
2006 * @priv: Private driver interface data
2008 void (*resume)(void *priv);
2011 * signal_monitor - Set signal monitoring parameters
2012 * @priv: Private driver interface data
2013 * @threshold: Threshold value for signal change events; 0 = disabled
2014 * @hysteresis: Minimum change in signal strength before indicating a
2016 * Returns: 0 on success, -1 on failure (or if not supported)
2018 * This function can be used to configure monitoring of signal strength
2019 * with the current AP. Whenever signal strength drops below the
2020 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2021 * should be generated assuming the signal strength has changed at
2022 * least %hysteresis from the previously indicated signal change event.
2024 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2027 * send_frame - Send IEEE 802.11 frame (testing use only)
2028 * @priv: Private driver interface data
2029 * @data: IEEE 802.11 frame with IEEE 802.11 header
2030 * @data_len: Size of the frame
2031 * @encrypt: Whether to encrypt the frame (if keys are set)
2032 * Returns: 0 on success, -1 on failure
2034 * This function is only used for debugging purposes and is not
2035 * required to be implemented for normal operations.
2037 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2041 * shared_freq - Get operating frequency of shared interface(s)
2042 * @priv: Private driver interface data
2043 * Returns: Operating frequency in MHz, 0 if no shared operation in
2044 * use, or -1 on failure
2046 * This command can be used to request the current operating frequency
2047 * of any virtual interface that shares the same radio to provide
2048 * information for channel selection for other virtual interfaces.
2050 int (*shared_freq)(void *priv);
2053 * get_noa - Get current Notice of Absence attribute payload
2054 * @priv: Private driver interface data
2055 * @buf: Buffer for returning NoA
2056 * @buf_len: Buffer length in octets
2057 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2058 * advertized, or -1 on failure
2060 * This function is used to fetch the current Notice of Absence
2061 * attribute value from GO.
2063 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2066 * set_noa - Set Notice of Absence parameters for GO (testing)
2067 * @priv: Private driver interface data
2069 * @start: Start time in ms from next TBTT
2070 * @duration: Duration in ms
2071 * Returns: 0 on success or -1 on failure
2073 * This function is used to set Notice of Absence parameters for GO. It
2074 * is used only for testing. To disable NoA, all parameters are set to
2077 int (*set_noa)(void *priv, u8 count, int start, int duration);
2080 * set_p2p_powersave - Set P2P power save options
2081 * @priv: Private driver interface data
2082 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2083 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2084 * @ctwindow: 0.. = change (msec), -1 = no change
2085 * Returns: 0 on success or -1 on failure
2087 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2091 * ampdu - Enable/disable aggregation
2092 * @priv: Private driver interface data
2093 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2094 * Returns: 0 on success or -1 on failure
2096 int (*ampdu)(void *priv, int ampdu);
2099 * set_intra_bss - Enables/Disables intra BSS bridging
2101 int (*set_intra_bss)(void *priv, int enabled);
2104 * get_radio_name - Get physical radio name for the device
2105 * @priv: Private driver interface data
2106 * Returns: Radio name or %NULL if not known
2108 * The returned data must not be modified by the caller. It is assumed
2109 * that any interface that has the same radio name as another is
2110 * sharing the same physical radio. This information can be used to
2111 * share scan results etc. information between the virtual interfaces
2112 * to speed up various operations.
2114 const char * (*get_radio_name)(void *priv);
2117 * p2p_find - Start P2P Device Discovery
2118 * @priv: Private driver interface data
2119 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2120 * @type: Device Discovery type (enum p2p_discovery_type)
2121 * Returns: 0 on success, -1 on failure
2123 * This function is only used if the driver implements P2P management,
2124 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2125 * struct wpa_driver_capa.
2127 int (*p2p_find)(void *priv, unsigned int timeout, int type);
2130 * p2p_stop_find - Stop P2P Device Discovery
2131 * @priv: Private driver interface data
2132 * Returns: 0 on success, -1 on failure
2134 * This function is only used if the driver implements P2P management,
2135 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2136 * struct wpa_driver_capa.
2138 int (*p2p_stop_find)(void *priv);
2141 * p2p_listen - Start P2P Listen state for specified duration
2142 * @priv: Private driver interface data
2143 * @timeout: Listen state duration in milliseconds
2144 * Returns: 0 on success, -1 on failure
2146 * This function can be used to request the P2P module to keep the
2147 * device discoverable on the listen channel for an extended set of
2148 * time. At least in its current form, this is mainly used for testing
2149 * purposes and may not be of much use for normal P2P operations.
2151 * This function is only used if the driver implements P2P management,
2152 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2153 * struct wpa_driver_capa.
2155 int (*p2p_listen)(void *priv, unsigned int timeout);
2158 * p2p_connect - Start P2P group formation (GO negotiation)
2159 * @priv: Private driver interface data
2160 * @peer_addr: MAC address of the peer P2P client
2161 * @wps_method: enum p2p_wps_method value indicating config method
2162 * @go_intent: Local GO intent value (1..15)
2163 * @own_interface_addr: Intended interface address to use with the
2165 * @force_freq: The only allowed channel frequency in MHz or 0
2166 * @persistent_group: Whether to create persistent group
2167 * Returns: 0 on success, -1 on failure
2169 * This function is only used if the driver implements P2P management,
2170 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2171 * struct wpa_driver_capa.
2173 int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method,
2174 int go_intent, const u8 *own_interface_addr,
2175 unsigned int force_freq, int persistent_group);
2178 * wps_success_cb - Report successfully completed WPS provisioning
2179 * @priv: Private driver interface data
2180 * @peer_addr: Peer address
2181 * Returns: 0 on success, -1 on failure
2183 * This function is used to report successfully completed WPS
2184 * provisioning during group formation in both GO/Registrar and
2185 * client/Enrollee roles.
2187 * This function is only used if the driver implements P2P management,
2188 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2189 * struct wpa_driver_capa.
2191 int (*wps_success_cb)(void *priv, const u8 *peer_addr);
2194 * p2p_group_formation_failed - Report failed WPS provisioning
2195 * @priv: Private driver interface data
2196 * Returns: 0 on success, -1 on failure
2198 * This function is used to report failed group formation. This can
2199 * happen either due to failed WPS provisioning or due to 15 second
2200 * timeout during the provisioning phase.
2202 * This function is only used if the driver implements P2P management,
2203 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2204 * struct wpa_driver_capa.
2206 int (*p2p_group_formation_failed)(void *priv);
2209 * p2p_set_params - Set P2P parameters
2210 * @priv: Private driver interface data
2211 * @params: P2P parameters
2212 * Returns: 0 on success, -1 on failure
2214 * This function is only used if the driver implements P2P management,
2215 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2216 * struct wpa_driver_capa.
2218 int (*p2p_set_params)(void *priv, const struct p2p_params *params);
2221 * p2p_prov_disc_req - Send Provision Discovery Request
2222 * @priv: Private driver interface data
2223 * @peer_addr: MAC address of the peer P2P client
2224 * @config_methods: WPS Config Methods value (only one bit set)
2225 * Returns: 0 on success, -1 on failure
2227 * This function can be used to request a discovered P2P peer to
2228 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2229 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2230 * Provision Discovery Request frame is transmitted once immediately
2231 * and if no response is received, the frame will be sent again
2232 * whenever the target device is discovered during device dsicovery
2233 * (start with a p2p_find() call). Response from the peer is indicated
2234 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
2236 * This function is only used if the driver implements P2P management,
2237 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2238 * struct wpa_driver_capa.
2240 int (*p2p_prov_disc_req)(void *priv, const u8 *peer_addr,
2241 u16 config_methods);
2244 * p2p_sd_request - Schedule a service discovery query
2245 * @priv: Private driver interface data
2246 * @dst: Destination peer or %NULL to apply for all peers
2247 * @tlvs: P2P Service Query TLV(s)
2248 * Returns: Reference to the query or 0 on failure
2250 * Response to the query is indicated with the
2251 * EVENT_P2P_SD_RESPONSE driver event.
2253 * This function is only used if the driver implements P2P management,
2254 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2255 * struct wpa_driver_capa.
2257 u64 (*p2p_sd_request)(void *priv, const u8 *dst,
2258 const struct wpabuf *tlvs);
2261 * p2p_sd_cancel_request - Cancel a pending service discovery query
2262 * @priv: Private driver interface data
2263 * @req: Query reference from p2p_sd_request()
2264 * Returns: 0 on success, -1 on failure
2266 * This function is only used if the driver implements P2P management,
2267 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2268 * struct wpa_driver_capa.
2270 int (*p2p_sd_cancel_request)(void *priv, u64 req);
2273 * p2p_sd_response - Send response to a service discovery query
2274 * @priv: Private driver interface data
2275 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2276 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2277 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2278 * @resp_tlvs: P2P Service Response TLV(s)
2279 * Returns: 0 on success, -1 on failure
2281 * This function is called as a response to the request indicated with
2282 * the EVENT_P2P_SD_REQUEST driver event.
2284 * This function is only used if the driver implements P2P management,
2285 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2286 * struct wpa_driver_capa.
2288 int (*p2p_sd_response)(void *priv, int freq, const u8 *dst,
2290 const struct wpabuf *resp_tlvs);
2293 * p2p_service_update - Indicate a change in local services
2294 * @priv: Private driver interface data
2295 * Returns: 0 on success, -1 on failure
2297 * This function needs to be called whenever there is a change in
2298 * availability of the local services. This will increment the
2299 * Service Update Indicator value which will be used in SD Request and
2302 * This function is only used if the driver implements P2P management,
2303 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2304 * struct wpa_driver_capa.
2306 int (*p2p_service_update)(void *priv);
2309 * p2p_reject - Reject peer device (explicitly block connections)
2310 * @priv: Private driver interface data
2311 * @addr: MAC address of the peer
2312 * Returns: 0 on success, -1 on failure
2314 int (*p2p_reject)(void *priv, const u8 *addr);
2317 * p2p_invite - Invite a P2P Device into a group
2318 * @priv: Private driver interface data
2319 * @peer: Device Address of the peer P2P Device
2320 * @role: Local role in the group
2321 * @bssid: Group BSSID or %NULL if not known
2323 * @ssid_len: Length of ssid in octets
2324 * @go_dev_addr: Forced GO Device Address or %NULL if none
2325 * @persistent_group: Whether this is to reinvoke a persistent group
2326 * Returns: 0 on success, -1 on failure
2328 int (*p2p_invite)(void *priv, const u8 *peer, int role,
2329 const u8 *bssid, const u8 *ssid, size_t ssid_len,
2330 const u8 *go_dev_addr, int persistent_group);
2333 * send_tdls_mgmt - for sending TDLS management packets
2334 * @priv: private driver interface data
2335 * @dst: Destination (peer) MAC address
2336 * @action_code: TDLS action code for the mssage
2337 * @dialog_token: Dialog Token to use in the message (if needed)
2338 * @status_code: Status Code or Reason Code to use (if needed)
2339 * @buf: TDLS IEs to add to the message
2340 * @len: Length of buf in octets
2341 * Returns: 0 on success, -1 on failure
2343 * This optional function can be used to send packet to driver which is
2344 * responsible for receiving and sending all TDLS packets.
2346 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2347 u8 dialog_token, u16 status_code,
2348 const u8 *buf, size_t len);
2350 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2353 * signal_poll - Get current connection information
2354 * @priv: Private driver interface data
2355 * @signal_info: Connection info structure
2357 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2360 * set_authmode - Set authentication algorithm(s) for static WEP
2361 * @priv: Private driver interface data
2362 * @authmode: 1=Open System, 2=Shared Key, 3=both
2363 * Returns: 0 on success, -1 on failure
2365 * This function can be used to set authentication algorithms for AP
2366 * mode when static WEP is used. If the driver uses user space MLME/SME
2367 * implementation, there is no need to implement this function.
2369 int (*set_authmode)(void *priv, int authmode);
2372 * set_rekey_info - Set rekey information
2373 * @priv: Private driver interface data
2376 * @replay_ctr: Current EAPOL-Key Replay Counter
2378 * This optional function can be used to provide information for the
2379 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2380 * while the host (including wpa_supplicant) is sleeping.
2382 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2383 const u8 *replay_ctr);
2388 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2390 enum wpa_event_type {
2392 * EVENT_ASSOC - Association completed
2394 * This event needs to be delivered when the driver completes IEEE
2395 * 802.11 association or reassociation successfully.
2396 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2397 * after this event has been generated. In addition, optional
2398 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2399 * more information about the association. If the driver interface gets
2400 * both of these events at the same time, it can also include the
2401 * assoc_info data in EVENT_ASSOC call.
2406 * EVENT_DISASSOC - Association lost
2408 * This event should be called when association is lost either due to
2409 * receiving deauthenticate or disassociate frame from the AP or when
2410 * sending either of these frames to the current AP. If the driver
2411 * supports separate deauthentication event, EVENT_DISASSOC should only
2412 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2413 * In AP mode, union wpa_event_data::disassoc_info is required.
2418 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2420 * This event must be delivered when a Michael MIC error is detected by
2421 * the local driver. Additional data for event processing is
2422 * provided with union wpa_event_data::michael_mic_failure. This
2423 * information is used to request new encyption key and to initiate
2424 * TKIP countermeasures if needed.
2426 EVENT_MICHAEL_MIC_FAILURE,
2429 * EVENT_SCAN_RESULTS - Scan results available
2431 * This event must be called whenever scan results are available to be
2432 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2433 * is expected to be used some time after struct wpa_driver_ops::scan()
2434 * is called. If the driver provides an unsolicited event when the scan
2435 * has been completed, this event can be used to trigger
2436 * EVENT_SCAN_RESULTS call. If such event is not available from the
2437 * driver, the driver wrapper code is expected to use a registered
2438 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2439 * scan is expected to be completed. Optional information about
2440 * completed scan can be provided with union wpa_event_data::scan_info.
2445 * EVENT_ASSOCINFO - Report optional extra information for association
2447 * This event can be used to report extra association information for
2448 * EVENT_ASSOC processing. This extra information includes IEs from
2449 * association frames and Beacon/Probe Response frames in union
2450 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2451 * EVENT_ASSOC. Alternatively, the driver interface can include
2452 * assoc_info data in the EVENT_ASSOC call if it has all the
2453 * information available at the same point.
2458 * EVENT_INTERFACE_STATUS - Report interface status changes
2460 * This optional event can be used to report changes in interface
2461 * status (interface added/removed) using union
2462 * wpa_event_data::interface_status. This can be used to trigger
2463 * wpa_supplicant to stop and re-start processing for the interface,
2464 * e.g., when a cardbus card is ejected/inserted.
2466 EVENT_INTERFACE_STATUS,
2469 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2471 * This event can be used to inform wpa_supplicant about candidates for
2472 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2473 * for scan request (ap_scan=2 mode), this event is required for
2474 * pre-authentication. If wpa_supplicant is performing scan request
2475 * (ap_scan=1), this event is optional since scan results can be used
2476 * to add pre-authentication candidates. union
2477 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2478 * candidate and priority of the candidate, e.g., based on the signal
2479 * strength, in order to try to pre-authenticate first with candidates
2480 * that are most likely targets for re-association.
2482 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2483 * on the candidate list. In addition, it can be called for the current
2484 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2485 * will automatically skip pre-authentication in cases where a valid
2486 * PMKSA exists. When more than one candidate exists, this event should
2487 * be generated once for each candidate.
2489 * Driver will be notified about successful pre-authentication with
2490 * struct wpa_driver_ops::add_pmkid() calls.
2492 EVENT_PMKID_CANDIDATE,
2495 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2497 * This event can be used to inform wpa_supplicant about desire to set
2498 * up secure direct link connection between two stations as defined in
2499 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2500 * STAKey negotiation. The caller will need to set peer address for the
2506 * EVENT_TDLS - Request TDLS operation
2508 * This event can be used to request a TDLS operation to be performed.
2513 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2515 * The driver is expected to report the received FT IEs from
2516 * FT authentication sequence from the AP. The FT IEs are included in
2517 * the extra information in union wpa_event_data::ft_ies.
2522 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2524 * The driver can use this event to inform wpa_supplicant about a STA
2525 * in an IBSS with which protected frames could be exchanged. This
2526 * event starts RSN authentication with the other STA to authenticate
2527 * the STA and set up encryption keys with it.
2529 EVENT_IBSS_RSN_START,
2532 * EVENT_AUTH - Authentication result
2534 * This event should be called when authentication attempt has been
2535 * completed. This is only used if the driver supports separate
2536 * authentication step (struct wpa_driver_ops::authenticate).
2537 * Information about authentication result is included in
2538 * union wpa_event_data::auth.
2543 * EVENT_DEAUTH - Authentication lost
2545 * This event should be called when authentication is lost either due
2546 * to receiving deauthenticate frame from the AP or when sending that
2547 * frame to the current AP.
2548 * In AP mode, union wpa_event_data::deauth_info is required.
2553 * EVENT_ASSOC_REJECT - Association rejected
2555 * This event should be called when (re)association attempt has been
2556 * rejected by the AP. Information about the association response is
2557 * included in union wpa_event_data::assoc_reject.
2562 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2564 EVENT_AUTH_TIMED_OUT,
2567 * EVENT_ASSOC_TIMED_OUT - Association timed out
2569 EVENT_ASSOC_TIMED_OUT,
2572 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2577 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2579 EVENT_WPS_BUTTON_PUSHED,
2582 * EVENT_TX_STATUS - Report TX status
2587 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2589 EVENT_RX_FROM_UNKNOWN,
2592 * EVENT_RX_MGMT - Report RX of a management frame
2597 * EVENT_RX_ACTION - Action frame received
2599 * This event is used to indicate when an Action frame has been
2600 * received. Information about the received frame is included in
2601 * union wpa_event_data::rx_action.
2606 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2608 * This event is used to indicate when the driver has started the
2609 * requested remain-on-channel duration. Information about the
2610 * operation is included in union wpa_event_data::remain_on_channel.
2612 EVENT_REMAIN_ON_CHANNEL,
2615 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2617 * This event is used to indicate when the driver has completed
2618 * remain-on-channel duration, i.e., may noot be available on the
2619 * requested channel anymore. Information about the
2620 * operation is included in union wpa_event_data::remain_on_channel.
2622 EVENT_CANCEL_REMAIN_ON_CHANNEL,
2625 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2627 * This event is used only by driver_test.c and userspace MLME.
2632 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2634 * This event is used to indicate when a Probe Request frame has been
2635 * received. Information about the received frame is included in
2636 * union wpa_event_data::rx_probe_req. The driver is required to report
2637 * these events only after successfully completed probe_req_report()
2638 * commands to request the events (i.e., report parameter is non-zero)
2639 * in station mode. In AP mode, Probe Request frames should always be
2645 * EVENT_NEW_STA - New wired device noticed
2647 * This event is used to indicate that a new device has been detected
2648 * in a network that does not use association-like functionality (i.e.,
2649 * mainly wired Ethernet). This can be used to start EAPOL
2650 * authenticator when receiving a frame from a device. The address of
2651 * the device is included in union wpa_event_data::new_sta.
2656 * EVENT_EAPOL_RX - Report received EAPOL frame
2658 * When in AP mode with hostapd, this event is required to be used to
2659 * deliver the receive EAPOL frames from the driver. With
2660 * %wpa_supplicant, this event is used only if the send_eapol() handler
2661 * is used to override the use of l2_packet for EAPOL frame TX.
2666 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
2668 * This event is used to indicate changes in the signal strength
2669 * observed in frames received from the current AP if signal strength
2670 * monitoring has been enabled with signal_monitor().
2672 EVENT_SIGNAL_CHANGE,
2675 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
2677 * This event is used to indicate that the interface was enabled after
2678 * having been previously disabled, e.g., due to rfkill.
2680 EVENT_INTERFACE_ENABLED,
2683 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
2685 * This event is used to indicate that the interface was disabled,
2686 * e.g., due to rfkill.
2688 EVENT_INTERFACE_DISABLED,
2691 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
2693 * This event is used to indicate that the channel list has changed,
2694 * e.g., because of a regulatory domain change triggered by scan
2695 * results including an AP advertising a country code.
2697 EVENT_CHANNEL_LIST_CHANGED,
2700 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
2702 * This event is used to indicate that the driver cannot maintain this
2703 * interface in its operation mode anymore. The most likely use for
2704 * this is to indicate that AP mode operation is not available due to
2705 * operating channel would need to be changed to a DFS channel when
2706 * the driver does not support radar detection and another virtual
2707 * interfaces caused the operating channel to change. Other similar
2708 * resource conflicts could also trigger this for station mode
2711 EVENT_INTERFACE_UNAVAILABLE,
2714 * EVENT_BEST_CHANNEL
2716 * Driver generates this event whenever it detects a better channel
2717 * (e.g., based on RSSI or channel use). This information can be used
2718 * to improve channel selection for a new AP/P2P group.
2723 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
2725 * This event should be called when a Deauthentication frame is dropped
2726 * due to it not being protected (MFP/IEEE 802.11w).
2727 * union wpa_event_data::unprot_deauth is required to provide more
2728 * details of the frame.
2730 EVENT_UNPROT_DEAUTH,
2733 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
2735 * This event should be called when a Disassociation frame is dropped
2736 * due to it not being protected (MFP/IEEE 802.11w).
2737 * union wpa_event_data::unprot_disassoc is required to provide more
2738 * details of the frame.
2740 EVENT_UNPROT_DISASSOC,
2743 * EVENT_STATION_LOW_ACK
2745 * Driver generates this event whenever it detected that a particular
2746 * station was lost. Detection can be through massive transmission
2747 * failures for example.
2749 EVENT_STATION_LOW_ACK,
2752 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
2754 * This event is used only if the driver implements P2P management
2755 * internally. Event data is stored in
2756 * union wpa_event_data::p2p_dev_found.
2758 EVENT_P2P_DEV_FOUND,
2761 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
2763 * This event is used only if the driver implements P2P management
2764 * internally. Event data is stored in
2765 * union wpa_event_data::p2p_go_neg_req_rx.
2767 EVENT_P2P_GO_NEG_REQ_RX,
2770 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
2772 * This event is used only if the driver implements P2P management
2773 * internally. Event data is stored in
2774 * union wpa_event_data::p2p_go_neg_completed.
2776 EVENT_P2P_GO_NEG_COMPLETED,
2778 EVENT_P2P_PROV_DISC_REQUEST,
2779 EVENT_P2P_PROV_DISC_RESPONSE,
2780 EVENT_P2P_SD_REQUEST,
2781 EVENT_P2P_SD_RESPONSE,
2784 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
2786 EVENT_IBSS_PEER_LOST,
2789 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
2791 * This event carries the new replay counter to notify wpa_supplicant
2792 * of the current EAPOL-Key Replay Counter in case the driver/firmware
2793 * completed Group Key Handshake while the host (including
2794 * wpa_supplicant was sleeping).
2796 EVENT_DRIVER_GTK_REKEY
2801 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
2803 union wpa_event_data {
2805 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
2807 * This structure is optional for EVENT_ASSOC calls and required for
2808 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
2809 * driver interface does not need to generate separate EVENT_ASSOCINFO
2814 * reassoc - Flag to indicate association or reassociation
2819 * req_ies - (Re)Association Request IEs
2821 * If the driver generates WPA/RSN IE, this event data must be
2822 * returned for WPA handshake to have needed information. If
2823 * wpa_supplicant-generated WPA/RSN IE is used, this
2824 * information event is optional.
2826 * This should start with the first IE (fixed fields before IEs
2827 * are not included).
2832 * req_ies_len - Length of req_ies in bytes
2837 * resp_ies - (Re)Association Response IEs
2839 * Optional association data from the driver. This data is not
2840 * required WPA, but may be useful for some protocols and as
2841 * such, should be reported if this is available to the driver
2844 * This should start with the first IE (fixed fields before IEs
2845 * are not included).
2850 * resp_ies_len - Length of resp_ies in bytes
2852 size_t resp_ies_len;
2855 * beacon_ies - Beacon or Probe Response IEs
2857 * Optional Beacon/ProbeResp data: IEs included in Beacon or
2858 * Probe Response frames from the current AP (i.e., the one
2859 * that the client just associated with). This information is
2860 * used to update WPA/RSN IE for the AP. If this field is not
2861 * set, the results from previous scan will be used. If no
2862 * data for the new AP is found, scan results will be requested
2863 * again (without scan request). At this point, the driver is
2864 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
2867 * This should start with the first IE (fixed fields before IEs
2868 * are not included).
2870 const u8 *beacon_ies;
2873 * beacon_ies_len - Length of beacon_ies */
2874 size_t beacon_ies_len;
2877 * freq - Frequency of the operational channel in MHz
2882 * addr - Station address (for AP mode)
2888 * struct disassoc_info - Data for EVENT_DISASSOC events
2890 struct disassoc_info {
2892 * addr - Station address (for AP mode)
2897 * reason_code - Reason Code (host byte order) used in
2898 * Deauthentication frame
2903 * ie - Optional IE(s) in Disassociation frame
2908 * ie_len - Length of ie buffer in octets
2914 * struct deauth_info - Data for EVENT_DEAUTH events
2916 struct deauth_info {
2918 * addr - Station address (for AP mode)
2923 * reason_code - Reason Code (host byte order) used in
2924 * Deauthentication frame
2929 * ie - Optional IE(s) in Deauthentication frame
2934 * ie_len - Length of ie buffer in octets
2940 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
2942 struct michael_mic_failure {
2945 } michael_mic_failure;
2948 * struct interface_status - Data for EVENT_INTERFACE_STATUS
2950 struct interface_status {
2953 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
2958 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
2960 struct pmkid_candidate {
2961 /** BSSID of the PMKID candidate */
2963 /** Smaller the index, higher the priority */
2965 /** Whether RSN IE includes pre-authenticate flag */
2970 * struct stkstart - Data for EVENT_STKSTART
2977 * struct tdls - Data for EVENT_TDLS
2983 TDLS_REQUEST_TEARDOWN
2985 u16 reason_code; /* for teardown */
2989 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
2991 * During FT (IEEE 802.11r) authentication sequence, the driver is
2992 * expected to use this event to report received FT IEs (MDIE, FTIE,
2993 * RSN IE, TIE, possible resource request) to the supplicant. The FT
2994 * IEs for the next message will be delivered through the
2995 * struct wpa_driver_ops::update_ft_ies() callback.
3001 u8 target_ap[ETH_ALEN];
3002 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3004 /** Length of ric_ies buffer in octets */
3009 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3011 struct ibss_rsn_start {
3016 * struct auth_info - Data for EVENT_AUTH events
3027 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3029 struct assoc_reject {
3031 * bssid - BSSID of the AP that rejected association
3036 * resp_ies - (Re)Association Response IEs
3038 * Optional association data from the driver. This data is not
3039 * required WPA, but may be useful for some protocols and as
3040 * such, should be reported if this is available to the driver
3043 * This should start with the first IE (fixed fields before IEs
3044 * are not included).
3049 * resp_ies_len - Length of resp_ies in bytes
3051 size_t resp_ies_len;
3054 * status_code - Status Code from (Re)association Response
3059 struct timeout_event {
3064 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3073 * struct tx_status - Data for EVENT_TX_STATUS events
3085 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3087 struct rx_from_unknown {
3093 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3103 * struct rx_action - Data for EVENT_RX_ACTION events
3107 * da - Destination address of the received Action frame
3112 * sa - Source address of the received Action frame
3117 * bssid - Address 3 of the received Action frame
3122 * category - Action frame category
3127 * data - Action frame body after category field
3132 * len - Length of data in octets
3137 * freq - Frequency (in MHz) on which the frame was received
3143 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3145 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3147 struct remain_on_channel {
3149 * freq - Channel frequency in MHz
3154 * duration - Duration to remain on the channel in milliseconds
3156 unsigned int duration;
3157 } remain_on_channel;
3160 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3161 * @aborted: Whether the scan was aborted
3162 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3163 * @num_freqs: Number of entries in freqs array
3164 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3166 * @num_ssids: Number of entries in ssids array
3172 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3177 * struct mlme_rx - Data for EVENT_MLME_RX events
3188 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3190 struct rx_probe_req {
3192 * sa - Source address of the received Probe Request frame
3197 * da - Destination address of the received Probe Request frame
3198 * or %NULL if not available
3203 * bssid - BSSID of the received Probe Request frame or %NULL
3209 * ie - IEs from the Probe Request body
3214 * ie_len - Length of ie buffer in octets
3220 * struct new_sta - Data for EVENT_NEW_STA events
3227 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3236 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3238 struct wpa_signal_info signal_change;
3241 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3242 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3243 * @freq_5: Best 5 GHz band channel frequency in MHz
3244 * @freq_overall: Best channel frequency in MHz
3246 * 0 can be used to indicate no preference in either band.
3248 struct best_channel {
3254 struct unprot_deauth {
3260 struct unprot_disassoc {
3267 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3268 * @addr: station address
3275 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3277 struct p2p_dev_found {
3280 const u8 *pri_dev_type;
3281 const char *dev_name;
3288 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3290 struct p2p_go_neg_req_rx {
3293 } p2p_go_neg_req_rx;
3296 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3298 struct p2p_go_neg_completed {
3299 struct p2p_go_neg_results *res;
3300 } p2p_go_neg_completed;
3302 struct p2p_prov_disc_req {
3306 const u8 *pri_dev_type;
3307 const char *dev_name;
3308 u16 supp_config_methods;
3311 } p2p_prov_disc_req;
3313 struct p2p_prov_disc_resp {
3316 } p2p_prov_disc_resp;
3327 struct p2p_sd_resp {
3335 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3337 struct ibss_peer_lost {
3342 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3344 struct driver_gtk_rekey {
3346 const u8 *replay_ctr;
3351 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3352 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3353 * with struct wpa_driver_ops::init()
3354 * @event: event type (defined above)
3355 * @data: possible extra data for the event
3357 * Driver wrapper code should call this function whenever an event is received
3360 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
3361 union wpa_event_data *data);
3365 * The following inline functions are provided for convenience to simplify
3366 * event indication for some of the common events.
3369 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
3370 size_t ielen, int reassoc)
3372 union wpa_event_data event;
3373 os_memset(&event, 0, sizeof(event));
3374 event.assoc_info.reassoc = reassoc;
3375 event.assoc_info.req_ies = ie;
3376 event.assoc_info.req_ies_len = ielen;
3377 event.assoc_info.addr = addr;
3378 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
3381 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
3383 union wpa_event_data event;
3384 os_memset(&event, 0, sizeof(event));
3385 event.disassoc_info.addr = addr;
3386 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
3389 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
3392 union wpa_event_data event;
3393 os_memset(&event, 0, sizeof(event));
3394 event.eapol_rx.src = src;
3395 event.eapol_rx.data = data;
3396 event.eapol_rx.data_len = data_len;
3397 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
3400 #endif /* DRIVER_H */