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"
23 #include "utils/list.h"
25 #define HOSTAPD_CHAN_DISABLED 0x00000001
26 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
27 #define HOSTAPD_CHAN_NO_IBSS 0x00000004
28 #define HOSTAPD_CHAN_RADAR 0x00000008
29 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
30 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
31 #define HOSTAPD_CHAN_HT40 0x00000040
32 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
34 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
35 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
36 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
37 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
38 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
40 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
41 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
42 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
43 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
45 enum reg_change_initiator
{
49 REGDOM_SET_BY_COUNTRY_IE
,
53 * struct hostapd_channel_data - Channel information
55 struct hostapd_channel_data
{
57 * chan - Channel number (IEEE 802.11)
62 * freq - Frequency in MHz
67 * flag - Channel flags (HOSTAPD_CHAN_*)
72 * max_tx_power - Regulatory transmit power limit in dBm
77 * survey_list - Linked list of surveys
79 struct dl_list survey_list
;
82 * min_nf - Minimum observed noise floor, in dBm, based on all
83 * surveyed channel data
89 * interference_factor - Computed interference factor on this
90 * channel (used internally in src/ap/acs.c; driver wrappers do not
93 long double interference_factor
;
94 #endif /* CONFIG_ACS */
97 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
98 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
101 * struct hostapd_hw_modes - Supported hardware mode information
103 struct hostapd_hw_modes
{
105 * mode - Hardware mode
107 enum hostapd_hw_mode mode
;
110 * num_channels - Number of entries in the channels array
115 * channels - Array of supported channels
117 struct hostapd_channel_data
*channels
;
120 * num_rates - Number of entries in the rates array
125 * rates - Array of supported rates in 100 kbps units
130 * ht_capab - HT (IEEE 802.11n) capabilities
135 * mcs_set - MCS (IEEE 802.11n) rate parameters
140 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
145 * vht_capab - VHT (IEEE 802.11ac) capabilities
150 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
154 unsigned int flags
; /* HOSTAPD_MODE_FLAG_* */
158 #define IEEE80211_MODE_INFRA 0
159 #define IEEE80211_MODE_IBSS 1
160 #define IEEE80211_MODE_AP 2
162 #define IEEE80211_CAP_ESS 0x0001
163 #define IEEE80211_CAP_IBSS 0x0002
164 #define IEEE80211_CAP_PRIVACY 0x0010
166 /* DMG (60 GHz) IEEE 802.11ad */
167 /* type - bits 0..1 */
168 #define IEEE80211_CAP_DMG_MASK 0x0003
169 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
170 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
171 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
173 #define WPA_SCAN_QUAL_INVALID BIT(0)
174 #define WPA_SCAN_NOISE_INVALID BIT(1)
175 #define WPA_SCAN_LEVEL_INVALID BIT(2)
176 #define WPA_SCAN_LEVEL_DBM BIT(3)
177 #define WPA_SCAN_AUTHENTICATED BIT(4)
178 #define WPA_SCAN_ASSOCIATED BIT(5)
181 * struct wpa_scan_res - Scan result for an BSS/IBSS
182 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
184 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
185 * @beacon_int: beacon interval in TUs (host byte order)
186 * @caps: capability information field in host byte order
187 * @qual: signal quality
188 * @noise: noise level
189 * @level: signal level
191 * @age: Age of the information in milliseconds (i.e., how many milliseconds
192 * ago the last Beacon or Probe Response frame was received)
193 * @ie_len: length of the following IE field in octets
194 * @beacon_ie_len: length of the following Beacon IE field in octets
196 * This structure is used as a generic format for scan results from the
197 * driver. Each driver interface implementation is responsible for converting
198 * the driver or OS specific scan results into this format.
200 * If the driver does not support reporting all IEs, the IE data structure is
201 * constructed of the IEs that are available. This field will also need to
202 * include SSID in IE format. All drivers are encouraged to be extended to
203 * report all IEs to make it easier to support future additions.
205 struct wpa_scan_res
{
217 size_t beacon_ie_len
;
219 * Followed by ie_len octets of IEs from Probe Response frame (or if
220 * the driver does not indicate source of IEs, these may also be from
221 * Beacon frame). After the first set of IEs, another set of IEs may
222 * follow (with beacon_ie_len octets of data) if the driver provides
228 * struct wpa_scan_results - Scan results
229 * @res: Array of pointers to allocated variable length scan result entries
230 * @num: Number of entries in the scan result array
231 * @fetch_time: Time when the results were fetched from the driver
233 struct wpa_scan_results
{
234 struct wpa_scan_res
**res
;
236 struct os_reltime fetch_time
;
240 * struct wpa_interface_info - Network interface information
241 * @next: Pointer to the next interface or NULL if this is the last one
242 * @ifname: Interface name that can be used with init() or init2()
243 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
245 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
246 * is not an allocated copy, i.e., get_interfaces() caller will not free
249 struct wpa_interface_info
{
250 struct wpa_interface_info
*next
;
253 const char *drv_name
;
256 #define WPAS_MAX_SCAN_SSIDS 16
259 * struct wpa_driver_scan_params - Scan parameters
260 * Data for struct wpa_driver_ops::scan2().
262 struct wpa_driver_scan_params
{
264 * ssids - SSIDs to scan for
266 struct wpa_driver_scan_ssid
{
268 * ssid - specific SSID to scan for (ProbeReq)
269 * %NULL or zero-length SSID is used to indicate active scan
270 * with wildcard SSID.
274 * ssid_len: Length of the SSID in octets
277 } ssids
[WPAS_MAX_SCAN_SSIDS
];
280 * num_ssids - Number of entries in ssids array
281 * Zero indicates a request for a passive scan.
286 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
291 * extra_ies_len - Length of extra_ies in octets
293 size_t extra_ies_len
;
296 * freqs - Array of frequencies to scan or %NULL for all frequencies
298 * The frequency is set in MHz. The array is zero-terminated.
303 * filter_ssids - Filter for reporting SSIDs
305 * This optional parameter can be used to request the driver wrapper to
306 * filter scan results to include only the specified SSIDs. %NULL
307 * indicates that no filtering is to be done. This can be used to
308 * reduce memory needs for scan results in environments that have large
309 * number of APs with different SSIDs.
311 * The driver wrapper is allowed to take this allocated buffer into its
312 * own use by setting the pointer to %NULL. In that case, the driver
313 * wrapper is responsible for freeing the buffer with os_free() once it
314 * is not needed anymore.
316 struct wpa_driver_scan_filter
{
322 * num_filter_ssids - Number of entries in filter_ssids array
324 size_t num_filter_ssids
;
327 * filter_rssi - Filter by RSSI
329 * The driver may filter scan results in firmware to reduce host
330 * wakeups and thereby save power. Specify the RSSI threshold in s32
336 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
338 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
339 * Mbps from the support rates element(s) in the Probe Request frames
340 * and not to transmit the frames at any of those rates.
345 * only_new_results - Request driver to report only new results
347 * This is used to request the driver to report only BSSes that have
348 * been detected after this scan request has been started, i.e., to
349 * flush old cached BSS entries.
351 int only_new_results
;
355 * struct wpa_driver_auth_params - Authentication parameters
356 * Data for struct wpa_driver_ops::authenticate().
358 struct wpa_driver_auth_params
{
366 const u8
*wep_key
[4];
367 size_t wep_key_len
[4];
369 int local_state_change
;
372 * p2p - Whether this connection is a P2P group
382 WPS_MODE_NONE
/* no WPS provisioning being used */,
383 WPS_MODE_OPEN
/* WPS provisioning with AP that is in open mode */,
384 WPS_MODE_PRIVACY
/* WPS provisioning with AP that is using protection
389 * struct wpa_driver_associate_params - Association parameters
390 * Data for struct wpa_driver_ops::associate().
392 struct wpa_driver_associate_params
{
394 * bssid - BSSID of the selected AP
395 * This can be %NULL, if ap_scan=2 mode is used and the driver is
396 * responsible for selecting with which BSS to associate. */
400 * ssid - The selected SSID
405 * ssid_len - Length of the SSID (1..32)
410 * freq - Frequency of the channel the selected AP is using
411 * Frequency that the selected AP is using (in MHz as
412 * reported in the scan results)
417 * bg_scan_period - Background scan period in seconds, 0 to disable
418 * background scan, or -1 to indicate no change to default driver
424 * wpa_ie - WPA information element for (Re)Association Request
425 * WPA information element to be included in (Re)Association
426 * Request (including information element id and length). Use
427 * of this WPA IE is optional. If the driver generates the WPA
428 * IE, it can use pairwise_suite, group_suite, and
429 * key_mgmt_suite to select proper algorithms. In this case,
430 * the driver has to notify wpa_supplicant about the used WPA
431 * IE by generating an event that the interface code will
432 * convert into EVENT_ASSOCINFO data (see below).
434 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
435 * instead. The driver can determine which version is used by
436 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
439 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
444 * wpa_ie_len - length of the wpa_ie
449 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
451 unsigned int wpa_proto
;
454 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
456 * This is usually ignored if @wpa_ie is used.
458 unsigned int pairwise_suite
;
461 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
463 * This is usually ignored if @wpa_ie is used.
465 unsigned int group_suite
;
468 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
470 * This is usually ignored if @wpa_ie is used.
472 unsigned int key_mgmt_suite
;
475 * auth_alg - Allowed authentication algorithms
476 * Bit field of WPA_AUTH_ALG_*
481 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
486 * wep_key - WEP keys for static WEP configuration
488 const u8
*wep_key
[4];
491 * wep_key_len - WEP key length for static WEP configuration
493 size_t wep_key_len
[4];
496 * wep_tx_keyidx - WEP TX key index for static WEP configuration
501 * mgmt_frame_protection - IEEE 802.11w management frame protection
503 enum mfp_options mgmt_frame_protection
;
506 * ft_ies - IEEE 802.11r / FT information elements
507 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
508 * for fast transition, this parameter is set to include the IEs that
509 * are to be sent in the next FT Authentication Request message.
510 * update_ft_ies() handler is called to update the IEs for further
511 * FT messages in the sequence.
513 * The driver should use these IEs only if the target AP is advertising
514 * the same mobility domain as the one included in the MDIE here.
516 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
517 * AP after the initial association. These IEs can only be used if the
518 * target AP is advertising support for FT and is using the same MDIE
519 * and SSID as the current AP.
521 * The driver is responsible for reporting the FT IEs received from the
522 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
523 * type. update_ft_ies() handler will then be called with the FT IEs to
524 * include in the next frame in the authentication sequence.
529 * ft_ies_len - Length of ft_ies in bytes
534 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
536 * This value is provided to allow the driver interface easier access
537 * to the current mobility domain. This value is set to %NULL if no
538 * mobility domain is currently active.
543 * passphrase - RSN passphrase for PSK
545 * This value is made available only for WPA/WPA2-Personal (PSK) and
546 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
547 * the 8..63 character ASCII passphrase, if available. Please note that
548 * this can be %NULL if passphrase was not used to generate the PSK. In
549 * that case, the psk field must be used to fetch the PSK.
551 const char *passphrase
;
554 * psk - RSN PSK (alternative for passphrase for PSK)
556 * This value is made available only for WPA/WPA2-Personal (PSK) and
557 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
558 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
559 * be prepared to handle %NULL value as an error.
564 * drop_unencrypted - Enable/disable unencrypted frame filtering
566 * Configure the driver to drop all non-EAPOL frames (both receive and
567 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
568 * still be allowed for key negotiation.
570 int drop_unencrypted
;
573 * prev_bssid - Previously used BSSID in this ESS
575 * When not %NULL, this is a request to use reassociation instead of
578 const u8
*prev_bssid
;
583 * If the driver needs to do special configuration for WPS association,
584 * this variable provides more information on what type of association
585 * is being requested. Most drivers should not need ot use this.
590 * p2p - Whether this connection is a P2P group
595 * uapsd - UAPSD parameters for the network
596 * -1 = do not change defaults
597 * AP mode: 1 = enabled, 0 = disabled
598 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
603 * fixed_bssid - Whether to force this BSSID in IBSS mode
604 * 1 = Fix this BSSID and prevent merges.
605 * 0 = Do not fix BSSID.
610 * disable_ht - Disable HT (IEEE 802.11n) for this connection
615 * HT Capabilities over-rides. Only bits set in the mask will be used,
616 * and not all values are used by the kernel anyway. Currently, MCS,
617 * MPDU and MSDU fields are used.
619 const u8
*htcaps
; /* struct ieee80211_ht_capabilities * */
620 const u8
*htcaps_mask
; /* struct ieee80211_ht_capabilities * */
622 #ifdef CONFIG_VHT_OVERRIDES
624 * disable_vht - Disable VHT for this connection
629 * VHT capability overrides.
631 const struct ieee80211_vht_capabilities
*vhtcaps
;
632 const struct ieee80211_vht_capabilities
*vhtcaps_mask
;
633 #endif /* CONFIG_VHT_OVERRIDES */
638 HIDDEN_SSID_ZERO_LEN
,
639 HIDDEN_SSID_ZERO_CONTENTS
642 struct wpa_driver_ap_params
{
644 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
649 * head_len - Length of the head buffer in octets
654 * tail - Beacon tail following TIM IE
659 * tail_len - Length of the tail buffer in octets
664 * dtim_period - DTIM period
669 * beacon_int - Beacon interval
674 * basic_rates: -1 terminated array of basic rates in 100 kbps
676 * This parameter can be used to set a specific basic rate set for the
677 * BSS. If %NULL, default basic rate set is used.
682 * proberesp - Probe Response template
684 * This is used by drivers that reply to Probe Requests internally in
685 * AP mode and require the full Probe Response template.
690 * proberesp_len - Length of the proberesp buffer in octets
692 size_t proberesp_len
;
695 * ssid - The SSID to use in Beacon/Probe Response frames
700 * ssid_len - Length of the SSID (1..32)
705 * hide_ssid - Whether to hide the SSID
707 enum hide_ssid hide_ssid
;
710 * pairwise_ciphers - WPA_CIPHER_* bitfield
712 unsigned int pairwise_ciphers
;
715 * group_cipher - WPA_CIPHER_*
717 unsigned int group_cipher
;
720 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
722 unsigned int key_mgmt_suites
;
725 * auth_algs - WPA_AUTH_ALG_* bitfield
727 unsigned int auth_algs
;
730 * wpa_version - WPA_PROTO_* bitfield
732 unsigned int wpa_version
;
735 * privacy - Whether privacy is used in the BSS
740 * beacon_ies - WPS/P2P IE(s) for Beacon frames
742 * This is used to add IEs like WPS IE and P2P IE by drivers that do
743 * not use the full Beacon template.
745 const struct wpabuf
*beacon_ies
;
748 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
750 * This is used to add IEs like WPS IE and P2P IE by drivers that
751 * reply to Probe Request frames internally.
753 const struct wpabuf
*proberesp_ies
;
756 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
758 * This is used to add IEs like WPS IE by drivers that reply to
759 * (Re)Association Request frames internally.
761 const struct wpabuf
*assocresp_ies
;
764 * isolate - Whether to isolate frames between associated stations
766 * If this is non-zero, the AP is requested to disable forwarding of
767 * frames between associated stations.
772 * cts_protect - Whether CTS protection is enabled
777 * preamble - Whether short preamble is enabled
782 * short_slot_time - Whether short slot time is enabled
784 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
785 * not set (e.g., when 802.11g mode is not in use)
790 * ht_opmode - HT operation mode or -1 if HT not in use
795 * interworking - Whether Interworking is enabled
800 * hessid - Homogeneous ESS identifier or %NULL if not set
805 * access_network_type - Access Network Type (0..15)
807 * This is used for filtering Probe Request frames when Interworking is
810 u8 access_network_type
;
813 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
815 * This is used by driver which advertises this capability.
817 int ap_max_inactivity
;
820 * disable_dgaf - Whether group-addressed frames are disabled
826 * struct wpa_driver_capa - Driver capability information
828 struct wpa_driver_capa
{
829 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
830 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
831 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
832 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
833 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
834 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
835 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
836 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
837 unsigned int key_mgmt
;
839 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
840 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
841 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
842 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
843 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
844 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
845 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
846 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
847 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
848 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
849 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
850 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
853 #define WPA_DRIVER_AUTH_OPEN 0x00000001
854 #define WPA_DRIVER_AUTH_SHARED 0x00000002
855 #define WPA_DRIVER_AUTH_LEAP 0x00000004
858 /* Driver generated WPA/RSN IE */
859 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
860 /* Driver needs static WEP key setup after association command */
861 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
862 /* unused: 0x00000004 */
863 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
864 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
865 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
866 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
867 /* Driver provides separate commands for authentication and association (SME in
868 * wpa_supplicant). */
869 #define WPA_DRIVER_FLAGS_SME 0x00000020
870 /* Driver supports AP mode */
871 #define WPA_DRIVER_FLAGS_AP 0x00000040
872 /* Driver needs static WEP key setup after association has been completed */
873 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
874 /* unused: 0x00000100 */
875 /* Driver supports concurrent P2P operations */
876 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
878 * Driver uses the initial interface as a dedicated management interface, i.e.,
879 * it cannot be used for P2P group operations or non-P2P purposes.
881 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
882 /* This interface is P2P capable (P2P GO or P2P Client) */
883 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
884 /* unused: 0x00001000 */
886 * Driver uses the initial interface for P2P management interface and non-P2P
887 * purposes (e.g., connect to infra AP), but this interface cannot be used for
888 * P2P group operations.
890 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
892 * Driver is known to use sane error codes, i.e., when it indicates that
893 * something (e.g., association) fails, there was indeed a failure and the
894 * operation does not end up getting completed successfully later.
896 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
897 /* Driver supports off-channel TX */
898 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
899 /* Driver indicates TX status events for EAPOL Data frames */
900 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
901 /* Driver indicates TX status events for Deauth/Disassoc frames */
902 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
903 /* Driver supports roaming (BSS selection) in firmware */
904 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
905 /* Driver supports operating as a TDLS peer */
906 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
907 /* Driver requires external TDLS setup/teardown/discovery */
908 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
909 /* Driver indicates support for Probe Response offloading in AP mode */
910 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
911 /* Driver supports U-APSD in AP mode */
912 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
913 /* Driver supports inactivity timer in AP mode */
914 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
915 /* Driver expects user space implementation of MLME in AP mode */
916 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
917 /* Driver supports SAE with user space SME */
918 #define WPA_DRIVER_FLAGS_SAE 0x02000000
919 /* Driver makes use of OBSS scan mechanism in wpa_supplicant */
920 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
921 /* Driver supports IBSS (Ad-hoc) mode */
922 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
923 /* Driver supports radar detection */
924 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
925 /* Driver supports a dedicated interface for P2P Device */
926 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
927 /* Driver supports QoS Mapping */
928 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
932 int max_sched_scan_ssids
;
933 int sched_scan_supported
;
937 * max_remain_on_chan - Maximum remain-on-channel duration in msec
939 unsigned int max_remain_on_chan
;
942 * max_stations - Maximum number of associated stations the driver
943 * supports in AP mode
945 unsigned int max_stations
;
948 * probe_resp_offloads - Bitmap of supported protocols by the driver
949 * for Probe Response offloading.
951 /* Driver Probe Response offloading support for WPS ver. 1 */
952 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
953 /* Driver Probe Response offloading support for WPS ver. 2 */
954 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
955 /* Driver Probe Response offloading support for P2P */
956 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
957 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
958 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
959 unsigned int probe_resp_offloads
;
961 unsigned int max_acl_mac_addrs
;
964 * Number of supported concurrent channels
966 unsigned int num_multichan_concurrent
;
969 * extended_capa - extended capabilities in driver/device
971 * Must be allocated and freed by driver and the pointers must be
972 * valid for the lifetime of the driver, i.e., freed in deinit()
974 const u8
*extended_capa
, *extended_capa_mask
;
975 unsigned int extended_capa_len
;
981 struct hostap_sta_driver_data
{
982 unsigned long rx_packets
, tx_packets
, rx_bytes
, tx_bytes
;
983 unsigned long current_tx_rate
;
984 unsigned long inactive_msec
;
986 unsigned long num_ps_buf_frames
;
987 unsigned long tx_retry_failed
;
988 unsigned long tx_retry_count
;
993 struct hostapd_sta_add_params
{
997 const u8
*supp_rates
;
998 size_t supp_rates_len
;
1000 const struct ieee80211_ht_capabilities
*ht_capabilities
;
1001 const struct ieee80211_vht_capabilities
*vht_capabilities
;
1002 u32 flags
; /* bitmask of WPA_STA_* flags */
1003 int set
; /* Set STA parameters instead of add */
1005 const u8
*ext_capab
;
1006 size_t ext_capab_len
;
1009 struct hostapd_freq_params
{
1015 int sec_channel_offset
; /* 0 = HT40 disabled, -1 = HT40 enabled,
1016 * secondary channel below primary, 1 = HT40
1017 * enabled, secondary channel above primary */
1022 /* valid for both HT and VHT, center_freq2 is non-zero
1023 * only for bandwidth 80 and an 80+80 channel */
1024 int center_freq1
, center_freq2
;
1028 struct mac_address
{
1032 struct hostapd_acl_params
{
1034 unsigned int num_mac_acl
;
1035 struct mac_address mac_acl
[0];
1038 enum wpa_driver_if_type
{
1040 * WPA_IF_STATION - Station mode interface
1045 * WPA_IF_AP_VLAN - AP mode VLAN interface
1047 * This interface shares its address and Beacon frame with the main
1053 * WPA_IF_AP_BSS - AP mode BSS interface
1055 * This interface has its own address and Beacon frame.
1060 * WPA_IF_P2P_GO - P2P Group Owner
1065 * WPA_IF_P2P_CLIENT - P2P Client
1070 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1071 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1076 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1077 * abstracted P2P Device function in the driver
1082 struct wpa_init_params
{
1088 const char *test_socket
;
1089 int use_pae_group_addr
;
1093 u8
*own_addr
; /* buffer for writing own MAC address */
1097 struct wpa_bss_params
{
1098 /** Interface name (for multi-SSID/VLAN support) */
1100 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1109 enum mfp_options ieee80211w
;
1112 #define WPA_STA_AUTHORIZED BIT(0)
1113 #define WPA_STA_WMM BIT(1)
1114 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1115 #define WPA_STA_MFP BIT(3)
1116 #define WPA_STA_TDLS_PEER BIT(4)
1129 WNM_SLEEP_ENTER_CONFIRM
,
1130 WNM_SLEEP_ENTER_FAIL
,
1131 WNM_SLEEP_EXIT_CONFIRM
,
1132 WNM_SLEEP_EXIT_FAIL
,
1133 WNM_SLEEP_TFS_REQ_IE_ADD
, /* STA requests driver to add TFS req IE */
1134 WNM_SLEEP_TFS_REQ_IE_NONE
, /* STA requests empty TFS req IE */
1135 WNM_SLEEP_TFS_REQ_IE_SET
, /* AP requests driver to set TFS req IE for
1137 WNM_SLEEP_TFS_RESP_IE_ADD
, /* AP requests driver to add TFS resp IE
1139 WNM_SLEEP_TFS_RESP_IE_NONE
, /* AP requests empty TFS resp IE */
1140 WNM_SLEEP_TFS_RESP_IE_SET
, /* AP requests driver to set TFS resp IE
1142 WNM_SLEEP_TFS_IE_DEL
/* AP delete the TFS IE */
1145 /* enum chan_width - Channel width definitions */
1157 * struct wpa_signal_info - Information about channel signal quality
1159 struct wpa_signal_info
{
1161 int above_threshold
;
1166 enum chan_width chanwidth
;
1172 * struct beacon_data - Beacon data
1173 * @head: Head portion of Beacon frame (before TIM IE)
1174 * @tail: Tail portion of Beacon frame (after TIM IE)
1175 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1176 * @proberesp_ies: Extra information element(s) to add into Probe Response
1178 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1179 * Response frames or %NULL
1180 * @probe_resp: Probe Response frame template
1181 * @head_len: Length of @head
1182 * @tail_len: Length of @tail
1183 * @beacon_ies_len: Length of beacon_ies in octets
1184 * @proberesp_ies_len: Length of proberesp_ies in octets
1185 * @proberesp_ies_len: Length of proberesp_ies in octets
1186 * @probe_resp_len: Length of probe response template (@probe_resp)
1188 struct beacon_data
{
1195 size_t head_len
, tail_len
;
1196 size_t beacon_ies_len
;
1197 size_t proberesp_ies_len
;
1198 size_t assocresp_ies_len
;
1199 size_t probe_resp_len
;
1203 * struct csa_settings - Settings for channel switch command
1204 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1205 * @block_tx: 1 - block transmission for CSA period
1206 * @freq_params: Next channel frequency parameter
1207 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1208 * @beacon_after: Next beacon/probe resp/asooc resp info
1209 * @counter_offset_beacon: Offset to the count field in beacon's tail
1210 * @counter_offset_presp: Offset to the count field in probe resp.
1212 struct csa_settings
{
1216 struct hostapd_freq_params freq_params
;
1217 struct beacon_data beacon_csa
;
1218 struct beacon_data beacon_after
;
1220 u16 counter_offset_beacon
;
1221 u16 counter_offset_presp
;
1225 * struct wpa_driver_ops - Driver interface API definition
1227 * This structure defines the API that each driver interface needs to implement
1228 * for core wpa_supplicant code. All driver specific functionality is captured
1231 struct wpa_driver_ops
{
1232 /** Name of the driver interface */
1234 /** One line description of the driver interface */
1238 * get_bssid - Get the current BSSID
1239 * @priv: private driver interface data
1240 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1242 * Returns: 0 on success, -1 on failure
1244 * Query kernel driver for the current BSSID and copy it to bssid.
1245 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1248 int (*get_bssid
)(void *priv
, u8
*bssid
);
1251 * get_ssid - Get the current SSID
1252 * @priv: private driver interface data
1253 * @ssid: buffer for SSID (at least 32 bytes)
1255 * Returns: Length of the SSID on success, -1 on failure
1257 * Query kernel driver for the current SSID and copy it to ssid.
1258 * Returning zero is recommended if the STA is not associated.
1260 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1261 * can, at least in theory, contain control characters (including nul)
1262 * and as such, should be processed as binary data, not a printable
1265 int (*get_ssid
)(void *priv
, u8
*ssid
);
1268 * set_key - Configure encryption key
1269 * @ifname: Interface name (for multi-SSID/VLAN support)
1270 * @priv: private driver interface data
1271 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1272 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1273 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1274 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1275 * %WPA_ALG_BIP_CMAC_256);
1276 * %WPA_ALG_NONE clears the key.
1277 * @addr: Address of the peer STA (BSSID of the current AP when setting
1278 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1279 * broadcast keys, %NULL for default keys that are used both for
1280 * broadcast and unicast; when clearing keys, %NULL is used to
1281 * indicate that both the broadcast-only and default key of the
1282 * specified key index is to be cleared
1283 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1285 * @set_tx: configure this key as the default Tx key (only used when
1286 * driver does not support separate unicast/individual key
1287 * @seq: sequence number/packet number, seq_len octets, the next
1288 * packet number to be used for in replay protection; configured
1289 * for Rx keys (in most cases, this is only used with broadcast
1290 * keys and set to zero for unicast keys); %NULL if not set
1291 * @seq_len: length of the seq, depends on the algorithm:
1292 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1293 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1295 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1296 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1298 * Returns: 0 on success, -1 on failure
1300 * Configure the given key for the kernel driver. If the driver
1301 * supports separate individual keys (4 default keys + 1 individual),
1302 * addr can be used to determine whether the key is default or
1303 * individual. If only 4 keys are supported, the default key with key
1304 * index 0 is used as the individual key. STA must be configured to use
1305 * it as the default Tx key (set_tx is set) and accept Rx for all the
1306 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1307 * broadcast keys, so key index 0 is available for this kind of
1310 * Please note that TKIP keys include separate TX and RX MIC keys and
1311 * some drivers may expect them in different order than wpa_supplicant
1312 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1313 * will trigger Michael MIC errors. This can be fixed by changing the
1314 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1315 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1316 * example on how this can be done.
1318 int (*set_key
)(const char *ifname
, void *priv
, enum wpa_alg alg
,
1319 const u8
*addr
, int key_idx
, int set_tx
,
1320 const u8
*seq
, size_t seq_len
,
1321 const u8
*key
, size_t key_len
);
1324 * init - Initialize driver interface
1325 * @ctx: context to be used when calling wpa_supplicant functions,
1326 * e.g., wpa_supplicant_event()
1327 * @ifname: interface name, e.g., wlan0
1329 * Returns: Pointer to private data, %NULL on failure
1331 * Initialize driver interface, including event processing for kernel
1332 * driver events (e.g., associated, scan results, Michael MIC failure).
1333 * This function can allocate a private configuration data area for
1334 * @ctx, file descriptor, interface name, etc. information that may be
1335 * needed in future driver operations. If this is not used, non-NULL
1336 * value will need to be returned because %NULL is used to indicate
1337 * failure. The returned value will be used as 'void *priv' data for
1338 * all other driver_ops functions.
1340 * The main event loop (eloop.c) of wpa_supplicant can be used to
1341 * register callback for read sockets (eloop_register_read_sock()).
1343 * See below for more information about events and
1344 * wpa_supplicant_event() function.
1346 void * (*init
)(void *ctx
, const char *ifname
);
1349 * deinit - Deinitialize driver interface
1350 * @priv: private driver interface data from init()
1352 * Shut down driver interface and processing of driver events. Free
1353 * private data buffer if one was allocated in init() handler.
1355 void (*deinit
)(void *priv
);
1358 * set_param - Set driver configuration parameters
1359 * @priv: private driver interface data from init()
1360 * @param: driver specific configuration parameters
1362 * Returns: 0 on success, -1 on failure
1364 * Optional handler for notifying driver interface about configuration
1365 * parameters (driver_param).
1367 int (*set_param
)(void *priv
, const char *param
);
1370 * set_countermeasures - Enable/disable TKIP countermeasures
1371 * @priv: private driver interface data
1372 * @enabled: 1 = countermeasures enabled, 0 = disabled
1374 * Returns: 0 on success, -1 on failure
1376 * Configure TKIP countermeasures. When these are enabled, the driver
1377 * should drop all received and queued frames that are using TKIP.
1379 int (*set_countermeasures
)(void *priv
, int enabled
);
1382 * deauthenticate - Request driver to deauthenticate
1383 * @priv: private driver interface data
1384 * @addr: peer address (BSSID of the AP)
1385 * @reason_code: 16-bit reason code to be sent in the deauthentication
1388 * Returns: 0 on success, -1 on failure
1390 int (*deauthenticate
)(void *priv
, const u8
*addr
, int reason_code
);
1393 * associate - Request driver to associate
1394 * @priv: private driver interface data
1395 * @params: association parameters
1397 * Returns: 0 on success, -1 on failure
1399 int (*associate
)(void *priv
,
1400 struct wpa_driver_associate_params
*params
);
1403 * add_pmkid - Add PMKSA cache entry to the driver
1404 * @priv: private driver interface data
1405 * @bssid: BSSID for the PMKSA cache entry
1406 * @pmkid: PMKID for the PMKSA cache entry
1408 * Returns: 0 on success, -1 on failure
1410 * This function is called when a new PMK is received, as a result of
1411 * either normal authentication or RSN pre-authentication.
1413 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1414 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1415 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1416 * driver_ops function does not need to be implemented. Likewise, if
1417 * the driver does not support WPA, this function is not needed.
1419 int (*add_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
1422 * remove_pmkid - Remove PMKSA cache entry to the driver
1423 * @priv: private driver interface data
1424 * @bssid: BSSID for the PMKSA cache entry
1425 * @pmkid: PMKID for the PMKSA cache entry
1427 * Returns: 0 on success, -1 on failure
1429 * This function is called when the supplicant drops a PMKSA cache
1430 * entry for any reason.
1432 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1433 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1434 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1435 * from wpa_supplicant, this driver_ops function does not need to be
1436 * implemented. Likewise, if the driver does not support WPA, this
1437 * function is not needed.
1439 int (*remove_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
1442 * flush_pmkid - Flush PMKSA cache
1443 * @priv: private driver interface data
1445 * Returns: 0 on success, -1 on failure
1447 * This function is called when the supplicant drops all PMKSA cache
1448 * entries for any reason.
1450 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1451 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1452 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1453 * from wpa_supplicant, this driver_ops function does not need to be
1454 * implemented. Likewise, if the driver does not support WPA, this
1455 * function is not needed.
1457 int (*flush_pmkid
)(void *priv
);
1460 * get_capa - Get driver capabilities
1461 * @priv: private driver interface data
1463 * Returns: 0 on success, -1 on failure
1465 * Get driver/firmware/hardware capabilities.
1467 int (*get_capa
)(void *priv
, struct wpa_driver_capa
*capa
);
1470 * poll - Poll driver for association information
1471 * @priv: private driver interface data
1473 * This is an option callback that can be used when the driver does not
1474 * provide event mechanism for association events. This is called when
1475 * receiving WPA EAPOL-Key messages that require association
1476 * information. The driver interface is supposed to generate associnfo
1477 * event before returning from this callback function. In addition, the
1478 * driver interface should generate an association event after having
1479 * sent out associnfo.
1481 void (*poll
)(void *priv
);
1484 * get_ifname - Get interface name
1485 * @priv: private driver interface data
1487 * Returns: Pointer to the interface name. This can differ from the
1488 * interface name used in init() call. Init() is called first.
1490 * This optional function can be used to allow the driver interface to
1491 * replace the interface name with something else, e.g., based on an
1492 * interface mapping from a more descriptive name.
1494 const char * (*get_ifname
)(void *priv
);
1497 * get_mac_addr - Get own MAC address
1498 * @priv: private driver interface data
1500 * Returns: Pointer to own MAC address or %NULL on failure
1502 * This optional function can be used to get the own MAC address of the
1503 * device from the driver interface code. This is only needed if the
1504 * l2_packet implementation for the OS does not provide easy access to
1506 const u8
* (*get_mac_addr
)(void *priv
);
1509 * send_eapol - Optional function for sending EAPOL packets
1510 * @priv: private driver interface data
1511 * @dest: Destination MAC address
1513 * @data: EAPOL packet starting with IEEE 802.1X header
1514 * @data_len: Size of the EAPOL packet
1516 * Returns: 0 on success, -1 on failure
1518 * This optional function can be used to override l2_packet operations
1519 * with driver specific functionality. If this function pointer is set,
1520 * l2_packet module is not used at all and the driver interface code is
1521 * responsible for receiving and sending all EAPOL packets. The
1522 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1523 * event. The driver interface is required to implement get_mac_addr()
1524 * handler if send_eapol() is used.
1526 int (*send_eapol
)(void *priv
, const u8
*dest
, u16 proto
,
1527 const u8
*data
, size_t data_len
);
1530 * set_operstate - Sets device operating state to DORMANT or UP
1531 * @priv: private driver interface data
1532 * @state: 0 = dormant, 1 = up
1533 * Returns: 0 on success, -1 on failure
1535 * This is an optional function that can be used on operating systems
1536 * that support a concept of controlling network device state from user
1537 * space applications. This function, if set, gets called with
1538 * state = 1 when authentication has been completed and with state = 0
1539 * when connection is lost.
1541 int (*set_operstate
)(void *priv
, int state
);
1544 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1545 * @priv: Private driver interface data
1546 * @addr: Address of the station for which to set protection (may be
1547 * %NULL for group keys)
1548 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1549 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1550 * Returns: 0 on success, -1 on failure
1552 * This is an optional function that can be used to set the driver to
1553 * require protection for Tx and/or Rx frames. This uses the layer
1554 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1555 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1556 * set protection operation; instead, they set protection implicitly
1557 * based on configured keys.
1559 int (*mlme_setprotection
)(void *priv
, const u8
*addr
, int protect_type
,
1563 * get_hw_feature_data - Get hardware support data (channels and rates)
1564 * @priv: Private driver interface data
1565 * @num_modes: Variable for returning the number of returned modes
1566 * flags: Variable for returning hardware feature flags
1567 * Returns: Pointer to allocated hardware data on success or %NULL on
1568 * failure. Caller is responsible for freeing this.
1570 struct hostapd_hw_modes
* (*get_hw_feature_data
)(void *priv
,
1575 * send_mlme - Send management frame from MLME
1576 * @priv: Private driver interface data
1577 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1578 * @data_len: Size of the management frame
1579 * @noack: Do not wait for this frame to be acked (disable retries)
1580 * Returns: 0 on success, -1 on failure
1582 int (*send_mlme
)(void *priv
, const u8
*data
, size_t data_len
,
1586 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1587 * @priv: Private driver interface data
1588 * @md: Mobility domain (2 octets) (also included inside ies)
1589 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1590 * @ies_len: Length of FT IEs in bytes
1591 * Returns: 0 on success, -1 on failure
1593 * The supplicant uses this callback to let the driver know that keying
1594 * material for FT is available and that the driver can use the
1595 * provided IEs in the next message in FT authentication sequence.
1597 * This function is only needed for driver that support IEEE 802.11r
1598 * (Fast BSS Transition).
1600 int (*update_ft_ies
)(void *priv
, const u8
*md
, const u8
*ies
,
1604 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1605 * @priv: Private driver interface data
1606 * @action: Action field value
1607 * @target_ap: Target AP address
1608 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1609 * @ies_len: Length of FT IEs in bytes
1610 * Returns: 0 on success, -1 on failure
1612 * The supplicant uses this callback to request the driver to transmit
1613 * an FT Action frame (action category 6) for over-the-DS fast BSS
1616 int (*send_ft_action
)(void *priv
, u8 action
, const u8
*target_ap
,
1617 const u8
*ies
, size_t ies_len
);
1620 * get_scan_results2 - Fetch the latest scan results
1621 * @priv: private driver interface data
1623 * Returns: Allocated buffer of scan results (caller is responsible for
1624 * freeing the data structure) on success, NULL on failure
1626 struct wpa_scan_results
* (*get_scan_results2
)(void *priv
);
1629 * set_country - Set country
1630 * @priv: Private driver interface data
1631 * @alpha2: country to which to switch to
1632 * Returns: 0 on success, -1 on failure
1634 * This function is for drivers which support some form
1635 * of setting a regulatory domain.
1637 int (*set_country
)(void *priv
, const char *alpha2
);
1640 * get_country - Get country
1641 * @priv: Private driver interface data
1642 * @alpha2: Buffer for returning country code (at least 3 octets)
1643 * Returns: 0 on success, -1 on failure
1645 int (*get_country
)(void *priv
, char *alpha2
);
1648 * global_init - Global driver initialization
1649 * Returns: Pointer to private data (global), %NULL on failure
1651 * This optional function is called to initialize the driver wrapper
1652 * for global data, i.e., data that applies to all interfaces. If this
1653 * function is implemented, global_deinit() will also need to be
1654 * implemented to free the private data. The driver will also likely
1655 * use init2() function instead of init() to get the pointer to global
1656 * data available to per-interface initializer.
1658 void * (*global_init
)(void);
1661 * global_deinit - Global driver deinitialization
1662 * @priv: private driver global data from global_init()
1664 * Terminate any global driver related functionality and free the
1665 * global data structure.
1667 void (*global_deinit
)(void *priv
);
1670 * init2 - Initialize driver interface (with global data)
1671 * @ctx: context to be used when calling wpa_supplicant functions,
1672 * e.g., wpa_supplicant_event()
1673 * @ifname: interface name, e.g., wlan0
1674 * @global_priv: private driver global data from global_init()
1675 * Returns: Pointer to private data, %NULL on failure
1677 * This function can be used instead of init() if the driver wrapper
1680 void * (*init2
)(void *ctx
, const char *ifname
, void *global_priv
);
1683 * get_interfaces - Get information about available interfaces
1684 * @global_priv: private driver global data from global_init()
1685 * Returns: Allocated buffer of interface information (caller is
1686 * responsible for freeing the data structure) on success, NULL on
1689 struct wpa_interface_info
* (*get_interfaces
)(void *global_priv
);
1692 * scan2 - Request the driver to initiate scan
1693 * @priv: private driver interface data
1694 * @params: Scan parameters
1696 * Returns: 0 on success, -1 on failure
1698 * Once the scan results are ready, the driver should report scan
1699 * results event for wpa_supplicant which will eventually request the
1700 * results with wpa_driver_get_scan_results2().
1702 int (*scan2
)(void *priv
, struct wpa_driver_scan_params
*params
);
1705 * authenticate - Request driver to authenticate
1706 * @priv: private driver interface data
1707 * @params: authentication parameters
1708 * Returns: 0 on success, -1 on failure
1710 * This is an optional function that can be used with drivers that
1711 * support separate authentication and association steps, i.e., when
1712 * wpa_supplicant can act as the SME. If not implemented, associate()
1713 * function is expected to take care of IEEE 802.11 authentication,
1716 int (*authenticate
)(void *priv
,
1717 struct wpa_driver_auth_params
*params
);
1720 * set_ap - Set Beacon and Probe Response information for AP mode
1721 * @priv: Private driver interface data
1722 * @params: Parameters to use in AP mode
1724 * This function is used to configure Beacon template and/or extra IEs
1725 * to add for Beacon and Probe Response frames for the driver in
1726 * AP mode. The driver is responsible for building the full Beacon
1727 * frame by concatenating the head part with TIM IE generated by the
1728 * driver/firmware and finishing with the tail part. Depending on the
1729 * driver architectue, this can be done either by using the full
1730 * template or the set of additional IEs (e.g., WPS and P2P IE).
1731 * Similarly, Probe Response processing depends on the driver design.
1732 * If the driver (or firmware) takes care of replying to Probe Request
1733 * frames, the extra IEs provided here needs to be added to the Probe
1736 * Returns: 0 on success, -1 on failure
1738 int (*set_ap
)(void *priv
, struct wpa_driver_ap_params
*params
);
1741 * set_acl - Set ACL in AP mode
1742 * @priv: Private driver interface data
1743 * @params: Parameters to configure ACL
1744 * Returns: 0 on success, -1 on failure
1746 * This is used only for the drivers which support MAC address ACL.
1748 int (*set_acl
)(void *priv
, struct hostapd_acl_params
*params
);
1751 * hapd_init - Initialize driver interface (hostapd only)
1752 * @hapd: Pointer to hostapd context
1753 * @params: Configuration for the driver wrapper
1754 * Returns: Pointer to private data, %NULL on failure
1756 * This function is used instead of init() or init2() when the driver
1757 * wrapper is used with hostapd.
1759 void * (*hapd_init
)(struct hostapd_data
*hapd
,
1760 struct wpa_init_params
*params
);
1763 * hapd_deinit - Deinitialize driver interface (hostapd only)
1764 * @priv: Private driver interface data from hapd_init()
1766 void (*hapd_deinit
)(void *priv
);
1769 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1770 * @priv: Private driver interface data
1771 * @params: BSS parameters
1772 * Returns: 0 on success, -1 on failure
1774 * This is an optional function to configure the kernel driver to
1775 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1776 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1777 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1778 * for Beacon frames.
1780 * DEPRECATED - use set_ap() instead
1782 int (*set_ieee8021x
)(void *priv
, struct wpa_bss_params
*params
);
1785 * set_privacy - Enable/disable privacy (AP only)
1786 * @priv: Private driver interface data
1787 * @enabled: 1 = privacy enabled, 0 = disabled
1788 * Returns: 0 on success, -1 on failure
1790 * This is an optional function to configure privacy field in the
1791 * kernel driver for Beacon frames. This can be left undefined (set to
1792 * %NULL) if the driver uses the Beacon template from set_ap().
1794 * DEPRECATED - use set_ap() instead
1796 int (*set_privacy
)(void *priv
, int enabled
);
1799 * get_seqnum - Fetch the current TSC/packet number (AP only)
1800 * @ifname: The interface name (main or virtual)
1801 * @priv: Private driver interface data
1802 * @addr: MAC address of the station or %NULL for group keys
1804 * @seq: Buffer for returning the latest used TSC/packet number
1805 * Returns: 0 on success, -1 on failure
1807 * This function is used to fetch the last used TSC/packet number for
1808 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1809 * keys, so there is no strict requirement on implementing support for
1810 * unicast keys (i.e., addr != %NULL).
1812 int (*get_seqnum
)(const char *ifname
, void *priv
, const u8
*addr
,
1816 * flush - Flush all association stations (AP only)
1817 * @priv: Private driver interface data
1818 * Returns: 0 on success, -1 on failure
1820 * This function requests the driver to disassociate all associated
1821 * stations. This function does not need to be implemented if the
1822 * driver does not process association frames internally.
1824 int (*flush
)(void *priv
);
1827 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1828 * @priv: Private driver interface data
1829 * @elem: Information elements
1830 * @elem_len: Length of the elem buffer in octets
1831 * Returns: 0 on success, -1 on failure
1833 * This is an optional function to add information elements in the
1834 * kernel driver for Beacon and Probe Response frames. This can be left
1835 * undefined (set to %NULL) if the driver uses the Beacon template from
1838 * DEPRECATED - use set_ap() instead
1840 int (*set_generic_elem
)(void *priv
, const u8
*elem
, size_t elem_len
);
1843 * read_sta_data - Fetch station data
1844 * @priv: Private driver interface data
1845 * @data: Buffer for returning station information
1846 * @addr: MAC address of the station
1847 * Returns: 0 on success, -1 on failure
1849 int (*read_sta_data
)(void *priv
, struct hostap_sta_driver_data
*data
,
1853 * hapd_send_eapol - Send an EAPOL packet (AP only)
1854 * @priv: private driver interface data
1855 * @addr: Destination MAC address
1856 * @data: EAPOL packet starting with IEEE 802.1X header
1857 * @data_len: Length of the EAPOL packet in octets
1858 * @encrypt: Whether the frame should be encrypted
1859 * @own_addr: Source MAC address
1860 * @flags: WPA_STA_* flags for the destination station
1862 * Returns: 0 on success, -1 on failure
1864 int (*hapd_send_eapol
)(void *priv
, const u8
*addr
, const u8
*data
,
1865 size_t data_len
, int encrypt
,
1866 const u8
*own_addr
, u32 flags
);
1869 * sta_deauth - Deauthenticate a station (AP only)
1870 * @priv: Private driver interface data
1871 * @own_addr: Source address and BSSID for the Deauthentication frame
1872 * @addr: MAC address of the station to deauthenticate
1873 * @reason: Reason code for the Deauthentiation frame
1874 * Returns: 0 on success, -1 on failure
1876 * This function requests a specific station to be deauthenticated and
1877 * a Deauthentication frame to be sent to it.
1879 int (*sta_deauth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
1883 * sta_disassoc - Disassociate a station (AP only)
1884 * @priv: Private driver interface data
1885 * @own_addr: Source address and BSSID for the Disassociation frame
1886 * @addr: MAC address of the station to disassociate
1887 * @reason: Reason code for the Disassociation frame
1888 * Returns: 0 on success, -1 on failure
1890 * This function requests a specific station to be disassociated and
1891 * a Disassociation frame to be sent to it.
1893 int (*sta_disassoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
1897 * sta_remove - Remove a station entry (AP only)
1898 * @priv: Private driver interface data
1899 * @addr: MAC address of the station to be removed
1900 * Returns: 0 on success, -1 on failure
1902 int (*sta_remove
)(void *priv
, const u8
*addr
);
1905 * hapd_get_ssid - Get the current SSID (AP only)
1906 * @priv: Private driver interface data
1907 * @buf: Buffer for returning the SSID
1908 * @len: Maximum length of the buffer
1909 * Returns: Length of the SSID on success, -1 on failure
1911 * This function need not be implemented if the driver uses Beacon
1912 * template from set_ap() and does not reply to Probe Request frames.
1914 int (*hapd_get_ssid
)(void *priv
, u8
*buf
, int len
);
1917 * hapd_set_ssid - Set SSID (AP only)
1918 * @priv: Private driver interface data
1920 * @len: Length of the SSID in octets
1921 * Returns: 0 on success, -1 on failure
1923 * DEPRECATED - use set_ap() instead
1925 int (*hapd_set_ssid
)(void *priv
, const u8
*buf
, int len
);
1928 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1929 * @priv: Private driver interface data
1930 * @enabled: 1 = countermeasures enabled, 0 = disabled
1931 * Returns: 0 on success, -1 on failure
1933 * This need not be implemented if the driver does not take care of
1934 * association processing.
1936 int (*hapd_set_countermeasures
)(void *priv
, int enabled
);
1939 * sta_add - Add a station entry
1940 * @priv: Private driver interface data
1941 * @params: Station parameters
1942 * Returns: 0 on success, -1 on failure
1944 * This function is used to add a station entry to the driver once the
1945 * station has completed association. This is only used if the driver
1946 * does not take care of association processing.
1948 * With TDLS, this function is also used to add or set (params->set 1)
1949 * TDLS peer entries.
1951 int (*sta_add
)(void *priv
, struct hostapd_sta_add_params
*params
);
1954 * get_inact_sec - Get station inactivity duration (AP only)
1955 * @priv: Private driver interface data
1956 * @addr: Station address
1957 * Returns: Number of seconds station has been inactive, -1 on failure
1959 int (*get_inact_sec
)(void *priv
, const u8
*addr
);
1962 * sta_clear_stats - Clear station statistics (AP only)
1963 * @priv: Private driver interface data
1964 * @addr: Station address
1965 * Returns: 0 on success, -1 on failure
1967 int (*sta_clear_stats
)(void *priv
, const u8
*addr
);
1970 * set_freq - Set channel/frequency (AP only)
1971 * @priv: Private driver interface data
1972 * @freq: Channel parameters
1973 * Returns: 0 on success, -1 on failure
1975 int (*set_freq
)(void *priv
, struct hostapd_freq_params
*freq
);
1978 * set_rts - Set RTS threshold
1979 * @priv: Private driver interface data
1980 * @rts: RTS threshold in octets
1981 * Returns: 0 on success, -1 on failure
1983 int (*set_rts
)(void *priv
, int rts
);
1986 * set_frag - Set fragmentation threshold
1987 * @priv: Private driver interface data
1988 * @frag: Fragmentation threshold in octets
1989 * Returns: 0 on success, -1 on failure
1991 int (*set_frag
)(void *priv
, int frag
);
1994 * sta_set_flags - Set station flags (AP only)
1995 * @priv: Private driver interface data
1996 * @addr: Station address
1997 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1998 * @flags_or: Bitmap of WPA_STA_* flags to add
1999 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2000 * Returns: 0 on success, -1 on failure
2002 int (*sta_set_flags
)(void *priv
, const u8
*addr
,
2003 int total_flags
, int flags_or
, int flags_and
);
2006 * set_tx_queue_params - Set TX queue parameters
2007 * @priv: Private driver interface data
2008 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2012 * @burst_time: Maximum length for bursting in 0.1 msec units
2014 int (*set_tx_queue_params
)(void *priv
, int queue
, int aifs
, int cw_min
,
2015 int cw_max
, int burst_time
);
2018 * if_add - Add a virtual interface
2019 * @priv: Private driver interface data
2020 * @type: Interface type
2021 * @ifname: Interface name for the new virtual interface
2022 * @addr: Local address to use for the interface or %NULL to use the
2023 * parent interface address
2024 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2025 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2026 * not allowed (applies only to %WPA_IF_AP_BSS type)
2027 * @force_ifname: Buffer for returning an interface name that the
2028 * driver ended up using if it differs from the requested ifname
2029 * @if_addr: Buffer for returning the allocated interface address
2030 * (this may differ from the requested addr if the driver cannot
2031 * change interface address)
2032 * @bridge: Bridge interface to use or %NULL if no bridge configured
2033 * @use_existing: Whether to allow existing interface to be used
2034 * Returns: 0 on success, -1 on failure
2036 int (*if_add
)(void *priv
, enum wpa_driver_if_type type
,
2037 const char *ifname
, const u8
*addr
, void *bss_ctx
,
2038 void **drv_priv
, char *force_ifname
, u8
*if_addr
,
2039 const char *bridge
, int use_existing
);
2042 * if_remove - Remove a virtual interface
2043 * @priv: Private driver interface data
2044 * @type: Interface type
2045 * @ifname: Interface name of the virtual interface to be removed
2046 * Returns: 0 on success, -1 on failure
2048 int (*if_remove
)(void *priv
, enum wpa_driver_if_type type
,
2049 const char *ifname
);
2052 * set_sta_vlan - Bind a station into a specific interface (AP only)
2053 * @priv: Private driver interface data
2054 * @ifname: Interface (main or virtual BSS or VLAN)
2055 * @addr: MAC address of the associated station
2057 * Returns: 0 on success, -1 on failure
2059 * This function is used to bind a station to a specific virtual
2060 * interface. It is only used if when virtual interfaces are supported,
2061 * e.g., to assign stations to different VLAN interfaces based on
2062 * information from a RADIUS server. This allows separate broadcast
2063 * domains to be used with a single BSS.
2065 int (*set_sta_vlan
)(void *priv
, const u8
*addr
, const char *ifname
,
2069 * commit - Optional commit changes handler (AP only)
2070 * @priv: driver private data
2071 * Returns: 0 on success, -1 on failure
2073 * This optional handler function can be registered if the driver
2074 * interface implementation needs to commit changes (e.g., by setting
2075 * network interface up) at the end of initial configuration. If set,
2076 * this handler will be called after initial setup has been completed.
2078 int (*commit
)(void *priv
);
2081 * send_ether - Send an ethernet packet (AP only)
2082 * @priv: private driver interface data
2083 * @dst: Destination MAC address
2084 * @src: Source MAC address
2086 * @data: EAPOL packet starting with IEEE 802.1X header
2087 * @data_len: Length of the EAPOL packet in octets
2088 * Returns: 0 on success, -1 on failure
2090 int (*send_ether
)(void *priv
, const u8
*dst
, const u8
*src
, u16 proto
,
2091 const u8
*data
, size_t data_len
);
2094 * set_radius_acl_auth - Notification of RADIUS ACL change
2095 * @priv: Private driver interface data
2096 * @mac: MAC address of the station
2097 * @accepted: Whether the station was accepted
2098 * @session_timeout: Session timeout for the station
2099 * Returns: 0 on success, -1 on failure
2101 int (*set_radius_acl_auth
)(void *priv
, const u8
*mac
, int accepted
,
2102 u32 session_timeout
);
2105 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2106 * @priv: Private driver interface data
2107 * @mac: MAC address of the station
2108 * Returns: 0 on success, -1 on failure
2110 int (*set_radius_acl_expire
)(void *priv
, const u8
*mac
);
2113 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2114 * @priv: Private driver interface data
2115 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2116 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2118 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2119 * to remove extra IE(s)
2120 * Returns: 0 on success, -1 on failure
2122 * This is an optional function to add WPS IE in the kernel driver for
2123 * Beacon and Probe Response frames. This can be left undefined (set
2124 * to %NULL) if the driver uses the Beacon template from set_ap()
2125 * and does not process Probe Request frames. If the driver takes care
2126 * of (Re)Association frame processing, the assocresp buffer includes
2127 * WPS IE(s) that need to be added to (Re)Association Response frames
2128 * whenever a (Re)Association Request frame indicated use of WPS.
2130 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2131 * frames when operating as a GO. The driver is responsible for adding
2132 * timing related attributes (e.g., NoA) in addition to the IEs
2133 * included here by appending them after these buffers. This call is
2134 * also used to provide Probe Response IEs for P2P Listen state
2135 * operations for drivers that generate the Probe Response frames
2138 * DEPRECATED - use set_ap() instead
2140 int (*set_ap_wps_ie
)(void *priv
, const struct wpabuf
*beacon
,
2141 const struct wpabuf
*proberesp
,
2142 const struct wpabuf
*assocresp
);
2145 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2146 * @priv: Private driver interface data
2147 * @authorized: Whether the port is authorized
2148 * Returns: 0 on success, -1 on failure
2150 int (*set_supp_port
)(void *priv
, int authorized
);
2153 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2154 * @priv: Private driver interface data
2155 * @addr: MAC address of the associated station
2156 * @aid: Association ID
2157 * @val: 1 = bind to 4-address WDS; 0 = unbind
2158 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2159 * to indicate that bridge is not to be used
2160 * @ifname_wds: Buffer to return the interface name for the new WDS
2161 * station or %NULL to indicate name is not returned.
2162 * Returns: 0 on success, -1 on failure
2164 int (*set_wds_sta
)(void *priv
, const u8
*addr
, int aid
, int val
,
2165 const char *bridge_ifname
, char *ifname_wds
);
2168 * send_action - Transmit an Action frame
2169 * @priv: Private driver interface data
2170 * @freq: Frequency (in MHz) of the channel
2171 * @wait: Time to wait off-channel for a response (in ms), or zero
2172 * @dst: Destination MAC address (Address 1)
2173 * @src: Source MAC address (Address 2)
2174 * @bssid: BSSID (Address 3)
2176 * @data_len: data length in octets
2177 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2178 * Returns: 0 on success, -1 on failure
2180 * This command can be used to request the driver to transmit an action
2181 * frame to the specified destination.
2183 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2184 * be transmitted on the given channel and the device will wait for a
2185 * response on that channel for the given wait time.
2187 * If the flag is not set, the wait time will be ignored. In this case,
2188 * if a remain-on-channel duration is in progress, the frame must be
2189 * transmitted on that channel; alternatively the frame may be sent on
2190 * the current operational channel (if in associated state in station
2191 * mode or while operating as an AP.)
2193 int (*send_action
)(void *priv
, unsigned int freq
, unsigned int wait
,
2194 const u8
*dst
, const u8
*src
, const u8
*bssid
,
2195 const u8
*data
, size_t data_len
, int no_cck
);
2198 * send_action_cancel_wait - Cancel action frame TX wait
2199 * @priv: Private driver interface data
2201 * This command cancels the wait time associated with sending an action
2202 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2203 * set in the driver flags.
2205 void (*send_action_cancel_wait
)(void *priv
);
2208 * remain_on_channel - Remain awake on a channel
2209 * @priv: Private driver interface data
2210 * @freq: Frequency (in MHz) of the channel
2211 * @duration: Duration in milliseconds
2212 * Returns: 0 on success, -1 on failure
2214 * This command is used to request the driver to remain awake on the
2215 * specified channel for the specified duration and report received
2216 * Action frames with EVENT_RX_MGMT events. Optionally, received
2217 * Probe Request frames may also be requested to be reported by calling
2218 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2220 * The driver may not be at the requested channel when this function
2221 * returns, i.e., the return code is only indicating whether the
2222 * request was accepted. The caller will need to wait until the
2223 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2224 * completed the channel change. This may take some time due to other
2225 * need for the radio and the caller should be prepared to timing out
2226 * its wait since there are no guarantees on when this request can be
2229 int (*remain_on_channel
)(void *priv
, unsigned int freq
,
2230 unsigned int duration
);
2233 * cancel_remain_on_channel - Cancel remain-on-channel operation
2234 * @priv: Private driver interface data
2236 * This command can be used to cancel a remain-on-channel operation
2237 * before its originally requested duration has passed. This could be
2238 * used, e.g., when remain_on_channel() is used to request extra time
2239 * to receive a response to an Action frame and the response is
2240 * received when there is still unneeded time remaining on the
2241 * remain-on-channel operation.
2243 int (*cancel_remain_on_channel
)(void *priv
);
2246 * probe_req_report - Request Probe Request frames to be indicated
2247 * @priv: Private driver interface data
2248 * @report: Whether to report received Probe Request frames
2249 * Returns: 0 on success, -1 on failure (or if not supported)
2251 * This command can be used to request the driver to indicate when
2252 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2253 * Since this operation may require extra resources, e.g., due to less
2254 * optimal hardware/firmware RX filtering, many drivers may disable
2255 * Probe Request reporting at least in station mode. This command is
2256 * used to notify the driver when the Probe Request frames need to be
2257 * reported, e.g., during remain-on-channel operations.
2259 int (*probe_req_report
)(void *priv
, int report
);
2262 * deinit_ap - Deinitialize AP mode
2263 * @priv: Private driver interface data
2264 * Returns: 0 on success, -1 on failure (or if not supported)
2266 * This optional function can be used to disable AP mode related
2267 * configuration. If the interface was not dynamically added,
2268 * change the driver mode to station mode to allow normal station
2269 * operations like scanning to be completed.
2271 int (*deinit_ap
)(void *priv
);
2274 * deinit_p2p_cli - Deinitialize P2P client mode
2275 * @priv: Private driver interface data
2276 * Returns: 0 on success, -1 on failure (or if not supported)
2278 * This optional function can be used to disable P2P client mode. If the
2279 * interface was not dynamically added, change the interface type back
2282 int (*deinit_p2p_cli
)(void *priv
);
2285 * suspend - Notification on system suspend/hibernate event
2286 * @priv: Private driver interface data
2288 void (*suspend
)(void *priv
);
2291 * resume - Notification on system resume/thaw event
2292 * @priv: Private driver interface data
2294 void (*resume
)(void *priv
);
2297 * signal_monitor - Set signal monitoring parameters
2298 * @priv: Private driver interface data
2299 * @threshold: Threshold value for signal change events; 0 = disabled
2300 * @hysteresis: Minimum change in signal strength before indicating a
2302 * Returns: 0 on success, -1 on failure (or if not supported)
2304 * This function can be used to configure monitoring of signal strength
2305 * with the current AP. Whenever signal strength drops below the
2306 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2307 * should be generated assuming the signal strength has changed at
2308 * least %hysteresis from the previously indicated signal change event.
2310 int (*signal_monitor
)(void *priv
, int threshold
, int hysteresis
);
2313 * send_frame - Send IEEE 802.11 frame (testing use only)
2314 * @priv: Private driver interface data
2315 * @data: IEEE 802.11 frame with IEEE 802.11 header
2316 * @data_len: Size of the frame
2317 * @encrypt: Whether to encrypt the frame (if keys are set)
2318 * Returns: 0 on success, -1 on failure
2320 * This function is only used for debugging purposes and is not
2321 * required to be implemented for normal operations.
2323 int (*send_frame
)(void *priv
, const u8
*data
, size_t data_len
,
2327 * shared_freq - Get operating frequency of shared interface(s)
2328 * @priv: Private driver interface data
2329 * Returns: Operating frequency in MHz, 0 if no shared operation in
2330 * use, or -1 on failure
2332 * This command can be used to request the current operating frequency
2333 * of any virtual interface that shares the same radio to provide
2334 * information for channel selection for other virtual interfaces.
2336 int (*shared_freq
)(void *priv
);
2339 * get_noa - Get current Notice of Absence attribute payload
2340 * @priv: Private driver interface data
2341 * @buf: Buffer for returning NoA
2342 * @buf_len: Buffer length in octets
2343 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2344 * advertized, or -1 on failure
2346 * This function is used to fetch the current Notice of Absence
2347 * attribute value from GO.
2349 int (*get_noa
)(void *priv
, u8
*buf
, size_t buf_len
);
2352 * set_noa - Set Notice of Absence parameters for GO (testing)
2353 * @priv: Private driver interface data
2355 * @start: Start time in ms from next TBTT
2356 * @duration: Duration in ms
2357 * Returns: 0 on success or -1 on failure
2359 * This function is used to set Notice of Absence parameters for GO. It
2360 * is used only for testing. To disable NoA, all parameters are set to
2363 int (*set_noa
)(void *priv
, u8 count
, int start
, int duration
);
2366 * set_p2p_powersave - Set P2P power save options
2367 * @priv: Private driver interface data
2368 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2369 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2370 * @ctwindow: 0.. = change (msec), -1 = no change
2371 * Returns: 0 on success or -1 on failure
2373 int (*set_p2p_powersave
)(void *priv
, int legacy_ps
, int opp_ps
,
2377 * ampdu - Enable/disable aggregation
2378 * @priv: Private driver interface data
2379 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2380 * Returns: 0 on success or -1 on failure
2382 int (*ampdu
)(void *priv
, int ampdu
);
2385 * get_radio_name - Get physical radio name for the device
2386 * @priv: Private driver interface data
2387 * Returns: Radio name or %NULL if not known
2389 * The returned data must not be modified by the caller. It is assumed
2390 * that any interface that has the same radio name as another is
2391 * sharing the same physical radio. This information can be used to
2392 * share scan results etc. information between the virtual interfaces
2393 * to speed up various operations.
2395 const char * (*get_radio_name
)(void *priv
);
2398 * send_tdls_mgmt - for sending TDLS management packets
2399 * @priv: private driver interface data
2400 * @dst: Destination (peer) MAC address
2401 * @action_code: TDLS action code for the mssage
2402 * @dialog_token: Dialog Token to use in the message (if needed)
2403 * @status_code: Status Code or Reason Code to use (if needed)
2404 * @buf: TDLS IEs to add to the message
2405 * @len: Length of buf in octets
2406 * Returns: 0 on success, negative (<0) on failure
2408 * This optional function can be used to send packet to driver which is
2409 * responsible for receiving and sending all TDLS packets.
2411 int (*send_tdls_mgmt
)(void *priv
, const u8
*dst
, u8 action_code
,
2412 u8 dialog_token
, u16 status_code
,
2413 const u8
*buf
, size_t len
);
2416 * tdls_oper - Ask the driver to perform high-level TDLS operations
2417 * @priv: Private driver interface data
2418 * @oper: TDLS high-level operation. See %enum tdls_oper
2419 * @peer: Destination (peer) MAC address
2420 * Returns: 0 on success, negative (<0) on failure
2422 * This optional function can be used to send high-level TDLS commands
2425 int (*tdls_oper
)(void *priv
, enum tdls_oper oper
, const u8
*peer
);
2428 * wnm_oper - Notify driver of the WNM frame reception
2429 * @priv: Private driver interface data
2430 * @oper: WNM operation. See %enum wnm_oper
2431 * @peer: Destination (peer) MAC address
2432 * @buf: Buffer for the driver to fill in (for getting IE)
2433 * @buf_len: Return the len of buf
2434 * Returns: 0 on success, negative (<0) on failure
2436 int (*wnm_oper
)(void *priv
, enum wnm_oper oper
, const u8
*peer
,
2437 u8
*buf
, u16
*buf_len
);
2440 * set_qos_map - Set QoS Map
2441 * @priv: Private driver interface data
2442 * @qos_map_set: QoS Map
2443 * @qos_map_set_len: Length of QoS Map
2445 int (*set_qos_map
)(void *priv
, const u8
*qos_map_set
,
2446 u8 qos_map_set_len
);
2449 * signal_poll - Get current connection information
2450 * @priv: Private driver interface data
2451 * @signal_info: Connection info structure
2453 int (*signal_poll
)(void *priv
, struct wpa_signal_info
*signal_info
);
2456 * set_authmode - Set authentication algorithm(s) for static WEP
2457 * @priv: Private driver interface data
2458 * @authmode: 1=Open System, 2=Shared Key, 3=both
2459 * Returns: 0 on success, -1 on failure
2461 * This function can be used to set authentication algorithms for AP
2462 * mode when static WEP is used. If the driver uses user space MLME/SME
2463 * implementation, there is no need to implement this function.
2465 * DEPRECATED - use set_ap() instead
2467 int (*set_authmode
)(void *priv
, int authmode
);
2471 * driver_cmd - Execute driver-specific command
2472 * @priv: Private driver interface data
2473 * @cmd: Command to execute
2474 * @buf: Return buffer
2475 * @buf_len: Buffer length
2476 * Returns: 0 on success, -1 on failure
2478 int (*driver_cmd
)(void *priv
, char *cmd
, char *buf
, size_t buf_len
);
2479 #endif /* ANDROID */
2482 * set_rekey_info - Set rekey information
2483 * @priv: Private driver interface data
2486 * @replay_ctr: Current EAPOL-Key Replay Counter
2488 * This optional function can be used to provide information for the
2489 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2490 * while the host (including wpa_supplicant) is sleeping.
2492 void (*set_rekey_info
)(void *priv
, const u8
*kek
, const u8
*kck
,
2493 const u8
*replay_ctr
);
2496 * sta_assoc - Station association indication
2497 * @priv: Private driver interface data
2498 * @own_addr: Source address and BSSID for association frame
2499 * @addr: MAC address of the station to associate
2500 * @reassoc: flag to indicate re-association
2501 * @status: association response status code
2502 * @ie: assoc response ie buffer
2503 * @len: ie buffer length
2504 * Returns: 0 on success, -1 on failure
2506 * This function indicates the driver to send (Re)Association
2507 * Response frame to the station.
2509 int (*sta_assoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2510 int reassoc
, u16 status
, const u8
*ie
, size_t len
);
2513 * sta_auth - Station authentication indication
2514 * @priv: Private driver interface data
2515 * @own_addr: Source address and BSSID for authentication frame
2516 * @addr: MAC address of the station to associate
2517 * @seq: authentication sequence number
2518 * @status: authentication response status code
2519 * @ie: authentication frame ie buffer
2520 * @len: ie buffer length
2522 * This function indicates the driver to send Authentication frame
2525 int (*sta_auth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2526 u16 seq
, u16 status
, const u8
*ie
, size_t len
);
2529 * add_tspec - Add traffic stream
2530 * @priv: Private driver interface data
2531 * @addr: MAC address of the station to associate
2532 * @tspec_ie: tspec ie buffer
2533 * @tspec_ielen: tspec ie length
2534 * Returns: 0 on success, -1 on failure
2536 * This function adds the traffic steam for the station
2537 * and fills the medium_time in tspec_ie.
2539 int (*add_tspec
)(void *priv
, const u8
*addr
, u8
*tspec_ie
,
2540 size_t tspec_ielen
);
2543 * add_sta_node - Add a station node in the driver
2544 * @priv: Private driver interface data
2545 * @addr: MAC address of the station to add
2546 * @auth_alg: authentication algorithm used by the station
2547 * Returns: 0 on success, -1 on failure
2549 * This function adds the station node in the driver, when
2550 * the station gets added by FT-over-DS.
2552 int (*add_sta_node
)(void *priv
, const u8
*addr
, u16 auth_alg
);
2555 * sched_scan - Request the driver to initiate scheduled scan
2556 * @priv: Private driver interface data
2557 * @params: Scan parameters
2558 * @interval: Interval between scan cycles in milliseconds
2559 * Returns: 0 on success, -1 on failure
2561 * This operation should be used for scheduled scan offload to
2562 * the hardware. Every time scan results are available, the
2563 * driver should report scan results event for wpa_supplicant
2564 * which will eventually request the results with
2565 * wpa_driver_get_scan_results2(). This operation is optional
2566 * and if not provided or if it returns -1, we fall back to
2567 * normal host-scheduled scans.
2569 int (*sched_scan
)(void *priv
, struct wpa_driver_scan_params
*params
,
2573 * stop_sched_scan - Request the driver to stop a scheduled scan
2574 * @priv: Private driver interface data
2575 * Returns: 0 on success, -1 on failure
2577 * This should cause the scheduled scan to be stopped and
2578 * results should stop being sent. Must be supported if
2579 * sched_scan is supported.
2581 int (*stop_sched_scan
)(void *priv
);
2584 * poll_client - Probe (null data or such) the given station
2585 * @priv: Private driver interface data
2586 * @own_addr: MAC address of sending interface
2587 * @addr: MAC address of the station to probe
2588 * @qos: Indicates whether station is QoS station
2590 * This function is used to verify whether an associated station is
2591 * still present. This function does not need to be implemented if the
2592 * driver provides such inactivity polling mechanism.
2594 void (*poll_client
)(void *priv
, const u8
*own_addr
,
2595 const u8
*addr
, int qos
);
2598 * radio_disable - Disable/enable radio
2599 * @priv: Private driver interface data
2600 * @disabled: 1=disable 0=enable radio
2601 * Returns: 0 on success, -1 on failure
2603 * This optional command is for testing purposes. It can be used to
2604 * disable the radio on a testbed device to simulate out-of-radio-range
2607 int (*radio_disable
)(void *priv
, int disabled
);
2610 * switch_channel - Announce channel switch and migrate the GO to the
2612 * @priv: Private driver interface data
2613 * @settings: Settings for CSA period and new channel
2614 * Returns: 0 on success, -1 on failure
2616 * This function is used to move the GO to the legacy STA channel to
2617 * avoid frequency conflict in single channel concurrency.
2619 int (*switch_channel
)(void *priv
, struct csa_settings
*settings
);
2622 * start_dfs_cac - Listen for radar interference on the channel
2623 * @priv: Private driver interface data
2624 * @freq: Channel parameters
2625 * Returns: 0 on success, -1 on failure
2627 int (*start_dfs_cac
)(void *priv
, struct hostapd_freq_params
*freq
);
2630 * stop_ap - Removes beacon from AP
2631 * @priv: Private driver interface data
2632 * Returns: 0 on success, -1 on failure (or if not supported)
2634 * This optional function can be used to disable AP mode related
2635 * configuration. Unlike deinit_ap, it does not change to station
2638 int (*stop_ap
)(void *priv
);
2641 * get_survey - Retrieve survey data
2642 * @priv: Private driver interface data
2643 * @freq: If set, survey data for the specified frequency is only
2644 * being requested. If not set, all survey data is requested.
2645 * Returns: 0 on success, -1 on failure
2647 * Use this to retrieve:
2649 * - the observed channel noise floor
2650 * - the amount of time we have spent on the channel
2651 * - the amount of time during which we have spent on the channel that
2652 * the radio has determined the medium is busy and we cannot
2654 * - the amount of time we have spent receiving data
2655 * - the amount of time we have spent transmitting data
2657 * This data can be used for spectrum heuristics. One example is
2658 * Automatic Channel Selection (ACS). The channel survey data is
2659 * kept on a linked list on the channel data, one entry is added
2660 * for each survey. The min_nf of the channel is updated for each
2663 int (*get_survey
)(void *priv
, unsigned int freq
);
2666 * status - Get driver interface status information
2667 * @priv: Private driver interface data
2668 * @buf: Buffer for printing tou the status information
2669 * @buflen: Maximum length of the buffer
2670 * Returns: Length of written status information or -1 on failure
2672 int (*status
)(void *priv
, char *buf
, size_t buflen
);
2677 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2679 enum wpa_event_type
{
2681 * EVENT_ASSOC - Association completed
2683 * This event needs to be delivered when the driver completes IEEE
2684 * 802.11 association or reassociation successfully.
2685 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2686 * after this event has been generated. In addition, optional
2687 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2688 * more information about the association. If the driver interface gets
2689 * both of these events at the same time, it can also include the
2690 * assoc_info data in EVENT_ASSOC call.
2695 * EVENT_DISASSOC - Association lost
2697 * This event should be called when association is lost either due to
2698 * receiving deauthenticate or disassociate frame from the AP or when
2699 * sending either of these frames to the current AP. If the driver
2700 * supports separate deauthentication event, EVENT_DISASSOC should only
2701 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2702 * In AP mode, union wpa_event_data::disassoc_info is required.
2707 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2709 * This event must be delivered when a Michael MIC error is detected by
2710 * the local driver. Additional data for event processing is
2711 * provided with union wpa_event_data::michael_mic_failure. This
2712 * information is used to request new encyption key and to initiate
2713 * TKIP countermeasures if needed.
2715 EVENT_MICHAEL_MIC_FAILURE
,
2718 * EVENT_SCAN_RESULTS - Scan results available
2720 * This event must be called whenever scan results are available to be
2721 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2722 * is expected to be used some time after struct wpa_driver_ops::scan()
2723 * is called. If the driver provides an unsolicited event when the scan
2724 * has been completed, this event can be used to trigger
2725 * EVENT_SCAN_RESULTS call. If such event is not available from the
2726 * driver, the driver wrapper code is expected to use a registered
2727 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2728 * scan is expected to be completed. Optional information about
2729 * completed scan can be provided with union wpa_event_data::scan_info.
2734 * EVENT_ASSOCINFO - Report optional extra information for association
2736 * This event can be used to report extra association information for
2737 * EVENT_ASSOC processing. This extra information includes IEs from
2738 * association frames and Beacon/Probe Response frames in union
2739 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2740 * EVENT_ASSOC. Alternatively, the driver interface can include
2741 * assoc_info data in the EVENT_ASSOC call if it has all the
2742 * information available at the same point.
2747 * EVENT_INTERFACE_STATUS - Report interface status changes
2749 * This optional event can be used to report changes in interface
2750 * status (interface added/removed) using union
2751 * wpa_event_data::interface_status. This can be used to trigger
2752 * wpa_supplicant to stop and re-start processing for the interface,
2753 * e.g., when a cardbus card is ejected/inserted.
2755 EVENT_INTERFACE_STATUS
,
2758 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2760 * This event can be used to inform wpa_supplicant about candidates for
2761 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2762 * for scan request (ap_scan=2 mode), this event is required for
2763 * pre-authentication. If wpa_supplicant is performing scan request
2764 * (ap_scan=1), this event is optional since scan results can be used
2765 * to add pre-authentication candidates. union
2766 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2767 * candidate and priority of the candidate, e.g., based on the signal
2768 * strength, in order to try to pre-authenticate first with candidates
2769 * that are most likely targets for re-association.
2771 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2772 * on the candidate list. In addition, it can be called for the current
2773 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2774 * will automatically skip pre-authentication in cases where a valid
2775 * PMKSA exists. When more than one candidate exists, this event should
2776 * be generated once for each candidate.
2778 * Driver will be notified about successful pre-authentication with
2779 * struct wpa_driver_ops::add_pmkid() calls.
2781 EVENT_PMKID_CANDIDATE
,
2784 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2786 * This event can be used to inform wpa_supplicant about desire to set
2787 * up secure direct link connection between two stations as defined in
2788 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2789 * STAKey negotiation. The caller will need to set peer address for the
2795 * EVENT_TDLS - Request TDLS operation
2797 * This event can be used to request a TDLS operation to be performed.
2802 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2804 * The driver is expected to report the received FT IEs from
2805 * FT authentication sequence from the AP. The FT IEs are included in
2806 * the extra information in union wpa_event_data::ft_ies.
2811 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2813 * The driver can use this event to inform wpa_supplicant about a STA
2814 * in an IBSS with which protected frames could be exchanged. This
2815 * event starts RSN authentication with the other STA to authenticate
2816 * the STA and set up encryption keys with it.
2818 EVENT_IBSS_RSN_START
,
2821 * EVENT_AUTH - Authentication result
2823 * This event should be called when authentication attempt has been
2824 * completed. This is only used if the driver supports separate
2825 * authentication step (struct wpa_driver_ops::authenticate).
2826 * Information about authentication result is included in
2827 * union wpa_event_data::auth.
2832 * EVENT_DEAUTH - Authentication lost
2834 * This event should be called when authentication is lost either due
2835 * to receiving deauthenticate frame from the AP or when sending that
2836 * frame to the current AP.
2837 * In AP mode, union wpa_event_data::deauth_info is required.
2842 * EVENT_ASSOC_REJECT - Association rejected
2844 * This event should be called when (re)association attempt has been
2845 * rejected by the AP. Information about the association response is
2846 * included in union wpa_event_data::assoc_reject.
2851 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2853 EVENT_AUTH_TIMED_OUT
,
2856 * EVENT_ASSOC_TIMED_OUT - Association timed out
2858 EVENT_ASSOC_TIMED_OUT
,
2861 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2866 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2868 EVENT_WPS_BUTTON_PUSHED
,
2871 * EVENT_TX_STATUS - Report TX status
2876 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2878 EVENT_RX_FROM_UNKNOWN
,
2881 * EVENT_RX_MGMT - Report RX of a management frame
2886 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2888 * This event is used to indicate when the driver has started the
2889 * requested remain-on-channel duration. Information about the
2890 * operation is included in union wpa_event_data::remain_on_channel.
2892 EVENT_REMAIN_ON_CHANNEL
,
2895 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2897 * This event is used to indicate when the driver has completed
2898 * remain-on-channel duration, i.e., may noot be available on the
2899 * requested channel anymore. Information about the
2900 * operation is included in union wpa_event_data::remain_on_channel.
2902 EVENT_CANCEL_REMAIN_ON_CHANNEL
,
2905 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2907 * This event is used only by driver_test.c and userspace MLME.
2912 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2914 * This event is used to indicate when a Probe Request frame has been
2915 * received. Information about the received frame is included in
2916 * union wpa_event_data::rx_probe_req. The driver is required to report
2917 * these events only after successfully completed probe_req_report()
2918 * commands to request the events (i.e., report parameter is non-zero)
2919 * in station mode. In AP mode, Probe Request frames should always be
2925 * EVENT_NEW_STA - New wired device noticed
2927 * This event is used to indicate that a new device has been detected
2928 * in a network that does not use association-like functionality (i.e.,
2929 * mainly wired Ethernet). This can be used to start EAPOL
2930 * authenticator when receiving a frame from a device. The address of
2931 * the device is included in union wpa_event_data::new_sta.
2936 * EVENT_EAPOL_RX - Report received EAPOL frame
2938 * When in AP mode with hostapd, this event is required to be used to
2939 * deliver the receive EAPOL frames from the driver. With
2940 * %wpa_supplicant, this event is used only if the send_eapol() handler
2941 * is used to override the use of l2_packet for EAPOL frame TX.
2946 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
2948 * This event is used to indicate changes in the signal strength
2949 * observed in frames received from the current AP if signal strength
2950 * monitoring has been enabled with signal_monitor().
2952 EVENT_SIGNAL_CHANGE
,
2955 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
2957 * This event is used to indicate that the interface was enabled after
2958 * having been previously disabled, e.g., due to rfkill.
2960 EVENT_INTERFACE_ENABLED
,
2963 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
2965 * This event is used to indicate that the interface was disabled,
2966 * e.g., due to rfkill.
2968 EVENT_INTERFACE_DISABLED
,
2971 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
2973 * This event is used to indicate that the channel list has changed,
2974 * e.g., because of a regulatory domain change triggered by scan
2975 * results including an AP advertising a country code.
2977 EVENT_CHANNEL_LIST_CHANGED
,
2980 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
2982 * This event is used to indicate that the driver cannot maintain this
2983 * interface in its operation mode anymore. The most likely use for
2984 * this is to indicate that AP mode operation is not available due to
2985 * operating channel would need to be changed to a DFS channel when
2986 * the driver does not support radar detection and another virtual
2987 * interfaces caused the operating channel to change. Other similar
2988 * resource conflicts could also trigger this for station mode
2991 EVENT_INTERFACE_UNAVAILABLE
,
2994 * EVENT_BEST_CHANNEL
2996 * Driver generates this event whenever it detects a better channel
2997 * (e.g., based on RSSI or channel use). This information can be used
2998 * to improve channel selection for a new AP/P2P group.
3003 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3005 * This event should be called when a Deauthentication frame is dropped
3006 * due to it not being protected (MFP/IEEE 802.11w).
3007 * union wpa_event_data::unprot_deauth is required to provide more
3008 * details of the frame.
3010 EVENT_UNPROT_DEAUTH
,
3013 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3015 * This event should be called when a Disassociation frame is dropped
3016 * due to it not being protected (MFP/IEEE 802.11w).
3017 * union wpa_event_data::unprot_disassoc is required to provide more
3018 * details of the frame.
3020 EVENT_UNPROT_DISASSOC
,
3023 * EVENT_STATION_LOW_ACK
3025 * Driver generates this event whenever it detected that a particular
3026 * station was lost. Detection can be through massive transmission
3027 * failures for example.
3029 EVENT_STATION_LOW_ACK
,
3032 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3034 EVENT_IBSS_PEER_LOST
,
3037 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3039 * This event carries the new replay counter to notify wpa_supplicant
3040 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3041 * completed Group Key Handshake while the host (including
3042 * wpa_supplicant was sleeping).
3044 EVENT_DRIVER_GTK_REKEY
,
3047 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3049 EVENT_SCHED_SCAN_STOPPED
,
3052 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3054 * This event indicates that the station responded to the poll
3055 * initiated with @poll_client.
3057 EVENT_DRIVER_CLIENT_POLL_OK
,
3060 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3062 EVENT_EAPOL_TX_STATUS
,
3065 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3067 * Described in wpa_event_data.ch_switch
3072 * EVENT_WNM - Request WNM operation
3074 * This event can be used to request a WNM operation to be performed.
3079 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3081 * This event indicates that the driver reported a connection failure
3082 * with the specified client (for example, max client reached, etc.) in
3085 EVENT_CONNECT_FAILED_REASON
,
3088 * EVENT_RADAR_DETECTED - Notify of radar detection
3090 * A radar has been detected on the supplied frequency, hostapd should
3091 * react accordingly (e.g., change channel).
3093 EVENT_DFS_RADAR_DETECTED
,
3096 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3098 * After a successful CAC, the channel can be marked clear and used.
3100 EVENT_DFS_CAC_FINISHED
,
3103 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3105 * The CAC was not successful, and the channel remains in the previous
3106 * state. This may happen due to a radar beeing detected or other
3107 * external influences.
3109 EVENT_DFS_CAC_ABORTED
,
3112 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3114 * The channel which was previously unavailable is now available again.
3116 EVENT_DFS_NOP_FINISHED
,
3119 * EVENT_SURVEY - Received survey data
3121 * This event gets triggered when a driver query is issued for survey
3122 * data and the requested data becomes available. The returned data is
3123 * stored in struct survey_results. The results provide at most one
3124 * survey entry for each frequency and at minimum will provide one
3125 * survey entry for one frequency. The survey data can be os_malloc()'d
3126 * and then os_free()'d, so the event callback must only copy data.
3131 * EVENT_SCAN_STARTED - Scan started
3133 * This indicates that driver has started a scan operation either based
3134 * on a request from wpa_supplicant/hostapd or from another application.
3135 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3136 * completed (either successfully or by getting cancelled).
3143 * struct freq_survey - Channel survey info
3145 * @ifidx: Interface index in which this survey was observed
3146 * @freq: Center of frequency of the surveyed channel
3147 * @nf: Channel noise floor in dBm
3148 * @channel_time: Amount of time in ms the radio spent on the channel
3149 * @channel_time_busy: Amount of time in ms the radio detected some signal
3150 * that indicated to the radio the channel was not clear
3151 * @channel_time_rx: Amount of time the radio spent receiving data
3152 * @channel_time_tx: Amount of time the radio spent transmitting data
3153 * @filled: bitmask indicating which fields have been reported, see
3154 * SURVEY_HAS_* defines.
3155 * @list: Internal list pointers
3157 struct freq_survey
{
3162 u64 channel_time_busy
;
3163 u64 channel_time_rx
;
3164 u64 channel_time_tx
;
3165 unsigned int filled
;
3166 struct dl_list list
;
3169 #define SURVEY_HAS_NF BIT(0)
3170 #define SURVEY_HAS_CHAN_TIME BIT(1)
3171 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3172 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3173 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3177 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3179 union wpa_event_data
{
3181 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3183 * This structure is optional for EVENT_ASSOC calls and required for
3184 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3185 * driver interface does not need to generate separate EVENT_ASSOCINFO
3190 * reassoc - Flag to indicate association or reassociation
3195 * req_ies - (Re)Association Request IEs
3197 * If the driver generates WPA/RSN IE, this event data must be
3198 * returned for WPA handshake to have needed information. If
3199 * wpa_supplicant-generated WPA/RSN IE is used, this
3200 * information event is optional.
3202 * This should start with the first IE (fixed fields before IEs
3203 * are not included).
3208 * req_ies_len - Length of req_ies in bytes
3213 * resp_ies - (Re)Association Response IEs
3215 * Optional association data from the driver. This data is not
3216 * required WPA, but may be useful for some protocols and as
3217 * such, should be reported if this is available to the driver
3220 * This should start with the first IE (fixed fields before IEs
3221 * are not included).
3226 * resp_ies_len - Length of resp_ies in bytes
3228 size_t resp_ies_len
;
3231 * beacon_ies - Beacon or Probe Response IEs
3233 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3234 * Probe Response frames from the current AP (i.e., the one
3235 * that the client just associated with). This information is
3236 * used to update WPA/RSN IE for the AP. If this field is not
3237 * set, the results from previous scan will be used. If no
3238 * data for the new AP is found, scan results will be requested
3239 * again (without scan request). At this point, the driver is
3240 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3243 * This should start with the first IE (fixed fields before IEs
3244 * are not included).
3246 const u8
*beacon_ies
;
3249 * beacon_ies_len - Length of beacon_ies */
3250 size_t beacon_ies_len
;
3253 * freq - Frequency of the operational channel in MHz
3258 * addr - Station address (for AP mode)
3264 * struct disassoc_info - Data for EVENT_DISASSOC events
3266 struct disassoc_info
{
3268 * addr - Station address (for AP mode)
3273 * reason_code - Reason Code (host byte order) used in
3274 * Deauthentication frame
3279 * ie - Optional IE(s) in Disassociation frame
3284 * ie_len - Length of ie buffer in octets
3289 * locally_generated - Whether the frame was locally generated
3291 int locally_generated
;
3295 * struct deauth_info - Data for EVENT_DEAUTH events
3297 struct deauth_info
{
3299 * addr - Station address (for AP mode)
3304 * reason_code - Reason Code (host byte order) used in
3305 * Deauthentication frame
3310 * ie - Optional IE(s) in Deauthentication frame
3315 * ie_len - Length of ie buffer in octets
3320 * locally_generated - Whether the frame was locally generated
3322 int locally_generated
;
3326 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3328 struct michael_mic_failure
{
3331 } michael_mic_failure
;
3334 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3336 struct interface_status
{
3339 EVENT_INTERFACE_ADDED
, EVENT_INTERFACE_REMOVED
3344 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3346 struct pmkid_candidate
{
3347 /** BSSID of the PMKID candidate */
3349 /** Smaller the index, higher the priority */
3351 /** Whether RSN IE includes pre-authenticate flag */
3356 * struct stkstart - Data for EVENT_STKSTART
3363 * struct tdls - Data for EVENT_TDLS
3369 TDLS_REQUEST_TEARDOWN
3371 u16 reason_code
; /* for teardown */
3375 * struct wnm - Data for EVENT_WNM
3393 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3395 * During FT (IEEE 802.11r) authentication sequence, the driver is
3396 * expected to use this event to report received FT IEs (MDIE, FTIE,
3397 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3398 * IEs for the next message will be delivered through the
3399 * struct wpa_driver_ops::update_ft_ies() callback.
3405 u8 target_ap
[ETH_ALEN
];
3406 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3408 /** Length of ric_ies buffer in octets */
3413 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3415 struct ibss_rsn_start
{
3420 * struct auth_info - Data for EVENT_AUTH events
3426 u16 auth_transaction
;
3433 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3435 struct assoc_reject
{
3437 * bssid - BSSID of the AP that rejected association
3442 * resp_ies - (Re)Association Response IEs
3444 * Optional association data from the driver. This data is not
3445 * required WPA, but may be useful for some protocols and as
3446 * such, should be reported if this is available to the driver
3449 * This should start with the first IE (fixed fields before IEs
3450 * are not included).
3455 * resp_ies_len - Length of resp_ies in bytes
3457 size_t resp_ies_len
;
3460 * status_code - Status Code from (Re)association Response
3465 struct timeout_event
{
3470 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3479 * struct tx_status - Data for EVENT_TX_STATUS events
3491 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3493 struct rx_from_unknown
{
3500 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3508 * freq - Frequency (in MHz) on which the frame was received
3513 * ssi_signal - Signal strength in dBm (or 0 if not available)
3519 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3521 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3523 struct remain_on_channel
{
3525 * freq - Channel frequency in MHz
3530 * duration - Duration to remain on the channel in milliseconds
3532 unsigned int duration
;
3533 } remain_on_channel
;
3536 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3537 * @aborted: Whether the scan was aborted
3538 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3539 * @num_freqs: Number of entries in freqs array
3540 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3542 * @num_ssids: Number of entries in ssids array
3548 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
3553 * struct mlme_rx - Data for EVENT_MLME_RX events
3564 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3566 struct rx_probe_req
{
3568 * sa - Source address of the received Probe Request frame
3573 * da - Destination address of the received Probe Request frame
3574 * or %NULL if not available
3579 * bssid - BSSID of the received Probe Request frame or %NULL
3585 * ie - IEs from the Probe Request body
3590 * ie_len - Length of ie buffer in octets
3595 * signal - signal strength in dBm (or 0 if not available)
3601 * struct new_sta - Data for EVENT_NEW_STA events
3608 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3617 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3619 struct wpa_signal_info signal_change
;
3622 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3623 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3624 * @freq_5: Best 5 GHz band channel frequency in MHz
3625 * @freq_overall: Best channel frequency in MHz
3627 * 0 can be used to indicate no preference in either band.
3629 struct best_channel
{
3635 struct unprot_deauth
{
3641 struct unprot_disassoc
{
3648 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3649 * @addr: station address
3656 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3658 struct ibss_peer_lost
{
3663 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3665 struct driver_gtk_rekey
{
3667 const u8
*replay_ctr
;
3671 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
3672 * @addr: station address
3674 struct client_poll
{
3679 * struct eapol_tx_status
3680 * @dst: Original destination
3681 * @data: Data starting with IEEE 802.1X header (!)
3682 * @data_len: Length of data
3683 * @ack: Indicates ack or lost frame
3685 * This corresponds to hapd_send_eapol if the frame sent
3686 * there isn't just reported as EVENT_TX_STATUS.
3688 struct eapol_tx_status
{
3697 * @freq: Frequency of new channel in MHz
3698 * @ht_enabled: Whether this is an HT channel
3699 * @ch_offset: Secondary channel offset
3700 * @ch_width: Channel width
3701 * @cf1: Center frequency 1
3702 * @cf2: Center frequency 2
3708 enum chan_width ch_width
;
3714 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
3715 * @addr: Remote client address
3716 * @code: Reason code for connection failure
3718 struct connect_failed_reason
{
3724 } connect_failed_reason
;
3727 * struct dfs_event - Data for radar detected events
3728 * @freq: Frequency of the channel in MHz
3734 enum chan_width chan_width
;
3740 * survey_results - Survey result data for EVENT_SURVEY
3741 * @freq_filter: Requested frequency survey filter, 0 if request
3742 * was for all survey data
3743 * @survey_list: Linked list of survey data
3745 struct survey_results
{
3746 unsigned int freq_filter
;
3747 struct dl_list survey_list
; /* struct freq_survey */
3751 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
3752 * @initiator: Initiator of the regulatory change
3754 struct channel_list_changed
{
3755 enum reg_change_initiator initiator
;
3756 } channel_list_changed
;
3760 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3761 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3762 * with struct wpa_driver_ops::init()
3763 * @event: event type (defined above)
3764 * @data: possible extra data for the event
3766 * Driver wrapper code should call this function whenever an event is received
3769 void wpa_supplicant_event(void *ctx
, enum wpa_event_type event
,
3770 union wpa_event_data
*data
);
3774 * The following inline functions are provided for convenience to simplify
3775 * event indication for some of the common events.
3778 static inline void drv_event_assoc(void *ctx
, const u8
*addr
, const u8
*ie
,
3779 size_t ielen
, int reassoc
)
3781 union wpa_event_data event
;
3782 os_memset(&event
, 0, sizeof(event
));
3783 event
.assoc_info
.reassoc
= reassoc
;
3784 event
.assoc_info
.req_ies
= ie
;
3785 event
.assoc_info
.req_ies_len
= ielen
;
3786 event
.assoc_info
.addr
= addr
;
3787 wpa_supplicant_event(ctx
, EVENT_ASSOC
, &event
);
3790 static inline void drv_event_disassoc(void *ctx
, const u8
*addr
)
3792 union wpa_event_data event
;
3793 os_memset(&event
, 0, sizeof(event
));
3794 event
.disassoc_info
.addr
= addr
;
3795 wpa_supplicant_event(ctx
, EVENT_DISASSOC
, &event
);
3798 static inline void drv_event_eapol_rx(void *ctx
, const u8
*src
, const u8
*data
,
3801 union wpa_event_data event
;
3802 os_memset(&event
, 0, sizeof(event
));
3803 event
.eapol_rx
.src
= src
;
3804 event
.eapol_rx
.data
= data
;
3805 event
.eapol_rx
.data_len
= data_len
;
3806 wpa_supplicant_event(ctx
, EVENT_EAPOL_RX
, &event
);
3809 /* driver_common.c */
3810 void wpa_scan_results_free(struct wpa_scan_results
*res
);
3812 /* Convert wpa_event_type to a string for logging */
3813 const char * event_to_string(enum wpa_event_type event
);
3815 /* NULL terminated array of linked in driver wrappers */
3816 extern struct wpa_driver_ops
*wpa_drivers
[];
3818 #endif /* DRIVER_H */