2 * Driver interface definition
3 * Copyright (c) 2003-2010, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
14 * This file defines a driver interface used by both %wpa_supplicant and
15 * hostapd. The first part of the file defines data structures used in various
16 * driver operations. This is followed by the struct wpa_driver_ops that each
17 * driver wrapper will beed to define with callback functions for requesting
18 * driver operations. After this, there are definitions for driver event
19 * reporting with wpa_supplicant_event() and some convenience helper functions
20 * that can be used to report events.
26 #define WPA_SUPPLICANT_DRIVER_VERSION 4
28 #include "common/defs.h"
30 #define HOSTAPD_CHAN_DISABLED 0x00000001
31 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
32 #define HOSTAPD_CHAN_NO_IBSS 0x00000004
33 #define HOSTAPD_CHAN_RADAR 0x00000008
34 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
35 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
36 #define HOSTAPD_CHAN_HT40 0x00000040
39 * struct hostapd_channel_data - Channel information
41 struct hostapd_channel_data
{
43 * chan - Channel number (IEEE 802.11)
48 * freq - Frequency in MHz
53 * flag - Channel flags (HOSTAPD_CHAN_*)
58 * max_tx_power - maximum transmit power in dBm
64 * struct hostapd_hw_modes - Supported hardware mode information
66 struct hostapd_hw_modes
{
68 * mode - Hardware mode
70 enum hostapd_hw_mode mode
;
73 * num_channels - Number of entries in the channels array
78 * channels - Array of supported channels
80 struct hostapd_channel_data
*channels
;
83 * num_rates - Number of entries in the rates array
88 * rates - Array of supported rates in 100 kbps units
93 * ht_capab - HT (IEEE 802.11n) capabilities
98 * mcs_set - MCS (IEEE 802.11n) rate parameters
103 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
109 #define IEEE80211_MODE_INFRA 0
110 #define IEEE80211_MODE_IBSS 1
111 #define IEEE80211_MODE_AP 2
113 #define IEEE80211_CAP_ESS 0x0001
114 #define IEEE80211_CAP_IBSS 0x0002
115 #define IEEE80211_CAP_PRIVACY 0x0010
117 #define WPA_SCAN_QUAL_INVALID BIT(0)
118 #define WPA_SCAN_NOISE_INVALID BIT(1)
119 #define WPA_SCAN_LEVEL_INVALID BIT(2)
120 #define WPA_SCAN_LEVEL_DBM BIT(3)
121 #define WPA_SCAN_AUTHENTICATED BIT(4)
122 #define WPA_SCAN_ASSOCIATED BIT(5)
125 * struct wpa_scan_res - Scan result for an BSS/IBSS
126 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
128 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
129 * @beacon_int: beacon interval in TUs (host byte order)
130 * @caps: capability information field in host byte order
131 * @qual: signal quality
132 * @noise: noise level
133 * @level: signal level
135 * @age: Age of the information in milliseconds (i.e., how many milliseconds
136 * ago the last Beacon or Probe Response frame was received)
137 * @ie_len: length of the following IE field in octets
138 * @beacon_ie_len: length of the following Beacon IE field in octets
140 * This structure is used as a generic format for scan results from the
141 * driver. Each driver interface implementation is responsible for converting
142 * the driver or OS specific scan results into this format.
144 * If the driver does not support reporting all IEs, the IE data structure is
145 * constructed of the IEs that are available. This field will also need to
146 * include SSID in IE format. All drivers are encouraged to be extended to
147 * report all IEs to make it easier to support future additions.
149 struct wpa_scan_res
{
161 size_t beacon_ie_len
;
163 * Followed by ie_len octets of IEs from Probe Response frame (or if
164 * the driver does not indicate source of IEs, these may also be from
165 * Beacon frame). After the first set of IEs, another set of IEs may
166 * follow (with beacon_ie_len octets of data) if the driver provides
172 * struct wpa_scan_results - Scan results
173 * @res: Array of pointers to allocated variable length scan result entries
174 * @num: Number of entries in the scan result array
176 struct wpa_scan_results
{
177 struct wpa_scan_res
**res
;
182 * struct wpa_interface_info - Network interface information
183 * @next: Pointer to the next interface or NULL if this is the last one
184 * @ifname: Interface name that can be used with init() or init2()
185 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
187 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
188 * is not an allocated copy, i.e., get_interfaces() caller will not free
191 struct wpa_interface_info
{
192 struct wpa_interface_info
*next
;
195 const char *drv_name
;
198 #define WPAS_MAX_SCAN_SSIDS 10
201 * struct wpa_driver_scan_params - Scan parameters
202 * Data for struct wpa_driver_ops::scan2().
204 struct wpa_driver_scan_params
{
206 * ssids - SSIDs to scan for
208 struct wpa_driver_scan_ssid
{
210 * ssid - specific SSID to scan for (ProbeReq)
211 * %NULL or zero-length SSID is used to indicate active scan
212 * with wildcard SSID.
216 * ssid_len: Length of the SSID in octets
219 } ssids
[WPAS_MAX_SCAN_SSIDS
];
222 * num_ssids - Number of entries in ssids array
223 * Zero indicates a request for a passive scan.
228 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
233 * extra_ies_len - Length of extra_ies in octets
235 size_t extra_ies_len
;
238 * freqs - Array of frequencies to scan or %NULL for all frequencies
240 * The frequency is set in MHz. The array is zero-terminated.
245 * filter_ssids - Filter for reporting SSIDs
247 * This optional parameter can be used to request the driver wrapper to
248 * filter scan results to include only the specified SSIDs. %NULL
249 * indicates that no filtering is to be done. This can be used to
250 * reduce memory needs for scan results in environments that have large
251 * number of APs with different SSIDs.
253 * The driver wrapper is allowed to take this allocated buffer into its
254 * own use by setting the pointer to %NULL. In that case, the driver
255 * wrapper is responsible for freeing the buffer with os_free() once it
256 * is not needed anymore.
258 struct wpa_driver_scan_filter
{
264 * num_filter_ssids - Number of entries in filter_ssids array
266 size_t num_filter_ssids
;
269 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
271 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
272 * Mbps from the support rates element(s) in the Probe Request frames
273 * and not to transmit the frames at any of those rates.
279 * struct wpa_driver_auth_params - Authentication parameters
280 * Data for struct wpa_driver_ops::authenticate().
282 struct wpa_driver_auth_params
{
290 const u8
*wep_key
[4];
291 size_t wep_key_len
[4];
293 int local_state_change
;
296 * p2p - Whether this connection is a P2P group
303 WPS_MODE_NONE
/* no WPS provisioning being used */,
304 WPS_MODE_OPEN
/* WPS provisioning with AP that is in open mode */,
305 WPS_MODE_PRIVACY
/* WPS provisioning with AP that is using protection
310 * struct wpa_driver_associate_params - Association parameters
311 * Data for struct wpa_driver_ops::associate().
313 struct wpa_driver_associate_params
{
315 * bssid - BSSID of the selected AP
316 * This can be %NULL, if ap_scan=2 mode is used and the driver is
317 * responsible for selecting with which BSS to associate. */
321 * ssid - The selected SSID
326 * ssid_len - Length of the SSID (1..32)
331 * freq - Frequency of the channel the selected AP is using
332 * Frequency that the selected AP is using (in MHz as
333 * reported in the scan results)
338 * wpa_ie - WPA information element for (Re)Association Request
339 * WPA information element to be included in (Re)Association
340 * Request (including information element id and length). Use
341 * of this WPA IE is optional. If the driver generates the WPA
342 * IE, it can use pairwise_suite, group_suite, and
343 * key_mgmt_suite to select proper algorithms. In this case,
344 * the driver has to notify wpa_supplicant about the used WPA
345 * IE by generating an event that the interface code will
346 * convert into EVENT_ASSOCINFO data (see below).
348 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
349 * instead. The driver can determine which version is used by
350 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
353 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
358 * wpa_ie_len - length of the wpa_ie
363 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
365 unsigned int wpa_proto
;
368 * pairwise_suite - Selected pairwise cipher suite
370 * This is usually ignored if @wpa_ie is used.
372 enum wpa_cipher pairwise_suite
;
375 * group_suite - Selected group cipher suite
377 * This is usually ignored if @wpa_ie is used.
379 enum wpa_cipher group_suite
;
382 * key_mgmt_suite - Selected key management suite
384 * This is usually ignored if @wpa_ie is used.
386 enum wpa_key_mgmt key_mgmt_suite
;
389 * auth_alg - Allowed authentication algorithms
390 * Bit field of WPA_AUTH_ALG_*
395 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
400 * wep_key - WEP keys for static WEP configuration
402 const u8
*wep_key
[4];
405 * wep_key_len - WEP key length for static WEP configuration
407 size_t wep_key_len
[4];
410 * wep_tx_keyidx - WEP TX key index for static WEP configuration
415 * mgmt_frame_protection - IEEE 802.11w management frame protection
417 enum mfp_options mgmt_frame_protection
;
420 * ft_ies - IEEE 802.11r / FT information elements
421 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
422 * for fast transition, this parameter is set to include the IEs that
423 * are to be sent in the next FT Authentication Request message.
424 * update_ft_ies() handler is called to update the IEs for further
425 * FT messages in the sequence.
427 * The driver should use these IEs only if the target AP is advertising
428 * the same mobility domain as the one included in the MDIE here.
430 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
431 * AP after the initial association. These IEs can only be used if the
432 * target AP is advertising support for FT and is using the same MDIE
433 * and SSID as the current AP.
435 * The driver is responsible for reporting the FT IEs received from the
436 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
437 * type. update_ft_ies() handler will then be called with the FT IEs to
438 * include in the next frame in the authentication sequence.
443 * ft_ies_len - Length of ft_ies in bytes
448 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
450 * This value is provided to allow the driver interface easier access
451 * to the current mobility domain. This value is set to %NULL if no
452 * mobility domain is currently active.
457 * passphrase - RSN passphrase for PSK
459 * This value is made available only for WPA/WPA2-Personal (PSK) and
460 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
461 * the 8..63 character ASCII passphrase, if available. Please note that
462 * this can be %NULL if passphrase was not used to generate the PSK. In
463 * that case, the psk field must be used to fetch the PSK.
465 const char *passphrase
;
468 * psk - RSN PSK (alternative for passphrase for PSK)
470 * This value is made available only for WPA/WPA2-Personal (PSK) and
471 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
472 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
473 * be prepared to handle %NULL value as an error.
478 * drop_unencrypted - Enable/disable unencrypted frame filtering
480 * Configure the driver to drop all non-EAPOL frames (both receive and
481 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
482 * still be allowed for key negotiation.
484 int drop_unencrypted
;
487 * prev_bssid - Previously used BSSID in this ESS
489 * When not %NULL, this is a request to use reassociation instead of
492 const u8
*prev_bssid
;
497 * If the driver needs to do special configuration for WPS association,
498 * this variable provides more information on what type of association
499 * is being requested. Most drivers should not need ot use this.
504 * p2p - Whether this connection is a P2P group
509 * uapsd - UAPSD parameters for the network
510 * -1 = do not change defaults
511 * AP mode: 1 = enabled, 0 = disabled
512 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
519 HIDDEN_SSID_ZERO_LEN
,
520 HIDDEN_SSID_ZERO_CONTENTS
523 struct wpa_driver_ap_params
{
525 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
530 * head_len - Length of the head buffer in octets
535 * tail - Beacon tail following TIM IE
540 * tail_len - Length of the tail buffer in octets
545 * dtim_period - DTIM period
550 * beacon_int - Beacon interval
555 * ssid - The SSID to use in Beacon/Probe Response frames
560 * ssid_len - Length of the SSID (1..32)
565 * hide_ssid - Whether to hide the SSID
567 enum hide_ssid hide_ssid
;
570 * pairwise_ciphers - WPA_CIPHER_* bitfield
572 unsigned int pairwise_ciphers
;
575 * group_cipher - WPA_CIPHER_*
577 unsigned int group_cipher
;
580 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
582 unsigned int key_mgmt_suites
;
585 * auth_algs - WPA_AUTH_ALG_* bitfield
587 unsigned int auth_algs
;
590 * wpa_version - WPA_PROTO_* bitfield
592 unsigned int wpa_version
;
595 * privacy - Whether privacy is used in the BSS
600 * beacon_ies - WPS/P2P IE(s) for Beacon frames
602 * This is used to add IEs like WPS IE and P2P IE by drivers that do not
603 * use the full Beacon template.
605 const struct wpabuf
*beacon_ies
;
608 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
610 * This is used to add IEs like WPS IE and P2P IE by drivers that
611 * reply to Probe Request frames internally.
613 const struct wpabuf
*proberesp_ies
;
616 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
618 const struct wpabuf
*assocresp_ies
;
622 * struct wpa_driver_capa - Driver capability information
624 struct wpa_driver_capa
{
625 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
626 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
627 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
628 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
629 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
630 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
631 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
632 unsigned int key_mgmt
;
634 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
635 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
636 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
637 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
640 #define WPA_DRIVER_AUTH_OPEN 0x00000001
641 #define WPA_DRIVER_AUTH_SHARED 0x00000002
642 #define WPA_DRIVER_AUTH_LEAP 0x00000004
645 /* Driver generated WPA/RSN IE */
646 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
647 /* Driver needs static WEP key setup after association command */
648 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
649 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
650 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
651 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
652 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
653 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
654 /* Driver provides separate commands for authentication and association (SME in
655 * wpa_supplicant). */
656 #define WPA_DRIVER_FLAGS_SME 0x00000020
657 /* Driver supports AP mode */
658 #define WPA_DRIVER_FLAGS_AP 0x00000040
659 /* Driver needs static WEP key setup after association has been completed */
660 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
661 /* Driver takes care of P2P management operations */
662 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
663 /* Driver supports concurrent P2P operations */
664 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
666 * Driver uses the initial interface as a dedicated management interface, i.e.,
667 * it cannot be used for P2P group operations or non-P2P purposes.
669 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
670 /* This interface is P2P capable (P2P Device, GO, or P2P Client */
671 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
672 /* Driver supports concurrent operations on multiple channels */
673 #define WPA_DRIVER_FLAGS_MULTI_CHANNEL_CONCURRENT 0x00001000
675 * Driver uses the initial interface for P2P management interface and non-P2P
676 * purposes (e.g., connect to infra AP), but this interface cannot be used for
677 * P2P group operations.
679 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
681 * Driver is known to use sane error codes, i.e., when it indicates that
682 * something (e.g., association) fails, there was indeed a failure and the
683 * operation does not end up getting completed successfully later.
685 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
686 /* Driver supports off-channel TX */
687 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
688 /* Driver indicates TX status events for EAPOL Data frames */
689 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
690 /* Driver indicates TX status events for Deauth/Disassoc frames */
691 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
692 /* Driver supports roaming (BSS selection) in firmware */
693 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
699 * max_remain_on_chan - Maximum remain-on-channel duration in msec
701 unsigned int max_remain_on_chan
;
704 * max_stations - Maximum number of associated stations the driver
705 * supports in AP mode
707 unsigned int max_stations
;
713 struct hostap_sta_driver_data
{
714 unsigned long rx_packets
, tx_packets
, rx_bytes
, tx_bytes
;
715 unsigned long current_tx_rate
;
716 unsigned long inactive_msec
;
718 unsigned long num_ps_buf_frames
;
719 unsigned long tx_retry_failed
;
720 unsigned long tx_retry_count
;
725 struct hostapd_sta_add_params
{
729 const u8
*supp_rates
;
730 size_t supp_rates_len
;
732 const struct ieee80211_ht_capabilities
*ht_capabilities
;
733 u32 flags
; /* bitmask of WPA_STA_* flags */
736 struct hostapd_freq_params
{
741 int sec_channel_offset
; /* 0 = HT40 disabled, -1 = HT40 enabled,
742 * secondary channel below primary, 1 = HT40
743 * enabled, secondary channel above primary */
746 enum wpa_driver_if_type
{
748 * WPA_IF_STATION - Station mode interface
753 * WPA_IF_AP_VLAN - AP mode VLAN interface
755 * This interface shares its address and Beacon frame with the main
761 * WPA_IF_AP_BSS - AP mode BSS interface
763 * This interface has its own address and Beacon frame.
768 * WPA_IF_P2P_GO - P2P Group Owner
773 * WPA_IF_P2P_CLIENT - P2P Client
778 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
779 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
784 struct wpa_init_params
{
789 const char *test_socket
;
790 int use_pae_group_addr
;
794 u8
*own_addr
; /* buffer for writing own MAC address */
798 struct wpa_bss_params
{
799 /** Interface name (for multi-SSID/VLAN support) */
801 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
810 enum mfp_options ieee80211w
;
813 #define WPA_STA_AUTHORIZED BIT(0)
814 #define WPA_STA_WMM BIT(1)
815 #define WPA_STA_SHORT_PREAMBLE BIT(2)
816 #define WPA_STA_MFP BIT(3)
819 * struct p2p_params - P2P parameters for driver-based P2P management
822 const char *dev_name
;
824 #define DRV_MAX_SEC_DEV_TYPES 5
825 u8 sec_dev_type
[DRV_MAX_SEC_DEV_TYPES
][8];
826 size_t num_sec_dev_types
;
840 * struct wpa_signal_info - Information about channel signal quality
842 struct wpa_signal_info
{
851 * struct wpa_driver_ops - Driver interface API definition
853 * This structure defines the API that each driver interface needs to implement
854 * for core wpa_supplicant code. All driver specific functionality is captured
857 struct wpa_driver_ops
{
858 /** Name of the driver interface */
860 /** One line description of the driver interface */
864 * get_bssid - Get the current BSSID
865 * @priv: private driver interface data
866 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
868 * Returns: 0 on success, -1 on failure
870 * Query kernel driver for the current BSSID and copy it to bssid.
871 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
874 int (*get_bssid
)(void *priv
, u8
*bssid
);
877 * get_ssid - Get the current SSID
878 * @priv: private driver interface data
879 * @ssid: buffer for SSID (at least 32 bytes)
881 * Returns: Length of the SSID on success, -1 on failure
883 * Query kernel driver for the current SSID and copy it to ssid.
884 * Returning zero is recommended if the STA is not associated.
886 * Note: SSID is an array of octets, i.e., it is not nul terminated and
887 * can, at least in theory, contain control characters (including nul)
888 * and as such, should be processed as binary data, not a printable
891 int (*get_ssid
)(void *priv
, u8
*ssid
);
894 * set_key - Configure encryption key
895 * @ifname: Interface name (for multi-SSID/VLAN support)
896 * @priv: private driver interface data
897 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
898 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
899 * %WPA_ALG_NONE clears the key.
900 * @addr: Address of the peer STA (BSSID of the current AP when setting
901 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
902 * broadcast keys, %NULL for default keys that are used both for
903 * broadcast and unicast; when clearing keys, %NULL is used to
904 * indicate that both the broadcast-only and default key of the
905 * specified key index is to be cleared
906 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
908 * @set_tx: configure this key as the default Tx key (only used when
909 * driver does not support separate unicast/individual key
910 * @seq: sequence number/packet number, seq_len octets, the next
911 * packet number to be used for in replay protection; configured
912 * for Rx keys (in most cases, this is only used with broadcast
913 * keys and set to zero for unicast keys); %NULL if not set
914 * @seq_len: length of the seq, depends on the algorithm:
915 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
916 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
918 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
919 * TKIP: 32, CCMP: 16, IGTK: 16)
921 * Returns: 0 on success, -1 on failure
923 * Configure the given key for the kernel driver. If the driver
924 * supports separate individual keys (4 default keys + 1 individual),
925 * addr can be used to determine whether the key is default or
926 * individual. If only 4 keys are supported, the default key with key
927 * index 0 is used as the individual key. STA must be configured to use
928 * it as the default Tx key (set_tx is set) and accept Rx for all the
929 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
930 * broadcast keys, so key index 0 is available for this kind of
933 * Please note that TKIP keys include separate TX and RX MIC keys and
934 * some drivers may expect them in different order than wpa_supplicant
935 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
936 * will trigger Michael MIC errors. This can be fixed by changing the
937 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
938 * in driver_*.c set_key() implementation, see driver_ndis.c for an
939 * example on how this can be done.
941 int (*set_key
)(const char *ifname
, void *priv
, enum wpa_alg alg
,
942 const u8
*addr
, int key_idx
, int set_tx
,
943 const u8
*seq
, size_t seq_len
,
944 const u8
*key
, size_t key_len
);
947 * init - Initialize driver interface
948 * @ctx: context to be used when calling wpa_supplicant functions,
949 * e.g., wpa_supplicant_event()
950 * @ifname: interface name, e.g., wlan0
952 * Returns: Pointer to private data, %NULL on failure
954 * Initialize driver interface, including event processing for kernel
955 * driver events (e.g., associated, scan results, Michael MIC failure).
956 * This function can allocate a private configuration data area for
957 * @ctx, file descriptor, interface name, etc. information that may be
958 * needed in future driver operations. If this is not used, non-NULL
959 * value will need to be returned because %NULL is used to indicate
960 * failure. The returned value will be used as 'void *priv' data for
961 * all other driver_ops functions.
963 * The main event loop (eloop.c) of wpa_supplicant can be used to
964 * register callback for read sockets (eloop_register_read_sock()).
966 * See below for more information about events and
967 * wpa_supplicant_event() function.
969 void * (*init
)(void *ctx
, const char *ifname
);
972 * deinit - Deinitialize driver interface
973 * @priv: private driver interface data from init()
975 * Shut down driver interface and processing of driver events. Free
976 * private data buffer if one was allocated in init() handler.
978 void (*deinit
)(void *priv
);
981 * set_param - Set driver configuration parameters
982 * @priv: private driver interface data from init()
983 * @param: driver specific configuration parameters
985 * Returns: 0 on success, -1 on failure
987 * Optional handler for notifying driver interface about configuration
988 * parameters (driver_param).
990 int (*set_param
)(void *priv
, const char *param
);
993 * set_countermeasures - Enable/disable TKIP countermeasures
994 * @priv: private driver interface data
995 * @enabled: 1 = countermeasures enabled, 0 = disabled
997 * Returns: 0 on success, -1 on failure
999 * Configure TKIP countermeasures. When these are enabled, the driver
1000 * should drop all received and queued frames that are using TKIP.
1002 int (*set_countermeasures
)(void *priv
, int enabled
);
1005 * deauthenticate - Request driver to deauthenticate
1006 * @priv: private driver interface data
1007 * @addr: peer address (BSSID of the AP)
1008 * @reason_code: 16-bit reason code to be sent in the deauthentication
1011 * Returns: 0 on success, -1 on failure
1013 int (*deauthenticate
)(void *priv
, const u8
*addr
, int reason_code
);
1016 * disassociate - Request driver to disassociate
1017 * @priv: private driver interface data
1018 * @addr: peer address (BSSID of the AP)
1019 * @reason_code: 16-bit reason code to be sent in the disassociation
1022 * Returns: 0 on success, -1 on failure
1024 int (*disassociate
)(void *priv
, const u8
*addr
, int reason_code
);
1027 * associate - Request driver to associate
1028 * @priv: private driver interface data
1029 * @params: association parameters
1031 * Returns: 0 on success, -1 on failure
1033 int (*associate
)(void *priv
,
1034 struct wpa_driver_associate_params
*params
);
1037 * add_pmkid - Add PMKSA cache entry to the driver
1038 * @priv: private driver interface data
1039 * @bssid: BSSID for the PMKSA cache entry
1040 * @pmkid: PMKID for the PMKSA cache entry
1042 * Returns: 0 on success, -1 on failure
1044 * This function is called when a new PMK is received, as a result of
1045 * either normal authentication or RSN pre-authentication.
1047 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1048 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1049 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1050 * driver_ops function does not need to be implemented. Likewise, if
1051 * the driver does not support WPA, this function is not needed.
1053 int (*add_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
1056 * remove_pmkid - Remove PMKSA cache entry to the driver
1057 * @priv: private driver interface data
1058 * @bssid: BSSID for the PMKSA cache entry
1059 * @pmkid: PMKID for the PMKSA cache entry
1061 * Returns: 0 on success, -1 on failure
1063 * This function is called when the supplicant drops a PMKSA cache
1064 * entry for any reason.
1066 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1067 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1068 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1069 * from wpa_supplicant, this driver_ops function does not need to be
1070 * implemented. Likewise, if the driver does not support WPA, this
1071 * function is not needed.
1073 int (*remove_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
1076 * flush_pmkid - Flush PMKSA cache
1077 * @priv: private driver interface data
1079 * Returns: 0 on success, -1 on failure
1081 * This function is called when the supplicant drops all PMKSA cache
1082 * entries for any reason.
1084 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1085 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1086 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1087 * from wpa_supplicant, this driver_ops function does not need to be
1088 * implemented. Likewise, if the driver does not support WPA, this
1089 * function is not needed.
1091 int (*flush_pmkid
)(void *priv
);
1094 * get_capa - Get driver capabilities
1095 * @priv: private driver interface data
1097 * Returns: 0 on success, -1 on failure
1099 * Get driver/firmware/hardware capabilities.
1101 int (*get_capa
)(void *priv
, struct wpa_driver_capa
*capa
);
1104 * poll - Poll driver for association information
1105 * @priv: private driver interface data
1107 * This is an option callback that can be used when the driver does not
1108 * provide event mechanism for association events. This is called when
1109 * receiving WPA EAPOL-Key messages that require association
1110 * information. The driver interface is supposed to generate associnfo
1111 * event before returning from this callback function. In addition, the
1112 * driver interface should generate an association event after having
1113 * sent out associnfo.
1115 void (*poll
)(void *priv
);
1118 * get_ifname - Get interface name
1119 * @priv: private driver interface data
1121 * Returns: Pointer to the interface name. This can differ from the
1122 * interface name used in init() call. Init() is called first.
1124 * This optional function can be used to allow the driver interface to
1125 * replace the interface name with something else, e.g., based on an
1126 * interface mapping from a more descriptive name.
1128 const char * (*get_ifname
)(void *priv
);
1131 * get_mac_addr - Get own MAC address
1132 * @priv: private driver interface data
1134 * Returns: Pointer to own MAC address or %NULL on failure
1136 * This optional function can be used to get the own MAC address of the
1137 * device from the driver interface code. This is only needed if the
1138 * l2_packet implementation for the OS does not provide easy access to
1140 const u8
* (*get_mac_addr
)(void *priv
);
1143 * send_eapol - Optional function for sending EAPOL packets
1144 * @priv: private driver interface data
1145 * @dest: Destination MAC address
1147 * @data: EAPOL packet starting with IEEE 802.1X header
1148 * @data_len: Size of the EAPOL packet
1150 * Returns: 0 on success, -1 on failure
1152 * This optional function can be used to override l2_packet operations
1153 * with driver specific functionality. If this function pointer is set,
1154 * l2_packet module is not used at all and the driver interface code is
1155 * responsible for receiving and sending all EAPOL packets. The
1156 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1157 * event. The driver interface is required to implement get_mac_addr()
1158 * handler if send_eapol() is used.
1160 int (*send_eapol
)(void *priv
, const u8
*dest
, u16 proto
,
1161 const u8
*data
, size_t data_len
);
1164 * set_operstate - Sets device operating state to DORMANT or UP
1165 * @priv: private driver interface data
1166 * @state: 0 = dormant, 1 = up
1167 * Returns: 0 on success, -1 on failure
1169 * This is an optional function that can be used on operating systems
1170 * that support a concept of controlling network device state from user
1171 * space applications. This function, if set, gets called with
1172 * state = 1 when authentication has been completed and with state = 0
1173 * when connection is lost.
1175 int (*set_operstate
)(void *priv
, int state
);
1178 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1179 * @priv: Private driver interface data
1180 * @addr: Address of the station for which to set protection (may be
1181 * %NULL for group keys)
1182 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1183 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1184 * Returns: 0 on success, -1 on failure
1186 * This is an optional function that can be used to set the driver to
1187 * require protection for Tx and/or Rx frames. This uses the layer
1188 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1189 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1190 * set protection operation; instead, they set protection implicitly
1191 * based on configured keys.
1193 int (*mlme_setprotection
)(void *priv
, const u8
*addr
, int protect_type
,
1197 * get_hw_feature_data - Get hardware support data (channels and rates)
1198 * @priv: Private driver interface data
1199 * @num_modes: Variable for returning the number of returned modes
1200 * flags: Variable for returning hardware feature flags
1201 * Returns: Pointer to allocated hardware data on success or %NULL on
1202 * failure. Caller is responsible for freeing this.
1204 * This function is only needed for drivers that export MLME
1205 * (management frame processing) to %wpa_supplicant or hostapd.
1207 struct hostapd_hw_modes
* (*get_hw_feature_data
)(void *priv
,
1212 * set_channel - Set channel
1213 * @priv: Private driver interface data
1214 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
1215 * @chan: IEEE 802.11 channel number
1216 * @freq: Frequency of the channel in MHz
1217 * Returns: 0 on success, -1 on failure
1219 * This function is only needed for drivers that export MLME
1220 * (management frame processing) to wpa_supplicant.
1222 int (*set_channel
)(void *priv
, enum hostapd_hw_mode phymode
, int chan
,
1226 * set_ssid - Set SSID
1227 * @priv: Private driver interface data
1229 * @ssid_len: SSID length
1230 * Returns: 0 on success, -1 on failure
1232 * This function is only needed for drivers that export MLME
1233 * (management frame processing) to wpa_supplicant.
1235 int (*set_ssid
)(void *priv
, const u8
*ssid
, size_t ssid_len
);
1238 * set_bssid - Set BSSID
1239 * @priv: Private driver interface data
1241 * Returns: 0 on success, -1 on failure
1243 * This function is only needed for drivers that export MLME
1244 * (management frame processing) to wpa_supplicant.
1246 int (*set_bssid
)(void *priv
, const u8
*bssid
);
1249 * send_mlme - Send management frame from MLME
1250 * @priv: Private driver interface data
1251 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1252 * @data_len: Size of the management frame
1253 * Returns: 0 on success, -1 on failure
1255 * This function is only needed for drivers that export MLME
1256 * (management frame processing) to wpa_supplicant.
1258 int (*send_mlme
)(void *priv
, const u8
*data
, size_t data_len
);
1261 * mlme_add_sta - Add a STA entry into the driver/netstack
1262 * @priv: Private driver interface data
1263 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1264 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
1265 * format (one octet per rate, 1 = 0.5 Mbps)
1266 * @supp_rates_len: Number of entries in supp_rates
1267 * Returns: 0 on success, -1 on failure
1269 * This function is only needed for drivers that export MLME
1270 * (management frame processing) to wpa_supplicant. When the MLME code
1271 * completes association with an AP, this function is called to
1272 * configure the driver/netstack with a STA entry for data frame
1273 * processing (TX rate control, encryption/decryption).
1275 int (*mlme_add_sta
)(void *priv
, const u8
*addr
, const u8
*supp_rates
,
1276 size_t supp_rates_len
);
1279 * mlme_remove_sta - Remove a STA entry from the driver/netstack
1280 * @priv: Private driver interface data
1281 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1282 * Returns: 0 on success, -1 on failure
1284 * This function is only needed for drivers that export MLME
1285 * (management frame processing) to wpa_supplicant.
1287 int (*mlme_remove_sta
)(void *priv
, const u8
*addr
);
1290 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1291 * @priv: Private driver interface data
1292 * @md: Mobility domain (2 octets) (also included inside ies)
1293 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1294 * @ies_len: Length of FT IEs in bytes
1295 * Returns: 0 on success, -1 on failure
1297 * The supplicant uses this callback to let the driver know that keying
1298 * material for FT is available and that the driver can use the
1299 * provided IEs in the next message in FT authentication sequence.
1301 * This function is only needed for driver that support IEEE 802.11r
1302 * (Fast BSS Transition).
1304 int (*update_ft_ies
)(void *priv
, const u8
*md
, const u8
*ies
,
1308 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1309 * @priv: Private driver interface data
1310 * @action: Action field value
1311 * @target_ap: Target AP address
1312 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1313 * @ies_len: Length of FT IEs in bytes
1314 * Returns: 0 on success, -1 on failure
1316 * The supplicant uses this callback to request the driver to transmit
1317 * an FT Action frame (action category 6) for over-the-DS fast BSS
1320 int (*send_ft_action
)(void *priv
, u8 action
, const u8
*target_ap
,
1321 const u8
*ies
, size_t ies_len
);
1324 * get_scan_results2 - Fetch the latest scan results
1325 * @priv: private driver interface data
1327 * Returns: Allocated buffer of scan results (caller is responsible for
1328 * freeing the data structure) on success, NULL on failure
1330 struct wpa_scan_results
* (*get_scan_results2
)(void *priv
);
1333 * set_country - Set country
1334 * @priv: Private driver interface data
1335 * @alpha2: country to which to switch to
1336 * Returns: 0 on success, -1 on failure
1338 * This function is for drivers which support some form
1339 * of setting a regulatory domain.
1341 int (*set_country
)(void *priv
, const char *alpha2
);
1344 * global_init - Global driver initialization
1345 * Returns: Pointer to private data (global), %NULL on failure
1347 * This optional function is called to initialize the driver wrapper
1348 * for global data, i.e., data that applies to all interfaces. If this
1349 * function is implemented, global_deinit() will also need to be
1350 * implemented to free the private data. The driver will also likely
1351 * use init2() function instead of init() to get the pointer to global
1352 * data available to per-interface initializer.
1354 void * (*global_init
)(void);
1357 * global_deinit - Global driver deinitialization
1358 * @priv: private driver global data from global_init()
1360 * Terminate any global driver related functionality and free the
1361 * global data structure.
1363 void (*global_deinit
)(void *priv
);
1366 * init2 - Initialize driver interface (with global data)
1367 * @ctx: context to be used when calling wpa_supplicant functions,
1368 * e.g., wpa_supplicant_event()
1369 * @ifname: interface name, e.g., wlan0
1370 * @global_priv: private driver global data from global_init()
1371 * Returns: Pointer to private data, %NULL on failure
1373 * This function can be used instead of init() if the driver wrapper
1376 void * (*init2
)(void *ctx
, const char *ifname
, void *global_priv
);
1379 * get_interfaces - Get information about available interfaces
1380 * @global_priv: private driver global data from global_init()
1381 * Returns: Allocated buffer of interface information (caller is
1382 * responsible for freeing the data structure) on success, NULL on
1385 struct wpa_interface_info
* (*get_interfaces
)(void *global_priv
);
1388 * scan2 - Request the driver to initiate scan
1389 * @priv: private driver interface data
1390 * @params: Scan parameters
1392 * Returns: 0 on success, -1 on failure
1394 * Once the scan results are ready, the driver should report scan
1395 * results event for wpa_supplicant which will eventually request the
1396 * results with wpa_driver_get_scan_results2().
1398 int (*scan2
)(void *priv
, struct wpa_driver_scan_params
*params
);
1401 * authenticate - Request driver to authenticate
1402 * @priv: private driver interface data
1403 * @params: authentication parameters
1404 * Returns: 0 on success, -1 on failure
1406 * This is an optional function that can be used with drivers that
1407 * support separate authentication and association steps, i.e., when
1408 * wpa_supplicant can act as the SME. If not implemented, associate()
1409 * function is expected to take care of IEEE 802.11 authentication,
1412 int (*authenticate
)(void *priv
,
1413 struct wpa_driver_auth_params
*params
);
1416 * set_ap - Set Beacon and Probe Response information for AP mode
1417 * @priv: Private driver interface data
1418 * @params: Parameters to use in AP mode
1420 * This function is used to configure Beacon template and/or extra IEs
1421 * to add for Beacon and Probe Response frames for the driver in
1422 * AP mode. The driver is responsible for building the full Beacon
1423 * frame by concatenating the head part with TIM IE generated by the
1424 * driver/firmware and finishing with the tail part. Depending on the
1425 * driver architectue, this can be done either by using the full
1426 * template or the set of additional IEs (e.g., WPS and P2P IE).
1427 * Similarly, Probe Response processing depends on the driver design.
1428 * If the driver (or firmware) takes care of replying to Probe Request
1429 * frames, the extra IEs provided here needs to be added to the Probe
1432 * Returns: 0 on success, -1 on failure
1434 int (*set_ap
)(void *priv
, struct wpa_driver_ap_params
*params
);
1437 * hapd_init - Initialize driver interface (hostapd only)
1438 * @hapd: Pointer to hostapd context
1439 * @params: Configuration for the driver wrapper
1440 * Returns: Pointer to private data, %NULL on failure
1442 * This function is used instead of init() or init2() when the driver
1443 * wrapper is used with hostapd.
1445 void * (*hapd_init
)(struct hostapd_data
*hapd
,
1446 struct wpa_init_params
*params
);
1449 * hapd_deinit - Deinitialize driver interface (hostapd only)
1450 * @priv: Private driver interface data from hapd_init()
1452 void (*hapd_deinit
)(void *priv
);
1455 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1456 * @priv: Private driver interface data
1457 * @params: BSS parameters
1458 * Returns: 0 on success, -1 on failure
1460 * This is an optional function to configure the kernel driver to
1461 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1462 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1463 * always enabled and the driver uses set_beacon() to set WPA/RSN IE
1464 * for Beacon frames.
1466 int (*set_ieee8021x
)(void *priv
, struct wpa_bss_params
*params
);
1469 * set_privacy - Enable/disable privacy (AP only)
1470 * @priv: Private driver interface data
1471 * @enabled: 1 = privacy enabled, 0 = disabled
1472 * Returns: 0 on success, -1 on failure
1474 * This is an optional function to configure privacy field in the
1475 * kernel driver for Beacon frames. This can be left undefined (set to
1476 * %NULL) if the driver uses the Beacon template from set_beacon().
1478 int (*set_privacy
)(void *priv
, int enabled
);
1481 * get_seqnum - Fetch the current TSC/packet number (AP only)
1482 * @ifname: The interface name (main or virtual)
1483 * @priv: Private driver interface data
1484 * @addr: MAC address of the station or %NULL for group keys
1486 * @seq: Buffer for returning the latest used TSC/packet number
1487 * Returns: 0 on success, -1 on failure
1489 * This function is used to fetch the last used TSC/packet number for
1490 * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so
1491 * there is no strict requirement on implementing support for unicast
1492 * keys (i.e., addr != %NULL).
1494 int (*get_seqnum
)(const char *ifname
, void *priv
, const u8
*addr
,
1498 * flush - Flush all association stations (AP only)
1499 * @priv: Private driver interface data
1500 * Returns: 0 on success, -1 on failure
1502 * This function requests the driver to disassociate all associated
1503 * stations. This function does not need to be implemented if the
1504 * driver does not process association frames internally.
1506 int (*flush
)(void *priv
);
1509 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1510 * @priv: Private driver interface data
1511 * @elem: Information elements
1512 * @elem_len: Length of the elem buffer in octets
1513 * Returns: 0 on success, -1 on failure
1515 * This is an optional function to add information elements in the
1516 * kernel driver for Beacon and Probe Response frames. This can be left
1517 * undefined (set to %NULL) if the driver uses the Beacon template from
1520 int (*set_generic_elem
)(void *priv
, const u8
*elem
, size_t elem_len
);
1523 * read_sta_data - Fetch station data (AP only)
1524 * @priv: Private driver interface data
1525 * @data: Buffer for returning station information
1526 * @addr: MAC address of the station
1527 * Returns: 0 on success, -1 on failure
1529 int (*read_sta_data
)(void *priv
, struct hostap_sta_driver_data
*data
,
1533 * hapd_send_eapol - Send an EAPOL packet (AP only)
1534 * @priv: private driver interface data
1535 * @addr: Destination MAC address
1536 * @data: EAPOL packet starting with IEEE 802.1X header
1537 * @data_len: Length of the EAPOL packet in octets
1538 * @encrypt: Whether the frame should be encrypted
1539 * @own_addr: Source MAC address
1540 * @flags: WPA_STA_* flags for the destination station
1542 * Returns: 0 on success, -1 on failure
1544 int (*hapd_send_eapol
)(void *priv
, const u8
*addr
, const u8
*data
,
1545 size_t data_len
, int encrypt
,
1546 const u8
*own_addr
, u32 flags
);
1549 * sta_deauth - Deauthenticate a station (AP only)
1550 * @priv: Private driver interface data
1551 * @own_addr: Source address and BSSID for the Deauthentication frame
1552 * @addr: MAC address of the station to deauthenticate
1553 * @reason: Reason code for the Deauthentiation frame
1554 * Returns: 0 on success, -1 on failure
1556 * This function requests a specific station to be deauthenticated and
1557 * a Deauthentication frame to be sent to it.
1559 int (*sta_deauth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
1563 * sta_disassoc - Disassociate a station (AP only)
1564 * @priv: Private driver interface data
1565 * @own_addr: Source address and BSSID for the Disassociation frame
1566 * @addr: MAC address of the station to disassociate
1567 * @reason: Reason code for the Disassociation frame
1568 * Returns: 0 on success, -1 on failure
1570 * This function requests a specific station to be disassociated and
1571 * a Disassociation frame to be sent to it.
1573 int (*sta_disassoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
1577 * sta_remove - Remove a station entry (AP only)
1578 * @priv: Private driver interface data
1579 * @addr: MAC address of the station to be removed
1580 * Returns: 0 on success, -1 on failure
1582 int (*sta_remove
)(void *priv
, const u8
*addr
);
1585 * hapd_get_ssid - Get the current SSID (AP only)
1586 * @priv: Private driver interface data
1587 * @buf: Buffer for returning the SSID
1588 * @len: Maximum length of the buffer
1589 * Returns: Length of the SSID on success, -1 on failure
1591 * This function need not be implemented if the driver uses Beacon
1592 * template from set_beacon() and does not reply to Probe Request
1595 int (*hapd_get_ssid
)(void *priv
, u8
*buf
, int len
);
1598 * hapd_set_ssid - Set SSID (AP only)
1599 * @priv: Private driver interface data
1601 * @len: Length of the SSID in octets
1602 * Returns: 0 on success, -1 on failure
1604 int (*hapd_set_ssid
)(void *priv
, const u8
*buf
, int len
);
1607 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1608 * @priv: Private driver interface data
1609 * @enabled: 1 = countermeasures enabled, 0 = disabled
1610 * Returns: 0 on success, -1 on failure
1612 * This need not be implemented if the driver does not take care of
1613 * association processing.
1615 int (*hapd_set_countermeasures
)(void *priv
, int enabled
);
1618 * sta_add - Add a station entry
1619 * @priv: Private driver interface data
1620 * @params: Station parameters
1621 * Returns: 0 on success, -1 on failure
1623 * This function is used to add a station entry to the driver once the
1624 * station has completed association. This is only used if the driver
1625 * does not take care of association processing.
1627 int (*sta_add
)(void *priv
, struct hostapd_sta_add_params
*params
);
1630 * get_inact_sec - Get station inactivity duration (AP only)
1631 * @priv: Private driver interface data
1632 * @addr: Station address
1633 * Returns: Number of seconds station has been inactive, -1 on failure
1635 int (*get_inact_sec
)(void *priv
, const u8
*addr
);
1638 * sta_clear_stats - Clear station statistics (AP only)
1639 * @priv: Private driver interface data
1640 * @addr: Station address
1641 * Returns: 0 on success, -1 on failure
1643 int (*sta_clear_stats
)(void *priv
, const u8
*addr
);
1646 * set_freq - Set channel/frequency (AP only)
1647 * @priv: Private driver interface data
1648 * @freq: Channel parameters
1649 * Returns: 0 on success, -1 on failure
1651 int (*set_freq
)(void *priv
, struct hostapd_freq_params
*freq
);
1654 * set_rts - Set RTS threshold
1655 * @priv: Private driver interface data
1656 * @rts: RTS threshold in octets
1657 * Returns: 0 on success, -1 on failure
1659 int (*set_rts
)(void *priv
, int rts
);
1662 * set_frag - Set fragmentation threshold
1663 * @priv: Private driver interface data
1664 * @frag: Fragmentation threshold in octets
1665 * Returns: 0 on success, -1 on failure
1667 int (*set_frag
)(void *priv
, int frag
);
1670 * sta_set_flags - Set station flags (AP only)
1671 * @priv: Private driver interface data
1672 * @addr: Station address
1673 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1674 * @flags_or: Bitmap of WPA_STA_* flags to add
1675 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1676 * Returns: 0 on success, -1 on failure
1678 int (*sta_set_flags
)(void *priv
, const u8
*addr
,
1679 int total_flags
, int flags_or
, int flags_and
);
1682 * set_rate_sets - Set supported and basic rate sets (AP only)
1683 * @priv: Private driver interface data
1684 * @supp_rates: -1 terminated array of supported rates in 100 kbps
1685 * @basic_rates: -1 terminated array of basic rates in 100 kbps
1686 * @mode: hardware mode (HOSTAPD_MODE_*)
1687 * Returns: 0 on success, -1 on failure
1689 int (*set_rate_sets
)(void *priv
, int *supp_rates
, int *basic_rates
,
1693 * set_cts_protect - Set CTS protection mode (AP only)
1694 * @priv: Private driver interface data
1695 * @value: Whether CTS protection is enabled
1696 * Returns: 0 on success, -1 on failure
1698 int (*set_cts_protect
)(void *priv
, int value
);
1701 * set_preamble - Set preamble mode (AP only)
1702 * @priv: Private driver interface data
1703 * @value: Whether short preamble is enabled
1704 * Returns: 0 on success, -1 on failure
1706 int (*set_preamble
)(void *priv
, int value
);
1709 * set_short_slot_time - Set short slot time (AP only)
1710 * @priv: Private driver interface data
1711 * @value: Whether short slot time is enabled
1712 * Returns: 0 on success, -1 on failure
1714 int (*set_short_slot_time
)(void *priv
, int value
);
1717 * set_tx_queue_params - Set TX queue parameters
1718 * @priv: Private driver interface data
1719 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
1723 * @burst_time: Maximum length for bursting in 0.1 msec units
1725 int (*set_tx_queue_params
)(void *priv
, int queue
, int aifs
, int cw_min
,
1726 int cw_max
, int burst_time
);
1729 * valid_bss_mask - Validate BSSID mask
1730 * @priv: Private driver interface data
1733 * Returns: 0 if mask is valid, -1 if mask is not valid, 1 if mask can
1734 * be used, but the main interface address must be the first address in
1735 * the block if mask is applied
1737 int (*valid_bss_mask
)(void *priv
, const u8
*addr
, const u8
*mask
);
1740 * if_add - Add a virtual interface
1741 * @priv: Private driver interface data
1742 * @type: Interface type
1743 * @ifname: Interface name for the new virtual interface
1744 * @addr: Local address to use for the interface or %NULL to use the
1745 * parent interface address
1746 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1747 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1748 * not allowed (applies only to %WPA_IF_AP_BSS type)
1749 * @force_ifname: Buffer for returning an interface name that the
1750 * driver ended up using if it differs from the requested ifname
1751 * @if_addr: Buffer for returning the allocated interface address
1752 * (this may differ from the requested addr if the driver cannot
1753 * change interface address)
1754 * @bridge: Bridge interface to use or %NULL if no bridge configured
1755 * Returns: 0 on success, -1 on failure
1757 int (*if_add
)(void *priv
, enum wpa_driver_if_type type
,
1758 const char *ifname
, const u8
*addr
, void *bss_ctx
,
1759 void **drv_priv
, char *force_ifname
, u8
*if_addr
,
1760 const char *bridge
);
1763 * if_remove - Remove a virtual interface
1764 * @priv: Private driver interface data
1765 * @type: Interface type
1766 * @ifname: Interface name of the virtual interface to be removed
1767 * Returns: 0 on success, -1 on failure
1769 int (*if_remove
)(void *priv
, enum wpa_driver_if_type type
,
1770 const char *ifname
);
1773 * set_sta_vlan - Bind a station into a specific interface (AP only)
1774 * @priv: Private driver interface data
1775 * @ifname: Interface (main or virtual BSS or VLAN)
1776 * @addr: MAC address of the associated station
1778 * Returns: 0 on success, -1 on failure
1780 * This function is used to bind a station to a specific virtual
1781 * interface. It is only used if when virtual interfaces are supported,
1782 * e.g., to assign stations to different VLAN interfaces based on
1783 * information from a RADIUS server. This allows separate broadcast
1784 * domains to be used with a single BSS.
1786 int (*set_sta_vlan
)(void *priv
, const u8
*addr
, const char *ifname
,
1790 * commit - Optional commit changes handler (AP only)
1791 * @priv: driver private data
1792 * Returns: 0 on success, -1 on failure
1794 * This optional handler function can be registered if the driver
1795 * interface implementation needs to commit changes (e.g., by setting
1796 * network interface up) at the end of initial configuration. If set,
1797 * this handler will be called after initial setup has been completed.
1799 int (*commit
)(void *priv
);
1802 * send_ether - Send an ethernet packet (AP only)
1803 * @priv: private driver interface data
1804 * @dst: Destination MAC address
1805 * @src: Source MAC address
1807 * @data: EAPOL packet starting with IEEE 802.1X header
1808 * @data_len: Length of the EAPOL packet in octets
1809 * Returns: 0 on success, -1 on failure
1811 int (*send_ether
)(void *priv
, const u8
*dst
, const u8
*src
, u16 proto
,
1812 const u8
*data
, size_t data_len
);
1815 * set_radius_acl_auth - Notification of RADIUS ACL change
1816 * @priv: Private driver interface data
1817 * @mac: MAC address of the station
1818 * @accepted: Whether the station was accepted
1819 * @session_timeout: Session timeout for the station
1820 * Returns: 0 on success, -1 on failure
1822 int (*set_radius_acl_auth
)(void *priv
, const u8
*mac
, int accepted
,
1823 u32 session_timeout
);
1826 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1827 * @priv: Private driver interface data
1828 * @mac: MAC address of the station
1829 * Returns: 0 on success, -1 on failure
1831 int (*set_radius_acl_expire
)(void *priv
, const u8
*mac
);
1834 * set_ht_params - Set HT parameters (AP only)
1835 * @priv: Private driver interface data
1836 * @ht_capab: HT Capabilities IE
1837 * @ht_capab_len: Length of ht_capab in octets
1838 * @ht_oper: HT Operation IE
1839 * @ht_oper_len: Length of ht_oper in octets
1840 * Returns: 0 on success, -1 on failure
1842 int (*set_ht_params
)(void *priv
,
1843 const u8
*ht_capab
, size_t ht_capab_len
,
1844 const u8
*ht_oper
, size_t ht_oper_len
);
1847 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
1848 * @priv: Private driver interface data
1849 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
1850 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
1852 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
1853 * to remove extra IE(s)
1854 * Returns: 0 on success, -1 on failure
1856 * This is an optional function to add WPS IE in the kernel driver for
1857 * Beacon and Probe Response frames. This can be left undefined (set
1858 * to %NULL) if the driver uses the Beacon template from set_beacon()
1859 * and does not process Probe Request frames. If the driver takes care
1860 * of (Re)Association frame processing, the assocresp buffer includes
1861 * WPS IE(s) that need to be added to (Re)Association Response frames
1862 * whenever a (Re)Association Request frame indicated use of WPS.
1864 * This will also be used to add P2P IE(s) into Beacon/Probe Response
1865 * frames when operating as a GO. The driver is responsible for adding
1866 * timing related attributes (e.g., NoA) in addition to the IEs
1867 * included here by appending them after these buffers. This call is
1868 * also used to provide Probe Response IEs for P2P Listen state
1869 * operations for drivers that generate the Probe Response frames
1872 int (*set_ap_wps_ie
)(void *priv
, const struct wpabuf
*beacon
,
1873 const struct wpabuf
*proberesp
,
1874 const struct wpabuf
*assocresp
);
1877 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1878 * @priv: Private driver interface data
1879 * @authorized: Whether the port is authorized
1880 * Returns: 0 on success, -1 on failure
1882 int (*set_supp_port
)(void *priv
, int authorized
);
1885 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1886 * @priv: Private driver interface data
1887 * @addr: MAC address of the associated station
1888 * @aid: Association ID
1889 * @val: 1 = bind to 4-address WDS; 0 = unbind
1890 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
1891 * to indicate that bridge is not to be used
1892 * Returns: 0 on success, -1 on failure
1894 int (*set_wds_sta
)(void *priv
, const u8
*addr
, int aid
, int val
,
1895 const char *bridge_ifname
);
1898 * send_action - Transmit an Action frame
1899 * @priv: Private driver interface data
1900 * @freq: Frequency (in MHz) of the channel
1901 * @wait: Time to wait off-channel for a response (in ms), or zero
1902 * @dst: Destination MAC address (Address 1)
1903 * @src: Source MAC address (Address 2)
1904 * @bssid: BSSID (Address 3)
1906 * @data_len: data length in octets
1907 * Returns: 0 on success, -1 on failure
1909 * This command can be used to request the driver to transmit an action
1910 * frame to the specified destination.
1912 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
1913 * be transmitted on the given channel and the device will wait for a
1914 * response on that channel for the given wait time.
1916 * If the flag is not set, the wait time will be ignored. In this case,
1917 * if a remain-on-channel duration is in progress, the frame must be
1918 * transmitted on that channel; alternatively the frame may be sent on
1919 * the current operational channel (if in associated state in station
1920 * mode or while operating as an AP.)
1922 int (*send_action
)(void *priv
, unsigned int freq
, unsigned int wait
,
1923 const u8
*dst
, const u8
*src
, const u8
*bssid
,
1924 const u8
*data
, size_t data_len
);
1927 * send_action_cancel_wait - Cancel action frame TX wait
1928 * @priv: Private driver interface data
1930 * This command cancels the wait time associated with sending an action
1931 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
1932 * set in the driver flags.
1934 void (*send_action_cancel_wait
)(void *priv
);
1937 * remain_on_channel - Remain awake on a channel
1938 * @priv: Private driver interface data
1939 * @freq: Frequency (in MHz) of the channel
1940 * @duration: Duration in milliseconds
1941 * Returns: 0 on success, -1 on failure
1943 * This command is used to request the driver to remain awake on the
1944 * specified channel for the specified duration and report received
1945 * Action frames with EVENT_RX_ACTION events. Optionally, received
1946 * Probe Request frames may also be requested to be reported by calling
1947 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
1949 * The driver may not be at the requested channel when this function
1950 * returns, i.e., the return code is only indicating whether the
1951 * request was accepted. The caller will need to wait until the
1952 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
1953 * completed the channel change. This may take some time due to other
1954 * need for the radio and the caller should be prepared to timing out
1955 * its wait since there are no guarantees on when this request can be
1958 int (*remain_on_channel
)(void *priv
, unsigned int freq
,
1959 unsigned int duration
);
1962 * cancel_remain_on_channel - Cancel remain-on-channel operation
1963 * @priv: Private driver interface data
1965 * This command can be used to cancel a remain-on-channel operation
1966 * before its originally requested duration has passed. This could be
1967 * used, e.g., when remain_on_channel() is used to request extra time
1968 * to receive a response to an Action frame and the response is
1969 * received when there is still unneeded time remaining on the
1970 * remain-on-channel operation.
1972 int (*cancel_remain_on_channel
)(void *priv
);
1975 * probe_req_report - Request Probe Request frames to be indicated
1976 * @priv: Private driver interface data
1977 * @report: Whether to report received Probe Request frames
1978 * Returns: 0 on success, -1 on failure (or if not supported)
1980 * This command can be used to request the driver to indicate when
1981 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
1982 * Since this operation may require extra resources, e.g., due to less
1983 * optimal hardware/firmware RX filtering, many drivers may disable
1984 * Probe Request reporting at least in station mode. This command is
1985 * used to notify the driver when the Probe Request frames need to be
1986 * reported, e.g., during remain-on-channel operations.
1988 int (*probe_req_report
)(void *priv
, int report
);
1991 * disable_11b_rates - Set whether IEEE 802.11b rates are used for TX
1992 * @priv: Private driver interface data
1993 * @disabled: Whether IEEE 802.11b rates are disabled
1994 * Returns: 0 on success, -1 on failure (or if not supported)
1996 * This command is used to disable IEEE 802.11b rates (1, 2, 5.5, and
1997 * 11 Mbps) as TX rates for data and management frames. This can be
1998 * used to optimize channel use when there is no need to support IEEE
1999 * 802.11b-only devices.
2001 int (*disable_11b_rates
)(void *priv
, int disabled
);
2004 * deinit_ap - Deinitialize AP mode
2005 * @priv: Private driver interface data
2006 * Returns: 0 on success, -1 on failure (or if not supported)
2008 * This optional function can be used to disable AP mode related
2009 * configuration and change the driver mode to station mode to allow
2010 * normal station operations like scanning to be completed.
2012 int (*deinit_ap
)(void *priv
);
2015 * suspend - Notification on system suspend/hibernate event
2016 * @priv: Private driver interface data
2018 void (*suspend
)(void *priv
);
2021 * resume - Notification on system resume/thaw event
2022 * @priv: Private driver interface data
2024 void (*resume
)(void *priv
);
2027 * signal_monitor - Set signal monitoring parameters
2028 * @priv: Private driver interface data
2029 * @threshold: Threshold value for signal change events; 0 = disabled
2030 * @hysteresis: Minimum change in signal strength before indicating a
2032 * Returns: 0 on success, -1 on failure (or if not supported)
2034 * This function can be used to configure monitoring of signal strength
2035 * with the current AP. Whenever signal strength drops below the
2036 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2037 * should be generated assuming the signal strength has changed at
2038 * least %hysteresis from the previously indicated signal change event.
2040 int (*signal_monitor
)(void *priv
, int threshold
, int hysteresis
);
2043 * send_frame - Send IEEE 802.11 frame (testing use only)
2044 * @priv: Private driver interface data
2045 * @data: IEEE 802.11 frame with IEEE 802.11 header
2046 * @data_len: Size of the frame
2047 * @encrypt: Whether to encrypt the frame (if keys are set)
2048 * Returns: 0 on success, -1 on failure
2050 * This function is only used for debugging purposes and is not
2051 * required to be implemented for normal operations.
2053 int (*send_frame
)(void *priv
, const u8
*data
, size_t data_len
,
2057 * shared_freq - Get operating frequency of shared interface(s)
2058 * @priv: Private driver interface data
2059 * Returns: Operating frequency in MHz, 0 if no shared operation in
2060 * use, or -1 on failure
2062 * This command can be used to request the current operating frequency
2063 * of any virtual interface that shares the same radio to provide
2064 * information for channel selection for other virtual interfaces.
2066 int (*shared_freq
)(void *priv
);
2069 * get_noa - Get current Notice of Absence attribute payload
2070 * @priv: Private driver interface data
2071 * @buf: Buffer for returning NoA
2072 * @buf_len: Buffer length in octets
2073 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2074 * advertized, or -1 on failure
2076 * This function is used to fetch the current Notice of Absence
2077 * attribute value from GO.
2079 int (*get_noa
)(void *priv
, u8
*buf
, size_t buf_len
);
2082 * set_noa - Set Notice of Absence parameters for GO (testing)
2083 * @priv: Private driver interface data
2085 * @start: Start time in ms from next TBTT
2086 * @duration: Duration in ms
2087 * Returns: 0 on success or -1 on failure
2089 * This function is used to set Notice of Absence parameters for GO. It
2090 * is used only for testing. To disable NoA, all parameters are set to
2093 int (*set_noa
)(void *priv
, u8 count
, int start
, int duration
);
2096 * set_p2p_powersave - Set P2P power save options
2097 * @priv: Private driver interface data
2098 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2099 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2100 * @ctwindow: 0.. = change (msec), -1 = no change
2101 * Returns: 0 on success or -1 on failure
2103 int (*set_p2p_powersave
)(void *priv
, int legacy_ps
, int opp_ps
,
2107 * ampdu - Enable/disable aggregation
2108 * @priv: Private driver interface data
2109 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2110 * Returns: 0 on success or -1 on failure
2112 int (*ampdu
)(void *priv
, int ampdu
);
2115 * set_intra_bss - Enables/Disables intra BSS bridging
2117 int (*set_intra_bss
)(void *priv
, int enabled
);
2120 * get_radio_name - Get physical radio name for the device
2121 * @priv: Private driver interface data
2122 * Returns: Radio name or %NULL if not known
2124 * The returned data must not be modified by the caller. It is assumed
2125 * that any interface that has the same radio name as another is
2126 * sharing the same physical radio. This information can be used to
2127 * share scan results etc. information between the virtual interfaces
2128 * to speed up various operations.
2130 const char * (*get_radio_name
)(void *priv
);
2133 * p2p_find - Start P2P Device Discovery
2134 * @priv: Private driver interface data
2135 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2136 * @type: Device Discovery type (enum p2p_discovery_type)
2137 * Returns: 0 on success, -1 on failure
2139 * This function is only used if the driver implements P2P management,
2140 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2141 * struct wpa_driver_capa.
2143 int (*p2p_find
)(void *priv
, unsigned int timeout
, int type
);
2146 * p2p_stop_find - Stop P2P Device Discovery
2147 * @priv: Private driver interface data
2148 * Returns: 0 on success, -1 on failure
2150 * This function is only used if the driver implements P2P management,
2151 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2152 * struct wpa_driver_capa.
2154 int (*p2p_stop_find
)(void *priv
);
2157 * p2p_listen - Start P2P Listen state for specified duration
2158 * @priv: Private driver interface data
2159 * @timeout: Listen state duration in milliseconds
2160 * Returns: 0 on success, -1 on failure
2162 * This function can be used to request the P2P module to keep the
2163 * device discoverable on the listen channel for an extended set of
2164 * time. At least in its current form, this is mainly used for testing
2165 * purposes and may not be of much use for normal P2P operations.
2167 * This function is only used if the driver implements P2P management,
2168 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2169 * struct wpa_driver_capa.
2171 int (*p2p_listen
)(void *priv
, unsigned int timeout
);
2174 * p2p_connect - Start P2P group formation (GO negotiation)
2175 * @priv: Private driver interface data
2176 * @peer_addr: MAC address of the peer P2P client
2177 * @wps_method: enum p2p_wps_method value indicating config method
2178 * @go_intent: Local GO intent value (1..15)
2179 * @own_interface_addr: Intended interface address to use with the
2181 * @force_freq: The only allowed channel frequency in MHz or 0
2182 * @persistent_group: Whether to create persistent group
2183 * Returns: 0 on success, -1 on failure
2185 * This function is only used if the driver implements P2P management,
2186 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2187 * struct wpa_driver_capa.
2189 int (*p2p_connect
)(void *priv
, const u8
*peer_addr
, int wps_method
,
2190 int go_intent
, const u8
*own_interface_addr
,
2191 unsigned int force_freq
, int persistent_group
);
2194 * wps_success_cb - Report successfully completed WPS provisioning
2195 * @priv: Private driver interface data
2196 * @peer_addr: Peer address
2197 * Returns: 0 on success, -1 on failure
2199 * This function is used to report successfully completed WPS
2200 * provisioning during group formation in both GO/Registrar and
2201 * client/Enrollee roles.
2203 * This function is only used if the driver implements P2P management,
2204 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2205 * struct wpa_driver_capa.
2207 int (*wps_success_cb
)(void *priv
, const u8
*peer_addr
);
2210 * p2p_group_formation_failed - Report failed WPS provisioning
2211 * @priv: Private driver interface data
2212 * Returns: 0 on success, -1 on failure
2214 * This function is used to report failed group formation. This can
2215 * happen either due to failed WPS provisioning or due to 15 second
2216 * timeout during the provisioning phase.
2218 * This function is only used if the driver implements P2P management,
2219 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2220 * struct wpa_driver_capa.
2222 int (*p2p_group_formation_failed
)(void *priv
);
2225 * p2p_set_params - Set P2P parameters
2226 * @priv: Private driver interface data
2227 * @params: P2P parameters
2228 * Returns: 0 on success, -1 on failure
2230 * This function is only used if the driver implements P2P management,
2231 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2232 * struct wpa_driver_capa.
2234 int (*p2p_set_params
)(void *priv
, const struct p2p_params
*params
);
2237 * p2p_prov_disc_req - Send Provision Discovery Request
2238 * @priv: Private driver interface data
2239 * @peer_addr: MAC address of the peer P2P client
2240 * @config_methods: WPS Config Methods value (only one bit set)
2241 * Returns: 0 on success, -1 on failure
2243 * This function can be used to request a discovered P2P peer to
2244 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2245 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2246 * Provision Discovery Request frame is transmitted once immediately
2247 * and if no response is received, the frame will be sent again
2248 * whenever the target device is discovered during device dsicovery
2249 * (start with a p2p_find() call). Response from the peer is indicated
2250 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
2252 * This function is only used if the driver implements P2P management,
2253 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2254 * struct wpa_driver_capa.
2256 int (*p2p_prov_disc_req
)(void *priv
, const u8
*peer_addr
,
2257 u16 config_methods
);
2260 * p2p_sd_request - Schedule a service discovery query
2261 * @priv: Private driver interface data
2262 * @dst: Destination peer or %NULL to apply for all peers
2263 * @tlvs: P2P Service Query TLV(s)
2264 * Returns: Reference to the query or 0 on failure
2266 * Response to the query is indicated with the
2267 * EVENT_P2P_SD_RESPONSE driver event.
2269 * This function is only used if the driver implements P2P management,
2270 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2271 * struct wpa_driver_capa.
2273 u64 (*p2p_sd_request
)(void *priv
, const u8
*dst
,
2274 const struct wpabuf
*tlvs
);
2277 * p2p_sd_cancel_request - Cancel a pending service discovery query
2278 * @priv: Private driver interface data
2279 * @req: Query reference from p2p_sd_request()
2280 * Returns: 0 on success, -1 on failure
2282 * This function is only used if the driver implements P2P management,
2283 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2284 * struct wpa_driver_capa.
2286 int (*p2p_sd_cancel_request
)(void *priv
, u64 req
);
2289 * p2p_sd_response - Send response to a service discovery query
2290 * @priv: Private driver interface data
2291 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2292 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2293 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2294 * @resp_tlvs: P2P Service Response TLV(s)
2295 * Returns: 0 on success, -1 on failure
2297 * This function is called as a response to the request indicated with
2298 * the EVENT_P2P_SD_REQUEST driver event.
2300 * This function is only used if the driver implements P2P management,
2301 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2302 * struct wpa_driver_capa.
2304 int (*p2p_sd_response
)(void *priv
, int freq
, const u8
*dst
,
2306 const struct wpabuf
*resp_tlvs
);
2309 * p2p_service_update - Indicate a change in local services
2310 * @priv: Private driver interface data
2311 * Returns: 0 on success, -1 on failure
2313 * This function needs to be called whenever there is a change in
2314 * availability of the local services. This will increment the
2315 * Service Update Indicator value which will be used in SD Request and
2318 * This function is only used if the driver implements P2P management,
2319 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2320 * struct wpa_driver_capa.
2322 int (*p2p_service_update
)(void *priv
);
2325 * p2p_reject - Reject peer device (explicitly block connections)
2326 * @priv: Private driver interface data
2327 * @addr: MAC address of the peer
2328 * Returns: 0 on success, -1 on failure
2330 int (*p2p_reject
)(void *priv
, const u8
*addr
);
2333 * p2p_invite - Invite a P2P Device into a group
2334 * @priv: Private driver interface data
2335 * @peer: Device Address of the peer P2P Device
2336 * @role: Local role in the group
2337 * @bssid: Group BSSID or %NULL if not known
2339 * @ssid_len: Length of ssid in octets
2340 * @go_dev_addr: Forced GO Device Address or %NULL if none
2341 * @persistent_group: Whether this is to reinvoke a persistent group
2342 * Returns: 0 on success, -1 on failure
2344 int (*p2p_invite
)(void *priv
, const u8
*peer
, int role
,
2345 const u8
*bssid
, const u8
*ssid
, size_t ssid_len
,
2346 const u8
*go_dev_addr
, int persistent_group
);
2349 * send_tdls_mgmt - for sending TDLS management packets
2350 * @priv: private driver interface data
2351 * @dst: Destination (peer) MAC address
2352 * @action_code: TDLS action code for the mssage
2353 * @dialog_token: Dialog Token to use in the message (if needed)
2354 * @status_code: Status Code or Reason Code to use (if needed)
2355 * @buf: TDLS IEs to add to the message
2356 * @len: Length of buf in octets
2357 * Returns: 0 on success, -1 on failure
2359 * This optional function can be used to send packet to driver which is
2360 * responsible for receiving and sending all TDLS packets.
2362 int (*send_tdls_mgmt
)(void *priv
, const u8
*dst
, u8 action_code
,
2363 u8 dialog_token
, u16 status_code
,
2364 const u8
*buf
, size_t len
);
2366 int (*tdls_oper
)(void *priv
, enum tdls_oper oper
, const u8
*peer
);
2369 * signal_poll - Get current connection information
2370 * @priv: Private driver interface data
2371 * @signal_info: Connection info structure
2373 int (*signal_poll
)(void *priv
, struct wpa_signal_info
*signal_info
);
2376 * set_authmode - Set authentication algorithm(s) for static WEP
2377 * @priv: Private driver interface data
2378 * @authmode: 1=Open System, 2=Shared Key, 3=both
2379 * Returns: 0 on success, -1 on failure
2381 * This function can be used to set authentication algorithms for AP
2382 * mode when static WEP is used. If the driver uses user space MLME/SME
2383 * implementation, there is no need to implement this function.
2385 int (*set_authmode
)(void *priv
, int authmode
);
2388 * set_rekey_info - Set rekey information
2389 * @priv: Private driver interface data
2392 * @replay_ctr: Current EAPOL-Key Replay Counter
2394 * This optional function can be used to provide information for the
2395 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2396 * while the host (including wpa_supplicant) is sleeping.
2398 void (*set_rekey_info
)(void *priv
, const u8
*kek
, const u8
*kck
,
2399 const u8
*replay_ctr
);
2404 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2406 enum wpa_event_type
{
2408 * EVENT_ASSOC - Association completed
2410 * This event needs to be delivered when the driver completes IEEE
2411 * 802.11 association or reassociation successfully.
2412 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2413 * after this event has been generated. In addition, optional
2414 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2415 * more information about the association. If the driver interface gets
2416 * both of these events at the same time, it can also include the
2417 * assoc_info data in EVENT_ASSOC call.
2422 * EVENT_DISASSOC - Association lost
2424 * This event should be called when association is lost either due to
2425 * receiving deauthenticate or disassociate frame from the AP or when
2426 * sending either of these frames to the current AP. If the driver
2427 * supports separate deauthentication event, EVENT_DISASSOC should only
2428 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2429 * In AP mode, union wpa_event_data::disassoc_info is required.
2434 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2436 * This event must be delivered when a Michael MIC error is detected by
2437 * the local driver. Additional data for event processing is
2438 * provided with union wpa_event_data::michael_mic_failure. This
2439 * information is used to request new encyption key and to initiate
2440 * TKIP countermeasures if needed.
2442 EVENT_MICHAEL_MIC_FAILURE
,
2445 * EVENT_SCAN_RESULTS - Scan results available
2447 * This event must be called whenever scan results are available to be
2448 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2449 * is expected to be used some time after struct wpa_driver_ops::scan()
2450 * is called. If the driver provides an unsolicited event when the scan
2451 * has been completed, this event can be used to trigger
2452 * EVENT_SCAN_RESULTS call. If such event is not available from the
2453 * driver, the driver wrapper code is expected to use a registered
2454 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2455 * scan is expected to be completed. Optional information about
2456 * completed scan can be provided with union wpa_event_data::scan_info.
2461 * EVENT_ASSOCINFO - Report optional extra information for association
2463 * This event can be used to report extra association information for
2464 * EVENT_ASSOC processing. This extra information includes IEs from
2465 * association frames and Beacon/Probe Response frames in union
2466 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2467 * EVENT_ASSOC. Alternatively, the driver interface can include
2468 * assoc_info data in the EVENT_ASSOC call if it has all the
2469 * information available at the same point.
2474 * EVENT_INTERFACE_STATUS - Report interface status changes
2476 * This optional event can be used to report changes in interface
2477 * status (interface added/removed) using union
2478 * wpa_event_data::interface_status. This can be used to trigger
2479 * wpa_supplicant to stop and re-start processing for the interface,
2480 * e.g., when a cardbus card is ejected/inserted.
2482 EVENT_INTERFACE_STATUS
,
2485 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2487 * This event can be used to inform wpa_supplicant about candidates for
2488 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2489 * for scan request (ap_scan=2 mode), this event is required for
2490 * pre-authentication. If wpa_supplicant is performing scan request
2491 * (ap_scan=1), this event is optional since scan results can be used
2492 * to add pre-authentication candidates. union
2493 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2494 * candidate and priority of the candidate, e.g., based on the signal
2495 * strength, in order to try to pre-authenticate first with candidates
2496 * that are most likely targets for re-association.
2498 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2499 * on the candidate list. In addition, it can be called for the current
2500 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2501 * will automatically skip pre-authentication in cases where a valid
2502 * PMKSA exists. When more than one candidate exists, this event should
2503 * be generated once for each candidate.
2505 * Driver will be notified about successful pre-authentication with
2506 * struct wpa_driver_ops::add_pmkid() calls.
2508 EVENT_PMKID_CANDIDATE
,
2511 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2513 * This event can be used to inform wpa_supplicant about desire to set
2514 * up secure direct link connection between two stations as defined in
2515 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2516 * STAKey negotiation. The caller will need to set peer address for the
2522 * EVENT_TDLS - Request TDLS operation
2524 * This event can be used to request a TDLS operation to be performed.
2529 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2531 * The driver is expected to report the received FT IEs from
2532 * FT authentication sequence from the AP. The FT IEs are included in
2533 * the extra information in union wpa_event_data::ft_ies.
2538 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2540 * The driver can use this event to inform wpa_supplicant about a STA
2541 * in an IBSS with which protected frames could be exchanged. This
2542 * event starts RSN authentication with the other STA to authenticate
2543 * the STA and set up encryption keys with it.
2545 EVENT_IBSS_RSN_START
,
2548 * EVENT_AUTH - Authentication result
2550 * This event should be called when authentication attempt has been
2551 * completed. This is only used if the driver supports separate
2552 * authentication step (struct wpa_driver_ops::authenticate).
2553 * Information about authentication result is included in
2554 * union wpa_event_data::auth.
2559 * EVENT_DEAUTH - Authentication lost
2561 * This event should be called when authentication is lost either due
2562 * to receiving deauthenticate frame from the AP or when sending that
2563 * frame to the current AP.
2564 * In AP mode, union wpa_event_data::deauth_info is required.
2569 * EVENT_ASSOC_REJECT - Association rejected
2571 * This event should be called when (re)association attempt has been
2572 * rejected by the AP. Information about the association response is
2573 * included in union wpa_event_data::assoc_reject.
2578 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2580 EVENT_AUTH_TIMED_OUT
,
2583 * EVENT_ASSOC_TIMED_OUT - Association timed out
2585 EVENT_ASSOC_TIMED_OUT
,
2588 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2593 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2595 EVENT_WPS_BUTTON_PUSHED
,
2598 * EVENT_TX_STATUS - Report TX status
2603 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2605 EVENT_RX_FROM_UNKNOWN
,
2608 * EVENT_RX_MGMT - Report RX of a management frame
2613 * EVENT_RX_ACTION - Action frame received
2615 * This event is used to indicate when an Action frame has been
2616 * received. Information about the received frame is included in
2617 * union wpa_event_data::rx_action.
2622 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2624 * This event is used to indicate when the driver has started the
2625 * requested remain-on-channel duration. Information about the
2626 * operation is included in union wpa_event_data::remain_on_channel.
2628 EVENT_REMAIN_ON_CHANNEL
,
2631 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2633 * This event is used to indicate when the driver has completed
2634 * remain-on-channel duration, i.e., may noot be available on the
2635 * requested channel anymore. Information about the
2636 * operation is included in union wpa_event_data::remain_on_channel.
2638 EVENT_CANCEL_REMAIN_ON_CHANNEL
,
2641 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2643 * This event is used only by driver_test.c and userspace MLME.
2648 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2650 * This event is used to indicate when a Probe Request frame has been
2651 * received. Information about the received frame is included in
2652 * union wpa_event_data::rx_probe_req. The driver is required to report
2653 * these events only after successfully completed probe_req_report()
2654 * commands to request the events (i.e., report parameter is non-zero)
2655 * in station mode. In AP mode, Probe Request frames should always be
2661 * EVENT_NEW_STA - New wired device noticed
2663 * This event is used to indicate that a new device has been detected
2664 * in a network that does not use association-like functionality (i.e.,
2665 * mainly wired Ethernet). This can be used to start EAPOL
2666 * authenticator when receiving a frame from a device. The address of
2667 * the device is included in union wpa_event_data::new_sta.
2672 * EVENT_EAPOL_RX - Report received EAPOL frame
2674 * When in AP mode with hostapd, this event is required to be used to
2675 * deliver the receive EAPOL frames from the driver. With
2676 * %wpa_supplicant, this event is used only if the send_eapol() handler
2677 * is used to override the use of l2_packet for EAPOL frame TX.
2682 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
2684 * This event is used to indicate changes in the signal strength
2685 * observed in frames received from the current AP if signal strength
2686 * monitoring has been enabled with signal_monitor().
2688 EVENT_SIGNAL_CHANGE
,
2691 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
2693 * This event is used to indicate that the interface was enabled after
2694 * having been previously disabled, e.g., due to rfkill.
2696 EVENT_INTERFACE_ENABLED
,
2699 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
2701 * This event is used to indicate that the interface was disabled,
2702 * e.g., due to rfkill.
2704 EVENT_INTERFACE_DISABLED
,
2707 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
2709 * This event is used to indicate that the channel list has changed,
2710 * e.g., because of a regulatory domain change triggered by scan
2711 * results including an AP advertising a country code.
2713 EVENT_CHANNEL_LIST_CHANGED
,
2716 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
2718 * This event is used to indicate that the driver cannot maintain this
2719 * interface in its operation mode anymore. The most likely use for
2720 * this is to indicate that AP mode operation is not available due to
2721 * operating channel would need to be changed to a DFS channel when
2722 * the driver does not support radar detection and another virtual
2723 * interfaces caused the operating channel to change. Other similar
2724 * resource conflicts could also trigger this for station mode
2727 EVENT_INTERFACE_UNAVAILABLE
,
2730 * EVENT_BEST_CHANNEL
2732 * Driver generates this event whenever it detects a better channel
2733 * (e.g., based on RSSI or channel use). This information can be used
2734 * to improve channel selection for a new AP/P2P group.
2739 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
2741 * This event should be called when a Deauthentication frame is dropped
2742 * due to it not being protected (MFP/IEEE 802.11w).
2743 * union wpa_event_data::unprot_deauth is required to provide more
2744 * details of the frame.
2746 EVENT_UNPROT_DEAUTH
,
2749 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
2751 * This event should be called when a Disassociation frame is dropped
2752 * due to it not being protected (MFP/IEEE 802.11w).
2753 * union wpa_event_data::unprot_disassoc is required to provide more
2754 * details of the frame.
2756 EVENT_UNPROT_DISASSOC
,
2759 * EVENT_STATION_LOW_ACK
2761 * Driver generates this event whenever it detected that a particular
2762 * station was lost. Detection can be through massive transmission
2763 * failures for example.
2765 EVENT_STATION_LOW_ACK
,
2768 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
2770 * This event is used only if the driver implements P2P management
2771 * internally. Event data is stored in
2772 * union wpa_event_data::p2p_dev_found.
2774 EVENT_P2P_DEV_FOUND
,
2777 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
2779 * This event is used only if the driver implements P2P management
2780 * internally. Event data is stored in
2781 * union wpa_event_data::p2p_go_neg_req_rx.
2783 EVENT_P2P_GO_NEG_REQ_RX
,
2786 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
2788 * This event is used only if the driver implements P2P management
2789 * internally. Event data is stored in
2790 * union wpa_event_data::p2p_go_neg_completed.
2792 EVENT_P2P_GO_NEG_COMPLETED
,
2794 EVENT_P2P_PROV_DISC_REQUEST
,
2795 EVENT_P2P_PROV_DISC_RESPONSE
,
2796 EVENT_P2P_SD_REQUEST
,
2797 EVENT_P2P_SD_RESPONSE
,
2800 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
2802 EVENT_IBSS_PEER_LOST
,
2805 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
2807 * This event carries the new replay counter to notify wpa_supplicant
2808 * of the current EAPOL-Key Replay Counter in case the driver/firmware
2809 * completed Group Key Handshake while the host (including
2810 * wpa_supplicant was sleeping).
2812 EVENT_DRIVER_GTK_REKEY
2817 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
2819 union wpa_event_data
{
2821 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
2823 * This structure is optional for EVENT_ASSOC calls and required for
2824 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
2825 * driver interface does not need to generate separate EVENT_ASSOCINFO
2830 * reassoc - Flag to indicate association or reassociation
2835 * req_ies - (Re)Association Request IEs
2837 * If the driver generates WPA/RSN IE, this event data must be
2838 * returned for WPA handshake to have needed information. If
2839 * wpa_supplicant-generated WPA/RSN IE is used, this
2840 * information event is optional.
2842 * This should start with the first IE (fixed fields before IEs
2843 * are not included).
2848 * req_ies_len - Length of req_ies in bytes
2853 * resp_ies - (Re)Association Response IEs
2855 * Optional association data from the driver. This data is not
2856 * required WPA, but may be useful for some protocols and as
2857 * such, should be reported if this is available to the driver
2860 * This should start with the first IE (fixed fields before IEs
2861 * are not included).
2866 * resp_ies_len - Length of resp_ies in bytes
2868 size_t resp_ies_len
;
2871 * beacon_ies - Beacon or Probe Response IEs
2873 * Optional Beacon/ProbeResp data: IEs included in Beacon or
2874 * Probe Response frames from the current AP (i.e., the one
2875 * that the client just associated with). This information is
2876 * used to update WPA/RSN IE for the AP. If this field is not
2877 * set, the results from previous scan will be used. If no
2878 * data for the new AP is found, scan results will be requested
2879 * again (without scan request). At this point, the driver is
2880 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
2883 * This should start with the first IE (fixed fields before IEs
2884 * are not included).
2886 const u8
*beacon_ies
;
2889 * beacon_ies_len - Length of beacon_ies */
2890 size_t beacon_ies_len
;
2893 * freq - Frequency of the operational channel in MHz
2898 * addr - Station address (for AP mode)
2904 * struct disassoc_info - Data for EVENT_DISASSOC events
2906 struct disassoc_info
{
2908 * addr - Station address (for AP mode)
2913 * reason_code - Reason Code (host byte order) used in
2914 * Deauthentication frame
2919 * ie - Optional IE(s) in Disassociation frame
2924 * ie_len - Length of ie buffer in octets
2930 * struct deauth_info - Data for EVENT_DEAUTH events
2932 struct deauth_info
{
2934 * addr - Station address (for AP mode)
2939 * reason_code - Reason Code (host byte order) used in
2940 * Deauthentication frame
2945 * ie - Optional IE(s) in Deauthentication frame
2950 * ie_len - Length of ie buffer in octets
2956 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
2958 struct michael_mic_failure
{
2961 } michael_mic_failure
;
2964 * struct interface_status - Data for EVENT_INTERFACE_STATUS
2966 struct interface_status
{
2969 EVENT_INTERFACE_ADDED
, EVENT_INTERFACE_REMOVED
2974 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
2976 struct pmkid_candidate
{
2977 /** BSSID of the PMKID candidate */
2979 /** Smaller the index, higher the priority */
2981 /** Whether RSN IE includes pre-authenticate flag */
2986 * struct stkstart - Data for EVENT_STKSTART
2993 * struct tdls - Data for EVENT_TDLS
2999 TDLS_REQUEST_TEARDOWN
3001 u16 reason_code
; /* for teardown */
3005 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3007 * During FT (IEEE 802.11r) authentication sequence, the driver is
3008 * expected to use this event to report received FT IEs (MDIE, FTIE,
3009 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3010 * IEs for the next message will be delivered through the
3011 * struct wpa_driver_ops::update_ft_ies() callback.
3017 u8 target_ap
[ETH_ALEN
];
3018 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3020 /** Length of ric_ies buffer in octets */
3025 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3027 struct ibss_rsn_start
{
3032 * struct auth_info - Data for EVENT_AUTH events
3043 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3045 struct assoc_reject
{
3047 * bssid - BSSID of the AP that rejected association
3052 * resp_ies - (Re)Association Response IEs
3054 * Optional association data from the driver. This data is not
3055 * required WPA, but may be useful for some protocols and as
3056 * such, should be reported if this is available to the driver
3059 * This should start with the first IE (fixed fields before IEs
3060 * are not included).
3065 * resp_ies_len - Length of resp_ies in bytes
3067 size_t resp_ies_len
;
3070 * status_code - Status Code from (Re)association Response
3075 struct timeout_event
{
3080 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3089 * struct tx_status - Data for EVENT_TX_STATUS events
3101 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3103 struct rx_from_unknown
{
3109 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3119 * struct rx_action - Data for EVENT_RX_ACTION events
3123 * da - Destination address of the received Action frame
3128 * sa - Source address of the received Action frame
3133 * bssid - Address 3 of the received Action frame
3138 * category - Action frame category
3143 * data - Action frame body after category field
3148 * len - Length of data in octets
3153 * freq - Frequency (in MHz) on which the frame was received
3159 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3161 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3163 struct remain_on_channel
{
3165 * freq - Channel frequency in MHz
3170 * duration - Duration to remain on the channel in milliseconds
3172 unsigned int duration
;
3173 } remain_on_channel
;
3176 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3177 * @aborted: Whether the scan was aborted
3178 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3179 * @num_freqs: Number of entries in freqs array
3180 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3182 * @num_ssids: Number of entries in ssids array
3188 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
3193 * struct mlme_rx - Data for EVENT_MLME_RX events
3204 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3206 struct rx_probe_req
{
3208 * sa - Source address of the received Probe Request frame
3213 * da - Destination address of the received Probe Request frame
3214 * or %NULL if not available
3219 * bssid - BSSID of the received Probe Request frame or %NULL
3225 * ie - IEs from the Probe Request body
3230 * ie_len - Length of ie buffer in octets
3236 * struct new_sta - Data for EVENT_NEW_STA events
3243 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3252 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3254 struct wpa_signal_info signal_change
;
3257 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3258 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3259 * @freq_5: Best 5 GHz band channel frequency in MHz
3260 * @freq_overall: Best channel frequency in MHz
3262 * 0 can be used to indicate no preference in either band.
3264 struct best_channel
{
3270 struct unprot_deauth
{
3276 struct unprot_disassoc
{
3283 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3284 * @addr: station address
3291 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3293 struct p2p_dev_found
{
3296 const u8
*pri_dev_type
;
3297 const char *dev_name
;
3304 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3306 struct p2p_go_neg_req_rx
{
3309 } p2p_go_neg_req_rx
;
3312 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3314 struct p2p_go_neg_completed
{
3315 struct p2p_go_neg_results
*res
;
3316 } p2p_go_neg_completed
;
3318 struct p2p_prov_disc_req
{
3322 const u8
*pri_dev_type
;
3323 const char *dev_name
;
3324 u16 supp_config_methods
;
3327 } p2p_prov_disc_req
;
3329 struct p2p_prov_disc_resp
{
3332 } p2p_prov_disc_resp
;
3343 struct p2p_sd_resp
{
3351 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3353 struct ibss_peer_lost
{
3358 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3360 struct driver_gtk_rekey
{
3362 const u8
*replay_ctr
;
3367 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3368 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3369 * with struct wpa_driver_ops::init()
3370 * @event: event type (defined above)
3371 * @data: possible extra data for the event
3373 * Driver wrapper code should call this function whenever an event is received
3376 void wpa_supplicant_event(void *ctx
, enum wpa_event_type event
,
3377 union wpa_event_data
*data
);
3381 * The following inline functions are provided for convenience to simplify
3382 * event indication for some of the common events.
3385 static inline void drv_event_assoc(void *ctx
, const u8
*addr
, const u8
*ie
,
3386 size_t ielen
, int reassoc
)
3388 union wpa_event_data event
;
3389 os_memset(&event
, 0, sizeof(event
));
3390 event
.assoc_info
.reassoc
= reassoc
;
3391 event
.assoc_info
.req_ies
= ie
;
3392 event
.assoc_info
.req_ies_len
= ielen
;
3393 event
.assoc_info
.addr
= addr
;
3394 wpa_supplicant_event(ctx
, EVENT_ASSOC
, &event
);
3397 static inline void drv_event_disassoc(void *ctx
, const u8
*addr
)
3399 union wpa_event_data event
;
3400 os_memset(&event
, 0, sizeof(event
));
3401 event
.disassoc_info
.addr
= addr
;
3402 wpa_supplicant_event(ctx
, EVENT_DISASSOC
, &event
);
3405 static inline void drv_event_eapol_rx(void *ctx
, const u8
*src
, const u8
*data
,
3408 union wpa_event_data event
;
3409 os_memset(&event
, 0, sizeof(event
));
3410 event
.eapol_rx
.src
= src
;
3411 event
.eapol_rx
.data
= data
;
3412 event
.eapol_rx
.data_len
= data_len
;
3413 wpa_supplicant_event(ctx
, EVENT_EAPOL_RX
, &event
);
3416 #endif /* DRIVER_H */