2 * Driver interface definition
3 * Copyright (c) 2003-2010, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
14 * This file defines a driver interface used by both %wpa_supplicant and
15 * hostapd. The first part of the file defines data structures used in various
16 * driver operations. This is followed by the struct wpa_driver_ops that each
17 * driver wrapper will beed to define with callback functions for requesting
18 * driver operations. After this, there are definitions for driver event
19 * reporting with wpa_supplicant_event() and some convenience helper functions
20 * that can be used to report events.
26 #define WPA_SUPPLICANT_DRIVER_VERSION 4
28 #include "common/defs.h"
30 #define HOSTAPD_CHAN_DISABLED 0x00000001
31 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
32 #define HOSTAPD_CHAN_NO_IBSS 0x00000004
33 #define HOSTAPD_CHAN_RADAR 0x00000008
34 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
35 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
36 #define HOSTAPD_CHAN_HT40 0x00000040
39 * struct hostapd_channel_data - Channel information
41 struct hostapd_channel_data {
43 * chan - Channel number (IEEE 802.11)
48 * freq - Frequency in MHz
53 * flag - Channel flags (HOSTAPD_CHAN_*)
58 * max_tx_power - maximum transmit power in dBm
64 * struct hostapd_hw_modes - Supported hardware mode information
66 struct hostapd_hw_modes {
68 * mode - Hardware mode
70 enum hostapd_hw_mode mode;
73 * num_channels - Number of entries in the channels array
78 * channels - Array of supported channels
80 struct hostapd_channel_data *channels;
83 * num_rates - Number of entries in the rates array
88 * rates - Array of supported rates in 100 kbps units
93 * ht_capab - HT (IEEE 802.11n) capabilities
98 * mcs_set - MCS (IEEE 802.11n) rate parameters
103 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
109 #define IEEE80211_MODE_INFRA 0
110 #define IEEE80211_MODE_IBSS 1
111 #define IEEE80211_MODE_AP 2
113 #define IEEE80211_CAP_ESS 0x0001
114 #define IEEE80211_CAP_IBSS 0x0002
115 #define IEEE80211_CAP_PRIVACY 0x0010
117 #define WPA_SCAN_QUAL_INVALID BIT(0)
118 #define WPA_SCAN_NOISE_INVALID BIT(1)
119 #define WPA_SCAN_LEVEL_INVALID BIT(2)
120 #define WPA_SCAN_LEVEL_DBM BIT(3)
121 #define WPA_SCAN_AUTHENTICATED BIT(4)
122 #define WPA_SCAN_ASSOCIATED BIT(5)
125 * struct wpa_scan_res - Scan result for an BSS/IBSS
126 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
128 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
129 * @beacon_int: beacon interval in TUs (host byte order)
130 * @caps: capability information field in host byte order
131 * @qual: signal quality
132 * @noise: noise level
133 * @level: signal level
135 * @age: Age of the information in milliseconds (i.e., how many milliseconds
136 * ago the last Beacon or Probe Response frame was received)
137 * @ie_len: length of the following IE field in octets
138 * @beacon_ie_len: length of the following Beacon IE field in octets
140 * This structure is used as a generic format for scan results from the
141 * driver. Each driver interface implementation is responsible for converting
142 * the driver or OS specific scan results into this format.
144 * If the driver does not support reporting all IEs, the IE data structure is
145 * constructed of the IEs that are available. This field will also need to
146 * include SSID in IE format. All drivers are encouraged to be extended to
147 * report all IEs to make it easier to support future additions.
149 struct wpa_scan_res {
161 size_t beacon_ie_len;
163 * Followed by ie_len octets of IEs from Probe Response frame (or if
164 * the driver does not indicate source of IEs, these may also be from
165 * Beacon frame). After the first set of IEs, another set of IEs may
166 * follow (with beacon_ie_len octets of data) if the driver provides
172 * struct wpa_scan_results - Scan results
173 * @res: Array of pointers to allocated variable length scan result entries
174 * @num: Number of entries in the scan result array
176 struct wpa_scan_results {
177 struct wpa_scan_res **res;
182 * struct wpa_interface_info - Network interface information
183 * @next: Pointer to the next interface or NULL if this is the last one
184 * @ifname: Interface name that can be used with init() or init2()
185 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
187 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
188 * is not an allocated copy, i.e., get_interfaces() caller will not free
191 struct wpa_interface_info {
192 struct wpa_interface_info *next;
195 const char *drv_name;
198 #define WPAS_MAX_SCAN_SSIDS 16
201 * struct wpa_driver_scan_params - Scan parameters
202 * Data for struct wpa_driver_ops::scan2().
204 struct wpa_driver_scan_params {
206 * ssids - SSIDs to scan for
208 struct wpa_driver_scan_ssid {
210 * ssid - specific SSID to scan for (ProbeReq)
211 * %NULL or zero-length SSID is used to indicate active scan
212 * with wildcard SSID.
216 * ssid_len: Length of the SSID in octets
219 } ssids[WPAS_MAX_SCAN_SSIDS];
222 * num_ssids - Number of entries in ssids array
223 * Zero indicates a request for a passive scan.
228 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
233 * extra_ies_len - Length of extra_ies in octets
235 size_t extra_ies_len;
238 * freqs - Array of frequencies to scan or %NULL for all frequencies
240 * The frequency is set in MHz. The array is zero-terminated.
245 * filter_ssids - Filter for reporting SSIDs
247 * This optional parameter can be used to request the driver wrapper to
248 * filter scan results to include only the specified SSIDs. %NULL
249 * indicates that no filtering is to be done. This can be used to
250 * reduce memory needs for scan results in environments that have large
251 * number of APs with different SSIDs.
253 * The driver wrapper is allowed to take this allocated buffer into its
254 * own use by setting the pointer to %NULL. In that case, the driver
255 * wrapper is responsible for freeing the buffer with os_free() once it
256 * is not needed anymore.
258 struct wpa_driver_scan_filter {
264 * num_filter_ssids - Number of entries in filter_ssids array
266 size_t num_filter_ssids;
269 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
271 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
272 * Mbps from the support rates element(s) in the Probe Request frames
273 * and not to transmit the frames at any of those rates.
279 * struct wpa_driver_auth_params - Authentication parameters
280 * Data for struct wpa_driver_ops::authenticate().
282 struct wpa_driver_auth_params {
290 const u8 *wep_key[4];
291 size_t wep_key_len[4];
293 int local_state_change;
296 * p2p - Whether this connection is a P2P group
303 WPS_MODE_NONE /* no WPS provisioning being used */,
304 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
305 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
310 * struct wpa_driver_associate_params - Association parameters
311 * Data for struct wpa_driver_ops::associate().
313 struct wpa_driver_associate_params {
315 * bssid - BSSID of the selected AP
316 * This can be %NULL, if ap_scan=2 mode is used and the driver is
317 * responsible for selecting with which BSS to associate. */
321 * ssid - The selected SSID
326 * ssid_len - Length of the SSID (1..32)
331 * freq - Frequency of the channel the selected AP is using
332 * Frequency that the selected AP is using (in MHz as
333 * reported in the scan results)
338 * wpa_ie - WPA information element for (Re)Association Request
339 * WPA information element to be included in (Re)Association
340 * Request (including information element id and length). Use
341 * of this WPA IE is optional. If the driver generates the WPA
342 * IE, it can use pairwise_suite, group_suite, and
343 * key_mgmt_suite to select proper algorithms. In this case,
344 * the driver has to notify wpa_supplicant about the used WPA
345 * IE by generating an event that the interface code will
346 * convert into EVENT_ASSOCINFO data (see below).
348 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
349 * instead. The driver can determine which version is used by
350 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
353 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
358 * wpa_ie_len - length of the wpa_ie
363 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
365 unsigned int wpa_proto;
368 * pairwise_suite - Selected pairwise cipher suite
370 * This is usually ignored if @wpa_ie is used.
372 enum wpa_cipher pairwise_suite;
375 * group_suite - Selected group cipher suite
377 * This is usually ignored if @wpa_ie is used.
379 enum wpa_cipher group_suite;
382 * key_mgmt_suite - Selected key management suite
384 * This is usually ignored if @wpa_ie is used.
386 enum wpa_key_mgmt key_mgmt_suite;
389 * auth_alg - Allowed authentication algorithms
390 * Bit field of WPA_AUTH_ALG_*
395 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
400 * wep_key - WEP keys for static WEP configuration
402 const u8 *wep_key[4];
405 * wep_key_len - WEP key length for static WEP configuration
407 size_t wep_key_len[4];
410 * wep_tx_keyidx - WEP TX key index for static WEP configuration
415 * mgmt_frame_protection - IEEE 802.11w management frame protection
417 enum mfp_options mgmt_frame_protection;
420 * ft_ies - IEEE 802.11r / FT information elements
421 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
422 * for fast transition, this parameter is set to include the IEs that
423 * are to be sent in the next FT Authentication Request message.
424 * update_ft_ies() handler is called to update the IEs for further
425 * FT messages in the sequence.
427 * The driver should use these IEs only if the target AP is advertising
428 * the same mobility domain as the one included in the MDIE here.
430 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
431 * AP after the initial association. These IEs can only be used if the
432 * target AP is advertising support for FT and is using the same MDIE
433 * and SSID as the current AP.
435 * The driver is responsible for reporting the FT IEs received from the
436 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
437 * type. update_ft_ies() handler will then be called with the FT IEs to
438 * include in the next frame in the authentication sequence.
443 * ft_ies_len - Length of ft_ies in bytes
448 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
450 * This value is provided to allow the driver interface easier access
451 * to the current mobility domain. This value is set to %NULL if no
452 * mobility domain is currently active.
457 * passphrase - RSN passphrase for PSK
459 * This value is made available only for WPA/WPA2-Personal (PSK) and
460 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
461 * the 8..63 character ASCII passphrase, if available. Please note that
462 * this can be %NULL if passphrase was not used to generate the PSK. In
463 * that case, the psk field must be used to fetch the PSK.
465 const char *passphrase;
468 * psk - RSN PSK (alternative for passphrase for PSK)
470 * This value is made available only for WPA/WPA2-Personal (PSK) and
471 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
472 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
473 * be prepared to handle %NULL value as an error.
478 * drop_unencrypted - Enable/disable unencrypted frame filtering
480 * Configure the driver to drop all non-EAPOL frames (both receive and
481 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
482 * still be allowed for key negotiation.
484 int drop_unencrypted;
487 * prev_bssid - Previously used BSSID in this ESS
489 * When not %NULL, this is a request to use reassociation instead of
492 const u8 *prev_bssid;
497 * If the driver needs to do special configuration for WPS association,
498 * this variable provides more information on what type of association
499 * is being requested. Most drivers should not need ot use this.
504 * p2p - Whether this connection is a P2P group
509 * uapsd - UAPSD parameters for the network
510 * -1 = do not change defaults
511 * AP mode: 1 = enabled, 0 = disabled
512 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
519 HIDDEN_SSID_ZERO_LEN,
520 HIDDEN_SSID_ZERO_CONTENTS
523 struct wpa_driver_ap_params {
525 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
530 * head_len - Length of the head buffer in octets
535 * tail - Beacon tail following TIM IE
540 * tail_len - Length of the tail buffer in octets
545 * dtim_period - DTIM period
550 * beacon_int - Beacon interval
555 * ssid - The SSID to use in Beacon/Probe Response frames
560 * ssid_len - Length of the SSID (1..32)
565 * hide_ssid - Whether to hide the SSID
567 enum hide_ssid hide_ssid;
570 * pairwise_ciphers - WPA_CIPHER_* bitfield
572 unsigned int pairwise_ciphers;
575 * group_cipher - WPA_CIPHER_*
577 unsigned int group_cipher;
580 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
582 unsigned int key_mgmt_suites;
585 * auth_algs - WPA_AUTH_ALG_* bitfield
587 unsigned int auth_algs;
590 * wpa_version - WPA_PROTO_* bitfield
592 unsigned int wpa_version;
595 * privacy - Whether privacy is used in the BSS
600 * beacon_ies - WPS/P2P IE(s) for Beacon frames
602 * This is used to add IEs like WPS IE and P2P IE by drivers that do
603 * not use the full Beacon template.
605 const struct wpabuf *beacon_ies;
608 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
610 * This is used to add IEs like WPS IE and P2P IE by drivers that
611 * reply to Probe Request frames internally.
613 const struct wpabuf *proberesp_ies;
616 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
618 * This is used to add IEs like WPS IE by drivers that reply to
619 * (Re)Association Request frames internally.
621 const struct wpabuf *assocresp_ies;
624 * isolate - Whether to isolate frames between associated stations
626 * If this is non-zero, the AP is requested to disable forwarding of
627 * frames between association stations.
632 * cts_protect - Whether CTS protection is enabled
637 * preamble - Whether short preamble is enabled
642 * short_slot_time - Whether short slot time is enabled
644 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
645 * not set (e.g., when 802.11g mode is not in use)
650 * ht_opmode - HT operation mode or -1 if HT not in use
655 * interworking - Whether Interworking is enabled
660 * hessid - Homogeneous ESS identifier or %NULL if not set
666 * struct wpa_driver_capa - Driver capability information
668 struct wpa_driver_capa {
669 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
670 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
671 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
672 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
673 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
674 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
675 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
676 unsigned int key_mgmt;
678 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
679 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
680 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
681 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
684 #define WPA_DRIVER_AUTH_OPEN 0x00000001
685 #define WPA_DRIVER_AUTH_SHARED 0x00000002
686 #define WPA_DRIVER_AUTH_LEAP 0x00000004
689 /* Driver generated WPA/RSN IE */
690 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
691 /* Driver needs static WEP key setup after association command */
692 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
693 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
694 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
695 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
696 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
697 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
698 /* Driver provides separate commands for authentication and association (SME in
699 * wpa_supplicant). */
700 #define WPA_DRIVER_FLAGS_SME 0x00000020
701 /* Driver supports AP mode */
702 #define WPA_DRIVER_FLAGS_AP 0x00000040
703 /* Driver needs static WEP key setup after association has been completed */
704 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
705 /* Driver takes care of P2P management operations */
706 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
707 /* Driver supports concurrent P2P operations */
708 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
710 * Driver uses the initial interface as a dedicated management interface, i.e.,
711 * it cannot be used for P2P group operations or non-P2P purposes.
713 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
714 /* This interface is P2P capable (P2P Device, GO, or P2P Client */
715 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
716 /* Driver supports concurrent operations on multiple channels */
717 #define WPA_DRIVER_FLAGS_MULTI_CHANNEL_CONCURRENT 0x00001000
719 * Driver uses the initial interface for P2P management interface and non-P2P
720 * purposes (e.g., connect to infra AP), but this interface cannot be used for
721 * P2P group operations.
723 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
725 * Driver is known to use sane error codes, i.e., when it indicates that
726 * something (e.g., association) fails, there was indeed a failure and the
727 * operation does not end up getting completed successfully later.
729 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
730 /* Driver supports off-channel TX */
731 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
732 /* Driver indicates TX status events for EAPOL Data frames */
733 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
734 /* Driver indicates TX status events for Deauth/Disassoc frames */
735 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
736 /* Driver supports roaming (BSS selection) in firmware */
737 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
741 int max_sched_scan_ssids;
742 int sched_scan_supported;
746 * max_remain_on_chan - Maximum remain-on-channel duration in msec
748 unsigned int max_remain_on_chan;
751 * max_stations - Maximum number of associated stations the driver
752 * supports in AP mode
754 unsigned int max_stations;
760 struct hostap_sta_driver_data {
761 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
762 unsigned long current_tx_rate;
763 unsigned long inactive_msec;
765 unsigned long num_ps_buf_frames;
766 unsigned long tx_retry_failed;
767 unsigned long tx_retry_count;
772 struct hostapd_sta_add_params {
776 const u8 *supp_rates;
777 size_t supp_rates_len;
779 const struct ieee80211_ht_capabilities *ht_capabilities;
780 u32 flags; /* bitmask of WPA_STA_* flags */
783 struct hostapd_freq_params {
788 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
789 * secondary channel below primary, 1 = HT40
790 * enabled, secondary channel above primary */
793 enum wpa_driver_if_type {
795 * WPA_IF_STATION - Station mode interface
800 * WPA_IF_AP_VLAN - AP mode VLAN interface
802 * This interface shares its address and Beacon frame with the main
808 * WPA_IF_AP_BSS - AP mode BSS interface
810 * This interface has its own address and Beacon frame.
815 * WPA_IF_P2P_GO - P2P Group Owner
820 * WPA_IF_P2P_CLIENT - P2P Client
825 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
826 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
831 struct wpa_init_params {
836 const char *test_socket;
837 int use_pae_group_addr;
841 u8 *own_addr; /* buffer for writing own MAC address */
845 struct wpa_bss_params {
846 /** Interface name (for multi-SSID/VLAN support) */
848 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
857 enum mfp_options ieee80211w;
860 #define WPA_STA_AUTHORIZED BIT(0)
861 #define WPA_STA_WMM BIT(1)
862 #define WPA_STA_SHORT_PREAMBLE BIT(2)
863 #define WPA_STA_MFP BIT(3)
866 * struct p2p_params - P2P parameters for driver-based P2P management
869 const char *dev_name;
871 #define DRV_MAX_SEC_DEV_TYPES 5
872 u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8];
873 size_t num_sec_dev_types;
887 * struct wpa_signal_info - Information about channel signal quality
889 struct wpa_signal_info {
898 * struct wpa_driver_ops - Driver interface API definition
900 * This structure defines the API that each driver interface needs to implement
901 * for core wpa_supplicant code. All driver specific functionality is captured
904 struct wpa_driver_ops {
905 /** Name of the driver interface */
907 /** One line description of the driver interface */
911 * get_bssid - Get the current BSSID
912 * @priv: private driver interface data
913 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
915 * Returns: 0 on success, -1 on failure
917 * Query kernel driver for the current BSSID and copy it to bssid.
918 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
921 int (*get_bssid)(void *priv, u8 *bssid);
924 * get_ssid - Get the current SSID
925 * @priv: private driver interface data
926 * @ssid: buffer for SSID (at least 32 bytes)
928 * Returns: Length of the SSID on success, -1 on failure
930 * Query kernel driver for the current SSID and copy it to ssid.
931 * Returning zero is recommended if the STA is not associated.
933 * Note: SSID is an array of octets, i.e., it is not nul terminated and
934 * can, at least in theory, contain control characters (including nul)
935 * and as such, should be processed as binary data, not a printable
938 int (*get_ssid)(void *priv, u8 *ssid);
941 * set_key - Configure encryption key
942 * @ifname: Interface name (for multi-SSID/VLAN support)
943 * @priv: private driver interface data
944 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
945 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
946 * %WPA_ALG_NONE clears the key.
947 * @addr: Address of the peer STA (BSSID of the current AP when setting
948 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
949 * broadcast keys, %NULL for default keys that are used both for
950 * broadcast and unicast; when clearing keys, %NULL is used to
951 * indicate that both the broadcast-only and default key of the
952 * specified key index is to be cleared
953 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
955 * @set_tx: configure this key as the default Tx key (only used when
956 * driver does not support separate unicast/individual key
957 * @seq: sequence number/packet number, seq_len octets, the next
958 * packet number to be used for in replay protection; configured
959 * for Rx keys (in most cases, this is only used with broadcast
960 * keys and set to zero for unicast keys); %NULL if not set
961 * @seq_len: length of the seq, depends on the algorithm:
962 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
963 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
965 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
966 * TKIP: 32, CCMP: 16, IGTK: 16)
968 * Returns: 0 on success, -1 on failure
970 * Configure the given key for the kernel driver. If the driver
971 * supports separate individual keys (4 default keys + 1 individual),
972 * addr can be used to determine whether the key is default or
973 * individual. If only 4 keys are supported, the default key with key
974 * index 0 is used as the individual key. STA must be configured to use
975 * it as the default Tx key (set_tx is set) and accept Rx for all the
976 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
977 * broadcast keys, so key index 0 is available for this kind of
980 * Please note that TKIP keys include separate TX and RX MIC keys and
981 * some drivers may expect them in different order than wpa_supplicant
982 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
983 * will trigger Michael MIC errors. This can be fixed by changing the
984 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
985 * in driver_*.c set_key() implementation, see driver_ndis.c for an
986 * example on how this can be done.
988 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
989 const u8 *addr, int key_idx, int set_tx,
990 const u8 *seq, size_t seq_len,
991 const u8 *key, size_t key_len);
994 * init - Initialize driver interface
995 * @ctx: context to be used when calling wpa_supplicant functions,
996 * e.g., wpa_supplicant_event()
997 * @ifname: interface name, e.g., wlan0
999 * Returns: Pointer to private data, %NULL on failure
1001 * Initialize driver interface, including event processing for kernel
1002 * driver events (e.g., associated, scan results, Michael MIC failure).
1003 * This function can allocate a private configuration data area for
1004 * @ctx, file descriptor, interface name, etc. information that may be
1005 * needed in future driver operations. If this is not used, non-NULL
1006 * value will need to be returned because %NULL is used to indicate
1007 * failure. The returned value will be used as 'void *priv' data for
1008 * all other driver_ops functions.
1010 * The main event loop (eloop.c) of wpa_supplicant can be used to
1011 * register callback for read sockets (eloop_register_read_sock()).
1013 * See below for more information about events and
1014 * wpa_supplicant_event() function.
1016 void * (*init)(void *ctx, const char *ifname);
1019 * deinit - Deinitialize driver interface
1020 * @priv: private driver interface data from init()
1022 * Shut down driver interface and processing of driver events. Free
1023 * private data buffer if one was allocated in init() handler.
1025 void (*deinit)(void *priv);
1028 * set_param - Set driver configuration parameters
1029 * @priv: private driver interface data from init()
1030 * @param: driver specific configuration parameters
1032 * Returns: 0 on success, -1 on failure
1034 * Optional handler for notifying driver interface about configuration
1035 * parameters (driver_param).
1037 int (*set_param)(void *priv, const char *param);
1040 * set_countermeasures - Enable/disable TKIP countermeasures
1041 * @priv: private driver interface data
1042 * @enabled: 1 = countermeasures enabled, 0 = disabled
1044 * Returns: 0 on success, -1 on failure
1046 * Configure TKIP countermeasures. When these are enabled, the driver
1047 * should drop all received and queued frames that are using TKIP.
1049 int (*set_countermeasures)(void *priv, int enabled);
1052 * deauthenticate - Request driver to deauthenticate
1053 * @priv: private driver interface data
1054 * @addr: peer address (BSSID of the AP)
1055 * @reason_code: 16-bit reason code to be sent in the deauthentication
1058 * Returns: 0 on success, -1 on failure
1060 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1063 * disassociate - Request driver to disassociate
1064 * @priv: private driver interface data
1065 * @addr: peer address (BSSID of the AP)
1066 * @reason_code: 16-bit reason code to be sent in the disassociation
1069 * Returns: 0 on success, -1 on failure
1071 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
1074 * associate - Request driver to associate
1075 * @priv: private driver interface data
1076 * @params: association parameters
1078 * Returns: 0 on success, -1 on failure
1080 int (*associate)(void *priv,
1081 struct wpa_driver_associate_params *params);
1084 * add_pmkid - Add PMKSA cache entry to the driver
1085 * @priv: private driver interface data
1086 * @bssid: BSSID for the PMKSA cache entry
1087 * @pmkid: PMKID for the PMKSA cache entry
1089 * Returns: 0 on success, -1 on failure
1091 * This function is called when a new PMK is received, as a result of
1092 * either normal authentication or RSN pre-authentication.
1094 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1095 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1096 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1097 * driver_ops function does not need to be implemented. Likewise, if
1098 * the driver does not support WPA, this function is not needed.
1100 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1103 * remove_pmkid - Remove PMKSA cache entry to the driver
1104 * @priv: private driver interface data
1105 * @bssid: BSSID for the PMKSA cache entry
1106 * @pmkid: PMKID for the PMKSA cache entry
1108 * Returns: 0 on success, -1 on failure
1110 * This function is called when the supplicant drops a PMKSA cache
1111 * entry for any reason.
1113 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1114 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1115 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1116 * from wpa_supplicant, this driver_ops function does not need to be
1117 * implemented. Likewise, if the driver does not support WPA, this
1118 * function is not needed.
1120 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1123 * flush_pmkid - Flush PMKSA cache
1124 * @priv: private driver interface data
1126 * Returns: 0 on success, -1 on failure
1128 * This function is called when the supplicant drops all PMKSA cache
1129 * entries for any reason.
1131 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1132 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1133 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1134 * from wpa_supplicant, this driver_ops function does not need to be
1135 * implemented. Likewise, if the driver does not support WPA, this
1136 * function is not needed.
1138 int (*flush_pmkid)(void *priv);
1141 * get_capa - Get driver capabilities
1142 * @priv: private driver interface data
1144 * Returns: 0 on success, -1 on failure
1146 * Get driver/firmware/hardware capabilities.
1148 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1151 * poll - Poll driver for association information
1152 * @priv: private driver interface data
1154 * This is an option callback that can be used when the driver does not
1155 * provide event mechanism for association events. This is called when
1156 * receiving WPA EAPOL-Key messages that require association
1157 * information. The driver interface is supposed to generate associnfo
1158 * event before returning from this callback function. In addition, the
1159 * driver interface should generate an association event after having
1160 * sent out associnfo.
1162 void (*poll)(void *priv);
1165 * get_ifname - Get interface name
1166 * @priv: private driver interface data
1168 * Returns: Pointer to the interface name. This can differ from the
1169 * interface name used in init() call. Init() is called first.
1171 * This optional function can be used to allow the driver interface to
1172 * replace the interface name with something else, e.g., based on an
1173 * interface mapping from a more descriptive name.
1175 const char * (*get_ifname)(void *priv);
1178 * get_mac_addr - Get own MAC address
1179 * @priv: private driver interface data
1181 * Returns: Pointer to own MAC address or %NULL on failure
1183 * This optional function can be used to get the own MAC address of the
1184 * device from the driver interface code. This is only needed if the
1185 * l2_packet implementation for the OS does not provide easy access to
1187 const u8 * (*get_mac_addr)(void *priv);
1190 * send_eapol - Optional function for sending EAPOL packets
1191 * @priv: private driver interface data
1192 * @dest: Destination MAC address
1194 * @data: EAPOL packet starting with IEEE 802.1X header
1195 * @data_len: Size of the EAPOL packet
1197 * Returns: 0 on success, -1 on failure
1199 * This optional function can be used to override l2_packet operations
1200 * with driver specific functionality. If this function pointer is set,
1201 * l2_packet module is not used at all and the driver interface code is
1202 * responsible for receiving and sending all EAPOL packets. The
1203 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1204 * event. The driver interface is required to implement get_mac_addr()
1205 * handler if send_eapol() is used.
1207 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1208 const u8 *data, size_t data_len);
1211 * set_operstate - Sets device operating state to DORMANT or UP
1212 * @priv: private driver interface data
1213 * @state: 0 = dormant, 1 = up
1214 * Returns: 0 on success, -1 on failure
1216 * This is an optional function that can be used on operating systems
1217 * that support a concept of controlling network device state from user
1218 * space applications. This function, if set, gets called with
1219 * state = 1 when authentication has been completed and with state = 0
1220 * when connection is lost.
1222 int (*set_operstate)(void *priv, int state);
1225 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1226 * @priv: Private driver interface data
1227 * @addr: Address of the station for which to set protection (may be
1228 * %NULL for group keys)
1229 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1230 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1231 * Returns: 0 on success, -1 on failure
1233 * This is an optional function that can be used to set the driver to
1234 * require protection for Tx and/or Rx frames. This uses the layer
1235 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1236 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1237 * set protection operation; instead, they set protection implicitly
1238 * based on configured keys.
1240 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1244 * get_hw_feature_data - Get hardware support data (channels and rates)
1245 * @priv: Private driver interface data
1246 * @num_modes: Variable for returning the number of returned modes
1247 * flags: Variable for returning hardware feature flags
1248 * Returns: Pointer to allocated hardware data on success or %NULL on
1249 * failure. Caller is responsible for freeing this.
1251 * This function is only needed for drivers that export MLME
1252 * (management frame processing) to %wpa_supplicant or hostapd.
1254 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1259 * set_channel - Set channel
1260 * @priv: Private driver interface data
1261 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
1262 * @chan: IEEE 802.11 channel number
1263 * @freq: Frequency of the channel in MHz
1264 * Returns: 0 on success, -1 on failure
1266 * This function is only needed for drivers that export MLME
1267 * (management frame processing) to wpa_supplicant.
1269 int (*set_channel)(void *priv, enum hostapd_hw_mode phymode, int chan,
1273 * set_ssid - Set SSID
1274 * @priv: Private driver interface data
1276 * @ssid_len: SSID length
1277 * Returns: 0 on success, -1 on failure
1279 * This function is only needed for drivers that export MLME
1280 * (management frame processing) to wpa_supplicant.
1282 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
1285 * set_bssid - Set BSSID
1286 * @priv: Private driver interface data
1288 * Returns: 0 on success, -1 on failure
1290 * This function is only needed for drivers that export MLME
1291 * (management frame processing) to wpa_supplicant.
1293 int (*set_bssid)(void *priv, const u8 *bssid);
1296 * send_mlme - Send management frame from MLME
1297 * @priv: Private driver interface data
1298 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1299 * @data_len: Size of the management frame
1300 * Returns: 0 on success, -1 on failure
1302 * This function is only needed for drivers that export MLME
1303 * (management frame processing) to wpa_supplicant.
1305 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
1308 * mlme_add_sta - Add a STA entry into the driver/netstack
1309 * @priv: Private driver interface data
1310 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1311 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
1312 * format (one octet per rate, 1 = 0.5 Mbps)
1313 * @supp_rates_len: Number of entries in supp_rates
1314 * Returns: 0 on success, -1 on failure
1316 * This function is only needed for drivers that export MLME
1317 * (management frame processing) to wpa_supplicant. When the MLME code
1318 * completes association with an AP, this function is called to
1319 * configure the driver/netstack with a STA entry for data frame
1320 * processing (TX rate control, encryption/decryption).
1322 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
1323 size_t supp_rates_len);
1326 * mlme_remove_sta - Remove a STA entry from the driver/netstack
1327 * @priv: Private driver interface data
1328 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1329 * Returns: 0 on success, -1 on failure
1331 * This function is only needed for drivers that export MLME
1332 * (management frame processing) to wpa_supplicant.
1334 int (*mlme_remove_sta)(void *priv, const u8 *addr);
1337 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1338 * @priv: Private driver interface data
1339 * @md: Mobility domain (2 octets) (also included inside ies)
1340 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1341 * @ies_len: Length of FT IEs in bytes
1342 * Returns: 0 on success, -1 on failure
1344 * The supplicant uses this callback to let the driver know that keying
1345 * material for FT is available and that the driver can use the
1346 * provided IEs in the next message in FT authentication sequence.
1348 * This function is only needed for driver that support IEEE 802.11r
1349 * (Fast BSS Transition).
1351 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1355 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1356 * @priv: Private driver interface data
1357 * @action: Action field value
1358 * @target_ap: Target AP address
1359 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1360 * @ies_len: Length of FT IEs in bytes
1361 * Returns: 0 on success, -1 on failure
1363 * The supplicant uses this callback to request the driver to transmit
1364 * an FT Action frame (action category 6) for over-the-DS fast BSS
1367 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1368 const u8 *ies, size_t ies_len);
1371 * get_scan_results2 - Fetch the latest scan results
1372 * @priv: private driver interface data
1374 * Returns: Allocated buffer of scan results (caller is responsible for
1375 * freeing the data structure) on success, NULL on failure
1377 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1380 * set_country - Set country
1381 * @priv: Private driver interface data
1382 * @alpha2: country to which to switch to
1383 * Returns: 0 on success, -1 on failure
1385 * This function is for drivers which support some form
1386 * of setting a regulatory domain.
1388 int (*set_country)(void *priv, const char *alpha2);
1391 * global_init - Global driver initialization
1392 * Returns: Pointer to private data (global), %NULL on failure
1394 * This optional function is called to initialize the driver wrapper
1395 * for global data, i.e., data that applies to all interfaces. If this
1396 * function is implemented, global_deinit() will also need to be
1397 * implemented to free the private data. The driver will also likely
1398 * use init2() function instead of init() to get the pointer to global
1399 * data available to per-interface initializer.
1401 void * (*global_init)(void);
1404 * global_deinit - Global driver deinitialization
1405 * @priv: private driver global data from global_init()
1407 * Terminate any global driver related functionality and free the
1408 * global data structure.
1410 void (*global_deinit)(void *priv);
1413 * init2 - Initialize driver interface (with global data)
1414 * @ctx: context to be used when calling wpa_supplicant functions,
1415 * e.g., wpa_supplicant_event()
1416 * @ifname: interface name, e.g., wlan0
1417 * @global_priv: private driver global data from global_init()
1418 * Returns: Pointer to private data, %NULL on failure
1420 * This function can be used instead of init() if the driver wrapper
1423 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1426 * get_interfaces - Get information about available interfaces
1427 * @global_priv: private driver global data from global_init()
1428 * Returns: Allocated buffer of interface information (caller is
1429 * responsible for freeing the data structure) on success, NULL on
1432 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1435 * scan2 - Request the driver to initiate scan
1436 * @priv: private driver interface data
1437 * @params: Scan parameters
1439 * Returns: 0 on success, -1 on failure
1441 * Once the scan results are ready, the driver should report scan
1442 * results event for wpa_supplicant which will eventually request the
1443 * results with wpa_driver_get_scan_results2().
1445 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1448 * authenticate - Request driver to authenticate
1449 * @priv: private driver interface data
1450 * @params: authentication parameters
1451 * Returns: 0 on success, -1 on failure
1453 * This is an optional function that can be used with drivers that
1454 * support separate authentication and association steps, i.e., when
1455 * wpa_supplicant can act as the SME. If not implemented, associate()
1456 * function is expected to take care of IEEE 802.11 authentication,
1459 int (*authenticate)(void *priv,
1460 struct wpa_driver_auth_params *params);
1463 * set_ap - Set Beacon and Probe Response information for AP mode
1464 * @priv: Private driver interface data
1465 * @params: Parameters to use in AP mode
1467 * This function is used to configure Beacon template and/or extra IEs
1468 * to add for Beacon and Probe Response frames for the driver in
1469 * AP mode. The driver is responsible for building the full Beacon
1470 * frame by concatenating the head part with TIM IE generated by the
1471 * driver/firmware and finishing with the tail part. Depending on the
1472 * driver architectue, this can be done either by using the full
1473 * template or the set of additional IEs (e.g., WPS and P2P IE).
1474 * Similarly, Probe Response processing depends on the driver design.
1475 * If the driver (or firmware) takes care of replying to Probe Request
1476 * frames, the extra IEs provided here needs to be added to the Probe
1479 * Returns: 0 on success, -1 on failure
1481 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1484 * hapd_init - Initialize driver interface (hostapd only)
1485 * @hapd: Pointer to hostapd context
1486 * @params: Configuration for the driver wrapper
1487 * Returns: Pointer to private data, %NULL on failure
1489 * This function is used instead of init() or init2() when the driver
1490 * wrapper is used with hostapd.
1492 void * (*hapd_init)(struct hostapd_data *hapd,
1493 struct wpa_init_params *params);
1496 * hapd_deinit - Deinitialize driver interface (hostapd only)
1497 * @priv: Private driver interface data from hapd_init()
1499 void (*hapd_deinit)(void *priv);
1502 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1503 * @priv: Private driver interface data
1504 * @params: BSS parameters
1505 * Returns: 0 on success, -1 on failure
1507 * This is an optional function to configure the kernel driver to
1508 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1509 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1510 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1511 * for Beacon frames.
1513 * DEPRECATED - use set_ap() instead
1515 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1518 * set_privacy - Enable/disable privacy (AP only)
1519 * @priv: Private driver interface data
1520 * @enabled: 1 = privacy enabled, 0 = disabled
1521 * Returns: 0 on success, -1 on failure
1523 * This is an optional function to configure privacy field in the
1524 * kernel driver for Beacon frames. This can be left undefined (set to
1525 * %NULL) if the driver uses the Beacon template from set_ap().
1527 * DEPRECATED - use set_ap() instead
1529 int (*set_privacy)(void *priv, int enabled);
1532 * get_seqnum - Fetch the current TSC/packet number (AP only)
1533 * @ifname: The interface name (main or virtual)
1534 * @priv: Private driver interface data
1535 * @addr: MAC address of the station or %NULL for group keys
1537 * @seq: Buffer for returning the latest used TSC/packet number
1538 * Returns: 0 on success, -1 on failure
1540 * This function is used to fetch the last used TSC/packet number for
1541 * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so
1542 * there is no strict requirement on implementing support for unicast
1543 * keys (i.e., addr != %NULL).
1545 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1549 * flush - Flush all association stations (AP only)
1550 * @priv: Private driver interface data
1551 * Returns: 0 on success, -1 on failure
1553 * This function requests the driver to disassociate all associated
1554 * stations. This function does not need to be implemented if the
1555 * driver does not process association frames internally.
1557 int (*flush)(void *priv);
1560 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1561 * @priv: Private driver interface data
1562 * @elem: Information elements
1563 * @elem_len: Length of the elem buffer in octets
1564 * Returns: 0 on success, -1 on failure
1566 * This is an optional function to add information elements in the
1567 * kernel driver for Beacon and Probe Response frames. This can be left
1568 * undefined (set to %NULL) if the driver uses the Beacon template from
1571 * DEPRECATED - use set_ap() instead
1573 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1576 * read_sta_data - Fetch station data (AP only)
1577 * @priv: Private driver interface data
1578 * @data: Buffer for returning station information
1579 * @addr: MAC address of the station
1580 * Returns: 0 on success, -1 on failure
1582 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1586 * hapd_send_eapol - Send an EAPOL packet (AP only)
1587 * @priv: private driver interface data
1588 * @addr: Destination MAC address
1589 * @data: EAPOL packet starting with IEEE 802.1X header
1590 * @data_len: Length of the EAPOL packet in octets
1591 * @encrypt: Whether the frame should be encrypted
1592 * @own_addr: Source MAC address
1593 * @flags: WPA_STA_* flags for the destination station
1595 * Returns: 0 on success, -1 on failure
1597 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1598 size_t data_len, int encrypt,
1599 const u8 *own_addr, u32 flags);
1602 * sta_deauth - Deauthenticate a station (AP only)
1603 * @priv: Private driver interface data
1604 * @own_addr: Source address and BSSID for the Deauthentication frame
1605 * @addr: MAC address of the station to deauthenticate
1606 * @reason: Reason code for the Deauthentiation frame
1607 * Returns: 0 on success, -1 on failure
1609 * This function requests a specific station to be deauthenticated and
1610 * a Deauthentication frame to be sent to it.
1612 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1616 * sta_disassoc - Disassociate a station (AP only)
1617 * @priv: Private driver interface data
1618 * @own_addr: Source address and BSSID for the Disassociation frame
1619 * @addr: MAC address of the station to disassociate
1620 * @reason: Reason code for the Disassociation frame
1621 * Returns: 0 on success, -1 on failure
1623 * This function requests a specific station to be disassociated and
1624 * a Disassociation frame to be sent to it.
1626 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1630 * sta_remove - Remove a station entry (AP only)
1631 * @priv: Private driver interface data
1632 * @addr: MAC address of the station to be removed
1633 * Returns: 0 on success, -1 on failure
1635 int (*sta_remove)(void *priv, const u8 *addr);
1638 * hapd_get_ssid - Get the current SSID (AP only)
1639 * @priv: Private driver interface data
1640 * @buf: Buffer for returning the SSID
1641 * @len: Maximum length of the buffer
1642 * Returns: Length of the SSID on success, -1 on failure
1644 * This function need not be implemented if the driver uses Beacon
1645 * template from set_ap() and does not reply to Probe Request frames.
1647 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1650 * hapd_set_ssid - Set SSID (AP only)
1651 * @priv: Private driver interface data
1653 * @len: Length of the SSID in octets
1654 * Returns: 0 on success, -1 on failure
1656 * DEPRECATED - use set_ap() instead
1658 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1661 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1662 * @priv: Private driver interface data
1663 * @enabled: 1 = countermeasures enabled, 0 = disabled
1664 * Returns: 0 on success, -1 on failure
1666 * This need not be implemented if the driver does not take care of
1667 * association processing.
1669 int (*hapd_set_countermeasures)(void *priv, int enabled);
1672 * sta_add - Add a station entry
1673 * @priv: Private driver interface data
1674 * @params: Station parameters
1675 * Returns: 0 on success, -1 on failure
1677 * This function is used to add a station entry to the driver once the
1678 * station has completed association. This is only used if the driver
1679 * does not take care of association processing.
1681 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1684 * get_inact_sec - Get station inactivity duration (AP only)
1685 * @priv: Private driver interface data
1686 * @addr: Station address
1687 * Returns: Number of seconds station has been inactive, -1 on failure
1689 int (*get_inact_sec)(void *priv, const u8 *addr);
1692 * sta_clear_stats - Clear station statistics (AP only)
1693 * @priv: Private driver interface data
1694 * @addr: Station address
1695 * Returns: 0 on success, -1 on failure
1697 int (*sta_clear_stats)(void *priv, const u8 *addr);
1700 * set_freq - Set channel/frequency (AP only)
1701 * @priv: Private driver interface data
1702 * @freq: Channel parameters
1703 * Returns: 0 on success, -1 on failure
1705 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1708 * set_rts - Set RTS threshold
1709 * @priv: Private driver interface data
1710 * @rts: RTS threshold in octets
1711 * Returns: 0 on success, -1 on failure
1713 int (*set_rts)(void *priv, int rts);
1716 * set_frag - Set fragmentation threshold
1717 * @priv: Private driver interface data
1718 * @frag: Fragmentation threshold in octets
1719 * Returns: 0 on success, -1 on failure
1721 int (*set_frag)(void *priv, int frag);
1724 * sta_set_flags - Set station flags (AP only)
1725 * @priv: Private driver interface data
1726 * @addr: Station address
1727 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1728 * @flags_or: Bitmap of WPA_STA_* flags to add
1729 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1730 * Returns: 0 on success, -1 on failure
1732 int (*sta_set_flags)(void *priv, const u8 *addr,
1733 int total_flags, int flags_or, int flags_and);
1736 * set_rate_sets - Set supported and basic rate sets (AP only)
1737 * @priv: Private driver interface data
1738 * @supp_rates: -1 terminated array of supported rates in 100 kbps
1739 * @basic_rates: -1 terminated array of basic rates in 100 kbps
1740 * @mode: hardware mode (HOSTAPD_MODE_*)
1741 * Returns: 0 on success, -1 on failure
1743 int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
1747 * set_tx_queue_params - Set TX queue parameters
1748 * @priv: Private driver interface data
1749 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
1753 * @burst_time: Maximum length for bursting in 0.1 msec units
1755 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1756 int cw_max, int burst_time);
1759 * valid_bss_mask - Validate BSSID mask
1760 * @priv: Private driver interface data
1763 * Returns: 0 if mask is valid, -1 if mask is not valid, 1 if mask can
1764 * be used, but the main interface address must be the first address in
1765 * the block if mask is applied
1767 int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
1770 * if_add - Add a virtual interface
1771 * @priv: Private driver interface data
1772 * @type: Interface type
1773 * @ifname: Interface name for the new virtual interface
1774 * @addr: Local address to use for the interface or %NULL to use the
1775 * parent interface address
1776 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1777 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1778 * not allowed (applies only to %WPA_IF_AP_BSS type)
1779 * @force_ifname: Buffer for returning an interface name that the
1780 * driver ended up using if it differs from the requested ifname
1781 * @if_addr: Buffer for returning the allocated interface address
1782 * (this may differ from the requested addr if the driver cannot
1783 * change interface address)
1784 * @bridge: Bridge interface to use or %NULL if no bridge configured
1785 * Returns: 0 on success, -1 on failure
1787 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1788 const char *ifname, const u8 *addr, void *bss_ctx,
1789 void **drv_priv, char *force_ifname, u8 *if_addr,
1790 const char *bridge);
1793 * if_remove - Remove a virtual interface
1794 * @priv: Private driver interface data
1795 * @type: Interface type
1796 * @ifname: Interface name of the virtual interface to be removed
1797 * Returns: 0 on success, -1 on failure
1799 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1800 const char *ifname);
1803 * set_sta_vlan - Bind a station into a specific interface (AP only)
1804 * @priv: Private driver interface data
1805 * @ifname: Interface (main or virtual BSS or VLAN)
1806 * @addr: MAC address of the associated station
1808 * Returns: 0 on success, -1 on failure
1810 * This function is used to bind a station to a specific virtual
1811 * interface. It is only used if when virtual interfaces are supported,
1812 * e.g., to assign stations to different VLAN interfaces based on
1813 * information from a RADIUS server. This allows separate broadcast
1814 * domains to be used with a single BSS.
1816 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1820 * commit - Optional commit changes handler (AP only)
1821 * @priv: driver private data
1822 * Returns: 0 on success, -1 on failure
1824 * This optional handler function can be registered if the driver
1825 * interface implementation needs to commit changes (e.g., by setting
1826 * network interface up) at the end of initial configuration. If set,
1827 * this handler will be called after initial setup has been completed.
1829 int (*commit)(void *priv);
1832 * send_ether - Send an ethernet packet (AP only)
1833 * @priv: private driver interface data
1834 * @dst: Destination MAC address
1835 * @src: Source MAC address
1837 * @data: EAPOL packet starting with IEEE 802.1X header
1838 * @data_len: Length of the EAPOL packet in octets
1839 * Returns: 0 on success, -1 on failure
1841 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1842 const u8 *data, size_t data_len);
1845 * set_radius_acl_auth - Notification of RADIUS ACL change
1846 * @priv: Private driver interface data
1847 * @mac: MAC address of the station
1848 * @accepted: Whether the station was accepted
1849 * @session_timeout: Session timeout for the station
1850 * Returns: 0 on success, -1 on failure
1852 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1853 u32 session_timeout);
1856 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1857 * @priv: Private driver interface data
1858 * @mac: MAC address of the station
1859 * Returns: 0 on success, -1 on failure
1861 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1864 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
1865 * @priv: Private driver interface data
1866 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
1867 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
1869 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
1870 * to remove extra IE(s)
1871 * Returns: 0 on success, -1 on failure
1873 * This is an optional function to add WPS IE in the kernel driver for
1874 * Beacon and Probe Response frames. This can be left undefined (set
1875 * to %NULL) if the driver uses the Beacon template from set_ap()
1876 * and does not process Probe Request frames. If the driver takes care
1877 * of (Re)Association frame processing, the assocresp buffer includes
1878 * WPS IE(s) that need to be added to (Re)Association Response frames
1879 * whenever a (Re)Association Request frame indicated use of WPS.
1881 * This will also be used to add P2P IE(s) into Beacon/Probe Response
1882 * frames when operating as a GO. The driver is responsible for adding
1883 * timing related attributes (e.g., NoA) in addition to the IEs
1884 * included here by appending them after these buffers. This call is
1885 * also used to provide Probe Response IEs for P2P Listen state
1886 * operations for drivers that generate the Probe Response frames
1889 * DEPRECATED - use set_ap() instead
1891 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
1892 const struct wpabuf *proberesp,
1893 const struct wpabuf *assocresp);
1896 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1897 * @priv: Private driver interface data
1898 * @authorized: Whether the port is authorized
1899 * Returns: 0 on success, -1 on failure
1901 int (*set_supp_port)(void *priv, int authorized);
1904 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1905 * @priv: Private driver interface data
1906 * @addr: MAC address of the associated station
1907 * @aid: Association ID
1908 * @val: 1 = bind to 4-address WDS; 0 = unbind
1909 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
1910 * to indicate that bridge is not to be used
1911 * Returns: 0 on success, -1 on failure
1913 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
1914 const char *bridge_ifname);
1917 * send_action - Transmit an Action frame
1918 * @priv: Private driver interface data
1919 * @freq: Frequency (in MHz) of the channel
1920 * @wait: Time to wait off-channel for a response (in ms), or zero
1921 * @dst: Destination MAC address (Address 1)
1922 * @src: Source MAC address (Address 2)
1923 * @bssid: BSSID (Address 3)
1925 * @data_len: data length in octets
1926 * Returns: 0 on success, -1 on failure
1928 * This command can be used to request the driver to transmit an action
1929 * frame to the specified destination.
1931 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
1932 * be transmitted on the given channel and the device will wait for a
1933 * response on that channel for the given wait time.
1935 * If the flag is not set, the wait time will be ignored. In this case,
1936 * if a remain-on-channel duration is in progress, the frame must be
1937 * transmitted on that channel; alternatively the frame may be sent on
1938 * the current operational channel (if in associated state in station
1939 * mode or while operating as an AP.)
1941 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
1942 const u8 *dst, const u8 *src, const u8 *bssid,
1943 const u8 *data, size_t data_len);
1946 * send_action_cancel_wait - Cancel action frame TX wait
1947 * @priv: Private driver interface data
1949 * This command cancels the wait time associated with sending an action
1950 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
1951 * set in the driver flags.
1953 void (*send_action_cancel_wait)(void *priv);
1956 * remain_on_channel - Remain awake on a channel
1957 * @priv: Private driver interface data
1958 * @freq: Frequency (in MHz) of the channel
1959 * @duration: Duration in milliseconds
1960 * Returns: 0 on success, -1 on failure
1962 * This command is used to request the driver to remain awake on the
1963 * specified channel for the specified duration and report received
1964 * Action frames with EVENT_RX_ACTION events. Optionally, received
1965 * Probe Request frames may also be requested to be reported by calling
1966 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
1968 * The driver may not be at the requested channel when this function
1969 * returns, i.e., the return code is only indicating whether the
1970 * request was accepted. The caller will need to wait until the
1971 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
1972 * completed the channel change. This may take some time due to other
1973 * need for the radio and the caller should be prepared to timing out
1974 * its wait since there are no guarantees on when this request can be
1977 int (*remain_on_channel)(void *priv, unsigned int freq,
1978 unsigned int duration);
1981 * cancel_remain_on_channel - Cancel remain-on-channel operation
1982 * @priv: Private driver interface data
1984 * This command can be used to cancel a remain-on-channel operation
1985 * before its originally requested duration has passed. This could be
1986 * used, e.g., when remain_on_channel() is used to request extra time
1987 * to receive a response to an Action frame and the response is
1988 * received when there is still unneeded time remaining on the
1989 * remain-on-channel operation.
1991 int (*cancel_remain_on_channel)(void *priv);
1994 * probe_req_report - Request Probe Request frames to be indicated
1995 * @priv: Private driver interface data
1996 * @report: Whether to report received Probe Request frames
1997 * Returns: 0 on success, -1 on failure (or if not supported)
1999 * This command can be used to request the driver to indicate when
2000 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2001 * Since this operation may require extra resources, e.g., due to less
2002 * optimal hardware/firmware RX filtering, many drivers may disable
2003 * Probe Request reporting at least in station mode. This command is
2004 * used to notify the driver when the Probe Request frames need to be
2005 * reported, e.g., during remain-on-channel operations.
2007 int (*probe_req_report)(void *priv, int report);
2010 * disable_11b_rates - Set whether IEEE 802.11b rates are used for TX
2011 * @priv: Private driver interface data
2012 * @disabled: Whether IEEE 802.11b rates are disabled
2013 * Returns: 0 on success, -1 on failure (or if not supported)
2015 * This command is used to disable IEEE 802.11b rates (1, 2, 5.5, and
2016 * 11 Mbps) as TX rates for data and management frames. This can be
2017 * used to optimize channel use when there is no need to support IEEE
2018 * 802.11b-only devices.
2020 int (*disable_11b_rates)(void *priv, int disabled);
2023 * deinit_ap - Deinitialize AP mode
2024 * @priv: Private driver interface data
2025 * Returns: 0 on success, -1 on failure (or if not supported)
2027 * This optional function can be used to disable AP mode related
2028 * configuration and change the driver mode to station mode to allow
2029 * normal station operations like scanning to be completed.
2031 int (*deinit_ap)(void *priv);
2034 * suspend - Notification on system suspend/hibernate event
2035 * @priv: Private driver interface data
2037 void (*suspend)(void *priv);
2040 * resume - Notification on system resume/thaw event
2041 * @priv: Private driver interface data
2043 void (*resume)(void *priv);
2046 * signal_monitor - Set signal monitoring parameters
2047 * @priv: Private driver interface data
2048 * @threshold: Threshold value for signal change events; 0 = disabled
2049 * @hysteresis: Minimum change in signal strength before indicating a
2051 * Returns: 0 on success, -1 on failure (or if not supported)
2053 * This function can be used to configure monitoring of signal strength
2054 * with the current AP. Whenever signal strength drops below the
2055 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2056 * should be generated assuming the signal strength has changed at
2057 * least %hysteresis from the previously indicated signal change event.
2059 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2062 * send_frame - Send IEEE 802.11 frame (testing use only)
2063 * @priv: Private driver interface data
2064 * @data: IEEE 802.11 frame with IEEE 802.11 header
2065 * @data_len: Size of the frame
2066 * @encrypt: Whether to encrypt the frame (if keys are set)
2067 * Returns: 0 on success, -1 on failure
2069 * This function is only used for debugging purposes and is not
2070 * required to be implemented for normal operations.
2072 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2076 * shared_freq - Get operating frequency of shared interface(s)
2077 * @priv: Private driver interface data
2078 * Returns: Operating frequency in MHz, 0 if no shared operation in
2079 * use, or -1 on failure
2081 * This command can be used to request the current operating frequency
2082 * of any virtual interface that shares the same radio to provide
2083 * information for channel selection for other virtual interfaces.
2085 int (*shared_freq)(void *priv);
2088 * get_noa - Get current Notice of Absence attribute payload
2089 * @priv: Private driver interface data
2090 * @buf: Buffer for returning NoA
2091 * @buf_len: Buffer length in octets
2092 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2093 * advertized, or -1 on failure
2095 * This function is used to fetch the current Notice of Absence
2096 * attribute value from GO.
2098 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2101 * set_noa - Set Notice of Absence parameters for GO (testing)
2102 * @priv: Private driver interface data
2104 * @start: Start time in ms from next TBTT
2105 * @duration: Duration in ms
2106 * Returns: 0 on success or -1 on failure
2108 * This function is used to set Notice of Absence parameters for GO. It
2109 * is used only for testing. To disable NoA, all parameters are set to
2112 int (*set_noa)(void *priv, u8 count, int start, int duration);
2115 * set_p2p_powersave - Set P2P power save options
2116 * @priv: Private driver interface data
2117 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2118 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2119 * @ctwindow: 0.. = change (msec), -1 = no change
2120 * Returns: 0 on success or -1 on failure
2122 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2126 * ampdu - Enable/disable aggregation
2127 * @priv: Private driver interface data
2128 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2129 * Returns: 0 on success or -1 on failure
2131 int (*ampdu)(void *priv, int ampdu);
2134 * get_radio_name - Get physical radio name for the device
2135 * @priv: Private driver interface data
2136 * Returns: Radio name or %NULL if not known
2138 * The returned data must not be modified by the caller. It is assumed
2139 * that any interface that has the same radio name as another is
2140 * sharing the same physical radio. This information can be used to
2141 * share scan results etc. information between the virtual interfaces
2142 * to speed up various operations.
2144 const char * (*get_radio_name)(void *priv);
2147 * p2p_find - Start P2P Device Discovery
2148 * @priv: Private driver interface data
2149 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2150 * @type: Device Discovery type (enum p2p_discovery_type)
2151 * Returns: 0 on success, -1 on failure
2153 * This function is only used if the driver implements P2P management,
2154 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2155 * struct wpa_driver_capa.
2157 int (*p2p_find)(void *priv, unsigned int timeout, int type);
2160 * p2p_stop_find - Stop P2P Device Discovery
2161 * @priv: Private driver interface data
2162 * Returns: 0 on success, -1 on failure
2164 * This function is only used if the driver implements P2P management,
2165 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2166 * struct wpa_driver_capa.
2168 int (*p2p_stop_find)(void *priv);
2171 * p2p_listen - Start P2P Listen state for specified duration
2172 * @priv: Private driver interface data
2173 * @timeout: Listen state duration in milliseconds
2174 * Returns: 0 on success, -1 on failure
2176 * This function can be used to request the P2P module to keep the
2177 * device discoverable on the listen channel for an extended set of
2178 * time. At least in its current form, this is mainly used for testing
2179 * purposes and may not be of much use for normal P2P operations.
2181 * This function is only used if the driver implements P2P management,
2182 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2183 * struct wpa_driver_capa.
2185 int (*p2p_listen)(void *priv, unsigned int timeout);
2188 * p2p_connect - Start P2P group formation (GO negotiation)
2189 * @priv: Private driver interface data
2190 * @peer_addr: MAC address of the peer P2P client
2191 * @wps_method: enum p2p_wps_method value indicating config method
2192 * @go_intent: Local GO intent value (1..15)
2193 * @own_interface_addr: Intended interface address to use with the
2195 * @force_freq: The only allowed channel frequency in MHz or 0
2196 * @persistent_group: Whether to create persistent group
2197 * Returns: 0 on success, -1 on failure
2199 * This function is only used if the driver implements P2P management,
2200 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2201 * struct wpa_driver_capa.
2203 int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method,
2204 int go_intent, const u8 *own_interface_addr,
2205 unsigned int force_freq, int persistent_group);
2208 * wps_success_cb - Report successfully completed WPS provisioning
2209 * @priv: Private driver interface data
2210 * @peer_addr: Peer address
2211 * Returns: 0 on success, -1 on failure
2213 * This function is used to report successfully completed WPS
2214 * provisioning during group formation in both GO/Registrar and
2215 * client/Enrollee roles.
2217 * This function is only used if the driver implements P2P management,
2218 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2219 * struct wpa_driver_capa.
2221 int (*wps_success_cb)(void *priv, const u8 *peer_addr);
2224 * p2p_group_formation_failed - Report failed WPS provisioning
2225 * @priv: Private driver interface data
2226 * Returns: 0 on success, -1 on failure
2228 * This function is used to report failed group formation. This can
2229 * happen either due to failed WPS provisioning or due to 15 second
2230 * timeout during the provisioning phase.
2232 * This function is only used if the driver implements P2P management,
2233 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2234 * struct wpa_driver_capa.
2236 int (*p2p_group_formation_failed)(void *priv);
2239 * p2p_set_params - Set P2P parameters
2240 * @priv: Private driver interface data
2241 * @params: P2P parameters
2242 * Returns: 0 on success, -1 on failure
2244 * This function is only used if the driver implements P2P management,
2245 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2246 * struct wpa_driver_capa.
2248 int (*p2p_set_params)(void *priv, const struct p2p_params *params);
2251 * p2p_prov_disc_req - Send Provision Discovery Request
2252 * @priv: Private driver interface data
2253 * @peer_addr: MAC address of the peer P2P client
2254 * @config_methods: WPS Config Methods value (only one bit set)
2255 * Returns: 0 on success, -1 on failure
2257 * This function can be used to request a discovered P2P peer to
2258 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2259 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2260 * Provision Discovery Request frame is transmitted once immediately
2261 * and if no response is received, the frame will be sent again
2262 * whenever the target device is discovered during device dsicovery
2263 * (start with a p2p_find() call). Response from the peer is indicated
2264 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
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_prov_disc_req)(void *priv, const u8 *peer_addr,
2271 u16 config_methods);
2274 * p2p_sd_request - Schedule a service discovery query
2275 * @priv: Private driver interface data
2276 * @dst: Destination peer or %NULL to apply for all peers
2277 * @tlvs: P2P Service Query TLV(s)
2278 * Returns: Reference to the query or 0 on failure
2280 * Response to the query is indicated with the
2281 * EVENT_P2P_SD_RESPONSE driver event.
2283 * This function is only used if the driver implements P2P management,
2284 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2285 * struct wpa_driver_capa.
2287 u64 (*p2p_sd_request)(void *priv, const u8 *dst,
2288 const struct wpabuf *tlvs);
2291 * p2p_sd_cancel_request - Cancel a pending service discovery query
2292 * @priv: Private driver interface data
2293 * @req: Query reference from p2p_sd_request()
2294 * Returns: 0 on success, -1 on failure
2296 * This function is only used if the driver implements P2P management,
2297 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2298 * struct wpa_driver_capa.
2300 int (*p2p_sd_cancel_request)(void *priv, u64 req);
2303 * p2p_sd_response - Send response to a service discovery query
2304 * @priv: Private driver interface data
2305 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2306 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2307 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2308 * @resp_tlvs: P2P Service Response TLV(s)
2309 * Returns: 0 on success, -1 on failure
2311 * This function is called as a response to the request indicated with
2312 * the EVENT_P2P_SD_REQUEST driver event.
2314 * This function is only used if the driver implements P2P management,
2315 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2316 * struct wpa_driver_capa.
2318 int (*p2p_sd_response)(void *priv, int freq, const u8 *dst,
2320 const struct wpabuf *resp_tlvs);
2323 * p2p_service_update - Indicate a change in local services
2324 * @priv: Private driver interface data
2325 * Returns: 0 on success, -1 on failure
2327 * This function needs to be called whenever there is a change in
2328 * availability of the local services. This will increment the
2329 * Service Update Indicator value which will be used in SD Request and
2332 * This function is only used if the driver implements P2P management,
2333 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2334 * struct wpa_driver_capa.
2336 int (*p2p_service_update)(void *priv);
2339 * p2p_reject - Reject peer device (explicitly block connections)
2340 * @priv: Private driver interface data
2341 * @addr: MAC address of the peer
2342 * Returns: 0 on success, -1 on failure
2344 int (*p2p_reject)(void *priv, const u8 *addr);
2347 * p2p_invite - Invite a P2P Device into a group
2348 * @priv: Private driver interface data
2349 * @peer: Device Address of the peer P2P Device
2350 * @role: Local role in the group
2351 * @bssid: Group BSSID or %NULL if not known
2353 * @ssid_len: Length of ssid in octets
2354 * @go_dev_addr: Forced GO Device Address or %NULL if none
2355 * @persistent_group: Whether this is to reinvoke a persistent group
2356 * Returns: 0 on success, -1 on failure
2358 int (*p2p_invite)(void *priv, const u8 *peer, int role,
2359 const u8 *bssid, const u8 *ssid, size_t ssid_len,
2360 const u8 *go_dev_addr, int persistent_group);
2363 * send_tdls_mgmt - for sending TDLS management packets
2364 * @priv: private driver interface data
2365 * @dst: Destination (peer) MAC address
2366 * @action_code: TDLS action code for the mssage
2367 * @dialog_token: Dialog Token to use in the message (if needed)
2368 * @status_code: Status Code or Reason Code to use (if needed)
2369 * @buf: TDLS IEs to add to the message
2370 * @len: Length of buf in octets
2371 * Returns: 0 on success, -1 on failure
2373 * This optional function can be used to send packet to driver which is
2374 * responsible for receiving and sending all TDLS packets.
2376 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2377 u8 dialog_token, u16 status_code,
2378 const u8 *buf, size_t len);
2380 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2383 * signal_poll - Get current connection information
2384 * @priv: Private driver interface data
2385 * @signal_info: Connection info structure
2387 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2390 * set_authmode - Set authentication algorithm(s) for static WEP
2391 * @priv: Private driver interface data
2392 * @authmode: 1=Open System, 2=Shared Key, 3=both
2393 * Returns: 0 on success, -1 on failure
2395 * This function can be used to set authentication algorithms for AP
2396 * mode when static WEP is used. If the driver uses user space MLME/SME
2397 * implementation, there is no need to implement this function.
2399 * DEPRECATED - use set_ap() instead
2401 int (*set_authmode)(void *priv, int authmode);
2404 * set_rekey_info - Set rekey information
2405 * @priv: Private driver interface data
2408 * @replay_ctr: Current EAPOL-Key Replay Counter
2410 * This optional function can be used to provide information for the
2411 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2412 * while the host (including wpa_supplicant) is sleeping.
2414 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2415 const u8 *replay_ctr);
2418 * sta_assoc - Station association indication
2419 * @priv: Private driver interface data
2420 * @own_addr: Source address and BSSID for association frame
2421 * @addr: MAC address of the station to associate
2422 * @reassoc: flag to indicate re-association
2423 * @status: association response status code
2424 * @ie: assoc response ie buffer
2425 * @len: ie buffer length
2426 * Returns: 0 on success, -1 on failure
2428 * This function indicates the driver to send (Re)Association
2429 * Response frame to the station.
2431 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2432 int reassoc, u16 status, const u8 *ie, size_t len);
2435 * sta_auth - Station authentication indication
2436 * @priv: Private driver interface data
2437 * @own_addr: Source address and BSSID for authentication frame
2438 * @addr: MAC address of the station to associate
2439 * @seq: authentication sequence number
2440 * @status: authentication response status code
2441 * @ie: authentication frame ie buffer
2442 * @len: ie buffer length
2444 * This function indicates the driver to send Authentication frame
2447 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2448 u16 seq, u16 status, const u8 *ie, size_t len);
2451 * add_tspec - Add traffic stream
2452 * @priv: Private driver interface data
2453 * @addr: MAC address of the station to associate
2454 * @tspec_ie: tspec ie buffer
2455 * @tspec_ielen: tspec ie length
2456 * Returns: 0 on success, -1 on failure
2458 * This function adds the traffic steam for the station
2459 * and fills the medium_time in tspec_ie.
2461 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2462 size_t tspec_ielen);
2465 * add_sta_node - Add a station node in the driver
2466 * @priv: Private driver interface data
2467 * @addr: MAC address of the station to add
2468 * @auth_alg: authentication algorithm used by the station
2469 * Returns: 0 on success, -1 on failure
2471 * This function adds the station node in the driver, when
2472 * the station gets added by FT-over-DS.
2474 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2477 * sched_scan - Request the driver to initiate scheduled scan
2478 * @priv: Private driver interface data
2479 * @params: Scan parameters
2480 * @interval: Interval between scan cycles in milliseconds
2481 * Returns: 0 on success, -1 on failure
2483 * This operation should be used for scheduled scan offload to
2484 * the hardware. Every time scan results are available, the
2485 * driver should report scan results event for wpa_supplicant
2486 * which will eventually request the results with
2487 * wpa_driver_get_scan_results2(). This operation is optional
2488 * and if not provided or if it returns -1, we fall back to
2489 * normal host-scheduled scans.
2491 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2495 * stop_sched_scan - Request the driver to stop a scheduled scan
2496 * @priv: Private driver interface data
2497 * Returns: 0 on success, -1 on failure
2499 * This should cause the scheduled scan to be stopped and
2500 * results should stop being sent. Must be supported if
2501 * sched_scan is supported.
2503 int (*stop_sched_scan)(void *priv);
2506 * poll_client - Probe (null data or such) the given station
2507 * @priv: Private driver interface data
2508 * @own_addr: MAC address of sending interface
2509 * @addr: MAC address of the station to probe
2510 * @qos: Indicates whether station is QoS station
2512 * This function is used to verify whether an associated station is
2513 * still present. This function does not need to be implemented if the
2514 * driver provides such inactivity polling mechanism.
2516 void (*poll_client)(void *priv, const u8 *own_addr,
2517 const u8 *addr, int qos);
2522 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2524 enum wpa_event_type {
2526 * EVENT_ASSOC - Association completed
2528 * This event needs to be delivered when the driver completes IEEE
2529 * 802.11 association or reassociation successfully.
2530 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2531 * after this event has been generated. In addition, optional
2532 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2533 * more information about the association. If the driver interface gets
2534 * both of these events at the same time, it can also include the
2535 * assoc_info data in EVENT_ASSOC call.
2540 * EVENT_DISASSOC - Association lost
2542 * This event should be called when association is lost either due to
2543 * receiving deauthenticate or disassociate frame from the AP or when
2544 * sending either of these frames to the current AP. If the driver
2545 * supports separate deauthentication event, EVENT_DISASSOC should only
2546 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2547 * In AP mode, union wpa_event_data::disassoc_info is required.
2552 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2554 * This event must be delivered when a Michael MIC error is detected by
2555 * the local driver. Additional data for event processing is
2556 * provided with union wpa_event_data::michael_mic_failure. This
2557 * information is used to request new encyption key and to initiate
2558 * TKIP countermeasures if needed.
2560 EVENT_MICHAEL_MIC_FAILURE,
2563 * EVENT_SCAN_RESULTS - Scan results available
2565 * This event must be called whenever scan results are available to be
2566 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2567 * is expected to be used some time after struct wpa_driver_ops::scan()
2568 * is called. If the driver provides an unsolicited event when the scan
2569 * has been completed, this event can be used to trigger
2570 * EVENT_SCAN_RESULTS call. If such event is not available from the
2571 * driver, the driver wrapper code is expected to use a registered
2572 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2573 * scan is expected to be completed. Optional information about
2574 * completed scan can be provided with union wpa_event_data::scan_info.
2579 * EVENT_ASSOCINFO - Report optional extra information for association
2581 * This event can be used to report extra association information for
2582 * EVENT_ASSOC processing. This extra information includes IEs from
2583 * association frames and Beacon/Probe Response frames in union
2584 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2585 * EVENT_ASSOC. Alternatively, the driver interface can include
2586 * assoc_info data in the EVENT_ASSOC call if it has all the
2587 * information available at the same point.
2592 * EVENT_INTERFACE_STATUS - Report interface status changes
2594 * This optional event can be used to report changes in interface
2595 * status (interface added/removed) using union
2596 * wpa_event_data::interface_status. This can be used to trigger
2597 * wpa_supplicant to stop and re-start processing for the interface,
2598 * e.g., when a cardbus card is ejected/inserted.
2600 EVENT_INTERFACE_STATUS,
2603 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2605 * This event can be used to inform wpa_supplicant about candidates for
2606 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2607 * for scan request (ap_scan=2 mode), this event is required for
2608 * pre-authentication. If wpa_supplicant is performing scan request
2609 * (ap_scan=1), this event is optional since scan results can be used
2610 * to add pre-authentication candidates. union
2611 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2612 * candidate and priority of the candidate, e.g., based on the signal
2613 * strength, in order to try to pre-authenticate first with candidates
2614 * that are most likely targets for re-association.
2616 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2617 * on the candidate list. In addition, it can be called for the current
2618 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2619 * will automatically skip pre-authentication in cases where a valid
2620 * PMKSA exists. When more than one candidate exists, this event should
2621 * be generated once for each candidate.
2623 * Driver will be notified about successful pre-authentication with
2624 * struct wpa_driver_ops::add_pmkid() calls.
2626 EVENT_PMKID_CANDIDATE,
2629 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2631 * This event can be used to inform wpa_supplicant about desire to set
2632 * up secure direct link connection between two stations as defined in
2633 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2634 * STAKey negotiation. The caller will need to set peer address for the
2640 * EVENT_TDLS - Request TDLS operation
2642 * This event can be used to request a TDLS operation to be performed.
2647 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2649 * The driver is expected to report the received FT IEs from
2650 * FT authentication sequence from the AP. The FT IEs are included in
2651 * the extra information in union wpa_event_data::ft_ies.
2656 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2658 * The driver can use this event to inform wpa_supplicant about a STA
2659 * in an IBSS with which protected frames could be exchanged. This
2660 * event starts RSN authentication with the other STA to authenticate
2661 * the STA and set up encryption keys with it.
2663 EVENT_IBSS_RSN_START,
2666 * EVENT_AUTH - Authentication result
2668 * This event should be called when authentication attempt has been
2669 * completed. This is only used if the driver supports separate
2670 * authentication step (struct wpa_driver_ops::authenticate).
2671 * Information about authentication result is included in
2672 * union wpa_event_data::auth.
2677 * EVENT_DEAUTH - Authentication lost
2679 * This event should be called when authentication is lost either due
2680 * to receiving deauthenticate frame from the AP or when sending that
2681 * frame to the current AP.
2682 * In AP mode, union wpa_event_data::deauth_info is required.
2687 * EVENT_ASSOC_REJECT - Association rejected
2689 * This event should be called when (re)association attempt has been
2690 * rejected by the AP. Information about the association response is
2691 * included in union wpa_event_data::assoc_reject.
2696 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2698 EVENT_AUTH_TIMED_OUT,
2701 * EVENT_ASSOC_TIMED_OUT - Association timed out
2703 EVENT_ASSOC_TIMED_OUT,
2706 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2711 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2713 EVENT_WPS_BUTTON_PUSHED,
2716 * EVENT_TX_STATUS - Report TX status
2721 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2723 EVENT_RX_FROM_UNKNOWN,
2726 * EVENT_RX_MGMT - Report RX of a management frame
2731 * EVENT_RX_ACTION - Action frame received
2733 * This event is used to indicate when an Action frame has been
2734 * received. Information about the received frame is included in
2735 * union wpa_event_data::rx_action.
2740 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2742 * This event is used to indicate when the driver has started the
2743 * requested remain-on-channel duration. Information about the
2744 * operation is included in union wpa_event_data::remain_on_channel.
2746 EVENT_REMAIN_ON_CHANNEL,
2749 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2751 * This event is used to indicate when the driver has completed
2752 * remain-on-channel duration, i.e., may noot be available on the
2753 * requested channel anymore. Information about the
2754 * operation is included in union wpa_event_data::remain_on_channel.
2756 EVENT_CANCEL_REMAIN_ON_CHANNEL,
2759 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2761 * This event is used only by driver_test.c and userspace MLME.
2766 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2768 * This event is used to indicate when a Probe Request frame has been
2769 * received. Information about the received frame is included in
2770 * union wpa_event_data::rx_probe_req. The driver is required to report
2771 * these events only after successfully completed probe_req_report()
2772 * commands to request the events (i.e., report parameter is non-zero)
2773 * in station mode. In AP mode, Probe Request frames should always be
2779 * EVENT_NEW_STA - New wired device noticed
2781 * This event is used to indicate that a new device has been detected
2782 * in a network that does not use association-like functionality (i.e.,
2783 * mainly wired Ethernet). This can be used to start EAPOL
2784 * authenticator when receiving a frame from a device. The address of
2785 * the device is included in union wpa_event_data::new_sta.
2790 * EVENT_EAPOL_RX - Report received EAPOL frame
2792 * When in AP mode with hostapd, this event is required to be used to
2793 * deliver the receive EAPOL frames from the driver. With
2794 * %wpa_supplicant, this event is used only if the send_eapol() handler
2795 * is used to override the use of l2_packet for EAPOL frame TX.
2800 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
2802 * This event is used to indicate changes in the signal strength
2803 * observed in frames received from the current AP if signal strength
2804 * monitoring has been enabled with signal_monitor().
2806 EVENT_SIGNAL_CHANGE,
2809 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
2811 * This event is used to indicate that the interface was enabled after
2812 * having been previously disabled, e.g., due to rfkill.
2814 EVENT_INTERFACE_ENABLED,
2817 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
2819 * This event is used to indicate that the interface was disabled,
2820 * e.g., due to rfkill.
2822 EVENT_INTERFACE_DISABLED,
2825 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
2827 * This event is used to indicate that the channel list has changed,
2828 * e.g., because of a regulatory domain change triggered by scan
2829 * results including an AP advertising a country code.
2831 EVENT_CHANNEL_LIST_CHANGED,
2834 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
2836 * This event is used to indicate that the driver cannot maintain this
2837 * interface in its operation mode anymore. The most likely use for
2838 * this is to indicate that AP mode operation is not available due to
2839 * operating channel would need to be changed to a DFS channel when
2840 * the driver does not support radar detection and another virtual
2841 * interfaces caused the operating channel to change. Other similar
2842 * resource conflicts could also trigger this for station mode
2845 EVENT_INTERFACE_UNAVAILABLE,
2848 * EVENT_BEST_CHANNEL
2850 * Driver generates this event whenever it detects a better channel
2851 * (e.g., based on RSSI or channel use). This information can be used
2852 * to improve channel selection for a new AP/P2P group.
2857 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
2859 * This event should be called when a Deauthentication frame is dropped
2860 * due to it not being protected (MFP/IEEE 802.11w).
2861 * union wpa_event_data::unprot_deauth is required to provide more
2862 * details of the frame.
2864 EVENT_UNPROT_DEAUTH,
2867 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
2869 * This event should be called when a Disassociation frame is dropped
2870 * due to it not being protected (MFP/IEEE 802.11w).
2871 * union wpa_event_data::unprot_disassoc is required to provide more
2872 * details of the frame.
2874 EVENT_UNPROT_DISASSOC,
2877 * EVENT_STATION_LOW_ACK
2879 * Driver generates this event whenever it detected that a particular
2880 * station was lost. Detection can be through massive transmission
2881 * failures for example.
2883 EVENT_STATION_LOW_ACK,
2886 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
2888 * This event is used only if the driver implements P2P management
2889 * internally. Event data is stored in
2890 * union wpa_event_data::p2p_dev_found.
2892 EVENT_P2P_DEV_FOUND,
2895 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
2897 * This event is used only if the driver implements P2P management
2898 * internally. Event data is stored in
2899 * union wpa_event_data::p2p_go_neg_req_rx.
2901 EVENT_P2P_GO_NEG_REQ_RX,
2904 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
2906 * This event is used only if the driver implements P2P management
2907 * internally. Event data is stored in
2908 * union wpa_event_data::p2p_go_neg_completed.
2910 EVENT_P2P_GO_NEG_COMPLETED,
2912 EVENT_P2P_PROV_DISC_REQUEST,
2913 EVENT_P2P_PROV_DISC_RESPONSE,
2914 EVENT_P2P_SD_REQUEST,
2915 EVENT_P2P_SD_RESPONSE,
2918 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
2920 EVENT_IBSS_PEER_LOST,
2923 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
2925 * This event carries the new replay counter to notify wpa_supplicant
2926 * of the current EAPOL-Key Replay Counter in case the driver/firmware
2927 * completed Group Key Handshake while the host (including
2928 * wpa_supplicant was sleeping).
2930 EVENT_DRIVER_GTK_REKEY,
2933 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
2935 EVENT_SCHED_SCAN_STOPPED,
2938 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
2940 * This event indicates that the station responded to the poll
2941 * initiated with @poll_client.
2943 EVENT_DRIVER_CLIENT_POLL_OK
2948 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
2950 union wpa_event_data {
2952 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
2954 * This structure is optional for EVENT_ASSOC calls and required for
2955 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
2956 * driver interface does not need to generate separate EVENT_ASSOCINFO
2961 * reassoc - Flag to indicate association or reassociation
2966 * req_ies - (Re)Association Request IEs
2968 * If the driver generates WPA/RSN IE, this event data must be
2969 * returned for WPA handshake to have needed information. If
2970 * wpa_supplicant-generated WPA/RSN IE is used, this
2971 * information event is optional.
2973 * This should start with the first IE (fixed fields before IEs
2974 * are not included).
2979 * req_ies_len - Length of req_ies in bytes
2984 * resp_ies - (Re)Association Response IEs
2986 * Optional association data from the driver. This data is not
2987 * required WPA, but may be useful for some protocols and as
2988 * such, should be reported if this is available to the driver
2991 * This should start with the first IE (fixed fields before IEs
2992 * are not included).
2997 * resp_ies_len - Length of resp_ies in bytes
2999 size_t resp_ies_len;
3002 * beacon_ies - Beacon or Probe Response IEs
3004 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3005 * Probe Response frames from the current AP (i.e., the one
3006 * that the client just associated with). This information is
3007 * used to update WPA/RSN IE for the AP. If this field is not
3008 * set, the results from previous scan will be used. If no
3009 * data for the new AP is found, scan results will be requested
3010 * again (without scan request). At this point, the driver is
3011 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3014 * This should start with the first IE (fixed fields before IEs
3015 * are not included).
3017 const u8 *beacon_ies;
3020 * beacon_ies_len - Length of beacon_ies */
3021 size_t beacon_ies_len;
3024 * freq - Frequency of the operational channel in MHz
3029 * addr - Station address (for AP mode)
3035 * struct disassoc_info - Data for EVENT_DISASSOC events
3037 struct disassoc_info {
3039 * addr - Station address (for AP mode)
3044 * reason_code - Reason Code (host byte order) used in
3045 * Deauthentication frame
3050 * ie - Optional IE(s) in Disassociation frame
3055 * ie_len - Length of ie buffer in octets
3061 * struct deauth_info - Data for EVENT_DEAUTH events
3063 struct deauth_info {
3065 * addr - Station address (for AP mode)
3070 * reason_code - Reason Code (host byte order) used in
3071 * Deauthentication frame
3076 * ie - Optional IE(s) in Deauthentication frame
3081 * ie_len - Length of ie buffer in octets
3087 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3089 struct michael_mic_failure {
3092 } michael_mic_failure;
3095 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3097 struct interface_status {
3100 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3105 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3107 struct pmkid_candidate {
3108 /** BSSID of the PMKID candidate */
3110 /** Smaller the index, higher the priority */
3112 /** Whether RSN IE includes pre-authenticate flag */
3117 * struct stkstart - Data for EVENT_STKSTART
3124 * struct tdls - Data for EVENT_TDLS
3130 TDLS_REQUEST_TEARDOWN
3132 u16 reason_code; /* for teardown */
3136 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3138 * During FT (IEEE 802.11r) authentication sequence, the driver is
3139 * expected to use this event to report received FT IEs (MDIE, FTIE,
3140 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3141 * IEs for the next message will be delivered through the
3142 * struct wpa_driver_ops::update_ft_ies() callback.
3148 u8 target_ap[ETH_ALEN];
3149 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3151 /** Length of ric_ies buffer in octets */
3156 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3158 struct ibss_rsn_start {
3163 * struct auth_info - Data for EVENT_AUTH events
3169 u16 auth_transaction;
3176 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3178 struct assoc_reject {
3180 * bssid - BSSID of the AP that rejected association
3185 * resp_ies - (Re)Association Response IEs
3187 * Optional association data from the driver. This data is not
3188 * required WPA, but may be useful for some protocols and as
3189 * such, should be reported if this is available to the driver
3192 * This should start with the first IE (fixed fields before IEs
3193 * are not included).
3198 * resp_ies_len - Length of resp_ies in bytes
3200 size_t resp_ies_len;
3203 * status_code - Status Code from (Re)association Response
3208 struct timeout_event {
3213 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3222 * struct tx_status - Data for EVENT_TX_STATUS events
3234 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3236 struct rx_from_unknown {
3243 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3253 * struct rx_action - Data for EVENT_RX_ACTION events
3257 * da - Destination address of the received Action frame
3262 * sa - Source address of the received Action frame
3267 * bssid - Address 3 of the received Action frame
3272 * category - Action frame category
3277 * data - Action frame body after category field
3282 * len - Length of data in octets
3287 * freq - Frequency (in MHz) on which the frame was received
3293 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3295 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3297 struct remain_on_channel {
3299 * freq - Channel frequency in MHz
3304 * duration - Duration to remain on the channel in milliseconds
3306 unsigned int duration;
3307 } remain_on_channel;
3310 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3311 * @aborted: Whether the scan was aborted
3312 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3313 * @num_freqs: Number of entries in freqs array
3314 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3316 * @num_ssids: Number of entries in ssids array
3322 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3327 * struct mlme_rx - Data for EVENT_MLME_RX events
3338 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3340 struct rx_probe_req {
3342 * sa - Source address of the received Probe Request frame
3347 * da - Destination address of the received Probe Request frame
3348 * or %NULL if not available
3353 * bssid - BSSID of the received Probe Request frame or %NULL
3359 * ie - IEs from the Probe Request body
3364 * ie_len - Length of ie buffer in octets
3370 * struct new_sta - Data for EVENT_NEW_STA events
3377 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3386 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3388 struct wpa_signal_info signal_change;
3391 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3392 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3393 * @freq_5: Best 5 GHz band channel frequency in MHz
3394 * @freq_overall: Best channel frequency in MHz
3396 * 0 can be used to indicate no preference in either band.
3398 struct best_channel {
3404 struct unprot_deauth {
3410 struct unprot_disassoc {
3417 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3418 * @addr: station address
3425 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3427 struct p2p_dev_found {
3430 const u8 *pri_dev_type;
3431 const char *dev_name;
3438 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3440 struct p2p_go_neg_req_rx {
3443 } p2p_go_neg_req_rx;
3446 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3448 struct p2p_go_neg_completed {
3449 struct p2p_go_neg_results *res;
3450 } p2p_go_neg_completed;
3452 struct p2p_prov_disc_req {
3456 const u8 *pri_dev_type;
3457 const char *dev_name;
3458 u16 supp_config_methods;
3461 } p2p_prov_disc_req;
3463 struct p2p_prov_disc_resp {
3466 } p2p_prov_disc_resp;
3477 struct p2p_sd_resp {
3485 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3487 struct ibss_peer_lost {
3492 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3494 struct driver_gtk_rekey {
3496 const u8 *replay_ctr;
3500 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
3501 * @addr: station address
3503 struct client_poll {
3509 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3510 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3511 * with struct wpa_driver_ops::init()
3512 * @event: event type (defined above)
3513 * @data: possible extra data for the event
3515 * Driver wrapper code should call this function whenever an event is received
3518 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
3519 union wpa_event_data *data);
3523 * The following inline functions are provided for convenience to simplify
3524 * event indication for some of the common events.
3527 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
3528 size_t ielen, int reassoc)
3530 union wpa_event_data event;
3531 os_memset(&event, 0, sizeof(event));
3532 event.assoc_info.reassoc = reassoc;
3533 event.assoc_info.req_ies = ie;
3534 event.assoc_info.req_ies_len = ielen;
3535 event.assoc_info.addr = addr;
3536 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
3539 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
3541 union wpa_event_data event;
3542 os_memset(&event, 0, sizeof(event));
3543 event.disassoc_info.addr = addr;
3544 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
3547 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
3550 union wpa_event_data event;
3551 os_memset(&event, 0, sizeof(event));
3552 event.eapol_rx.src = src;
3553 event.eapol_rx.data = data;
3554 event.eapol_rx.data_len = data_len;
3555 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
3558 #endif /* DRIVER_H */