2 * Driver interface definition
3 * Copyright (c) 2003-2012, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
8 * This file defines a driver interface used by both %wpa_supplicant and
9 * hostapd. The first part of the file defines data structures used in various
10 * driver operations. This is followed by the struct wpa_driver_ops that each
11 * driver wrapper will beed to define with callback functions for requesting
12 * driver operations. After this, there are definitions for driver event
13 * reporting with wpa_supplicant_event() and some convenience helper functions
14 * that can be used to report events.
20 #define WPA_SUPPLICANT_DRIVER_VERSION 4
22 #include "common/defs.h"
24 #define HOSTAPD_CHAN_DISABLED 0x00000001
25 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
26 #define HOSTAPD_CHAN_NO_IBSS 0x00000004
27 #define HOSTAPD_CHAN_RADAR 0x00000008
28 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
29 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
30 #define HOSTAPD_CHAN_HT40 0x00000040
33 * struct hostapd_channel_data - Channel information
35 struct hostapd_channel_data
{
37 * chan - Channel number (IEEE 802.11)
42 * freq - Frequency in MHz
47 * flag - Channel flags (HOSTAPD_CHAN_*)
52 * max_tx_power - maximum transmit power in dBm
57 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
60 * struct hostapd_hw_modes - Supported hardware mode information
62 struct hostapd_hw_modes
{
64 * mode - Hardware mode
66 enum hostapd_hw_mode mode
;
69 * num_channels - Number of entries in the channels array
74 * channels - Array of supported channels
76 struct hostapd_channel_data
*channels
;
79 * num_rates - Number of entries in the rates array
84 * rates - Array of supported rates in 100 kbps units
89 * ht_capab - HT (IEEE 802.11n) capabilities
94 * mcs_set - MCS (IEEE 802.11n) rate parameters
99 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
104 * vht_capab - VHT (IEEE 802.11ac) capabilities
109 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
113 unsigned int flags
; /* HOSTAPD_MODE_FLAG_* */
117 #define IEEE80211_MODE_INFRA 0
118 #define IEEE80211_MODE_IBSS 1
119 #define IEEE80211_MODE_AP 2
121 #define IEEE80211_CAP_ESS 0x0001
122 #define IEEE80211_CAP_IBSS 0x0002
123 #define IEEE80211_CAP_PRIVACY 0x0010
125 #define WPA_SCAN_QUAL_INVALID BIT(0)
126 #define WPA_SCAN_NOISE_INVALID BIT(1)
127 #define WPA_SCAN_LEVEL_INVALID BIT(2)
128 #define WPA_SCAN_LEVEL_DBM BIT(3)
129 #define WPA_SCAN_AUTHENTICATED BIT(4)
130 #define WPA_SCAN_ASSOCIATED BIT(5)
133 * struct wpa_scan_res - Scan result for an BSS/IBSS
134 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
136 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
137 * @beacon_int: beacon interval in TUs (host byte order)
138 * @caps: capability information field in host byte order
139 * @qual: signal quality
140 * @noise: noise level
141 * @level: signal level
143 * @age: Age of the information in milliseconds (i.e., how many milliseconds
144 * ago the last Beacon or Probe Response frame was received)
145 * @ie_len: length of the following IE field in octets
146 * @beacon_ie_len: length of the following Beacon IE field in octets
148 * This structure is used as a generic format for scan results from the
149 * driver. Each driver interface implementation is responsible for converting
150 * the driver or OS specific scan results into this format.
152 * If the driver does not support reporting all IEs, the IE data structure is
153 * constructed of the IEs that are available. This field will also need to
154 * include SSID in IE format. All drivers are encouraged to be extended to
155 * report all IEs to make it easier to support future additions.
157 struct wpa_scan_res
{
169 size_t beacon_ie_len
;
171 * Followed by ie_len octets of IEs from Probe Response frame (or if
172 * the driver does not indicate source of IEs, these may also be from
173 * Beacon frame). After the first set of IEs, another set of IEs may
174 * follow (with beacon_ie_len octets of data) if the driver provides
180 * struct wpa_scan_results - Scan results
181 * @res: Array of pointers to allocated variable length scan result entries
182 * @num: Number of entries in the scan result array
184 struct wpa_scan_results
{
185 struct wpa_scan_res
**res
;
190 * struct wpa_interface_info - Network interface information
191 * @next: Pointer to the next interface or NULL if this is the last one
192 * @ifname: Interface name that can be used with init() or init2()
193 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
195 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
196 * is not an allocated copy, i.e., get_interfaces() caller will not free
199 struct wpa_interface_info
{
200 struct wpa_interface_info
*next
;
203 const char *drv_name
;
206 #define WPAS_MAX_SCAN_SSIDS 16
209 * struct wpa_driver_scan_params - Scan parameters
210 * Data for struct wpa_driver_ops::scan2().
212 struct wpa_driver_scan_params
{
214 * ssids - SSIDs to scan for
216 struct wpa_driver_scan_ssid
{
218 * ssid - specific SSID to scan for (ProbeReq)
219 * %NULL or zero-length SSID is used to indicate active scan
220 * with wildcard SSID.
224 * ssid_len: Length of the SSID in octets
227 } ssids
[WPAS_MAX_SCAN_SSIDS
];
230 * num_ssids - Number of entries in ssids array
231 * Zero indicates a request for a passive scan.
236 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
241 * extra_ies_len - Length of extra_ies in octets
243 size_t extra_ies_len
;
246 * freqs - Array of frequencies to scan or %NULL for all frequencies
248 * The frequency is set in MHz. The array is zero-terminated.
253 * filter_ssids - Filter for reporting SSIDs
255 * This optional parameter can be used to request the driver wrapper to
256 * filter scan results to include only the specified SSIDs. %NULL
257 * indicates that no filtering is to be done. This can be used to
258 * reduce memory needs for scan results in environments that have large
259 * number of APs with different SSIDs.
261 * The driver wrapper is allowed to take this allocated buffer into its
262 * own use by setting the pointer to %NULL. In that case, the driver
263 * wrapper is responsible for freeing the buffer with os_free() once it
264 * is not needed anymore.
266 struct wpa_driver_scan_filter
{
272 * num_filter_ssids - Number of entries in filter_ssids array
274 size_t num_filter_ssids
;
277 * filter_rssi - Filter by RSSI
279 * The driver may filter scan results in firmware to reduce host
280 * wakeups and thereby save power. Specify the RSSI threshold in s32
286 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
288 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
289 * Mbps from the support rates element(s) in the Probe Request frames
290 * and not to transmit the frames at any of those rates.
296 * struct wpa_driver_auth_params - Authentication parameters
297 * Data for struct wpa_driver_ops::authenticate().
299 struct wpa_driver_auth_params
{
307 const u8
*wep_key
[4];
308 size_t wep_key_len
[4];
310 int local_state_change
;
313 * p2p - Whether this connection is a P2P group
323 WPS_MODE_NONE
/* no WPS provisioning being used */,
324 WPS_MODE_OPEN
/* WPS provisioning with AP that is in open mode */,
325 WPS_MODE_PRIVACY
/* WPS provisioning with AP that is using protection
330 * struct wpa_driver_associate_params - Association parameters
331 * Data for struct wpa_driver_ops::associate().
333 struct wpa_driver_associate_params
{
335 * bssid - BSSID of the selected AP
336 * This can be %NULL, if ap_scan=2 mode is used and the driver is
337 * responsible for selecting with which BSS to associate. */
341 * ssid - The selected SSID
346 * ssid_len - Length of the SSID (1..32)
351 * freq - Frequency of the channel the selected AP is using
352 * Frequency that the selected AP is using (in MHz as
353 * reported in the scan results)
358 * bg_scan_period - Background scan period in seconds, 0 to disable
359 * background scan, or -1 to indicate no change to default driver
365 * wpa_ie - WPA information element for (Re)Association Request
366 * WPA information element to be included in (Re)Association
367 * Request (including information element id and length). Use
368 * of this WPA IE is optional. If the driver generates the WPA
369 * IE, it can use pairwise_suite, group_suite, and
370 * key_mgmt_suite to select proper algorithms. In this case,
371 * the driver has to notify wpa_supplicant about the used WPA
372 * IE by generating an event that the interface code will
373 * convert into EVENT_ASSOCINFO data (see below).
375 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
376 * instead. The driver can determine which version is used by
377 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
380 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
385 * wpa_ie_len - length of the wpa_ie
390 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
392 unsigned int wpa_proto
;
395 * pairwise_suite - Selected pairwise cipher suite
397 * This is usually ignored if @wpa_ie is used.
399 enum wpa_cipher pairwise_suite
;
402 * group_suite - Selected group cipher suite
404 * This is usually ignored if @wpa_ie is used.
406 enum wpa_cipher group_suite
;
409 * key_mgmt_suite - Selected key management suite
411 * This is usually ignored if @wpa_ie is used.
413 enum wpa_key_mgmt key_mgmt_suite
;
416 * auth_alg - Allowed authentication algorithms
417 * Bit field of WPA_AUTH_ALG_*
422 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
427 * wep_key - WEP keys for static WEP configuration
429 const u8
*wep_key
[4];
432 * wep_key_len - WEP key length for static WEP configuration
434 size_t wep_key_len
[4];
437 * wep_tx_keyidx - WEP TX key index for static WEP configuration
442 * mgmt_frame_protection - IEEE 802.11w management frame protection
444 enum mfp_options mgmt_frame_protection
;
447 * ft_ies - IEEE 802.11r / FT information elements
448 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
449 * for fast transition, this parameter is set to include the IEs that
450 * are to be sent in the next FT Authentication Request message.
451 * update_ft_ies() handler is called to update the IEs for further
452 * FT messages in the sequence.
454 * The driver should use these IEs only if the target AP is advertising
455 * the same mobility domain as the one included in the MDIE here.
457 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
458 * AP after the initial association. These IEs can only be used if the
459 * target AP is advertising support for FT and is using the same MDIE
460 * and SSID as the current AP.
462 * The driver is responsible for reporting the FT IEs received from the
463 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
464 * type. update_ft_ies() handler will then be called with the FT IEs to
465 * include in the next frame in the authentication sequence.
470 * ft_ies_len - Length of ft_ies in bytes
475 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
477 * This value is provided to allow the driver interface easier access
478 * to the current mobility domain. This value is set to %NULL if no
479 * mobility domain is currently active.
484 * passphrase - RSN passphrase for PSK
486 * This value is made available only for WPA/WPA2-Personal (PSK) and
487 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
488 * the 8..63 character ASCII passphrase, if available. Please note that
489 * this can be %NULL if passphrase was not used to generate the PSK. In
490 * that case, the psk field must be used to fetch the PSK.
492 const char *passphrase
;
495 * psk - RSN PSK (alternative for passphrase for PSK)
497 * This value is made available only for WPA/WPA2-Personal (PSK) and
498 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
499 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
500 * be prepared to handle %NULL value as an error.
505 * drop_unencrypted - Enable/disable unencrypted frame filtering
507 * Configure the driver to drop all non-EAPOL frames (both receive and
508 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
509 * still be allowed for key negotiation.
511 int drop_unencrypted
;
514 * prev_bssid - Previously used BSSID in this ESS
516 * When not %NULL, this is a request to use reassociation instead of
519 const u8
*prev_bssid
;
524 * If the driver needs to do special configuration for WPS association,
525 * this variable provides more information on what type of association
526 * is being requested. Most drivers should not need ot use this.
531 * p2p - Whether this connection is a P2P group
536 * uapsd - UAPSD parameters for the network
537 * -1 = do not change defaults
538 * AP mode: 1 = enabled, 0 = disabled
539 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
544 * fixed_bssid - Whether to force this BSSID in IBSS mode
545 * 1 = Fix this BSSID and prevent merges.
546 * 0 = Do not fix BSSID.
551 * disable_ht - Disable HT (IEEE 802.11n) for this connection
556 * HT Capabilities over-rides. Only bits set in the mask will be used,
557 * and not all values are used by the kernel anyway. Currently, MCS,
558 * MPDU and MSDU fields are used.
560 const u8
*htcaps
; /* struct ieee80211_ht_capabilities * */
561 const u8
*htcaps_mask
; /* struct ieee80211_ht_capabilities * */
566 HIDDEN_SSID_ZERO_LEN
,
567 HIDDEN_SSID_ZERO_CONTENTS
570 struct wpa_driver_ap_params
{
572 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
577 * head_len - Length of the head buffer in octets
582 * tail - Beacon tail following TIM IE
587 * tail_len - Length of the tail buffer in octets
592 * dtim_period - DTIM period
597 * beacon_int - Beacon interval
602 * basic_rates: -1 terminated array of basic rates in 100 kbps
604 * This parameter can be used to set a specific basic rate set for the
605 * BSS. If %NULL, default basic rate set is used.
610 * proberesp - Probe Response template
612 * This is used by drivers that reply to Probe Requests internally in
613 * AP mode and require the full Probe Response template.
618 * proberesp_len - Length of the proberesp buffer in octets
620 size_t proberesp_len
;
623 * ssid - The SSID to use in Beacon/Probe Response frames
628 * ssid_len - Length of the SSID (1..32)
633 * hide_ssid - Whether to hide the SSID
635 enum hide_ssid hide_ssid
;
638 * pairwise_ciphers - WPA_CIPHER_* bitfield
640 unsigned int pairwise_ciphers
;
643 * group_cipher - WPA_CIPHER_*
645 unsigned int group_cipher
;
648 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
650 unsigned int key_mgmt_suites
;
653 * auth_algs - WPA_AUTH_ALG_* bitfield
655 unsigned int auth_algs
;
658 * wpa_version - WPA_PROTO_* bitfield
660 unsigned int wpa_version
;
663 * privacy - Whether privacy is used in the BSS
668 * beacon_ies - WPS/P2P IE(s) for Beacon frames
670 * This is used to add IEs like WPS IE and P2P IE by drivers that do
671 * not use the full Beacon template.
673 const struct wpabuf
*beacon_ies
;
676 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
678 * This is used to add IEs like WPS IE and P2P IE by drivers that
679 * reply to Probe Request frames internally.
681 const struct wpabuf
*proberesp_ies
;
684 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
686 * This is used to add IEs like WPS IE by drivers that reply to
687 * (Re)Association Request frames internally.
689 const struct wpabuf
*assocresp_ies
;
692 * isolate - Whether to isolate frames between associated stations
694 * If this is non-zero, the AP is requested to disable forwarding of
695 * frames between associated stations.
700 * cts_protect - Whether CTS protection is enabled
705 * preamble - Whether short preamble is enabled
710 * short_slot_time - Whether short slot time is enabled
712 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
713 * not set (e.g., when 802.11g mode is not in use)
718 * ht_opmode - HT operation mode or -1 if HT not in use
723 * interworking - Whether Interworking is enabled
728 * hessid - Homogeneous ESS identifier or %NULL if not set
733 * access_network_type - Access Network Type (0..15)
735 * This is used for filtering Probe Request frames when Interworking is
738 u8 access_network_type
;
741 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
743 * This is used by driver which advertises this capability.
745 int ap_max_inactivity
;
748 * disable_dgaf - Whether group-addressed frames are disabled
754 * struct wpa_driver_capa - Driver capability information
756 struct wpa_driver_capa
{
757 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
758 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
759 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
760 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
761 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
762 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
763 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
764 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
765 unsigned int key_mgmt
;
767 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
768 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
769 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
770 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
771 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
772 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
775 #define WPA_DRIVER_AUTH_OPEN 0x00000001
776 #define WPA_DRIVER_AUTH_SHARED 0x00000002
777 #define WPA_DRIVER_AUTH_LEAP 0x00000004
780 /* Driver generated WPA/RSN IE */
781 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
782 /* Driver needs static WEP key setup after association command */
783 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
784 /* unused: 0x00000004 */
785 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
786 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
787 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
788 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
789 /* Driver provides separate commands for authentication and association (SME in
790 * wpa_supplicant). */
791 #define WPA_DRIVER_FLAGS_SME 0x00000020
792 /* Driver supports AP mode */
793 #define WPA_DRIVER_FLAGS_AP 0x00000040
794 /* Driver needs static WEP key setup after association has been completed */
795 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
796 /* Driver takes care of P2P management operations */
797 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
798 /* Driver supports concurrent P2P operations */
799 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
801 * Driver uses the initial interface as a dedicated management interface, i.e.,
802 * it cannot be used for P2P group operations or non-P2P purposes.
804 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
805 /* This interface is P2P capable (P2P Device, GO, or P2P Client */
806 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
807 /* Driver supports concurrent operations on multiple channels */
808 #define WPA_DRIVER_FLAGS_MULTI_CHANNEL_CONCURRENT 0x00001000
810 * Driver uses the initial interface for P2P management interface and non-P2P
811 * purposes (e.g., connect to infra AP), but this interface cannot be used for
812 * P2P group operations.
814 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
816 * Driver is known to use sane error codes, i.e., when it indicates that
817 * something (e.g., association) fails, there was indeed a failure and the
818 * operation does not end up getting completed successfully later.
820 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
821 /* Driver supports off-channel TX */
822 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
823 /* Driver indicates TX status events for EAPOL Data frames */
824 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
825 /* Driver indicates TX status events for Deauth/Disassoc frames */
826 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
827 /* Driver supports roaming (BSS selection) in firmware */
828 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
829 /* Driver supports operating as a TDLS peer */
830 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
831 /* Driver requires external TDLS setup/teardown/discovery */
832 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
833 /* Driver indicates support for Probe Response offloading in AP mode */
834 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
835 /* Driver supports U-APSD in AP mode */
836 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
837 /* Driver supports inactivity timer in AP mode */
838 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
839 /* Driver expects user space implementation of MLME in AP mode */
840 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
841 /* Driver supports SAE with user space SME */
842 #define WPA_DRIVER_FLAGS_SAE 0x02000000
846 int max_sched_scan_ssids
;
847 int sched_scan_supported
;
851 * max_remain_on_chan - Maximum remain-on-channel duration in msec
853 unsigned int max_remain_on_chan
;
856 * max_stations - Maximum number of associated stations the driver
857 * supports in AP mode
859 unsigned int max_stations
;
862 * probe_resp_offloads - Bitmap of supported protocols by the driver
863 * for Probe Response offloading.
865 /* Driver Probe Response offloading support for WPS ver. 1 */
866 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
867 /* Driver Probe Response offloading support for WPS ver. 2 */
868 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
869 /* Driver Probe Response offloading support for P2P */
870 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
871 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
872 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
873 unsigned int probe_resp_offloads
;
879 struct hostap_sta_driver_data
{
880 unsigned long rx_packets
, tx_packets
, rx_bytes
, tx_bytes
;
881 unsigned long current_tx_rate
;
882 unsigned long inactive_msec
;
884 unsigned long num_ps_buf_frames
;
885 unsigned long tx_retry_failed
;
886 unsigned long tx_retry_count
;
891 struct hostapd_sta_add_params
{
895 const u8
*supp_rates
;
896 size_t supp_rates_len
;
898 const struct ieee80211_ht_capabilities
*ht_capabilities
;
899 u32 flags
; /* bitmask of WPA_STA_* flags */
900 int set
; /* Set STA parameters instead of add */
904 struct hostapd_freq_params
{
909 int sec_channel_offset
; /* 0 = HT40 disabled, -1 = HT40 enabled,
910 * secondary channel below primary, 1 = HT40
911 * enabled, secondary channel above primary */
914 enum wpa_driver_if_type
{
916 * WPA_IF_STATION - Station mode interface
921 * WPA_IF_AP_VLAN - AP mode VLAN interface
923 * This interface shares its address and Beacon frame with the main
929 * WPA_IF_AP_BSS - AP mode BSS interface
931 * This interface has its own address and Beacon frame.
936 * WPA_IF_P2P_GO - P2P Group Owner
941 * WPA_IF_P2P_CLIENT - P2P Client
946 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
947 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
952 struct wpa_init_params
{
958 const char *test_socket
;
959 int use_pae_group_addr
;
963 u8
*own_addr
; /* buffer for writing own MAC address */
967 struct wpa_bss_params
{
968 /** Interface name (for multi-SSID/VLAN support) */
970 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
979 enum mfp_options ieee80211w
;
982 #define WPA_STA_AUTHORIZED BIT(0)
983 #define WPA_STA_WMM BIT(1)
984 #define WPA_STA_SHORT_PREAMBLE BIT(2)
985 #define WPA_STA_MFP BIT(3)
986 #define WPA_STA_TDLS_PEER BIT(4)
989 * struct p2p_params - P2P parameters for driver-based P2P management
992 const char *dev_name
;
994 #define DRV_MAX_SEC_DEV_TYPES 5
995 u8 sec_dev_type
[DRV_MAX_SEC_DEV_TYPES
][8];
996 size_t num_sec_dev_types
;
1010 WNM_SLEEP_ENTER_CONFIRM
,
1011 WNM_SLEEP_ENTER_FAIL
,
1012 WNM_SLEEP_EXIT_CONFIRM
,
1013 WNM_SLEEP_EXIT_FAIL
,
1014 WNM_SLEEP_TFS_REQ_IE_ADD
, /* STA requests driver to add TFS req IE */
1015 WNM_SLEEP_TFS_REQ_IE_NONE
, /* STA requests empty TFS req IE */
1016 WNM_SLEEP_TFS_REQ_IE_SET
, /* AP requests driver to set TFS req IE for
1018 WNM_SLEEP_TFS_RESP_IE_ADD
, /* AP requests driver to add TFS resp IE
1020 WNM_SLEEP_TFS_RESP_IE_NONE
, /* AP requests empty TFS resp IE */
1021 WNM_SLEEP_TFS_RESP_IE_SET
, /* AP requests driver to set TFS resp IE
1023 WNM_SLEEP_TFS_IE_DEL
/* AP delete the TFS IE */
1027 * struct wpa_signal_info - Information about channel signal quality
1029 struct wpa_signal_info
{
1031 int above_threshold
;
1038 * struct wpa_driver_ops - Driver interface API definition
1040 * This structure defines the API that each driver interface needs to implement
1041 * for core wpa_supplicant code. All driver specific functionality is captured
1044 struct wpa_driver_ops
{
1045 /** Name of the driver interface */
1047 /** One line description of the driver interface */
1051 * get_bssid - Get the current BSSID
1052 * @priv: private driver interface data
1053 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1055 * Returns: 0 on success, -1 on failure
1057 * Query kernel driver for the current BSSID and copy it to bssid.
1058 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1061 int (*get_bssid
)(void *priv
, u8
*bssid
);
1064 * get_ssid - Get the current SSID
1065 * @priv: private driver interface data
1066 * @ssid: buffer for SSID (at least 32 bytes)
1068 * Returns: Length of the SSID on success, -1 on failure
1070 * Query kernel driver for the current SSID and copy it to ssid.
1071 * Returning zero is recommended if the STA is not associated.
1073 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1074 * can, at least in theory, contain control characters (including nul)
1075 * and as such, should be processed as binary data, not a printable
1078 int (*get_ssid
)(void *priv
, u8
*ssid
);
1081 * set_key - Configure encryption key
1082 * @ifname: Interface name (for multi-SSID/VLAN support)
1083 * @priv: private driver interface data
1084 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1085 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1087 * %WPA_ALG_NONE clears the key.
1088 * @addr: Address of the peer STA (BSSID of the current AP when setting
1089 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1090 * broadcast keys, %NULL for default keys that are used both for
1091 * broadcast and unicast; when clearing keys, %NULL is used to
1092 * indicate that both the broadcast-only and default key of the
1093 * specified key index is to be cleared
1094 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1096 * @set_tx: configure this key as the default Tx key (only used when
1097 * driver does not support separate unicast/individual key
1098 * @seq: sequence number/packet number, seq_len octets, the next
1099 * packet number to be used for in replay protection; configured
1100 * for Rx keys (in most cases, this is only used with broadcast
1101 * keys and set to zero for unicast keys); %NULL if not set
1102 * @seq_len: length of the seq, depends on the algorithm:
1103 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1104 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1106 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1107 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1109 * Returns: 0 on success, -1 on failure
1111 * Configure the given key for the kernel driver. If the driver
1112 * supports separate individual keys (4 default keys + 1 individual),
1113 * addr can be used to determine whether the key is default or
1114 * individual. If only 4 keys are supported, the default key with key
1115 * index 0 is used as the individual key. STA must be configured to use
1116 * it as the default Tx key (set_tx is set) and accept Rx for all the
1117 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1118 * broadcast keys, so key index 0 is available for this kind of
1121 * Please note that TKIP keys include separate TX and RX MIC keys and
1122 * some drivers may expect them in different order than wpa_supplicant
1123 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1124 * will trigger Michael MIC errors. This can be fixed by changing the
1125 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1126 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1127 * example on how this can be done.
1129 int (*set_key
)(const char *ifname
, void *priv
, enum wpa_alg alg
,
1130 const u8
*addr
, int key_idx
, int set_tx
,
1131 const u8
*seq
, size_t seq_len
,
1132 const u8
*key
, size_t key_len
);
1135 * init - Initialize driver interface
1136 * @ctx: context to be used when calling wpa_supplicant functions,
1137 * e.g., wpa_supplicant_event()
1138 * @ifname: interface name, e.g., wlan0
1140 * Returns: Pointer to private data, %NULL on failure
1142 * Initialize driver interface, including event processing for kernel
1143 * driver events (e.g., associated, scan results, Michael MIC failure).
1144 * This function can allocate a private configuration data area for
1145 * @ctx, file descriptor, interface name, etc. information that may be
1146 * needed in future driver operations. If this is not used, non-NULL
1147 * value will need to be returned because %NULL is used to indicate
1148 * failure. The returned value will be used as 'void *priv' data for
1149 * all other driver_ops functions.
1151 * The main event loop (eloop.c) of wpa_supplicant can be used to
1152 * register callback for read sockets (eloop_register_read_sock()).
1154 * See below for more information about events and
1155 * wpa_supplicant_event() function.
1157 void * (*init
)(void *ctx
, const char *ifname
);
1160 * deinit - Deinitialize driver interface
1161 * @priv: private driver interface data from init()
1163 * Shut down driver interface and processing of driver events. Free
1164 * private data buffer if one was allocated in init() handler.
1166 void (*deinit
)(void *priv
);
1169 * set_param - Set driver configuration parameters
1170 * @priv: private driver interface data from init()
1171 * @param: driver specific configuration parameters
1173 * Returns: 0 on success, -1 on failure
1175 * Optional handler for notifying driver interface about configuration
1176 * parameters (driver_param).
1178 int (*set_param
)(void *priv
, const char *param
);
1181 * set_countermeasures - Enable/disable TKIP countermeasures
1182 * @priv: private driver interface data
1183 * @enabled: 1 = countermeasures enabled, 0 = disabled
1185 * Returns: 0 on success, -1 on failure
1187 * Configure TKIP countermeasures. When these are enabled, the driver
1188 * should drop all received and queued frames that are using TKIP.
1190 int (*set_countermeasures
)(void *priv
, int enabled
);
1193 * deauthenticate - Request driver to deauthenticate
1194 * @priv: private driver interface data
1195 * @addr: peer address (BSSID of the AP)
1196 * @reason_code: 16-bit reason code to be sent in the deauthentication
1199 * Returns: 0 on success, -1 on failure
1201 int (*deauthenticate
)(void *priv
, const u8
*addr
, int reason_code
);
1204 * disassociate - Request driver to disassociate
1205 * @priv: private driver interface data
1206 * @addr: peer address (BSSID of the AP)
1207 * @reason_code: 16-bit reason code to be sent in the disassociation
1210 * Returns: 0 on success, -1 on failure
1212 int (*disassociate
)(void *priv
, const u8
*addr
, int reason_code
);
1215 * associate - Request driver to associate
1216 * @priv: private driver interface data
1217 * @params: association parameters
1219 * Returns: 0 on success, -1 on failure
1221 int (*associate
)(void *priv
,
1222 struct wpa_driver_associate_params
*params
);
1225 * add_pmkid - Add PMKSA cache entry to the driver
1226 * @priv: private driver interface data
1227 * @bssid: BSSID for the PMKSA cache entry
1228 * @pmkid: PMKID for the PMKSA cache entry
1230 * Returns: 0 on success, -1 on failure
1232 * This function is called when a new PMK is received, as a result of
1233 * either normal authentication or RSN pre-authentication.
1235 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1236 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1237 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1238 * driver_ops function does not need to be implemented. Likewise, if
1239 * the driver does not support WPA, this function is not needed.
1241 int (*add_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
1244 * remove_pmkid - Remove PMKSA cache entry to the driver
1245 * @priv: private driver interface data
1246 * @bssid: BSSID for the PMKSA cache entry
1247 * @pmkid: PMKID for the PMKSA cache entry
1249 * Returns: 0 on success, -1 on failure
1251 * This function is called when the supplicant drops a PMKSA cache
1252 * entry for any reason.
1254 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1255 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1256 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1257 * from wpa_supplicant, this driver_ops function does not need to be
1258 * implemented. Likewise, if the driver does not support WPA, this
1259 * function is not needed.
1261 int (*remove_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
1264 * flush_pmkid - Flush PMKSA cache
1265 * @priv: private driver interface data
1267 * Returns: 0 on success, -1 on failure
1269 * This function is called when the supplicant drops all PMKSA cache
1270 * entries for any reason.
1272 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1273 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1274 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1275 * from wpa_supplicant, this driver_ops function does not need to be
1276 * implemented. Likewise, if the driver does not support WPA, this
1277 * function is not needed.
1279 int (*flush_pmkid
)(void *priv
);
1282 * get_capa - Get driver capabilities
1283 * @priv: private driver interface data
1285 * Returns: 0 on success, -1 on failure
1287 * Get driver/firmware/hardware capabilities.
1289 int (*get_capa
)(void *priv
, struct wpa_driver_capa
*capa
);
1292 * poll - Poll driver for association information
1293 * @priv: private driver interface data
1295 * This is an option callback that can be used when the driver does not
1296 * provide event mechanism for association events. This is called when
1297 * receiving WPA EAPOL-Key messages that require association
1298 * information. The driver interface is supposed to generate associnfo
1299 * event before returning from this callback function. In addition, the
1300 * driver interface should generate an association event after having
1301 * sent out associnfo.
1303 void (*poll
)(void *priv
);
1306 * get_ifname - Get interface name
1307 * @priv: private driver interface data
1309 * Returns: Pointer to the interface name. This can differ from the
1310 * interface name used in init() call. Init() is called first.
1312 * This optional function can be used to allow the driver interface to
1313 * replace the interface name with something else, e.g., based on an
1314 * interface mapping from a more descriptive name.
1316 const char * (*get_ifname
)(void *priv
);
1319 * get_mac_addr - Get own MAC address
1320 * @priv: private driver interface data
1322 * Returns: Pointer to own MAC address or %NULL on failure
1324 * This optional function can be used to get the own MAC address of the
1325 * device from the driver interface code. This is only needed if the
1326 * l2_packet implementation for the OS does not provide easy access to
1328 const u8
* (*get_mac_addr
)(void *priv
);
1331 * send_eapol - Optional function for sending EAPOL packets
1332 * @priv: private driver interface data
1333 * @dest: Destination MAC address
1335 * @data: EAPOL packet starting with IEEE 802.1X header
1336 * @data_len: Size of the EAPOL packet
1338 * Returns: 0 on success, -1 on failure
1340 * This optional function can be used to override l2_packet operations
1341 * with driver specific functionality. If this function pointer is set,
1342 * l2_packet module is not used at all and the driver interface code is
1343 * responsible for receiving and sending all EAPOL packets. The
1344 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1345 * event. The driver interface is required to implement get_mac_addr()
1346 * handler if send_eapol() is used.
1348 int (*send_eapol
)(void *priv
, const u8
*dest
, u16 proto
,
1349 const u8
*data
, size_t data_len
);
1352 * set_operstate - Sets device operating state to DORMANT or UP
1353 * @priv: private driver interface data
1354 * @state: 0 = dormant, 1 = up
1355 * Returns: 0 on success, -1 on failure
1357 * This is an optional function that can be used on operating systems
1358 * that support a concept of controlling network device state from user
1359 * space applications. This function, if set, gets called with
1360 * state = 1 when authentication has been completed and with state = 0
1361 * when connection is lost.
1363 int (*set_operstate
)(void *priv
, int state
);
1366 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1367 * @priv: Private driver interface data
1368 * @addr: Address of the station for which to set protection (may be
1369 * %NULL for group keys)
1370 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1371 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1372 * Returns: 0 on success, -1 on failure
1374 * This is an optional function that can be used to set the driver to
1375 * require protection for Tx and/or Rx frames. This uses the layer
1376 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1377 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1378 * set protection operation; instead, they set protection implicitly
1379 * based on configured keys.
1381 int (*mlme_setprotection
)(void *priv
, const u8
*addr
, int protect_type
,
1385 * get_hw_feature_data - Get hardware support data (channels and rates)
1386 * @priv: Private driver interface data
1387 * @num_modes: Variable for returning the number of returned modes
1388 * flags: Variable for returning hardware feature flags
1389 * Returns: Pointer to allocated hardware data on success or %NULL on
1390 * failure. Caller is responsible for freeing this.
1392 struct hostapd_hw_modes
* (*get_hw_feature_data
)(void *priv
,
1397 * send_mlme - Send management frame from MLME
1398 * @priv: Private driver interface data
1399 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1400 * @data_len: Size of the management frame
1401 * @noack: Do not wait for this frame to be acked (disable retries)
1402 * Returns: 0 on success, -1 on failure
1404 int (*send_mlme
)(void *priv
, const u8
*data
, size_t data_len
,
1408 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1409 * @priv: Private driver interface data
1410 * @md: Mobility domain (2 octets) (also included inside ies)
1411 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1412 * @ies_len: Length of FT IEs in bytes
1413 * Returns: 0 on success, -1 on failure
1415 * The supplicant uses this callback to let the driver know that keying
1416 * material for FT is available and that the driver can use the
1417 * provided IEs in the next message in FT authentication sequence.
1419 * This function is only needed for driver that support IEEE 802.11r
1420 * (Fast BSS Transition).
1422 int (*update_ft_ies
)(void *priv
, const u8
*md
, const u8
*ies
,
1426 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1427 * @priv: Private driver interface data
1428 * @action: Action field value
1429 * @target_ap: Target AP address
1430 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1431 * @ies_len: Length of FT IEs in bytes
1432 * Returns: 0 on success, -1 on failure
1434 * The supplicant uses this callback to request the driver to transmit
1435 * an FT Action frame (action category 6) for over-the-DS fast BSS
1438 int (*send_ft_action
)(void *priv
, u8 action
, const u8
*target_ap
,
1439 const u8
*ies
, size_t ies_len
);
1442 * get_scan_results2 - Fetch the latest scan results
1443 * @priv: private driver interface data
1445 * Returns: Allocated buffer of scan results (caller is responsible for
1446 * freeing the data structure) on success, NULL on failure
1448 struct wpa_scan_results
* (*get_scan_results2
)(void *priv
);
1451 * set_country - Set country
1452 * @priv: Private driver interface data
1453 * @alpha2: country to which to switch to
1454 * Returns: 0 on success, -1 on failure
1456 * This function is for drivers which support some form
1457 * of setting a regulatory domain.
1459 int (*set_country
)(void *priv
, const char *alpha2
);
1462 * global_init - Global driver initialization
1463 * Returns: Pointer to private data (global), %NULL on failure
1465 * This optional function is called to initialize the driver wrapper
1466 * for global data, i.e., data that applies to all interfaces. If this
1467 * function is implemented, global_deinit() will also need to be
1468 * implemented to free the private data. The driver will also likely
1469 * use init2() function instead of init() to get the pointer to global
1470 * data available to per-interface initializer.
1472 void * (*global_init
)(void);
1475 * global_deinit - Global driver deinitialization
1476 * @priv: private driver global data from global_init()
1478 * Terminate any global driver related functionality and free the
1479 * global data structure.
1481 void (*global_deinit
)(void *priv
);
1484 * init2 - Initialize driver interface (with global data)
1485 * @ctx: context to be used when calling wpa_supplicant functions,
1486 * e.g., wpa_supplicant_event()
1487 * @ifname: interface name, e.g., wlan0
1488 * @global_priv: private driver global data from global_init()
1489 * Returns: Pointer to private data, %NULL on failure
1491 * This function can be used instead of init() if the driver wrapper
1494 void * (*init2
)(void *ctx
, const char *ifname
, void *global_priv
);
1497 * get_interfaces - Get information about available interfaces
1498 * @global_priv: private driver global data from global_init()
1499 * Returns: Allocated buffer of interface information (caller is
1500 * responsible for freeing the data structure) on success, NULL on
1503 struct wpa_interface_info
* (*get_interfaces
)(void *global_priv
);
1506 * scan2 - Request the driver to initiate scan
1507 * @priv: private driver interface data
1508 * @params: Scan parameters
1510 * Returns: 0 on success, -1 on failure
1512 * Once the scan results are ready, the driver should report scan
1513 * results event for wpa_supplicant which will eventually request the
1514 * results with wpa_driver_get_scan_results2().
1516 int (*scan2
)(void *priv
, struct wpa_driver_scan_params
*params
);
1519 * authenticate - Request driver to authenticate
1520 * @priv: private driver interface data
1521 * @params: authentication parameters
1522 * Returns: 0 on success, -1 on failure
1524 * This is an optional function that can be used with drivers that
1525 * support separate authentication and association steps, i.e., when
1526 * wpa_supplicant can act as the SME. If not implemented, associate()
1527 * function is expected to take care of IEEE 802.11 authentication,
1530 int (*authenticate
)(void *priv
,
1531 struct wpa_driver_auth_params
*params
);
1534 * set_ap - Set Beacon and Probe Response information for AP mode
1535 * @priv: Private driver interface data
1536 * @params: Parameters to use in AP mode
1538 * This function is used to configure Beacon template and/or extra IEs
1539 * to add for Beacon and Probe Response frames for the driver in
1540 * AP mode. The driver is responsible for building the full Beacon
1541 * frame by concatenating the head part with TIM IE generated by the
1542 * driver/firmware and finishing with the tail part. Depending on the
1543 * driver architectue, this can be done either by using the full
1544 * template or the set of additional IEs (e.g., WPS and P2P IE).
1545 * Similarly, Probe Response processing depends on the driver design.
1546 * If the driver (or firmware) takes care of replying to Probe Request
1547 * frames, the extra IEs provided here needs to be added to the Probe
1550 * Returns: 0 on success, -1 on failure
1552 int (*set_ap
)(void *priv
, struct wpa_driver_ap_params
*params
);
1555 * hapd_init - Initialize driver interface (hostapd only)
1556 * @hapd: Pointer to hostapd context
1557 * @params: Configuration for the driver wrapper
1558 * Returns: Pointer to private data, %NULL on failure
1560 * This function is used instead of init() or init2() when the driver
1561 * wrapper is used with hostapd.
1563 void * (*hapd_init
)(struct hostapd_data
*hapd
,
1564 struct wpa_init_params
*params
);
1567 * hapd_deinit - Deinitialize driver interface (hostapd only)
1568 * @priv: Private driver interface data from hapd_init()
1570 void (*hapd_deinit
)(void *priv
);
1573 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1574 * @priv: Private driver interface data
1575 * @params: BSS parameters
1576 * Returns: 0 on success, -1 on failure
1578 * This is an optional function to configure the kernel driver to
1579 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1580 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1581 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1582 * for Beacon frames.
1584 * DEPRECATED - use set_ap() instead
1586 int (*set_ieee8021x
)(void *priv
, struct wpa_bss_params
*params
);
1589 * set_privacy - Enable/disable privacy (AP only)
1590 * @priv: Private driver interface data
1591 * @enabled: 1 = privacy enabled, 0 = disabled
1592 * Returns: 0 on success, -1 on failure
1594 * This is an optional function to configure privacy field in the
1595 * kernel driver for Beacon frames. This can be left undefined (set to
1596 * %NULL) if the driver uses the Beacon template from set_ap().
1598 * DEPRECATED - use set_ap() instead
1600 int (*set_privacy
)(void *priv
, int enabled
);
1603 * get_seqnum - Fetch the current TSC/packet number (AP only)
1604 * @ifname: The interface name (main or virtual)
1605 * @priv: Private driver interface data
1606 * @addr: MAC address of the station or %NULL for group keys
1608 * @seq: Buffer for returning the latest used TSC/packet number
1609 * Returns: 0 on success, -1 on failure
1611 * This function is used to fetch the last used TSC/packet number for
1612 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1613 * keys, so there is no strict requirement on implementing support for
1614 * unicast keys (i.e., addr != %NULL).
1616 int (*get_seqnum
)(const char *ifname
, void *priv
, const u8
*addr
,
1620 * flush - Flush all association stations (AP only)
1621 * @priv: Private driver interface data
1622 * Returns: 0 on success, -1 on failure
1624 * This function requests the driver to disassociate all associated
1625 * stations. This function does not need to be implemented if the
1626 * driver does not process association frames internally.
1628 int (*flush
)(void *priv
);
1631 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1632 * @priv: Private driver interface data
1633 * @elem: Information elements
1634 * @elem_len: Length of the elem buffer in octets
1635 * Returns: 0 on success, -1 on failure
1637 * This is an optional function to add information elements in the
1638 * kernel driver for Beacon and Probe Response frames. This can be left
1639 * undefined (set to %NULL) if the driver uses the Beacon template from
1642 * DEPRECATED - use set_ap() instead
1644 int (*set_generic_elem
)(void *priv
, const u8
*elem
, size_t elem_len
);
1647 * read_sta_data - Fetch station data
1648 * @priv: Private driver interface data
1649 * @data: Buffer for returning station information
1650 * @addr: MAC address of the station
1651 * Returns: 0 on success, -1 on failure
1653 int (*read_sta_data
)(void *priv
, struct hostap_sta_driver_data
*data
,
1657 * hapd_send_eapol - Send an EAPOL packet (AP only)
1658 * @priv: private driver interface data
1659 * @addr: Destination MAC address
1660 * @data: EAPOL packet starting with IEEE 802.1X header
1661 * @data_len: Length of the EAPOL packet in octets
1662 * @encrypt: Whether the frame should be encrypted
1663 * @own_addr: Source MAC address
1664 * @flags: WPA_STA_* flags for the destination station
1666 * Returns: 0 on success, -1 on failure
1668 int (*hapd_send_eapol
)(void *priv
, const u8
*addr
, const u8
*data
,
1669 size_t data_len
, int encrypt
,
1670 const u8
*own_addr
, u32 flags
);
1673 * sta_deauth - Deauthenticate a station (AP only)
1674 * @priv: Private driver interface data
1675 * @own_addr: Source address and BSSID for the Deauthentication frame
1676 * @addr: MAC address of the station to deauthenticate
1677 * @reason: Reason code for the Deauthentiation frame
1678 * Returns: 0 on success, -1 on failure
1680 * This function requests a specific station to be deauthenticated and
1681 * a Deauthentication frame to be sent to it.
1683 int (*sta_deauth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
1687 * sta_disassoc - Disassociate a station (AP only)
1688 * @priv: Private driver interface data
1689 * @own_addr: Source address and BSSID for the Disassociation frame
1690 * @addr: MAC address of the station to disassociate
1691 * @reason: Reason code for the Disassociation frame
1692 * Returns: 0 on success, -1 on failure
1694 * This function requests a specific station to be disassociated and
1695 * a Disassociation frame to be sent to it.
1697 int (*sta_disassoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
1701 * sta_remove - Remove a station entry (AP only)
1702 * @priv: Private driver interface data
1703 * @addr: MAC address of the station to be removed
1704 * Returns: 0 on success, -1 on failure
1706 int (*sta_remove
)(void *priv
, const u8
*addr
);
1709 * hapd_get_ssid - Get the current SSID (AP only)
1710 * @priv: Private driver interface data
1711 * @buf: Buffer for returning the SSID
1712 * @len: Maximum length of the buffer
1713 * Returns: Length of the SSID on success, -1 on failure
1715 * This function need not be implemented if the driver uses Beacon
1716 * template from set_ap() and does not reply to Probe Request frames.
1718 int (*hapd_get_ssid
)(void *priv
, u8
*buf
, int len
);
1721 * hapd_set_ssid - Set SSID (AP only)
1722 * @priv: Private driver interface data
1724 * @len: Length of the SSID in octets
1725 * Returns: 0 on success, -1 on failure
1727 * DEPRECATED - use set_ap() instead
1729 int (*hapd_set_ssid
)(void *priv
, const u8
*buf
, int len
);
1732 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1733 * @priv: Private driver interface data
1734 * @enabled: 1 = countermeasures enabled, 0 = disabled
1735 * Returns: 0 on success, -1 on failure
1737 * This need not be implemented if the driver does not take care of
1738 * association processing.
1740 int (*hapd_set_countermeasures
)(void *priv
, int enabled
);
1743 * sta_add - Add a station entry
1744 * @priv: Private driver interface data
1745 * @params: Station parameters
1746 * Returns: 0 on success, -1 on failure
1748 * This function is used to add a station entry to the driver once the
1749 * station has completed association. This is only used if the driver
1750 * does not take care of association processing.
1752 * With TDLS, this function is also used to add or set (params->set 1)
1753 * TDLS peer entries.
1755 int (*sta_add
)(void *priv
, struct hostapd_sta_add_params
*params
);
1758 * get_inact_sec - Get station inactivity duration (AP only)
1759 * @priv: Private driver interface data
1760 * @addr: Station address
1761 * Returns: Number of seconds station has been inactive, -1 on failure
1763 int (*get_inact_sec
)(void *priv
, const u8
*addr
);
1766 * sta_clear_stats - Clear station statistics (AP only)
1767 * @priv: Private driver interface data
1768 * @addr: Station address
1769 * Returns: 0 on success, -1 on failure
1771 int (*sta_clear_stats
)(void *priv
, const u8
*addr
);
1774 * set_freq - Set channel/frequency (AP only)
1775 * @priv: Private driver interface data
1776 * @freq: Channel parameters
1777 * Returns: 0 on success, -1 on failure
1779 int (*set_freq
)(void *priv
, struct hostapd_freq_params
*freq
);
1782 * set_rts - Set RTS threshold
1783 * @priv: Private driver interface data
1784 * @rts: RTS threshold in octets
1785 * Returns: 0 on success, -1 on failure
1787 int (*set_rts
)(void *priv
, int rts
);
1790 * set_frag - Set fragmentation threshold
1791 * @priv: Private driver interface data
1792 * @frag: Fragmentation threshold in octets
1793 * Returns: 0 on success, -1 on failure
1795 int (*set_frag
)(void *priv
, int frag
);
1798 * sta_set_flags - Set station flags (AP only)
1799 * @priv: Private driver interface data
1800 * @addr: Station address
1801 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1802 * @flags_or: Bitmap of WPA_STA_* flags to add
1803 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1804 * Returns: 0 on success, -1 on failure
1806 int (*sta_set_flags
)(void *priv
, const u8
*addr
,
1807 int total_flags
, int flags_or
, int flags_and
);
1810 * set_tx_queue_params - Set TX queue parameters
1811 * @priv: Private driver interface data
1812 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
1816 * @burst_time: Maximum length for bursting in 0.1 msec units
1818 int (*set_tx_queue_params
)(void *priv
, int queue
, int aifs
, int cw_min
,
1819 int cw_max
, int burst_time
);
1822 * if_add - Add a virtual interface
1823 * @priv: Private driver interface data
1824 * @type: Interface type
1825 * @ifname: Interface name for the new virtual interface
1826 * @addr: Local address to use for the interface or %NULL to use the
1827 * parent interface address
1828 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1829 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1830 * not allowed (applies only to %WPA_IF_AP_BSS type)
1831 * @force_ifname: Buffer for returning an interface name that the
1832 * driver ended up using if it differs from the requested ifname
1833 * @if_addr: Buffer for returning the allocated interface address
1834 * (this may differ from the requested addr if the driver cannot
1835 * change interface address)
1836 * @bridge: Bridge interface to use or %NULL if no bridge configured
1837 * Returns: 0 on success, -1 on failure
1839 int (*if_add
)(void *priv
, enum wpa_driver_if_type type
,
1840 const char *ifname
, const u8
*addr
, void *bss_ctx
,
1841 void **drv_priv
, char *force_ifname
, u8
*if_addr
,
1842 const char *bridge
);
1845 * if_remove - Remove a virtual interface
1846 * @priv: Private driver interface data
1847 * @type: Interface type
1848 * @ifname: Interface name of the virtual interface to be removed
1849 * Returns: 0 on success, -1 on failure
1851 int (*if_remove
)(void *priv
, enum wpa_driver_if_type type
,
1852 const char *ifname
);
1855 * set_sta_vlan - Bind a station into a specific interface (AP only)
1856 * @priv: Private driver interface data
1857 * @ifname: Interface (main or virtual BSS or VLAN)
1858 * @addr: MAC address of the associated station
1860 * Returns: 0 on success, -1 on failure
1862 * This function is used to bind a station to a specific virtual
1863 * interface. It is only used if when virtual interfaces are supported,
1864 * e.g., to assign stations to different VLAN interfaces based on
1865 * information from a RADIUS server. This allows separate broadcast
1866 * domains to be used with a single BSS.
1868 int (*set_sta_vlan
)(void *priv
, const u8
*addr
, const char *ifname
,
1872 * commit - Optional commit changes handler (AP only)
1873 * @priv: driver private data
1874 * Returns: 0 on success, -1 on failure
1876 * This optional handler function can be registered if the driver
1877 * interface implementation needs to commit changes (e.g., by setting
1878 * network interface up) at the end of initial configuration. If set,
1879 * this handler will be called after initial setup has been completed.
1881 int (*commit
)(void *priv
);
1884 * send_ether - Send an ethernet packet (AP only)
1885 * @priv: private driver interface data
1886 * @dst: Destination MAC address
1887 * @src: Source MAC address
1889 * @data: EAPOL packet starting with IEEE 802.1X header
1890 * @data_len: Length of the EAPOL packet in octets
1891 * Returns: 0 on success, -1 on failure
1893 int (*send_ether
)(void *priv
, const u8
*dst
, const u8
*src
, u16 proto
,
1894 const u8
*data
, size_t data_len
);
1897 * set_radius_acl_auth - Notification of RADIUS ACL change
1898 * @priv: Private driver interface data
1899 * @mac: MAC address of the station
1900 * @accepted: Whether the station was accepted
1901 * @session_timeout: Session timeout for the station
1902 * Returns: 0 on success, -1 on failure
1904 int (*set_radius_acl_auth
)(void *priv
, const u8
*mac
, int accepted
,
1905 u32 session_timeout
);
1908 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1909 * @priv: Private driver interface data
1910 * @mac: MAC address of the station
1911 * Returns: 0 on success, -1 on failure
1913 int (*set_radius_acl_expire
)(void *priv
, const u8
*mac
);
1916 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
1917 * @priv: Private driver interface data
1918 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
1919 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
1921 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
1922 * to remove extra IE(s)
1923 * Returns: 0 on success, -1 on failure
1925 * This is an optional function to add WPS IE in the kernel driver for
1926 * Beacon and Probe Response frames. This can be left undefined (set
1927 * to %NULL) if the driver uses the Beacon template from set_ap()
1928 * and does not process Probe Request frames. If the driver takes care
1929 * of (Re)Association frame processing, the assocresp buffer includes
1930 * WPS IE(s) that need to be added to (Re)Association Response frames
1931 * whenever a (Re)Association Request frame indicated use of WPS.
1933 * This will also be used to add P2P IE(s) into Beacon/Probe Response
1934 * frames when operating as a GO. The driver is responsible for adding
1935 * timing related attributes (e.g., NoA) in addition to the IEs
1936 * included here by appending them after these buffers. This call is
1937 * also used to provide Probe Response IEs for P2P Listen state
1938 * operations for drivers that generate the Probe Response frames
1941 * DEPRECATED - use set_ap() instead
1943 int (*set_ap_wps_ie
)(void *priv
, const struct wpabuf
*beacon
,
1944 const struct wpabuf
*proberesp
,
1945 const struct wpabuf
*assocresp
);
1948 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1949 * @priv: Private driver interface data
1950 * @authorized: Whether the port is authorized
1951 * Returns: 0 on success, -1 on failure
1953 int (*set_supp_port
)(void *priv
, int authorized
);
1956 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1957 * @priv: Private driver interface data
1958 * @addr: MAC address of the associated station
1959 * @aid: Association ID
1960 * @val: 1 = bind to 4-address WDS; 0 = unbind
1961 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
1962 * to indicate that bridge is not to be used
1963 * Returns: 0 on success, -1 on failure
1965 int (*set_wds_sta
)(void *priv
, const u8
*addr
, int aid
, int val
,
1966 const char *bridge_ifname
);
1969 * send_action - Transmit an Action frame
1970 * @priv: Private driver interface data
1971 * @freq: Frequency (in MHz) of the channel
1972 * @wait: Time to wait off-channel for a response (in ms), or zero
1973 * @dst: Destination MAC address (Address 1)
1974 * @src: Source MAC address (Address 2)
1975 * @bssid: BSSID (Address 3)
1977 * @data_len: data length in octets
1978 @ @no_cck: Whether CCK rates must not be used to transmit this frame
1979 * Returns: 0 on success, -1 on failure
1981 * This command can be used to request the driver to transmit an action
1982 * frame to the specified destination.
1984 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
1985 * be transmitted on the given channel and the device will wait for a
1986 * response on that channel for the given wait time.
1988 * If the flag is not set, the wait time will be ignored. In this case,
1989 * if a remain-on-channel duration is in progress, the frame must be
1990 * transmitted on that channel; alternatively the frame may be sent on
1991 * the current operational channel (if in associated state in station
1992 * mode or while operating as an AP.)
1994 int (*send_action
)(void *priv
, unsigned int freq
, unsigned int wait
,
1995 const u8
*dst
, const u8
*src
, const u8
*bssid
,
1996 const u8
*data
, size_t data_len
, int no_cck
);
1999 * send_action_cancel_wait - Cancel action frame TX wait
2000 * @priv: Private driver interface data
2002 * This command cancels the wait time associated with sending an action
2003 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2004 * set in the driver flags.
2006 void (*send_action_cancel_wait
)(void *priv
);
2009 * remain_on_channel - Remain awake on a channel
2010 * @priv: Private driver interface data
2011 * @freq: Frequency (in MHz) of the channel
2012 * @duration: Duration in milliseconds
2013 * Returns: 0 on success, -1 on failure
2015 * This command is used to request the driver to remain awake on the
2016 * specified channel for the specified duration and report received
2017 * Action frames with EVENT_RX_ACTION events. Optionally, received
2018 * Probe Request frames may also be requested to be reported by calling
2019 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2021 * The driver may not be at the requested channel when this function
2022 * returns, i.e., the return code is only indicating whether the
2023 * request was accepted. The caller will need to wait until the
2024 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2025 * completed the channel change. This may take some time due to other
2026 * need for the radio and the caller should be prepared to timing out
2027 * its wait since there are no guarantees on when this request can be
2030 int (*remain_on_channel
)(void *priv
, unsigned int freq
,
2031 unsigned int duration
);
2034 * cancel_remain_on_channel - Cancel remain-on-channel operation
2035 * @priv: Private driver interface data
2037 * This command can be used to cancel a remain-on-channel operation
2038 * before its originally requested duration has passed. This could be
2039 * used, e.g., when remain_on_channel() is used to request extra time
2040 * to receive a response to an Action frame and the response is
2041 * received when there is still unneeded time remaining on the
2042 * remain-on-channel operation.
2044 int (*cancel_remain_on_channel
)(void *priv
);
2047 * probe_req_report - Request Probe Request frames to be indicated
2048 * @priv: Private driver interface data
2049 * @report: Whether to report received Probe Request frames
2050 * Returns: 0 on success, -1 on failure (or if not supported)
2052 * This command can be used to request the driver to indicate when
2053 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2054 * Since this operation may require extra resources, e.g., due to less
2055 * optimal hardware/firmware RX filtering, many drivers may disable
2056 * Probe Request reporting at least in station mode. This command is
2057 * used to notify the driver when the Probe Request frames need to be
2058 * reported, e.g., during remain-on-channel operations.
2060 int (*probe_req_report
)(void *priv
, int report
);
2063 * deinit_ap - Deinitialize AP mode
2064 * @priv: Private driver interface data
2065 * Returns: 0 on success, -1 on failure (or if not supported)
2067 * This optional function can be used to disable AP mode related
2068 * configuration and change the driver mode to station mode to allow
2069 * normal station operations like scanning to be completed.
2071 int (*deinit_ap
)(void *priv
);
2074 * deinit_p2p_cli - Deinitialize P2P client mode
2075 * @priv: Private driver interface data
2076 * Returns: 0 on success, -1 on failure (or if not supported)
2078 * This optional function can be used to disable P2P client mode. It
2079 * can be used to change the interface type back to station mode.
2081 int (*deinit_p2p_cli
)(void *priv
);
2084 * suspend - Notification on system suspend/hibernate event
2085 * @priv: Private driver interface data
2087 void (*suspend
)(void *priv
);
2090 * resume - Notification on system resume/thaw event
2091 * @priv: Private driver interface data
2093 void (*resume
)(void *priv
);
2096 * signal_monitor - Set signal monitoring parameters
2097 * @priv: Private driver interface data
2098 * @threshold: Threshold value for signal change events; 0 = disabled
2099 * @hysteresis: Minimum change in signal strength before indicating a
2101 * Returns: 0 on success, -1 on failure (or if not supported)
2103 * This function can be used to configure monitoring of signal strength
2104 * with the current AP. Whenever signal strength drops below the
2105 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2106 * should be generated assuming the signal strength has changed at
2107 * least %hysteresis from the previously indicated signal change event.
2109 int (*signal_monitor
)(void *priv
, int threshold
, int hysteresis
);
2112 * send_frame - Send IEEE 802.11 frame (testing use only)
2113 * @priv: Private driver interface data
2114 * @data: IEEE 802.11 frame with IEEE 802.11 header
2115 * @data_len: Size of the frame
2116 * @encrypt: Whether to encrypt the frame (if keys are set)
2117 * Returns: 0 on success, -1 on failure
2119 * This function is only used for debugging purposes and is not
2120 * required to be implemented for normal operations.
2122 int (*send_frame
)(void *priv
, const u8
*data
, size_t data_len
,
2126 * shared_freq - Get operating frequency of shared interface(s)
2127 * @priv: Private driver interface data
2128 * Returns: Operating frequency in MHz, 0 if no shared operation in
2129 * use, or -1 on failure
2131 * This command can be used to request the current operating frequency
2132 * of any virtual interface that shares the same radio to provide
2133 * information for channel selection for other virtual interfaces.
2135 int (*shared_freq
)(void *priv
);
2138 * get_noa - Get current Notice of Absence attribute payload
2139 * @priv: Private driver interface data
2140 * @buf: Buffer for returning NoA
2141 * @buf_len: Buffer length in octets
2142 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2143 * advertized, or -1 on failure
2145 * This function is used to fetch the current Notice of Absence
2146 * attribute value from GO.
2148 int (*get_noa
)(void *priv
, u8
*buf
, size_t buf_len
);
2151 * set_noa - Set Notice of Absence parameters for GO (testing)
2152 * @priv: Private driver interface data
2154 * @start: Start time in ms from next TBTT
2155 * @duration: Duration in ms
2156 * Returns: 0 on success or -1 on failure
2158 * This function is used to set Notice of Absence parameters for GO. It
2159 * is used only for testing. To disable NoA, all parameters are set to
2162 int (*set_noa
)(void *priv
, u8 count
, int start
, int duration
);
2165 * set_p2p_powersave - Set P2P power save options
2166 * @priv: Private driver interface data
2167 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2168 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2169 * @ctwindow: 0.. = change (msec), -1 = no change
2170 * Returns: 0 on success or -1 on failure
2172 int (*set_p2p_powersave
)(void *priv
, int legacy_ps
, int opp_ps
,
2176 * ampdu - Enable/disable aggregation
2177 * @priv: Private driver interface data
2178 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2179 * Returns: 0 on success or -1 on failure
2181 int (*ampdu
)(void *priv
, int ampdu
);
2184 * get_radio_name - Get physical radio name for the device
2185 * @priv: Private driver interface data
2186 * Returns: Radio name or %NULL if not known
2188 * The returned data must not be modified by the caller. It is assumed
2189 * that any interface that has the same radio name as another is
2190 * sharing the same physical radio. This information can be used to
2191 * share scan results etc. information between the virtual interfaces
2192 * to speed up various operations.
2194 const char * (*get_radio_name
)(void *priv
);
2197 * p2p_find - Start P2P Device Discovery
2198 * @priv: Private driver interface data
2199 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2200 * @type: Device Discovery type (enum p2p_discovery_type)
2201 * Returns: 0 on success, -1 on failure
2203 * This function is only used if the driver implements P2P management,
2204 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2205 * struct wpa_driver_capa.
2207 int (*p2p_find
)(void *priv
, unsigned int timeout
, int type
);
2210 * p2p_stop_find - Stop P2P Device Discovery
2211 * @priv: Private driver interface data
2212 * Returns: 0 on success, -1 on failure
2214 * This function is only used if the driver implements P2P management,
2215 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2216 * struct wpa_driver_capa.
2218 int (*p2p_stop_find
)(void *priv
);
2221 * p2p_listen - Start P2P Listen state for specified duration
2222 * @priv: Private driver interface data
2223 * @timeout: Listen state duration in milliseconds
2224 * Returns: 0 on success, -1 on failure
2226 * This function can be used to request the P2P module to keep the
2227 * device discoverable on the listen channel for an extended set of
2228 * time. At least in its current form, this is mainly used for testing
2229 * purposes and may not be of much use for normal P2P operations.
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_listen
)(void *priv
, unsigned int timeout
);
2238 * p2p_connect - Start P2P group formation (GO negotiation)
2239 * @priv: Private driver interface data
2240 * @peer_addr: MAC address of the peer P2P client
2241 * @wps_method: enum p2p_wps_method value indicating config method
2242 * @go_intent: Local GO intent value (1..15)
2243 * @own_interface_addr: Intended interface address to use with the
2245 * @force_freq: The only allowed channel frequency in MHz or 0
2246 * @persistent_group: Whether to create persistent group
2247 * Returns: 0 on success, -1 on failure
2249 * This function is only used if the driver implements P2P management,
2250 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2251 * struct wpa_driver_capa.
2253 int (*p2p_connect
)(void *priv
, const u8
*peer_addr
, int wps_method
,
2254 int go_intent
, const u8
*own_interface_addr
,
2255 unsigned int force_freq
, int persistent_group
);
2258 * wps_success_cb - Report successfully completed WPS provisioning
2259 * @priv: Private driver interface data
2260 * @peer_addr: Peer address
2261 * Returns: 0 on success, -1 on failure
2263 * This function is used to report successfully completed WPS
2264 * provisioning during group formation in both GO/Registrar and
2265 * client/Enrollee roles.
2267 * This function is only used if the driver implements P2P management,
2268 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2269 * struct wpa_driver_capa.
2271 int (*wps_success_cb
)(void *priv
, const u8
*peer_addr
);
2274 * p2p_group_formation_failed - Report failed WPS provisioning
2275 * @priv: Private driver interface data
2276 * Returns: 0 on success, -1 on failure
2278 * This function is used to report failed group formation. This can
2279 * happen either due to failed WPS provisioning or due to 15 second
2280 * timeout during the provisioning phase.
2282 * This function is only used if the driver implements P2P management,
2283 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2284 * struct wpa_driver_capa.
2286 int (*p2p_group_formation_failed
)(void *priv
);
2289 * p2p_set_params - Set P2P parameters
2290 * @priv: Private driver interface data
2291 * @params: P2P parameters
2292 * Returns: 0 on success, -1 on failure
2294 * This function is only used if the driver implements P2P management,
2295 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2296 * struct wpa_driver_capa.
2298 int (*p2p_set_params
)(void *priv
, const struct p2p_params
*params
);
2301 * p2p_prov_disc_req - Send Provision Discovery Request
2302 * @priv: Private driver interface data
2303 * @peer_addr: MAC address of the peer P2P client
2304 * @config_methods: WPS Config Methods value (only one bit set)
2305 * Returns: 0 on success, -1 on failure
2307 * This function can be used to request a discovered P2P peer to
2308 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2309 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2310 * Provision Discovery Request frame is transmitted once immediately
2311 * and if no response is received, the frame will be sent again
2312 * whenever the target device is discovered during device dsicovery
2313 * (start with a p2p_find() call). Response from the peer is indicated
2314 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
2316 * This function is only used if the driver implements P2P management,
2317 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2318 * struct wpa_driver_capa.
2320 int (*p2p_prov_disc_req
)(void *priv
, const u8
*peer_addr
,
2321 u16 config_methods
, int join
);
2324 * p2p_sd_request - Schedule a service discovery query
2325 * @priv: Private driver interface data
2326 * @dst: Destination peer or %NULL to apply for all peers
2327 * @tlvs: P2P Service Query TLV(s)
2328 * Returns: Reference to the query or 0 on failure
2330 * Response to the query is indicated with the
2331 * EVENT_P2P_SD_RESPONSE driver event.
2333 * This function is only used if the driver implements P2P management,
2334 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2335 * struct wpa_driver_capa.
2337 u64 (*p2p_sd_request
)(void *priv
, const u8
*dst
,
2338 const struct wpabuf
*tlvs
);
2341 * p2p_sd_cancel_request - Cancel a pending service discovery query
2342 * @priv: Private driver interface data
2343 * @req: Query reference from p2p_sd_request()
2344 * Returns: 0 on success, -1 on failure
2346 * This function is only used if the driver implements P2P management,
2347 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2348 * struct wpa_driver_capa.
2350 int (*p2p_sd_cancel_request
)(void *priv
, u64 req
);
2353 * p2p_sd_response - Send response to a service discovery query
2354 * @priv: Private driver interface data
2355 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2356 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2357 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2358 * @resp_tlvs: P2P Service Response TLV(s)
2359 * Returns: 0 on success, -1 on failure
2361 * This function is called as a response to the request indicated with
2362 * the EVENT_P2P_SD_REQUEST driver event.
2364 * This function is only used if the driver implements P2P management,
2365 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2366 * struct wpa_driver_capa.
2368 int (*p2p_sd_response
)(void *priv
, int freq
, const u8
*dst
,
2370 const struct wpabuf
*resp_tlvs
);
2373 * p2p_service_update - Indicate a change in local services
2374 * @priv: Private driver interface data
2375 * Returns: 0 on success, -1 on failure
2377 * This function needs to be called whenever there is a change in
2378 * availability of the local services. This will increment the
2379 * Service Update Indicator value which will be used in SD Request and
2382 * This function is only used if the driver implements P2P management,
2383 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2384 * struct wpa_driver_capa.
2386 int (*p2p_service_update
)(void *priv
);
2389 * p2p_reject - Reject peer device (explicitly block connections)
2390 * @priv: Private driver interface data
2391 * @addr: MAC address of the peer
2392 * Returns: 0 on success, -1 on failure
2394 int (*p2p_reject
)(void *priv
, const u8
*addr
);
2397 * p2p_invite - Invite a P2P Device into a group
2398 * @priv: Private driver interface data
2399 * @peer: Device Address of the peer P2P Device
2400 * @role: Local role in the group
2401 * @bssid: Group BSSID or %NULL if not known
2403 * @ssid_len: Length of ssid in octets
2404 * @go_dev_addr: Forced GO Device Address or %NULL if none
2405 * @persistent_group: Whether this is to reinvoke a persistent group
2406 * Returns: 0 on success, -1 on failure
2408 int (*p2p_invite
)(void *priv
, const u8
*peer
, int role
,
2409 const u8
*bssid
, const u8
*ssid
, size_t ssid_len
,
2410 const u8
*go_dev_addr
, int persistent_group
);
2413 * send_tdls_mgmt - for sending TDLS management packets
2414 * @priv: private driver interface data
2415 * @dst: Destination (peer) MAC address
2416 * @action_code: TDLS action code for the mssage
2417 * @dialog_token: Dialog Token to use in the message (if needed)
2418 * @status_code: Status Code or Reason Code to use (if needed)
2419 * @buf: TDLS IEs to add to the message
2420 * @len: Length of buf in octets
2421 * Returns: 0 on success, negative (<0) on failure
2423 * This optional function can be used to send packet to driver which is
2424 * responsible for receiving and sending all TDLS packets.
2426 int (*send_tdls_mgmt
)(void *priv
, const u8
*dst
, u8 action_code
,
2427 u8 dialog_token
, u16 status_code
,
2428 const u8
*buf
, size_t len
);
2431 * tdls_oper - Ask the driver to perform high-level TDLS operations
2432 * @priv: Private driver interface data
2433 * @oper: TDLS high-level operation. See %enum tdls_oper
2434 * @peer: Destination (peer) MAC address
2435 * Returns: 0 on success, negative (<0) on failure
2437 * This optional function can be used to send high-level TDLS commands
2440 int (*tdls_oper
)(void *priv
, enum tdls_oper oper
, const u8
*peer
);
2443 * wnm_oper - Notify driver of the WNM frame reception
2444 * @priv: Private driver interface data
2445 * @oper: WNM operation. See %enum wnm_oper
2446 * @peer: Destination (peer) MAC address
2447 * @buf: Buffer for the driver to fill in (for getting IE)
2448 * @buf_len: Return the len of buf
2449 * Returns: 0 on success, negative (<0) on failure
2451 int (*wnm_oper
)(void *priv
, enum wnm_oper oper
, const u8
*peer
,
2452 u8
*buf
, u16
*buf_len
);
2455 * signal_poll - Get current connection information
2456 * @priv: Private driver interface data
2457 * @signal_info: Connection info structure
2459 int (*signal_poll
)(void *priv
, struct wpa_signal_info
*signal_info
);
2462 * set_authmode - Set authentication algorithm(s) for static WEP
2463 * @priv: Private driver interface data
2464 * @authmode: 1=Open System, 2=Shared Key, 3=both
2465 * Returns: 0 on success, -1 on failure
2467 * This function can be used to set authentication algorithms for AP
2468 * mode when static WEP is used. If the driver uses user space MLME/SME
2469 * implementation, there is no need to implement this function.
2471 * DEPRECATED - use set_ap() instead
2473 int (*set_authmode
)(void *priv
, int authmode
);
2476 * set_rekey_info - Set rekey information
2477 * @priv: Private driver interface data
2480 * @replay_ctr: Current EAPOL-Key Replay Counter
2482 * This optional function can be used to provide information for the
2483 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2484 * while the host (including wpa_supplicant) is sleeping.
2486 void (*set_rekey_info
)(void *priv
, const u8
*kek
, const u8
*kck
,
2487 const u8
*replay_ctr
);
2490 * sta_assoc - Station association indication
2491 * @priv: Private driver interface data
2492 * @own_addr: Source address and BSSID for association frame
2493 * @addr: MAC address of the station to associate
2494 * @reassoc: flag to indicate re-association
2495 * @status: association response status code
2496 * @ie: assoc response ie buffer
2497 * @len: ie buffer length
2498 * Returns: 0 on success, -1 on failure
2500 * This function indicates the driver to send (Re)Association
2501 * Response frame to the station.
2503 int (*sta_assoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2504 int reassoc
, u16 status
, const u8
*ie
, size_t len
);
2507 * sta_auth - Station authentication indication
2508 * @priv: Private driver interface data
2509 * @own_addr: Source address and BSSID for authentication frame
2510 * @addr: MAC address of the station to associate
2511 * @seq: authentication sequence number
2512 * @status: authentication response status code
2513 * @ie: authentication frame ie buffer
2514 * @len: ie buffer length
2516 * This function indicates the driver to send Authentication frame
2519 int (*sta_auth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2520 u16 seq
, u16 status
, const u8
*ie
, size_t len
);
2523 * add_tspec - Add traffic stream
2524 * @priv: Private driver interface data
2525 * @addr: MAC address of the station to associate
2526 * @tspec_ie: tspec ie buffer
2527 * @tspec_ielen: tspec ie length
2528 * Returns: 0 on success, -1 on failure
2530 * This function adds the traffic steam for the station
2531 * and fills the medium_time in tspec_ie.
2533 int (*add_tspec
)(void *priv
, const u8
*addr
, u8
*tspec_ie
,
2534 size_t tspec_ielen
);
2537 * add_sta_node - Add a station node in the driver
2538 * @priv: Private driver interface data
2539 * @addr: MAC address of the station to add
2540 * @auth_alg: authentication algorithm used by the station
2541 * Returns: 0 on success, -1 on failure
2543 * This function adds the station node in the driver, when
2544 * the station gets added by FT-over-DS.
2546 int (*add_sta_node
)(void *priv
, const u8
*addr
, u16 auth_alg
);
2549 * sched_scan - Request the driver to initiate scheduled scan
2550 * @priv: Private driver interface data
2551 * @params: Scan parameters
2552 * @interval: Interval between scan cycles in milliseconds
2553 * Returns: 0 on success, -1 on failure
2555 * This operation should be used for scheduled scan offload to
2556 * the hardware. Every time scan results are available, the
2557 * driver should report scan results event for wpa_supplicant
2558 * which will eventually request the results with
2559 * wpa_driver_get_scan_results2(). This operation is optional
2560 * and if not provided or if it returns -1, we fall back to
2561 * normal host-scheduled scans.
2563 int (*sched_scan
)(void *priv
, struct wpa_driver_scan_params
*params
,
2567 * stop_sched_scan - Request the driver to stop a scheduled scan
2568 * @priv: Private driver interface data
2569 * Returns: 0 on success, -1 on failure
2571 * This should cause the scheduled scan to be stopped and
2572 * results should stop being sent. Must be supported if
2573 * sched_scan is supported.
2575 int (*stop_sched_scan
)(void *priv
);
2578 * poll_client - Probe (null data or such) the given station
2579 * @priv: Private driver interface data
2580 * @own_addr: MAC address of sending interface
2581 * @addr: MAC address of the station to probe
2582 * @qos: Indicates whether station is QoS station
2584 * This function is used to verify whether an associated station is
2585 * still present. This function does not need to be implemented if the
2586 * driver provides such inactivity polling mechanism.
2588 void (*poll_client
)(void *priv
, const u8
*own_addr
,
2589 const u8
*addr
, int qos
);
2592 * radio_disable - Disable/enable radio
2593 * @priv: Private driver interface data
2594 * @disabled: 1=disable 0=enable radio
2595 * Returns: 0 on success, -1 on failure
2597 * This optional command is for testing purposes. It can be used to
2598 * disable the radio on a testbed device to simulate out-of-radio-range
2601 int (*radio_disable
)(void *priv
, int disabled
);
2604 * switch_channel - Announce channel switch and migrate the GO to the
2606 * @priv: Private driver interface data
2607 * @freq: Frequency in MHz
2608 * Returns: 0 on success, -1 on failure
2610 * This function is used to move the GO to the legacy STA channel to
2611 * avoid frequency conflict in single channel concurrency.
2613 int (*switch_channel
)(void *priv
, unsigned int freq
);
2618 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2620 enum wpa_event_type
{
2622 * EVENT_ASSOC - Association completed
2624 * This event needs to be delivered when the driver completes IEEE
2625 * 802.11 association or reassociation successfully.
2626 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2627 * after this event has been generated. In addition, optional
2628 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2629 * more information about the association. If the driver interface gets
2630 * both of these events at the same time, it can also include the
2631 * assoc_info data in EVENT_ASSOC call.
2636 * EVENT_DISASSOC - Association lost
2638 * This event should be called when association is lost either due to
2639 * receiving deauthenticate or disassociate frame from the AP or when
2640 * sending either of these frames to the current AP. If the driver
2641 * supports separate deauthentication event, EVENT_DISASSOC should only
2642 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2643 * In AP mode, union wpa_event_data::disassoc_info is required.
2648 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2650 * This event must be delivered when a Michael MIC error is detected by
2651 * the local driver. Additional data for event processing is
2652 * provided with union wpa_event_data::michael_mic_failure. This
2653 * information is used to request new encyption key and to initiate
2654 * TKIP countermeasures if needed.
2656 EVENT_MICHAEL_MIC_FAILURE
,
2659 * EVENT_SCAN_RESULTS - Scan results available
2661 * This event must be called whenever scan results are available to be
2662 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2663 * is expected to be used some time after struct wpa_driver_ops::scan()
2664 * is called. If the driver provides an unsolicited event when the scan
2665 * has been completed, this event can be used to trigger
2666 * EVENT_SCAN_RESULTS call. If such event is not available from the
2667 * driver, the driver wrapper code is expected to use a registered
2668 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2669 * scan is expected to be completed. Optional information about
2670 * completed scan can be provided with union wpa_event_data::scan_info.
2675 * EVENT_ASSOCINFO - Report optional extra information for association
2677 * This event can be used to report extra association information for
2678 * EVENT_ASSOC processing. This extra information includes IEs from
2679 * association frames and Beacon/Probe Response frames in union
2680 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2681 * EVENT_ASSOC. Alternatively, the driver interface can include
2682 * assoc_info data in the EVENT_ASSOC call if it has all the
2683 * information available at the same point.
2688 * EVENT_INTERFACE_STATUS - Report interface status changes
2690 * This optional event can be used to report changes in interface
2691 * status (interface added/removed) using union
2692 * wpa_event_data::interface_status. This can be used to trigger
2693 * wpa_supplicant to stop and re-start processing for the interface,
2694 * e.g., when a cardbus card is ejected/inserted.
2696 EVENT_INTERFACE_STATUS
,
2699 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2701 * This event can be used to inform wpa_supplicant about candidates for
2702 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2703 * for scan request (ap_scan=2 mode), this event is required for
2704 * pre-authentication. If wpa_supplicant is performing scan request
2705 * (ap_scan=1), this event is optional since scan results can be used
2706 * to add pre-authentication candidates. union
2707 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2708 * candidate and priority of the candidate, e.g., based on the signal
2709 * strength, in order to try to pre-authenticate first with candidates
2710 * that are most likely targets for re-association.
2712 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2713 * on the candidate list. In addition, it can be called for the current
2714 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2715 * will automatically skip pre-authentication in cases where a valid
2716 * PMKSA exists. When more than one candidate exists, this event should
2717 * be generated once for each candidate.
2719 * Driver will be notified about successful pre-authentication with
2720 * struct wpa_driver_ops::add_pmkid() calls.
2722 EVENT_PMKID_CANDIDATE
,
2725 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2727 * This event can be used to inform wpa_supplicant about desire to set
2728 * up secure direct link connection between two stations as defined in
2729 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2730 * STAKey negotiation. The caller will need to set peer address for the
2736 * EVENT_TDLS - Request TDLS operation
2738 * This event can be used to request a TDLS operation to be performed.
2743 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2745 * The driver is expected to report the received FT IEs from
2746 * FT authentication sequence from the AP. The FT IEs are included in
2747 * the extra information in union wpa_event_data::ft_ies.
2752 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2754 * The driver can use this event to inform wpa_supplicant about a STA
2755 * in an IBSS with which protected frames could be exchanged. This
2756 * event starts RSN authentication with the other STA to authenticate
2757 * the STA and set up encryption keys with it.
2759 EVENT_IBSS_RSN_START
,
2762 * EVENT_AUTH - Authentication result
2764 * This event should be called when authentication attempt has been
2765 * completed. This is only used if the driver supports separate
2766 * authentication step (struct wpa_driver_ops::authenticate).
2767 * Information about authentication result is included in
2768 * union wpa_event_data::auth.
2773 * EVENT_DEAUTH - Authentication lost
2775 * This event should be called when authentication is lost either due
2776 * to receiving deauthenticate frame from the AP or when sending that
2777 * frame to the current AP.
2778 * In AP mode, union wpa_event_data::deauth_info is required.
2783 * EVENT_ASSOC_REJECT - Association rejected
2785 * This event should be called when (re)association attempt has been
2786 * rejected by the AP. Information about the association response is
2787 * included in union wpa_event_data::assoc_reject.
2792 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2794 EVENT_AUTH_TIMED_OUT
,
2797 * EVENT_ASSOC_TIMED_OUT - Association timed out
2799 EVENT_ASSOC_TIMED_OUT
,
2802 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2807 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2809 EVENT_WPS_BUTTON_PUSHED
,
2812 * EVENT_TX_STATUS - Report TX status
2817 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2819 EVENT_RX_FROM_UNKNOWN
,
2822 * EVENT_RX_MGMT - Report RX of a management frame
2827 * EVENT_RX_ACTION - Action frame received
2829 * This event is used to indicate when an Action frame has been
2830 * received. Information about the received frame is included in
2831 * union wpa_event_data::rx_action.
2836 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2838 * This event is used to indicate when the driver has started the
2839 * requested remain-on-channel duration. Information about the
2840 * operation is included in union wpa_event_data::remain_on_channel.
2842 EVENT_REMAIN_ON_CHANNEL
,
2845 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2847 * This event is used to indicate when the driver has completed
2848 * remain-on-channel duration, i.e., may noot be available on the
2849 * requested channel anymore. Information about the
2850 * operation is included in union wpa_event_data::remain_on_channel.
2852 EVENT_CANCEL_REMAIN_ON_CHANNEL
,
2855 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2857 * This event is used only by driver_test.c and userspace MLME.
2862 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2864 * This event is used to indicate when a Probe Request frame has been
2865 * received. Information about the received frame is included in
2866 * union wpa_event_data::rx_probe_req. The driver is required to report
2867 * these events only after successfully completed probe_req_report()
2868 * commands to request the events (i.e., report parameter is non-zero)
2869 * in station mode. In AP mode, Probe Request frames should always be
2875 * EVENT_NEW_STA - New wired device noticed
2877 * This event is used to indicate that a new device has been detected
2878 * in a network that does not use association-like functionality (i.e.,
2879 * mainly wired Ethernet). This can be used to start EAPOL
2880 * authenticator when receiving a frame from a device. The address of
2881 * the device is included in union wpa_event_data::new_sta.
2886 * EVENT_EAPOL_RX - Report received EAPOL frame
2888 * When in AP mode with hostapd, this event is required to be used to
2889 * deliver the receive EAPOL frames from the driver. With
2890 * %wpa_supplicant, this event is used only if the send_eapol() handler
2891 * is used to override the use of l2_packet for EAPOL frame TX.
2896 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
2898 * This event is used to indicate changes in the signal strength
2899 * observed in frames received from the current AP if signal strength
2900 * monitoring has been enabled with signal_monitor().
2902 EVENT_SIGNAL_CHANGE
,
2905 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
2907 * This event is used to indicate that the interface was enabled after
2908 * having been previously disabled, e.g., due to rfkill.
2910 EVENT_INTERFACE_ENABLED
,
2913 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
2915 * This event is used to indicate that the interface was disabled,
2916 * e.g., due to rfkill.
2918 EVENT_INTERFACE_DISABLED
,
2921 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
2923 * This event is used to indicate that the channel list has changed,
2924 * e.g., because of a regulatory domain change triggered by scan
2925 * results including an AP advertising a country code.
2927 EVENT_CHANNEL_LIST_CHANGED
,
2930 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
2932 * This event is used to indicate that the driver cannot maintain this
2933 * interface in its operation mode anymore. The most likely use for
2934 * this is to indicate that AP mode operation is not available due to
2935 * operating channel would need to be changed to a DFS channel when
2936 * the driver does not support radar detection and another virtual
2937 * interfaces caused the operating channel to change. Other similar
2938 * resource conflicts could also trigger this for station mode
2941 EVENT_INTERFACE_UNAVAILABLE
,
2944 * EVENT_BEST_CHANNEL
2946 * Driver generates this event whenever it detects a better channel
2947 * (e.g., based on RSSI or channel use). This information can be used
2948 * to improve channel selection for a new AP/P2P group.
2953 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
2955 * This event should be called when a Deauthentication frame is dropped
2956 * due to it not being protected (MFP/IEEE 802.11w).
2957 * union wpa_event_data::unprot_deauth is required to provide more
2958 * details of the frame.
2960 EVENT_UNPROT_DEAUTH
,
2963 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
2965 * This event should be called when a Disassociation frame is dropped
2966 * due to it not being protected (MFP/IEEE 802.11w).
2967 * union wpa_event_data::unprot_disassoc is required to provide more
2968 * details of the frame.
2970 EVENT_UNPROT_DISASSOC
,
2973 * EVENT_STATION_LOW_ACK
2975 * Driver generates this event whenever it detected that a particular
2976 * station was lost. Detection can be through massive transmission
2977 * failures for example.
2979 EVENT_STATION_LOW_ACK
,
2982 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
2984 * This event is used only if the driver implements P2P management
2985 * internally. Event data is stored in
2986 * union wpa_event_data::p2p_dev_found.
2988 EVENT_P2P_DEV_FOUND
,
2991 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
2993 * This event is used only if the driver implements P2P management
2994 * internally. Event data is stored in
2995 * union wpa_event_data::p2p_go_neg_req_rx.
2997 EVENT_P2P_GO_NEG_REQ_RX
,
3000 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
3002 * This event is used only if the driver implements P2P management
3003 * internally. Event data is stored in
3004 * union wpa_event_data::p2p_go_neg_completed.
3006 EVENT_P2P_GO_NEG_COMPLETED
,
3008 EVENT_P2P_PROV_DISC_REQUEST
,
3009 EVENT_P2P_PROV_DISC_RESPONSE
,
3010 EVENT_P2P_SD_REQUEST
,
3011 EVENT_P2P_SD_RESPONSE
,
3014 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3016 EVENT_IBSS_PEER_LOST
,
3019 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3021 * This event carries the new replay counter to notify wpa_supplicant
3022 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3023 * completed Group Key Handshake while the host (including
3024 * wpa_supplicant was sleeping).
3026 EVENT_DRIVER_GTK_REKEY
,
3029 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3031 EVENT_SCHED_SCAN_STOPPED
,
3034 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3036 * This event indicates that the station responded to the poll
3037 * initiated with @poll_client.
3039 EVENT_DRIVER_CLIENT_POLL_OK
,
3042 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3044 EVENT_EAPOL_TX_STATUS
,
3047 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3049 * Described in wpa_event_data.ch_switch
3054 * EVENT_WNM - Request WNM operation
3056 * This event can be used to request a WNM operation to be performed.
3063 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3065 union wpa_event_data
{
3067 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3069 * This structure is optional for EVENT_ASSOC calls and required for
3070 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3071 * driver interface does not need to generate separate EVENT_ASSOCINFO
3076 * reassoc - Flag to indicate association or reassociation
3081 * req_ies - (Re)Association Request IEs
3083 * If the driver generates WPA/RSN IE, this event data must be
3084 * returned for WPA handshake to have needed information. If
3085 * wpa_supplicant-generated WPA/RSN IE is used, this
3086 * information event is optional.
3088 * This should start with the first IE (fixed fields before IEs
3089 * are not included).
3094 * req_ies_len - Length of req_ies in bytes
3099 * resp_ies - (Re)Association Response IEs
3101 * Optional association data from the driver. This data is not
3102 * required WPA, but may be useful for some protocols and as
3103 * such, should be reported if this is available to the driver
3106 * This should start with the first IE (fixed fields before IEs
3107 * are not included).
3112 * resp_ies_len - Length of resp_ies in bytes
3114 size_t resp_ies_len
;
3117 * beacon_ies - Beacon or Probe Response IEs
3119 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3120 * Probe Response frames from the current AP (i.e., the one
3121 * that the client just associated with). This information is
3122 * used to update WPA/RSN IE for the AP. If this field is not
3123 * set, the results from previous scan will be used. If no
3124 * data for the new AP is found, scan results will be requested
3125 * again (without scan request). At this point, the driver is
3126 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3129 * This should start with the first IE (fixed fields before IEs
3130 * are not included).
3132 const u8
*beacon_ies
;
3135 * beacon_ies_len - Length of beacon_ies */
3136 size_t beacon_ies_len
;
3139 * freq - Frequency of the operational channel in MHz
3144 * addr - Station address (for AP mode)
3150 * struct disassoc_info - Data for EVENT_DISASSOC events
3152 struct disassoc_info
{
3154 * addr - Station address (for AP mode)
3159 * reason_code - Reason Code (host byte order) used in
3160 * Deauthentication frame
3165 * ie - Optional IE(s) in Disassociation frame
3170 * ie_len - Length of ie buffer in octets
3175 * locally_generated - Whether the frame was locally generated
3177 int locally_generated
;
3181 * struct deauth_info - Data for EVENT_DEAUTH events
3183 struct deauth_info
{
3185 * addr - Station address (for AP mode)
3190 * reason_code - Reason Code (host byte order) used in
3191 * Deauthentication frame
3196 * ie - Optional IE(s) in Deauthentication frame
3201 * ie_len - Length of ie buffer in octets
3206 * locally_generated - Whether the frame was locally generated
3208 int locally_generated
;
3212 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3214 struct michael_mic_failure
{
3217 } michael_mic_failure
;
3220 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3222 struct interface_status
{
3225 EVENT_INTERFACE_ADDED
, EVENT_INTERFACE_REMOVED
3230 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3232 struct pmkid_candidate
{
3233 /** BSSID of the PMKID candidate */
3235 /** Smaller the index, higher the priority */
3237 /** Whether RSN IE includes pre-authenticate flag */
3242 * struct stkstart - Data for EVENT_STKSTART
3249 * struct tdls - Data for EVENT_TDLS
3255 TDLS_REQUEST_TEARDOWN
3257 u16 reason_code
; /* for teardown */
3261 * struct wnm - Data for EVENT_WNM
3279 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3281 * During FT (IEEE 802.11r) authentication sequence, the driver is
3282 * expected to use this event to report received FT IEs (MDIE, FTIE,
3283 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3284 * IEs for the next message will be delivered through the
3285 * struct wpa_driver_ops::update_ft_ies() callback.
3291 u8 target_ap
[ETH_ALEN
];
3292 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3294 /** Length of ric_ies buffer in octets */
3299 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3301 struct ibss_rsn_start
{
3306 * struct auth_info - Data for EVENT_AUTH events
3312 u16 auth_transaction
;
3319 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3321 struct assoc_reject
{
3323 * bssid - BSSID of the AP that rejected association
3328 * resp_ies - (Re)Association Response IEs
3330 * Optional association data from the driver. This data is not
3331 * required WPA, but may be useful for some protocols and as
3332 * such, should be reported if this is available to the driver
3335 * This should start with the first IE (fixed fields before IEs
3336 * are not included).
3341 * resp_ies_len - Length of resp_ies in bytes
3343 size_t resp_ies_len
;
3346 * status_code - Status Code from (Re)association Response
3351 struct timeout_event
{
3356 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3365 * struct tx_status - Data for EVENT_TX_STATUS events
3377 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3379 struct rx_from_unknown
{
3386 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3392 int ssi_signal
; /* dBm */
3396 * struct rx_action - Data for EVENT_RX_ACTION events
3400 * da - Destination address of the received Action frame
3405 * sa - Source address of the received Action frame
3410 * bssid - Address 3 of the received Action frame
3415 * category - Action frame category
3420 * data - Action frame body after category field
3425 * len - Length of data in octets
3430 * freq - Frequency (in MHz) on which the frame was received
3436 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3438 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3440 struct remain_on_channel
{
3442 * freq - Channel frequency in MHz
3447 * duration - Duration to remain on the channel in milliseconds
3449 unsigned int duration
;
3450 } remain_on_channel
;
3453 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3454 * @aborted: Whether the scan was aborted
3455 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3456 * @num_freqs: Number of entries in freqs array
3457 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3459 * @num_ssids: Number of entries in ssids array
3465 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
3470 * struct mlme_rx - Data for EVENT_MLME_RX events
3481 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3483 struct rx_probe_req
{
3485 * sa - Source address of the received Probe Request frame
3490 * da - Destination address of the received Probe Request frame
3491 * or %NULL if not available
3496 * bssid - BSSID of the received Probe Request frame or %NULL
3502 * ie - IEs from the Probe Request body
3507 * ie_len - Length of ie buffer in octets
3512 * signal - signal strength in dBm (or 0 if not available)
3518 * struct new_sta - Data for EVENT_NEW_STA events
3525 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3534 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3536 struct wpa_signal_info signal_change
;
3539 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3540 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3541 * @freq_5: Best 5 GHz band channel frequency in MHz
3542 * @freq_overall: Best channel frequency in MHz
3544 * 0 can be used to indicate no preference in either band.
3546 struct best_channel
{
3552 struct unprot_deauth
{
3558 struct unprot_disassoc
{
3565 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3566 * @addr: station address
3573 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3575 struct p2p_dev_found
{
3578 const u8
*pri_dev_type
;
3579 const char *dev_name
;
3586 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3588 struct p2p_go_neg_req_rx
{
3591 } p2p_go_neg_req_rx
;
3594 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3596 struct p2p_go_neg_completed
{
3597 struct p2p_go_neg_results
*res
;
3598 } p2p_go_neg_completed
;
3600 struct p2p_prov_disc_req
{
3604 const u8
*pri_dev_type
;
3605 const char *dev_name
;
3606 u16 supp_config_methods
;
3609 } p2p_prov_disc_req
;
3611 struct p2p_prov_disc_resp
{
3614 } p2p_prov_disc_resp
;
3625 struct p2p_sd_resp
{
3633 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3635 struct ibss_peer_lost
{
3640 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3642 struct driver_gtk_rekey
{
3644 const u8
*replay_ctr
;
3648 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
3649 * @addr: station address
3651 struct client_poll
{
3656 * struct eapol_tx_status
3657 * @dst: Original destination
3658 * @data: Data starting with IEEE 802.1X header (!)
3659 * @data_len: Length of data
3660 * @ack: Indicates ack or lost frame
3662 * This corresponds to hapd_send_eapol if the frame sent
3663 * there isn't just reported as EVENT_TX_STATUS.
3665 struct eapol_tx_status
{
3674 * @freq: Frequency of new channel in MHz
3675 * @ht_enabled: Whether this is an HT channel
3676 * @ch_offset: Secondary channel offset
3686 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3687 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3688 * with struct wpa_driver_ops::init()
3689 * @event: event type (defined above)
3690 * @data: possible extra data for the event
3692 * Driver wrapper code should call this function whenever an event is received
3695 void wpa_supplicant_event(void *ctx
, enum wpa_event_type event
,
3696 union wpa_event_data
*data
);
3700 * The following inline functions are provided for convenience to simplify
3701 * event indication for some of the common events.
3704 static inline void drv_event_assoc(void *ctx
, const u8
*addr
, const u8
*ie
,
3705 size_t ielen
, int reassoc
)
3707 union wpa_event_data event
;
3708 os_memset(&event
, 0, sizeof(event
));
3709 event
.assoc_info
.reassoc
= reassoc
;
3710 event
.assoc_info
.req_ies
= ie
;
3711 event
.assoc_info
.req_ies_len
= ielen
;
3712 event
.assoc_info
.addr
= addr
;
3713 wpa_supplicant_event(ctx
, EVENT_ASSOC
, &event
);
3716 static inline void drv_event_disassoc(void *ctx
, const u8
*addr
)
3718 union wpa_event_data event
;
3719 os_memset(&event
, 0, sizeof(event
));
3720 event
.disassoc_info
.addr
= addr
;
3721 wpa_supplicant_event(ctx
, EVENT_DISASSOC
, &event
);
3724 static inline void drv_event_eapol_rx(void *ctx
, const u8
*src
, const u8
*data
,
3727 union wpa_event_data event
;
3728 os_memset(&event
, 0, sizeof(event
));
3729 event
.eapol_rx
.src
= src
;
3730 event
.eapol_rx
.data
= data
;
3731 event
.eapol_rx
.data_len
= data_len
;
3732 wpa_supplicant_event(ctx
, EVENT_EAPOL_RX
, &event
);
3735 /* driver_common.c */
3736 void wpa_scan_results_free(struct wpa_scan_results
*res
);
3738 /* Convert wpa_event_type to a string for logging */
3739 const char * event_to_string(enum wpa_event_type event
);
3741 #endif /* DRIVER_H */