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
32 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
33 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
34 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
35 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
36 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
39 * struct hostapd_channel_data - Channel information
41 struct hostapd_channel_data {
43 * chan - Channel number (IEEE 802.11)
48 * freq - Frequency in MHz
53 * flag - Channel flags (HOSTAPD_CHAN_*)
58 * max_tx_power - maximum transmit power in dBm
63 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
66 * struct hostapd_hw_modes - Supported hardware mode information
68 struct hostapd_hw_modes {
70 * mode - Hardware mode
72 enum hostapd_hw_mode mode;
75 * num_channels - Number of entries in the channels array
80 * channels - Array of supported channels
82 struct hostapd_channel_data *channels;
85 * num_rates - Number of entries in the rates array
90 * rates - Array of supported rates in 100 kbps units
95 * ht_capab - HT (IEEE 802.11n) capabilities
100 * mcs_set - MCS (IEEE 802.11n) rate parameters
105 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
110 * vht_capab - VHT (IEEE 802.11ac) capabilities
115 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
119 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
123 #define IEEE80211_MODE_INFRA 0
124 #define IEEE80211_MODE_IBSS 1
125 #define IEEE80211_MODE_AP 2
127 #define IEEE80211_CAP_ESS 0x0001
128 #define IEEE80211_CAP_IBSS 0x0002
129 #define IEEE80211_CAP_PRIVACY 0x0010
131 /* DMG (60 GHz) IEEE 802.11ad */
132 /* type - bits 0..1 */
133 #define IEEE80211_CAP_DMG_MASK 0x0003
134 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
135 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
136 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
138 #define WPA_SCAN_QUAL_INVALID BIT(0)
139 #define WPA_SCAN_NOISE_INVALID BIT(1)
140 #define WPA_SCAN_LEVEL_INVALID BIT(2)
141 #define WPA_SCAN_LEVEL_DBM BIT(3)
142 #define WPA_SCAN_AUTHENTICATED BIT(4)
143 #define WPA_SCAN_ASSOCIATED BIT(5)
146 * struct wpa_scan_res - Scan result for an BSS/IBSS
147 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
149 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
150 * @beacon_int: beacon interval in TUs (host byte order)
151 * @caps: capability information field in host byte order
152 * @qual: signal quality
153 * @noise: noise level
154 * @level: signal level
156 * @age: Age of the information in milliseconds (i.e., how many milliseconds
157 * ago the last Beacon or Probe Response frame was received)
158 * @ie_len: length of the following IE field in octets
159 * @beacon_ie_len: length of the following Beacon IE field in octets
161 * This structure is used as a generic format for scan results from the
162 * driver. Each driver interface implementation is responsible for converting
163 * the driver or OS specific scan results into this format.
165 * If the driver does not support reporting all IEs, the IE data structure is
166 * constructed of the IEs that are available. This field will also need to
167 * include SSID in IE format. All drivers are encouraged to be extended to
168 * report all IEs to make it easier to support future additions.
170 struct wpa_scan_res {
182 size_t beacon_ie_len;
184 * Followed by ie_len octets of IEs from Probe Response frame (or if
185 * the driver does not indicate source of IEs, these may also be from
186 * Beacon frame). After the first set of IEs, another set of IEs may
187 * follow (with beacon_ie_len octets of data) if the driver provides
193 * struct wpa_scan_results - Scan results
194 * @res: Array of pointers to allocated variable length scan result entries
195 * @num: Number of entries in the scan result array
196 * @fetch_time: Time when the results were fetched from the driver
198 struct wpa_scan_results {
199 struct wpa_scan_res **res;
201 struct os_time fetch_time;
205 * struct wpa_interface_info - Network interface information
206 * @next: Pointer to the next interface or NULL if this is the last one
207 * @ifname: Interface name that can be used with init() or init2()
208 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
210 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
211 * is not an allocated copy, i.e., get_interfaces() caller will not free
214 struct wpa_interface_info {
215 struct wpa_interface_info *next;
218 const char *drv_name;
221 #define WPAS_MAX_SCAN_SSIDS 16
224 * struct wpa_driver_scan_params - Scan parameters
225 * Data for struct wpa_driver_ops::scan2().
227 struct wpa_driver_scan_params {
229 * ssids - SSIDs to scan for
231 struct wpa_driver_scan_ssid {
233 * ssid - specific SSID to scan for (ProbeReq)
234 * %NULL or zero-length SSID is used to indicate active scan
235 * with wildcard SSID.
239 * ssid_len: Length of the SSID in octets
242 } ssids[WPAS_MAX_SCAN_SSIDS];
245 * num_ssids - Number of entries in ssids array
246 * Zero indicates a request for a passive scan.
251 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
256 * extra_ies_len - Length of extra_ies in octets
258 size_t extra_ies_len;
261 * freqs - Array of frequencies to scan or %NULL for all frequencies
263 * The frequency is set in MHz. The array is zero-terminated.
268 * filter_ssids - Filter for reporting SSIDs
270 * This optional parameter can be used to request the driver wrapper to
271 * filter scan results to include only the specified SSIDs. %NULL
272 * indicates that no filtering is to be done. This can be used to
273 * reduce memory needs for scan results in environments that have large
274 * number of APs with different SSIDs.
276 * The driver wrapper is allowed to take this allocated buffer into its
277 * own use by setting the pointer to %NULL. In that case, the driver
278 * wrapper is responsible for freeing the buffer with os_free() once it
279 * is not needed anymore.
281 struct wpa_driver_scan_filter {
287 * num_filter_ssids - Number of entries in filter_ssids array
289 size_t num_filter_ssids;
292 * filter_rssi - Filter by RSSI
294 * The driver may filter scan results in firmware to reduce host
295 * wakeups and thereby save power. Specify the RSSI threshold in s32
301 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
303 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
304 * Mbps from the support rates element(s) in the Probe Request frames
305 * and not to transmit the frames at any of those rates.
311 * struct wpa_driver_auth_params - Authentication parameters
312 * Data for struct wpa_driver_ops::authenticate().
314 struct wpa_driver_auth_params {
322 const u8 *wep_key[4];
323 size_t wep_key_len[4];
325 int local_state_change;
328 * p2p - Whether this connection is a P2P group
338 WPS_MODE_NONE /* no WPS provisioning being used */,
339 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
340 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
345 * struct wpa_driver_associate_params - Association parameters
346 * Data for struct wpa_driver_ops::associate().
348 struct wpa_driver_associate_params {
350 * bssid - BSSID of the selected AP
351 * This can be %NULL, if ap_scan=2 mode is used and the driver is
352 * responsible for selecting with which BSS to associate. */
356 * ssid - The selected SSID
361 * ssid_len - Length of the SSID (1..32)
366 * freq - Frequency of the channel the selected AP is using
367 * Frequency that the selected AP is using (in MHz as
368 * reported in the scan results)
373 * bg_scan_period - Background scan period in seconds, 0 to disable
374 * background scan, or -1 to indicate no change to default driver
380 * wpa_ie - WPA information element for (Re)Association Request
381 * WPA information element to be included in (Re)Association
382 * Request (including information element id and length). Use
383 * of this WPA IE is optional. If the driver generates the WPA
384 * IE, it can use pairwise_suite, group_suite, and
385 * key_mgmt_suite to select proper algorithms. In this case,
386 * the driver has to notify wpa_supplicant about the used WPA
387 * IE by generating an event that the interface code will
388 * convert into EVENT_ASSOCINFO data (see below).
390 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
391 * instead. The driver can determine which version is used by
392 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
395 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
400 * wpa_ie_len - length of the wpa_ie
405 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
407 unsigned int wpa_proto;
410 * pairwise_suite - Selected pairwise cipher suite
412 * This is usually ignored if @wpa_ie is used.
414 enum wpa_cipher pairwise_suite;
417 * group_suite - Selected group cipher suite
419 * This is usually ignored if @wpa_ie is used.
421 enum wpa_cipher group_suite;
424 * key_mgmt_suite - Selected key management suite
426 * This is usually ignored if @wpa_ie is used.
428 enum wpa_key_mgmt key_mgmt_suite;
431 * auth_alg - Allowed authentication algorithms
432 * Bit field of WPA_AUTH_ALG_*
437 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
442 * wep_key - WEP keys for static WEP configuration
444 const u8 *wep_key[4];
447 * wep_key_len - WEP key length for static WEP configuration
449 size_t wep_key_len[4];
452 * wep_tx_keyidx - WEP TX key index for static WEP configuration
457 * mgmt_frame_protection - IEEE 802.11w management frame protection
459 enum mfp_options mgmt_frame_protection;
462 * ft_ies - IEEE 802.11r / FT information elements
463 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
464 * for fast transition, this parameter is set to include the IEs that
465 * are to be sent in the next FT Authentication Request message.
466 * update_ft_ies() handler is called to update the IEs for further
467 * FT messages in the sequence.
469 * The driver should use these IEs only if the target AP is advertising
470 * the same mobility domain as the one included in the MDIE here.
472 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
473 * AP after the initial association. These IEs can only be used if the
474 * target AP is advertising support for FT and is using the same MDIE
475 * and SSID as the current AP.
477 * The driver is responsible for reporting the FT IEs received from the
478 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
479 * type. update_ft_ies() handler will then be called with the FT IEs to
480 * include in the next frame in the authentication sequence.
485 * ft_ies_len - Length of ft_ies in bytes
490 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
492 * This value is provided to allow the driver interface easier access
493 * to the current mobility domain. This value is set to %NULL if no
494 * mobility domain is currently active.
499 * passphrase - RSN passphrase for PSK
501 * This value is made available only for WPA/WPA2-Personal (PSK) and
502 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
503 * the 8..63 character ASCII passphrase, if available. Please note that
504 * this can be %NULL if passphrase was not used to generate the PSK. In
505 * that case, the psk field must be used to fetch the PSK.
507 const char *passphrase;
510 * psk - RSN PSK (alternative for passphrase for PSK)
512 * This value is made available only for WPA/WPA2-Personal (PSK) and
513 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
514 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
515 * be prepared to handle %NULL value as an error.
520 * drop_unencrypted - Enable/disable unencrypted frame filtering
522 * Configure the driver to drop all non-EAPOL frames (both receive and
523 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
524 * still be allowed for key negotiation.
526 int drop_unencrypted;
529 * prev_bssid - Previously used BSSID in this ESS
531 * When not %NULL, this is a request to use reassociation instead of
534 const u8 *prev_bssid;
539 * If the driver needs to do special configuration for WPS association,
540 * this variable provides more information on what type of association
541 * is being requested. Most drivers should not need ot use this.
546 * p2p - Whether this connection is a P2P group
551 * uapsd - UAPSD parameters for the network
552 * -1 = do not change defaults
553 * AP mode: 1 = enabled, 0 = disabled
554 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
559 * fixed_bssid - Whether to force this BSSID in IBSS mode
560 * 1 = Fix this BSSID and prevent merges.
561 * 0 = Do not fix BSSID.
566 * disable_ht - Disable HT (IEEE 802.11n) for this connection
571 * HT Capabilities over-rides. Only bits set in the mask will be used,
572 * and not all values are used by the kernel anyway. Currently, MCS,
573 * MPDU and MSDU fields are used.
575 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */
576 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */
578 #ifdef CONFIG_VHT_OVERRIDES
580 * disable_vht - Disable VHT for this connection
585 * VHT capability overrides.
587 const struct ieee80211_vht_capabilities *vhtcaps;
588 const struct ieee80211_vht_capabilities *vhtcaps_mask;
589 #endif /* CONFIG_VHT_OVERRIDES */
594 HIDDEN_SSID_ZERO_LEN,
595 HIDDEN_SSID_ZERO_CONTENTS
598 struct wpa_driver_ap_params {
600 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
605 * head_len - Length of the head buffer in octets
610 * tail - Beacon tail following TIM IE
615 * tail_len - Length of the tail buffer in octets
620 * dtim_period - DTIM period
625 * beacon_int - Beacon interval
630 * basic_rates: -1 terminated array of basic rates in 100 kbps
632 * This parameter can be used to set a specific basic rate set for the
633 * BSS. If %NULL, default basic rate set is used.
638 * proberesp - Probe Response template
640 * This is used by drivers that reply to Probe Requests internally in
641 * AP mode and require the full Probe Response template.
646 * proberesp_len - Length of the proberesp buffer in octets
648 size_t proberesp_len;
651 * ssid - The SSID to use in Beacon/Probe Response frames
656 * ssid_len - Length of the SSID (1..32)
661 * hide_ssid - Whether to hide the SSID
663 enum hide_ssid hide_ssid;
666 * pairwise_ciphers - WPA_CIPHER_* bitfield
668 unsigned int pairwise_ciphers;
671 * group_cipher - WPA_CIPHER_*
673 unsigned int group_cipher;
676 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
678 unsigned int key_mgmt_suites;
681 * auth_algs - WPA_AUTH_ALG_* bitfield
683 unsigned int auth_algs;
686 * wpa_version - WPA_PROTO_* bitfield
688 unsigned int wpa_version;
691 * privacy - Whether privacy is used in the BSS
696 * beacon_ies - WPS/P2P IE(s) for Beacon frames
698 * This is used to add IEs like WPS IE and P2P IE by drivers that do
699 * not use the full Beacon template.
701 const struct wpabuf *beacon_ies;
704 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
706 * This is used to add IEs like WPS IE and P2P IE by drivers that
707 * reply to Probe Request frames internally.
709 const struct wpabuf *proberesp_ies;
712 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
714 * This is used to add IEs like WPS IE by drivers that reply to
715 * (Re)Association Request frames internally.
717 const struct wpabuf *assocresp_ies;
720 * isolate - Whether to isolate frames between associated stations
722 * If this is non-zero, the AP is requested to disable forwarding of
723 * frames between associated stations.
728 * cts_protect - Whether CTS protection is enabled
733 * preamble - Whether short preamble is enabled
738 * short_slot_time - Whether short slot time is enabled
740 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
741 * not set (e.g., when 802.11g mode is not in use)
746 * ht_opmode - HT operation mode or -1 if HT not in use
751 * interworking - Whether Interworking is enabled
756 * hessid - Homogeneous ESS identifier or %NULL if not set
761 * access_network_type - Access Network Type (0..15)
763 * This is used for filtering Probe Request frames when Interworking is
766 u8 access_network_type;
769 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
771 * This is used by driver which advertises this capability.
773 int ap_max_inactivity;
776 * disable_dgaf - Whether group-addressed frames are disabled
782 * struct wpa_driver_capa - Driver capability information
784 struct wpa_driver_capa {
785 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
786 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
787 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
788 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
789 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
790 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
791 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
792 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
793 unsigned int key_mgmt;
795 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
796 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
797 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
798 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
799 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
800 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
803 #define WPA_DRIVER_AUTH_OPEN 0x00000001
804 #define WPA_DRIVER_AUTH_SHARED 0x00000002
805 #define WPA_DRIVER_AUTH_LEAP 0x00000004
808 /* Driver generated WPA/RSN IE */
809 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
810 /* Driver needs static WEP key setup after association command */
811 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
812 /* unused: 0x00000004 */
813 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
814 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
815 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
816 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
817 /* Driver provides separate commands for authentication and association (SME in
818 * wpa_supplicant). */
819 #define WPA_DRIVER_FLAGS_SME 0x00000020
820 /* Driver supports AP mode */
821 #define WPA_DRIVER_FLAGS_AP 0x00000040
822 /* Driver needs static WEP key setup after association has been completed */
823 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
824 /* Driver takes care of P2P management operations */
825 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
826 /* Driver supports concurrent P2P operations */
827 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
829 * Driver uses the initial interface as a dedicated management interface, i.e.,
830 * it cannot be used for P2P group operations or non-P2P purposes.
832 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
833 /* This interface is P2P capable (P2P GO or P2P Client) */
834 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
835 /* Driver supports concurrent operations on multiple channels */
836 #define WPA_DRIVER_FLAGS_MULTI_CHANNEL_CONCURRENT 0x00001000
838 * Driver uses the initial interface for P2P management interface and non-P2P
839 * purposes (e.g., connect to infra AP), but this interface cannot be used for
840 * P2P group operations.
842 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
844 * Driver is known to use sane error codes, i.e., when it indicates that
845 * something (e.g., association) fails, there was indeed a failure and the
846 * operation does not end up getting completed successfully later.
848 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
849 /* Driver supports off-channel TX */
850 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
851 /* Driver indicates TX status events for EAPOL Data frames */
852 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
853 /* Driver indicates TX status events for Deauth/Disassoc frames */
854 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
855 /* Driver supports roaming (BSS selection) in firmware */
856 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
857 /* Driver supports operating as a TDLS peer */
858 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
859 /* Driver requires external TDLS setup/teardown/discovery */
860 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
861 /* Driver indicates support for Probe Response offloading in AP mode */
862 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
863 /* Driver supports U-APSD in AP mode */
864 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
865 /* Driver supports inactivity timer in AP mode */
866 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
867 /* Driver expects user space implementation of MLME in AP mode */
868 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
869 /* Driver supports SAE with user space SME */
870 #define WPA_DRIVER_FLAGS_SAE 0x02000000
871 /* Driver makes use of OBSS scan mechanism in wpa_supplicant */
872 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
873 /* Driver supports IBSS (Ad-hoc) mode */
874 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
875 /* Driver supports radar detection */
876 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
877 /* Driver supports a dedicated interface for P2P Device */
878 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
882 int max_sched_scan_ssids;
883 int sched_scan_supported;
887 * max_remain_on_chan - Maximum remain-on-channel duration in msec
889 unsigned int max_remain_on_chan;
892 * max_stations - Maximum number of associated stations the driver
893 * supports in AP mode
895 unsigned int max_stations;
898 * probe_resp_offloads - Bitmap of supported protocols by the driver
899 * for Probe Response offloading.
901 /* Driver Probe Response offloading support for WPS ver. 1 */
902 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
903 /* Driver Probe Response offloading support for WPS ver. 2 */
904 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
905 /* Driver Probe Response offloading support for P2P */
906 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
907 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
908 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
909 unsigned int probe_resp_offloads;
911 unsigned int max_acl_mac_addrs;
914 * extended_capa - extended capabilities in driver/device
916 * Must be allocated and freed by driver and the pointers must be
917 * valid for the lifetime of the driver, i.e., freed in deinit()
919 const u8 *extended_capa, *extended_capa_mask;
920 unsigned int extended_capa_len;
926 struct hostap_sta_driver_data {
927 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
928 unsigned long current_tx_rate;
929 unsigned long inactive_msec;
931 unsigned long num_ps_buf_frames;
932 unsigned long tx_retry_failed;
933 unsigned long tx_retry_count;
938 struct hostapd_sta_add_params {
942 const u8 *supp_rates;
943 size_t supp_rates_len;
945 const struct ieee80211_ht_capabilities *ht_capabilities;
946 const struct ieee80211_vht_capabilities *vht_capabilities;
947 u32 flags; /* bitmask of WPA_STA_* flags */
948 int set; /* Set STA parameters instead of add */
951 size_t ext_capab_len;
954 struct hostapd_freq_params {
960 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
961 * secondary channel below primary, 1 = HT40
962 * enabled, secondary channel above primary */
967 /* valid for both HT and VHT, center_freq2 is non-zero
968 * only for bandwidth 80 and an 80+80 channel */
969 int center_freq1, center_freq2;
977 struct hostapd_acl_params {
979 unsigned int num_mac_acl;
980 struct mac_address mac_acl[0];
983 enum wpa_driver_if_type {
985 * WPA_IF_STATION - Station mode interface
990 * WPA_IF_AP_VLAN - AP mode VLAN interface
992 * This interface shares its address and Beacon frame with the main
998 * WPA_IF_AP_BSS - AP mode BSS interface
1000 * This interface has its own address and Beacon frame.
1005 * WPA_IF_P2P_GO - P2P Group Owner
1010 * WPA_IF_P2P_CLIENT - P2P Client
1015 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1016 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1021 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1022 * abstracted P2P Device function in the driver
1027 struct wpa_init_params {
1033 const char *test_socket;
1034 int use_pae_group_addr;
1038 u8 *own_addr; /* buffer for writing own MAC address */
1042 struct wpa_bss_params {
1043 /** Interface name (for multi-SSID/VLAN support) */
1045 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1054 enum mfp_options ieee80211w;
1057 #define WPA_STA_AUTHORIZED BIT(0)
1058 #define WPA_STA_WMM BIT(1)
1059 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1060 #define WPA_STA_MFP BIT(3)
1061 #define WPA_STA_TDLS_PEER BIT(4)
1064 * struct p2p_params - P2P parameters for driver-based P2P management
1067 const char *dev_name;
1069 #define DRV_MAX_SEC_DEV_TYPES 5
1070 u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8];
1071 size_t num_sec_dev_types;
1085 WNM_SLEEP_ENTER_CONFIRM,
1086 WNM_SLEEP_ENTER_FAIL,
1087 WNM_SLEEP_EXIT_CONFIRM,
1088 WNM_SLEEP_EXIT_FAIL,
1089 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1090 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1091 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1093 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1095 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1096 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1098 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1101 /* enum chan_width - Channel width definitions */
1113 * struct wpa_signal_info - Information about channel signal quality
1115 struct wpa_signal_info {
1117 int above_threshold;
1122 enum chan_width chanwidth;
1128 * struct wpa_driver_ops - Driver interface API definition
1130 * This structure defines the API that each driver interface needs to implement
1131 * for core wpa_supplicant code. All driver specific functionality is captured
1134 struct wpa_driver_ops {
1135 /** Name of the driver interface */
1137 /** One line description of the driver interface */
1141 * get_bssid - Get the current BSSID
1142 * @priv: private driver interface data
1143 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1145 * Returns: 0 on success, -1 on failure
1147 * Query kernel driver for the current BSSID and copy it to bssid.
1148 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1151 int (*get_bssid)(void *priv, u8 *bssid);
1154 * get_ssid - Get the current SSID
1155 * @priv: private driver interface data
1156 * @ssid: buffer for SSID (at least 32 bytes)
1158 * Returns: Length of the SSID on success, -1 on failure
1160 * Query kernel driver for the current SSID and copy it to ssid.
1161 * Returning zero is recommended if the STA is not associated.
1163 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1164 * can, at least in theory, contain control characters (including nul)
1165 * and as such, should be processed as binary data, not a printable
1168 int (*get_ssid)(void *priv, u8 *ssid);
1171 * set_key - Configure encryption key
1172 * @ifname: Interface name (for multi-SSID/VLAN support)
1173 * @priv: private driver interface data
1174 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1175 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1177 * %WPA_ALG_NONE clears the key.
1178 * @addr: Address of the peer STA (BSSID of the current AP when setting
1179 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1180 * broadcast keys, %NULL for default keys that are used both for
1181 * broadcast and unicast; when clearing keys, %NULL is used to
1182 * indicate that both the broadcast-only and default key of the
1183 * specified key index is to be cleared
1184 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1186 * @set_tx: configure this key as the default Tx key (only used when
1187 * driver does not support separate unicast/individual key
1188 * @seq: sequence number/packet number, seq_len octets, the next
1189 * packet number to be used for in replay protection; configured
1190 * for Rx keys (in most cases, this is only used with broadcast
1191 * keys and set to zero for unicast keys); %NULL if not set
1192 * @seq_len: length of the seq, depends on the algorithm:
1193 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1194 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1196 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1197 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1199 * Returns: 0 on success, -1 on failure
1201 * Configure the given key for the kernel driver. If the driver
1202 * supports separate individual keys (4 default keys + 1 individual),
1203 * addr can be used to determine whether the key is default or
1204 * individual. If only 4 keys are supported, the default key with key
1205 * index 0 is used as the individual key. STA must be configured to use
1206 * it as the default Tx key (set_tx is set) and accept Rx for all the
1207 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1208 * broadcast keys, so key index 0 is available for this kind of
1211 * Please note that TKIP keys include separate TX and RX MIC keys and
1212 * some drivers may expect them in different order than wpa_supplicant
1213 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1214 * will trigger Michael MIC errors. This can be fixed by changing the
1215 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1216 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1217 * example on how this can be done.
1219 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1220 const u8 *addr, int key_idx, int set_tx,
1221 const u8 *seq, size_t seq_len,
1222 const u8 *key, size_t key_len);
1225 * init - Initialize driver interface
1226 * @ctx: context to be used when calling wpa_supplicant functions,
1227 * e.g., wpa_supplicant_event()
1228 * @ifname: interface name, e.g., wlan0
1230 * Returns: Pointer to private data, %NULL on failure
1232 * Initialize driver interface, including event processing for kernel
1233 * driver events (e.g., associated, scan results, Michael MIC failure).
1234 * This function can allocate a private configuration data area for
1235 * @ctx, file descriptor, interface name, etc. information that may be
1236 * needed in future driver operations. If this is not used, non-NULL
1237 * value will need to be returned because %NULL is used to indicate
1238 * failure. The returned value will be used as 'void *priv' data for
1239 * all other driver_ops functions.
1241 * The main event loop (eloop.c) of wpa_supplicant can be used to
1242 * register callback for read sockets (eloop_register_read_sock()).
1244 * See below for more information about events and
1245 * wpa_supplicant_event() function.
1247 void * (*init)(void *ctx, const char *ifname);
1250 * deinit - Deinitialize driver interface
1251 * @priv: private driver interface data from init()
1253 * Shut down driver interface and processing of driver events. Free
1254 * private data buffer if one was allocated in init() handler.
1256 void (*deinit)(void *priv);
1259 * set_param - Set driver configuration parameters
1260 * @priv: private driver interface data from init()
1261 * @param: driver specific configuration parameters
1263 * Returns: 0 on success, -1 on failure
1265 * Optional handler for notifying driver interface about configuration
1266 * parameters (driver_param).
1268 int (*set_param)(void *priv, const char *param);
1271 * set_countermeasures - Enable/disable TKIP countermeasures
1272 * @priv: private driver interface data
1273 * @enabled: 1 = countermeasures enabled, 0 = disabled
1275 * Returns: 0 on success, -1 on failure
1277 * Configure TKIP countermeasures. When these are enabled, the driver
1278 * should drop all received and queued frames that are using TKIP.
1280 int (*set_countermeasures)(void *priv, int enabled);
1283 * deauthenticate - Request driver to deauthenticate
1284 * @priv: private driver interface data
1285 * @addr: peer address (BSSID of the AP)
1286 * @reason_code: 16-bit reason code to be sent in the deauthentication
1289 * Returns: 0 on success, -1 on failure
1291 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1294 * associate - Request driver to associate
1295 * @priv: private driver interface data
1296 * @params: association parameters
1298 * Returns: 0 on success, -1 on failure
1300 int (*associate)(void *priv,
1301 struct wpa_driver_associate_params *params);
1304 * add_pmkid - Add PMKSA cache entry to the driver
1305 * @priv: private driver interface data
1306 * @bssid: BSSID for the PMKSA cache entry
1307 * @pmkid: PMKID for the PMKSA cache entry
1309 * Returns: 0 on success, -1 on failure
1311 * This function is called when a new PMK is received, as a result of
1312 * either normal authentication or RSN pre-authentication.
1314 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1315 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1316 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1317 * driver_ops function does not need to be implemented. Likewise, if
1318 * the driver does not support WPA, this function is not needed.
1320 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1323 * remove_pmkid - Remove PMKSA cache entry to the driver
1324 * @priv: private driver interface data
1325 * @bssid: BSSID for the PMKSA cache entry
1326 * @pmkid: PMKID for the PMKSA cache entry
1328 * Returns: 0 on success, -1 on failure
1330 * This function is called when the supplicant drops a PMKSA cache
1331 * entry for any reason.
1333 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1334 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1335 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1336 * from wpa_supplicant, this driver_ops function does not need to be
1337 * implemented. Likewise, if the driver does not support WPA, this
1338 * function is not needed.
1340 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1343 * flush_pmkid - Flush PMKSA cache
1344 * @priv: private driver interface data
1346 * Returns: 0 on success, -1 on failure
1348 * This function is called when the supplicant drops all PMKSA cache
1349 * entries for any reason.
1351 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1352 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1353 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1354 * from wpa_supplicant, this driver_ops function does not need to be
1355 * implemented. Likewise, if the driver does not support WPA, this
1356 * function is not needed.
1358 int (*flush_pmkid)(void *priv);
1361 * get_capa - Get driver capabilities
1362 * @priv: private driver interface data
1364 * Returns: 0 on success, -1 on failure
1366 * Get driver/firmware/hardware capabilities.
1368 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1371 * poll - Poll driver for association information
1372 * @priv: private driver interface data
1374 * This is an option callback that can be used when the driver does not
1375 * provide event mechanism for association events. This is called when
1376 * receiving WPA EAPOL-Key messages that require association
1377 * information. The driver interface is supposed to generate associnfo
1378 * event before returning from this callback function. In addition, the
1379 * driver interface should generate an association event after having
1380 * sent out associnfo.
1382 void (*poll)(void *priv);
1385 * get_ifname - Get interface name
1386 * @priv: private driver interface data
1388 * Returns: Pointer to the interface name. This can differ from the
1389 * interface name used in init() call. Init() is called first.
1391 * This optional function can be used to allow the driver interface to
1392 * replace the interface name with something else, e.g., based on an
1393 * interface mapping from a more descriptive name.
1395 const char * (*get_ifname)(void *priv);
1398 * get_mac_addr - Get own MAC address
1399 * @priv: private driver interface data
1401 * Returns: Pointer to own MAC address or %NULL on failure
1403 * This optional function can be used to get the own MAC address of the
1404 * device from the driver interface code. This is only needed if the
1405 * l2_packet implementation for the OS does not provide easy access to
1407 const u8 * (*get_mac_addr)(void *priv);
1410 * send_eapol - Optional function for sending EAPOL packets
1411 * @priv: private driver interface data
1412 * @dest: Destination MAC address
1414 * @data: EAPOL packet starting with IEEE 802.1X header
1415 * @data_len: Size of the EAPOL packet
1417 * Returns: 0 on success, -1 on failure
1419 * This optional function can be used to override l2_packet operations
1420 * with driver specific functionality. If this function pointer is set,
1421 * l2_packet module is not used at all and the driver interface code is
1422 * responsible for receiving and sending all EAPOL packets. The
1423 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1424 * event. The driver interface is required to implement get_mac_addr()
1425 * handler if send_eapol() is used.
1427 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1428 const u8 *data, size_t data_len);
1431 * set_operstate - Sets device operating state to DORMANT or UP
1432 * @priv: private driver interface data
1433 * @state: 0 = dormant, 1 = up
1434 * Returns: 0 on success, -1 on failure
1436 * This is an optional function that can be used on operating systems
1437 * that support a concept of controlling network device state from user
1438 * space applications. This function, if set, gets called with
1439 * state = 1 when authentication has been completed and with state = 0
1440 * when connection is lost.
1442 int (*set_operstate)(void *priv, int state);
1445 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1446 * @priv: Private driver interface data
1447 * @addr: Address of the station for which to set protection (may be
1448 * %NULL for group keys)
1449 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1450 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1451 * Returns: 0 on success, -1 on failure
1453 * This is an optional function that can be used to set the driver to
1454 * require protection for Tx and/or Rx frames. This uses the layer
1455 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1456 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1457 * set protection operation; instead, they set protection implicitly
1458 * based on configured keys.
1460 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1464 * get_hw_feature_data - Get hardware support data (channels and rates)
1465 * @priv: Private driver interface data
1466 * @num_modes: Variable for returning the number of returned modes
1467 * flags: Variable for returning hardware feature flags
1468 * Returns: Pointer to allocated hardware data on success or %NULL on
1469 * failure. Caller is responsible for freeing this.
1471 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1476 * send_mlme - Send management frame from MLME
1477 * @priv: Private driver interface data
1478 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1479 * @data_len: Size of the management frame
1480 * @noack: Do not wait for this frame to be acked (disable retries)
1481 * Returns: 0 on success, -1 on failure
1483 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1487 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1488 * @priv: Private driver interface data
1489 * @md: Mobility domain (2 octets) (also included inside ies)
1490 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1491 * @ies_len: Length of FT IEs in bytes
1492 * Returns: 0 on success, -1 on failure
1494 * The supplicant uses this callback to let the driver know that keying
1495 * material for FT is available and that the driver can use the
1496 * provided IEs in the next message in FT authentication sequence.
1498 * This function is only needed for driver that support IEEE 802.11r
1499 * (Fast BSS Transition).
1501 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1505 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1506 * @priv: Private driver interface data
1507 * @action: Action field value
1508 * @target_ap: Target AP address
1509 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1510 * @ies_len: Length of FT IEs in bytes
1511 * Returns: 0 on success, -1 on failure
1513 * The supplicant uses this callback to request the driver to transmit
1514 * an FT Action frame (action category 6) for over-the-DS fast BSS
1517 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1518 const u8 *ies, size_t ies_len);
1521 * get_scan_results2 - Fetch the latest scan results
1522 * @priv: private driver interface data
1524 * Returns: Allocated buffer of scan results (caller is responsible for
1525 * freeing the data structure) on success, NULL on failure
1527 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1530 * set_country - Set country
1531 * @priv: Private driver interface data
1532 * @alpha2: country to which to switch to
1533 * Returns: 0 on success, -1 on failure
1535 * This function is for drivers which support some form
1536 * of setting a regulatory domain.
1538 int (*set_country)(void *priv, const char *alpha2);
1541 * global_init - Global driver initialization
1542 * Returns: Pointer to private data (global), %NULL on failure
1544 * This optional function is called to initialize the driver wrapper
1545 * for global data, i.e., data that applies to all interfaces. If this
1546 * function is implemented, global_deinit() will also need to be
1547 * implemented to free the private data. The driver will also likely
1548 * use init2() function instead of init() to get the pointer to global
1549 * data available to per-interface initializer.
1551 void * (*global_init)(void);
1554 * global_deinit - Global driver deinitialization
1555 * @priv: private driver global data from global_init()
1557 * Terminate any global driver related functionality and free the
1558 * global data structure.
1560 void (*global_deinit)(void *priv);
1563 * init2 - Initialize driver interface (with global data)
1564 * @ctx: context to be used when calling wpa_supplicant functions,
1565 * e.g., wpa_supplicant_event()
1566 * @ifname: interface name, e.g., wlan0
1567 * @global_priv: private driver global data from global_init()
1568 * Returns: Pointer to private data, %NULL on failure
1570 * This function can be used instead of init() if the driver wrapper
1573 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1576 * get_interfaces - Get information about available interfaces
1577 * @global_priv: private driver global data from global_init()
1578 * Returns: Allocated buffer of interface information (caller is
1579 * responsible for freeing the data structure) on success, NULL on
1582 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1585 * scan2 - Request the driver to initiate scan
1586 * @priv: private driver interface data
1587 * @params: Scan parameters
1589 * Returns: 0 on success, -1 on failure
1591 * Once the scan results are ready, the driver should report scan
1592 * results event for wpa_supplicant which will eventually request the
1593 * results with wpa_driver_get_scan_results2().
1595 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1598 * authenticate - Request driver to authenticate
1599 * @priv: private driver interface data
1600 * @params: authentication parameters
1601 * Returns: 0 on success, -1 on failure
1603 * This is an optional function that can be used with drivers that
1604 * support separate authentication and association steps, i.e., when
1605 * wpa_supplicant can act as the SME. If not implemented, associate()
1606 * function is expected to take care of IEEE 802.11 authentication,
1609 int (*authenticate)(void *priv,
1610 struct wpa_driver_auth_params *params);
1613 * set_ap - Set Beacon and Probe Response information for AP mode
1614 * @priv: Private driver interface data
1615 * @params: Parameters to use in AP mode
1617 * This function is used to configure Beacon template and/or extra IEs
1618 * to add for Beacon and Probe Response frames for the driver in
1619 * AP mode. The driver is responsible for building the full Beacon
1620 * frame by concatenating the head part with TIM IE generated by the
1621 * driver/firmware and finishing with the tail part. Depending on the
1622 * driver architectue, this can be done either by using the full
1623 * template or the set of additional IEs (e.g., WPS and P2P IE).
1624 * Similarly, Probe Response processing depends on the driver design.
1625 * If the driver (or firmware) takes care of replying to Probe Request
1626 * frames, the extra IEs provided here needs to be added to the Probe
1629 * Returns: 0 on success, -1 on failure
1631 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1634 * set_acl - Set ACL in AP mode
1635 * @priv: Private driver interface data
1636 * @params: Parameters to configure ACL
1637 * Returns: 0 on success, -1 on failure
1639 * This is used only for the drivers which support MAC address ACL.
1641 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1644 * hapd_init - Initialize driver interface (hostapd only)
1645 * @hapd: Pointer to hostapd context
1646 * @params: Configuration for the driver wrapper
1647 * Returns: Pointer to private data, %NULL on failure
1649 * This function is used instead of init() or init2() when the driver
1650 * wrapper is used with hostapd.
1652 void * (*hapd_init)(struct hostapd_data *hapd,
1653 struct wpa_init_params *params);
1656 * hapd_deinit - Deinitialize driver interface (hostapd only)
1657 * @priv: Private driver interface data from hapd_init()
1659 void (*hapd_deinit)(void *priv);
1662 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1663 * @priv: Private driver interface data
1664 * @params: BSS parameters
1665 * Returns: 0 on success, -1 on failure
1667 * This is an optional function to configure the kernel driver to
1668 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1669 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1670 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1671 * for Beacon frames.
1673 * DEPRECATED - use set_ap() instead
1675 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1678 * set_privacy - Enable/disable privacy (AP only)
1679 * @priv: Private driver interface data
1680 * @enabled: 1 = privacy enabled, 0 = disabled
1681 * Returns: 0 on success, -1 on failure
1683 * This is an optional function to configure privacy field in the
1684 * kernel driver for Beacon frames. This can be left undefined (set to
1685 * %NULL) if the driver uses the Beacon template from set_ap().
1687 * DEPRECATED - use set_ap() instead
1689 int (*set_privacy)(void *priv, int enabled);
1692 * get_seqnum - Fetch the current TSC/packet number (AP only)
1693 * @ifname: The interface name (main or virtual)
1694 * @priv: Private driver interface data
1695 * @addr: MAC address of the station or %NULL for group keys
1697 * @seq: Buffer for returning the latest used TSC/packet number
1698 * Returns: 0 on success, -1 on failure
1700 * This function is used to fetch the last used TSC/packet number for
1701 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1702 * keys, so there is no strict requirement on implementing support for
1703 * unicast keys (i.e., addr != %NULL).
1705 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1709 * flush - Flush all association stations (AP only)
1710 * @priv: Private driver interface data
1711 * Returns: 0 on success, -1 on failure
1713 * This function requests the driver to disassociate all associated
1714 * stations. This function does not need to be implemented if the
1715 * driver does not process association frames internally.
1717 int (*flush)(void *priv);
1720 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1721 * @priv: Private driver interface data
1722 * @elem: Information elements
1723 * @elem_len: Length of the elem buffer in octets
1724 * Returns: 0 on success, -1 on failure
1726 * This is an optional function to add information elements in the
1727 * kernel driver for Beacon and Probe Response frames. This can be left
1728 * undefined (set to %NULL) if the driver uses the Beacon template from
1731 * DEPRECATED - use set_ap() instead
1733 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1736 * read_sta_data - Fetch station data
1737 * @priv: Private driver interface data
1738 * @data: Buffer for returning station information
1739 * @addr: MAC address of the station
1740 * Returns: 0 on success, -1 on failure
1742 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1746 * hapd_send_eapol - Send an EAPOL packet (AP only)
1747 * @priv: private driver interface data
1748 * @addr: Destination MAC address
1749 * @data: EAPOL packet starting with IEEE 802.1X header
1750 * @data_len: Length of the EAPOL packet in octets
1751 * @encrypt: Whether the frame should be encrypted
1752 * @own_addr: Source MAC address
1753 * @flags: WPA_STA_* flags for the destination station
1755 * Returns: 0 on success, -1 on failure
1757 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1758 size_t data_len, int encrypt,
1759 const u8 *own_addr, u32 flags);
1762 * sta_deauth - Deauthenticate a station (AP only)
1763 * @priv: Private driver interface data
1764 * @own_addr: Source address and BSSID for the Deauthentication frame
1765 * @addr: MAC address of the station to deauthenticate
1766 * @reason: Reason code for the Deauthentiation frame
1767 * Returns: 0 on success, -1 on failure
1769 * This function requests a specific station to be deauthenticated and
1770 * a Deauthentication frame to be sent to it.
1772 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1776 * sta_disassoc - Disassociate a station (AP only)
1777 * @priv: Private driver interface data
1778 * @own_addr: Source address and BSSID for the Disassociation frame
1779 * @addr: MAC address of the station to disassociate
1780 * @reason: Reason code for the Disassociation frame
1781 * Returns: 0 on success, -1 on failure
1783 * This function requests a specific station to be disassociated and
1784 * a Disassociation frame to be sent to it.
1786 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1790 * sta_remove - Remove a station entry (AP only)
1791 * @priv: Private driver interface data
1792 * @addr: MAC address of the station to be removed
1793 * Returns: 0 on success, -1 on failure
1795 int (*sta_remove)(void *priv, const u8 *addr);
1798 * hapd_get_ssid - Get the current SSID (AP only)
1799 * @priv: Private driver interface data
1800 * @buf: Buffer for returning the SSID
1801 * @len: Maximum length of the buffer
1802 * Returns: Length of the SSID on success, -1 on failure
1804 * This function need not be implemented if the driver uses Beacon
1805 * template from set_ap() and does not reply to Probe Request frames.
1807 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1810 * hapd_set_ssid - Set SSID (AP only)
1811 * @priv: Private driver interface data
1813 * @len: Length of the SSID in octets
1814 * Returns: 0 on success, -1 on failure
1816 * DEPRECATED - use set_ap() instead
1818 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1821 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1822 * @priv: Private driver interface data
1823 * @enabled: 1 = countermeasures enabled, 0 = disabled
1824 * Returns: 0 on success, -1 on failure
1826 * This need not be implemented if the driver does not take care of
1827 * association processing.
1829 int (*hapd_set_countermeasures)(void *priv, int enabled);
1832 * sta_add - Add a station entry
1833 * @priv: Private driver interface data
1834 * @params: Station parameters
1835 * Returns: 0 on success, -1 on failure
1837 * This function is used to add a station entry to the driver once the
1838 * station has completed association. This is only used if the driver
1839 * does not take care of association processing.
1841 * With TDLS, this function is also used to add or set (params->set 1)
1842 * TDLS peer entries.
1844 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1847 * get_inact_sec - Get station inactivity duration (AP only)
1848 * @priv: Private driver interface data
1849 * @addr: Station address
1850 * Returns: Number of seconds station has been inactive, -1 on failure
1852 int (*get_inact_sec)(void *priv, const u8 *addr);
1855 * sta_clear_stats - Clear station statistics (AP only)
1856 * @priv: Private driver interface data
1857 * @addr: Station address
1858 * Returns: 0 on success, -1 on failure
1860 int (*sta_clear_stats)(void *priv, const u8 *addr);
1863 * set_freq - Set channel/frequency (AP only)
1864 * @priv: Private driver interface data
1865 * @freq: Channel parameters
1866 * Returns: 0 on success, -1 on failure
1868 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1871 * set_rts - Set RTS threshold
1872 * @priv: Private driver interface data
1873 * @rts: RTS threshold in octets
1874 * Returns: 0 on success, -1 on failure
1876 int (*set_rts)(void *priv, int rts);
1879 * set_frag - Set fragmentation threshold
1880 * @priv: Private driver interface data
1881 * @frag: Fragmentation threshold in octets
1882 * Returns: 0 on success, -1 on failure
1884 int (*set_frag)(void *priv, int frag);
1887 * sta_set_flags - Set station flags (AP only)
1888 * @priv: Private driver interface data
1889 * @addr: Station address
1890 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1891 * @flags_or: Bitmap of WPA_STA_* flags to add
1892 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1893 * Returns: 0 on success, -1 on failure
1895 int (*sta_set_flags)(void *priv, const u8 *addr,
1896 int total_flags, int flags_or, int flags_and);
1899 * set_tx_queue_params - Set TX queue parameters
1900 * @priv: Private driver interface data
1901 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
1905 * @burst_time: Maximum length for bursting in 0.1 msec units
1907 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1908 int cw_max, int burst_time);
1911 * if_add - Add a virtual interface
1912 * @priv: Private driver interface data
1913 * @type: Interface type
1914 * @ifname: Interface name for the new virtual interface
1915 * @addr: Local address to use for the interface or %NULL to use the
1916 * parent interface address
1917 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1918 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1919 * not allowed (applies only to %WPA_IF_AP_BSS type)
1920 * @force_ifname: Buffer for returning an interface name that the
1921 * driver ended up using if it differs from the requested ifname
1922 * @if_addr: Buffer for returning the allocated interface address
1923 * (this may differ from the requested addr if the driver cannot
1924 * change interface address)
1925 * @bridge: Bridge interface to use or %NULL if no bridge configured
1926 * Returns: 0 on success, -1 on failure
1928 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1929 const char *ifname, const u8 *addr, void *bss_ctx,
1930 void **drv_priv, char *force_ifname, u8 *if_addr,
1931 const char *bridge);
1934 * if_remove - Remove a virtual interface
1935 * @priv: Private driver interface data
1936 * @type: Interface type
1937 * @ifname: Interface name of the virtual interface to be removed
1938 * Returns: 0 on success, -1 on failure
1940 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1941 const char *ifname);
1944 * set_sta_vlan - Bind a station into a specific interface (AP only)
1945 * @priv: Private driver interface data
1946 * @ifname: Interface (main or virtual BSS or VLAN)
1947 * @addr: MAC address of the associated station
1949 * Returns: 0 on success, -1 on failure
1951 * This function is used to bind a station to a specific virtual
1952 * interface. It is only used if when virtual interfaces are supported,
1953 * e.g., to assign stations to different VLAN interfaces based on
1954 * information from a RADIUS server. This allows separate broadcast
1955 * domains to be used with a single BSS.
1957 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1961 * commit - Optional commit changes handler (AP only)
1962 * @priv: driver private data
1963 * Returns: 0 on success, -1 on failure
1965 * This optional handler function can be registered if the driver
1966 * interface implementation needs to commit changes (e.g., by setting
1967 * network interface up) at the end of initial configuration. If set,
1968 * this handler will be called after initial setup has been completed.
1970 int (*commit)(void *priv);
1973 * send_ether - Send an ethernet packet (AP only)
1974 * @priv: private driver interface data
1975 * @dst: Destination MAC address
1976 * @src: Source MAC address
1978 * @data: EAPOL packet starting with IEEE 802.1X header
1979 * @data_len: Length of the EAPOL packet in octets
1980 * Returns: 0 on success, -1 on failure
1982 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1983 const u8 *data, size_t data_len);
1986 * set_radius_acl_auth - Notification of RADIUS ACL change
1987 * @priv: Private driver interface data
1988 * @mac: MAC address of the station
1989 * @accepted: Whether the station was accepted
1990 * @session_timeout: Session timeout for the station
1991 * Returns: 0 on success, -1 on failure
1993 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1994 u32 session_timeout);
1997 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1998 * @priv: Private driver interface data
1999 * @mac: MAC address of the station
2000 * Returns: 0 on success, -1 on failure
2002 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2005 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2006 * @priv: Private driver interface data
2007 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2008 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2010 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2011 * to remove extra IE(s)
2012 * Returns: 0 on success, -1 on failure
2014 * This is an optional function to add WPS IE in the kernel driver for
2015 * Beacon and Probe Response frames. This can be left undefined (set
2016 * to %NULL) if the driver uses the Beacon template from set_ap()
2017 * and does not process Probe Request frames. If the driver takes care
2018 * of (Re)Association frame processing, the assocresp buffer includes
2019 * WPS IE(s) that need to be added to (Re)Association Response frames
2020 * whenever a (Re)Association Request frame indicated use of WPS.
2022 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2023 * frames when operating as a GO. The driver is responsible for adding
2024 * timing related attributes (e.g., NoA) in addition to the IEs
2025 * included here by appending them after these buffers. This call is
2026 * also used to provide Probe Response IEs for P2P Listen state
2027 * operations for drivers that generate the Probe Response frames
2030 * DEPRECATED - use set_ap() instead
2032 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2033 const struct wpabuf *proberesp,
2034 const struct wpabuf *assocresp);
2037 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2038 * @priv: Private driver interface data
2039 * @authorized: Whether the port is authorized
2040 * Returns: 0 on success, -1 on failure
2042 int (*set_supp_port)(void *priv, int authorized);
2045 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2046 * @priv: Private driver interface data
2047 * @addr: MAC address of the associated station
2048 * @aid: Association ID
2049 * @val: 1 = bind to 4-address WDS; 0 = unbind
2050 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2051 * to indicate that bridge is not to be used
2052 * Returns: 0 on success, -1 on failure
2054 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2055 const char *bridge_ifname);
2058 * send_action - Transmit an Action frame
2059 * @priv: Private driver interface data
2060 * @freq: Frequency (in MHz) of the channel
2061 * @wait: Time to wait off-channel for a response (in ms), or zero
2062 * @dst: Destination MAC address (Address 1)
2063 * @src: Source MAC address (Address 2)
2064 * @bssid: BSSID (Address 3)
2066 * @data_len: data length in octets
2067 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2068 * Returns: 0 on success, -1 on failure
2070 * This command can be used to request the driver to transmit an action
2071 * frame to the specified destination.
2073 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2074 * be transmitted on the given channel and the device will wait for a
2075 * response on that channel for the given wait time.
2077 * If the flag is not set, the wait time will be ignored. In this case,
2078 * if a remain-on-channel duration is in progress, the frame must be
2079 * transmitted on that channel; alternatively the frame may be sent on
2080 * the current operational channel (if in associated state in station
2081 * mode or while operating as an AP.)
2083 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2084 const u8 *dst, const u8 *src, const u8 *bssid,
2085 const u8 *data, size_t data_len, int no_cck);
2088 * send_action_cancel_wait - Cancel action frame TX wait
2089 * @priv: Private driver interface data
2091 * This command cancels the wait time associated with sending an action
2092 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2093 * set in the driver flags.
2095 void (*send_action_cancel_wait)(void *priv);
2098 * remain_on_channel - Remain awake on a channel
2099 * @priv: Private driver interface data
2100 * @freq: Frequency (in MHz) of the channel
2101 * @duration: Duration in milliseconds
2102 * Returns: 0 on success, -1 on failure
2104 * This command is used to request the driver to remain awake on the
2105 * specified channel for the specified duration and report received
2106 * Action frames with EVENT_RX_ACTION events. Optionally, received
2107 * Probe Request frames may also be requested to be reported by calling
2108 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2110 * The driver may not be at the requested channel when this function
2111 * returns, i.e., the return code is only indicating whether the
2112 * request was accepted. The caller will need to wait until the
2113 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2114 * completed the channel change. This may take some time due to other
2115 * need for the radio and the caller should be prepared to timing out
2116 * its wait since there are no guarantees on when this request can be
2119 int (*remain_on_channel)(void *priv, unsigned int freq,
2120 unsigned int duration);
2123 * cancel_remain_on_channel - Cancel remain-on-channel operation
2124 * @priv: Private driver interface data
2126 * This command can be used to cancel a remain-on-channel operation
2127 * before its originally requested duration has passed. This could be
2128 * used, e.g., when remain_on_channel() is used to request extra time
2129 * to receive a response to an Action frame and the response is
2130 * received when there is still unneeded time remaining on the
2131 * remain-on-channel operation.
2133 int (*cancel_remain_on_channel)(void *priv);
2136 * probe_req_report - Request Probe Request frames to be indicated
2137 * @priv: Private driver interface data
2138 * @report: Whether to report received Probe Request frames
2139 * Returns: 0 on success, -1 on failure (or if not supported)
2141 * This command can be used to request the driver to indicate when
2142 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2143 * Since this operation may require extra resources, e.g., due to less
2144 * optimal hardware/firmware RX filtering, many drivers may disable
2145 * Probe Request reporting at least in station mode. This command is
2146 * used to notify the driver when the Probe Request frames need to be
2147 * reported, e.g., during remain-on-channel operations.
2149 int (*probe_req_report)(void *priv, int report);
2152 * deinit_ap - Deinitialize AP mode
2153 * @priv: Private driver interface data
2154 * Returns: 0 on success, -1 on failure (or if not supported)
2156 * This optional function can be used to disable AP mode related
2157 * configuration and change the driver mode to station mode to allow
2158 * normal station operations like scanning to be completed.
2160 int (*deinit_ap)(void *priv);
2163 * deinit_p2p_cli - Deinitialize P2P client mode
2164 * @priv: Private driver interface data
2165 * Returns: 0 on success, -1 on failure (or if not supported)
2167 * This optional function can be used to disable P2P client mode. It
2168 * can be used to change the interface type back to station mode.
2170 int (*deinit_p2p_cli)(void *priv);
2173 * suspend - Notification on system suspend/hibernate event
2174 * @priv: Private driver interface data
2176 void (*suspend)(void *priv);
2179 * resume - Notification on system resume/thaw event
2180 * @priv: Private driver interface data
2182 void (*resume)(void *priv);
2185 * signal_monitor - Set signal monitoring parameters
2186 * @priv: Private driver interface data
2187 * @threshold: Threshold value for signal change events; 0 = disabled
2188 * @hysteresis: Minimum change in signal strength before indicating a
2190 * Returns: 0 on success, -1 on failure (or if not supported)
2192 * This function can be used to configure monitoring of signal strength
2193 * with the current AP. Whenever signal strength drops below the
2194 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2195 * should be generated assuming the signal strength has changed at
2196 * least %hysteresis from the previously indicated signal change event.
2198 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2201 * send_frame - Send IEEE 802.11 frame (testing use only)
2202 * @priv: Private driver interface data
2203 * @data: IEEE 802.11 frame with IEEE 802.11 header
2204 * @data_len: Size of the frame
2205 * @encrypt: Whether to encrypt the frame (if keys are set)
2206 * Returns: 0 on success, -1 on failure
2208 * This function is only used for debugging purposes and is not
2209 * required to be implemented for normal operations.
2211 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2215 * shared_freq - Get operating frequency of shared interface(s)
2216 * @priv: Private driver interface data
2217 * Returns: Operating frequency in MHz, 0 if no shared operation in
2218 * use, or -1 on failure
2220 * This command can be used to request the current operating frequency
2221 * of any virtual interface that shares the same radio to provide
2222 * information for channel selection for other virtual interfaces.
2224 int (*shared_freq)(void *priv);
2227 * get_noa - Get current Notice of Absence attribute payload
2228 * @priv: Private driver interface data
2229 * @buf: Buffer for returning NoA
2230 * @buf_len: Buffer length in octets
2231 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2232 * advertized, or -1 on failure
2234 * This function is used to fetch the current Notice of Absence
2235 * attribute value from GO.
2237 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2240 * set_noa - Set Notice of Absence parameters for GO (testing)
2241 * @priv: Private driver interface data
2243 * @start: Start time in ms from next TBTT
2244 * @duration: Duration in ms
2245 * Returns: 0 on success or -1 on failure
2247 * This function is used to set Notice of Absence parameters for GO. It
2248 * is used only for testing. To disable NoA, all parameters are set to
2251 int (*set_noa)(void *priv, u8 count, int start, int duration);
2254 * set_p2p_powersave - Set P2P power save options
2255 * @priv: Private driver interface data
2256 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2257 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2258 * @ctwindow: 0.. = change (msec), -1 = no change
2259 * Returns: 0 on success or -1 on failure
2261 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2265 * ampdu - Enable/disable aggregation
2266 * @priv: Private driver interface data
2267 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2268 * Returns: 0 on success or -1 on failure
2270 int (*ampdu)(void *priv, int ampdu);
2273 * get_radio_name - Get physical radio name for the device
2274 * @priv: Private driver interface data
2275 * Returns: Radio name or %NULL if not known
2277 * The returned data must not be modified by the caller. It is assumed
2278 * that any interface that has the same radio name as another is
2279 * sharing the same physical radio. This information can be used to
2280 * share scan results etc. information between the virtual interfaces
2281 * to speed up various operations.
2283 const char * (*get_radio_name)(void *priv);
2286 * p2p_find - Start P2P Device Discovery
2287 * @priv: Private driver interface data
2288 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2289 * @type: Device Discovery type (enum p2p_discovery_type)
2290 * Returns: 0 on success, -1 on failure
2292 * This function is only used if the driver implements P2P management,
2293 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2294 * struct wpa_driver_capa.
2296 int (*p2p_find)(void *priv, unsigned int timeout, int type);
2299 * p2p_stop_find - Stop P2P Device Discovery
2300 * @priv: Private driver interface data
2301 * Returns: 0 on success, -1 on failure
2303 * This function is only used if the driver implements P2P management,
2304 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2305 * struct wpa_driver_capa.
2307 int (*p2p_stop_find)(void *priv);
2310 * p2p_listen - Start P2P Listen state for specified duration
2311 * @priv: Private driver interface data
2312 * @timeout: Listen state duration in milliseconds
2313 * Returns: 0 on success, -1 on failure
2315 * This function can be used to request the P2P module to keep the
2316 * device discoverable on the listen channel for an extended set of
2317 * time. At least in its current form, this is mainly used for testing
2318 * purposes and may not be of much use for normal P2P operations.
2320 * This function is only used if the driver implements P2P management,
2321 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2322 * struct wpa_driver_capa.
2324 int (*p2p_listen)(void *priv, unsigned int timeout);
2327 * p2p_connect - Start P2P group formation (GO negotiation)
2328 * @priv: Private driver interface data
2329 * @peer_addr: MAC address of the peer P2P client
2330 * @wps_method: enum p2p_wps_method value indicating config method
2331 * @go_intent: Local GO intent value (1..15)
2332 * @own_interface_addr: Intended interface address to use with the
2334 * @force_freq: The only allowed channel frequency in MHz or 0
2335 * @persistent_group: Whether to create persistent group
2336 * Returns: 0 on success, -1 on failure
2338 * This function is only used if the driver implements P2P management,
2339 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2340 * struct wpa_driver_capa.
2342 int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method,
2343 int go_intent, const u8 *own_interface_addr,
2344 unsigned int force_freq, int persistent_group);
2347 * wps_success_cb - Report successfully completed WPS provisioning
2348 * @priv: Private driver interface data
2349 * @peer_addr: Peer address
2350 * Returns: 0 on success, -1 on failure
2352 * This function is used to report successfully completed WPS
2353 * provisioning during group formation in both GO/Registrar and
2354 * client/Enrollee roles.
2356 * This function is only used if the driver implements P2P management,
2357 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2358 * struct wpa_driver_capa.
2360 int (*wps_success_cb)(void *priv, const u8 *peer_addr);
2363 * p2p_group_formation_failed - Report failed WPS provisioning
2364 * @priv: Private driver interface data
2365 * Returns: 0 on success, -1 on failure
2367 * This function is used to report failed group formation. This can
2368 * happen either due to failed WPS provisioning or due to 15 second
2369 * timeout during the provisioning phase.
2371 * This function is only used if the driver implements P2P management,
2372 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2373 * struct wpa_driver_capa.
2375 int (*p2p_group_formation_failed)(void *priv);
2378 * p2p_set_params - Set P2P parameters
2379 * @priv: Private driver interface data
2380 * @params: P2P parameters
2381 * Returns: 0 on success, -1 on failure
2383 * This function is only used if the driver implements P2P management,
2384 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2385 * struct wpa_driver_capa.
2387 int (*p2p_set_params)(void *priv, const struct p2p_params *params);
2390 * p2p_prov_disc_req - Send Provision Discovery Request
2391 * @priv: Private driver interface data
2392 * @peer_addr: MAC address of the peer P2P client
2393 * @config_methods: WPS Config Methods value (only one bit set)
2394 * Returns: 0 on success, -1 on failure
2396 * This function can be used to request a discovered P2P peer to
2397 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2398 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2399 * Provision Discovery Request frame is transmitted once immediately
2400 * and if no response is received, the frame will be sent again
2401 * whenever the target device is discovered during device dsicovery
2402 * (start with a p2p_find() call). Response from the peer is indicated
2403 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
2405 * This function is only used if the driver implements P2P management,
2406 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2407 * struct wpa_driver_capa.
2409 int (*p2p_prov_disc_req)(void *priv, const u8 *peer_addr,
2410 u16 config_methods, int join);
2413 * p2p_sd_request - Schedule a service discovery query
2414 * @priv: Private driver interface data
2415 * @dst: Destination peer or %NULL to apply for all peers
2416 * @tlvs: P2P Service Query TLV(s)
2417 * Returns: Reference to the query or 0 on failure
2419 * Response to the query is indicated with the
2420 * EVENT_P2P_SD_RESPONSE driver event.
2422 * This function is only used if the driver implements P2P management,
2423 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2424 * struct wpa_driver_capa.
2426 u64 (*p2p_sd_request)(void *priv, const u8 *dst,
2427 const struct wpabuf *tlvs);
2430 * p2p_sd_cancel_request - Cancel a pending service discovery query
2431 * @priv: Private driver interface data
2432 * @req: Query reference from p2p_sd_request()
2433 * Returns: 0 on success, -1 on failure
2435 * This function is only used if the driver implements P2P management,
2436 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2437 * struct wpa_driver_capa.
2439 int (*p2p_sd_cancel_request)(void *priv, u64 req);
2442 * p2p_sd_response - Send response to a service discovery query
2443 * @priv: Private driver interface data
2444 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2445 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2446 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2447 * @resp_tlvs: P2P Service Response TLV(s)
2448 * Returns: 0 on success, -1 on failure
2450 * This function is called as a response to the request indicated with
2451 * the EVENT_P2P_SD_REQUEST driver event.
2453 * This function is only used if the driver implements P2P management,
2454 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2455 * struct wpa_driver_capa.
2457 int (*p2p_sd_response)(void *priv, int freq, const u8 *dst,
2459 const struct wpabuf *resp_tlvs);
2462 * p2p_service_update - Indicate a change in local services
2463 * @priv: Private driver interface data
2464 * Returns: 0 on success, -1 on failure
2466 * This function needs to be called whenever there is a change in
2467 * availability of the local services. This will increment the
2468 * Service Update Indicator value which will be used in SD Request and
2471 * This function is only used if the driver implements P2P management,
2472 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2473 * struct wpa_driver_capa.
2475 int (*p2p_service_update)(void *priv);
2478 * p2p_reject - Reject peer device (explicitly block connections)
2479 * @priv: Private driver interface data
2480 * @addr: MAC address of the peer
2481 * Returns: 0 on success, -1 on failure
2483 int (*p2p_reject)(void *priv, const u8 *addr);
2486 * p2p_invite - Invite a P2P Device into a group
2487 * @priv: Private driver interface data
2488 * @peer: Device Address of the peer P2P Device
2489 * @role: Local role in the group
2490 * @bssid: Group BSSID or %NULL if not known
2492 * @ssid_len: Length of ssid in octets
2493 * @go_dev_addr: Forced GO Device Address or %NULL if none
2494 * @persistent_group: Whether this is to reinvoke a persistent group
2495 * Returns: 0 on success, -1 on failure
2497 int (*p2p_invite)(void *priv, const u8 *peer, int role,
2498 const u8 *bssid, const u8 *ssid, size_t ssid_len,
2499 const u8 *go_dev_addr, int persistent_group);
2502 * send_tdls_mgmt - for sending TDLS management packets
2503 * @priv: private driver interface data
2504 * @dst: Destination (peer) MAC address
2505 * @action_code: TDLS action code for the mssage
2506 * @dialog_token: Dialog Token to use in the message (if needed)
2507 * @status_code: Status Code or Reason Code to use (if needed)
2508 * @buf: TDLS IEs to add to the message
2509 * @len: Length of buf in octets
2510 * Returns: 0 on success, negative (<0) on failure
2512 * This optional function can be used to send packet to driver which is
2513 * responsible for receiving and sending all TDLS packets.
2515 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2516 u8 dialog_token, u16 status_code,
2517 const u8 *buf, size_t len);
2520 * tdls_oper - Ask the driver to perform high-level TDLS operations
2521 * @priv: Private driver interface data
2522 * @oper: TDLS high-level operation. See %enum tdls_oper
2523 * @peer: Destination (peer) MAC address
2524 * Returns: 0 on success, negative (<0) on failure
2526 * This optional function can be used to send high-level TDLS commands
2529 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2532 * wnm_oper - Notify driver of the WNM frame reception
2533 * @priv: Private driver interface data
2534 * @oper: WNM operation. See %enum wnm_oper
2535 * @peer: Destination (peer) MAC address
2536 * @buf: Buffer for the driver to fill in (for getting IE)
2537 * @buf_len: Return the len of buf
2538 * Returns: 0 on success, negative (<0) on failure
2540 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2541 u8 *buf, u16 *buf_len);
2544 * signal_poll - Get current connection information
2545 * @priv: Private driver interface data
2546 * @signal_info: Connection info structure
2548 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2551 * set_authmode - Set authentication algorithm(s) for static WEP
2552 * @priv: Private driver interface data
2553 * @authmode: 1=Open System, 2=Shared Key, 3=both
2554 * Returns: 0 on success, -1 on failure
2556 * This function can be used to set authentication algorithms for AP
2557 * mode when static WEP is used. If the driver uses user space MLME/SME
2558 * implementation, there is no need to implement this function.
2560 * DEPRECATED - use set_ap() instead
2562 int (*set_authmode)(void *priv, int authmode);
2565 * set_rekey_info - Set rekey information
2566 * @priv: Private driver interface data
2569 * @replay_ctr: Current EAPOL-Key Replay Counter
2571 * This optional function can be used to provide information for the
2572 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2573 * while the host (including wpa_supplicant) is sleeping.
2575 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2576 const u8 *replay_ctr);
2579 * sta_assoc - Station association indication
2580 * @priv: Private driver interface data
2581 * @own_addr: Source address and BSSID for association frame
2582 * @addr: MAC address of the station to associate
2583 * @reassoc: flag to indicate re-association
2584 * @status: association response status code
2585 * @ie: assoc response ie buffer
2586 * @len: ie buffer length
2587 * Returns: 0 on success, -1 on failure
2589 * This function indicates the driver to send (Re)Association
2590 * Response frame to the station.
2592 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2593 int reassoc, u16 status, const u8 *ie, size_t len);
2596 * sta_auth - Station authentication indication
2597 * @priv: Private driver interface data
2598 * @own_addr: Source address and BSSID for authentication frame
2599 * @addr: MAC address of the station to associate
2600 * @seq: authentication sequence number
2601 * @status: authentication response status code
2602 * @ie: authentication frame ie buffer
2603 * @len: ie buffer length
2605 * This function indicates the driver to send Authentication frame
2608 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2609 u16 seq, u16 status, const u8 *ie, size_t len);
2612 * add_tspec - Add traffic stream
2613 * @priv: Private driver interface data
2614 * @addr: MAC address of the station to associate
2615 * @tspec_ie: tspec ie buffer
2616 * @tspec_ielen: tspec ie length
2617 * Returns: 0 on success, -1 on failure
2619 * This function adds the traffic steam for the station
2620 * and fills the medium_time in tspec_ie.
2622 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2623 size_t tspec_ielen);
2626 * add_sta_node - Add a station node in the driver
2627 * @priv: Private driver interface data
2628 * @addr: MAC address of the station to add
2629 * @auth_alg: authentication algorithm used by the station
2630 * Returns: 0 on success, -1 on failure
2632 * This function adds the station node in the driver, when
2633 * the station gets added by FT-over-DS.
2635 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2638 * sched_scan - Request the driver to initiate scheduled scan
2639 * @priv: Private driver interface data
2640 * @params: Scan parameters
2641 * @interval: Interval between scan cycles in milliseconds
2642 * Returns: 0 on success, -1 on failure
2644 * This operation should be used for scheduled scan offload to
2645 * the hardware. Every time scan results are available, the
2646 * driver should report scan results event for wpa_supplicant
2647 * which will eventually request the results with
2648 * wpa_driver_get_scan_results2(). This operation is optional
2649 * and if not provided or if it returns -1, we fall back to
2650 * normal host-scheduled scans.
2652 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2656 * stop_sched_scan - Request the driver to stop a scheduled scan
2657 * @priv: Private driver interface data
2658 * Returns: 0 on success, -1 on failure
2660 * This should cause the scheduled scan to be stopped and
2661 * results should stop being sent. Must be supported if
2662 * sched_scan is supported.
2664 int (*stop_sched_scan)(void *priv);
2667 * poll_client - Probe (null data or such) the given station
2668 * @priv: Private driver interface data
2669 * @own_addr: MAC address of sending interface
2670 * @addr: MAC address of the station to probe
2671 * @qos: Indicates whether station is QoS station
2673 * This function is used to verify whether an associated station is
2674 * still present. This function does not need to be implemented if the
2675 * driver provides such inactivity polling mechanism.
2677 void (*poll_client)(void *priv, const u8 *own_addr,
2678 const u8 *addr, int qos);
2681 * radio_disable - Disable/enable radio
2682 * @priv: Private driver interface data
2683 * @disabled: 1=disable 0=enable radio
2684 * Returns: 0 on success, -1 on failure
2686 * This optional command is for testing purposes. It can be used to
2687 * disable the radio on a testbed device to simulate out-of-radio-range
2690 int (*radio_disable)(void *priv, int disabled);
2693 * switch_channel - Announce channel switch and migrate the GO to the
2695 * @priv: Private driver interface data
2696 * @freq: Frequency in MHz
2697 * Returns: 0 on success, -1 on failure
2699 * This function is used to move the GO to the legacy STA channel to
2700 * avoid frequency conflict in single channel concurrency.
2702 int (*switch_channel)(void *priv, unsigned int freq);
2705 * start_dfs_cac - Listen for radar interference on the channel
2706 * @priv: Private driver interface data
2707 * @freq: Frequency (in MHz) of the channel
2708 * Returns: 0 on success, -1 on failure
2710 int (*start_dfs_cac)(void *priv, int freq);
2713 * stop_ap - Removes beacon from AP
2714 * @priv: Private driver interface data
2715 * Returns: 0 on success, -1 on failure (or if not supported)
2717 * This optional function can be used to disable AP mode related
2718 * configuration. Unlike deinit_ap, it does not change to station
2721 int (*stop_ap)(void *priv);
2726 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2728 enum wpa_event_type {
2730 * EVENT_ASSOC - Association completed
2732 * This event needs to be delivered when the driver completes IEEE
2733 * 802.11 association or reassociation successfully.
2734 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2735 * after this event has been generated. In addition, optional
2736 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2737 * more information about the association. If the driver interface gets
2738 * both of these events at the same time, it can also include the
2739 * assoc_info data in EVENT_ASSOC call.
2744 * EVENT_DISASSOC - Association lost
2746 * This event should be called when association is lost either due to
2747 * receiving deauthenticate or disassociate frame from the AP or when
2748 * sending either of these frames to the current AP. If the driver
2749 * supports separate deauthentication event, EVENT_DISASSOC should only
2750 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2751 * In AP mode, union wpa_event_data::disassoc_info is required.
2756 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2758 * This event must be delivered when a Michael MIC error is detected by
2759 * the local driver. Additional data for event processing is
2760 * provided with union wpa_event_data::michael_mic_failure. This
2761 * information is used to request new encyption key and to initiate
2762 * TKIP countermeasures if needed.
2764 EVENT_MICHAEL_MIC_FAILURE,
2767 * EVENT_SCAN_RESULTS - Scan results available
2769 * This event must be called whenever scan results are available to be
2770 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2771 * is expected to be used some time after struct wpa_driver_ops::scan()
2772 * is called. If the driver provides an unsolicited event when the scan
2773 * has been completed, this event can be used to trigger
2774 * EVENT_SCAN_RESULTS call. If such event is not available from the
2775 * driver, the driver wrapper code is expected to use a registered
2776 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2777 * scan is expected to be completed. Optional information about
2778 * completed scan can be provided with union wpa_event_data::scan_info.
2783 * EVENT_ASSOCINFO - Report optional extra information for association
2785 * This event can be used to report extra association information for
2786 * EVENT_ASSOC processing. This extra information includes IEs from
2787 * association frames and Beacon/Probe Response frames in union
2788 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2789 * EVENT_ASSOC. Alternatively, the driver interface can include
2790 * assoc_info data in the EVENT_ASSOC call if it has all the
2791 * information available at the same point.
2796 * EVENT_INTERFACE_STATUS - Report interface status changes
2798 * This optional event can be used to report changes in interface
2799 * status (interface added/removed) using union
2800 * wpa_event_data::interface_status. This can be used to trigger
2801 * wpa_supplicant to stop and re-start processing for the interface,
2802 * e.g., when a cardbus card is ejected/inserted.
2804 EVENT_INTERFACE_STATUS,
2807 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2809 * This event can be used to inform wpa_supplicant about candidates for
2810 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2811 * for scan request (ap_scan=2 mode), this event is required for
2812 * pre-authentication. If wpa_supplicant is performing scan request
2813 * (ap_scan=1), this event is optional since scan results can be used
2814 * to add pre-authentication candidates. union
2815 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2816 * candidate and priority of the candidate, e.g., based on the signal
2817 * strength, in order to try to pre-authenticate first with candidates
2818 * that are most likely targets for re-association.
2820 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2821 * on the candidate list. In addition, it can be called for the current
2822 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2823 * will automatically skip pre-authentication in cases where a valid
2824 * PMKSA exists. When more than one candidate exists, this event should
2825 * be generated once for each candidate.
2827 * Driver will be notified about successful pre-authentication with
2828 * struct wpa_driver_ops::add_pmkid() calls.
2830 EVENT_PMKID_CANDIDATE,
2833 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2835 * This event can be used to inform wpa_supplicant about desire to set
2836 * up secure direct link connection between two stations as defined in
2837 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2838 * STAKey negotiation. The caller will need to set peer address for the
2844 * EVENT_TDLS - Request TDLS operation
2846 * This event can be used to request a TDLS operation to be performed.
2851 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2853 * The driver is expected to report the received FT IEs from
2854 * FT authentication sequence from the AP. The FT IEs are included in
2855 * the extra information in union wpa_event_data::ft_ies.
2860 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2862 * The driver can use this event to inform wpa_supplicant about a STA
2863 * in an IBSS with which protected frames could be exchanged. This
2864 * event starts RSN authentication with the other STA to authenticate
2865 * the STA and set up encryption keys with it.
2867 EVENT_IBSS_RSN_START,
2870 * EVENT_AUTH - Authentication result
2872 * This event should be called when authentication attempt has been
2873 * completed. This is only used if the driver supports separate
2874 * authentication step (struct wpa_driver_ops::authenticate).
2875 * Information about authentication result is included in
2876 * union wpa_event_data::auth.
2881 * EVENT_DEAUTH - Authentication lost
2883 * This event should be called when authentication is lost either due
2884 * to receiving deauthenticate frame from the AP or when sending that
2885 * frame to the current AP.
2886 * In AP mode, union wpa_event_data::deauth_info is required.
2891 * EVENT_ASSOC_REJECT - Association rejected
2893 * This event should be called when (re)association attempt has been
2894 * rejected by the AP. Information about the association response is
2895 * included in union wpa_event_data::assoc_reject.
2900 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2902 EVENT_AUTH_TIMED_OUT,
2905 * EVENT_ASSOC_TIMED_OUT - Association timed out
2907 EVENT_ASSOC_TIMED_OUT,
2910 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2915 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2917 EVENT_WPS_BUTTON_PUSHED,
2920 * EVENT_TX_STATUS - Report TX status
2925 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2927 EVENT_RX_FROM_UNKNOWN,
2930 * EVENT_RX_MGMT - Report RX of a management frame
2935 * EVENT_RX_ACTION - Action frame received
2937 * This event is used to indicate when an Action frame has been
2938 * received. Information about the received frame is included in
2939 * union wpa_event_data::rx_action.
2944 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2946 * This event is used to indicate when the driver has started the
2947 * requested remain-on-channel duration. Information about the
2948 * operation is included in union wpa_event_data::remain_on_channel.
2950 EVENT_REMAIN_ON_CHANNEL,
2953 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2955 * This event is used to indicate when the driver has completed
2956 * remain-on-channel duration, i.e., may noot be available on the
2957 * requested channel anymore. Information about the
2958 * operation is included in union wpa_event_data::remain_on_channel.
2960 EVENT_CANCEL_REMAIN_ON_CHANNEL,
2963 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2965 * This event is used only by driver_test.c and userspace MLME.
2970 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2972 * This event is used to indicate when a Probe Request frame has been
2973 * received. Information about the received frame is included in
2974 * union wpa_event_data::rx_probe_req. The driver is required to report
2975 * these events only after successfully completed probe_req_report()
2976 * commands to request the events (i.e., report parameter is non-zero)
2977 * in station mode. In AP mode, Probe Request frames should always be
2983 * EVENT_NEW_STA - New wired device noticed
2985 * This event is used to indicate that a new device has been detected
2986 * in a network that does not use association-like functionality (i.e.,
2987 * mainly wired Ethernet). This can be used to start EAPOL
2988 * authenticator when receiving a frame from a device. The address of
2989 * the device is included in union wpa_event_data::new_sta.
2994 * EVENT_EAPOL_RX - Report received EAPOL frame
2996 * When in AP mode with hostapd, this event is required to be used to
2997 * deliver the receive EAPOL frames from the driver. With
2998 * %wpa_supplicant, this event is used only if the send_eapol() handler
2999 * is used to override the use of l2_packet for EAPOL frame TX.
3004 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3006 * This event is used to indicate changes in the signal strength
3007 * observed in frames received from the current AP if signal strength
3008 * monitoring has been enabled with signal_monitor().
3010 EVENT_SIGNAL_CHANGE,
3013 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3015 * This event is used to indicate that the interface was enabled after
3016 * having been previously disabled, e.g., due to rfkill.
3018 EVENT_INTERFACE_ENABLED,
3021 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3023 * This event is used to indicate that the interface was disabled,
3024 * e.g., due to rfkill.
3026 EVENT_INTERFACE_DISABLED,
3029 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3031 * This event is used to indicate that the channel list has changed,
3032 * e.g., because of a regulatory domain change triggered by scan
3033 * results including an AP advertising a country code.
3035 EVENT_CHANNEL_LIST_CHANGED,
3038 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3040 * This event is used to indicate that the driver cannot maintain this
3041 * interface in its operation mode anymore. The most likely use for
3042 * this is to indicate that AP mode operation is not available due to
3043 * operating channel would need to be changed to a DFS channel when
3044 * the driver does not support radar detection and another virtual
3045 * interfaces caused the operating channel to change. Other similar
3046 * resource conflicts could also trigger this for station mode
3049 EVENT_INTERFACE_UNAVAILABLE,
3052 * EVENT_BEST_CHANNEL
3054 * Driver generates this event whenever it detects a better channel
3055 * (e.g., based on RSSI or channel use). This information can be used
3056 * to improve channel selection for a new AP/P2P group.
3061 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3063 * This event should be called when a Deauthentication frame is dropped
3064 * due to it not being protected (MFP/IEEE 802.11w).
3065 * union wpa_event_data::unprot_deauth is required to provide more
3066 * details of the frame.
3068 EVENT_UNPROT_DEAUTH,
3071 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3073 * This event should be called when a Disassociation frame is dropped
3074 * due to it not being protected (MFP/IEEE 802.11w).
3075 * union wpa_event_data::unprot_disassoc is required to provide more
3076 * details of the frame.
3078 EVENT_UNPROT_DISASSOC,
3081 * EVENT_STATION_LOW_ACK
3083 * Driver generates this event whenever it detected that a particular
3084 * station was lost. Detection can be through massive transmission
3085 * failures for example.
3087 EVENT_STATION_LOW_ACK,
3090 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
3092 * This event is used only if the driver implements P2P management
3093 * internally. Event data is stored in
3094 * union wpa_event_data::p2p_dev_found.
3096 EVENT_P2P_DEV_FOUND,
3099 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
3101 * This event is used only if the driver implements P2P management
3102 * internally. Event data is stored in
3103 * union wpa_event_data::p2p_go_neg_req_rx.
3105 EVENT_P2P_GO_NEG_REQ_RX,
3108 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
3110 * This event is used only if the driver implements P2P management
3111 * internally. Event data is stored in
3112 * union wpa_event_data::p2p_go_neg_completed.
3114 EVENT_P2P_GO_NEG_COMPLETED,
3116 EVENT_P2P_PROV_DISC_REQUEST,
3117 EVENT_P2P_PROV_DISC_RESPONSE,
3118 EVENT_P2P_SD_REQUEST,
3119 EVENT_P2P_SD_RESPONSE,
3122 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3124 EVENT_IBSS_PEER_LOST,
3127 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3129 * This event carries the new replay counter to notify wpa_supplicant
3130 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3131 * completed Group Key Handshake while the host (including
3132 * wpa_supplicant was sleeping).
3134 EVENT_DRIVER_GTK_REKEY,
3137 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3139 EVENT_SCHED_SCAN_STOPPED,
3142 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3144 * This event indicates that the station responded to the poll
3145 * initiated with @poll_client.
3147 EVENT_DRIVER_CLIENT_POLL_OK,
3150 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3152 EVENT_EAPOL_TX_STATUS,
3155 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3157 * Described in wpa_event_data.ch_switch
3162 * EVENT_WNM - Request WNM operation
3164 * This event can be used to request a WNM operation to be performed.
3169 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3171 * This event indicates that the driver reported a connection failure
3172 * with the specified client (for example, max client reached, etc.) in
3175 EVENT_CONNECT_FAILED_REASON,
3178 * EVENT_RADAR_DETECTED - Notify of radar detection
3180 * A radar has been detected on the supplied frequency, hostapd should
3181 * react accordingly (e.g., change channel).
3183 EVENT_DFS_RADAR_DETECTED,
3186 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3188 * After a successful CAC, the channel can be marked clear and used.
3190 EVENT_DFS_CAC_FINISHED,
3193 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3195 * The CAC was not successful, and the channel remains in the previous
3196 * state. This may happen due to a radar beeing detected or other
3197 * external influences.
3199 EVENT_DFS_CAC_ABORTED,
3202 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3204 * The channel which was previously unavailable is now available again.
3206 EVENT_DFS_NOP_FINISHED
3211 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3213 union wpa_event_data {
3215 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3217 * This structure is optional for EVENT_ASSOC calls and required for
3218 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3219 * driver interface does not need to generate separate EVENT_ASSOCINFO
3224 * reassoc - Flag to indicate association or reassociation
3229 * req_ies - (Re)Association Request IEs
3231 * If the driver generates WPA/RSN IE, this event data must be
3232 * returned for WPA handshake to have needed information. If
3233 * wpa_supplicant-generated WPA/RSN IE is used, this
3234 * information event is optional.
3236 * This should start with the first IE (fixed fields before IEs
3237 * are not included).
3242 * req_ies_len - Length of req_ies in bytes
3247 * resp_ies - (Re)Association Response IEs
3249 * Optional association data from the driver. This data is not
3250 * required WPA, but may be useful for some protocols and as
3251 * such, should be reported if this is available to the driver
3254 * This should start with the first IE (fixed fields before IEs
3255 * are not included).
3260 * resp_ies_len - Length of resp_ies in bytes
3262 size_t resp_ies_len;
3265 * beacon_ies - Beacon or Probe Response IEs
3267 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3268 * Probe Response frames from the current AP (i.e., the one
3269 * that the client just associated with). This information is
3270 * used to update WPA/RSN IE for the AP. If this field is not
3271 * set, the results from previous scan will be used. If no
3272 * data for the new AP is found, scan results will be requested
3273 * again (without scan request). At this point, the driver is
3274 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3277 * This should start with the first IE (fixed fields before IEs
3278 * are not included).
3280 const u8 *beacon_ies;
3283 * beacon_ies_len - Length of beacon_ies */
3284 size_t beacon_ies_len;
3287 * freq - Frequency of the operational channel in MHz
3292 * addr - Station address (for AP mode)
3298 * struct disassoc_info - Data for EVENT_DISASSOC events
3300 struct disassoc_info {
3302 * addr - Station address (for AP mode)
3307 * reason_code - Reason Code (host byte order) used in
3308 * Deauthentication frame
3313 * ie - Optional IE(s) in Disassociation frame
3318 * ie_len - Length of ie buffer in octets
3323 * locally_generated - Whether the frame was locally generated
3325 int locally_generated;
3329 * struct deauth_info - Data for EVENT_DEAUTH events
3331 struct deauth_info {
3333 * addr - Station address (for AP mode)
3338 * reason_code - Reason Code (host byte order) used in
3339 * Deauthentication frame
3344 * ie - Optional IE(s) in Deauthentication frame
3349 * ie_len - Length of ie buffer in octets
3354 * locally_generated - Whether the frame was locally generated
3356 int locally_generated;
3360 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3362 struct michael_mic_failure {
3365 } michael_mic_failure;
3368 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3370 struct interface_status {
3373 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3378 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3380 struct pmkid_candidate {
3381 /** BSSID of the PMKID candidate */
3383 /** Smaller the index, higher the priority */
3385 /** Whether RSN IE includes pre-authenticate flag */
3390 * struct stkstart - Data for EVENT_STKSTART
3397 * struct tdls - Data for EVENT_TDLS
3403 TDLS_REQUEST_TEARDOWN
3405 u16 reason_code; /* for teardown */
3409 * struct wnm - Data for EVENT_WNM
3427 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3429 * During FT (IEEE 802.11r) authentication sequence, the driver is
3430 * expected to use this event to report received FT IEs (MDIE, FTIE,
3431 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3432 * IEs for the next message will be delivered through the
3433 * struct wpa_driver_ops::update_ft_ies() callback.
3439 u8 target_ap[ETH_ALEN];
3440 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3442 /** Length of ric_ies buffer in octets */
3447 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3449 struct ibss_rsn_start {
3454 * struct auth_info - Data for EVENT_AUTH events
3460 u16 auth_transaction;
3467 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3469 struct assoc_reject {
3471 * bssid - BSSID of the AP that rejected association
3476 * resp_ies - (Re)Association Response IEs
3478 * Optional association data from the driver. This data is not
3479 * required WPA, but may be useful for some protocols and as
3480 * such, should be reported if this is available to the driver
3483 * This should start with the first IE (fixed fields before IEs
3484 * are not included).
3489 * resp_ies_len - Length of resp_ies in bytes
3491 size_t resp_ies_len;
3494 * status_code - Status Code from (Re)association Response
3499 struct timeout_event {
3504 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3513 * struct tx_status - Data for EVENT_TX_STATUS events
3525 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3527 struct rx_from_unknown {
3534 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3540 int ssi_signal; /* dBm */
3544 * struct rx_action - Data for EVENT_RX_ACTION events
3548 * da - Destination address of the received Action frame
3553 * sa - Source address of the received Action frame
3558 * bssid - Address 3 of the received Action frame
3563 * category - Action frame category
3568 * data - Action frame body after category field
3573 * len - Length of data in octets
3578 * freq - Frequency (in MHz) on which the frame was received
3584 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3586 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3588 struct remain_on_channel {
3590 * freq - Channel frequency in MHz
3595 * duration - Duration to remain on the channel in milliseconds
3597 unsigned int duration;
3598 } remain_on_channel;
3601 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3602 * @aborted: Whether the scan was aborted
3603 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3604 * @num_freqs: Number of entries in freqs array
3605 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3607 * @num_ssids: Number of entries in ssids array
3613 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3618 * struct mlme_rx - Data for EVENT_MLME_RX events
3629 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3631 struct rx_probe_req {
3633 * sa - Source address of the received Probe Request frame
3638 * da - Destination address of the received Probe Request frame
3639 * or %NULL if not available
3644 * bssid - BSSID of the received Probe Request frame or %NULL
3650 * ie - IEs from the Probe Request body
3655 * ie_len - Length of ie buffer in octets
3660 * signal - signal strength in dBm (or 0 if not available)
3666 * struct new_sta - Data for EVENT_NEW_STA events
3673 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3682 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3684 struct wpa_signal_info signal_change;
3687 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3688 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3689 * @freq_5: Best 5 GHz band channel frequency in MHz
3690 * @freq_overall: Best channel frequency in MHz
3692 * 0 can be used to indicate no preference in either band.
3694 struct best_channel {
3700 struct unprot_deauth {
3706 struct unprot_disassoc {
3713 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3714 * @addr: station address
3721 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3723 struct p2p_dev_found {
3726 const u8 *pri_dev_type;
3727 const char *dev_name;
3734 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3736 struct p2p_go_neg_req_rx {
3739 } p2p_go_neg_req_rx;
3742 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3744 struct p2p_go_neg_completed {
3745 struct p2p_go_neg_results *res;
3746 } p2p_go_neg_completed;
3748 struct p2p_prov_disc_req {
3752 const u8 *pri_dev_type;
3753 const char *dev_name;
3754 u16 supp_config_methods;
3757 } p2p_prov_disc_req;
3759 struct p2p_prov_disc_resp {
3762 } p2p_prov_disc_resp;
3773 struct p2p_sd_resp {
3781 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3783 struct ibss_peer_lost {
3788 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3790 struct driver_gtk_rekey {
3792 const u8 *replay_ctr;
3796 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
3797 * @addr: station address
3799 struct client_poll {
3804 * struct eapol_tx_status
3805 * @dst: Original destination
3806 * @data: Data starting with IEEE 802.1X header (!)
3807 * @data_len: Length of data
3808 * @ack: Indicates ack or lost frame
3810 * This corresponds to hapd_send_eapol if the frame sent
3811 * there isn't just reported as EVENT_TX_STATUS.
3813 struct eapol_tx_status {
3822 * @freq: Frequency of new channel in MHz
3823 * @ht_enabled: Whether this is an HT channel
3824 * @ch_offset: Secondary channel offset
3833 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
3834 * @addr: Remote client address
3835 * @code: Reason code for connection failure
3837 struct connect_failed_reason {
3843 } connect_failed_reason;
3846 * struct dfs_event - Data for radar detected events
3847 * @freq: Frequency of the channel in MHz
3855 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3856 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3857 * with struct wpa_driver_ops::init()
3858 * @event: event type (defined above)
3859 * @data: possible extra data for the event
3861 * Driver wrapper code should call this function whenever an event is received
3864 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
3865 union wpa_event_data *data);
3869 * The following inline functions are provided for convenience to simplify
3870 * event indication for some of the common events.
3873 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
3874 size_t ielen, int reassoc)
3876 union wpa_event_data event;
3877 os_memset(&event, 0, sizeof(event));
3878 event.assoc_info.reassoc = reassoc;
3879 event.assoc_info.req_ies = ie;
3880 event.assoc_info.req_ies_len = ielen;
3881 event.assoc_info.addr = addr;
3882 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
3885 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
3887 union wpa_event_data event;
3888 os_memset(&event, 0, sizeof(event));
3889 event.disassoc_info.addr = addr;
3890 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
3893 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
3896 union wpa_event_data event;
3897 os_memset(&event, 0, sizeof(event));
3898 event.eapol_rx.src = src;
3899 event.eapol_rx.data = data;
3900 event.eapol_rx.data_len = data_len;
3901 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
3904 /* driver_common.c */
3905 void wpa_scan_results_free(struct wpa_scan_results *res);
3907 /* Convert wpa_event_type to a string for logging */
3908 const char * event_to_string(enum wpa_event_type event);
3910 #endif /* DRIVER_H */