2 * Driver interface definition
3 * Copyright (c) 2003-2010, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
14 * This file defines a driver interface used by both %wpa_supplicant and
15 * hostapd. The first part of the file defines data structures used in various
16 * driver operations. This is followed by the struct wpa_driver_ops that each
17 * driver wrapper will beed to define with callback functions for requesting
18 * driver operations. After this, there are definitions for driver event
19 * reporting with wpa_supplicant_event() and some convenience helper functions
20 * that can be used to report events.
26 #define WPA_SUPPLICANT_DRIVER_VERSION 4
28 #include "common/defs.h"
30 #define HOSTAPD_CHAN_DISABLED 0x00000001
31 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
32 #define HOSTAPD_CHAN_NO_IBSS 0x00000004
33 #define HOSTAPD_CHAN_RADAR 0x00000008
34 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
35 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
36 #define HOSTAPD_CHAN_HT40 0x00000040
39 * struct hostapd_channel_data - Channel information
41 struct hostapd_channel_data {
43 * chan - Channel number (IEEE 802.11)
48 * freq - Frequency in MHz
53 * flag - Channel flags (HOSTAPD_CHAN_*)
58 * max_tx_power - maximum transmit power in dBm
64 * struct hostapd_hw_modes - Supported hardware mode information
66 struct hostapd_hw_modes {
68 * mode - Hardware mode
70 enum hostapd_hw_mode mode;
73 * num_channels - Number of entries in the channels array
78 * channels - Array of supported channels
80 struct hostapd_channel_data *channels;
83 * num_rates - Number of entries in the rates array
88 * rates - Array of supported rates in 100 kbps units
93 * ht_capab - HT (IEEE 802.11n) capabilities
98 * mcs_set - MCS (IEEE 802.11n) rate parameters
103 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
109 #define IEEE80211_MODE_INFRA 0
110 #define IEEE80211_MODE_IBSS 1
111 #define IEEE80211_MODE_AP 2
113 #define IEEE80211_CAP_ESS 0x0001
114 #define IEEE80211_CAP_IBSS 0x0002
115 #define IEEE80211_CAP_PRIVACY 0x0010
117 #define WPA_SCAN_QUAL_INVALID BIT(0)
118 #define WPA_SCAN_NOISE_INVALID BIT(1)
119 #define WPA_SCAN_LEVEL_INVALID BIT(2)
120 #define WPA_SCAN_LEVEL_DBM BIT(3)
121 #define WPA_SCAN_AUTHENTICATED BIT(4)
122 #define WPA_SCAN_ASSOCIATED BIT(5)
125 * struct wpa_scan_res - Scan result for an BSS/IBSS
126 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
128 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
129 * @beacon_int: beacon interval in TUs (host byte order)
130 * @caps: capability information field in host byte order
131 * @qual: signal quality
132 * @noise: noise level
133 * @level: signal level
135 * @age: Age of the information in milliseconds (i.e., how many milliseconds
136 * ago the last Beacon or Probe Response frame was received)
137 * @ie_len: length of the following IE field in octets
138 * @beacon_ie_len: length of the following Beacon IE field in octets
140 * This structure is used as a generic format for scan results from the
141 * driver. Each driver interface implementation is responsible for converting
142 * the driver or OS specific scan results into this format.
144 * If the driver does not support reporting all IEs, the IE data structure is
145 * constructed of the IEs that are available. This field will also need to
146 * include SSID in IE format. All drivers are encouraged to be extended to
147 * report all IEs to make it easier to support future additions.
149 struct wpa_scan_res {
161 size_t beacon_ie_len;
163 * Followed by ie_len octets of IEs from Probe Response frame (or if
164 * the driver does not indicate source of IEs, these may also be from
165 * Beacon frame). After the first set of IEs, another set of IEs may
166 * follow (with beacon_ie_len octets of data) if the driver provides
172 * struct wpa_scan_results - Scan results
173 * @res: Array of pointers to allocated variable length scan result entries
174 * @num: Number of entries in the scan result array
176 struct wpa_scan_results {
177 struct wpa_scan_res **res;
182 * struct wpa_interface_info - Network interface information
183 * @next: Pointer to the next interface or NULL if this is the last one
184 * @ifname: Interface name that can be used with init() or init2()
185 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
187 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
188 * is not an allocated copy, i.e., get_interfaces() caller will not free
191 struct wpa_interface_info {
192 struct wpa_interface_info *next;
195 const char *drv_name;
198 #define WPAS_MAX_SCAN_SSIDS 10
201 * struct wpa_driver_scan_params - Scan parameters
202 * Data for struct wpa_driver_ops::scan2().
204 struct wpa_driver_scan_params {
206 * ssids - SSIDs to scan for
208 struct wpa_driver_scan_ssid {
210 * ssid - specific SSID to scan for (ProbeReq)
211 * %NULL or zero-length SSID is used to indicate active scan
212 * with wildcard SSID.
216 * ssid_len: Length of the SSID in octets
219 } ssids[WPAS_MAX_SCAN_SSIDS];
222 * num_ssids - Number of entries in ssids array
223 * Zero indicates a request for a passive scan.
228 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
233 * extra_ies_len - Length of extra_ies in octets
235 size_t extra_ies_len;
238 * freqs - Array of frequencies to scan or %NULL for all frequencies
240 * The frequency is set in MHz. The array is zero-terminated.
245 * filter_ssids - Filter for reporting SSIDs
247 * This optional parameter can be used to request the driver wrapper to
248 * filter scan results to include only the specified SSIDs. %NULL
249 * indicates that no filtering is to be done. This can be used to
250 * reduce memory needs for scan results in environments that have large
251 * number of APs with different SSIDs.
253 * The driver wrapper is allowed to take this allocated buffer into its
254 * own use by setting the pointer to %NULL. In that case, the driver
255 * wrapper is responsible for freeing the buffer with os_free() once it
256 * is not needed anymore.
258 struct wpa_driver_scan_filter {
264 * num_filter_ssids - Number of entries in filter_ssids array
266 size_t num_filter_ssids;
270 * struct wpa_driver_auth_params - Authentication parameters
271 * Data for struct wpa_driver_ops::authenticate().
273 struct wpa_driver_auth_params {
281 const u8 *wep_key[4];
282 size_t wep_key_len[4];
284 int local_state_change;
287 * p2p - Whether this connection is a P2P group
294 WPS_MODE_NONE /* no WPS provisioning being used */,
295 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
296 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
301 * struct wpa_driver_associate_params - Association parameters
302 * Data for struct wpa_driver_ops::associate().
304 struct wpa_driver_associate_params {
306 * bssid - BSSID of the selected AP
307 * This can be %NULL, if ap_scan=2 mode is used and the driver is
308 * responsible for selecting with which BSS to associate. */
312 * ssid - The selected SSID
317 * ssid_len - Length of the SSID (1..32)
322 * freq - Frequency of the channel the selected AP is using
323 * Frequency that the selected AP is using (in MHz as
324 * reported in the scan results)
329 * wpa_ie - WPA information element for (Re)Association Request
330 * WPA information element to be included in (Re)Association
331 * Request (including information element id and length). Use
332 * of this WPA IE is optional. If the driver generates the WPA
333 * IE, it can use pairwise_suite, group_suite, and
334 * key_mgmt_suite to select proper algorithms. In this case,
335 * the driver has to notify wpa_supplicant about the used WPA
336 * IE by generating an event that the interface code will
337 * convert into EVENT_ASSOCINFO data (see below).
339 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
340 * instead. The driver can determine which version is used by
341 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
344 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
349 * wpa_ie_len - length of the wpa_ie
354 * pairwise_suite - Selected pairwise cipher suite
356 * This is usually ignored if @wpa_ie is used.
358 enum wpa_cipher pairwise_suite;
361 * group_suite - Selected group cipher suite
363 * This is usually ignored if @wpa_ie is used.
365 enum wpa_cipher group_suite;
368 * key_mgmt_suite - Selected key management suite
370 * This is usually ignored if @wpa_ie is used.
372 enum wpa_key_mgmt key_mgmt_suite;
375 * auth_alg - Allowed authentication algorithms
376 * Bit field of WPA_AUTH_ALG_*
381 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
386 * wep_key - WEP keys for static WEP configuration
388 const u8 *wep_key[4];
391 * wep_key_len - WEP key length for static WEP configuration
393 size_t wep_key_len[4];
396 * wep_tx_keyidx - WEP TX key index for static WEP configuration
401 * mgmt_frame_protection - IEEE 802.11w management frame protection
403 enum mfp_options mgmt_frame_protection;
406 * ft_ies - IEEE 802.11r / FT information elements
407 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
408 * for fast transition, this parameter is set to include the IEs that
409 * are to be sent in the next FT Authentication Request message.
410 * update_ft_ies() handler is called to update the IEs for further
411 * FT messages in the sequence.
413 * The driver should use these IEs only if the target AP is advertising
414 * the same mobility domain as the one included in the MDIE here.
416 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
417 * AP after the initial association. These IEs can only be used if the
418 * target AP is advertising support for FT and is using the same MDIE
419 * and SSID as the current AP.
421 * The driver is responsible for reporting the FT IEs received from the
422 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
423 * type. update_ft_ies() handler will then be called with the FT IEs to
424 * include in the next frame in the authentication sequence.
429 * ft_ies_len - Length of ft_ies in bytes
434 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
436 * This value is provided to allow the driver interface easier access
437 * to the current mobility domain. This value is set to %NULL if no
438 * mobility domain is currently active.
443 * passphrase - RSN passphrase for PSK
445 * This value is made available only for WPA/WPA2-Personal (PSK) and
446 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
447 * the 8..63 character ASCII passphrase, if available. Please note that
448 * this can be %NULL if passphrase was not used to generate the PSK. In
449 * that case, the psk field must be used to fetch the PSK.
451 const char *passphrase;
454 * psk - RSN PSK (alternative for passphrase for PSK)
456 * This value is made available only for WPA/WPA2-Personal (PSK) and
457 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
458 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
459 * be prepared to handle %NULL value as an error.
464 * drop_unencrypted - Enable/disable unencrypted frame filtering
466 * Configure the driver to drop all non-EAPOL frames (both receive and
467 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
468 * still be allowed for key negotiation.
470 int drop_unencrypted;
473 * prev_bssid - Previously used BSSID in this ESS
475 * When not %NULL, this is a request to use reassociation instead of
478 const u8 *prev_bssid;
483 * If the driver needs to do special configuration for WPS association,
484 * this variable provides more information on what type of association
485 * is being requested. Most drivers should not need ot use this.
490 * p2p - Whether this connection is a P2P group
495 * uapsd - UAPSD parameters for the network
496 * -1 = do not change defaults
497 * AP mode: 1 = enabled, 0 = disabled
498 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
505 HIDDEN_SSID_ZERO_LEN,
506 HIDDEN_SSID_ZERO_CONTENTS
509 struct wpa_driver_ap_params {
511 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
516 * head_len - Length of the head buffer in octets
521 * tail - Beacon tail following TIM IE
526 * tail_len - Length of the tail buffer in octets
531 * dtim_period - DTIM period
536 * beacon_int - Beacon interval
541 * ssid - The SSID to use in Beacon/Probe Response frames
546 * ssid_len - Length of the SSID (1..32)
551 * hide_ssid - Whether to hide the SSID
553 enum hide_ssid hide_ssid;
556 * pairwise_ciphers - WPA_CIPHER_* bitfield
558 unsigned int pairwise_ciphers;
561 * group_cipher - WPA_CIPHER_*
563 unsigned int group_cipher;
566 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
568 unsigned int key_mgmt_suites;
571 * auth_algs - WPA_AUTH_ALG_* bitfield
573 unsigned int auth_algs;
576 * wpa_version - WPA_PROTO_* bitfield
578 unsigned int wpa_version;
581 * privacy - Whether privacy is used in the BSS
587 * struct wpa_driver_capa - Driver capability information
589 struct wpa_driver_capa {
590 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
591 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
592 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
593 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
594 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
595 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
596 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
597 unsigned int key_mgmt;
599 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
600 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
601 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
602 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
605 #define WPA_DRIVER_AUTH_OPEN 0x00000001
606 #define WPA_DRIVER_AUTH_SHARED 0x00000002
607 #define WPA_DRIVER_AUTH_LEAP 0x00000004
610 /* Driver generated WPA/RSN IE */
611 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
612 /* Driver needs static WEP key setup after association command */
613 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
614 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
615 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
616 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
617 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
618 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
619 /* Driver provides separate commands for authentication and association (SME in
620 * wpa_supplicant). */
621 #define WPA_DRIVER_FLAGS_SME 0x00000020
622 /* Driver supports AP mode */
623 #define WPA_DRIVER_FLAGS_AP 0x00000040
624 /* Driver needs static WEP key setup after association has been completed */
625 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
626 /* Driver takes care of P2P management operations */
627 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
628 /* Driver supports concurrent P2P operations */
629 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
631 * Driver uses the initial interface as a dedicated management interface, i.e.,
632 * it cannot be used for P2P group operations or non-P2P purposes.
634 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
635 /* This interface is P2P capable (P2P Device, GO, or P2P Client */
636 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
637 /* Driver supports concurrent operations on multiple channels */
638 #define WPA_DRIVER_FLAGS_MULTI_CHANNEL_CONCURRENT 0x00001000
640 * Driver uses the initial interface for P2P management interface and non-P2P
641 * purposes (e.g., connect to infra AP), but this interface cannot be used for
642 * P2P group operations.
644 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
646 * Driver is known to use sane error codes, i.e., when it indicates that
647 * something (e.g., association) fails, there was indeed a failure and the
648 * operation does not end up getting completed successfully later.
650 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
651 /* Driver supports off-channel TX */
652 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
653 /* Driver indicates TX status events for EAPOL Data frames */
654 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
660 * max_remain_on_chan - Maximum remain-on-channel duration in msec
662 unsigned int max_remain_on_chan;
665 * max_stations - Maximum number of associated stations the driver
666 * supports in AP mode
668 unsigned int max_stations;
674 struct hostap_sta_driver_data {
675 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
676 unsigned long current_tx_rate;
677 unsigned long inactive_msec;
679 unsigned long num_ps_buf_frames;
680 unsigned long tx_retry_failed;
681 unsigned long tx_retry_count;
686 struct hostapd_sta_add_params {
690 const u8 *supp_rates;
691 size_t supp_rates_len;
693 const struct ieee80211_ht_capabilities *ht_capabilities;
694 u32 flags; /* bitmask of WPA_STA_* flags */
697 struct hostapd_freq_params {
702 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
703 * secondary channel below primary, 1 = HT40
704 * enabled, secondary channel above primary */
707 enum wpa_driver_if_type {
709 * WPA_IF_STATION - Station mode interface
714 * WPA_IF_AP_VLAN - AP mode VLAN interface
716 * This interface shares its address and Beacon frame with the main
722 * WPA_IF_AP_BSS - AP mode BSS interface
724 * This interface has its own address and Beacon frame.
729 * WPA_IF_P2P_GO - P2P Group Owner
734 * WPA_IF_P2P_CLIENT - P2P Client
739 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
740 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
745 struct wpa_init_params {
750 const char *test_socket;
751 int use_pae_group_addr;
755 u8 *own_addr; /* buffer for writing own MAC address */
759 struct wpa_bss_params {
760 /** Interface name (for multi-SSID/VLAN support) */
762 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
771 enum mfp_options ieee80211w;
774 #define WPA_STA_AUTHORIZED BIT(0)
775 #define WPA_STA_WMM BIT(1)
776 #define WPA_STA_SHORT_PREAMBLE BIT(2)
777 #define WPA_STA_MFP BIT(3)
780 * struct p2p_params - P2P parameters for driver-based P2P management
783 const char *dev_name;
785 #define DRV_MAX_SEC_DEV_TYPES 5
786 u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8];
787 size_t num_sec_dev_types;
801 * struct wpa_signal_info - Information about channel signal quality
803 struct wpa_signal_info {
812 * struct wpa_driver_ops - Driver interface API definition
814 * This structure defines the API that each driver interface needs to implement
815 * for core wpa_supplicant code. All driver specific functionality is captured
818 struct wpa_driver_ops {
819 /** Name of the driver interface */
821 /** One line description of the driver interface */
825 * get_bssid - Get the current BSSID
826 * @priv: private driver interface data
827 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
829 * Returns: 0 on success, -1 on failure
831 * Query kernel driver for the current BSSID and copy it to bssid.
832 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
835 int (*get_bssid)(void *priv, u8 *bssid);
838 * get_ssid - Get the current SSID
839 * @priv: private driver interface data
840 * @ssid: buffer for SSID (at least 32 bytes)
842 * Returns: Length of the SSID on success, -1 on failure
844 * Query kernel driver for the current SSID and copy it to ssid.
845 * Returning zero is recommended if the STA is not associated.
847 * Note: SSID is an array of octets, i.e., it is not nul terminated and
848 * can, at least in theory, contain control characters (including nul)
849 * and as such, should be processed as binary data, not a printable
852 int (*get_ssid)(void *priv, u8 *ssid);
855 * set_key - Configure encryption key
856 * @ifname: Interface name (for multi-SSID/VLAN support)
857 * @priv: private driver interface data
858 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
859 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
860 * %WPA_ALG_NONE clears the key.
861 * @addr: Address of the peer STA (BSSID of the current AP when setting
862 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
863 * broadcast keys, %NULL for default keys that are used both for
864 * broadcast and unicast; when clearing keys, %NULL is used to
865 * indicate that both the broadcast-only and default key of the
866 * specified key index is to be cleared
867 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
869 * @set_tx: configure this key as the default Tx key (only used when
870 * driver does not support separate unicast/individual key
871 * @seq: sequence number/packet number, seq_len octets, the next
872 * packet number to be used for in replay protection; configured
873 * for Rx keys (in most cases, this is only used with broadcast
874 * keys and set to zero for unicast keys); %NULL if not set
875 * @seq_len: length of the seq, depends on the algorithm:
876 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
877 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
879 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
880 * TKIP: 32, CCMP: 16, IGTK: 16)
882 * Returns: 0 on success, -1 on failure
884 * Configure the given key for the kernel driver. If the driver
885 * supports separate individual keys (4 default keys + 1 individual),
886 * addr can be used to determine whether the key is default or
887 * individual. If only 4 keys are supported, the default key with key
888 * index 0 is used as the individual key. STA must be configured to use
889 * it as the default Tx key (set_tx is set) and accept Rx for all the
890 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
891 * broadcast keys, so key index 0 is available for this kind of
894 * Please note that TKIP keys include separate TX and RX MIC keys and
895 * some drivers may expect them in different order than wpa_supplicant
896 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
897 * will trigger Michael MIC errors. This can be fixed by changing the
898 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
899 * in driver_*.c set_key() implementation, see driver_ndis.c for an
900 * example on how this can be done.
902 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
903 const u8 *addr, int key_idx, int set_tx,
904 const u8 *seq, size_t seq_len,
905 const u8 *key, size_t key_len);
908 * init - Initialize driver interface
909 * @ctx: context to be used when calling wpa_supplicant functions,
910 * e.g., wpa_supplicant_event()
911 * @ifname: interface name, e.g., wlan0
913 * Returns: Pointer to private data, %NULL on failure
915 * Initialize driver interface, including event processing for kernel
916 * driver events (e.g., associated, scan results, Michael MIC failure).
917 * This function can allocate a private configuration data area for
918 * @ctx, file descriptor, interface name, etc. information that may be
919 * needed in future driver operations. If this is not used, non-NULL
920 * value will need to be returned because %NULL is used to indicate
921 * failure. The returned value will be used as 'void *priv' data for
922 * all other driver_ops functions.
924 * The main event loop (eloop.c) of wpa_supplicant can be used to
925 * register callback for read sockets (eloop_register_read_sock()).
927 * See below for more information about events and
928 * wpa_supplicant_event() function.
930 void * (*init)(void *ctx, const char *ifname);
933 * deinit - Deinitialize driver interface
934 * @priv: private driver interface data from init()
936 * Shut down driver interface and processing of driver events. Free
937 * private data buffer if one was allocated in init() handler.
939 void (*deinit)(void *priv);
942 * set_param - Set driver configuration parameters
943 * @priv: private driver interface data from init()
944 * @param: driver specific configuration parameters
946 * Returns: 0 on success, -1 on failure
948 * Optional handler for notifying driver interface about configuration
949 * parameters (driver_param).
951 int (*set_param)(void *priv, const char *param);
954 * set_countermeasures - Enable/disable TKIP countermeasures
955 * @priv: private driver interface data
956 * @enabled: 1 = countermeasures enabled, 0 = disabled
958 * Returns: 0 on success, -1 on failure
960 * Configure TKIP countermeasures. When these are enabled, the driver
961 * should drop all received and queued frames that are using TKIP.
963 int (*set_countermeasures)(void *priv, int enabled);
966 * deauthenticate - Request driver to deauthenticate
967 * @priv: private driver interface data
968 * @addr: peer address (BSSID of the AP)
969 * @reason_code: 16-bit reason code to be sent in the deauthentication
972 * Returns: 0 on success, -1 on failure
974 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
977 * disassociate - Request driver to disassociate
978 * @priv: private driver interface data
979 * @addr: peer address (BSSID of the AP)
980 * @reason_code: 16-bit reason code to be sent in the disassociation
983 * Returns: 0 on success, -1 on failure
985 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
988 * associate - Request driver to associate
989 * @priv: private driver interface data
990 * @params: association parameters
992 * Returns: 0 on success, -1 on failure
994 int (*associate)(void *priv,
995 struct wpa_driver_associate_params *params);
998 * add_pmkid - Add PMKSA cache entry to the driver
999 * @priv: private driver interface data
1000 * @bssid: BSSID for the PMKSA cache entry
1001 * @pmkid: PMKID for the PMKSA cache entry
1003 * Returns: 0 on success, -1 on failure
1005 * This function is called when a new PMK is received, as a result of
1006 * either normal authentication or RSN pre-authentication.
1008 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1009 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1010 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1011 * driver_ops function does not need to be implemented. Likewise, if
1012 * the driver does not support WPA, this function is not needed.
1014 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1017 * remove_pmkid - Remove PMKSA cache entry to the driver
1018 * @priv: private driver interface data
1019 * @bssid: BSSID for the PMKSA cache entry
1020 * @pmkid: PMKID for the PMKSA cache entry
1022 * Returns: 0 on success, -1 on failure
1024 * This function is called when the supplicant drops a PMKSA cache
1025 * entry for any reason.
1027 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1028 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1029 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1030 * from wpa_supplicant, this driver_ops function does not need to be
1031 * implemented. Likewise, if the driver does not support WPA, this
1032 * function is not needed.
1034 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1037 * flush_pmkid - Flush PMKSA cache
1038 * @priv: private driver interface data
1040 * Returns: 0 on success, -1 on failure
1042 * This function is called when the supplicant drops all PMKSA cache
1043 * entries for any reason.
1045 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1046 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1047 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1048 * from wpa_supplicant, this driver_ops function does not need to be
1049 * implemented. Likewise, if the driver does not support WPA, this
1050 * function is not needed.
1052 int (*flush_pmkid)(void *priv);
1055 * get_capa - Get driver capabilities
1056 * @priv: private driver interface data
1058 * Returns: 0 on success, -1 on failure
1060 * Get driver/firmware/hardware capabilities.
1062 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1065 * poll - Poll driver for association information
1066 * @priv: private driver interface data
1068 * This is an option callback that can be used when the driver does not
1069 * provide event mechanism for association events. This is called when
1070 * receiving WPA EAPOL-Key messages that require association
1071 * information. The driver interface is supposed to generate associnfo
1072 * event before returning from this callback function. In addition, the
1073 * driver interface should generate an association event after having
1074 * sent out associnfo.
1076 void (*poll)(void *priv);
1079 * get_ifname - Get interface name
1080 * @priv: private driver interface data
1082 * Returns: Pointer to the interface name. This can differ from the
1083 * interface name used in init() call. Init() is called first.
1085 * This optional function can be used to allow the driver interface to
1086 * replace the interface name with something else, e.g., based on an
1087 * interface mapping from a more descriptive name.
1089 const char * (*get_ifname)(void *priv);
1092 * get_mac_addr - Get own MAC address
1093 * @priv: private driver interface data
1095 * Returns: Pointer to own MAC address or %NULL on failure
1097 * This optional function can be used to get the own MAC address of the
1098 * device from the driver interface code. This is only needed if the
1099 * l2_packet implementation for the OS does not provide easy access to
1101 const u8 * (*get_mac_addr)(void *priv);
1104 * send_eapol - Optional function for sending EAPOL packets
1105 * @priv: private driver interface data
1106 * @dest: Destination MAC address
1108 * @data: EAPOL packet starting with IEEE 802.1X header
1109 * @data_len: Size of the EAPOL packet
1111 * Returns: 0 on success, -1 on failure
1113 * This optional function can be used to override l2_packet operations
1114 * with driver specific functionality. If this function pointer is set,
1115 * l2_packet module is not used at all and the driver interface code is
1116 * responsible for receiving and sending all EAPOL packets. The
1117 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1118 * event. The driver interface is required to implement get_mac_addr()
1119 * handler if send_eapol() is used.
1121 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1122 const u8 *data, size_t data_len);
1125 * set_operstate - Sets device operating state to DORMANT or UP
1126 * @priv: private driver interface data
1127 * @state: 0 = dormant, 1 = up
1128 * Returns: 0 on success, -1 on failure
1130 * This is an optional function that can be used on operating systems
1131 * that support a concept of controlling network device state from user
1132 * space applications. This function, if set, gets called with
1133 * state = 1 when authentication has been completed and with state = 0
1134 * when connection is lost.
1136 int (*set_operstate)(void *priv, int state);
1139 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1140 * @priv: Private driver interface data
1141 * @addr: Address of the station for which to set protection (may be
1142 * %NULL for group keys)
1143 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1144 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1145 * Returns: 0 on success, -1 on failure
1147 * This is an optional function that can be used to set the driver to
1148 * require protection for Tx and/or Rx frames. This uses the layer
1149 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1150 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1151 * set protection operation; instead, they set protection implicitly
1152 * based on configured keys.
1154 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1158 * get_hw_feature_data - Get hardware support data (channels and rates)
1159 * @priv: Private driver interface data
1160 * @num_modes: Variable for returning the number of returned modes
1161 * flags: Variable for returning hardware feature flags
1162 * Returns: Pointer to allocated hardware data on success or %NULL on
1163 * failure. Caller is responsible for freeing this.
1165 * This function is only needed for drivers that export MLME
1166 * (management frame processing) to %wpa_supplicant or hostapd.
1168 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1173 * set_channel - Set channel
1174 * @priv: Private driver interface data
1175 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
1176 * @chan: IEEE 802.11 channel number
1177 * @freq: Frequency of the channel in MHz
1178 * Returns: 0 on success, -1 on failure
1180 * This function is only needed for drivers that export MLME
1181 * (management frame processing) to wpa_supplicant.
1183 int (*set_channel)(void *priv, enum hostapd_hw_mode phymode, int chan,
1187 * set_ssid - Set SSID
1188 * @priv: Private driver interface data
1190 * @ssid_len: SSID length
1191 * Returns: 0 on success, -1 on failure
1193 * This function is only needed for drivers that export MLME
1194 * (management frame processing) to wpa_supplicant.
1196 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
1199 * set_bssid - Set BSSID
1200 * @priv: Private driver interface data
1202 * Returns: 0 on success, -1 on failure
1204 * This function is only needed for drivers that export MLME
1205 * (management frame processing) to wpa_supplicant.
1207 int (*set_bssid)(void *priv, const u8 *bssid);
1210 * send_mlme - Send management frame from MLME
1211 * @priv: Private driver interface data
1212 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1213 * @data_len: Size of the management frame
1214 * Returns: 0 on success, -1 on failure
1216 * This function is only needed for drivers that export MLME
1217 * (management frame processing) to wpa_supplicant.
1219 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
1222 * mlme_add_sta - Add a STA entry into the driver/netstack
1223 * @priv: Private driver interface data
1224 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1225 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
1226 * format (one octet per rate, 1 = 0.5 Mbps)
1227 * @supp_rates_len: Number of entries in supp_rates
1228 * Returns: 0 on success, -1 on failure
1230 * This function is only needed for drivers that export MLME
1231 * (management frame processing) to wpa_supplicant. When the MLME code
1232 * completes association with an AP, this function is called to
1233 * configure the driver/netstack with a STA entry for data frame
1234 * processing (TX rate control, encryption/decryption).
1236 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
1237 size_t supp_rates_len);
1240 * mlme_remove_sta - Remove a STA entry from the driver/netstack
1241 * @priv: Private driver interface data
1242 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1243 * Returns: 0 on success, -1 on failure
1245 * This function is only needed for drivers that export MLME
1246 * (management frame processing) to wpa_supplicant.
1248 int (*mlme_remove_sta)(void *priv, const u8 *addr);
1251 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1252 * @priv: Private driver interface data
1253 * @md: Mobility domain (2 octets) (also included inside ies)
1254 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1255 * @ies_len: Length of FT IEs in bytes
1256 * Returns: 0 on success, -1 on failure
1258 * The supplicant uses this callback to let the driver know that keying
1259 * material for FT is available and that the driver can use the
1260 * provided IEs in the next message in FT authentication sequence.
1262 * This function is only needed for driver that support IEEE 802.11r
1263 * (Fast BSS Transition).
1265 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1269 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1270 * @priv: Private driver interface data
1271 * @action: Action field value
1272 * @target_ap: Target AP address
1273 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1274 * @ies_len: Length of FT IEs in bytes
1275 * Returns: 0 on success, -1 on failure
1277 * The supplicant uses this callback to request the driver to transmit
1278 * an FT Action frame (action category 6) for over-the-DS fast BSS
1281 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1282 const u8 *ies, size_t ies_len);
1285 * get_scan_results2 - Fetch the latest scan results
1286 * @priv: private driver interface data
1288 * Returns: Allocated buffer of scan results (caller is responsible for
1289 * freeing the data structure) on success, NULL on failure
1291 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1294 * set_country - Set country
1295 * @priv: Private driver interface data
1296 * @alpha2: country to which to switch to
1297 * Returns: 0 on success, -1 on failure
1299 * This function is for drivers which support some form
1300 * of setting a regulatory domain.
1302 int (*set_country)(void *priv, const char *alpha2);
1305 * global_init - Global driver initialization
1306 * Returns: Pointer to private data (global), %NULL on failure
1308 * This optional function is called to initialize the driver wrapper
1309 * for global data, i.e., data that applies to all interfaces. If this
1310 * function is implemented, global_deinit() will also need to be
1311 * implemented to free the private data. The driver will also likely
1312 * use init2() function instead of init() to get the pointer to global
1313 * data available to per-interface initializer.
1315 void * (*global_init)(void);
1318 * global_deinit - Global driver deinitialization
1319 * @priv: private driver global data from global_init()
1321 * Terminate any global driver related functionality and free the
1322 * global data structure.
1324 void (*global_deinit)(void *priv);
1327 * init2 - Initialize driver interface (with global data)
1328 * @ctx: context to be used when calling wpa_supplicant functions,
1329 * e.g., wpa_supplicant_event()
1330 * @ifname: interface name, e.g., wlan0
1331 * @global_priv: private driver global data from global_init()
1332 * Returns: Pointer to private data, %NULL on failure
1334 * This function can be used instead of init() if the driver wrapper
1337 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1340 * get_interfaces - Get information about available interfaces
1341 * @global_priv: private driver global data from global_init()
1342 * Returns: Allocated buffer of interface information (caller is
1343 * responsible for freeing the data structure) on success, NULL on
1346 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1349 * scan2 - Request the driver to initiate scan
1350 * @priv: private driver interface data
1351 * @params: Scan parameters
1353 * Returns: 0 on success, -1 on failure
1355 * Once the scan results are ready, the driver should report scan
1356 * results event for wpa_supplicant which will eventually request the
1357 * results with wpa_driver_get_scan_results2().
1359 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1362 * authenticate - Request driver to authenticate
1363 * @priv: private driver interface data
1364 * @params: authentication parameters
1365 * Returns: 0 on success, -1 on failure
1367 * This is an optional function that can be used with drivers that
1368 * support separate authentication and association steps, i.e., when
1369 * wpa_supplicant can act as the SME. If not implemented, associate()
1370 * function is expected to take care of IEEE 802.11 authentication,
1373 int (*authenticate)(void *priv,
1374 struct wpa_driver_auth_params *params);
1377 * set_ap - Set Beacon and Probe Response information for AP mode
1378 * @priv: Private driver interface data
1379 * @params: Parameters to use in AP mode
1381 * This function is used to configure Beacon template and/or extra IEs
1382 * to add for Beacon and Probe Response frames for the driver in
1383 * AP mode. The driver is responsible for building the full Beacon
1384 * frame by concatenating the head part with TIM IE generated by the
1385 * driver/firmware and finishing with the tail part. Depending on the
1386 * driver architectue, this can be done either by using the full
1387 * template or the set of additional IEs (e.g., WPS and P2P IE).
1388 * Similarly, Probe Response processing depends on the driver design.
1389 * If the driver (or firmware) takes care of replying to Probe Request
1390 * frames, the extra IEs provided here needs to be added to the Probe
1393 * Returns: 0 on success, -1 on failure
1395 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1398 * hapd_init - Initialize driver interface (hostapd only)
1399 * @hapd: Pointer to hostapd context
1400 * @params: Configuration for the driver wrapper
1401 * Returns: Pointer to private data, %NULL on failure
1403 * This function is used instead of init() or init2() when the driver
1404 * wrapper is used withh hostapd.
1406 void * (*hapd_init)(struct hostapd_data *hapd,
1407 struct wpa_init_params *params);
1410 * hapd_deinit - Deinitialize driver interface (hostapd only)
1411 * @priv: Private driver interface data from hapd_init()
1413 void (*hapd_deinit)(void *priv);
1416 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1417 * @priv: Private driver interface data
1418 * @params: BSS parameters
1419 * Returns: 0 on success, -1 on failure
1421 * This is an optional function to configure the kernel driver to
1422 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1423 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1424 * always enabled and the driver uses set_beacon() to set WPA/RSN IE
1425 * for Beacon frames.
1427 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1430 * set_privacy - Enable/disable privacy (AP only)
1431 * @priv: Private driver interface data
1432 * @enabled: 1 = privacy enabled, 0 = disabled
1433 * Returns: 0 on success, -1 on failure
1435 * This is an optional function to configure privacy field in the
1436 * kernel driver for Beacon frames. This can be left undefined (set to
1437 * %NULL) if the driver uses the Beacon template from set_beacon().
1439 int (*set_privacy)(void *priv, int enabled);
1442 * get_seqnum - Fetch the current TSC/packet number (AP only)
1443 * @ifname: The interface name (main or virtual)
1444 * @priv: Private driver interface data
1445 * @addr: MAC address of the station or %NULL for group keys
1447 * @seq: Buffer for returning the latest used TSC/packet number
1448 * Returns: 0 on success, -1 on failure
1450 * This function is used to fetch the last used TSC/packet number for
1451 * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so
1452 * there is no strict requirement on implementing support for unicast
1453 * keys (i.e., addr != %NULL).
1455 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1459 * flush - Flush all association stations (AP only)
1460 * @priv: Private driver interface data
1461 * Returns: 0 on success, -1 on failure
1463 * This function requests the driver to disassociate all associated
1464 * stations. This function does not need to be implemented if the
1465 * driver does not process association frames internally.
1467 int (*flush)(void *priv);
1470 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1471 * @priv: Private driver interface data
1472 * @elem: Information elements
1473 * @elem_len: Length of the elem buffer in octets
1474 * Returns: 0 on success, -1 on failure
1476 * This is an optional function to add information elements in the
1477 * kernel driver for Beacon and Probe Response frames. This can be left
1478 * undefined (set to %NULL) if the driver uses the Beacon template from
1481 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1484 * read_sta_data - Fetch station data (AP only)
1485 * @priv: Private driver interface data
1486 * @data: Buffer for returning station information
1487 * @addr: MAC address of the station
1488 * Returns: 0 on success, -1 on failure
1490 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1494 * hapd_send_eapol - Send an EAPOL packet (AP only)
1495 * @priv: private driver interface data
1496 * @addr: Destination MAC address
1497 * @data: EAPOL packet starting with IEEE 802.1X header
1498 * @data_len: Length of the EAPOL packet in octets
1499 * @encrypt: Whether the frame should be encrypted
1500 * @own_addr: Source MAC address
1501 * @flags: WPA_STA_* flags for the destination station
1503 * Returns: 0 on success, -1 on failure
1505 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1506 size_t data_len, int encrypt,
1507 const u8 *own_addr, u32 flags);
1510 * sta_deauth - Deauthenticate a station (AP only)
1511 * @priv: Private driver interface data
1512 * @own_addr: Source address and BSSID for the Deauthentication frame
1513 * @addr: MAC address of the station to deauthenticate
1514 * @reason: Reason code for the Deauthentiation frame
1515 * Returns: 0 on success, -1 on failure
1517 * This function requests a specific station to be deauthenticated and
1518 * a Deauthentication frame to be sent to it.
1520 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1524 * sta_disassoc - Disassociate a station (AP only)
1525 * @priv: Private driver interface data
1526 * @own_addr: Source address and BSSID for the Disassociation frame
1527 * @addr: MAC address of the station to disassociate
1528 * @reason: Reason code for the Disassociation frame
1529 * Returns: 0 on success, -1 on failure
1531 * This function requests a specific station to be disassociated and
1532 * a Disassociation frame to be sent to it.
1534 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1538 * sta_remove - Remove a station entry (AP only)
1539 * @priv: Private driver interface data
1540 * @addr: MAC address of the station to be removed
1541 * Returns: 0 on success, -1 on failure
1543 int (*sta_remove)(void *priv, const u8 *addr);
1546 * hapd_get_ssid - Get the current SSID (AP only)
1547 * @priv: Private driver interface data
1548 * @buf: Buffer for returning the SSID
1549 * @len: Maximum length of the buffer
1550 * Returns: Length of the SSID on success, -1 on failure
1552 * This function need not be implemented if the driver uses Beacon
1553 * template from set_beacon() and does not reply to Probe Request
1556 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1559 * hapd_set_ssid - Set SSID (AP only)
1560 * @priv: Private driver interface data
1562 * @len: Length of the SSID in octets
1563 * Returns: 0 on success, -1 on failure
1565 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1568 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1569 * @priv: Private driver interface data
1570 * @enabled: 1 = countermeasures enabled, 0 = disabled
1571 * Returns: 0 on success, -1 on failure
1573 * This need not be implemented if the driver does not take care of
1574 * association processing.
1576 int (*hapd_set_countermeasures)(void *priv, int enabled);
1579 * sta_add - Add a station entry
1580 * @priv: Private driver interface data
1581 * @params: Station parameters
1582 * Returns: 0 on success, -1 on failure
1584 * This function is used to add a station entry to the driver once the
1585 * station has completed association. This is only used if the driver
1586 * does not take care of association processing.
1588 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1591 * get_inact_sec - Get station inactivity duration (AP only)
1592 * @priv: Private driver interface data
1593 * @addr: Station address
1594 * Returns: Number of seconds station has been inactive, -1 on failure
1596 int (*get_inact_sec)(void *priv, const u8 *addr);
1599 * sta_clear_stats - Clear station statistics (AP only)
1600 * @priv: Private driver interface data
1601 * @addr: Station address
1602 * Returns: 0 on success, -1 on failure
1604 int (*sta_clear_stats)(void *priv, const u8 *addr);
1607 * set_freq - Set channel/frequency (AP only)
1608 * @priv: Private driver interface data
1609 * @freq: Channel parameters
1610 * Returns: 0 on success, -1 on failure
1612 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1615 * set_rts - Set RTS threshold
1616 * @priv: Private driver interface data
1617 * @rts: RTS threshold in octets
1618 * Returns: 0 on success, -1 on failure
1620 int (*set_rts)(void *priv, int rts);
1623 * set_frag - Set fragmentation threshold
1624 * @priv: Private driver interface data
1625 * @frag: Fragmentation threshold in octets
1626 * Returns: 0 on success, -1 on failure
1628 int (*set_frag)(void *priv, int frag);
1631 * sta_set_flags - Set station flags (AP only)
1632 * @priv: Private driver interface data
1633 * @addr: Station address
1634 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1635 * @flags_or: Bitmap of WPA_STA_* flags to add
1636 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1637 * Returns: 0 on success, -1 on failure
1639 int (*sta_set_flags)(void *priv, const u8 *addr,
1640 int total_flags, int flags_or, int flags_and);
1643 * set_rate_sets - Set supported and basic rate sets (AP only)
1644 * @priv: Private driver interface data
1645 * @supp_rates: -1 terminated array of supported rates in 100 kbps
1646 * @basic_rates: -1 terminated array of basic rates in 100 kbps
1647 * @mode: hardware mode (HOSTAPD_MODE_*)
1648 * Returns: 0 on success, -1 on failure
1650 int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
1654 * set_cts_protect - Set CTS protection mode (AP only)
1655 * @priv: Private driver interface data
1656 * @value: Whether CTS protection is enabled
1657 * Returns: 0 on success, -1 on failure
1659 int (*set_cts_protect)(void *priv, int value);
1662 * set_preamble - Set preamble mode (AP only)
1663 * @priv: Private driver interface data
1664 * @value: Whether short preamble is enabled
1665 * Returns: 0 on success, -1 on failure
1667 int (*set_preamble)(void *priv, int value);
1670 * set_short_slot_time - Set short slot time (AP only)
1671 * @priv: Private driver interface data
1672 * @value: Whether short slot time is enabled
1673 * Returns: 0 on success, -1 on failure
1675 int (*set_short_slot_time)(void *priv, int value);
1678 * set_tx_queue_params - Set TX queue parameters
1679 * @priv: Private driver interface data
1680 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
1684 * @burst_time: Maximum length for bursting in 0.1 msec units
1686 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1687 int cw_max, int burst_time);
1690 * valid_bss_mask - Validate BSSID mask
1691 * @priv: Private driver interface data
1694 * Returns: 0 if mask is valid, -1 if mask is not valid, 1 if mask can
1695 * be used, but the main interface address must be the first address in
1696 * the block if mask is applied
1698 int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
1701 * if_add - Add a virtual interface
1702 * @priv: Private driver interface data
1703 * @type: Interface type
1704 * @ifname: Interface name for the new virtual interface
1705 * @addr: Local address to use for the interface or %NULL to use the
1706 * parent interface address
1707 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1708 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1709 * not allowed (applies only to %WPA_IF_AP_BSS type)
1710 * @force_ifname: Buffer for returning an interface name that the
1711 * driver ended up using if it differs from the requested ifname
1712 * @if_addr: Buffer for returning the allocated interface address
1713 * (this may differ from the requested addr if the driver cannot
1714 * change interface address)
1715 * @bridge: Bridge interface to use or %NULL if no bridge configured
1716 * Returns: 0 on success, -1 on failure
1718 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1719 const char *ifname, const u8 *addr, void *bss_ctx,
1720 void **drv_priv, char *force_ifname, u8 *if_addr,
1721 const char *bridge);
1724 * if_remove - Remove a virtual interface
1725 * @priv: Private driver interface data
1726 * @type: Interface type
1727 * @ifname: Interface name of the virtual interface to be removed
1728 * Returns: 0 on success, -1 on failure
1730 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1731 const char *ifname);
1734 * set_sta_vlan - Bind a station into a specific interface (AP only)
1735 * @priv: Private driver interface data
1736 * @ifname: Interface (main or virtual BSS or VLAN)
1737 * @addr: MAC address of the associated station
1739 * Returns: 0 on success, -1 on failure
1741 * This function is used to bind a station to a specific virtual
1742 * interface. It is only used if when virtual interfaces are supported,
1743 * e.g., to assign stations to different VLAN interfaces based on
1744 * information from a RADIUS server. This allows separate broadcast
1745 * domains to be used with a single BSS.
1747 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1751 * commit - Optional commit changes handler (AP only)
1752 * @priv: driver private data
1753 * Returns: 0 on success, -1 on failure
1755 * This optional handler function can be registered if the driver
1756 * interface implementation needs to commit changes (e.g., by setting
1757 * network interface up) at the end of initial configuration. If set,
1758 * this handler will be called after initial setup has been completed.
1760 int (*commit)(void *priv);
1763 * send_ether - Send an ethernet packet (AP only)
1764 * @priv: private driver interface data
1765 * @dst: Destination MAC address
1766 * @src: Source MAC address
1768 * @data: EAPOL packet starting with IEEE 802.1X header
1769 * @data_len: Length of the EAPOL packet in octets
1770 * Returns: 0 on success, -1 on failure
1772 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1773 const u8 *data, size_t data_len);
1776 * set_radius_acl_auth - Notification of RADIUS ACL change
1777 * @priv: Private driver interface data
1778 * @mac: MAC address of the station
1779 * @accepted: Whether the station was accepted
1780 * @session_timeout: Session timeout for the station
1781 * Returns: 0 on success, -1 on failure
1783 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1784 u32 session_timeout);
1787 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1788 * @priv: Private driver interface data
1789 * @mac: MAC address of the station
1790 * Returns: 0 on success, -1 on failure
1792 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1795 * set_ht_params - Set HT parameters (AP only)
1796 * @priv: Private driver interface data
1797 * @ht_capab: HT Capabilities IE
1798 * @ht_capab_len: Length of ht_capab in octets
1799 * @ht_oper: HT Operation IE
1800 * @ht_oper_len: Length of ht_oper in octets
1801 * Returns: 0 on success, -1 on failure
1803 int (*set_ht_params)(void *priv,
1804 const u8 *ht_capab, size_t ht_capab_len,
1805 const u8 *ht_oper, size_t ht_oper_len);
1808 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
1809 * @priv: Private driver interface data
1810 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
1811 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
1813 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
1814 * to remove extra IE(s)
1815 * Returns: 0 on success, -1 on failure
1817 * This is an optional function to add WPS IE in the kernel driver for
1818 * Beacon and Probe Response frames. This can be left undefined (set
1819 * to %NULL) if the driver uses the Beacon template from set_beacon()
1820 * and does not process Probe Request frames. If the driver takes care
1821 * of (Re)Association frame processing, the assocresp buffer includes
1822 * WPS IE(s) that need to be added to (Re)Association Response frames
1823 * whenever a (Re)Association Request frame indicated use of WPS.
1825 * This will also be used to add P2P IE(s) into Beacon/Probe Response
1826 * frames when operating as a GO. The driver is responsible for adding
1827 * timing related attributes (e.g., NoA) in addition to the IEs
1828 * included here by appending them after these buffers. This call is
1829 * also used to provide Probe Response IEs for P2P Listen state
1830 * operations for drivers that generate the Probe Response frames
1833 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
1834 const struct wpabuf *proberesp,
1835 const struct wpabuf *assocresp);
1838 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1839 * @priv: Private driver interface data
1840 * @authorized: Whether the port is authorized
1841 * Returns: 0 on success, -1 on failure
1843 int (*set_supp_port)(void *priv, int authorized);
1846 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1847 * @priv: Private driver interface data
1848 * @addr: MAC address of the associated station
1849 * @aid: Association ID
1850 * @val: 1 = bind to 4-address WDS; 0 = unbind
1851 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
1852 * to indicate that bridge is not to be used
1853 * Returns: 0 on success, -1 on failure
1855 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
1856 const char *bridge_ifname);
1859 * send_action - Transmit an Action frame
1860 * @priv: Private driver interface data
1861 * @freq: Frequency (in MHz) of the channel
1862 * @wait: Time to wait off-channel for a response (in ms), or zero
1863 * @dst: Destination MAC address (Address 1)
1864 * @src: Source MAC address (Address 2)
1865 * @bssid: BSSID (Address 3)
1867 * @data_len: data length in octets
1868 * Returns: 0 on success, -1 on failure
1870 * This command can be used to request the driver to transmit an action
1871 * frame to the specified destination.
1873 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
1874 * be transmitted on the given channel and the device will wait for a
1875 * response on that channel for the given wait time.
1877 * If the flag is not set, the wait time will be ignored. In this case,
1878 * if a remain-on-channel duration is in progress, the frame must be
1879 * transmitted on that channel; alternatively the frame may be sent on
1880 * the current operational channel (if in associated state in station
1881 * mode or while operating as an AP.)
1883 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
1884 const u8 *dst, const u8 *src, const u8 *bssid,
1885 const u8 *data, size_t data_len);
1888 * send_action_cancel_wait - Cancel action frame TX wait
1889 * @priv: Private driver interface data
1891 * This command cancels the wait time associated with sending an action
1892 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
1893 * set in the driver flags.
1895 void (*send_action_cancel_wait)(void *priv);
1898 * remain_on_channel - Remain awake on a channel
1899 * @priv: Private driver interface data
1900 * @freq: Frequency (in MHz) of the channel
1901 * @duration: Duration in milliseconds
1902 * Returns: 0 on success, -1 on failure
1904 * This command is used to request the driver to remain awake on the
1905 * specified channel for the specified duration and report received
1906 * Action frames with EVENT_RX_ACTION events. Optionally, received
1907 * Probe Request frames may also be requested to be reported by calling
1908 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
1910 * The driver may not be at the requested channel when this function
1911 * returns, i.e., the return code is only indicating whether the
1912 * request was accepted. The caller will need to wait until the
1913 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
1914 * completed the channel change. This may take some time due to other
1915 * need for the radio and the caller should be prepared to timing out
1916 * its wait since there are no guarantees on when this request can be
1919 int (*remain_on_channel)(void *priv, unsigned int freq,
1920 unsigned int duration);
1923 * cancel_remain_on_channel - Cancel remain-on-channel operation
1924 * @priv: Private driver interface data
1926 * This command can be used to cancel a remain-on-channel operation
1927 * before its originally requested duration has passed. This could be
1928 * used, e.g., when remain_on_channel() is used to request extra time
1929 * to receive a response to an Action frame and the response is
1930 * received when there is still unneeded time remaining on the
1931 * remain-on-channel operation.
1933 int (*cancel_remain_on_channel)(void *priv);
1936 * probe_req_report - Request Probe Request frames to be indicated
1937 * @priv: Private driver interface data
1938 * @report: Whether to report received Probe Request frames
1939 * Returns: 0 on success, -1 on failure (or if not supported)
1941 * This command can be used to request the driver to indicate when
1942 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
1943 * Since this operation may require extra resources, e.g., due to less
1944 * optimal hardware/firmware RX filtering, many drivers may disable
1945 * Probe Request reporting at least in station mode. This command is
1946 * used to notify the driver when the Probe Request frames need to be
1947 * reported, e.g., during remain-on-channel operations.
1949 int (*probe_req_report)(void *priv, int report);
1952 * disable_11b_rates - Set whether IEEE 802.11b rates are used for TX
1953 * @priv: Private driver interface data
1954 * @disabled: Whether IEEE 802.11b rates are disabled
1955 * Returns: 0 on success, -1 on failure (or if not supported)
1957 * This command is used to disable IEEE 802.11b rates (1, 2, 5.5, and
1958 * 11 Mbps) as TX rates for data and management frames. This can be
1959 * used to optimize channel use when there is no need to support IEEE
1960 * 802.11b-only devices.
1962 int (*disable_11b_rates)(void *priv, int disabled);
1965 * deinit_ap - Deinitialize AP mode
1966 * @priv: Private driver interface data
1967 * Returns: 0 on success, -1 on failure (or if not supported)
1969 * This optional function can be used to disable AP mode related
1970 * configuration and change the driver mode to station mode to allow
1971 * normal station operations like scanning to be completed.
1973 int (*deinit_ap)(void *priv);
1976 * suspend - Notification on system suspend/hibernate event
1977 * @priv: Private driver interface data
1979 void (*suspend)(void *priv);
1982 * resume - Notification on system resume/thaw event
1983 * @priv: Private driver interface data
1985 void (*resume)(void *priv);
1988 * signal_monitor - Set signal monitoring parameters
1989 * @priv: Private driver interface data
1990 * @threshold: Threshold value for signal change events; 0 = disabled
1991 * @hysteresis: Minimum change in signal strength before indicating a
1993 * Returns: 0 on success, -1 on failure (or if not supported)
1995 * This function can be used to configure monitoring of signal strength
1996 * with the current AP. Whenever signal strength drops below the
1997 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
1998 * should be generated assuming the signal strength has changed at
1999 * least %hysteresis from the previously indicated signal change event.
2001 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2004 * send_frame - Send IEEE 802.11 frame (testing use only)
2005 * @priv: Private driver interface data
2006 * @data: IEEE 802.11 frame with IEEE 802.11 header
2007 * @data_len: Size of the frame
2008 * @encrypt: Whether to encrypt the frame (if keys are set)
2009 * Returns: 0 on success, -1 on failure
2011 * This function is only used for debugging purposes and is not
2012 * required to be implemented for normal operations.
2014 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2018 * shared_freq - Get operating frequency of shared interface(s)
2019 * @priv: Private driver interface data
2020 * Returns: Operating frequency in MHz, 0 if no shared operation in
2021 * use, or -1 on failure
2023 * This command can be used to request the current operating frequency
2024 * of any virtual interface that shares the same radio to provide
2025 * information for channel selection for other virtual interfaces.
2027 int (*shared_freq)(void *priv);
2030 * get_noa - Get current Notice of Absence attribute payload
2031 * @priv: Private driver interface data
2032 * @buf: Buffer for returning NoA
2033 * @buf_len: Buffer length in octets
2034 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2035 * advertized, or -1 on failure
2037 * This function is used to fetch the current Notice of Absence
2038 * attribute value from GO.
2040 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2043 * set_noa - Set Notice of Absence parameters for GO (testing)
2044 * @priv: Private driver interface data
2046 * @start: Start time in ms from next TBTT
2047 * @duration: Duration in ms
2048 * Returns: 0 on success or -1 on failure
2050 * This function is used to set Notice of Absence parameters for GO. It
2051 * is used only for testing. To disable NoA, all parameters are set to
2054 int (*set_noa)(void *priv, u8 count, int start, int duration);
2057 * set_p2p_powersave - Set P2P power save options
2058 * @priv: Private driver interface data
2059 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2060 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2061 * @ctwindow: 0.. = change (msec), -1 = no change
2062 * Returns: 0 on success or -1 on failure
2064 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2068 * ampdu - Enable/disable aggregation
2069 * @priv: Private driver interface data
2070 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2071 * Returns: 0 on success or -1 on failure
2073 int (*ampdu)(void *priv, int ampdu);
2076 * set_intra_bss - Enables/Disables intra BSS bridging
2078 int (*set_intra_bss)(void *priv, int enabled);
2081 * get_radio_name - Get physical radio name for the device
2082 * @priv: Private driver interface data
2083 * Returns: Radio name or %NULL if not known
2085 * The returned data must not be modified by the caller. It is assumed
2086 * that any interface that has the same radio name as another is
2087 * sharing the same physical radio. This information can be used to
2088 * share scan results etc. information between the virtual interfaces
2089 * to speed up various operations.
2091 const char * (*get_radio_name)(void *priv);
2094 * p2p_find - Start P2P Device Discovery
2095 * @priv: Private driver interface data
2096 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2097 * @type: Device Discovery type (enum p2p_discovery_type)
2098 * Returns: 0 on success, -1 on failure
2100 * This function is only used if the driver implements P2P management,
2101 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2102 * struct wpa_driver_capa.
2104 int (*p2p_find)(void *priv, unsigned int timeout, int type);
2107 * p2p_stop_find - Stop P2P Device Discovery
2108 * @priv: Private driver interface data
2109 * Returns: 0 on success, -1 on failure
2111 * This function is only used if the driver implements P2P management,
2112 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2113 * struct wpa_driver_capa.
2115 int (*p2p_stop_find)(void *priv);
2118 * p2p_listen - Start P2P Listen state for specified duration
2119 * @priv: Private driver interface data
2120 * @timeout: Listen state duration in milliseconds
2121 * Returns: 0 on success, -1 on failure
2123 * This function can be used to request the P2P module to keep the
2124 * device discoverable on the listen channel for an extended set of
2125 * time. At least in its current form, this is mainly used for testing
2126 * purposes and may not be of much use for normal P2P operations.
2128 * This function is only used if the driver implements P2P management,
2129 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2130 * struct wpa_driver_capa.
2132 int (*p2p_listen)(void *priv, unsigned int timeout);
2135 * p2p_connect - Start P2P group formation (GO negotiation)
2136 * @priv: Private driver interface data
2137 * @peer_addr: MAC address of the peer P2P client
2138 * @wps_method: enum p2p_wps_method value indicating config method
2139 * @go_intent: Local GO intent value (1..15)
2140 * @own_interface_addr: Intended interface address to use with the
2142 * @force_freq: The only allowed channel frequency in MHz or 0
2143 * @persistent_group: Whether to create persistent group
2144 * Returns: 0 on success, -1 on failure
2146 * This function is only used if the driver implements P2P management,
2147 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2148 * struct wpa_driver_capa.
2150 int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method,
2151 int go_intent, const u8 *own_interface_addr,
2152 unsigned int force_freq, int persistent_group);
2155 * wps_success_cb - Report successfully completed WPS provisioning
2156 * @priv: Private driver interface data
2157 * @peer_addr: Peer address
2158 * Returns: 0 on success, -1 on failure
2160 * This function is used to report successfully completed WPS
2161 * provisioning during group formation in both GO/Registrar and
2162 * client/Enrollee roles.
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 (*wps_success_cb)(void *priv, const u8 *peer_addr);
2171 * p2p_group_formation_failed - Report failed WPS provisioning
2172 * @priv: Private driver interface data
2173 * Returns: 0 on success, -1 on failure
2175 * This function is used to report failed group formation. This can
2176 * happen either due to failed WPS provisioning or due to 15 second
2177 * timeout during the provisioning phase.
2179 * This function is only used if the driver implements P2P management,
2180 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2181 * struct wpa_driver_capa.
2183 int (*p2p_group_formation_failed)(void *priv);
2186 * p2p_set_params - Set P2P parameters
2187 * @priv: Private driver interface data
2188 * @params: P2P parameters
2189 * Returns: 0 on success, -1 on failure
2191 * This function is only used if the driver implements P2P management,
2192 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2193 * struct wpa_driver_capa.
2195 int (*p2p_set_params)(void *priv, const struct p2p_params *params);
2198 * p2p_prov_disc_req - Send Provision Discovery Request
2199 * @priv: Private driver interface data
2200 * @peer_addr: MAC address of the peer P2P client
2201 * @config_methods: WPS Config Methods value (only one bit set)
2202 * Returns: 0 on success, -1 on failure
2204 * This function can be used to request a discovered P2P peer to
2205 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2206 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2207 * Provision Discovery Request frame is transmitted once immediately
2208 * and if no response is received, the frame will be sent again
2209 * whenever the target device is discovered during device dsicovery
2210 * (start with a p2p_find() call). Response from the peer is indicated
2211 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
2213 * This function is only used if the driver implements P2P management,
2214 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2215 * struct wpa_driver_capa.
2217 int (*p2p_prov_disc_req)(void *priv, const u8 *peer_addr,
2218 u16 config_methods);
2221 * p2p_sd_request - Schedule a service discovery query
2222 * @priv: Private driver interface data
2223 * @dst: Destination peer or %NULL to apply for all peers
2224 * @tlvs: P2P Service Query TLV(s)
2225 * Returns: Reference to the query or 0 on failure
2227 * Response to the query is indicated with the
2228 * EVENT_P2P_SD_RESPONSE driver event.
2230 * This function is only used if the driver implements P2P management,
2231 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2232 * struct wpa_driver_capa.
2234 u64 (*p2p_sd_request)(void *priv, const u8 *dst,
2235 const struct wpabuf *tlvs);
2238 * p2p_sd_cancel_request - Cancel a pending service discovery query
2239 * @priv: Private driver interface data
2240 * @req: Query reference from p2p_sd_request()
2241 * Returns: 0 on success, -1 on failure
2243 * This function is only used if the driver implements P2P management,
2244 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2245 * struct wpa_driver_capa.
2247 int (*p2p_sd_cancel_request)(void *priv, u64 req);
2250 * p2p_sd_response - Send response to a service discovery query
2251 * @priv: Private driver interface data
2252 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2253 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2254 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2255 * @resp_tlvs: P2P Service Response TLV(s)
2256 * Returns: 0 on success, -1 on failure
2258 * This function is called as a response to the request indicated with
2259 * the EVENT_P2P_SD_REQUEST driver event.
2261 * This function is only used if the driver implements P2P management,
2262 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2263 * struct wpa_driver_capa.
2265 int (*p2p_sd_response)(void *priv, int freq, const u8 *dst,
2267 const struct wpabuf *resp_tlvs);
2270 * p2p_service_update - Indicate a change in local services
2271 * @priv: Private driver interface data
2272 * Returns: 0 on success, -1 on failure
2274 * This function needs to be called whenever there is a change in
2275 * availability of the local services. This will increment the
2276 * Service Update Indicator value which will be used in SD Request and
2279 * This function is only used if the driver implements P2P management,
2280 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2281 * struct wpa_driver_capa.
2283 int (*p2p_service_update)(void *priv);
2286 * p2p_reject - Reject peer device (explicitly block connections)
2287 * @priv: Private driver interface data
2288 * @addr: MAC address of the peer
2289 * Returns: 0 on success, -1 on failure
2291 int (*p2p_reject)(void *priv, const u8 *addr);
2294 * p2p_invite - Invite a P2P Device into a group
2295 * @priv: Private driver interface data
2296 * @peer: Device Address of the peer P2P Device
2297 * @role: Local role in the group
2298 * @bssid: Group BSSID or %NULL if not known
2300 * @ssid_len: Length of ssid in octets
2301 * @go_dev_addr: Forced GO Device Address or %NULL if none
2302 * @persistent_group: Whether this is to reinvoke a persistent group
2303 * Returns: 0 on success, -1 on failure
2305 int (*p2p_invite)(void *priv, const u8 *peer, int role,
2306 const u8 *bssid, const u8 *ssid, size_t ssid_len,
2307 const u8 *go_dev_addr, int persistent_group);
2310 * send_tdls_mgmt - for sending TDLS management packets
2311 * @priv: private driver interface data
2312 * @dst: Destination (peer) MAC address
2313 * @action_code: TDLS action code for the mssage
2314 * @dialog_token: Dialog Token to use in the message (if needed)
2315 * @status_code: Status Code or Reason Code to use (if needed)
2316 * @buf: TDLS IEs to add to the message
2317 * @len: Length of buf in octets
2318 * Returns: 0 on success, -1 on failure
2320 * This optional function can be used to send packet to driver which is
2321 * responsible for receiving and sending all TDLS packets.
2323 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2324 u8 dialog_token, u16 status_code,
2325 const u8 *buf, size_t len);
2327 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2330 * signal_poll - Get current connection information
2331 * @priv: Private driver interface data
2332 * @signal_info: Connection info structure
2334 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2337 * set_authmode - Set authentication algorithm(s) for static WEP
2338 * @priv: Private driver interface data
2339 * @authmode: 1=Open System, 2=Shared Key, 3=both
2340 * Returns: 0 on success, -1 on failure
2342 * This function can be used to set authentication algorithms for AP
2343 * mode when static WEP is used. If the driver uses user space MLME/SME
2344 * implementation, there is no need to implement this function.
2346 int (*set_authmode)(void *priv, int authmode);
2349 * set_rekey_info - Set rekey information
2350 * @priv: Private driver interface data
2353 * @replay_ctr: Current EAPOL-Key Replay Counter
2355 * This optional function can be used to provide information for the
2356 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2357 * while the host (including wpa_supplicant) is sleeping.
2359 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2360 const u8 *replay_ctr);
2365 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2367 enum wpa_event_type {
2369 * EVENT_ASSOC - Association completed
2371 * This event needs to be delivered when the driver completes IEEE
2372 * 802.11 association or reassociation successfully.
2373 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2374 * after this event has been generated. In addition, optional
2375 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2376 * more information about the association. If the driver interface gets
2377 * both of these events at the same time, it can also include the
2378 * assoc_info data in EVENT_ASSOC call.
2383 * EVENT_DISASSOC - Association lost
2385 * This event should be called when association is lost either due to
2386 * receiving deauthenticate or disassociate frame from the AP or when
2387 * sending either of these frames to the current AP. If the driver
2388 * supports separate deauthentication event, EVENT_DISASSOC should only
2389 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2390 * In AP mode, union wpa_event_data::disassoc_info is required.
2395 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2397 * This event must be delivered when a Michael MIC error is detected by
2398 * the local driver. Additional data for event processing is
2399 * provided with union wpa_event_data::michael_mic_failure. This
2400 * information is used to request new encyption key and to initiate
2401 * TKIP countermeasures if needed.
2403 EVENT_MICHAEL_MIC_FAILURE,
2406 * EVENT_SCAN_RESULTS - Scan results available
2408 * This event must be called whenever scan results are available to be
2409 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2410 * is expected to be used some time after struct wpa_driver_ops::scan()
2411 * is called. If the driver provides an unsolicited event when the scan
2412 * has been completed, this event can be used to trigger
2413 * EVENT_SCAN_RESULTS call. If such event is not available from the
2414 * driver, the driver wrapper code is expected to use a registered
2415 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2416 * scan is expected to be completed. Optional information about
2417 * completed scan can be provided with union wpa_event_data::scan_info.
2422 * EVENT_ASSOCINFO - Report optional extra information for association
2424 * This event can be used to report extra association information for
2425 * EVENT_ASSOC processing. This extra information includes IEs from
2426 * association frames and Beacon/Probe Response frames in union
2427 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2428 * EVENT_ASSOC. Alternatively, the driver interface can include
2429 * assoc_info data in the EVENT_ASSOC call if it has all the
2430 * information available at the same point.
2435 * EVENT_INTERFACE_STATUS - Report interface status changes
2437 * This optional event can be used to report changes in interface
2438 * status (interface added/removed) using union
2439 * wpa_event_data::interface_status. This can be used to trigger
2440 * wpa_supplicant to stop and re-start processing for the interface,
2441 * e.g., when a cardbus card is ejected/inserted.
2443 EVENT_INTERFACE_STATUS,
2446 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2448 * This event can be used to inform wpa_supplicant about candidates for
2449 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2450 * for scan request (ap_scan=2 mode), this event is required for
2451 * pre-authentication. If wpa_supplicant is performing scan request
2452 * (ap_scan=1), this event is optional since scan results can be used
2453 * to add pre-authentication candidates. union
2454 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2455 * candidate and priority of the candidate, e.g., based on the signal
2456 * strength, in order to try to pre-authenticate first with candidates
2457 * that are most likely targets for re-association.
2459 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2460 * on the candidate list. In addition, it can be called for the current
2461 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2462 * will automatically skip pre-authentication in cases where a valid
2463 * PMKSA exists. When more than one candidate exists, this event should
2464 * be generated once for each candidate.
2466 * Driver will be notified about successful pre-authentication with
2467 * struct wpa_driver_ops::add_pmkid() calls.
2469 EVENT_PMKID_CANDIDATE,
2472 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2474 * This event can be used to inform wpa_supplicant about desire to set
2475 * up secure direct link connection between two stations as defined in
2476 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2477 * STAKey negotiation. The caller will need to set peer address for the
2483 * EVENT_TDLS - Request TDLS operation
2485 * This event can be used to request a TDLS operation to be performed.
2490 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2492 * The driver is expected to report the received FT IEs from
2493 * FT authentication sequence from the AP. The FT IEs are included in
2494 * the extra information in union wpa_event_data::ft_ies.
2499 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2501 * The driver can use this event to inform wpa_supplicant about a STA
2502 * in an IBSS with which protected frames could be exchanged. This
2503 * event starts RSN authentication with the other STA to authenticate
2504 * the STA and set up encryption keys with it.
2506 EVENT_IBSS_RSN_START,
2509 * EVENT_AUTH - Authentication result
2511 * This event should be called when authentication attempt has been
2512 * completed. This is only used if the driver supports separate
2513 * authentication step (struct wpa_driver_ops::authenticate).
2514 * Information about authentication result is included in
2515 * union wpa_event_data::auth.
2520 * EVENT_DEAUTH - Authentication lost
2522 * This event should be called when authentication is lost either due
2523 * to receiving deauthenticate frame from the AP or when sending that
2524 * frame to the current AP.
2525 * In AP mode, union wpa_event_data::deauth_info is required.
2530 * EVENT_ASSOC_REJECT - Association rejected
2532 * This event should be called when (re)association attempt has been
2533 * rejected by the AP. Information about the association response is
2534 * included in union wpa_event_data::assoc_reject.
2539 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2541 EVENT_AUTH_TIMED_OUT,
2544 * EVENT_ASSOC_TIMED_OUT - Association timed out
2546 EVENT_ASSOC_TIMED_OUT,
2549 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2554 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2556 EVENT_WPS_BUTTON_PUSHED,
2559 * EVENT_TX_STATUS - Report TX status
2564 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2566 EVENT_RX_FROM_UNKNOWN,
2569 * EVENT_RX_MGMT - Report RX of a management frame
2574 * EVENT_RX_ACTION - Action frame received
2576 * This event is used to indicate when an Action frame has been
2577 * received. Information about the received frame is included in
2578 * union wpa_event_data::rx_action.
2583 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2585 * This event is used to indicate when the driver has started the
2586 * requested remain-on-channel duration. Information about the
2587 * operation is included in union wpa_event_data::remain_on_channel.
2589 EVENT_REMAIN_ON_CHANNEL,
2592 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2594 * This event is used to indicate when the driver has completed
2595 * remain-on-channel duration, i.e., may noot be available on the
2596 * requested channel anymore. Information about the
2597 * operation is included in union wpa_event_data::remain_on_channel.
2599 EVENT_CANCEL_REMAIN_ON_CHANNEL,
2602 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2604 * This event is used only by driver_test.c and userspace MLME.
2609 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2611 * This event is used to indicate when a Probe Request frame has been
2612 * received. Information about the received frame is included in
2613 * union wpa_event_data::rx_probe_req. The driver is required to report
2614 * these events only after successfully completed probe_req_report()
2615 * commands to request the events (i.e., report parameter is non-zero)
2616 * in station mode. In AP mode, Probe Request frames should always be
2622 * EVENT_NEW_STA - New wired device noticed
2624 * This event is used to indicate that a new device has been detected
2625 * in a network that does not use association-like functionality (i.e.,
2626 * mainly wired Ethernet). This can be used to start EAPOL
2627 * authenticator when receiving a frame from a device. The address of
2628 * the device is included in union wpa_event_data::new_sta.
2633 * EVENT_EAPOL_RX - Report received EAPOL frame
2635 * When in AP mode with hostapd, this event is required to be used to
2636 * deliver the receive EAPOL frames from the driver. With
2637 * %wpa_supplicant, this event is used only if the send_eapol() handler
2638 * is used to override the use of l2_packet for EAPOL frame TX.
2643 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
2645 * This event is used to indicate changes in the signal strength
2646 * observed in frames received from the current AP if signal strength
2647 * monitoring has been enabled with signal_monitor().
2649 EVENT_SIGNAL_CHANGE,
2652 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
2654 * This event is used to indicate that the interface was enabled after
2655 * having been previously disabled, e.g., due to rfkill.
2657 EVENT_INTERFACE_ENABLED,
2660 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
2662 * This event is used to indicate that the interface was disabled,
2663 * e.g., due to rfkill.
2665 EVENT_INTERFACE_DISABLED,
2668 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
2670 * This event is used to indicate that the channel list has changed,
2671 * e.g., because of a regulatory domain change triggered by scan
2672 * results including an AP advertising a country code.
2674 EVENT_CHANNEL_LIST_CHANGED,
2677 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
2679 * This event is used to indicate that the driver cannot maintain this
2680 * interface in its operation mode anymore. The most likely use for
2681 * this is to indicate that AP mode operation is not available due to
2682 * operating channel would need to be changed to a DFS channel when
2683 * the driver does not support radar detection and another virtual
2684 * interfaces caused the operating channel to change. Other similar
2685 * resource conflicts could also trigger this for station mode
2688 EVENT_INTERFACE_UNAVAILABLE,
2691 * EVENT_BEST_CHANNEL
2693 * Driver generates this event whenever it detects a better channel
2694 * (e.g., based on RSSI or channel use). This information can be used
2695 * to improve channel selection for a new AP/P2P group.
2700 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
2702 * This event should be called when a Deauthentication frame is dropped
2703 * due to it not being protected (MFP/IEEE 802.11w).
2704 * union wpa_event_data::unprot_deauth is required to provide more
2705 * details of the frame.
2707 EVENT_UNPROT_DEAUTH,
2710 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
2712 * This event should be called when a Disassociation frame is dropped
2713 * due to it not being protected (MFP/IEEE 802.11w).
2714 * union wpa_event_data::unprot_disassoc is required to provide more
2715 * details of the frame.
2717 EVENT_UNPROT_DISASSOC,
2720 * EVENT_STATION_LOW_ACK
2722 * Driver generates this event whenever it detected that a particular
2723 * station was lost. Detection can be through massive transmission
2724 * failures for example.
2726 EVENT_STATION_LOW_ACK,
2729 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
2731 * This event is used only if the driver implements P2P management
2732 * internally. Event data is stored in
2733 * union wpa_event_data::p2p_dev_found.
2735 EVENT_P2P_DEV_FOUND,
2738 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
2740 * This event is used only if the driver implements P2P management
2741 * internally. Event data is stored in
2742 * union wpa_event_data::p2p_go_neg_req_rx.
2744 EVENT_P2P_GO_NEG_REQ_RX,
2747 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
2749 * This event is used only if the driver implements P2P management
2750 * internally. Event data is stored in
2751 * union wpa_event_data::p2p_go_neg_completed.
2753 EVENT_P2P_GO_NEG_COMPLETED,
2755 EVENT_P2P_PROV_DISC_REQUEST,
2756 EVENT_P2P_PROV_DISC_RESPONSE,
2757 EVENT_P2P_SD_REQUEST,
2758 EVENT_P2P_SD_RESPONSE,
2761 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
2763 EVENT_IBSS_PEER_LOST,
2766 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
2768 * This event carries the new replay counter to notify wpa_supplicant
2769 * of the current EAPOL-Key Replay Counter in case the driver/firmware
2770 * completed Group Key Handshake while the host (including
2771 * wpa_supplicant was sleeping).
2773 EVENT_DRIVER_GTK_REKEY
2778 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
2780 union wpa_event_data {
2782 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
2784 * This structure is optional for EVENT_ASSOC calls and required for
2785 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
2786 * driver interface does not need to generate separate EVENT_ASSOCINFO
2791 * reassoc - Flag to indicate association or reassociation
2796 * req_ies - (Re)Association Request IEs
2798 * If the driver generates WPA/RSN IE, this event data must be
2799 * returned for WPA handshake to have needed information. If
2800 * wpa_supplicant-generated WPA/RSN IE is used, this
2801 * information event is optional.
2803 * This should start with the first IE (fixed fields before IEs
2804 * are not included).
2809 * req_ies_len - Length of req_ies in bytes
2814 * resp_ies - (Re)Association Response IEs
2816 * Optional association data from the driver. This data is not
2817 * required WPA, but may be useful for some protocols and as
2818 * such, should be reported if this is available to the driver
2821 * This should start with the first IE (fixed fields before IEs
2822 * are not included).
2827 * resp_ies_len - Length of resp_ies in bytes
2829 size_t resp_ies_len;
2832 * beacon_ies - Beacon or Probe Response IEs
2834 * Optional Beacon/ProbeResp data: IEs included in Beacon or
2835 * Probe Response frames from the current AP (i.e., the one
2836 * that the client just associated with). This information is
2837 * used to update WPA/RSN IE for the AP. If this field is not
2838 * set, the results from previous scan will be used. If no
2839 * data for the new AP is found, scan results will be requested
2840 * again (without scan request). At this point, the driver is
2841 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
2844 * This should start with the first IE (fixed fields before IEs
2845 * are not included).
2847 const u8 *beacon_ies;
2850 * beacon_ies_len - Length of beacon_ies */
2851 size_t beacon_ies_len;
2854 * freq - Frequency of the operational channel in MHz
2859 * addr - Station address (for AP mode)
2865 * struct disassoc_info - Data for EVENT_DISASSOC events
2867 struct disassoc_info {
2869 * addr - Station address (for AP mode)
2874 * reason_code - Reason Code (host byte order) used in
2875 * Deauthentication frame
2880 * ie - Optional IE(s) in Disassociation frame
2885 * ie_len - Length of ie buffer in octets
2891 * struct deauth_info - Data for EVENT_DEAUTH events
2893 struct deauth_info {
2895 * addr - Station address (for AP mode)
2900 * reason_code - Reason Code (host byte order) used in
2901 * Deauthentication frame
2906 * ie - Optional IE(s) in Deauthentication frame
2911 * ie_len - Length of ie buffer in octets
2917 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
2919 struct michael_mic_failure {
2922 } michael_mic_failure;
2925 * struct interface_status - Data for EVENT_INTERFACE_STATUS
2927 struct interface_status {
2930 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
2935 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
2937 struct pmkid_candidate {
2938 /** BSSID of the PMKID candidate */
2940 /** Smaller the index, higher the priority */
2942 /** Whether RSN IE includes pre-authenticate flag */
2947 * struct stkstart - Data for EVENT_STKSTART
2954 * struct tdls - Data for EVENT_TDLS
2960 TDLS_REQUEST_TEARDOWN
2962 u16 reason_code; /* for teardown */
2966 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
2968 * During FT (IEEE 802.11r) authentication sequence, the driver is
2969 * expected to use this event to report received FT IEs (MDIE, FTIE,
2970 * RSN IE, TIE, possible resource request) to the supplicant. The FT
2971 * IEs for the next message will be delivered through the
2972 * struct wpa_driver_ops::update_ft_ies() callback.
2978 u8 target_ap[ETH_ALEN];
2979 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
2981 /** Length of ric_ies buffer in octets */
2986 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
2988 struct ibss_rsn_start {
2993 * struct auth_info - Data for EVENT_AUTH events
3004 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3006 struct assoc_reject {
3008 * bssid - BSSID of the AP that rejected association
3013 * resp_ies - (Re)Association Response IEs
3015 * Optional association data from the driver. This data is not
3016 * required WPA, but may be useful for some protocols and as
3017 * such, should be reported if this is available to the driver
3020 * This should start with the first IE (fixed fields before IEs
3021 * are not included).
3026 * resp_ies_len - Length of resp_ies in bytes
3028 size_t resp_ies_len;
3031 * status_code - Status Code from (Re)association Response
3036 struct timeout_event {
3041 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3050 * struct tx_status - Data for EVENT_TX_STATUS events
3062 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3064 struct rx_from_unknown {
3070 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3080 * struct rx_action - Data for EVENT_RX_ACTION events
3084 * da - Destination address of the received Action frame
3089 * sa - Source address of the received Action frame
3094 * bssid - Address 3 of the received Action frame
3099 * category - Action frame category
3104 * data - Action frame body after category field
3109 * len - Length of data in octets
3114 * freq - Frequency (in MHz) on which the frame was received
3120 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3122 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3124 struct remain_on_channel {
3126 * freq - Channel frequency in MHz
3131 * duration - Duration to remain on the channel in milliseconds
3133 unsigned int duration;
3134 } remain_on_channel;
3137 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3138 * @aborted: Whether the scan was aborted
3139 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3140 * @num_freqs: Number of entries in freqs array
3141 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3143 * @num_ssids: Number of entries in ssids array
3149 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3154 * struct mlme_rx - Data for EVENT_MLME_RX events
3165 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3167 struct rx_probe_req {
3169 * sa - Source address of the received Probe Request frame
3174 * da - Destination address of the received Probe Request frame
3175 * or %NULL if not available
3180 * bssid - BSSID of the received Probe Request frame or %NULL
3186 * ie - IEs from the Probe Request body
3191 * ie_len - Length of ie buffer in octets
3197 * struct new_sta - Data for EVENT_NEW_STA events
3204 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3213 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3215 struct wpa_signal_info signal_change;
3218 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3219 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3220 * @freq_5: Best 5 GHz band channel frequency in MHz
3221 * @freq_overall: Best channel frequency in MHz
3223 * 0 can be used to indicate no preference in either band.
3225 struct best_channel {
3231 struct unprot_deauth {
3237 struct unprot_disassoc {
3244 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3245 * @addr: station address
3252 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3254 struct p2p_dev_found {
3257 const u8 *pri_dev_type;
3258 const char *dev_name;
3265 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3267 struct p2p_go_neg_req_rx {
3270 } p2p_go_neg_req_rx;
3273 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3275 struct p2p_go_neg_completed {
3276 struct p2p_go_neg_results *res;
3277 } p2p_go_neg_completed;
3279 struct p2p_prov_disc_req {
3283 const u8 *pri_dev_type;
3284 const char *dev_name;
3285 u16 supp_config_methods;
3288 } p2p_prov_disc_req;
3290 struct p2p_prov_disc_resp {
3293 } p2p_prov_disc_resp;
3304 struct p2p_sd_resp {
3312 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3314 struct ibss_peer_lost {
3319 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3321 struct driver_gtk_rekey {
3323 const u8 *replay_ctr;
3328 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3329 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3330 * with struct wpa_driver_ops::init()
3331 * @event: event type (defined above)
3332 * @data: possible extra data for the event
3334 * Driver wrapper code should call this function whenever an event is received
3337 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
3338 union wpa_event_data *data);
3342 * The following inline functions are provided for convenience to simplify
3343 * event indication for some of the common events.
3346 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
3347 size_t ielen, int reassoc)
3349 union wpa_event_data event;
3350 os_memset(&event, 0, sizeof(event));
3351 event.assoc_info.reassoc = reassoc;
3352 event.assoc_info.req_ies = ie;
3353 event.assoc_info.req_ies_len = ielen;
3354 event.assoc_info.addr = addr;
3355 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
3358 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
3360 union wpa_event_data event;
3361 os_memset(&event, 0, sizeof(event));
3362 event.disassoc_info.addr = addr;
3363 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
3366 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
3369 union wpa_event_data event;
3370 os_memset(&event, 0, sizeof(event));
3371 event.eapol_rx.src = src;
3372 event.eapol_rx.data = data;
3373 event.eapol_rx.data_len = data_len;
3374 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
3377 #endif /* DRIVER_H */