2 * Driver interface definition
3 * Copyright (c) 2003-2012, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
14 * This file defines a driver interface used by both %wpa_supplicant and
15 * hostapd. The first part of the file defines data structures used in various
16 * driver operations. This is followed by the struct wpa_driver_ops that each
17 * driver wrapper will beed to define with callback functions for requesting
18 * driver operations. After this, there are definitions for driver event
19 * reporting with wpa_supplicant_event() and some convenience helper functions
20 * that can be used to report events.
26 #define WPA_SUPPLICANT_DRIVER_VERSION 4
28 #include "common/defs.h"
30 #define HOSTAPD_CHAN_DISABLED 0x00000001
31 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
32 #define HOSTAPD_CHAN_NO_IBSS 0x00000004
33 #define HOSTAPD_CHAN_RADAR 0x00000008
34 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
35 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
36 #define HOSTAPD_CHAN_HT40 0x00000040
39 * struct hostapd_channel_data - Channel information
41 struct hostapd_channel_data
{
43 * chan - Channel number (IEEE 802.11)
48 * freq - Frequency in MHz
53 * flag - Channel flags (HOSTAPD_CHAN_*)
58 * max_tx_power - maximum transmit power in dBm
63 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
66 * struct hostapd_hw_modes - Supported hardware mode information
68 struct hostapd_hw_modes
{
70 * mode - Hardware mode
72 enum hostapd_hw_mode mode
;
75 * num_channels - Number of entries in the channels array
80 * channels - Array of supported channels
82 struct hostapd_channel_data
*channels
;
85 * num_rates - Number of entries in the rates array
90 * rates - Array of supported rates in 100 kbps units
95 * ht_capab - HT (IEEE 802.11n) capabilities
100 * mcs_set - MCS (IEEE 802.11n) rate parameters
105 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
109 unsigned int flags
; /* HOSTAPD_MODE_FLAG_* */
113 #define IEEE80211_MODE_INFRA 0
114 #define IEEE80211_MODE_IBSS 1
115 #define IEEE80211_MODE_AP 2
117 #define IEEE80211_CAP_ESS 0x0001
118 #define IEEE80211_CAP_IBSS 0x0002
119 #define IEEE80211_CAP_PRIVACY 0x0010
121 #define WPA_SCAN_QUAL_INVALID BIT(0)
122 #define WPA_SCAN_NOISE_INVALID BIT(1)
123 #define WPA_SCAN_LEVEL_INVALID BIT(2)
124 #define WPA_SCAN_LEVEL_DBM BIT(3)
125 #define WPA_SCAN_AUTHENTICATED BIT(4)
126 #define WPA_SCAN_ASSOCIATED BIT(5)
129 * struct wpa_scan_res - Scan result for an BSS/IBSS
130 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
132 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
133 * @beacon_int: beacon interval in TUs (host byte order)
134 * @caps: capability information field in host byte order
135 * @qual: signal quality
136 * @noise: noise level
137 * @level: signal level
139 * @age: Age of the information in milliseconds (i.e., how many milliseconds
140 * ago the last Beacon or Probe Response frame was received)
141 * @ie_len: length of the following IE field in octets
142 * @beacon_ie_len: length of the following Beacon IE field in octets
144 * This structure is used as a generic format for scan results from the
145 * driver. Each driver interface implementation is responsible for converting
146 * the driver or OS specific scan results into this format.
148 * If the driver does not support reporting all IEs, the IE data structure is
149 * constructed of the IEs that are available. This field will also need to
150 * include SSID in IE format. All drivers are encouraged to be extended to
151 * report all IEs to make it easier to support future additions.
153 struct wpa_scan_res
{
165 size_t beacon_ie_len
;
167 * Followed by ie_len octets of IEs from Probe Response frame (or if
168 * the driver does not indicate source of IEs, these may also be from
169 * Beacon frame). After the first set of IEs, another set of IEs may
170 * follow (with beacon_ie_len octets of data) if the driver provides
176 * struct wpa_scan_results - Scan results
177 * @res: Array of pointers to allocated variable length scan result entries
178 * @num: Number of entries in the scan result array
180 struct wpa_scan_results
{
181 struct wpa_scan_res
**res
;
186 * struct wpa_interface_info - Network interface information
187 * @next: Pointer to the next interface or NULL if this is the last one
188 * @ifname: Interface name that can be used with init() or init2()
189 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
191 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
192 * is not an allocated copy, i.e., get_interfaces() caller will not free
195 struct wpa_interface_info
{
196 struct wpa_interface_info
*next
;
199 const char *drv_name
;
202 #define WPAS_MAX_SCAN_SSIDS 16
205 * struct wpa_driver_scan_params - Scan parameters
206 * Data for struct wpa_driver_ops::scan2().
208 struct wpa_driver_scan_params
{
210 * ssids - SSIDs to scan for
212 struct wpa_driver_scan_ssid
{
214 * ssid - specific SSID to scan for (ProbeReq)
215 * %NULL or zero-length SSID is used to indicate active scan
216 * with wildcard SSID.
220 * ssid_len: Length of the SSID in octets
223 } ssids
[WPAS_MAX_SCAN_SSIDS
];
226 * num_ssids - Number of entries in ssids array
227 * Zero indicates a request for a passive scan.
232 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
237 * extra_ies_len - Length of extra_ies in octets
239 size_t extra_ies_len
;
242 * freqs - Array of frequencies to scan or %NULL for all frequencies
244 * The frequency is set in MHz. The array is zero-terminated.
249 * filter_ssids - Filter for reporting SSIDs
251 * This optional parameter can be used to request the driver wrapper to
252 * filter scan results to include only the specified SSIDs. %NULL
253 * indicates that no filtering is to be done. This can be used to
254 * reduce memory needs for scan results in environments that have large
255 * number of APs with different SSIDs.
257 * The driver wrapper is allowed to take this allocated buffer into its
258 * own use by setting the pointer to %NULL. In that case, the driver
259 * wrapper is responsible for freeing the buffer with os_free() once it
260 * is not needed anymore.
262 struct wpa_driver_scan_filter
{
268 * num_filter_ssids - Number of entries in filter_ssids array
270 size_t num_filter_ssids
;
273 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
275 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
276 * Mbps from the support rates element(s) in the Probe Request frames
277 * and not to transmit the frames at any of those rates.
283 * struct wpa_driver_auth_params - Authentication parameters
284 * Data for struct wpa_driver_ops::authenticate().
286 struct wpa_driver_auth_params
{
294 const u8
*wep_key
[4];
295 size_t wep_key_len
[4];
297 int local_state_change
;
300 * p2p - Whether this connection is a P2P group
307 WPS_MODE_NONE
/* no WPS provisioning being used */,
308 WPS_MODE_OPEN
/* WPS provisioning with AP that is in open mode */,
309 WPS_MODE_PRIVACY
/* WPS provisioning with AP that is using protection
314 * struct wpa_driver_associate_params - Association parameters
315 * Data for struct wpa_driver_ops::associate().
317 struct wpa_driver_associate_params
{
319 * bssid - BSSID of the selected AP
320 * This can be %NULL, if ap_scan=2 mode is used and the driver is
321 * responsible for selecting with which BSS to associate. */
325 * ssid - The selected SSID
330 * ssid_len - Length of the SSID (1..32)
335 * freq - Frequency of the channel the selected AP is using
336 * Frequency that the selected AP is using (in MHz as
337 * reported in the scan results)
342 * wpa_ie - WPA information element for (Re)Association Request
343 * WPA information element to be included in (Re)Association
344 * Request (including information element id and length). Use
345 * of this WPA IE is optional. If the driver generates the WPA
346 * IE, it can use pairwise_suite, group_suite, and
347 * key_mgmt_suite to select proper algorithms. In this case,
348 * the driver has to notify wpa_supplicant about the used WPA
349 * IE by generating an event that the interface code will
350 * convert into EVENT_ASSOCINFO data (see below).
352 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
353 * instead. The driver can determine which version is used by
354 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
357 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
362 * wpa_ie_len - length of the wpa_ie
367 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
369 unsigned int wpa_proto
;
372 * pairwise_suite - Selected pairwise cipher suite
374 * This is usually ignored if @wpa_ie is used.
376 enum wpa_cipher pairwise_suite
;
379 * group_suite - Selected group cipher suite
381 * This is usually ignored if @wpa_ie is used.
383 enum wpa_cipher group_suite
;
386 * key_mgmt_suite - Selected key management suite
388 * This is usually ignored if @wpa_ie is used.
390 enum wpa_key_mgmt key_mgmt_suite
;
393 * auth_alg - Allowed authentication algorithms
394 * Bit field of WPA_AUTH_ALG_*
399 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
404 * wep_key - WEP keys for static WEP configuration
406 const u8
*wep_key
[4];
409 * wep_key_len - WEP key length for static WEP configuration
411 size_t wep_key_len
[4];
414 * wep_tx_keyidx - WEP TX key index for static WEP configuration
419 * mgmt_frame_protection - IEEE 802.11w management frame protection
421 enum mfp_options mgmt_frame_protection
;
424 * ft_ies - IEEE 802.11r / FT information elements
425 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
426 * for fast transition, this parameter is set to include the IEs that
427 * are to be sent in the next FT Authentication Request message.
428 * update_ft_ies() handler is called to update the IEs for further
429 * FT messages in the sequence.
431 * The driver should use these IEs only if the target AP is advertising
432 * the same mobility domain as the one included in the MDIE here.
434 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
435 * AP after the initial association. These IEs can only be used if the
436 * target AP is advertising support for FT and is using the same MDIE
437 * and SSID as the current AP.
439 * The driver is responsible for reporting the FT IEs received from the
440 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
441 * type. update_ft_ies() handler will then be called with the FT IEs to
442 * include in the next frame in the authentication sequence.
447 * ft_ies_len - Length of ft_ies in bytes
452 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
454 * This value is provided to allow the driver interface easier access
455 * to the current mobility domain. This value is set to %NULL if no
456 * mobility domain is currently active.
461 * passphrase - RSN passphrase for PSK
463 * This value is made available only for WPA/WPA2-Personal (PSK) and
464 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
465 * the 8..63 character ASCII passphrase, if available. Please note that
466 * this can be %NULL if passphrase was not used to generate the PSK. In
467 * that case, the psk field must be used to fetch the PSK.
469 const char *passphrase
;
472 * psk - RSN PSK (alternative for passphrase for PSK)
474 * This value is made available only for WPA/WPA2-Personal (PSK) and
475 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
476 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
477 * be prepared to handle %NULL value as an error.
482 * drop_unencrypted - Enable/disable unencrypted frame filtering
484 * Configure the driver to drop all non-EAPOL frames (both receive and
485 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
486 * still be allowed for key negotiation.
488 int drop_unencrypted
;
491 * prev_bssid - Previously used BSSID in this ESS
493 * When not %NULL, this is a request to use reassociation instead of
496 const u8
*prev_bssid
;
501 * If the driver needs to do special configuration for WPS association,
502 * this variable provides more information on what type of association
503 * is being requested. Most drivers should not need ot use this.
508 * p2p - Whether this connection is a P2P group
513 * uapsd - UAPSD parameters for the network
514 * -1 = do not change defaults
515 * AP mode: 1 = enabled, 0 = disabled
516 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
521 * fixed_bssid - Whether to force this BSSID in IBSS mode
522 * 1 = Fix this BSSID and prevent merges.
523 * 0 = Do not fix BSSID.
530 HIDDEN_SSID_ZERO_LEN
,
531 HIDDEN_SSID_ZERO_CONTENTS
534 struct wpa_driver_ap_params
{
536 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
541 * head_len - Length of the head buffer in octets
546 * tail - Beacon tail following TIM IE
551 * tail_len - Length of the tail buffer in octets
556 * dtim_period - DTIM period
561 * beacon_int - Beacon interval
566 * basic_rates: -1 terminated array of basic rates in 100 kbps
568 * This parameter can be used to set a specific basic rate set for the
569 * BSS. If %NULL, default basic rate set is used.
574 * proberesp - Probe Response template
576 * This is used by drivers that reply to Probe Requests internally in
577 * AP mode and require the full Probe Response template.
582 * proberesp_len - Length of the proberesp buffer in octets
584 size_t proberesp_len
;
587 * ssid - The SSID to use in Beacon/Probe Response frames
592 * ssid_len - Length of the SSID (1..32)
597 * hide_ssid - Whether to hide the SSID
599 enum hide_ssid hide_ssid
;
602 * pairwise_ciphers - WPA_CIPHER_* bitfield
604 unsigned int pairwise_ciphers
;
607 * group_cipher - WPA_CIPHER_*
609 unsigned int group_cipher
;
612 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
614 unsigned int key_mgmt_suites
;
617 * auth_algs - WPA_AUTH_ALG_* bitfield
619 unsigned int auth_algs
;
622 * wpa_version - WPA_PROTO_* bitfield
624 unsigned int wpa_version
;
627 * privacy - Whether privacy is used in the BSS
632 * beacon_ies - WPS/P2P IE(s) for Beacon frames
634 * This is used to add IEs like WPS IE and P2P IE by drivers that do
635 * not use the full Beacon template.
637 const struct wpabuf
*beacon_ies
;
640 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
642 * This is used to add IEs like WPS IE and P2P IE by drivers that
643 * reply to Probe Request frames internally.
645 const struct wpabuf
*proberesp_ies
;
648 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
650 * This is used to add IEs like WPS IE by drivers that reply to
651 * (Re)Association Request frames internally.
653 const struct wpabuf
*assocresp_ies
;
656 * isolate - Whether to isolate frames between associated stations
658 * If this is non-zero, the AP is requested to disable forwarding of
659 * frames between associated stations.
664 * cts_protect - Whether CTS protection is enabled
669 * preamble - Whether short preamble is enabled
674 * short_slot_time - Whether short slot time is enabled
676 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
677 * not set (e.g., when 802.11g mode is not in use)
682 * ht_opmode - HT operation mode or -1 if HT not in use
687 * interworking - Whether Interworking is enabled
692 * hessid - Homogeneous ESS identifier or %NULL if not set
697 * access_network_type - Access Network Type (0..15)
699 * This is used for filtering Probe Request frames when Interworking is
702 u8 access_network_type
;
706 * struct wpa_driver_capa - Driver capability information
708 struct wpa_driver_capa
{
709 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
710 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
711 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
712 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
713 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
714 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
715 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
716 unsigned int key_mgmt
;
718 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
719 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
720 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
721 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
724 #define WPA_DRIVER_AUTH_OPEN 0x00000001
725 #define WPA_DRIVER_AUTH_SHARED 0x00000002
726 #define WPA_DRIVER_AUTH_LEAP 0x00000004
729 /* Driver generated WPA/RSN IE */
730 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
731 /* Driver needs static WEP key setup after association command */
732 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
733 /* unused: 0x00000004 */
734 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
735 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
736 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
737 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
738 /* Driver provides separate commands for authentication and association (SME in
739 * wpa_supplicant). */
740 #define WPA_DRIVER_FLAGS_SME 0x00000020
741 /* Driver supports AP mode */
742 #define WPA_DRIVER_FLAGS_AP 0x00000040
743 /* Driver needs static WEP key setup after association has been completed */
744 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
745 /* Driver takes care of P2P management operations */
746 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
747 /* Driver supports concurrent P2P operations */
748 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
750 * Driver uses the initial interface as a dedicated management interface, i.e.,
751 * it cannot be used for P2P group operations or non-P2P purposes.
753 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
754 /* This interface is P2P capable (P2P Device, GO, or P2P Client */
755 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
756 /* Driver supports concurrent operations on multiple channels */
757 #define WPA_DRIVER_FLAGS_MULTI_CHANNEL_CONCURRENT 0x00001000
759 * Driver uses the initial interface for P2P management interface and non-P2P
760 * purposes (e.g., connect to infra AP), but this interface cannot be used for
761 * P2P group operations.
763 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
765 * Driver is known to use sane error codes, i.e., when it indicates that
766 * something (e.g., association) fails, there was indeed a failure and the
767 * operation does not end up getting completed successfully later.
769 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
770 /* Driver supports off-channel TX */
771 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
772 /* Driver indicates TX status events for EAPOL Data frames */
773 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
774 /* Driver indicates TX status events for Deauth/Disassoc frames */
775 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
776 /* Driver supports roaming (BSS selection) in firmware */
777 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
778 /* Driver supports operating as a TDLS peer */
779 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
780 /* Driver requires external TDLS setup/teardown/discovery */
781 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
782 /* Driver indicates support for Probe Response offloading in AP mode */
783 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
784 /* Driver supports U-APSD in AP mode */
785 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
789 int max_sched_scan_ssids
;
790 int sched_scan_supported
;
794 * max_remain_on_chan - Maximum remain-on-channel duration in msec
796 unsigned int max_remain_on_chan
;
799 * max_stations - Maximum number of associated stations the driver
800 * supports in AP mode
802 unsigned int max_stations
;
805 * probe_resp_offloads - Bitmap of supported protocols by the driver
806 * for Probe Response offloading.
808 /* Driver Probe Response offloading support for WPS ver. 1 */
809 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
810 /* Driver Probe Response offloading support for WPS ver. 2 */
811 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
812 /* Driver Probe Response offloading support for P2P */
813 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
814 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
815 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
816 unsigned int probe_resp_offloads
;
822 struct hostap_sta_driver_data
{
823 unsigned long rx_packets
, tx_packets
, rx_bytes
, tx_bytes
;
824 unsigned long current_tx_rate
;
825 unsigned long inactive_msec
;
827 unsigned long num_ps_buf_frames
;
828 unsigned long tx_retry_failed
;
829 unsigned long tx_retry_count
;
834 struct hostapd_sta_add_params
{
838 const u8
*supp_rates
;
839 size_t supp_rates_len
;
841 const struct ieee80211_ht_capabilities
*ht_capabilities
;
842 u32 flags
; /* bitmask of WPA_STA_* flags */
843 int set
; /* Set STA parameters instead of add */
847 struct hostapd_freq_params
{
852 int sec_channel_offset
; /* 0 = HT40 disabled, -1 = HT40 enabled,
853 * secondary channel below primary, 1 = HT40
854 * enabled, secondary channel above primary */
857 enum wpa_driver_if_type
{
859 * WPA_IF_STATION - Station mode interface
864 * WPA_IF_AP_VLAN - AP mode VLAN interface
866 * This interface shares its address and Beacon frame with the main
872 * WPA_IF_AP_BSS - AP mode BSS interface
874 * This interface has its own address and Beacon frame.
879 * WPA_IF_P2P_GO - P2P Group Owner
884 * WPA_IF_P2P_CLIENT - P2P Client
889 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
890 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
895 struct wpa_init_params
{
901 const char *test_socket
;
902 int use_pae_group_addr
;
906 u8
*own_addr
; /* buffer for writing own MAC address */
910 struct wpa_bss_params
{
911 /** Interface name (for multi-SSID/VLAN support) */
913 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
922 enum mfp_options ieee80211w
;
925 #define WPA_STA_AUTHORIZED BIT(0)
926 #define WPA_STA_WMM BIT(1)
927 #define WPA_STA_SHORT_PREAMBLE BIT(2)
928 #define WPA_STA_MFP BIT(3)
929 #define WPA_STA_TDLS_PEER BIT(4)
932 * struct p2p_params - P2P parameters for driver-based P2P management
935 const char *dev_name
;
937 #define DRV_MAX_SEC_DEV_TYPES 5
938 u8 sec_dev_type
[DRV_MAX_SEC_DEV_TYPES
][8];
939 size_t num_sec_dev_types
;
953 * struct wpa_signal_info - Information about channel signal quality
955 struct wpa_signal_info
{
964 * struct wpa_driver_ops - Driver interface API definition
966 * This structure defines the API that each driver interface needs to implement
967 * for core wpa_supplicant code. All driver specific functionality is captured
970 struct wpa_driver_ops
{
971 /** Name of the driver interface */
973 /** One line description of the driver interface */
977 * get_bssid - Get the current BSSID
978 * @priv: private driver interface data
979 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
981 * Returns: 0 on success, -1 on failure
983 * Query kernel driver for the current BSSID and copy it to bssid.
984 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
987 int (*get_bssid
)(void *priv
, u8
*bssid
);
990 * get_ssid - Get the current SSID
991 * @priv: private driver interface data
992 * @ssid: buffer for SSID (at least 32 bytes)
994 * Returns: Length of the SSID on success, -1 on failure
996 * Query kernel driver for the current SSID and copy it to ssid.
997 * Returning zero is recommended if the STA is not associated.
999 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1000 * can, at least in theory, contain control characters (including nul)
1001 * and as such, should be processed as binary data, not a printable
1004 int (*get_ssid
)(void *priv
, u8
*ssid
);
1007 * set_key - Configure encryption key
1008 * @ifname: Interface name (for multi-SSID/VLAN support)
1009 * @priv: private driver interface data
1010 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1011 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
1012 * %WPA_ALG_NONE clears the key.
1013 * @addr: Address of the peer STA (BSSID of the current AP when setting
1014 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1015 * broadcast keys, %NULL for default keys that are used both for
1016 * broadcast and unicast; when clearing keys, %NULL is used to
1017 * indicate that both the broadcast-only and default key of the
1018 * specified key index is to be cleared
1019 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1021 * @set_tx: configure this key as the default Tx key (only used when
1022 * driver does not support separate unicast/individual key
1023 * @seq: sequence number/packet number, seq_len octets, the next
1024 * packet number to be used for in replay protection; configured
1025 * for Rx keys (in most cases, this is only used with broadcast
1026 * keys and set to zero for unicast keys); %NULL if not set
1027 * @seq_len: length of the seq, depends on the algorithm:
1028 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
1029 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1031 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1032 * TKIP: 32, CCMP: 16, IGTK: 16)
1034 * Returns: 0 on success, -1 on failure
1036 * Configure the given key for the kernel driver. If the driver
1037 * supports separate individual keys (4 default keys + 1 individual),
1038 * addr can be used to determine whether the key is default or
1039 * individual. If only 4 keys are supported, the default key with key
1040 * index 0 is used as the individual key. STA must be configured to use
1041 * it as the default Tx key (set_tx is set) and accept Rx for all the
1042 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1043 * broadcast keys, so key index 0 is available for this kind of
1046 * Please note that TKIP keys include separate TX and RX MIC keys and
1047 * some drivers may expect them in different order than wpa_supplicant
1048 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1049 * will trigger Michael MIC errors. This can be fixed by changing the
1050 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1051 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1052 * example on how this can be done.
1054 int (*set_key
)(const char *ifname
, void *priv
, enum wpa_alg alg
,
1055 const u8
*addr
, int key_idx
, int set_tx
,
1056 const u8
*seq
, size_t seq_len
,
1057 const u8
*key
, size_t key_len
);
1060 * init - Initialize driver interface
1061 * @ctx: context to be used when calling wpa_supplicant functions,
1062 * e.g., wpa_supplicant_event()
1063 * @ifname: interface name, e.g., wlan0
1065 * Returns: Pointer to private data, %NULL on failure
1067 * Initialize driver interface, including event processing for kernel
1068 * driver events (e.g., associated, scan results, Michael MIC failure).
1069 * This function can allocate a private configuration data area for
1070 * @ctx, file descriptor, interface name, etc. information that may be
1071 * needed in future driver operations. If this is not used, non-NULL
1072 * value will need to be returned because %NULL is used to indicate
1073 * failure. The returned value will be used as 'void *priv' data for
1074 * all other driver_ops functions.
1076 * The main event loop (eloop.c) of wpa_supplicant can be used to
1077 * register callback for read sockets (eloop_register_read_sock()).
1079 * See below for more information about events and
1080 * wpa_supplicant_event() function.
1082 void * (*init
)(void *ctx
, const char *ifname
);
1085 * deinit - Deinitialize driver interface
1086 * @priv: private driver interface data from init()
1088 * Shut down driver interface and processing of driver events. Free
1089 * private data buffer if one was allocated in init() handler.
1091 void (*deinit
)(void *priv
);
1094 * set_param - Set driver configuration parameters
1095 * @priv: private driver interface data from init()
1096 * @param: driver specific configuration parameters
1098 * Returns: 0 on success, -1 on failure
1100 * Optional handler for notifying driver interface about configuration
1101 * parameters (driver_param).
1103 int (*set_param
)(void *priv
, const char *param
);
1106 * set_countermeasures - Enable/disable TKIP countermeasures
1107 * @priv: private driver interface data
1108 * @enabled: 1 = countermeasures enabled, 0 = disabled
1110 * Returns: 0 on success, -1 on failure
1112 * Configure TKIP countermeasures. When these are enabled, the driver
1113 * should drop all received and queued frames that are using TKIP.
1115 int (*set_countermeasures
)(void *priv
, int enabled
);
1118 * deauthenticate - Request driver to deauthenticate
1119 * @priv: private driver interface data
1120 * @addr: peer address (BSSID of the AP)
1121 * @reason_code: 16-bit reason code to be sent in the deauthentication
1124 * Returns: 0 on success, -1 on failure
1126 int (*deauthenticate
)(void *priv
, const u8
*addr
, int reason_code
);
1129 * disassociate - Request driver to disassociate
1130 * @priv: private driver interface data
1131 * @addr: peer address (BSSID of the AP)
1132 * @reason_code: 16-bit reason code to be sent in the disassociation
1135 * Returns: 0 on success, -1 on failure
1137 int (*disassociate
)(void *priv
, const u8
*addr
, int reason_code
);
1140 * associate - Request driver to associate
1141 * @priv: private driver interface data
1142 * @params: association parameters
1144 * Returns: 0 on success, -1 on failure
1146 int (*associate
)(void *priv
,
1147 struct wpa_driver_associate_params
*params
);
1150 * add_pmkid - Add PMKSA cache entry to the driver
1151 * @priv: private driver interface data
1152 * @bssid: BSSID for the PMKSA cache entry
1153 * @pmkid: PMKID for the PMKSA cache entry
1155 * Returns: 0 on success, -1 on failure
1157 * This function is called when a new PMK is received, as a result of
1158 * either normal authentication or RSN pre-authentication.
1160 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1161 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1162 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1163 * driver_ops function does not need to be implemented. Likewise, if
1164 * the driver does not support WPA, this function is not needed.
1166 int (*add_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
1169 * remove_pmkid - Remove PMKSA cache entry to the driver
1170 * @priv: private driver interface data
1171 * @bssid: BSSID for the PMKSA cache entry
1172 * @pmkid: PMKID for the PMKSA cache entry
1174 * Returns: 0 on success, -1 on failure
1176 * This function is called when the supplicant drops a PMKSA cache
1177 * entry for any reason.
1179 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1180 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1181 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1182 * from wpa_supplicant, this driver_ops function does not need to be
1183 * implemented. Likewise, if the driver does not support WPA, this
1184 * function is not needed.
1186 int (*remove_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
1189 * flush_pmkid - Flush PMKSA cache
1190 * @priv: private driver interface data
1192 * Returns: 0 on success, -1 on failure
1194 * This function is called when the supplicant drops all PMKSA cache
1195 * entries for any reason.
1197 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1198 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1199 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1200 * from wpa_supplicant, this driver_ops function does not need to be
1201 * implemented. Likewise, if the driver does not support WPA, this
1202 * function is not needed.
1204 int (*flush_pmkid
)(void *priv
);
1207 * get_capa - Get driver capabilities
1208 * @priv: private driver interface data
1210 * Returns: 0 on success, -1 on failure
1212 * Get driver/firmware/hardware capabilities.
1214 int (*get_capa
)(void *priv
, struct wpa_driver_capa
*capa
);
1217 * poll - Poll driver for association information
1218 * @priv: private driver interface data
1220 * This is an option callback that can be used when the driver does not
1221 * provide event mechanism for association events. This is called when
1222 * receiving WPA EAPOL-Key messages that require association
1223 * information. The driver interface is supposed to generate associnfo
1224 * event before returning from this callback function. In addition, the
1225 * driver interface should generate an association event after having
1226 * sent out associnfo.
1228 void (*poll
)(void *priv
);
1231 * get_ifname - Get interface name
1232 * @priv: private driver interface data
1234 * Returns: Pointer to the interface name. This can differ from the
1235 * interface name used in init() call. Init() is called first.
1237 * This optional function can be used to allow the driver interface to
1238 * replace the interface name with something else, e.g., based on an
1239 * interface mapping from a more descriptive name.
1241 const char * (*get_ifname
)(void *priv
);
1244 * get_mac_addr - Get own MAC address
1245 * @priv: private driver interface data
1247 * Returns: Pointer to own MAC address or %NULL on failure
1249 * This optional function can be used to get the own MAC address of the
1250 * device from the driver interface code. This is only needed if the
1251 * l2_packet implementation for the OS does not provide easy access to
1253 const u8
* (*get_mac_addr
)(void *priv
);
1256 * send_eapol - Optional function for sending EAPOL packets
1257 * @priv: private driver interface data
1258 * @dest: Destination MAC address
1260 * @data: EAPOL packet starting with IEEE 802.1X header
1261 * @data_len: Size of the EAPOL packet
1263 * Returns: 0 on success, -1 on failure
1265 * This optional function can be used to override l2_packet operations
1266 * with driver specific functionality. If this function pointer is set,
1267 * l2_packet module is not used at all and the driver interface code is
1268 * responsible for receiving and sending all EAPOL packets. The
1269 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1270 * event. The driver interface is required to implement get_mac_addr()
1271 * handler if send_eapol() is used.
1273 int (*send_eapol
)(void *priv
, const u8
*dest
, u16 proto
,
1274 const u8
*data
, size_t data_len
);
1277 * set_operstate - Sets device operating state to DORMANT or UP
1278 * @priv: private driver interface data
1279 * @state: 0 = dormant, 1 = up
1280 * Returns: 0 on success, -1 on failure
1282 * This is an optional function that can be used on operating systems
1283 * that support a concept of controlling network device state from user
1284 * space applications. This function, if set, gets called with
1285 * state = 1 when authentication has been completed and with state = 0
1286 * when connection is lost.
1288 int (*set_operstate
)(void *priv
, int state
);
1291 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1292 * @priv: Private driver interface data
1293 * @addr: Address of the station for which to set protection (may be
1294 * %NULL for group keys)
1295 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1296 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1297 * Returns: 0 on success, -1 on failure
1299 * This is an optional function that can be used to set the driver to
1300 * require protection for Tx and/or Rx frames. This uses the layer
1301 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1302 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1303 * set protection operation; instead, they set protection implicitly
1304 * based on configured keys.
1306 int (*mlme_setprotection
)(void *priv
, const u8
*addr
, int protect_type
,
1310 * get_hw_feature_data - Get hardware support data (channels and rates)
1311 * @priv: Private driver interface data
1312 * @num_modes: Variable for returning the number of returned modes
1313 * flags: Variable for returning hardware feature flags
1314 * Returns: Pointer to allocated hardware data on success or %NULL on
1315 * failure. Caller is responsible for freeing this.
1317 struct hostapd_hw_modes
* (*get_hw_feature_data
)(void *priv
,
1322 * send_mlme - Send management frame from MLME
1323 * @priv: Private driver interface data
1324 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1325 * @data_len: Size of the management frame
1326 * @noack: Do not wait for this frame to be acked (disable retries)
1327 * Returns: 0 on success, -1 on failure
1329 int (*send_mlme
)(void *priv
, const u8
*data
, size_t data_len
,
1333 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1334 * @priv: Private driver interface data
1335 * @md: Mobility domain (2 octets) (also included inside ies)
1336 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1337 * @ies_len: Length of FT IEs in bytes
1338 * Returns: 0 on success, -1 on failure
1340 * The supplicant uses this callback to let the driver know that keying
1341 * material for FT is available and that the driver can use the
1342 * provided IEs in the next message in FT authentication sequence.
1344 * This function is only needed for driver that support IEEE 802.11r
1345 * (Fast BSS Transition).
1347 int (*update_ft_ies
)(void *priv
, const u8
*md
, const u8
*ies
,
1351 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1352 * @priv: Private driver interface data
1353 * @action: Action field value
1354 * @target_ap: Target AP address
1355 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1356 * @ies_len: Length of FT IEs in bytes
1357 * Returns: 0 on success, -1 on failure
1359 * The supplicant uses this callback to request the driver to transmit
1360 * an FT Action frame (action category 6) for over-the-DS fast BSS
1363 int (*send_ft_action
)(void *priv
, u8 action
, const u8
*target_ap
,
1364 const u8
*ies
, size_t ies_len
);
1367 * get_scan_results2 - Fetch the latest scan results
1368 * @priv: private driver interface data
1370 * Returns: Allocated buffer of scan results (caller is responsible for
1371 * freeing the data structure) on success, NULL on failure
1373 struct wpa_scan_results
* (*get_scan_results2
)(void *priv
);
1376 * set_country - Set country
1377 * @priv: Private driver interface data
1378 * @alpha2: country to which to switch to
1379 * Returns: 0 on success, -1 on failure
1381 * This function is for drivers which support some form
1382 * of setting a regulatory domain.
1384 int (*set_country
)(void *priv
, const char *alpha2
);
1387 * global_init - Global driver initialization
1388 * Returns: Pointer to private data (global), %NULL on failure
1390 * This optional function is called to initialize the driver wrapper
1391 * for global data, i.e., data that applies to all interfaces. If this
1392 * function is implemented, global_deinit() will also need to be
1393 * implemented to free the private data. The driver will also likely
1394 * use init2() function instead of init() to get the pointer to global
1395 * data available to per-interface initializer.
1397 void * (*global_init
)(void);
1400 * global_deinit - Global driver deinitialization
1401 * @priv: private driver global data from global_init()
1403 * Terminate any global driver related functionality and free the
1404 * global data structure.
1406 void (*global_deinit
)(void *priv
);
1409 * init2 - Initialize driver interface (with global data)
1410 * @ctx: context to be used when calling wpa_supplicant functions,
1411 * e.g., wpa_supplicant_event()
1412 * @ifname: interface name, e.g., wlan0
1413 * @global_priv: private driver global data from global_init()
1414 * Returns: Pointer to private data, %NULL on failure
1416 * This function can be used instead of init() if the driver wrapper
1419 void * (*init2
)(void *ctx
, const char *ifname
, void *global_priv
);
1422 * get_interfaces - Get information about available interfaces
1423 * @global_priv: private driver global data from global_init()
1424 * Returns: Allocated buffer of interface information (caller is
1425 * responsible for freeing the data structure) on success, NULL on
1428 struct wpa_interface_info
* (*get_interfaces
)(void *global_priv
);
1431 * scan2 - Request the driver to initiate scan
1432 * @priv: private driver interface data
1433 * @params: Scan parameters
1435 * Returns: 0 on success, -1 on failure
1437 * Once the scan results are ready, the driver should report scan
1438 * results event for wpa_supplicant which will eventually request the
1439 * results with wpa_driver_get_scan_results2().
1441 int (*scan2
)(void *priv
, struct wpa_driver_scan_params
*params
);
1444 * authenticate - Request driver to authenticate
1445 * @priv: private driver interface data
1446 * @params: authentication parameters
1447 * Returns: 0 on success, -1 on failure
1449 * This is an optional function that can be used with drivers that
1450 * support separate authentication and association steps, i.e., when
1451 * wpa_supplicant can act as the SME. If not implemented, associate()
1452 * function is expected to take care of IEEE 802.11 authentication,
1455 int (*authenticate
)(void *priv
,
1456 struct wpa_driver_auth_params
*params
);
1459 * set_ap - Set Beacon and Probe Response information for AP mode
1460 * @priv: Private driver interface data
1461 * @params: Parameters to use in AP mode
1463 * This function is used to configure Beacon template and/or extra IEs
1464 * to add for Beacon and Probe Response frames for the driver in
1465 * AP mode. The driver is responsible for building the full Beacon
1466 * frame by concatenating the head part with TIM IE generated by the
1467 * driver/firmware and finishing with the tail part. Depending on the
1468 * driver architectue, this can be done either by using the full
1469 * template or the set of additional IEs (e.g., WPS and P2P IE).
1470 * Similarly, Probe Response processing depends on the driver design.
1471 * If the driver (or firmware) takes care of replying to Probe Request
1472 * frames, the extra IEs provided here needs to be added to the Probe
1475 * Returns: 0 on success, -1 on failure
1477 int (*set_ap
)(void *priv
, struct wpa_driver_ap_params
*params
);
1480 * hapd_init - Initialize driver interface (hostapd only)
1481 * @hapd: Pointer to hostapd context
1482 * @params: Configuration for the driver wrapper
1483 * Returns: Pointer to private data, %NULL on failure
1485 * This function is used instead of init() or init2() when the driver
1486 * wrapper is used with hostapd.
1488 void * (*hapd_init
)(struct hostapd_data
*hapd
,
1489 struct wpa_init_params
*params
);
1492 * hapd_deinit - Deinitialize driver interface (hostapd only)
1493 * @priv: Private driver interface data from hapd_init()
1495 void (*hapd_deinit
)(void *priv
);
1498 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1499 * @priv: Private driver interface data
1500 * @params: BSS parameters
1501 * Returns: 0 on success, -1 on failure
1503 * This is an optional function to configure the kernel driver to
1504 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1505 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1506 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1507 * for Beacon frames.
1509 * DEPRECATED - use set_ap() instead
1511 int (*set_ieee8021x
)(void *priv
, struct wpa_bss_params
*params
);
1514 * set_privacy - Enable/disable privacy (AP only)
1515 * @priv: Private driver interface data
1516 * @enabled: 1 = privacy enabled, 0 = disabled
1517 * Returns: 0 on success, -1 on failure
1519 * This is an optional function to configure privacy field in the
1520 * kernel driver for Beacon frames. This can be left undefined (set to
1521 * %NULL) if the driver uses the Beacon template from set_ap().
1523 * DEPRECATED - use set_ap() instead
1525 int (*set_privacy
)(void *priv
, int enabled
);
1528 * get_seqnum - Fetch the current TSC/packet number (AP only)
1529 * @ifname: The interface name (main or virtual)
1530 * @priv: Private driver interface data
1531 * @addr: MAC address of the station or %NULL for group keys
1533 * @seq: Buffer for returning the latest used TSC/packet number
1534 * Returns: 0 on success, -1 on failure
1536 * This function is used to fetch the last used TSC/packet number for
1537 * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so
1538 * there is no strict requirement on implementing support for unicast
1539 * keys (i.e., addr != %NULL).
1541 int (*get_seqnum
)(const char *ifname
, void *priv
, const u8
*addr
,
1545 * flush - Flush all association stations (AP only)
1546 * @priv: Private driver interface data
1547 * Returns: 0 on success, -1 on failure
1549 * This function requests the driver to disassociate all associated
1550 * stations. This function does not need to be implemented if the
1551 * driver does not process association frames internally.
1553 int (*flush
)(void *priv
);
1556 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1557 * @priv: Private driver interface data
1558 * @elem: Information elements
1559 * @elem_len: Length of the elem buffer in octets
1560 * Returns: 0 on success, -1 on failure
1562 * This is an optional function to add information elements in the
1563 * kernel driver for Beacon and Probe Response frames. This can be left
1564 * undefined (set to %NULL) if the driver uses the Beacon template from
1567 * DEPRECATED - use set_ap() instead
1569 int (*set_generic_elem
)(void *priv
, const u8
*elem
, size_t elem_len
);
1572 * read_sta_data - Fetch station data (AP only)
1573 * @priv: Private driver interface data
1574 * @data: Buffer for returning station information
1575 * @addr: MAC address of the station
1576 * Returns: 0 on success, -1 on failure
1578 int (*read_sta_data
)(void *priv
, struct hostap_sta_driver_data
*data
,
1582 * hapd_send_eapol - Send an EAPOL packet (AP only)
1583 * @priv: private driver interface data
1584 * @addr: Destination MAC address
1585 * @data: EAPOL packet starting with IEEE 802.1X header
1586 * @data_len: Length of the EAPOL packet in octets
1587 * @encrypt: Whether the frame should be encrypted
1588 * @own_addr: Source MAC address
1589 * @flags: WPA_STA_* flags for the destination station
1591 * Returns: 0 on success, -1 on failure
1593 int (*hapd_send_eapol
)(void *priv
, const u8
*addr
, const u8
*data
,
1594 size_t data_len
, int encrypt
,
1595 const u8
*own_addr
, u32 flags
);
1598 * sta_deauth - Deauthenticate a station (AP only)
1599 * @priv: Private driver interface data
1600 * @own_addr: Source address and BSSID for the Deauthentication frame
1601 * @addr: MAC address of the station to deauthenticate
1602 * @reason: Reason code for the Deauthentiation frame
1603 * Returns: 0 on success, -1 on failure
1605 * This function requests a specific station to be deauthenticated and
1606 * a Deauthentication frame to be sent to it.
1608 int (*sta_deauth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
1612 * sta_disassoc - Disassociate a station (AP only)
1613 * @priv: Private driver interface data
1614 * @own_addr: Source address and BSSID for the Disassociation frame
1615 * @addr: MAC address of the station to disassociate
1616 * @reason: Reason code for the Disassociation frame
1617 * Returns: 0 on success, -1 on failure
1619 * This function requests a specific station to be disassociated and
1620 * a Disassociation frame to be sent to it.
1622 int (*sta_disassoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
1626 * sta_remove - Remove a station entry (AP only)
1627 * @priv: Private driver interface data
1628 * @addr: MAC address of the station to be removed
1629 * Returns: 0 on success, -1 on failure
1631 int (*sta_remove
)(void *priv
, const u8
*addr
);
1634 * hapd_get_ssid - Get the current SSID (AP only)
1635 * @priv: Private driver interface data
1636 * @buf: Buffer for returning the SSID
1637 * @len: Maximum length of the buffer
1638 * Returns: Length of the SSID on success, -1 on failure
1640 * This function need not be implemented if the driver uses Beacon
1641 * template from set_ap() and does not reply to Probe Request frames.
1643 int (*hapd_get_ssid
)(void *priv
, u8
*buf
, int len
);
1646 * hapd_set_ssid - Set SSID (AP only)
1647 * @priv: Private driver interface data
1649 * @len: Length of the SSID in octets
1650 * Returns: 0 on success, -1 on failure
1652 * DEPRECATED - use set_ap() instead
1654 int (*hapd_set_ssid
)(void *priv
, const u8
*buf
, int len
);
1657 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1658 * @priv: Private driver interface data
1659 * @enabled: 1 = countermeasures enabled, 0 = disabled
1660 * Returns: 0 on success, -1 on failure
1662 * This need not be implemented if the driver does not take care of
1663 * association processing.
1665 int (*hapd_set_countermeasures
)(void *priv
, int enabled
);
1668 * sta_add - Add a station entry
1669 * @priv: Private driver interface data
1670 * @params: Station parameters
1671 * Returns: 0 on success, -1 on failure
1673 * This function is used to add a station entry to the driver once the
1674 * station has completed association. This is only used if the driver
1675 * does not take care of association processing.
1677 * With TDLS, this function is also used to add or set (params->set 1)
1678 * TDLS peer entries.
1680 int (*sta_add
)(void *priv
, struct hostapd_sta_add_params
*params
);
1683 * get_inact_sec - Get station inactivity duration (AP only)
1684 * @priv: Private driver interface data
1685 * @addr: Station address
1686 * Returns: Number of seconds station has been inactive, -1 on failure
1688 int (*get_inact_sec
)(void *priv
, const u8
*addr
);
1691 * sta_clear_stats - Clear station statistics (AP only)
1692 * @priv: Private driver interface data
1693 * @addr: Station address
1694 * Returns: 0 on success, -1 on failure
1696 int (*sta_clear_stats
)(void *priv
, const u8
*addr
);
1699 * set_freq - Set channel/frequency (AP only)
1700 * @priv: Private driver interface data
1701 * @freq: Channel parameters
1702 * Returns: 0 on success, -1 on failure
1704 int (*set_freq
)(void *priv
, struct hostapd_freq_params
*freq
);
1707 * set_rts - Set RTS threshold
1708 * @priv: Private driver interface data
1709 * @rts: RTS threshold in octets
1710 * Returns: 0 on success, -1 on failure
1712 int (*set_rts
)(void *priv
, int rts
);
1715 * set_frag - Set fragmentation threshold
1716 * @priv: Private driver interface data
1717 * @frag: Fragmentation threshold in octets
1718 * Returns: 0 on success, -1 on failure
1720 int (*set_frag
)(void *priv
, int frag
);
1723 * sta_set_flags - Set station flags (AP only)
1724 * @priv: Private driver interface data
1725 * @addr: Station address
1726 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1727 * @flags_or: Bitmap of WPA_STA_* flags to add
1728 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1729 * Returns: 0 on success, -1 on failure
1731 int (*sta_set_flags
)(void *priv
, const u8
*addr
,
1732 int total_flags
, int flags_or
, int flags_and
);
1735 * set_tx_queue_params - Set TX queue parameters
1736 * @priv: Private driver interface data
1737 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
1741 * @burst_time: Maximum length for bursting in 0.1 msec units
1743 int (*set_tx_queue_params
)(void *priv
, int queue
, int aifs
, int cw_min
,
1744 int cw_max
, int burst_time
);
1747 * if_add - Add a virtual interface
1748 * @priv: Private driver interface data
1749 * @type: Interface type
1750 * @ifname: Interface name for the new virtual interface
1751 * @addr: Local address to use for the interface or %NULL to use the
1752 * parent interface address
1753 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1754 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1755 * not allowed (applies only to %WPA_IF_AP_BSS type)
1756 * @force_ifname: Buffer for returning an interface name that the
1757 * driver ended up using if it differs from the requested ifname
1758 * @if_addr: Buffer for returning the allocated interface address
1759 * (this may differ from the requested addr if the driver cannot
1760 * change interface address)
1761 * @bridge: Bridge interface to use or %NULL if no bridge configured
1762 * Returns: 0 on success, -1 on failure
1764 int (*if_add
)(void *priv
, enum wpa_driver_if_type type
,
1765 const char *ifname
, const u8
*addr
, void *bss_ctx
,
1766 void **drv_priv
, char *force_ifname
, u8
*if_addr
,
1767 const char *bridge
);
1770 * if_remove - Remove a virtual interface
1771 * @priv: Private driver interface data
1772 * @type: Interface type
1773 * @ifname: Interface name of the virtual interface to be removed
1774 * Returns: 0 on success, -1 on failure
1776 int (*if_remove
)(void *priv
, enum wpa_driver_if_type type
,
1777 const char *ifname
);
1780 * set_sta_vlan - Bind a station into a specific interface (AP only)
1781 * @priv: Private driver interface data
1782 * @ifname: Interface (main or virtual BSS or VLAN)
1783 * @addr: MAC address of the associated station
1785 * Returns: 0 on success, -1 on failure
1787 * This function is used to bind a station to a specific virtual
1788 * interface. It is only used if when virtual interfaces are supported,
1789 * e.g., to assign stations to different VLAN interfaces based on
1790 * information from a RADIUS server. This allows separate broadcast
1791 * domains to be used with a single BSS.
1793 int (*set_sta_vlan
)(void *priv
, const u8
*addr
, const char *ifname
,
1797 * commit - Optional commit changes handler (AP only)
1798 * @priv: driver private data
1799 * Returns: 0 on success, -1 on failure
1801 * This optional handler function can be registered if the driver
1802 * interface implementation needs to commit changes (e.g., by setting
1803 * network interface up) at the end of initial configuration. If set,
1804 * this handler will be called after initial setup has been completed.
1806 int (*commit
)(void *priv
);
1809 * send_ether - Send an ethernet packet (AP only)
1810 * @priv: private driver interface data
1811 * @dst: Destination MAC address
1812 * @src: Source MAC address
1814 * @data: EAPOL packet starting with IEEE 802.1X header
1815 * @data_len: Length of the EAPOL packet in octets
1816 * Returns: 0 on success, -1 on failure
1818 int (*send_ether
)(void *priv
, const u8
*dst
, const u8
*src
, u16 proto
,
1819 const u8
*data
, size_t data_len
);
1822 * set_radius_acl_auth - Notification of RADIUS ACL change
1823 * @priv: Private driver interface data
1824 * @mac: MAC address of the station
1825 * @accepted: Whether the station was accepted
1826 * @session_timeout: Session timeout for the station
1827 * Returns: 0 on success, -1 on failure
1829 int (*set_radius_acl_auth
)(void *priv
, const u8
*mac
, int accepted
,
1830 u32 session_timeout
);
1833 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1834 * @priv: Private driver interface data
1835 * @mac: MAC address of the station
1836 * Returns: 0 on success, -1 on failure
1838 int (*set_radius_acl_expire
)(void *priv
, const u8
*mac
);
1841 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
1842 * @priv: Private driver interface data
1843 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
1844 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
1846 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
1847 * to remove extra IE(s)
1848 * Returns: 0 on success, -1 on failure
1850 * This is an optional function to add WPS IE in the kernel driver for
1851 * Beacon and Probe Response frames. This can be left undefined (set
1852 * to %NULL) if the driver uses the Beacon template from set_ap()
1853 * and does not process Probe Request frames. If the driver takes care
1854 * of (Re)Association frame processing, the assocresp buffer includes
1855 * WPS IE(s) that need to be added to (Re)Association Response frames
1856 * whenever a (Re)Association Request frame indicated use of WPS.
1858 * This will also be used to add P2P IE(s) into Beacon/Probe Response
1859 * frames when operating as a GO. The driver is responsible for adding
1860 * timing related attributes (e.g., NoA) in addition to the IEs
1861 * included here by appending them after these buffers. This call is
1862 * also used to provide Probe Response IEs for P2P Listen state
1863 * operations for drivers that generate the Probe Response frames
1866 * DEPRECATED - use set_ap() instead
1868 int (*set_ap_wps_ie
)(void *priv
, const struct wpabuf
*beacon
,
1869 const struct wpabuf
*proberesp
,
1870 const struct wpabuf
*assocresp
);
1873 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1874 * @priv: Private driver interface data
1875 * @authorized: Whether the port is authorized
1876 * Returns: 0 on success, -1 on failure
1878 int (*set_supp_port
)(void *priv
, int authorized
);
1881 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1882 * @priv: Private driver interface data
1883 * @addr: MAC address of the associated station
1884 * @aid: Association ID
1885 * @val: 1 = bind to 4-address WDS; 0 = unbind
1886 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
1887 * to indicate that bridge is not to be used
1888 * Returns: 0 on success, -1 on failure
1890 int (*set_wds_sta
)(void *priv
, const u8
*addr
, int aid
, int val
,
1891 const char *bridge_ifname
);
1894 * send_action - Transmit an Action frame
1895 * @priv: Private driver interface data
1896 * @freq: Frequency (in MHz) of the channel
1897 * @wait: Time to wait off-channel for a response (in ms), or zero
1898 * @dst: Destination MAC address (Address 1)
1899 * @src: Source MAC address (Address 2)
1900 * @bssid: BSSID (Address 3)
1902 * @data_len: data length in octets
1903 @ @no_cck: Whether CCK rates must not be used to transmit this frame
1904 * Returns: 0 on success, -1 on failure
1906 * This command can be used to request the driver to transmit an action
1907 * frame to the specified destination.
1909 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
1910 * be transmitted on the given channel and the device will wait for a
1911 * response on that channel for the given wait time.
1913 * If the flag is not set, the wait time will be ignored. In this case,
1914 * if a remain-on-channel duration is in progress, the frame must be
1915 * transmitted on that channel; alternatively the frame may be sent on
1916 * the current operational channel (if in associated state in station
1917 * mode or while operating as an AP.)
1919 int (*send_action
)(void *priv
, unsigned int freq
, unsigned int wait
,
1920 const u8
*dst
, const u8
*src
, const u8
*bssid
,
1921 const u8
*data
, size_t data_len
, int no_cck
);
1924 * send_action_cancel_wait - Cancel action frame TX wait
1925 * @priv: Private driver interface data
1927 * This command cancels the wait time associated with sending an action
1928 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
1929 * set in the driver flags.
1931 void (*send_action_cancel_wait
)(void *priv
);
1934 * remain_on_channel - Remain awake on a channel
1935 * @priv: Private driver interface data
1936 * @freq: Frequency (in MHz) of the channel
1937 * @duration: Duration in milliseconds
1938 * Returns: 0 on success, -1 on failure
1940 * This command is used to request the driver to remain awake on the
1941 * specified channel for the specified duration and report received
1942 * Action frames with EVENT_RX_ACTION events. Optionally, received
1943 * Probe Request frames may also be requested to be reported by calling
1944 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
1946 * The driver may not be at the requested channel when this function
1947 * returns, i.e., the return code is only indicating whether the
1948 * request was accepted. The caller will need to wait until the
1949 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
1950 * completed the channel change. This may take some time due to other
1951 * need for the radio and the caller should be prepared to timing out
1952 * its wait since there are no guarantees on when this request can be
1955 int (*remain_on_channel
)(void *priv
, unsigned int freq
,
1956 unsigned int duration
);
1959 * cancel_remain_on_channel - Cancel remain-on-channel operation
1960 * @priv: Private driver interface data
1962 * This command can be used to cancel a remain-on-channel operation
1963 * before its originally requested duration has passed. This could be
1964 * used, e.g., when remain_on_channel() is used to request extra time
1965 * to receive a response to an Action frame and the response is
1966 * received when there is still unneeded time remaining on the
1967 * remain-on-channel operation.
1969 int (*cancel_remain_on_channel
)(void *priv
);
1972 * probe_req_report - Request Probe Request frames to be indicated
1973 * @priv: Private driver interface data
1974 * @report: Whether to report received Probe Request frames
1975 * Returns: 0 on success, -1 on failure (or if not supported)
1977 * This command can be used to request the driver to indicate when
1978 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
1979 * Since this operation may require extra resources, e.g., due to less
1980 * optimal hardware/firmware RX filtering, many drivers may disable
1981 * Probe Request reporting at least in station mode. This command is
1982 * used to notify the driver when the Probe Request frames need to be
1983 * reported, e.g., during remain-on-channel operations.
1985 int (*probe_req_report
)(void *priv
, int report
);
1988 * deinit_ap - Deinitialize AP mode
1989 * @priv: Private driver interface data
1990 * Returns: 0 on success, -1 on failure (or if not supported)
1992 * This optional function can be used to disable AP mode related
1993 * configuration and change the driver mode to station mode to allow
1994 * normal station operations like scanning to be completed.
1996 int (*deinit_ap
)(void *priv
);
1999 * suspend - Notification on system suspend/hibernate event
2000 * @priv: Private driver interface data
2002 void (*suspend
)(void *priv
);
2005 * resume - Notification on system resume/thaw event
2006 * @priv: Private driver interface data
2008 void (*resume
)(void *priv
);
2011 * signal_monitor - Set signal monitoring parameters
2012 * @priv: Private driver interface data
2013 * @threshold: Threshold value for signal change events; 0 = disabled
2014 * @hysteresis: Minimum change in signal strength before indicating a
2016 * Returns: 0 on success, -1 on failure (or if not supported)
2018 * This function can be used to configure monitoring of signal strength
2019 * with the current AP. Whenever signal strength drops below the
2020 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2021 * should be generated assuming the signal strength has changed at
2022 * least %hysteresis from the previously indicated signal change event.
2024 int (*signal_monitor
)(void *priv
, int threshold
, int hysteresis
);
2027 * send_frame - Send IEEE 802.11 frame (testing use only)
2028 * @priv: Private driver interface data
2029 * @data: IEEE 802.11 frame with IEEE 802.11 header
2030 * @data_len: Size of the frame
2031 * @encrypt: Whether to encrypt the frame (if keys are set)
2032 * Returns: 0 on success, -1 on failure
2034 * This function is only used for debugging purposes and is not
2035 * required to be implemented for normal operations.
2037 int (*send_frame
)(void *priv
, const u8
*data
, size_t data_len
,
2041 * shared_freq - Get operating frequency of shared interface(s)
2042 * @priv: Private driver interface data
2043 * Returns: Operating frequency in MHz, 0 if no shared operation in
2044 * use, or -1 on failure
2046 * This command can be used to request the current operating frequency
2047 * of any virtual interface that shares the same radio to provide
2048 * information for channel selection for other virtual interfaces.
2050 int (*shared_freq
)(void *priv
);
2053 * get_noa - Get current Notice of Absence attribute payload
2054 * @priv: Private driver interface data
2055 * @buf: Buffer for returning NoA
2056 * @buf_len: Buffer length in octets
2057 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2058 * advertized, or -1 on failure
2060 * This function is used to fetch the current Notice of Absence
2061 * attribute value from GO.
2063 int (*get_noa
)(void *priv
, u8
*buf
, size_t buf_len
);
2066 * set_noa - Set Notice of Absence parameters for GO (testing)
2067 * @priv: Private driver interface data
2069 * @start: Start time in ms from next TBTT
2070 * @duration: Duration in ms
2071 * Returns: 0 on success or -1 on failure
2073 * This function is used to set Notice of Absence parameters for GO. It
2074 * is used only for testing. To disable NoA, all parameters are set to
2077 int (*set_noa
)(void *priv
, u8 count
, int start
, int duration
);
2080 * set_p2p_powersave - Set P2P power save options
2081 * @priv: Private driver interface data
2082 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2083 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2084 * @ctwindow: 0.. = change (msec), -1 = no change
2085 * Returns: 0 on success or -1 on failure
2087 int (*set_p2p_powersave
)(void *priv
, int legacy_ps
, int opp_ps
,
2091 * ampdu - Enable/disable aggregation
2092 * @priv: Private driver interface data
2093 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2094 * Returns: 0 on success or -1 on failure
2096 int (*ampdu
)(void *priv
, int ampdu
);
2099 * get_radio_name - Get physical radio name for the device
2100 * @priv: Private driver interface data
2101 * Returns: Radio name or %NULL if not known
2103 * The returned data must not be modified by the caller. It is assumed
2104 * that any interface that has the same radio name as another is
2105 * sharing the same physical radio. This information can be used to
2106 * share scan results etc. information between the virtual interfaces
2107 * to speed up various operations.
2109 const char * (*get_radio_name
)(void *priv
);
2112 * p2p_find - Start P2P Device Discovery
2113 * @priv: Private driver interface data
2114 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2115 * @type: Device Discovery type (enum p2p_discovery_type)
2116 * Returns: 0 on success, -1 on failure
2118 * This function is only used if the driver implements P2P management,
2119 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2120 * struct wpa_driver_capa.
2122 int (*p2p_find
)(void *priv
, unsigned int timeout
, int type
);
2125 * p2p_stop_find - Stop P2P Device Discovery
2126 * @priv: Private driver interface data
2127 * Returns: 0 on success, -1 on failure
2129 * This function is only used if the driver implements P2P management,
2130 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2131 * struct wpa_driver_capa.
2133 int (*p2p_stop_find
)(void *priv
);
2136 * p2p_listen - Start P2P Listen state for specified duration
2137 * @priv: Private driver interface data
2138 * @timeout: Listen state duration in milliseconds
2139 * Returns: 0 on success, -1 on failure
2141 * This function can be used to request the P2P module to keep the
2142 * device discoverable on the listen channel for an extended set of
2143 * time. At least in its current form, this is mainly used for testing
2144 * purposes and may not be of much use for normal P2P operations.
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_listen
)(void *priv
, unsigned int timeout
);
2153 * p2p_connect - Start P2P group formation (GO negotiation)
2154 * @priv: Private driver interface data
2155 * @peer_addr: MAC address of the peer P2P client
2156 * @wps_method: enum p2p_wps_method value indicating config method
2157 * @go_intent: Local GO intent value (1..15)
2158 * @own_interface_addr: Intended interface address to use with the
2160 * @force_freq: The only allowed channel frequency in MHz or 0
2161 * @persistent_group: Whether to create persistent group
2162 * Returns: 0 on success, -1 on failure
2164 * This function is only used if the driver implements P2P management,
2165 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2166 * struct wpa_driver_capa.
2168 int (*p2p_connect
)(void *priv
, const u8
*peer_addr
, int wps_method
,
2169 int go_intent
, const u8
*own_interface_addr
,
2170 unsigned int force_freq
, int persistent_group
);
2173 * wps_success_cb - Report successfully completed WPS provisioning
2174 * @priv: Private driver interface data
2175 * @peer_addr: Peer address
2176 * Returns: 0 on success, -1 on failure
2178 * This function is used to report successfully completed WPS
2179 * provisioning during group formation in both GO/Registrar and
2180 * client/Enrollee roles.
2182 * This function is only used if the driver implements P2P management,
2183 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2184 * struct wpa_driver_capa.
2186 int (*wps_success_cb
)(void *priv
, const u8
*peer_addr
);
2189 * p2p_group_formation_failed - Report failed WPS provisioning
2190 * @priv: Private driver interface data
2191 * Returns: 0 on success, -1 on failure
2193 * This function is used to report failed group formation. This can
2194 * happen either due to failed WPS provisioning or due to 15 second
2195 * timeout during the provisioning phase.
2197 * This function is only used if the driver implements P2P management,
2198 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2199 * struct wpa_driver_capa.
2201 int (*p2p_group_formation_failed
)(void *priv
);
2204 * p2p_set_params - Set P2P parameters
2205 * @priv: Private driver interface data
2206 * @params: P2P parameters
2207 * Returns: 0 on success, -1 on failure
2209 * This function is only used if the driver implements P2P management,
2210 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2211 * struct wpa_driver_capa.
2213 int (*p2p_set_params
)(void *priv
, const struct p2p_params
*params
);
2216 * p2p_prov_disc_req - Send Provision Discovery Request
2217 * @priv: Private driver interface data
2218 * @peer_addr: MAC address of the peer P2P client
2219 * @config_methods: WPS Config Methods value (only one bit set)
2220 * Returns: 0 on success, -1 on failure
2222 * This function can be used to request a discovered P2P peer to
2223 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2224 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2225 * Provision Discovery Request frame is transmitted once immediately
2226 * and if no response is received, the frame will be sent again
2227 * whenever the target device is discovered during device dsicovery
2228 * (start with a p2p_find() call). Response from the peer is indicated
2229 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
2231 * This function is only used if the driver implements P2P management,
2232 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2233 * struct wpa_driver_capa.
2235 int (*p2p_prov_disc_req
)(void *priv
, const u8
*peer_addr
,
2236 u16 config_methods
, int join
);
2239 * p2p_sd_request - Schedule a service discovery query
2240 * @priv: Private driver interface data
2241 * @dst: Destination peer or %NULL to apply for all peers
2242 * @tlvs: P2P Service Query TLV(s)
2243 * Returns: Reference to the query or 0 on failure
2245 * Response to the query is indicated with the
2246 * EVENT_P2P_SD_RESPONSE driver event.
2248 * This function is only used if the driver implements P2P management,
2249 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2250 * struct wpa_driver_capa.
2252 u64 (*p2p_sd_request
)(void *priv
, const u8
*dst
,
2253 const struct wpabuf
*tlvs
);
2256 * p2p_sd_cancel_request - Cancel a pending service discovery query
2257 * @priv: Private driver interface data
2258 * @req: Query reference from p2p_sd_request()
2259 * Returns: 0 on success, -1 on failure
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_cancel_request
)(void *priv
, u64 req
);
2268 * p2p_sd_response - Send response to a service discovery query
2269 * @priv: Private driver interface data
2270 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2271 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2272 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2273 * @resp_tlvs: P2P Service Response TLV(s)
2274 * Returns: 0 on success, -1 on failure
2276 * This function is called as a response to the request indicated with
2277 * the EVENT_P2P_SD_REQUEST driver event.
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_sd_response
)(void *priv
, int freq
, const u8
*dst
,
2285 const struct wpabuf
*resp_tlvs
);
2288 * p2p_service_update - Indicate a change in local services
2289 * @priv: Private driver interface data
2290 * Returns: 0 on success, -1 on failure
2292 * This function needs to be called whenever there is a change in
2293 * availability of the local services. This will increment the
2294 * Service Update Indicator value which will be used in SD Request and
2297 * This function is only used if the driver implements P2P management,
2298 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2299 * struct wpa_driver_capa.
2301 int (*p2p_service_update
)(void *priv
);
2304 * p2p_reject - Reject peer device (explicitly block connections)
2305 * @priv: Private driver interface data
2306 * @addr: MAC address of the peer
2307 * Returns: 0 on success, -1 on failure
2309 int (*p2p_reject
)(void *priv
, const u8
*addr
);
2312 * p2p_invite - Invite a P2P Device into a group
2313 * @priv: Private driver interface data
2314 * @peer: Device Address of the peer P2P Device
2315 * @role: Local role in the group
2316 * @bssid: Group BSSID or %NULL if not known
2318 * @ssid_len: Length of ssid in octets
2319 * @go_dev_addr: Forced GO Device Address or %NULL if none
2320 * @persistent_group: Whether this is to reinvoke a persistent group
2321 * Returns: 0 on success, -1 on failure
2323 int (*p2p_invite
)(void *priv
, const u8
*peer
, int role
,
2324 const u8
*bssid
, const u8
*ssid
, size_t ssid_len
,
2325 const u8
*go_dev_addr
, int persistent_group
);
2328 * send_tdls_mgmt - for sending TDLS management packets
2329 * @priv: private driver interface data
2330 * @dst: Destination (peer) MAC address
2331 * @action_code: TDLS action code for the mssage
2332 * @dialog_token: Dialog Token to use in the message (if needed)
2333 * @status_code: Status Code or Reason Code to use (if needed)
2334 * @buf: TDLS IEs to add to the message
2335 * @len: Length of buf in octets
2336 * Returns: 0 on success, negative (<0) on failure
2338 * This optional function can be used to send packet to driver which is
2339 * responsible for receiving and sending all TDLS packets.
2341 int (*send_tdls_mgmt
)(void *priv
, const u8
*dst
, u8 action_code
,
2342 u8 dialog_token
, u16 status_code
,
2343 const u8
*buf
, size_t len
);
2346 * tdls_oper - Ask the driver to perform high-level TDLS operations
2347 * @priv: Private driver interface data
2348 * @oper: TDLS high-level operation. See %enum tdls_oper
2349 * @peer: Destination (peer) MAC address
2350 * Returns: 0 on success, negative (<0) on failure
2352 * This optional function can be used to send high-level TDLS commands
2355 int (*tdls_oper
)(void *priv
, enum tdls_oper oper
, const u8
*peer
);
2358 * signal_poll - Get current connection information
2359 * @priv: Private driver interface data
2360 * @signal_info: Connection info structure
2362 int (*signal_poll
)(void *priv
, struct wpa_signal_info
*signal_info
);
2365 * set_authmode - Set authentication algorithm(s) for static WEP
2366 * @priv: Private driver interface data
2367 * @authmode: 1=Open System, 2=Shared Key, 3=both
2368 * Returns: 0 on success, -1 on failure
2370 * This function can be used to set authentication algorithms for AP
2371 * mode when static WEP is used. If the driver uses user space MLME/SME
2372 * implementation, there is no need to implement this function.
2374 * DEPRECATED - use set_ap() instead
2376 int (*set_authmode
)(void *priv
, int authmode
);
2379 * set_rekey_info - Set rekey information
2380 * @priv: Private driver interface data
2383 * @replay_ctr: Current EAPOL-Key Replay Counter
2385 * This optional function can be used to provide information for the
2386 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2387 * while the host (including wpa_supplicant) is sleeping.
2389 void (*set_rekey_info
)(void *priv
, const u8
*kek
, const u8
*kck
,
2390 const u8
*replay_ctr
);
2393 * sta_assoc - Station association indication
2394 * @priv: Private driver interface data
2395 * @own_addr: Source address and BSSID for association frame
2396 * @addr: MAC address of the station to associate
2397 * @reassoc: flag to indicate re-association
2398 * @status: association response status code
2399 * @ie: assoc response ie buffer
2400 * @len: ie buffer length
2401 * Returns: 0 on success, -1 on failure
2403 * This function indicates the driver to send (Re)Association
2404 * Response frame to the station.
2406 int (*sta_assoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2407 int reassoc
, u16 status
, const u8
*ie
, size_t len
);
2410 * sta_auth - Station authentication indication
2411 * @priv: Private driver interface data
2412 * @own_addr: Source address and BSSID for authentication frame
2413 * @addr: MAC address of the station to associate
2414 * @seq: authentication sequence number
2415 * @status: authentication response status code
2416 * @ie: authentication frame ie buffer
2417 * @len: ie buffer length
2419 * This function indicates the driver to send Authentication frame
2422 int (*sta_auth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2423 u16 seq
, u16 status
, const u8
*ie
, size_t len
);
2426 * add_tspec - Add traffic stream
2427 * @priv: Private driver interface data
2428 * @addr: MAC address of the station to associate
2429 * @tspec_ie: tspec ie buffer
2430 * @tspec_ielen: tspec ie length
2431 * Returns: 0 on success, -1 on failure
2433 * This function adds the traffic steam for the station
2434 * and fills the medium_time in tspec_ie.
2436 int (*add_tspec
)(void *priv
, const u8
*addr
, u8
*tspec_ie
,
2437 size_t tspec_ielen
);
2440 * add_sta_node - Add a station node in the driver
2441 * @priv: Private driver interface data
2442 * @addr: MAC address of the station to add
2443 * @auth_alg: authentication algorithm used by the station
2444 * Returns: 0 on success, -1 on failure
2446 * This function adds the station node in the driver, when
2447 * the station gets added by FT-over-DS.
2449 int (*add_sta_node
)(void *priv
, const u8
*addr
, u16 auth_alg
);
2452 * sched_scan - Request the driver to initiate scheduled scan
2453 * @priv: Private driver interface data
2454 * @params: Scan parameters
2455 * @interval: Interval between scan cycles in milliseconds
2456 * Returns: 0 on success, -1 on failure
2458 * This operation should be used for scheduled scan offload to
2459 * the hardware. Every time scan results are available, the
2460 * driver should report scan results event for wpa_supplicant
2461 * which will eventually request the results with
2462 * wpa_driver_get_scan_results2(). This operation is optional
2463 * and if not provided or if it returns -1, we fall back to
2464 * normal host-scheduled scans.
2466 int (*sched_scan
)(void *priv
, struct wpa_driver_scan_params
*params
,
2470 * stop_sched_scan - Request the driver to stop a scheduled scan
2471 * @priv: Private driver interface data
2472 * Returns: 0 on success, -1 on failure
2474 * This should cause the scheduled scan to be stopped and
2475 * results should stop being sent. Must be supported if
2476 * sched_scan is supported.
2478 int (*stop_sched_scan
)(void *priv
);
2481 * poll_client - Probe (null data or such) the given station
2482 * @priv: Private driver interface data
2483 * @own_addr: MAC address of sending interface
2484 * @addr: MAC address of the station to probe
2485 * @qos: Indicates whether station is QoS station
2487 * This function is used to verify whether an associated station is
2488 * still present. This function does not need to be implemented if the
2489 * driver provides such inactivity polling mechanism.
2491 void (*poll_client
)(void *priv
, const u8
*own_addr
,
2492 const u8
*addr
, int qos
);
2497 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2499 enum wpa_event_type
{
2501 * EVENT_ASSOC - Association completed
2503 * This event needs to be delivered when the driver completes IEEE
2504 * 802.11 association or reassociation successfully.
2505 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2506 * after this event has been generated. In addition, optional
2507 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2508 * more information about the association. If the driver interface gets
2509 * both of these events at the same time, it can also include the
2510 * assoc_info data in EVENT_ASSOC call.
2515 * EVENT_DISASSOC - Association lost
2517 * This event should be called when association is lost either due to
2518 * receiving deauthenticate or disassociate frame from the AP or when
2519 * sending either of these frames to the current AP. If the driver
2520 * supports separate deauthentication event, EVENT_DISASSOC should only
2521 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2522 * In AP mode, union wpa_event_data::disassoc_info is required.
2527 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2529 * This event must be delivered when a Michael MIC error is detected by
2530 * the local driver. Additional data for event processing is
2531 * provided with union wpa_event_data::michael_mic_failure. This
2532 * information is used to request new encyption key and to initiate
2533 * TKIP countermeasures if needed.
2535 EVENT_MICHAEL_MIC_FAILURE
,
2538 * EVENT_SCAN_RESULTS - Scan results available
2540 * This event must be called whenever scan results are available to be
2541 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2542 * is expected to be used some time after struct wpa_driver_ops::scan()
2543 * is called. If the driver provides an unsolicited event when the scan
2544 * has been completed, this event can be used to trigger
2545 * EVENT_SCAN_RESULTS call. If such event is not available from the
2546 * driver, the driver wrapper code is expected to use a registered
2547 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2548 * scan is expected to be completed. Optional information about
2549 * completed scan can be provided with union wpa_event_data::scan_info.
2554 * EVENT_ASSOCINFO - Report optional extra information for association
2556 * This event can be used to report extra association information for
2557 * EVENT_ASSOC processing. This extra information includes IEs from
2558 * association frames and Beacon/Probe Response frames in union
2559 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2560 * EVENT_ASSOC. Alternatively, the driver interface can include
2561 * assoc_info data in the EVENT_ASSOC call if it has all the
2562 * information available at the same point.
2567 * EVENT_INTERFACE_STATUS - Report interface status changes
2569 * This optional event can be used to report changes in interface
2570 * status (interface added/removed) using union
2571 * wpa_event_data::interface_status. This can be used to trigger
2572 * wpa_supplicant to stop and re-start processing for the interface,
2573 * e.g., when a cardbus card is ejected/inserted.
2575 EVENT_INTERFACE_STATUS
,
2578 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2580 * This event can be used to inform wpa_supplicant about candidates for
2581 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2582 * for scan request (ap_scan=2 mode), this event is required for
2583 * pre-authentication. If wpa_supplicant is performing scan request
2584 * (ap_scan=1), this event is optional since scan results can be used
2585 * to add pre-authentication candidates. union
2586 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2587 * candidate and priority of the candidate, e.g., based on the signal
2588 * strength, in order to try to pre-authenticate first with candidates
2589 * that are most likely targets for re-association.
2591 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2592 * on the candidate list. In addition, it can be called for the current
2593 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2594 * will automatically skip pre-authentication in cases where a valid
2595 * PMKSA exists. When more than one candidate exists, this event should
2596 * be generated once for each candidate.
2598 * Driver will be notified about successful pre-authentication with
2599 * struct wpa_driver_ops::add_pmkid() calls.
2601 EVENT_PMKID_CANDIDATE
,
2604 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2606 * This event can be used to inform wpa_supplicant about desire to set
2607 * up secure direct link connection between two stations as defined in
2608 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2609 * STAKey negotiation. The caller will need to set peer address for the
2615 * EVENT_TDLS - Request TDLS operation
2617 * This event can be used to request a TDLS operation to be performed.
2622 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2624 * The driver is expected to report the received FT IEs from
2625 * FT authentication sequence from the AP. The FT IEs are included in
2626 * the extra information in union wpa_event_data::ft_ies.
2631 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2633 * The driver can use this event to inform wpa_supplicant about a STA
2634 * in an IBSS with which protected frames could be exchanged. This
2635 * event starts RSN authentication with the other STA to authenticate
2636 * the STA and set up encryption keys with it.
2638 EVENT_IBSS_RSN_START
,
2641 * EVENT_AUTH - Authentication result
2643 * This event should be called when authentication attempt has been
2644 * completed. This is only used if the driver supports separate
2645 * authentication step (struct wpa_driver_ops::authenticate).
2646 * Information about authentication result is included in
2647 * union wpa_event_data::auth.
2652 * EVENT_DEAUTH - Authentication lost
2654 * This event should be called when authentication is lost either due
2655 * to receiving deauthenticate frame from the AP or when sending that
2656 * frame to the current AP.
2657 * In AP mode, union wpa_event_data::deauth_info is required.
2662 * EVENT_ASSOC_REJECT - Association rejected
2664 * This event should be called when (re)association attempt has been
2665 * rejected by the AP. Information about the association response is
2666 * included in union wpa_event_data::assoc_reject.
2671 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2673 EVENT_AUTH_TIMED_OUT
,
2676 * EVENT_ASSOC_TIMED_OUT - Association timed out
2678 EVENT_ASSOC_TIMED_OUT
,
2681 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2686 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2688 EVENT_WPS_BUTTON_PUSHED
,
2691 * EVENT_TX_STATUS - Report TX status
2696 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2698 EVENT_RX_FROM_UNKNOWN
,
2701 * EVENT_RX_MGMT - Report RX of a management frame
2706 * EVENT_RX_ACTION - Action frame received
2708 * This event is used to indicate when an Action frame has been
2709 * received. Information about the received frame is included in
2710 * union wpa_event_data::rx_action.
2715 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2717 * This event is used to indicate when the driver has started the
2718 * requested remain-on-channel duration. Information about the
2719 * operation is included in union wpa_event_data::remain_on_channel.
2721 EVENT_REMAIN_ON_CHANNEL
,
2724 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2726 * This event is used to indicate when the driver has completed
2727 * remain-on-channel duration, i.e., may noot be available on the
2728 * requested channel anymore. Information about the
2729 * operation is included in union wpa_event_data::remain_on_channel.
2731 EVENT_CANCEL_REMAIN_ON_CHANNEL
,
2734 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2736 * This event is used only by driver_test.c and userspace MLME.
2741 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2743 * This event is used to indicate when a Probe Request frame has been
2744 * received. Information about the received frame is included in
2745 * union wpa_event_data::rx_probe_req. The driver is required to report
2746 * these events only after successfully completed probe_req_report()
2747 * commands to request the events (i.e., report parameter is non-zero)
2748 * in station mode. In AP mode, Probe Request frames should always be
2754 * EVENT_NEW_STA - New wired device noticed
2756 * This event is used to indicate that a new device has been detected
2757 * in a network that does not use association-like functionality (i.e.,
2758 * mainly wired Ethernet). This can be used to start EAPOL
2759 * authenticator when receiving a frame from a device. The address of
2760 * the device is included in union wpa_event_data::new_sta.
2765 * EVENT_EAPOL_RX - Report received EAPOL frame
2767 * When in AP mode with hostapd, this event is required to be used to
2768 * deliver the receive EAPOL frames from the driver. With
2769 * %wpa_supplicant, this event is used only if the send_eapol() handler
2770 * is used to override the use of l2_packet for EAPOL frame TX.
2775 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
2777 * This event is used to indicate changes in the signal strength
2778 * observed in frames received from the current AP if signal strength
2779 * monitoring has been enabled with signal_monitor().
2781 EVENT_SIGNAL_CHANGE
,
2784 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
2786 * This event is used to indicate that the interface was enabled after
2787 * having been previously disabled, e.g., due to rfkill.
2789 EVENT_INTERFACE_ENABLED
,
2792 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
2794 * This event is used to indicate that the interface was disabled,
2795 * e.g., due to rfkill.
2797 EVENT_INTERFACE_DISABLED
,
2800 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
2802 * This event is used to indicate that the channel list has changed,
2803 * e.g., because of a regulatory domain change triggered by scan
2804 * results including an AP advertising a country code.
2806 EVENT_CHANNEL_LIST_CHANGED
,
2809 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
2811 * This event is used to indicate that the driver cannot maintain this
2812 * interface in its operation mode anymore. The most likely use for
2813 * this is to indicate that AP mode operation is not available due to
2814 * operating channel would need to be changed to a DFS channel when
2815 * the driver does not support radar detection and another virtual
2816 * interfaces caused the operating channel to change. Other similar
2817 * resource conflicts could also trigger this for station mode
2820 EVENT_INTERFACE_UNAVAILABLE
,
2823 * EVENT_BEST_CHANNEL
2825 * Driver generates this event whenever it detects a better channel
2826 * (e.g., based on RSSI or channel use). This information can be used
2827 * to improve channel selection for a new AP/P2P group.
2832 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
2834 * This event should be called when a Deauthentication frame is dropped
2835 * due to it not being protected (MFP/IEEE 802.11w).
2836 * union wpa_event_data::unprot_deauth is required to provide more
2837 * details of the frame.
2839 EVENT_UNPROT_DEAUTH
,
2842 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
2844 * This event should be called when a Disassociation frame is dropped
2845 * due to it not being protected (MFP/IEEE 802.11w).
2846 * union wpa_event_data::unprot_disassoc is required to provide more
2847 * details of the frame.
2849 EVENT_UNPROT_DISASSOC
,
2852 * EVENT_STATION_LOW_ACK
2854 * Driver generates this event whenever it detected that a particular
2855 * station was lost. Detection can be through massive transmission
2856 * failures for example.
2858 EVENT_STATION_LOW_ACK
,
2861 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
2863 * This event is used only if the driver implements P2P management
2864 * internally. Event data is stored in
2865 * union wpa_event_data::p2p_dev_found.
2867 EVENT_P2P_DEV_FOUND
,
2870 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
2872 * This event is used only if the driver implements P2P management
2873 * internally. Event data is stored in
2874 * union wpa_event_data::p2p_go_neg_req_rx.
2876 EVENT_P2P_GO_NEG_REQ_RX
,
2879 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
2881 * This event is used only if the driver implements P2P management
2882 * internally. Event data is stored in
2883 * union wpa_event_data::p2p_go_neg_completed.
2885 EVENT_P2P_GO_NEG_COMPLETED
,
2887 EVENT_P2P_PROV_DISC_REQUEST
,
2888 EVENT_P2P_PROV_DISC_RESPONSE
,
2889 EVENT_P2P_SD_REQUEST
,
2890 EVENT_P2P_SD_RESPONSE
,
2893 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
2895 EVENT_IBSS_PEER_LOST
,
2898 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
2900 * This event carries the new replay counter to notify wpa_supplicant
2901 * of the current EAPOL-Key Replay Counter in case the driver/firmware
2902 * completed Group Key Handshake while the host (including
2903 * wpa_supplicant was sleeping).
2905 EVENT_DRIVER_GTK_REKEY
,
2908 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
2910 EVENT_SCHED_SCAN_STOPPED
,
2913 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
2915 * This event indicates that the station responded to the poll
2916 * initiated with @poll_client.
2918 EVENT_DRIVER_CLIENT_POLL_OK
,
2921 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
2923 EVENT_EAPOL_TX_STATUS
2928 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
2930 union wpa_event_data
{
2932 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
2934 * This structure is optional for EVENT_ASSOC calls and required for
2935 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
2936 * driver interface does not need to generate separate EVENT_ASSOCINFO
2941 * reassoc - Flag to indicate association or reassociation
2946 * req_ies - (Re)Association Request IEs
2948 * If the driver generates WPA/RSN IE, this event data must be
2949 * returned for WPA handshake to have needed information. If
2950 * wpa_supplicant-generated WPA/RSN IE is used, this
2951 * information event is optional.
2953 * This should start with the first IE (fixed fields before IEs
2954 * are not included).
2959 * req_ies_len - Length of req_ies in bytes
2964 * resp_ies - (Re)Association Response IEs
2966 * Optional association data from the driver. This data is not
2967 * required WPA, but may be useful for some protocols and as
2968 * such, should be reported if this is available to the driver
2971 * This should start with the first IE (fixed fields before IEs
2972 * are not included).
2977 * resp_ies_len - Length of resp_ies in bytes
2979 size_t resp_ies_len
;
2982 * beacon_ies - Beacon or Probe Response IEs
2984 * Optional Beacon/ProbeResp data: IEs included in Beacon or
2985 * Probe Response frames from the current AP (i.e., the one
2986 * that the client just associated with). This information is
2987 * used to update WPA/RSN IE for the AP. If this field is not
2988 * set, the results from previous scan will be used. If no
2989 * data for the new AP is found, scan results will be requested
2990 * again (without scan request). At this point, the driver is
2991 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
2994 * This should start with the first IE (fixed fields before IEs
2995 * are not included).
2997 const u8
*beacon_ies
;
3000 * beacon_ies_len - Length of beacon_ies */
3001 size_t beacon_ies_len
;
3004 * freq - Frequency of the operational channel in MHz
3009 * addr - Station address (for AP mode)
3015 * struct disassoc_info - Data for EVENT_DISASSOC events
3017 struct disassoc_info
{
3019 * addr - Station address (for AP mode)
3024 * reason_code - Reason Code (host byte order) used in
3025 * Deauthentication frame
3030 * ie - Optional IE(s) in Disassociation frame
3035 * ie_len - Length of ie buffer in octets
3040 * locally_generated - Whether the frame was locally generated
3042 int locally_generated
;
3046 * struct deauth_info - Data for EVENT_DEAUTH events
3048 struct deauth_info
{
3050 * addr - Station address (for AP mode)
3055 * reason_code - Reason Code (host byte order) used in
3056 * Deauthentication frame
3061 * ie - Optional IE(s) in Deauthentication frame
3066 * ie_len - Length of ie buffer in octets
3071 * locally_generated - Whether the frame was locally generated
3073 int locally_generated
;
3077 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3079 struct michael_mic_failure
{
3082 } michael_mic_failure
;
3085 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3087 struct interface_status
{
3090 EVENT_INTERFACE_ADDED
, EVENT_INTERFACE_REMOVED
3095 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3097 struct pmkid_candidate
{
3098 /** BSSID of the PMKID candidate */
3100 /** Smaller the index, higher the priority */
3102 /** Whether RSN IE includes pre-authenticate flag */
3107 * struct stkstart - Data for EVENT_STKSTART
3114 * struct tdls - Data for EVENT_TDLS
3120 TDLS_REQUEST_TEARDOWN
3122 u16 reason_code
; /* for teardown */
3126 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3128 * During FT (IEEE 802.11r) authentication sequence, the driver is
3129 * expected to use this event to report received FT IEs (MDIE, FTIE,
3130 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3131 * IEs for the next message will be delivered through the
3132 * struct wpa_driver_ops::update_ft_ies() callback.
3138 u8 target_ap
[ETH_ALEN
];
3139 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3141 /** Length of ric_ies buffer in octets */
3146 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3148 struct ibss_rsn_start
{
3153 * struct auth_info - Data for EVENT_AUTH events
3159 u16 auth_transaction
;
3166 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3168 struct assoc_reject
{
3170 * bssid - BSSID of the AP that rejected association
3175 * resp_ies - (Re)Association Response IEs
3177 * Optional association data from the driver. This data is not
3178 * required WPA, but may be useful for some protocols and as
3179 * such, should be reported if this is available to the driver
3182 * This should start with the first IE (fixed fields before IEs
3183 * are not included).
3188 * resp_ies_len - Length of resp_ies in bytes
3190 size_t resp_ies_len
;
3193 * status_code - Status Code from (Re)association Response
3198 struct timeout_event
{
3203 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3212 * struct tx_status - Data for EVENT_TX_STATUS events
3224 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3226 struct rx_from_unknown
{
3233 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3243 * struct rx_action - Data for EVENT_RX_ACTION events
3247 * da - Destination address of the received Action frame
3252 * sa - Source address of the received Action frame
3257 * bssid - Address 3 of the received Action frame
3262 * category - Action frame category
3267 * data - Action frame body after category field
3272 * len - Length of data in octets
3277 * freq - Frequency (in MHz) on which the frame was received
3283 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3285 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3287 struct remain_on_channel
{
3289 * freq - Channel frequency in MHz
3294 * duration - Duration to remain on the channel in milliseconds
3296 unsigned int duration
;
3297 } remain_on_channel
;
3300 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3301 * @aborted: Whether the scan was aborted
3302 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3303 * @num_freqs: Number of entries in freqs array
3304 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3306 * @num_ssids: Number of entries in ssids array
3312 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
3317 * struct mlme_rx - Data for EVENT_MLME_RX events
3328 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3330 struct rx_probe_req
{
3332 * sa - Source address of the received Probe Request frame
3337 * da - Destination address of the received Probe Request frame
3338 * or %NULL if not available
3343 * bssid - BSSID of the received Probe Request frame or %NULL
3349 * ie - IEs from the Probe Request body
3354 * ie_len - Length of ie buffer in octets
3360 * struct new_sta - Data for EVENT_NEW_STA events
3367 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3376 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3378 struct wpa_signal_info signal_change
;
3381 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3382 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3383 * @freq_5: Best 5 GHz band channel frequency in MHz
3384 * @freq_overall: Best channel frequency in MHz
3386 * 0 can be used to indicate no preference in either band.
3388 struct best_channel
{
3394 struct unprot_deauth
{
3400 struct unprot_disassoc
{
3407 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3408 * @addr: station address
3415 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3417 struct p2p_dev_found
{
3420 const u8
*pri_dev_type
;
3421 const char *dev_name
;
3428 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3430 struct p2p_go_neg_req_rx
{
3433 } p2p_go_neg_req_rx
;
3436 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3438 struct p2p_go_neg_completed
{
3439 struct p2p_go_neg_results
*res
;
3440 } p2p_go_neg_completed
;
3442 struct p2p_prov_disc_req
{
3446 const u8
*pri_dev_type
;
3447 const char *dev_name
;
3448 u16 supp_config_methods
;
3451 } p2p_prov_disc_req
;
3453 struct p2p_prov_disc_resp
{
3456 } p2p_prov_disc_resp
;
3467 struct p2p_sd_resp
{
3475 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3477 struct ibss_peer_lost
{
3482 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3484 struct driver_gtk_rekey
{
3486 const u8
*replay_ctr
;
3490 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
3491 * @addr: station address
3493 struct client_poll
{
3498 * struct eapol_tx_status
3499 * @dst: Original destination
3500 * @data: Data starting with IEEE 802.1X header (!)
3501 * @data_len: Length of data
3502 * @ack: Indicates ack or lost frame
3504 * This corresponds to hapd_send_eapol if the frame sent
3505 * there isn't just reported as EVENT_TX_STATUS.
3507 struct eapol_tx_status
{
3516 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3517 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3518 * with struct wpa_driver_ops::init()
3519 * @event: event type (defined above)
3520 * @data: possible extra data for the event
3522 * Driver wrapper code should call this function whenever an event is received
3525 void wpa_supplicant_event(void *ctx
, enum wpa_event_type event
,
3526 union wpa_event_data
*data
);
3530 * The following inline functions are provided for convenience to simplify
3531 * event indication for some of the common events.
3534 static inline void drv_event_assoc(void *ctx
, const u8
*addr
, const u8
*ie
,
3535 size_t ielen
, int reassoc
)
3537 union wpa_event_data event
;
3538 os_memset(&event
, 0, sizeof(event
));
3539 event
.assoc_info
.reassoc
= reassoc
;
3540 event
.assoc_info
.req_ies
= ie
;
3541 event
.assoc_info
.req_ies_len
= ielen
;
3542 event
.assoc_info
.addr
= addr
;
3543 wpa_supplicant_event(ctx
, EVENT_ASSOC
, &event
);
3546 static inline void drv_event_disassoc(void *ctx
, const u8
*addr
)
3548 union wpa_event_data event
;
3549 os_memset(&event
, 0, sizeof(event
));
3550 event
.disassoc_info
.addr
= addr
;
3551 wpa_supplicant_event(ctx
, EVENT_DISASSOC
, &event
);
3554 static inline void drv_event_eapol_rx(void *ctx
, const u8
*src
, const u8
*data
,
3557 union wpa_event_data event
;
3558 os_memset(&event
, 0, sizeof(event
));
3559 event
.eapol_rx
.src
= src
;
3560 event
.eapol_rx
.data
= data
;
3561 event
.eapol_rx
.data_len
= data_len
;
3562 wpa_supplicant_event(ctx
, EVENT_EAPOL_RX
, &event
);
3565 /* driver_common.c */
3566 void wpa_scan_results_free(struct wpa_scan_results
*res
);
3568 /* Convert wpa_event_type to a string for logging */
3569 const char * event_to_string(enum wpa_event_type event
);
3571 #endif /* DRIVER_H */