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
843 /* Driver makes use of OBSS scan mechanism in wpa_supplicant */
844 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
848 int max_sched_scan_ssids;
849 int sched_scan_supported;
853 * max_remain_on_chan - Maximum remain-on-channel duration in msec
855 unsigned int max_remain_on_chan;
858 * max_stations - Maximum number of associated stations the driver
859 * supports in AP mode
861 unsigned int max_stations;
864 * probe_resp_offloads - Bitmap of supported protocols by the driver
865 * for Probe Response offloading.
867 /* Driver Probe Response offloading support for WPS ver. 1 */
868 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
869 /* Driver Probe Response offloading support for WPS ver. 2 */
870 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
871 /* Driver Probe Response offloading support for P2P */
872 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
873 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
874 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
875 unsigned int probe_resp_offloads;
881 struct hostap_sta_driver_data {
882 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
883 unsigned long current_tx_rate;
884 unsigned long inactive_msec;
886 unsigned long num_ps_buf_frames;
887 unsigned long tx_retry_failed;
888 unsigned long tx_retry_count;
893 struct hostapd_sta_add_params {
897 const u8 *supp_rates;
898 size_t supp_rates_len;
900 const struct ieee80211_ht_capabilities *ht_capabilities;
901 u32 flags; /* bitmask of WPA_STA_* flags */
902 int set; /* Set STA parameters instead of add */
906 struct hostapd_freq_params {
911 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
912 * secondary channel below primary, 1 = HT40
913 * enabled, secondary channel above primary */
916 enum wpa_driver_if_type {
918 * WPA_IF_STATION - Station mode interface
923 * WPA_IF_AP_VLAN - AP mode VLAN interface
925 * This interface shares its address and Beacon frame with the main
931 * WPA_IF_AP_BSS - AP mode BSS interface
933 * This interface has its own address and Beacon frame.
938 * WPA_IF_P2P_GO - P2P Group Owner
943 * WPA_IF_P2P_CLIENT - P2P Client
948 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
949 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
954 struct wpa_init_params {
960 const char *test_socket;
961 int use_pae_group_addr;
965 u8 *own_addr; /* buffer for writing own MAC address */
969 struct wpa_bss_params {
970 /** Interface name (for multi-SSID/VLAN support) */
972 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
981 enum mfp_options ieee80211w;
984 #define WPA_STA_AUTHORIZED BIT(0)
985 #define WPA_STA_WMM BIT(1)
986 #define WPA_STA_SHORT_PREAMBLE BIT(2)
987 #define WPA_STA_MFP BIT(3)
988 #define WPA_STA_TDLS_PEER BIT(4)
991 * struct p2p_params - P2P parameters for driver-based P2P management
994 const char *dev_name;
996 #define DRV_MAX_SEC_DEV_TYPES 5
997 u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8];
998 size_t num_sec_dev_types;
1012 WNM_SLEEP_ENTER_CONFIRM,
1013 WNM_SLEEP_ENTER_FAIL,
1014 WNM_SLEEP_EXIT_CONFIRM,
1015 WNM_SLEEP_EXIT_FAIL,
1016 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1017 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1018 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1020 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1022 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1023 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1025 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1029 * struct wpa_signal_info - Information about channel signal quality
1031 struct wpa_signal_info {
1033 int above_threshold;
1040 * struct wpa_driver_ops - Driver interface API definition
1042 * This structure defines the API that each driver interface needs to implement
1043 * for core wpa_supplicant code. All driver specific functionality is captured
1046 struct wpa_driver_ops {
1047 /** Name of the driver interface */
1049 /** One line description of the driver interface */
1053 * get_bssid - Get the current BSSID
1054 * @priv: private driver interface data
1055 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1057 * Returns: 0 on success, -1 on failure
1059 * Query kernel driver for the current BSSID and copy it to bssid.
1060 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1063 int (*get_bssid)(void *priv, u8 *bssid);
1066 * get_ssid - Get the current SSID
1067 * @priv: private driver interface data
1068 * @ssid: buffer for SSID (at least 32 bytes)
1070 * Returns: Length of the SSID on success, -1 on failure
1072 * Query kernel driver for the current SSID and copy it to ssid.
1073 * Returning zero is recommended if the STA is not associated.
1075 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1076 * can, at least in theory, contain control characters (including nul)
1077 * and as such, should be processed as binary data, not a printable
1080 int (*get_ssid)(void *priv, u8 *ssid);
1083 * set_key - Configure encryption key
1084 * @ifname: Interface name (for multi-SSID/VLAN support)
1085 * @priv: private driver interface data
1086 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1087 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1089 * %WPA_ALG_NONE clears the key.
1090 * @addr: Address of the peer STA (BSSID of the current AP when setting
1091 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1092 * broadcast keys, %NULL for default keys that are used both for
1093 * broadcast and unicast; when clearing keys, %NULL is used to
1094 * indicate that both the broadcast-only and default key of the
1095 * specified key index is to be cleared
1096 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1098 * @set_tx: configure this key as the default Tx key (only used when
1099 * driver does not support separate unicast/individual key
1100 * @seq: sequence number/packet number, seq_len octets, the next
1101 * packet number to be used for in replay protection; configured
1102 * for Rx keys (in most cases, this is only used with broadcast
1103 * keys and set to zero for unicast keys); %NULL if not set
1104 * @seq_len: length of the seq, depends on the algorithm:
1105 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1106 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1108 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1109 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1111 * Returns: 0 on success, -1 on failure
1113 * Configure the given key for the kernel driver. If the driver
1114 * supports separate individual keys (4 default keys + 1 individual),
1115 * addr can be used to determine whether the key is default or
1116 * individual. If only 4 keys are supported, the default key with key
1117 * index 0 is used as the individual key. STA must be configured to use
1118 * it as the default Tx key (set_tx is set) and accept Rx for all the
1119 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1120 * broadcast keys, so key index 0 is available for this kind of
1123 * Please note that TKIP keys include separate TX and RX MIC keys and
1124 * some drivers may expect them in different order than wpa_supplicant
1125 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1126 * will trigger Michael MIC errors. This can be fixed by changing the
1127 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1128 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1129 * example on how this can be done.
1131 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1132 const u8 *addr, int key_idx, int set_tx,
1133 const u8 *seq, size_t seq_len,
1134 const u8 *key, size_t key_len);
1137 * init - Initialize driver interface
1138 * @ctx: context to be used when calling wpa_supplicant functions,
1139 * e.g., wpa_supplicant_event()
1140 * @ifname: interface name, e.g., wlan0
1142 * Returns: Pointer to private data, %NULL on failure
1144 * Initialize driver interface, including event processing for kernel
1145 * driver events (e.g., associated, scan results, Michael MIC failure).
1146 * This function can allocate a private configuration data area for
1147 * @ctx, file descriptor, interface name, etc. information that may be
1148 * needed in future driver operations. If this is not used, non-NULL
1149 * value will need to be returned because %NULL is used to indicate
1150 * failure. The returned value will be used as 'void *priv' data for
1151 * all other driver_ops functions.
1153 * The main event loop (eloop.c) of wpa_supplicant can be used to
1154 * register callback for read sockets (eloop_register_read_sock()).
1156 * See below for more information about events and
1157 * wpa_supplicant_event() function.
1159 void * (*init)(void *ctx, const char *ifname);
1162 * deinit - Deinitialize driver interface
1163 * @priv: private driver interface data from init()
1165 * Shut down driver interface and processing of driver events. Free
1166 * private data buffer if one was allocated in init() handler.
1168 void (*deinit)(void *priv);
1171 * set_param - Set driver configuration parameters
1172 * @priv: private driver interface data from init()
1173 * @param: driver specific configuration parameters
1175 * Returns: 0 on success, -1 on failure
1177 * Optional handler for notifying driver interface about configuration
1178 * parameters (driver_param).
1180 int (*set_param)(void *priv, const char *param);
1183 * set_countermeasures - Enable/disable TKIP countermeasures
1184 * @priv: private driver interface data
1185 * @enabled: 1 = countermeasures enabled, 0 = disabled
1187 * Returns: 0 on success, -1 on failure
1189 * Configure TKIP countermeasures. When these are enabled, the driver
1190 * should drop all received and queued frames that are using TKIP.
1192 int (*set_countermeasures)(void *priv, int enabled);
1195 * deauthenticate - Request driver to deauthenticate
1196 * @priv: private driver interface data
1197 * @addr: peer address (BSSID of the AP)
1198 * @reason_code: 16-bit reason code to be sent in the deauthentication
1201 * Returns: 0 on success, -1 on failure
1203 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1206 * associate - Request driver to associate
1207 * @priv: private driver interface data
1208 * @params: association parameters
1210 * Returns: 0 on success, -1 on failure
1212 int (*associate)(void *priv,
1213 struct wpa_driver_associate_params *params);
1216 * add_pmkid - Add PMKSA cache entry to the driver
1217 * @priv: private driver interface data
1218 * @bssid: BSSID for the PMKSA cache entry
1219 * @pmkid: PMKID for the PMKSA cache entry
1221 * Returns: 0 on success, -1 on failure
1223 * This function is called when a new PMK is received, as a result of
1224 * either normal authentication or RSN pre-authentication.
1226 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1227 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1228 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1229 * driver_ops function does not need to be implemented. Likewise, if
1230 * the driver does not support WPA, this function is not needed.
1232 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1235 * remove_pmkid - Remove PMKSA cache entry to the driver
1236 * @priv: private driver interface data
1237 * @bssid: BSSID for the PMKSA cache entry
1238 * @pmkid: PMKID for the PMKSA cache entry
1240 * Returns: 0 on success, -1 on failure
1242 * This function is called when the supplicant drops a PMKSA cache
1243 * entry for any reason.
1245 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1246 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1247 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1248 * from wpa_supplicant, this driver_ops function does not need to be
1249 * implemented. Likewise, if the driver does not support WPA, this
1250 * function is not needed.
1252 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1255 * flush_pmkid - Flush PMKSA cache
1256 * @priv: private driver interface data
1258 * Returns: 0 on success, -1 on failure
1260 * This function is called when the supplicant drops all PMKSA cache
1261 * entries for any reason.
1263 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1264 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1265 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1266 * from wpa_supplicant, this driver_ops function does not need to be
1267 * implemented. Likewise, if the driver does not support WPA, this
1268 * function is not needed.
1270 int (*flush_pmkid)(void *priv);
1273 * get_capa - Get driver capabilities
1274 * @priv: private driver interface data
1276 * Returns: 0 on success, -1 on failure
1278 * Get driver/firmware/hardware capabilities.
1280 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1283 * poll - Poll driver for association information
1284 * @priv: private driver interface data
1286 * This is an option callback that can be used when the driver does not
1287 * provide event mechanism for association events. This is called when
1288 * receiving WPA EAPOL-Key messages that require association
1289 * information. The driver interface is supposed to generate associnfo
1290 * event before returning from this callback function. In addition, the
1291 * driver interface should generate an association event after having
1292 * sent out associnfo.
1294 void (*poll)(void *priv);
1297 * get_ifname - Get interface name
1298 * @priv: private driver interface data
1300 * Returns: Pointer to the interface name. This can differ from the
1301 * interface name used in init() call. Init() is called first.
1303 * This optional function can be used to allow the driver interface to
1304 * replace the interface name with something else, e.g., based on an
1305 * interface mapping from a more descriptive name.
1307 const char * (*get_ifname)(void *priv);
1310 * get_mac_addr - Get own MAC address
1311 * @priv: private driver interface data
1313 * Returns: Pointer to own MAC address or %NULL on failure
1315 * This optional function can be used to get the own MAC address of the
1316 * device from the driver interface code. This is only needed if the
1317 * l2_packet implementation for the OS does not provide easy access to
1319 const u8 * (*get_mac_addr)(void *priv);
1322 * send_eapol - Optional function for sending EAPOL packets
1323 * @priv: private driver interface data
1324 * @dest: Destination MAC address
1326 * @data: EAPOL packet starting with IEEE 802.1X header
1327 * @data_len: Size of the EAPOL packet
1329 * Returns: 0 on success, -1 on failure
1331 * This optional function can be used to override l2_packet operations
1332 * with driver specific functionality. If this function pointer is set,
1333 * l2_packet module is not used at all and the driver interface code is
1334 * responsible for receiving and sending all EAPOL packets. The
1335 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1336 * event. The driver interface is required to implement get_mac_addr()
1337 * handler if send_eapol() is used.
1339 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1340 const u8 *data, size_t data_len);
1343 * set_operstate - Sets device operating state to DORMANT or UP
1344 * @priv: private driver interface data
1345 * @state: 0 = dormant, 1 = up
1346 * Returns: 0 on success, -1 on failure
1348 * This is an optional function that can be used on operating systems
1349 * that support a concept of controlling network device state from user
1350 * space applications. This function, if set, gets called with
1351 * state = 1 when authentication has been completed and with state = 0
1352 * when connection is lost.
1354 int (*set_operstate)(void *priv, int state);
1357 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1358 * @priv: Private driver interface data
1359 * @addr: Address of the station for which to set protection (may be
1360 * %NULL for group keys)
1361 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1362 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1363 * Returns: 0 on success, -1 on failure
1365 * This is an optional function that can be used to set the driver to
1366 * require protection for Tx and/or Rx frames. This uses the layer
1367 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1368 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1369 * set protection operation; instead, they set protection implicitly
1370 * based on configured keys.
1372 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1376 * get_hw_feature_data - Get hardware support data (channels and rates)
1377 * @priv: Private driver interface data
1378 * @num_modes: Variable for returning the number of returned modes
1379 * flags: Variable for returning hardware feature flags
1380 * Returns: Pointer to allocated hardware data on success or %NULL on
1381 * failure. Caller is responsible for freeing this.
1383 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1388 * send_mlme - Send management frame from MLME
1389 * @priv: Private driver interface data
1390 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1391 * @data_len: Size of the management frame
1392 * @noack: Do not wait for this frame to be acked (disable retries)
1393 * Returns: 0 on success, -1 on failure
1395 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1399 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1400 * @priv: Private driver interface data
1401 * @md: Mobility domain (2 octets) (also included inside ies)
1402 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1403 * @ies_len: Length of FT IEs in bytes
1404 * Returns: 0 on success, -1 on failure
1406 * The supplicant uses this callback to let the driver know that keying
1407 * material for FT is available and that the driver can use the
1408 * provided IEs in the next message in FT authentication sequence.
1410 * This function is only needed for driver that support IEEE 802.11r
1411 * (Fast BSS Transition).
1413 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1417 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1418 * @priv: Private driver interface data
1419 * @action: Action field value
1420 * @target_ap: Target AP address
1421 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1422 * @ies_len: Length of FT IEs in bytes
1423 * Returns: 0 on success, -1 on failure
1425 * The supplicant uses this callback to request the driver to transmit
1426 * an FT Action frame (action category 6) for over-the-DS fast BSS
1429 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1430 const u8 *ies, size_t ies_len);
1433 * get_scan_results2 - Fetch the latest scan results
1434 * @priv: private driver interface data
1436 * Returns: Allocated buffer of scan results (caller is responsible for
1437 * freeing the data structure) on success, NULL on failure
1439 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1442 * set_country - Set country
1443 * @priv: Private driver interface data
1444 * @alpha2: country to which to switch to
1445 * Returns: 0 on success, -1 on failure
1447 * This function is for drivers which support some form
1448 * of setting a regulatory domain.
1450 int (*set_country)(void *priv, const char *alpha2);
1453 * global_init - Global driver initialization
1454 * Returns: Pointer to private data (global), %NULL on failure
1456 * This optional function is called to initialize the driver wrapper
1457 * for global data, i.e., data that applies to all interfaces. If this
1458 * function is implemented, global_deinit() will also need to be
1459 * implemented to free the private data. The driver will also likely
1460 * use init2() function instead of init() to get the pointer to global
1461 * data available to per-interface initializer.
1463 void * (*global_init)(void);
1466 * global_deinit - Global driver deinitialization
1467 * @priv: private driver global data from global_init()
1469 * Terminate any global driver related functionality and free the
1470 * global data structure.
1472 void (*global_deinit)(void *priv);
1475 * init2 - Initialize driver interface (with global data)
1476 * @ctx: context to be used when calling wpa_supplicant functions,
1477 * e.g., wpa_supplicant_event()
1478 * @ifname: interface name, e.g., wlan0
1479 * @global_priv: private driver global data from global_init()
1480 * Returns: Pointer to private data, %NULL on failure
1482 * This function can be used instead of init() if the driver wrapper
1485 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1488 * get_interfaces - Get information about available interfaces
1489 * @global_priv: private driver global data from global_init()
1490 * Returns: Allocated buffer of interface information (caller is
1491 * responsible for freeing the data structure) on success, NULL on
1494 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1497 * scan2 - Request the driver to initiate scan
1498 * @priv: private driver interface data
1499 * @params: Scan parameters
1501 * Returns: 0 on success, -1 on failure
1503 * Once the scan results are ready, the driver should report scan
1504 * results event for wpa_supplicant which will eventually request the
1505 * results with wpa_driver_get_scan_results2().
1507 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1510 * authenticate - Request driver to authenticate
1511 * @priv: private driver interface data
1512 * @params: authentication parameters
1513 * Returns: 0 on success, -1 on failure
1515 * This is an optional function that can be used with drivers that
1516 * support separate authentication and association steps, i.e., when
1517 * wpa_supplicant can act as the SME. If not implemented, associate()
1518 * function is expected to take care of IEEE 802.11 authentication,
1521 int (*authenticate)(void *priv,
1522 struct wpa_driver_auth_params *params);
1525 * set_ap - Set Beacon and Probe Response information for AP mode
1526 * @priv: Private driver interface data
1527 * @params: Parameters to use in AP mode
1529 * This function is used to configure Beacon template and/or extra IEs
1530 * to add for Beacon and Probe Response frames for the driver in
1531 * AP mode. The driver is responsible for building the full Beacon
1532 * frame by concatenating the head part with TIM IE generated by the
1533 * driver/firmware and finishing with the tail part. Depending on the
1534 * driver architectue, this can be done either by using the full
1535 * template or the set of additional IEs (e.g., WPS and P2P IE).
1536 * Similarly, Probe Response processing depends on the driver design.
1537 * If the driver (or firmware) takes care of replying to Probe Request
1538 * frames, the extra IEs provided here needs to be added to the Probe
1541 * Returns: 0 on success, -1 on failure
1543 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1546 * hapd_init - Initialize driver interface (hostapd only)
1547 * @hapd: Pointer to hostapd context
1548 * @params: Configuration for the driver wrapper
1549 * Returns: Pointer to private data, %NULL on failure
1551 * This function is used instead of init() or init2() when the driver
1552 * wrapper is used with hostapd.
1554 void * (*hapd_init)(struct hostapd_data *hapd,
1555 struct wpa_init_params *params);
1558 * hapd_deinit - Deinitialize driver interface (hostapd only)
1559 * @priv: Private driver interface data from hapd_init()
1561 void (*hapd_deinit)(void *priv);
1564 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1565 * @priv: Private driver interface data
1566 * @params: BSS parameters
1567 * Returns: 0 on success, -1 on failure
1569 * This is an optional function to configure the kernel driver to
1570 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1571 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1572 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1573 * for Beacon frames.
1575 * DEPRECATED - use set_ap() instead
1577 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1580 * set_privacy - Enable/disable privacy (AP only)
1581 * @priv: Private driver interface data
1582 * @enabled: 1 = privacy enabled, 0 = disabled
1583 * Returns: 0 on success, -1 on failure
1585 * This is an optional function to configure privacy field in the
1586 * kernel driver for Beacon frames. This can be left undefined (set to
1587 * %NULL) if the driver uses the Beacon template from set_ap().
1589 * DEPRECATED - use set_ap() instead
1591 int (*set_privacy)(void *priv, int enabled);
1594 * get_seqnum - Fetch the current TSC/packet number (AP only)
1595 * @ifname: The interface name (main or virtual)
1596 * @priv: Private driver interface data
1597 * @addr: MAC address of the station or %NULL for group keys
1599 * @seq: Buffer for returning the latest used TSC/packet number
1600 * Returns: 0 on success, -1 on failure
1602 * This function is used to fetch the last used TSC/packet number for
1603 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1604 * keys, so there is no strict requirement on implementing support for
1605 * unicast keys (i.e., addr != %NULL).
1607 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1611 * flush - Flush all association stations (AP only)
1612 * @priv: Private driver interface data
1613 * Returns: 0 on success, -1 on failure
1615 * This function requests the driver to disassociate all associated
1616 * stations. This function does not need to be implemented if the
1617 * driver does not process association frames internally.
1619 int (*flush)(void *priv);
1622 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1623 * @priv: Private driver interface data
1624 * @elem: Information elements
1625 * @elem_len: Length of the elem buffer in octets
1626 * Returns: 0 on success, -1 on failure
1628 * This is an optional function to add information elements in the
1629 * kernel driver for Beacon and Probe Response frames. This can be left
1630 * undefined (set to %NULL) if the driver uses the Beacon template from
1633 * DEPRECATED - use set_ap() instead
1635 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1638 * read_sta_data - Fetch station data
1639 * @priv: Private driver interface data
1640 * @data: Buffer for returning station information
1641 * @addr: MAC address of the station
1642 * Returns: 0 on success, -1 on failure
1644 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1648 * hapd_send_eapol - Send an EAPOL packet (AP only)
1649 * @priv: private driver interface data
1650 * @addr: Destination MAC address
1651 * @data: EAPOL packet starting with IEEE 802.1X header
1652 * @data_len: Length of the EAPOL packet in octets
1653 * @encrypt: Whether the frame should be encrypted
1654 * @own_addr: Source MAC address
1655 * @flags: WPA_STA_* flags for the destination station
1657 * Returns: 0 on success, -1 on failure
1659 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1660 size_t data_len, int encrypt,
1661 const u8 *own_addr, u32 flags);
1664 * sta_deauth - Deauthenticate a station (AP only)
1665 * @priv: Private driver interface data
1666 * @own_addr: Source address and BSSID for the Deauthentication frame
1667 * @addr: MAC address of the station to deauthenticate
1668 * @reason: Reason code for the Deauthentiation frame
1669 * Returns: 0 on success, -1 on failure
1671 * This function requests a specific station to be deauthenticated and
1672 * a Deauthentication frame to be sent to it.
1674 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1678 * sta_disassoc - Disassociate a station (AP only)
1679 * @priv: Private driver interface data
1680 * @own_addr: Source address and BSSID for the Disassociation frame
1681 * @addr: MAC address of the station to disassociate
1682 * @reason: Reason code for the Disassociation frame
1683 * Returns: 0 on success, -1 on failure
1685 * This function requests a specific station to be disassociated and
1686 * a Disassociation frame to be sent to it.
1688 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1692 * sta_remove - Remove a station entry (AP only)
1693 * @priv: Private driver interface data
1694 * @addr: MAC address of the station to be removed
1695 * Returns: 0 on success, -1 on failure
1697 int (*sta_remove)(void *priv, const u8 *addr);
1700 * hapd_get_ssid - Get the current SSID (AP only)
1701 * @priv: Private driver interface data
1702 * @buf: Buffer for returning the SSID
1703 * @len: Maximum length of the buffer
1704 * Returns: Length of the SSID on success, -1 on failure
1706 * This function need not be implemented if the driver uses Beacon
1707 * template from set_ap() and does not reply to Probe Request frames.
1709 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1712 * hapd_set_ssid - Set SSID (AP only)
1713 * @priv: Private driver interface data
1715 * @len: Length of the SSID in octets
1716 * Returns: 0 on success, -1 on failure
1718 * DEPRECATED - use set_ap() instead
1720 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1723 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1724 * @priv: Private driver interface data
1725 * @enabled: 1 = countermeasures enabled, 0 = disabled
1726 * Returns: 0 on success, -1 on failure
1728 * This need not be implemented if the driver does not take care of
1729 * association processing.
1731 int (*hapd_set_countermeasures)(void *priv, int enabled);
1734 * sta_add - Add a station entry
1735 * @priv: Private driver interface data
1736 * @params: Station parameters
1737 * Returns: 0 on success, -1 on failure
1739 * This function is used to add a station entry to the driver once the
1740 * station has completed association. This is only used if the driver
1741 * does not take care of association processing.
1743 * With TDLS, this function is also used to add or set (params->set 1)
1744 * TDLS peer entries.
1746 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1749 * get_inact_sec - Get station inactivity duration (AP only)
1750 * @priv: Private driver interface data
1751 * @addr: Station address
1752 * Returns: Number of seconds station has been inactive, -1 on failure
1754 int (*get_inact_sec)(void *priv, const u8 *addr);
1757 * sta_clear_stats - Clear station statistics (AP only)
1758 * @priv: Private driver interface data
1759 * @addr: Station address
1760 * Returns: 0 on success, -1 on failure
1762 int (*sta_clear_stats)(void *priv, const u8 *addr);
1765 * set_freq - Set channel/frequency (AP only)
1766 * @priv: Private driver interface data
1767 * @freq: Channel parameters
1768 * Returns: 0 on success, -1 on failure
1770 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1773 * set_rts - Set RTS threshold
1774 * @priv: Private driver interface data
1775 * @rts: RTS threshold in octets
1776 * Returns: 0 on success, -1 on failure
1778 int (*set_rts)(void *priv, int rts);
1781 * set_frag - Set fragmentation threshold
1782 * @priv: Private driver interface data
1783 * @frag: Fragmentation threshold in octets
1784 * Returns: 0 on success, -1 on failure
1786 int (*set_frag)(void *priv, int frag);
1789 * sta_set_flags - Set station flags (AP only)
1790 * @priv: Private driver interface data
1791 * @addr: Station address
1792 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1793 * @flags_or: Bitmap of WPA_STA_* flags to add
1794 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1795 * Returns: 0 on success, -1 on failure
1797 int (*sta_set_flags)(void *priv, const u8 *addr,
1798 int total_flags, int flags_or, int flags_and);
1801 * set_tx_queue_params - Set TX queue parameters
1802 * @priv: Private driver interface data
1803 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
1807 * @burst_time: Maximum length for bursting in 0.1 msec units
1809 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1810 int cw_max, int burst_time);
1813 * if_add - Add a virtual interface
1814 * @priv: Private driver interface data
1815 * @type: Interface type
1816 * @ifname: Interface name for the new virtual interface
1817 * @addr: Local address to use for the interface or %NULL to use the
1818 * parent interface address
1819 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1820 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1821 * not allowed (applies only to %WPA_IF_AP_BSS type)
1822 * @force_ifname: Buffer for returning an interface name that the
1823 * driver ended up using if it differs from the requested ifname
1824 * @if_addr: Buffer for returning the allocated interface address
1825 * (this may differ from the requested addr if the driver cannot
1826 * change interface address)
1827 * @bridge: Bridge interface to use or %NULL if no bridge configured
1828 * Returns: 0 on success, -1 on failure
1830 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1831 const char *ifname, const u8 *addr, void *bss_ctx,
1832 void **drv_priv, char *force_ifname, u8 *if_addr,
1833 const char *bridge);
1836 * if_remove - Remove a virtual interface
1837 * @priv: Private driver interface data
1838 * @type: Interface type
1839 * @ifname: Interface name of the virtual interface to be removed
1840 * Returns: 0 on success, -1 on failure
1842 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1843 const char *ifname);
1846 * set_sta_vlan - Bind a station into a specific interface (AP only)
1847 * @priv: Private driver interface data
1848 * @ifname: Interface (main or virtual BSS or VLAN)
1849 * @addr: MAC address of the associated station
1851 * Returns: 0 on success, -1 on failure
1853 * This function is used to bind a station to a specific virtual
1854 * interface. It is only used if when virtual interfaces are supported,
1855 * e.g., to assign stations to different VLAN interfaces based on
1856 * information from a RADIUS server. This allows separate broadcast
1857 * domains to be used with a single BSS.
1859 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1863 * commit - Optional commit changes handler (AP only)
1864 * @priv: driver private data
1865 * Returns: 0 on success, -1 on failure
1867 * This optional handler function can be registered if the driver
1868 * interface implementation needs to commit changes (e.g., by setting
1869 * network interface up) at the end of initial configuration. If set,
1870 * this handler will be called after initial setup has been completed.
1872 int (*commit)(void *priv);
1875 * send_ether - Send an ethernet packet (AP only)
1876 * @priv: private driver interface data
1877 * @dst: Destination MAC address
1878 * @src: Source MAC address
1880 * @data: EAPOL packet starting with IEEE 802.1X header
1881 * @data_len: Length of the EAPOL packet in octets
1882 * Returns: 0 on success, -1 on failure
1884 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1885 const u8 *data, size_t data_len);
1888 * set_radius_acl_auth - Notification of RADIUS ACL change
1889 * @priv: Private driver interface data
1890 * @mac: MAC address of the station
1891 * @accepted: Whether the station was accepted
1892 * @session_timeout: Session timeout for the station
1893 * Returns: 0 on success, -1 on failure
1895 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1896 u32 session_timeout);
1899 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1900 * @priv: Private driver interface data
1901 * @mac: MAC address of the station
1902 * Returns: 0 on success, -1 on failure
1904 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1907 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
1908 * @priv: Private driver interface data
1909 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
1910 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
1912 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
1913 * to remove extra IE(s)
1914 * Returns: 0 on success, -1 on failure
1916 * This is an optional function to add WPS IE in the kernel driver for
1917 * Beacon and Probe Response frames. This can be left undefined (set
1918 * to %NULL) if the driver uses the Beacon template from set_ap()
1919 * and does not process Probe Request frames. If the driver takes care
1920 * of (Re)Association frame processing, the assocresp buffer includes
1921 * WPS IE(s) that need to be added to (Re)Association Response frames
1922 * whenever a (Re)Association Request frame indicated use of WPS.
1924 * This will also be used to add P2P IE(s) into Beacon/Probe Response
1925 * frames when operating as a GO. The driver is responsible for adding
1926 * timing related attributes (e.g., NoA) in addition to the IEs
1927 * included here by appending them after these buffers. This call is
1928 * also used to provide Probe Response IEs for P2P Listen state
1929 * operations for drivers that generate the Probe Response frames
1932 * DEPRECATED - use set_ap() instead
1934 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
1935 const struct wpabuf *proberesp,
1936 const struct wpabuf *assocresp);
1939 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1940 * @priv: Private driver interface data
1941 * @authorized: Whether the port is authorized
1942 * Returns: 0 on success, -1 on failure
1944 int (*set_supp_port)(void *priv, int authorized);
1947 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1948 * @priv: Private driver interface data
1949 * @addr: MAC address of the associated station
1950 * @aid: Association ID
1951 * @val: 1 = bind to 4-address WDS; 0 = unbind
1952 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
1953 * to indicate that bridge is not to be used
1954 * Returns: 0 on success, -1 on failure
1956 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
1957 const char *bridge_ifname);
1960 * send_action - Transmit an Action frame
1961 * @priv: Private driver interface data
1962 * @freq: Frequency (in MHz) of the channel
1963 * @wait: Time to wait off-channel for a response (in ms), or zero
1964 * @dst: Destination MAC address (Address 1)
1965 * @src: Source MAC address (Address 2)
1966 * @bssid: BSSID (Address 3)
1968 * @data_len: data length in octets
1969 @ @no_cck: Whether CCK rates must not be used to transmit this frame
1970 * Returns: 0 on success, -1 on failure
1972 * This command can be used to request the driver to transmit an action
1973 * frame to the specified destination.
1975 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
1976 * be transmitted on the given channel and the device will wait for a
1977 * response on that channel for the given wait time.
1979 * If the flag is not set, the wait time will be ignored. In this case,
1980 * if a remain-on-channel duration is in progress, the frame must be
1981 * transmitted on that channel; alternatively the frame may be sent on
1982 * the current operational channel (if in associated state in station
1983 * mode or while operating as an AP.)
1985 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
1986 const u8 *dst, const u8 *src, const u8 *bssid,
1987 const u8 *data, size_t data_len, int no_cck);
1990 * send_action_cancel_wait - Cancel action frame TX wait
1991 * @priv: Private driver interface data
1993 * This command cancels the wait time associated with sending an action
1994 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
1995 * set in the driver flags.
1997 void (*send_action_cancel_wait)(void *priv);
2000 * remain_on_channel - Remain awake on a channel
2001 * @priv: Private driver interface data
2002 * @freq: Frequency (in MHz) of the channel
2003 * @duration: Duration in milliseconds
2004 * Returns: 0 on success, -1 on failure
2006 * This command is used to request the driver to remain awake on the
2007 * specified channel for the specified duration and report received
2008 * Action frames with EVENT_RX_ACTION events. Optionally, received
2009 * Probe Request frames may also be requested to be reported by calling
2010 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2012 * The driver may not be at the requested channel when this function
2013 * returns, i.e., the return code is only indicating whether the
2014 * request was accepted. The caller will need to wait until the
2015 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2016 * completed the channel change. This may take some time due to other
2017 * need for the radio and the caller should be prepared to timing out
2018 * its wait since there are no guarantees on when this request can be
2021 int (*remain_on_channel)(void *priv, unsigned int freq,
2022 unsigned int duration);
2025 * cancel_remain_on_channel - Cancel remain-on-channel operation
2026 * @priv: Private driver interface data
2028 * This command can be used to cancel a remain-on-channel operation
2029 * before its originally requested duration has passed. This could be
2030 * used, e.g., when remain_on_channel() is used to request extra time
2031 * to receive a response to an Action frame and the response is
2032 * received when there is still unneeded time remaining on the
2033 * remain-on-channel operation.
2035 int (*cancel_remain_on_channel)(void *priv);
2038 * probe_req_report - Request Probe Request frames to be indicated
2039 * @priv: Private driver interface data
2040 * @report: Whether to report received Probe Request frames
2041 * Returns: 0 on success, -1 on failure (or if not supported)
2043 * This command can be used to request the driver to indicate when
2044 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2045 * Since this operation may require extra resources, e.g., due to less
2046 * optimal hardware/firmware RX filtering, many drivers may disable
2047 * Probe Request reporting at least in station mode. This command is
2048 * used to notify the driver when the Probe Request frames need to be
2049 * reported, e.g., during remain-on-channel operations.
2051 int (*probe_req_report)(void *priv, int report);
2054 * deinit_ap - Deinitialize AP mode
2055 * @priv: Private driver interface data
2056 * Returns: 0 on success, -1 on failure (or if not supported)
2058 * This optional function can be used to disable AP mode related
2059 * configuration and change the driver mode to station mode to allow
2060 * normal station operations like scanning to be completed.
2062 int (*deinit_ap)(void *priv);
2065 * deinit_p2p_cli - Deinitialize P2P client mode
2066 * @priv: Private driver interface data
2067 * Returns: 0 on success, -1 on failure (or if not supported)
2069 * This optional function can be used to disable P2P client mode. It
2070 * can be used to change the interface type back to station mode.
2072 int (*deinit_p2p_cli)(void *priv);
2075 * suspend - Notification on system suspend/hibernate event
2076 * @priv: Private driver interface data
2078 void (*suspend)(void *priv);
2081 * resume - Notification on system resume/thaw event
2082 * @priv: Private driver interface data
2084 void (*resume)(void *priv);
2087 * signal_monitor - Set signal monitoring parameters
2088 * @priv: Private driver interface data
2089 * @threshold: Threshold value for signal change events; 0 = disabled
2090 * @hysteresis: Minimum change in signal strength before indicating a
2092 * Returns: 0 on success, -1 on failure (or if not supported)
2094 * This function can be used to configure monitoring of signal strength
2095 * with the current AP. Whenever signal strength drops below the
2096 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2097 * should be generated assuming the signal strength has changed at
2098 * least %hysteresis from the previously indicated signal change event.
2100 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2103 * send_frame - Send IEEE 802.11 frame (testing use only)
2104 * @priv: Private driver interface data
2105 * @data: IEEE 802.11 frame with IEEE 802.11 header
2106 * @data_len: Size of the frame
2107 * @encrypt: Whether to encrypt the frame (if keys are set)
2108 * Returns: 0 on success, -1 on failure
2110 * This function is only used for debugging purposes and is not
2111 * required to be implemented for normal operations.
2113 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2117 * shared_freq - Get operating frequency of shared interface(s)
2118 * @priv: Private driver interface data
2119 * Returns: Operating frequency in MHz, 0 if no shared operation in
2120 * use, or -1 on failure
2122 * This command can be used to request the current operating frequency
2123 * of any virtual interface that shares the same radio to provide
2124 * information for channel selection for other virtual interfaces.
2126 int (*shared_freq)(void *priv);
2129 * get_noa - Get current Notice of Absence attribute payload
2130 * @priv: Private driver interface data
2131 * @buf: Buffer for returning NoA
2132 * @buf_len: Buffer length in octets
2133 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2134 * advertized, or -1 on failure
2136 * This function is used to fetch the current Notice of Absence
2137 * attribute value from GO.
2139 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2142 * set_noa - Set Notice of Absence parameters for GO (testing)
2143 * @priv: Private driver interface data
2145 * @start: Start time in ms from next TBTT
2146 * @duration: Duration in ms
2147 * Returns: 0 on success or -1 on failure
2149 * This function is used to set Notice of Absence parameters for GO. It
2150 * is used only for testing. To disable NoA, all parameters are set to
2153 int (*set_noa)(void *priv, u8 count, int start, int duration);
2156 * set_p2p_powersave - Set P2P power save options
2157 * @priv: Private driver interface data
2158 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2159 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2160 * @ctwindow: 0.. = change (msec), -1 = no change
2161 * Returns: 0 on success or -1 on failure
2163 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2167 * ampdu - Enable/disable aggregation
2168 * @priv: Private driver interface data
2169 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2170 * Returns: 0 on success or -1 on failure
2172 int (*ampdu)(void *priv, int ampdu);
2175 * get_radio_name - Get physical radio name for the device
2176 * @priv: Private driver interface data
2177 * Returns: Radio name or %NULL if not known
2179 * The returned data must not be modified by the caller. It is assumed
2180 * that any interface that has the same radio name as another is
2181 * sharing the same physical radio. This information can be used to
2182 * share scan results etc. information between the virtual interfaces
2183 * to speed up various operations.
2185 const char * (*get_radio_name)(void *priv);
2188 * p2p_find - Start P2P Device Discovery
2189 * @priv: Private driver interface data
2190 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2191 * @type: Device Discovery type (enum p2p_discovery_type)
2192 * Returns: 0 on success, -1 on failure
2194 * This function is only used if the driver implements P2P management,
2195 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2196 * struct wpa_driver_capa.
2198 int (*p2p_find)(void *priv, unsigned int timeout, int type);
2201 * p2p_stop_find - Stop P2P Device Discovery
2202 * @priv: Private driver interface data
2203 * Returns: 0 on success, -1 on failure
2205 * This function is only used if the driver implements P2P management,
2206 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2207 * struct wpa_driver_capa.
2209 int (*p2p_stop_find)(void *priv);
2212 * p2p_listen - Start P2P Listen state for specified duration
2213 * @priv: Private driver interface data
2214 * @timeout: Listen state duration in milliseconds
2215 * Returns: 0 on success, -1 on failure
2217 * This function can be used to request the P2P module to keep the
2218 * device discoverable on the listen channel for an extended set of
2219 * time. At least in its current form, this is mainly used for testing
2220 * purposes and may not be of much use for normal P2P operations.
2222 * This function is only used if the driver implements P2P management,
2223 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2224 * struct wpa_driver_capa.
2226 int (*p2p_listen)(void *priv, unsigned int timeout);
2229 * p2p_connect - Start P2P group formation (GO negotiation)
2230 * @priv: Private driver interface data
2231 * @peer_addr: MAC address of the peer P2P client
2232 * @wps_method: enum p2p_wps_method value indicating config method
2233 * @go_intent: Local GO intent value (1..15)
2234 * @own_interface_addr: Intended interface address to use with the
2236 * @force_freq: The only allowed channel frequency in MHz or 0
2237 * @persistent_group: Whether to create persistent group
2238 * Returns: 0 on success, -1 on failure
2240 * This function is only used if the driver implements P2P management,
2241 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2242 * struct wpa_driver_capa.
2244 int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method,
2245 int go_intent, const u8 *own_interface_addr,
2246 unsigned int force_freq, int persistent_group);
2249 * wps_success_cb - Report successfully completed WPS provisioning
2250 * @priv: Private driver interface data
2251 * @peer_addr: Peer address
2252 * Returns: 0 on success, -1 on failure
2254 * This function is used to report successfully completed WPS
2255 * provisioning during group formation in both GO/Registrar and
2256 * client/Enrollee roles.
2258 * This function is only used if the driver implements P2P management,
2259 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2260 * struct wpa_driver_capa.
2262 int (*wps_success_cb)(void *priv, const u8 *peer_addr);
2265 * p2p_group_formation_failed - Report failed WPS provisioning
2266 * @priv: Private driver interface data
2267 * Returns: 0 on success, -1 on failure
2269 * This function is used to report failed group formation. This can
2270 * happen either due to failed WPS provisioning or due to 15 second
2271 * timeout during the provisioning phase.
2273 * This function is only used if the driver implements P2P management,
2274 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2275 * struct wpa_driver_capa.
2277 int (*p2p_group_formation_failed)(void *priv);
2280 * p2p_set_params - Set P2P parameters
2281 * @priv: Private driver interface data
2282 * @params: P2P parameters
2283 * Returns: 0 on success, -1 on failure
2285 * This function is only used if the driver implements P2P management,
2286 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2287 * struct wpa_driver_capa.
2289 int (*p2p_set_params)(void *priv, const struct p2p_params *params);
2292 * p2p_prov_disc_req - Send Provision Discovery Request
2293 * @priv: Private driver interface data
2294 * @peer_addr: MAC address of the peer P2P client
2295 * @config_methods: WPS Config Methods value (only one bit set)
2296 * Returns: 0 on success, -1 on failure
2298 * This function can be used to request a discovered P2P peer to
2299 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2300 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2301 * Provision Discovery Request frame is transmitted once immediately
2302 * and if no response is received, the frame will be sent again
2303 * whenever the target device is discovered during device dsicovery
2304 * (start with a p2p_find() call). Response from the peer is indicated
2305 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
2307 * This function is only used if the driver implements P2P management,
2308 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2309 * struct wpa_driver_capa.
2311 int (*p2p_prov_disc_req)(void *priv, const u8 *peer_addr,
2312 u16 config_methods, int join);
2315 * p2p_sd_request - Schedule a service discovery query
2316 * @priv: Private driver interface data
2317 * @dst: Destination peer or %NULL to apply for all peers
2318 * @tlvs: P2P Service Query TLV(s)
2319 * Returns: Reference to the query or 0 on failure
2321 * Response to the query is indicated with the
2322 * EVENT_P2P_SD_RESPONSE driver event.
2324 * This function is only used if the driver implements P2P management,
2325 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2326 * struct wpa_driver_capa.
2328 u64 (*p2p_sd_request)(void *priv, const u8 *dst,
2329 const struct wpabuf *tlvs);
2332 * p2p_sd_cancel_request - Cancel a pending service discovery query
2333 * @priv: Private driver interface data
2334 * @req: Query reference from p2p_sd_request()
2335 * Returns: 0 on success, -1 on failure
2337 * This function is only used if the driver implements P2P management,
2338 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2339 * struct wpa_driver_capa.
2341 int (*p2p_sd_cancel_request)(void *priv, u64 req);
2344 * p2p_sd_response - Send response to a service discovery query
2345 * @priv: Private driver interface data
2346 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2347 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2348 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2349 * @resp_tlvs: P2P Service Response TLV(s)
2350 * Returns: 0 on success, -1 on failure
2352 * This function is called as a response to the request indicated with
2353 * the EVENT_P2P_SD_REQUEST driver event.
2355 * This function is only used if the driver implements P2P management,
2356 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2357 * struct wpa_driver_capa.
2359 int (*p2p_sd_response)(void *priv, int freq, const u8 *dst,
2361 const struct wpabuf *resp_tlvs);
2364 * p2p_service_update - Indicate a change in local services
2365 * @priv: Private driver interface data
2366 * Returns: 0 on success, -1 on failure
2368 * This function needs to be called whenever there is a change in
2369 * availability of the local services. This will increment the
2370 * Service Update Indicator value which will be used in SD Request and
2373 * This function is only used if the driver implements P2P management,
2374 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2375 * struct wpa_driver_capa.
2377 int (*p2p_service_update)(void *priv);
2380 * p2p_reject - Reject peer device (explicitly block connections)
2381 * @priv: Private driver interface data
2382 * @addr: MAC address of the peer
2383 * Returns: 0 on success, -1 on failure
2385 int (*p2p_reject)(void *priv, const u8 *addr);
2388 * p2p_invite - Invite a P2P Device into a group
2389 * @priv: Private driver interface data
2390 * @peer: Device Address of the peer P2P Device
2391 * @role: Local role in the group
2392 * @bssid: Group BSSID or %NULL if not known
2394 * @ssid_len: Length of ssid in octets
2395 * @go_dev_addr: Forced GO Device Address or %NULL if none
2396 * @persistent_group: Whether this is to reinvoke a persistent group
2397 * Returns: 0 on success, -1 on failure
2399 int (*p2p_invite)(void *priv, const u8 *peer, int role,
2400 const u8 *bssid, const u8 *ssid, size_t ssid_len,
2401 const u8 *go_dev_addr, int persistent_group);
2404 * send_tdls_mgmt - for sending TDLS management packets
2405 * @priv: private driver interface data
2406 * @dst: Destination (peer) MAC address
2407 * @action_code: TDLS action code for the mssage
2408 * @dialog_token: Dialog Token to use in the message (if needed)
2409 * @status_code: Status Code or Reason Code to use (if needed)
2410 * @buf: TDLS IEs to add to the message
2411 * @len: Length of buf in octets
2412 * Returns: 0 on success, negative (<0) on failure
2414 * This optional function can be used to send packet to driver which is
2415 * responsible for receiving and sending all TDLS packets.
2417 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2418 u8 dialog_token, u16 status_code,
2419 const u8 *buf, size_t len);
2422 * tdls_oper - Ask the driver to perform high-level TDLS operations
2423 * @priv: Private driver interface data
2424 * @oper: TDLS high-level operation. See %enum tdls_oper
2425 * @peer: Destination (peer) MAC address
2426 * Returns: 0 on success, negative (<0) on failure
2428 * This optional function can be used to send high-level TDLS commands
2431 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2434 * wnm_oper - Notify driver of the WNM frame reception
2435 * @priv: Private driver interface data
2436 * @oper: WNM operation. See %enum wnm_oper
2437 * @peer: Destination (peer) MAC address
2438 * @buf: Buffer for the driver to fill in (for getting IE)
2439 * @buf_len: Return the len of buf
2440 * Returns: 0 on success, negative (<0) on failure
2442 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2443 u8 *buf, u16 *buf_len);
2446 * signal_poll - Get current connection information
2447 * @priv: Private driver interface data
2448 * @signal_info: Connection info structure
2450 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2453 * set_authmode - Set authentication algorithm(s) for static WEP
2454 * @priv: Private driver interface data
2455 * @authmode: 1=Open System, 2=Shared Key, 3=both
2456 * Returns: 0 on success, -1 on failure
2458 * This function can be used to set authentication algorithms for AP
2459 * mode when static WEP is used. If the driver uses user space MLME/SME
2460 * implementation, there is no need to implement this function.
2462 * DEPRECATED - use set_ap() instead
2464 int (*set_authmode)(void *priv, int authmode);
2467 * set_rekey_info - Set rekey information
2468 * @priv: Private driver interface data
2471 * @replay_ctr: Current EAPOL-Key Replay Counter
2473 * This optional function can be used to provide information for the
2474 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2475 * while the host (including wpa_supplicant) is sleeping.
2477 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2478 const u8 *replay_ctr);
2481 * sta_assoc - Station association indication
2482 * @priv: Private driver interface data
2483 * @own_addr: Source address and BSSID for association frame
2484 * @addr: MAC address of the station to associate
2485 * @reassoc: flag to indicate re-association
2486 * @status: association response status code
2487 * @ie: assoc response ie buffer
2488 * @len: ie buffer length
2489 * Returns: 0 on success, -1 on failure
2491 * This function indicates the driver to send (Re)Association
2492 * Response frame to the station.
2494 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2495 int reassoc, u16 status, const u8 *ie, size_t len);
2498 * sta_auth - Station authentication indication
2499 * @priv: Private driver interface data
2500 * @own_addr: Source address and BSSID for authentication frame
2501 * @addr: MAC address of the station to associate
2502 * @seq: authentication sequence number
2503 * @status: authentication response status code
2504 * @ie: authentication frame ie buffer
2505 * @len: ie buffer length
2507 * This function indicates the driver to send Authentication frame
2510 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2511 u16 seq, u16 status, const u8 *ie, size_t len);
2514 * add_tspec - Add traffic stream
2515 * @priv: Private driver interface data
2516 * @addr: MAC address of the station to associate
2517 * @tspec_ie: tspec ie buffer
2518 * @tspec_ielen: tspec ie length
2519 * Returns: 0 on success, -1 on failure
2521 * This function adds the traffic steam for the station
2522 * and fills the medium_time in tspec_ie.
2524 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2525 size_t tspec_ielen);
2528 * add_sta_node - Add a station node in the driver
2529 * @priv: Private driver interface data
2530 * @addr: MAC address of the station to add
2531 * @auth_alg: authentication algorithm used by the station
2532 * Returns: 0 on success, -1 on failure
2534 * This function adds the station node in the driver, when
2535 * the station gets added by FT-over-DS.
2537 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2540 * sched_scan - Request the driver to initiate scheduled scan
2541 * @priv: Private driver interface data
2542 * @params: Scan parameters
2543 * @interval: Interval between scan cycles in milliseconds
2544 * Returns: 0 on success, -1 on failure
2546 * This operation should be used for scheduled scan offload to
2547 * the hardware. Every time scan results are available, the
2548 * driver should report scan results event for wpa_supplicant
2549 * which will eventually request the results with
2550 * wpa_driver_get_scan_results2(). This operation is optional
2551 * and if not provided or if it returns -1, we fall back to
2552 * normal host-scheduled scans.
2554 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2558 * stop_sched_scan - Request the driver to stop a scheduled scan
2559 * @priv: Private driver interface data
2560 * Returns: 0 on success, -1 on failure
2562 * This should cause the scheduled scan to be stopped and
2563 * results should stop being sent. Must be supported if
2564 * sched_scan is supported.
2566 int (*stop_sched_scan)(void *priv);
2569 * poll_client - Probe (null data or such) the given station
2570 * @priv: Private driver interface data
2571 * @own_addr: MAC address of sending interface
2572 * @addr: MAC address of the station to probe
2573 * @qos: Indicates whether station is QoS station
2575 * This function is used to verify whether an associated station is
2576 * still present. This function does not need to be implemented if the
2577 * driver provides such inactivity polling mechanism.
2579 void (*poll_client)(void *priv, const u8 *own_addr,
2580 const u8 *addr, int qos);
2583 * radio_disable - Disable/enable radio
2584 * @priv: Private driver interface data
2585 * @disabled: 1=disable 0=enable radio
2586 * Returns: 0 on success, -1 on failure
2588 * This optional command is for testing purposes. It can be used to
2589 * disable the radio on a testbed device to simulate out-of-radio-range
2592 int (*radio_disable)(void *priv, int disabled);
2595 * switch_channel - Announce channel switch and migrate the GO to the
2597 * @priv: Private driver interface data
2598 * @freq: Frequency in MHz
2599 * Returns: 0 on success, -1 on failure
2601 * This function is used to move the GO to the legacy STA channel to
2602 * avoid frequency conflict in single channel concurrency.
2604 int (*switch_channel)(void *priv, unsigned int freq);
2609 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2611 enum wpa_event_type {
2613 * EVENT_ASSOC - Association completed
2615 * This event needs to be delivered when the driver completes IEEE
2616 * 802.11 association or reassociation successfully.
2617 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2618 * after this event has been generated. In addition, optional
2619 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2620 * more information about the association. If the driver interface gets
2621 * both of these events at the same time, it can also include the
2622 * assoc_info data in EVENT_ASSOC call.
2627 * EVENT_DISASSOC - Association lost
2629 * This event should be called when association is lost either due to
2630 * receiving deauthenticate or disassociate frame from the AP or when
2631 * sending either of these frames to the current AP. If the driver
2632 * supports separate deauthentication event, EVENT_DISASSOC should only
2633 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2634 * In AP mode, union wpa_event_data::disassoc_info is required.
2639 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2641 * This event must be delivered when a Michael MIC error is detected by
2642 * the local driver. Additional data for event processing is
2643 * provided with union wpa_event_data::michael_mic_failure. This
2644 * information is used to request new encyption key and to initiate
2645 * TKIP countermeasures if needed.
2647 EVENT_MICHAEL_MIC_FAILURE,
2650 * EVENT_SCAN_RESULTS - Scan results available
2652 * This event must be called whenever scan results are available to be
2653 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2654 * is expected to be used some time after struct wpa_driver_ops::scan()
2655 * is called. If the driver provides an unsolicited event when the scan
2656 * has been completed, this event can be used to trigger
2657 * EVENT_SCAN_RESULTS call. If such event is not available from the
2658 * driver, the driver wrapper code is expected to use a registered
2659 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2660 * scan is expected to be completed. Optional information about
2661 * completed scan can be provided with union wpa_event_data::scan_info.
2666 * EVENT_ASSOCINFO - Report optional extra information for association
2668 * This event can be used to report extra association information for
2669 * EVENT_ASSOC processing. This extra information includes IEs from
2670 * association frames and Beacon/Probe Response frames in union
2671 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2672 * EVENT_ASSOC. Alternatively, the driver interface can include
2673 * assoc_info data in the EVENT_ASSOC call if it has all the
2674 * information available at the same point.
2679 * EVENT_INTERFACE_STATUS - Report interface status changes
2681 * This optional event can be used to report changes in interface
2682 * status (interface added/removed) using union
2683 * wpa_event_data::interface_status. This can be used to trigger
2684 * wpa_supplicant to stop and re-start processing for the interface,
2685 * e.g., when a cardbus card is ejected/inserted.
2687 EVENT_INTERFACE_STATUS,
2690 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2692 * This event can be used to inform wpa_supplicant about candidates for
2693 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2694 * for scan request (ap_scan=2 mode), this event is required for
2695 * pre-authentication. If wpa_supplicant is performing scan request
2696 * (ap_scan=1), this event is optional since scan results can be used
2697 * to add pre-authentication candidates. union
2698 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2699 * candidate and priority of the candidate, e.g., based on the signal
2700 * strength, in order to try to pre-authenticate first with candidates
2701 * that are most likely targets for re-association.
2703 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2704 * on the candidate list. In addition, it can be called for the current
2705 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2706 * will automatically skip pre-authentication in cases where a valid
2707 * PMKSA exists. When more than one candidate exists, this event should
2708 * be generated once for each candidate.
2710 * Driver will be notified about successful pre-authentication with
2711 * struct wpa_driver_ops::add_pmkid() calls.
2713 EVENT_PMKID_CANDIDATE,
2716 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2718 * This event can be used to inform wpa_supplicant about desire to set
2719 * up secure direct link connection between two stations as defined in
2720 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2721 * STAKey negotiation. The caller will need to set peer address for the
2727 * EVENT_TDLS - Request TDLS operation
2729 * This event can be used to request a TDLS operation to be performed.
2734 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2736 * The driver is expected to report the received FT IEs from
2737 * FT authentication sequence from the AP. The FT IEs are included in
2738 * the extra information in union wpa_event_data::ft_ies.
2743 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2745 * The driver can use this event to inform wpa_supplicant about a STA
2746 * in an IBSS with which protected frames could be exchanged. This
2747 * event starts RSN authentication with the other STA to authenticate
2748 * the STA and set up encryption keys with it.
2750 EVENT_IBSS_RSN_START,
2753 * EVENT_AUTH - Authentication result
2755 * This event should be called when authentication attempt has been
2756 * completed. This is only used if the driver supports separate
2757 * authentication step (struct wpa_driver_ops::authenticate).
2758 * Information about authentication result is included in
2759 * union wpa_event_data::auth.
2764 * EVENT_DEAUTH - Authentication lost
2766 * This event should be called when authentication is lost either due
2767 * to receiving deauthenticate frame from the AP or when sending that
2768 * frame to the current AP.
2769 * In AP mode, union wpa_event_data::deauth_info is required.
2774 * EVENT_ASSOC_REJECT - Association rejected
2776 * This event should be called when (re)association attempt has been
2777 * rejected by the AP. Information about the association response is
2778 * included in union wpa_event_data::assoc_reject.
2783 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2785 EVENT_AUTH_TIMED_OUT,
2788 * EVENT_ASSOC_TIMED_OUT - Association timed out
2790 EVENT_ASSOC_TIMED_OUT,
2793 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2798 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2800 EVENT_WPS_BUTTON_PUSHED,
2803 * EVENT_TX_STATUS - Report TX status
2808 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2810 EVENT_RX_FROM_UNKNOWN,
2813 * EVENT_RX_MGMT - Report RX of a management frame
2818 * EVENT_RX_ACTION - Action frame received
2820 * This event is used to indicate when an Action frame has been
2821 * received. Information about the received frame is included in
2822 * union wpa_event_data::rx_action.
2827 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2829 * This event is used to indicate when the driver has started the
2830 * requested remain-on-channel duration. Information about the
2831 * operation is included in union wpa_event_data::remain_on_channel.
2833 EVENT_REMAIN_ON_CHANNEL,
2836 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2838 * This event is used to indicate when the driver has completed
2839 * remain-on-channel duration, i.e., may noot be available on the
2840 * requested channel anymore. Information about the
2841 * operation is included in union wpa_event_data::remain_on_channel.
2843 EVENT_CANCEL_REMAIN_ON_CHANNEL,
2846 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2848 * This event is used only by driver_test.c and userspace MLME.
2853 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2855 * This event is used to indicate when a Probe Request frame has been
2856 * received. Information about the received frame is included in
2857 * union wpa_event_data::rx_probe_req. The driver is required to report
2858 * these events only after successfully completed probe_req_report()
2859 * commands to request the events (i.e., report parameter is non-zero)
2860 * in station mode. In AP mode, Probe Request frames should always be
2866 * EVENT_NEW_STA - New wired device noticed
2868 * This event is used to indicate that a new device has been detected
2869 * in a network that does not use association-like functionality (i.e.,
2870 * mainly wired Ethernet). This can be used to start EAPOL
2871 * authenticator when receiving a frame from a device. The address of
2872 * the device is included in union wpa_event_data::new_sta.
2877 * EVENT_EAPOL_RX - Report received EAPOL frame
2879 * When in AP mode with hostapd, this event is required to be used to
2880 * deliver the receive EAPOL frames from the driver. With
2881 * %wpa_supplicant, this event is used only if the send_eapol() handler
2882 * is used to override the use of l2_packet for EAPOL frame TX.
2887 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
2889 * This event is used to indicate changes in the signal strength
2890 * observed in frames received from the current AP if signal strength
2891 * monitoring has been enabled with signal_monitor().
2893 EVENT_SIGNAL_CHANGE,
2896 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
2898 * This event is used to indicate that the interface was enabled after
2899 * having been previously disabled, e.g., due to rfkill.
2901 EVENT_INTERFACE_ENABLED,
2904 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
2906 * This event is used to indicate that the interface was disabled,
2907 * e.g., due to rfkill.
2909 EVENT_INTERFACE_DISABLED,
2912 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
2914 * This event is used to indicate that the channel list has changed,
2915 * e.g., because of a regulatory domain change triggered by scan
2916 * results including an AP advertising a country code.
2918 EVENT_CHANNEL_LIST_CHANGED,
2921 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
2923 * This event is used to indicate that the driver cannot maintain this
2924 * interface in its operation mode anymore. The most likely use for
2925 * this is to indicate that AP mode operation is not available due to
2926 * operating channel would need to be changed to a DFS channel when
2927 * the driver does not support radar detection and another virtual
2928 * interfaces caused the operating channel to change. Other similar
2929 * resource conflicts could also trigger this for station mode
2932 EVENT_INTERFACE_UNAVAILABLE,
2935 * EVENT_BEST_CHANNEL
2937 * Driver generates this event whenever it detects a better channel
2938 * (e.g., based on RSSI or channel use). This information can be used
2939 * to improve channel selection for a new AP/P2P group.
2944 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
2946 * This event should be called when a Deauthentication frame is dropped
2947 * due to it not being protected (MFP/IEEE 802.11w).
2948 * union wpa_event_data::unprot_deauth is required to provide more
2949 * details of the frame.
2951 EVENT_UNPROT_DEAUTH,
2954 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
2956 * This event should be called when a Disassociation frame is dropped
2957 * due to it not being protected (MFP/IEEE 802.11w).
2958 * union wpa_event_data::unprot_disassoc is required to provide more
2959 * details of the frame.
2961 EVENT_UNPROT_DISASSOC,
2964 * EVENT_STATION_LOW_ACK
2966 * Driver generates this event whenever it detected that a particular
2967 * station was lost. Detection can be through massive transmission
2968 * failures for example.
2970 EVENT_STATION_LOW_ACK,
2973 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
2975 * This event is used only if the driver implements P2P management
2976 * internally. Event data is stored in
2977 * union wpa_event_data::p2p_dev_found.
2979 EVENT_P2P_DEV_FOUND,
2982 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
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_go_neg_req_rx.
2988 EVENT_P2P_GO_NEG_REQ_RX,
2991 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
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_completed.
2997 EVENT_P2P_GO_NEG_COMPLETED,
2999 EVENT_P2P_PROV_DISC_REQUEST,
3000 EVENT_P2P_PROV_DISC_RESPONSE,
3001 EVENT_P2P_SD_REQUEST,
3002 EVENT_P2P_SD_RESPONSE,
3005 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3007 EVENT_IBSS_PEER_LOST,
3010 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3012 * This event carries the new replay counter to notify wpa_supplicant
3013 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3014 * completed Group Key Handshake while the host (including
3015 * wpa_supplicant was sleeping).
3017 EVENT_DRIVER_GTK_REKEY,
3020 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3022 EVENT_SCHED_SCAN_STOPPED,
3025 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3027 * This event indicates that the station responded to the poll
3028 * initiated with @poll_client.
3030 EVENT_DRIVER_CLIENT_POLL_OK,
3033 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3035 EVENT_EAPOL_TX_STATUS,
3038 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3040 * Described in wpa_event_data.ch_switch
3045 * EVENT_WNM - Request WNM operation
3047 * This event can be used to request a WNM operation to be performed.
3054 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3056 union wpa_event_data {
3058 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3060 * This structure is optional for EVENT_ASSOC calls and required for
3061 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3062 * driver interface does not need to generate separate EVENT_ASSOCINFO
3067 * reassoc - Flag to indicate association or reassociation
3072 * req_ies - (Re)Association Request IEs
3074 * If the driver generates WPA/RSN IE, this event data must be
3075 * returned for WPA handshake to have needed information. If
3076 * wpa_supplicant-generated WPA/RSN IE is used, this
3077 * information event is optional.
3079 * This should start with the first IE (fixed fields before IEs
3080 * are not included).
3085 * req_ies_len - Length of req_ies in bytes
3090 * resp_ies - (Re)Association Response IEs
3092 * Optional association data from the driver. This data is not
3093 * required WPA, but may be useful for some protocols and as
3094 * such, should be reported if this is available to the driver
3097 * This should start with the first IE (fixed fields before IEs
3098 * are not included).
3103 * resp_ies_len - Length of resp_ies in bytes
3105 size_t resp_ies_len;
3108 * beacon_ies - Beacon or Probe Response IEs
3110 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3111 * Probe Response frames from the current AP (i.e., the one
3112 * that the client just associated with). This information is
3113 * used to update WPA/RSN IE for the AP. If this field is not
3114 * set, the results from previous scan will be used. If no
3115 * data for the new AP is found, scan results will be requested
3116 * again (without scan request). At this point, the driver is
3117 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3120 * This should start with the first IE (fixed fields before IEs
3121 * are not included).
3123 const u8 *beacon_ies;
3126 * beacon_ies_len - Length of beacon_ies */
3127 size_t beacon_ies_len;
3130 * freq - Frequency of the operational channel in MHz
3135 * addr - Station address (for AP mode)
3141 * struct disassoc_info - Data for EVENT_DISASSOC events
3143 struct disassoc_info {
3145 * addr - Station address (for AP mode)
3150 * reason_code - Reason Code (host byte order) used in
3151 * Deauthentication frame
3156 * ie - Optional IE(s) in Disassociation frame
3161 * ie_len - Length of ie buffer in octets
3166 * locally_generated - Whether the frame was locally generated
3168 int locally_generated;
3172 * struct deauth_info - Data for EVENT_DEAUTH events
3174 struct deauth_info {
3176 * addr - Station address (for AP mode)
3181 * reason_code - Reason Code (host byte order) used in
3182 * Deauthentication frame
3187 * ie - Optional IE(s) in Deauthentication frame
3192 * ie_len - Length of ie buffer in octets
3197 * locally_generated - Whether the frame was locally generated
3199 int locally_generated;
3203 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3205 struct michael_mic_failure {
3208 } michael_mic_failure;
3211 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3213 struct interface_status {
3216 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3221 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3223 struct pmkid_candidate {
3224 /** BSSID of the PMKID candidate */
3226 /** Smaller the index, higher the priority */
3228 /** Whether RSN IE includes pre-authenticate flag */
3233 * struct stkstart - Data for EVENT_STKSTART
3240 * struct tdls - Data for EVENT_TDLS
3246 TDLS_REQUEST_TEARDOWN
3248 u16 reason_code; /* for teardown */
3252 * struct wnm - Data for EVENT_WNM
3270 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3272 * During FT (IEEE 802.11r) authentication sequence, the driver is
3273 * expected to use this event to report received FT IEs (MDIE, FTIE,
3274 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3275 * IEs for the next message will be delivered through the
3276 * struct wpa_driver_ops::update_ft_ies() callback.
3282 u8 target_ap[ETH_ALEN];
3283 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3285 /** Length of ric_ies buffer in octets */
3290 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3292 struct ibss_rsn_start {
3297 * struct auth_info - Data for EVENT_AUTH events
3303 u16 auth_transaction;
3310 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3312 struct assoc_reject {
3314 * bssid - BSSID of the AP that rejected association
3319 * resp_ies - (Re)Association Response IEs
3321 * Optional association data from the driver. This data is not
3322 * required WPA, but may be useful for some protocols and as
3323 * such, should be reported if this is available to the driver
3326 * This should start with the first IE (fixed fields before IEs
3327 * are not included).
3332 * resp_ies_len - Length of resp_ies in bytes
3334 size_t resp_ies_len;
3337 * status_code - Status Code from (Re)association Response
3342 struct timeout_event {
3347 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3356 * struct tx_status - Data for EVENT_TX_STATUS events
3368 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3370 struct rx_from_unknown {
3377 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3383 int ssi_signal; /* dBm */
3387 * struct rx_action - Data for EVENT_RX_ACTION events
3391 * da - Destination address of the received Action frame
3396 * sa - Source address of the received Action frame
3401 * bssid - Address 3 of the received Action frame
3406 * category - Action frame category
3411 * data - Action frame body after category field
3416 * len - Length of data in octets
3421 * freq - Frequency (in MHz) on which the frame was received
3427 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3429 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3431 struct remain_on_channel {
3433 * freq - Channel frequency in MHz
3438 * duration - Duration to remain on the channel in milliseconds
3440 unsigned int duration;
3441 } remain_on_channel;
3444 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3445 * @aborted: Whether the scan was aborted
3446 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3447 * @num_freqs: Number of entries in freqs array
3448 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3450 * @num_ssids: Number of entries in ssids array
3456 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3461 * struct mlme_rx - Data for EVENT_MLME_RX events
3472 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3474 struct rx_probe_req {
3476 * sa - Source address of the received Probe Request frame
3481 * da - Destination address of the received Probe Request frame
3482 * or %NULL if not available
3487 * bssid - BSSID of the received Probe Request frame or %NULL
3493 * ie - IEs from the Probe Request body
3498 * ie_len - Length of ie buffer in octets
3503 * signal - signal strength in dBm (or 0 if not available)
3509 * struct new_sta - Data for EVENT_NEW_STA events
3516 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3525 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3527 struct wpa_signal_info signal_change;
3530 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3531 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3532 * @freq_5: Best 5 GHz band channel frequency in MHz
3533 * @freq_overall: Best channel frequency in MHz
3535 * 0 can be used to indicate no preference in either band.
3537 struct best_channel {
3543 struct unprot_deauth {
3549 struct unprot_disassoc {
3556 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3557 * @addr: station address
3564 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3566 struct p2p_dev_found {
3569 const u8 *pri_dev_type;
3570 const char *dev_name;
3577 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3579 struct p2p_go_neg_req_rx {
3582 } p2p_go_neg_req_rx;
3585 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3587 struct p2p_go_neg_completed {
3588 struct p2p_go_neg_results *res;
3589 } p2p_go_neg_completed;
3591 struct p2p_prov_disc_req {
3595 const u8 *pri_dev_type;
3596 const char *dev_name;
3597 u16 supp_config_methods;
3600 } p2p_prov_disc_req;
3602 struct p2p_prov_disc_resp {
3605 } p2p_prov_disc_resp;
3616 struct p2p_sd_resp {
3624 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3626 struct ibss_peer_lost {
3631 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3633 struct driver_gtk_rekey {
3635 const u8 *replay_ctr;
3639 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
3640 * @addr: station address
3642 struct client_poll {
3647 * struct eapol_tx_status
3648 * @dst: Original destination
3649 * @data: Data starting with IEEE 802.1X header (!)
3650 * @data_len: Length of data
3651 * @ack: Indicates ack or lost frame
3653 * This corresponds to hapd_send_eapol if the frame sent
3654 * there isn't just reported as EVENT_TX_STATUS.
3656 struct eapol_tx_status {
3665 * @freq: Frequency of new channel in MHz
3666 * @ht_enabled: Whether this is an HT channel
3667 * @ch_offset: Secondary channel offset
3677 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3678 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3679 * with struct wpa_driver_ops::init()
3680 * @event: event type (defined above)
3681 * @data: possible extra data for the event
3683 * Driver wrapper code should call this function whenever an event is received
3686 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
3687 union wpa_event_data *data);
3691 * The following inline functions are provided for convenience to simplify
3692 * event indication for some of the common events.
3695 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
3696 size_t ielen, int reassoc)
3698 union wpa_event_data event;
3699 os_memset(&event, 0, sizeof(event));
3700 event.assoc_info.reassoc = reassoc;
3701 event.assoc_info.req_ies = ie;
3702 event.assoc_info.req_ies_len = ielen;
3703 event.assoc_info.addr = addr;
3704 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
3707 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
3709 union wpa_event_data event;
3710 os_memset(&event, 0, sizeof(event));
3711 event.disassoc_info.addr = addr;
3712 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
3715 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
3718 union wpa_event_data event;
3719 os_memset(&event, 0, sizeof(event));
3720 event.eapol_rx.src = src;
3721 event.eapol_rx.data = data;
3722 event.eapol_rx.data_len = data_len;
3723 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
3726 /* driver_common.c */
3727 void wpa_scan_results_free(struct wpa_scan_results *res);
3729 /* Convert wpa_event_type to a string for logging */
3730 const char * event_to_string(enum wpa_event_type event);
3732 #endif /* DRIVER_H */