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
36 * struct hostapd_channel_data - Channel information
38 struct hostapd_channel_data {
40 * chan - Channel number (IEEE 802.11)
45 * freq - Frequency in MHz
50 * flag - Channel flags (HOSTAPD_CHAN_*)
55 * max_tx_power - maximum transmit power in dBm
61 * struct hostapd_hw_modes - Supported hardware mode information
63 struct hostapd_hw_modes {
65 * mode - Hardware mode
67 enum hostapd_hw_mode mode;
70 * num_channels - Number of entries in the channels array
75 * channels - Array of supported channels
77 struct hostapd_channel_data *channels;
80 * num_rates - Number of entries in the rates array
85 * rates - Array of supported rates in 100 kbps units
90 * ht_capab - HT (IEEE 802.11n) capabilities
95 * mcs_set - MCS (IEEE 802.11n) rate parameters
100 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
106 #define IEEE80211_MODE_INFRA 0
107 #define IEEE80211_MODE_IBSS 1
108 #define IEEE80211_MODE_AP 2
110 #define IEEE80211_CAP_ESS 0x0001
111 #define IEEE80211_CAP_IBSS 0x0002
112 #define IEEE80211_CAP_PRIVACY 0x0010
114 #define WPA_SCAN_QUAL_INVALID BIT(0)
115 #define WPA_SCAN_NOISE_INVALID BIT(1)
116 #define WPA_SCAN_LEVEL_INVALID BIT(2)
117 #define WPA_SCAN_LEVEL_DBM BIT(3)
118 #define WPA_SCAN_AUTHENTICATED BIT(4)
119 #define WPA_SCAN_ASSOCIATED BIT(5)
122 * struct wpa_scan_res - Scan result for an BSS/IBSS
123 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
125 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
126 * @beacon_int: beacon interval in TUs (host byte order)
127 * @caps: capability information field in host byte order
128 * @qual: signal quality
129 * @noise: noise level
130 * @level: signal level
132 * @age: Age of the information in milliseconds (i.e., how many milliseconds
133 * ago the last Beacon or Probe Response frame was received)
134 * @ie_len: length of the following IE field in octets
135 * @beacon_ie_len: length of the following Beacon IE field in octets
137 * This structure is used as a generic format for scan results from the
138 * driver. Each driver interface implementation is responsible for converting
139 * the driver or OS specific scan results into this format.
141 * If the driver does not support reporting all IEs, the IE data structure is
142 * constructed of the IEs that are available. This field will also need to
143 * include SSID in IE format. All drivers are encouraged to be extended to
144 * report all IEs to make it easier to support future additions.
146 struct wpa_scan_res {
158 size_t beacon_ie_len;
160 * Followed by ie_len octets of IEs from Probe Response frame (or if
161 * the driver does not indicate source of IEs, these may also be from
162 * Beacon frame). After the first set of IEs, another set of IEs may
163 * follow (with beacon_ie_len octets of data) if the driver provides
169 * struct wpa_scan_results - Scan results
170 * @res: Array of pointers to allocated variable length scan result entries
171 * @num: Number of entries in the scan result array
173 struct wpa_scan_results {
174 struct wpa_scan_res **res;
179 * struct wpa_interface_info - Network interface information
180 * @next: Pointer to the next interface or NULL if this is the last one
181 * @ifname: Interface name that can be used with init() or init2()
182 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
184 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
185 * is not an allocated copy, i.e., get_interfaces() caller will not free
188 struct wpa_interface_info {
189 struct wpa_interface_info *next;
192 const char *drv_name;
195 #define WPAS_MAX_SCAN_SSIDS 4
198 * struct wpa_driver_scan_params - Scan parameters
199 * Data for struct wpa_driver_ops::scan2().
201 struct wpa_driver_scan_params {
203 * ssids - SSIDs to scan for
205 struct wpa_driver_scan_ssid {
207 * ssid - specific SSID to scan for (ProbeReq)
208 * %NULL or zero-length SSID is used to indicate active scan
209 * with wildcard SSID.
213 * ssid_len: Length of the SSID in octets
216 } ssids[WPAS_MAX_SCAN_SSIDS];
219 * num_ssids - Number of entries in ssids array
220 * Zero indicates a request for a passive scan.
225 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
230 * extra_ies_len - Length of extra_ies in octets
232 size_t extra_ies_len;
235 * freqs - Array of frequencies to scan or %NULL for all frequencies
237 * The frequency is set in MHz. The array is zero-terminated.
242 * filter_ssids - Filter for reporting SSIDs
244 * This optional parameter can be used to request the driver wrapper to
245 * filter scan results to include only the specified SSIDs. %NULL
246 * indicates that no filtering is to be done. This can be used to
247 * reduce memory needs for scan results in environments that have large
248 * number of APs with different SSIDs.
250 * The driver wrapper is allowed to take this allocated buffer into its
251 * own use by setting the pointer to %NULL. In that case, the driver
252 * wrapper is responsible for freeing the buffer with os_free() once it
253 * is not needed anymore.
255 struct wpa_driver_scan_filter {
261 * num_filter_ssids - Number of entries in filter_ssids array
263 size_t num_filter_ssids;
267 * struct wpa_driver_auth_params - Authentication parameters
268 * Data for struct wpa_driver_ops::authenticate().
270 struct wpa_driver_auth_params {
278 const u8 *wep_key[4];
279 size_t wep_key_len[4];
281 int local_state_change;
285 WPS_MODE_NONE /* no WPS provisioning being used */,
286 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
287 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
292 * struct wpa_driver_associate_params - Association parameters
293 * Data for struct wpa_driver_ops::associate().
295 struct wpa_driver_associate_params {
297 * bssid - BSSID of the selected AP
298 * This can be %NULL, if ap_scan=2 mode is used and the driver is
299 * responsible for selecting with which BSS to associate. */
303 * ssid - The selected SSID
308 * ssid_len - Length of the SSID (1..32)
313 * freq - Frequency of the channel the selected AP is using
314 * Frequency that the selected AP is using (in MHz as
315 * reported in the scan results)
320 * wpa_ie - WPA information element for (Re)Association Request
321 * WPA information element to be included in (Re)Association
322 * Request (including information element id and length). Use
323 * of this WPA IE is optional. If the driver generates the WPA
324 * IE, it can use pairwise_suite, group_suite, and
325 * key_mgmt_suite to select proper algorithms. In this case,
326 * the driver has to notify wpa_supplicant about the used WPA
327 * IE by generating an event that the interface code will
328 * convert into EVENT_ASSOCINFO data (see below).
330 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
331 * instead. The driver can determine which version is used by
332 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
335 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
340 * wpa_ie_len - length of the wpa_ie
345 * pairwise_suite - Selected pairwise cipher suite
347 * This is usually ignored if @wpa_ie is used.
349 enum wpa_cipher pairwise_suite;
352 * group_suite - Selected group cipher suite
354 * This is usually ignored if @wpa_ie is used.
356 enum wpa_cipher group_suite;
359 * key_mgmt_suite - Selected key management suite
361 * This is usually ignored if @wpa_ie is used.
363 enum wpa_key_mgmt key_mgmt_suite;
366 * auth_alg - Allowed authentication algorithms
367 * Bit field of WPA_AUTH_ALG_*
372 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
377 * wep_key - WEP keys for static WEP configuration
379 const u8 *wep_key[4];
382 * wep_key_len - WEP key length for static WEP configuration
384 size_t wep_key_len[4];
387 * wep_tx_keyidx - WEP TX key index for static WEP configuration
392 * mgmt_frame_protection - IEEE 802.11w management frame protection
394 enum mfp_options mgmt_frame_protection;
397 * ft_ies - IEEE 802.11r / FT information elements
398 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
399 * for fast transition, this parameter is set to include the IEs that
400 * are to be sent in the next FT Authentication Request message.
401 * update_ft_ies() handler is called to update the IEs for further
402 * FT messages in the sequence.
404 * The driver should use these IEs only if the target AP is advertising
405 * the same mobility domain as the one included in the MDIE here.
407 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
408 * AP after the initial association. These IEs can only be used if the
409 * target AP is advertising support for FT and is using the same MDIE
410 * and SSID as the current AP.
412 * The driver is responsible for reporting the FT IEs received from the
413 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
414 * type. update_ft_ies() handler will then be called with the FT IEs to
415 * include in the next frame in the authentication sequence.
420 * ft_ies_len - Length of ft_ies in bytes
425 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
427 * This value is provided to allow the driver interface easier access
428 * to the current mobility domain. This value is set to %NULL if no
429 * mobility domain is currently active.
434 * passphrase - RSN passphrase for PSK
436 * This value is made available only for WPA/WPA2-Personal (PSK) and
437 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
438 * the 8..63 character ASCII passphrase, if available. Please note that
439 * this can be %NULL if passphrase was not used to generate the PSK. In
440 * that case, the psk field must be used to fetch the PSK.
442 const char *passphrase;
445 * psk - RSN PSK (alternative for passphrase for PSK)
447 * This value is made available only for WPA/WPA2-Personal (PSK) and
448 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
449 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
450 * be prepared to handle %NULL value as an error.
455 * drop_unencrypted - Enable/disable unencrypted frame filtering
457 * Configure the driver to drop all non-EAPOL frames (both receive and
458 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
459 * still be allowed for key negotiation.
461 int drop_unencrypted;
464 * prev_bssid - Previously used BSSID in this ESS
466 * When not %NULL, this is a request to use reassociation instead of
469 const u8 *prev_bssid;
474 * If the driver needs to do special configuration for WPS association,
475 * this variable provides more information on what type of association
476 * is being requested. Most drivers should not need ot use this.
481 * p2p - Whether this connection is a P2P group
487 * struct wpa_driver_capa - Driver capability information
489 struct wpa_driver_capa {
490 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
491 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
492 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
493 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
494 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
495 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
496 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
497 unsigned int key_mgmt;
499 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
500 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
501 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
502 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
505 #define WPA_DRIVER_AUTH_OPEN 0x00000001
506 #define WPA_DRIVER_AUTH_SHARED 0x00000002
507 #define WPA_DRIVER_AUTH_LEAP 0x00000004
510 /* Driver generated WPA/RSN IE */
511 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
512 /* Driver needs static WEP key setup after association command */
513 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
514 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
515 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
516 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
517 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
518 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
519 /* Driver provides separate commands for authentication and association (SME in
520 * wpa_supplicant). */
521 #define WPA_DRIVER_FLAGS_SME 0x00000020
522 /* Driver supports AP mode */
523 #define WPA_DRIVER_FLAGS_AP 0x00000040
524 /* Driver needs static WEP key setup after association has been completed */
525 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
526 /* Driver takes care of P2P management operations */
527 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
528 /* Driver supports concurrent P2P operations */
529 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
531 * Driver uses the initial interface as a dedicated management interface, i.e.,
532 * it cannot be used for P2P group operations.
534 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
535 /* This interface is P2P capable (P2P Device, GO, or P2P Client */
536 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
542 * max_remain_on_chan - Maximum remain-on-channel duration in msec
544 unsigned int max_remain_on_chan;
550 struct hostap_sta_driver_data {
551 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
552 unsigned long current_tx_rate;
553 unsigned long inactive_msec;
555 unsigned long num_ps_buf_frames;
556 unsigned long tx_retry_failed;
557 unsigned long tx_retry_count;
562 struct hostapd_sta_add_params {
566 const u8 *supp_rates;
567 size_t supp_rates_len;
569 const struct ieee80211_ht_capabilities *ht_capabilities;
572 struct hostapd_freq_params {
577 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
578 * secondary channel below primary, 1 = HT40
579 * enabled, secondary channel above primary */
582 enum wpa_driver_if_type {
584 * WPA_IF_STATION - Station mode interface
589 * WPA_IF_AP_VLAN - AP mode VLAN interface
591 * This interface shares its address and Beacon frame with the main
597 * WPA_IF_AP_BSS - AP mode BSS interface
599 * This interface has its own address and Beacon frame.
604 * WPA_IF_P2P_GO - P2P Group Owner
609 * WPA_IF_P2P_CLIENT - P2P Client
614 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
615 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
620 struct wpa_init_params {
625 const char *test_socket;
626 int use_pae_group_addr;
630 u8 *own_addr; /* buffer for writing own MAC address */
634 struct wpa_bss_params {
635 /** Interface name (for multi-SSID/VLAN support) */
637 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
648 #define WPA_STA_AUTHORIZED BIT(0)
649 #define WPA_STA_WMM BIT(1)
650 #define WPA_STA_SHORT_PREAMBLE BIT(2)
651 #define WPA_STA_MFP BIT(3)
654 * struct wpa_driver_ops - Driver interface API definition
656 * This structure defines the API that each driver interface needs to implement
657 * for core wpa_supplicant code. All driver specific functionality is captured
660 struct wpa_driver_ops {
661 /** Name of the driver interface */
663 /** One line description of the driver interface */
667 * get_bssid - Get the current BSSID
668 * @priv: private driver interface data
669 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
671 * Returns: 0 on success, -1 on failure
673 * Query kernel driver for the current BSSID and copy it to bssid.
674 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
677 int (*get_bssid)(void *priv, u8 *bssid);
680 * get_ssid - Get the current SSID
681 * @priv: private driver interface data
682 * @ssid: buffer for SSID (at least 32 bytes)
684 * Returns: Length of the SSID on success, -1 on failure
686 * Query kernel driver for the current SSID and copy it to ssid.
687 * Returning zero is recommended if the STA is not associated.
689 * Note: SSID is an array of octets, i.e., it is not nul terminated and
690 * can, at least in theory, contain control characters (including nul)
691 * and as such, should be processed as binary data, not a printable
694 int (*get_ssid)(void *priv, u8 *ssid);
697 * set_key - Configure encryption key
698 * @ifname: Interface name (for multi-SSID/VLAN support)
699 * @priv: private driver interface data
700 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
701 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
702 * %WPA_ALG_NONE clears the key.
703 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
704 * broadcast/default keys
705 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
707 * @set_tx: configure this key as the default Tx key (only used when
708 * driver does not support separate unicast/individual key
709 * @seq: sequence number/packet number, seq_len octets, the next
710 * packet number to be used for in replay protection; configured
711 * for Rx keys (in most cases, this is only used with broadcast
712 * keys and set to zero for unicast keys)
713 * @seq_len: length of the seq, depends on the algorithm:
714 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
715 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
717 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
718 * TKIP: 32, CCMP: 16, IGTK: 16)
720 * Returns: 0 on success, -1 on failure
722 * Configure the given key for the kernel driver. If the driver
723 * supports separate individual keys (4 default keys + 1 individual),
724 * addr can be used to determine whether the key is default or
725 * individual. If only 4 keys are supported, the default key with key
726 * index 0 is used as the individual key. STA must be configured to use
727 * it as the default Tx key (set_tx is set) and accept Rx for all the
728 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
729 * broadcast keys, so key index 0 is available for this kind of
732 * Please note that TKIP keys include separate TX and RX MIC keys and
733 * some drivers may expect them in different order than wpa_supplicant
734 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
735 * will tricker Michael MIC errors. This can be fixed by changing the
736 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
737 * in driver_*.c set_key() implementation, see driver_ndis.c for an
738 * example on how this can be done.
740 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
741 const u8 *addr, int key_idx, int set_tx,
742 const u8 *seq, size_t seq_len,
743 const u8 *key, size_t key_len);
746 * init - Initialize driver interface
747 * @ctx: context to be used when calling wpa_supplicant functions,
748 * e.g., wpa_supplicant_event()
749 * @ifname: interface name, e.g., wlan0
751 * Returns: Pointer to private data, %NULL on failure
753 * Initialize driver interface, including event processing for kernel
754 * driver events (e.g., associated, scan results, Michael MIC failure).
755 * This function can allocate a private configuration data area for
756 * @ctx, file descriptor, interface name, etc. information that may be
757 * needed in future driver operations. If this is not used, non-NULL
758 * value will need to be returned because %NULL is used to indicate
759 * failure. The returned value will be used as 'void *priv' data for
760 * all other driver_ops functions.
762 * The main event loop (eloop.c) of wpa_supplicant can be used to
763 * register callback for read sockets (eloop_register_read_sock()).
765 * See below for more information about events and
766 * wpa_supplicant_event() function.
768 void * (*init)(void *ctx, const char *ifname);
771 * deinit - Deinitialize driver interface
772 * @priv: private driver interface data from init()
774 * Shut down driver interface and processing of driver events. Free
775 * private data buffer if one was allocated in init() handler.
777 void (*deinit)(void *priv);
780 * set_param - Set driver configuration parameters
781 * @priv: private driver interface data from init()
782 * @param: driver specific configuration parameters
784 * Returns: 0 on success, -1 on failure
786 * Optional handler for notifying driver interface about configuration
787 * parameters (driver_param).
789 int (*set_param)(void *priv, const char *param);
792 * set_countermeasures - Enable/disable TKIP countermeasures
793 * @priv: private driver interface data
794 * @enabled: 1 = countermeasures enabled, 0 = disabled
796 * Returns: 0 on success, -1 on failure
798 * Configure TKIP countermeasures. When these are enabled, the driver
799 * should drop all received and queued frames that are using TKIP.
801 int (*set_countermeasures)(void *priv, int enabled);
804 * deauthenticate - Request driver to deauthenticate
805 * @priv: private driver interface data
806 * @addr: peer address (BSSID of the AP)
807 * @reason_code: 16-bit reason code to be sent in the deauthentication
810 * Returns: 0 on success, -1 on failure
812 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
815 * disassociate - Request driver to disassociate
816 * @priv: private driver interface data
817 * @addr: peer address (BSSID of the AP)
818 * @reason_code: 16-bit reason code to be sent in the disassociation
821 * Returns: 0 on success, -1 on failure
823 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
826 * associate - Request driver to associate
827 * @priv: private driver interface data
828 * @params: association parameters
830 * Returns: 0 on success, -1 on failure
832 int (*associate)(void *priv,
833 struct wpa_driver_associate_params *params);
836 * add_pmkid - Add PMKSA cache entry to the driver
837 * @priv: private driver interface data
838 * @bssid: BSSID for the PMKSA cache entry
839 * @pmkid: PMKID for the PMKSA cache entry
841 * Returns: 0 on success, -1 on failure
843 * This function is called when a new PMK is received, as a result of
844 * either normal authentication or RSN pre-authentication.
846 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
847 * associate(), add_pmkid() can be used to add new PMKSA cache entries
848 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
849 * driver_ops function does not need to be implemented. Likewise, if
850 * the driver does not support WPA, this function is not needed.
852 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
855 * remove_pmkid - Remove PMKSA cache entry to the driver
856 * @priv: private driver interface data
857 * @bssid: BSSID for the PMKSA cache entry
858 * @pmkid: PMKID for the PMKSA cache entry
860 * Returns: 0 on success, -1 on failure
862 * This function is called when the supplicant drops a PMKSA cache
863 * entry for any reason.
865 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
866 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
867 * between the driver and wpa_supplicant. If the driver uses wpa_ie
868 * from wpa_supplicant, this driver_ops function does not need to be
869 * implemented. Likewise, if the driver does not support WPA, this
870 * function is not needed.
872 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
875 * flush_pmkid - Flush PMKSA cache
876 * @priv: private driver interface data
878 * Returns: 0 on success, -1 on failure
880 * This function is called when the supplicant drops all PMKSA cache
881 * entries for any reason.
883 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
884 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
885 * between the driver and wpa_supplicant. If the driver uses wpa_ie
886 * from wpa_supplicant, this driver_ops function does not need to be
887 * implemented. Likewise, if the driver does not support WPA, this
888 * function is not needed.
890 int (*flush_pmkid)(void *priv);
893 * get_capa - Get driver capabilities
894 * @priv: private driver interface data
896 * Returns: 0 on success, -1 on failure
898 * Get driver/firmware/hardware capabilities.
900 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
903 * poll - Poll driver for association information
904 * @priv: private driver interface data
906 * This is an option callback that can be used when the driver does not
907 * provide event mechanism for association events. This is called when
908 * receiving WPA EAPOL-Key messages that require association
909 * information. The driver interface is supposed to generate associnfo
910 * event before returning from this callback function. In addition, the
911 * driver interface should generate an association event after having
912 * sent out associnfo.
914 void (*poll)(void *priv);
917 * get_ifname - Get interface name
918 * @priv: private driver interface data
920 * Returns: Pointer to the interface name. This can differ from the
921 * interface name used in init() call. Init() is called first.
923 * This optional function can be used to allow the driver interface to
924 * replace the interface name with something else, e.g., based on an
925 * interface mapping from a more descriptive name.
927 const char * (*get_ifname)(void *priv);
930 * get_mac_addr - Get own MAC address
931 * @priv: private driver interface data
933 * Returns: Pointer to own MAC address or %NULL on failure
935 * This optional function can be used to get the own MAC address of the
936 * device from the driver interface code. This is only needed if the
937 * l2_packet implementation for the OS does not provide easy access to
939 const u8 * (*get_mac_addr)(void *priv);
942 * send_eapol - Optional function for sending EAPOL packets
943 * @priv: private driver interface data
944 * @dest: Destination MAC address
946 * @data: EAPOL packet starting with IEEE 802.1X header
947 * @data_len: Size of the EAPOL packet
949 * Returns: 0 on success, -1 on failure
951 * This optional function can be used to override l2_packet operations
952 * with driver specific functionality. If this function pointer is set,
953 * l2_packet module is not used at all and the driver interface code is
954 * responsible for receiving and sending all EAPOL packets. The
955 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
956 * event. The driver interface is required to implement get_mac_addr()
957 * handler if send_eapol() is used.
959 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
960 const u8 *data, size_t data_len);
963 * set_operstate - Sets device operating state to DORMANT or UP
964 * @priv: private driver interface data
965 * @state: 0 = dormant, 1 = up
966 * Returns: 0 on success, -1 on failure
968 * This is an optional function that can be used on operating systems
969 * that support a concept of controlling network device state from user
970 * space applications. This function, if set, gets called with
971 * state = 1 when authentication has been completed and with state = 0
972 * when connection is lost.
974 int (*set_operstate)(void *priv, int state);
977 * mlme_setprotection - MLME-SETPROTECTION.request primitive
978 * @priv: Private driver interface data
979 * @addr: Address of the station for which to set protection (may be
980 * %NULL for group keys)
981 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
982 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
983 * Returns: 0 on success, -1 on failure
985 * This is an optional function that can be used to set the driver to
986 * require protection for Tx and/or Rx frames. This uses the layer
987 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
988 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
989 * set protection operation; instead, they set protection implicitly
990 * based on configured keys.
992 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
996 * get_hw_feature_data - Get hardware support data (channels and rates)
997 * @priv: Private driver interface data
998 * @num_modes: Variable for returning the number of returned modes
999 * flags: Variable for returning hardware feature flags
1000 * Returns: Pointer to allocated hardware data on success or %NULL on
1001 * failure. Caller is responsible for freeing this.
1003 * This function is only needed for drivers that export MLME
1004 * (management frame processing) to %wpa_supplicant or hostapd.
1006 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1011 * set_channel - Set channel
1012 * @priv: Private driver interface data
1013 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
1014 * @chan: IEEE 802.11 channel number
1015 * @freq: Frequency of the channel in MHz
1016 * Returns: 0 on success, -1 on failure
1018 * This function is only needed for drivers that export MLME
1019 * (management frame processing) to wpa_supplicant.
1021 int (*set_channel)(void *priv, enum hostapd_hw_mode phymode, int chan,
1025 * set_ssid - Set SSID
1026 * @priv: Private driver interface data
1028 * @ssid_len: SSID length
1029 * Returns: 0 on success, -1 on failure
1031 * This function is only needed for drivers that export MLME
1032 * (management frame processing) to wpa_supplicant.
1034 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
1037 * set_bssid - Set BSSID
1038 * @priv: Private driver interface data
1040 * Returns: 0 on success, -1 on failure
1042 * This function is only needed for drivers that export MLME
1043 * (management frame processing) to wpa_supplicant.
1045 int (*set_bssid)(void *priv, const u8 *bssid);
1048 * send_mlme - Send management frame from MLME
1049 * @priv: Private driver interface data
1050 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1051 * @data_len: Size of the management frame
1052 * Returns: 0 on success, -1 on failure
1054 * This function is only needed for drivers that export MLME
1055 * (management frame processing) to wpa_supplicant.
1057 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
1060 * mlme_add_sta - Add a STA entry into the driver/netstack
1061 * @priv: Private driver interface data
1062 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1063 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
1064 * format (one octet per rate, 1 = 0.5 Mbps)
1065 * @supp_rates_len: Number of entries in supp_rates
1066 * Returns: 0 on success, -1 on failure
1068 * This function is only needed for drivers that export MLME
1069 * (management frame processing) to wpa_supplicant. When the MLME code
1070 * completes association with an AP, this function is called to
1071 * configure the driver/netstack with a STA entry for data frame
1072 * processing (TX rate control, encryption/decryption).
1074 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
1075 size_t supp_rates_len);
1078 * mlme_remove_sta - Remove a STA entry from the driver/netstack
1079 * @priv: Private driver interface data
1080 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1081 * Returns: 0 on success, -1 on failure
1083 * This function is only needed for drivers that export MLME
1084 * (management frame processing) to wpa_supplicant.
1086 int (*mlme_remove_sta)(void *priv, const u8 *addr);
1089 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1090 * @priv: Private driver interface data
1091 * @md: Mobility domain (2 octets) (also included inside ies)
1092 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1093 * @ies_len: Length of FT IEs in bytes
1094 * Returns: 0 on success, -1 on failure
1096 * The supplicant uses this callback to let the driver know that keying
1097 * material for FT is available and that the driver can use the
1098 * provided IEs in the next message in FT authentication sequence.
1100 * This function is only needed for driver that support IEEE 802.11r
1101 * (Fast BSS Transition).
1103 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1107 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1108 * @priv: Private driver interface data
1109 * @action: Action field value
1110 * @target_ap: Target AP address
1111 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1112 * @ies_len: Length of FT IEs in bytes
1113 * Returns: 0 on success, -1 on failure
1115 * The supplicant uses this callback to request the driver to transmit
1116 * an FT Action frame (action category 6) for over-the-DS fast BSS
1119 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1120 const u8 *ies, size_t ies_len);
1123 * get_scan_results2 - Fetch the latest scan results
1124 * @priv: private driver interface data
1126 * Returns: Allocated buffer of scan results (caller is responsible for
1127 * freeing the data structure) on success, NULL on failure
1129 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1132 * set_country - Set country
1133 * @priv: Private driver interface data
1134 * @alpha2: country to which to switch to
1135 * Returns: 0 on success, -1 on failure
1137 * This function is for drivers which support some form
1138 * of setting a regulatory domain.
1140 int (*set_country)(void *priv, const char *alpha2);
1143 * global_init - Global driver initialization
1144 * Returns: Pointer to private data (global), %NULL on failure
1146 * This optional function is called to initialize the driver wrapper
1147 * for global data, i.e., data that applies to all interfaces. If this
1148 * function is implemented, global_deinit() will also need to be
1149 * implemented to free the private data. The driver will also likely
1150 * use init2() function instead of init() to get the pointer to global
1151 * data available to per-interface initializer.
1153 void * (*global_init)(void);
1156 * global_deinit - Global driver deinitialization
1157 * @priv: private driver global data from global_init()
1159 * Terminate any global driver related functionality and free the
1160 * global data structure.
1162 void (*global_deinit)(void *priv);
1165 * init2 - Initialize driver interface (with global data)
1166 * @ctx: context to be used when calling wpa_supplicant functions,
1167 * e.g., wpa_supplicant_event()
1168 * @ifname: interface name, e.g., wlan0
1169 * @global_priv: private driver global data from global_init()
1170 * Returns: Pointer to private data, %NULL on failure
1172 * This function can be used instead of init() if the driver wrapper
1175 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1178 * get_interfaces - Get information about available interfaces
1179 * @global_priv: private driver global data from global_init()
1180 * Returns: Allocated buffer of interface information (caller is
1181 * responsible for freeing the data structure) on success, NULL on
1184 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1187 * scan2 - Request the driver to initiate scan
1188 * @priv: private driver interface data
1189 * @params: Scan parameters
1191 * Returns: 0 on success, -1 on failure
1193 * Once the scan results are ready, the driver should report scan
1194 * results event for wpa_supplicant which will eventually request the
1195 * results with wpa_driver_get_scan_results2().
1197 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1200 * authenticate - Request driver to authenticate
1201 * @priv: private driver interface data
1202 * @params: authentication parameters
1203 * Returns: 0 on success, -1 on failure
1205 * This is an optional function that can be used with drivers that
1206 * support separate authentication and association steps, i.e., when
1207 * wpa_supplicant can act as the SME. If not implemented, associate()
1208 * function is expected to take care of IEEE 802.11 authentication,
1211 int (*authenticate)(void *priv,
1212 struct wpa_driver_auth_params *params);
1215 * set_beacon - Set Beacon frame template
1216 * @priv: Private driver interface data
1217 * @head: Beacon head from IEEE 802.11 header to IEs before TIM IE
1218 * @head_len: Length of the head buffer in octets
1219 * @tail: Beacon tail following TIM IE
1220 * @tail_len: Length of the tail buffer in octets
1221 * @dtim_period: DTIM period
1222 * @beacon_int: Beacon interval
1223 * Returns: 0 on success, -1 on failure
1225 * This function is used to configure Beacon template for the driver in
1226 * AP mode. The driver is responsible for building the full Beacon
1227 * frame by concatenating the head part with TIM IE generated by the
1228 * driver/firmware and finishing with the tail part.
1230 int (*set_beacon)(void *priv, const u8 *head, size_t head_len,
1231 const u8 *tail, size_t tail_len, int dtim_period,
1235 * hapd_init - Initialize driver interface (hostapd only)
1236 * @hapd: Pointer to hostapd context
1237 * @params: Configuration for the driver wrapper
1238 * Returns: Pointer to private data, %NULL on failure
1240 * This function is used instead of init() or init2() when the driver
1241 * wrapper is used withh hostapd.
1243 void * (*hapd_init)(struct hostapd_data *hapd,
1244 struct wpa_init_params *params);
1247 * hapd_deinit - Deinitialize driver interface (hostapd only)
1248 * @priv: Private driver interface data from hapd_init()
1250 void (*hapd_deinit)(void *priv);
1253 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1254 * @priv: Private driver interface data
1255 * @params: BSS parameters
1256 * Returns: 0 on success, -1 on failure
1258 * This is an optional function to configure the kernel driver to
1259 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1260 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1261 * always enabled and the driver uses set_beacon() to set WPA/RSN IE
1262 * for Beacon frames.
1264 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1267 * set_privacy - Enable/disable privacy (AP only)
1268 * @priv: Private driver interface data
1269 * @enabled: 1 = privacy enabled, 0 = disabled
1270 * Returns: 0 on success, -1 on failure
1272 * This is an optional function to configure privacy field in the
1273 * kernel driver for Beacon frames. This can be left undefined (set to
1274 * %NULL) if the driver uses the Beacon template from set_beacon().
1276 int (*set_privacy)(void *priv, int enabled);
1279 * get_seqnum - Fetch the current TSC/packet number (AP only)
1280 * @ifname: The interface name (main or virtual)
1281 * @priv: Private driver interface data
1282 * @addr: MAC address of the station or %NULL for group keys
1284 * @seq: Buffer for returning the latest used TSC/packet number
1285 * Returns: 0 on success, -1 on failure
1287 * This function is used to fetch the last used TSC/packet number for
1288 * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so
1289 * there is no strict requirement on implementing support for unicast
1290 * keys (i.e., addr != %NULL).
1292 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1296 * flush - Flush all association stations (AP only)
1297 * @priv: Private driver interface data
1298 * Returns: 0 on success, -1 on failure
1300 * This function requests the driver to disassociate all associated
1301 * stations. This function does not need to be implemented if the
1302 * driver does not process association frames internally.
1304 int (*flush)(void *priv);
1307 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1308 * @priv: Private driver interface data
1309 * @elem: Information elements
1310 * @elem_len: Length of the elem buffer in octets
1311 * Returns: 0 on success, -1 on failure
1313 * This is an optional function to add information elements in the
1314 * kernel driver for Beacon and Probe Response frames. This can be left
1315 * undefined (set to %NULL) if the driver uses the Beacon template from
1318 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1321 * read_sta_data - Fetch station data (AP only)
1322 * @priv: Private driver interface data
1323 * @data: Buffer for returning station information
1324 * @addr: MAC address of the station
1325 * Returns: 0 on success, -1 on failure
1327 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1331 * hapd_send_eapol - Send an EAPOL packet (AP only)
1332 * @priv: private driver interface data
1333 * @addr: Destination MAC address
1334 * @data: EAPOL packet starting with IEEE 802.1X header
1335 * @data_len: Length of the EAPOL packet in octets
1336 * @encrypt: Whether the frame should be encrypted
1337 * @own_addr: Source MAC address
1339 * Returns: 0 on success, -1 on failure
1341 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1342 size_t data_len, int encrypt,
1343 const u8 *own_addr);
1346 * sta_deauth - Deauthenticate a station (AP only)
1347 * @priv: Private driver interface data
1348 * @own_addr: Source address and BSSID for the Deauthentication frame
1349 * @addr: MAC address of the station to deauthenticate
1350 * @reason: Reason code for the Deauthentiation frame
1351 * Returns: 0 on success, -1 on failure
1353 * This function requests a specific station to be deauthenticated and
1354 * a Deauthentication frame to be sent to it.
1356 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1360 * sta_disassoc - Disassociate a station (AP only)
1361 * @priv: Private driver interface data
1362 * @own_addr: Source address and BSSID for the Disassociation frame
1363 * @addr: MAC address of the station to disassociate
1364 * @reason: Reason code for the Disassociation frame
1365 * Returns: 0 on success, -1 on failure
1367 * This function requests a specific station to be disassociated and
1368 * a Disassociation frame to be sent to it.
1370 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1374 * sta_remove - Remove a station entry (AP only)
1375 * @priv: Private driver interface data
1376 * @addr: MAC address of the station to be removed
1377 * Returns: 0 on success, -1 on failure
1379 int (*sta_remove)(void *priv, const u8 *addr);
1382 * hapd_get_ssid - Get the current SSID (AP only)
1383 * @priv: Private driver interface data
1384 * @buf: Buffer for returning the SSID
1385 * @len: Maximum length of the buffer
1386 * Returns: Length of the SSID on success, -1 on failure
1388 * This function need not be implemented if the driver uses Beacon
1389 * template from set_beacon() and does not reply to Probe Request
1392 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1395 * hapd_set_ssid - Set SSID (AP only)
1396 * @priv: Private driver interface data
1398 * @len: Length of the SSID in octets
1399 * Returns: 0 on success, -1 on failure
1401 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1404 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1405 * @priv: Private driver interface data
1406 * @enabled: 1 = countermeasures enabled, 0 = disabled
1407 * Returns: 0 on success, -1 on failure
1409 * This need not be implemented if the driver does not take care of
1410 * association processing.
1412 int (*hapd_set_countermeasures)(void *priv, int enabled);
1415 * sta_add - Add a station entry
1416 * @priv: Private driver interface data
1417 * @params: Station parameters
1418 * Returns: 0 on success, -1 on failure
1420 * This function is used to add a station entry to the driver once the
1421 * station has completed association. This is only used if the driver
1422 * does not take care of association processing.
1424 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1427 * get_inact_sec - Get station inactivity duration (AP only)
1428 * @priv: Private driver interface data
1429 * @addr: Station address
1430 * Returns: Number of seconds station has been inactive, -1 on failure
1432 int (*get_inact_sec)(void *priv, const u8 *addr);
1435 * sta_clear_stats - Clear station statistics (AP only)
1436 * @priv: Private driver interface data
1437 * @addr: Station address
1438 * Returns: 0 on success, -1 on failure
1440 int (*sta_clear_stats)(void *priv, const u8 *addr);
1443 * set_freq - Set channel/frequency (AP only)
1444 * @priv: Private driver interface data
1445 * @freq: Channel parameters
1446 * Returns: 0 on success, -1 on failure
1448 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1451 * set_rts - Set RTS threshold
1452 * @priv: Private driver interface data
1453 * @rts: RTS threshold in octets
1454 * Returns: 0 on success, -1 on failure
1456 int (*set_rts)(void *priv, int rts);
1459 * set_frag - Set fragmentation threshold
1460 * @priv: Private driver interface data
1461 * @frag: Fragmentation threshold in octets
1462 * Returns: 0 on success, -1 on failure
1464 int (*set_frag)(void *priv, int frag);
1467 * sta_set_flags - Set station flags (AP only)
1468 * @priv: Private driver interface data
1469 * @addr: Station address
1470 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1471 * @flags_or: Bitmap of WPA_STA_* flags to add
1472 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1473 * Returns: 0 on success, -1 on failure
1475 int (*sta_set_flags)(void *priv, const u8 *addr,
1476 int total_flags, int flags_or, int flags_and);
1479 * set_rate_sets - Set supported and basic rate sets (AP only)
1480 * @priv: Private driver interface data
1481 * @supp_rates: -1 terminated array of supported rates in 100 kbps
1482 * @basic_rates: -1 terminated array of basic rates in 100 kbps
1483 * @mode: hardware mode (HOSTAPD_MODE_*)
1484 * Returns: 0 on success, -1 on failure
1486 int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
1490 * set_cts_protect - Set CTS protection mode (AP only)
1491 * @priv: Private driver interface data
1492 * @value: Whether CTS protection is enabled
1493 * Returns: 0 on success, -1 on failure
1495 int (*set_cts_protect)(void *priv, int value);
1498 * set_preamble - Set preamble mode (AP only)
1499 * @priv: Private driver interface data
1500 * @value: Whether short preamble is enabled
1501 * Returns: 0 on success, -1 on failure
1503 int (*set_preamble)(void *priv, int value);
1506 * set_short_slot_time - Set short slot time (AP only)
1507 * @priv: Private driver interface data
1508 * @value: Whether short slot time is enabled
1509 * Returns: 0 on success, -1 on failure
1511 int (*set_short_slot_time)(void *priv, int value);
1514 * set_tx_queue_params - Set TX queue parameters
1515 * @priv: Private driver interface data
1516 * @queue: Queue number
1520 * @burst_time: Maximum length for bursting in 0.1 msec units
1522 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1523 int cw_max, int burst_time);
1526 * valid_bss_mask - Validate BSSID mask
1527 * @priv: Private driver interface data
1530 * Returns: 0 if mask is valid, -1 if mask is not valid, 1 if mask can
1531 * be used, but the main interface address must be the first address in
1532 * the block if mask is applied
1534 int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
1537 * if_add - Add a virtual interface
1538 * @priv: Private driver interface data
1539 * @type: Interface type
1540 * @ifname: Interface name for the new virtual interface
1541 * @addr: Local address to use for the interface or %NULL to use the
1542 * parent interface address
1543 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1544 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1545 * not allowed (applies only to %WPA_IF_AP_BSS type)
1546 * @force_ifname: Buffer for returning an interface name that the
1547 * driver ended up using if it differs from the requested ifname
1548 * @if_addr: Buffer for returning the allocated interface address
1549 * (this may differ from the requested addr if the driver cannot
1550 * change interface address)
1551 * Returns: 0 on success, -1 on failure
1553 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1554 const char *ifname, const u8 *addr, void *bss_ctx,
1555 void **drv_priv, char *force_ifname, u8 *if_addr);
1558 * if_remove - Remove a virtual interface
1559 * @priv: Private driver interface data
1560 * @type: Interface type
1561 * @ifname: Interface name of the virtual interface to be removed
1562 * Returns: 0 on success, -1 on failure
1564 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1565 const char *ifname);
1568 * set_sta_vlan - Bind a station into a specific interface (AP only)
1569 * @priv: Private driver interface data
1570 * @ifname: Interface (main or virtual BSS or VLAN)
1571 * @addr: MAC address of the associated station
1573 * Returns: 0 on success, -1 on failure
1575 * This function is used to bind a station to a specific virtual
1576 * interface. It is only used if when virtual interfaces are supported,
1577 * e.g., to assign stations to different VLAN interfaces based on
1578 * information from a RADIUS server. This allows separate broadcast
1579 * domains to be used with a single BSS.
1581 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1585 * commit - Optional commit changes handler (AP only)
1586 * @priv: driver private data
1587 * Returns: 0 on success, -1 on failure
1589 * This optional handler function can be registered if the driver
1590 * interface implementation needs to commit changes (e.g., by setting
1591 * network interface up) at the end of initial configuration. If set,
1592 * this handler will be called after initial setup has been completed.
1594 int (*commit)(void *priv);
1597 * send_ether - Send an ethernet packet (AP only)
1598 * @priv: private driver interface data
1599 * @dst: Destination MAC address
1600 * @src: Source MAC address
1602 * @data: EAPOL packet starting with IEEE 802.1X header
1603 * @data_len: Length of the EAPOL packet in octets
1604 * Returns: 0 on success, -1 on failure
1606 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1607 const u8 *data, size_t data_len);
1610 * set_radius_acl_auth - Notification of RADIUS ACL change
1611 * @priv: Private driver interface data
1612 * @mac: MAC address of the station
1613 * @accepted: Whether the station was accepted
1614 * @session_timeout: Session timeout for the station
1615 * Returns: 0 on success, -1 on failure
1617 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1618 u32 session_timeout);
1621 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1622 * @priv: Private driver interface data
1623 * @mac: MAC address of the station
1624 * Returns: 0 on success, -1 on failure
1626 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1629 * set_ht_params - Set HT parameters (AP only)
1630 * @priv: Private driver interface data
1631 * @ht_capab: HT Capabilities IE
1632 * @ht_capab_len: Length of ht_capab in octets
1633 * @ht_oper: HT Operation IE
1634 * @ht_oper_len: Length of ht_oper in octets
1635 * Returns: 0 on success, -1 on failure
1637 int (*set_ht_params)(void *priv,
1638 const u8 *ht_capab, size_t ht_capab_len,
1639 const u8 *ht_oper, size_t ht_oper_len);
1642 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
1643 * @priv: Private driver interface data
1644 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
1645 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
1647 * Returns: 0 on success, -1 on failure
1649 * This is an optional function to add WPS IE in the kernel driver for
1650 * Beacon and Probe Response frames. This can be left undefined (set
1651 * to %NULL) if the driver uses the Beacon template from set_beacon()
1652 * and does not process Probe Request frames.
1654 * This will also be used to add P2P IE(s) into Beacon/Probe Response
1655 * frames when operating as a GO. The driver is responsible for adding
1656 * timing related attributes (e.g., NoA) in addition to the IEs
1657 * included here by appending them after these buffers. This call is
1658 * also used to provide Probe Response IEs for P2P Listen state
1659 * operations for drivers that generate the Probe Response frames
1662 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
1663 const struct wpabuf *proberesp);
1666 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1667 * @priv: Private driver interface data
1668 * @authorized: Whether the port is authorized
1669 * Returns: 0 on success, -1 on failure
1671 int (*set_supp_port)(void *priv, int authorized);
1674 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1675 * @priv: Private driver interface data
1676 * @addr: MAC address of the associated station
1677 * @aid: Association ID
1678 * @val: 1 = bind to 4-address WDS; 0 = unbind
1679 * Returns: 0 on success, -1 on failure
1681 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val);
1684 * send_action - Transmit an Action frame
1685 * @priv: Private driver interface data
1686 * @freq: Frequency (in MHz) of the channel
1687 * @dst: Destination MAC address (Address 1)
1688 * @src: Source MAC address (Address 2)
1689 * @bssid: BSSID (Address 3)
1691 * @data_len: data length in octets
1692 * Returns: 0 on success, -1 on failure
1694 * This command can be used to request the driver to transmit an action
1695 * frame to the specified destination. If a remain-on-channel duration
1696 * is in progress, the frame is transmitted on that channel. Otherwise,
1697 * the frame is transmitted on the current operational channel if in
1698 * associated state in station mode or if operating as an AP. If none
1699 * of these conditions is in effect, send_action() cannot be used.
1701 int (*send_action)(void *priv, unsigned int freq,
1702 const u8 *dst, const u8 *src, const u8 *bssid,
1703 const u8 *data, size_t data_len);
1706 * remain_on_channel - Remain awake on a channel
1707 * @priv: Private driver interface data
1708 * @freq: Frequency (in MHz) of the channel
1709 * @duration: Duration in milliseconds
1710 * Returns: 0 on success, -1 on failure
1712 * This command is used to request the driver to remain awake on the
1713 * specified channel for the specified duration and report received
1714 * Action frames with EVENT_RX_ACTION events. Optionally, received
1715 * Probe Request frames may also be requested to be reported by calling
1716 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
1718 * The driver may not be at the requested channel when this function
1719 * returns, i.e., the return code is only indicating whether the
1720 * request was accepted. The caller will need to wait until the
1721 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
1722 * completed the channel change. This may take some time due to other
1723 * need for the radio and the caller should be prepared to timing out
1724 * its wait since there are no guarantees on when this request can be
1727 int (*remain_on_channel)(void *priv, unsigned int freq,
1728 unsigned int duration);
1731 * cancel_remain_on_channel - Cancel remain-on-channel operation
1732 * @priv: Private driver interface data
1734 * This command can be used to cancel a remain-on-channel operation
1735 * before its originally requested duration has passed. This could be
1736 * used, e.g., when remain_on_channel() is used to request extra time
1737 * to receive a response to an Action frame and the response is
1738 * received when there is still unneeded time remaining on the
1739 * remain-on-channel operation.
1741 int (*cancel_remain_on_channel)(void *priv);
1744 * probe_req_report - Request Probe Request frames to be indicated
1745 * @priv: Private driver interface data
1746 * @report: Whether to report received Probe Request frames
1747 * Returns: 0 on success, -1 on failure (or if not supported)
1749 * This command can be used to request the driver to indicate when
1750 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
1751 * Since this operation may require extra resources, e.g., due to less
1752 * optimal hardware/firmware RX filtering, many drivers may disable
1753 * Probe Request reporting at least in station mode. This command is
1754 * used to notify the driver when the Probe Request frames need to be
1755 * reported, e.g., during remain-on-channel operations.
1757 int (*probe_req_report)(void *priv, int report);
1760 * disable_11b_rates - Set whether IEEE 802.11b rates are used for TX
1761 * @priv: Private driver interface data
1762 * @disabled: Whether IEEE 802.11b rates are disabled
1763 * Returns: 0 on success, -1 on failure (or if not supported)
1765 * This command is used to disable IEEE 802.11b rates (1, 2, 5.5, and
1766 * 11 Mbps) as TX rates for data and management frames. This can be
1767 * used to optimize channel use when there is no need to support IEEE
1768 * 802.11b-only devices.
1770 int (*disable_11b_rates)(void *priv, int disabled);
1773 * deinit_ap - Deinitialize AP mode
1774 * @priv: Private driver interface data
1775 * Returns: 0 on success, -1 on failure (or if not supported)
1777 * This optional function can be used to disable AP mode related
1778 * configuration and change the driver mode to station mode to allow
1779 * normal station operations like scanning to be completed.
1781 int (*deinit_ap)(void *priv);
1784 * suspend - Notification on system suspend/hibernate event
1785 * @priv: Private driver interface data
1787 void (*suspend)(void *priv);
1790 * resume - Notification on system resume/thaw event
1791 * @priv: Private driver interface data
1793 void (*resume)(void *priv);
1796 * signal_monitor - Set signal monitoring parameters
1797 * @priv: Private driver interface data
1798 * @threshold: Threshold value for signal change events; 0 = disabled
1799 * @hysteresis: Minimum change in signal strength before indicating a
1801 * Returns: 0 on success, -1 on failure (or if not supported)
1803 * This function can be used to configure monitoring of signal strength
1804 * with the current AP. Whenever signal strength drops below the
1805 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
1806 * should be generated assuming the signal strength has changed at
1807 * least %hysteresis from the previously indicated signal change event.
1809 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
1812 * send_frame - Send IEEE 802.11 frame (testing use only)
1813 * @priv: Private driver interface data
1814 * @data: IEEE 802.11 frame with IEEE 802.11 header
1815 * @data_len: Size of the frame
1816 * @encrypt: Whether to encrypt the frame (if keys are set)
1817 * Returns: 0 on success, -1 on failure
1819 * This function is only used for debugging purposes and is not
1820 * required to be implemented for normal operations.
1822 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
1826 * shared_freq - Get operating frequency of shared interface(s)
1827 * @priv: Private driver interface data
1828 * Returns: Operating frequency in MHz, 0 if no shared operation in
1829 * use, or -1 on failure
1831 * This command can be used to request the current operating frequency
1832 * of any virtual interface that shares the same radio to provide
1833 * information for channel selection for other virtual interfaces.
1835 int (*shared_freq)(void *priv);
1838 * get_noa - Get current Notice of Absence attribute payload
1839 * @priv: Private driver interface data
1840 * @buf: Buffer for returning NoA
1841 * @buf_len: Buffer length in octets
1842 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
1843 * advertized, or -1 on failure
1845 * This function is used to fetch the current Notice of Absence
1846 * attribute value from GO.
1848 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
1851 * set_noa - Set Notice of Absence parameters for GO (testing)
1852 * @priv: Private driver interface data
1854 * @start: Start time in ms from next TBTT
1855 * @duration: Duration in ms
1856 * Returns: 0 on success or -1 on failure
1858 * This function is used to set Notice of Absence parameters for GO. It
1859 * is used only for testing. To disable NoA, all parameters are set to
1862 int (*set_noa)(void *priv, u8 count, int start, int duration);
1865 * set_p2p_powersave - Set P2P power save options
1866 * @priv: Private driver interface data
1867 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
1868 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
1869 * @ctwindow: 0.. = change (msec), -1 = no change
1870 * Returns: 0 on success or -1 on failure
1872 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
1878 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1880 enum wpa_event_type {
1882 * EVENT_ASSOC - Association completed
1884 * This event needs to be delivered when the driver completes IEEE
1885 * 802.11 association or reassociation successfully.
1886 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1887 * after this event has been generated. In addition, optional
1888 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1889 * more information about the association. If the driver interface gets
1890 * both of these events at the same time, it can also include the
1891 * assoc_info data in EVENT_ASSOC call.
1896 * EVENT_DISASSOC - Association lost
1898 * This event should be called when association is lost either due to
1899 * receiving deauthenticate or disassociate frame from the AP or when
1900 * sending either of these frames to the current AP. If the driver
1901 * supports separate deauthentication event, EVENT_DISASSOC should only
1902 * be used for disassociation and EVENT_DEAUTH for deauthentication.
1903 * In AP mode, union wpa_event_data::disassoc_info is required.
1908 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1910 * This event must be delivered when a Michael MIC error is detected by
1911 * the local driver. Additional data for event processing is
1912 * provided with union wpa_event_data::michael_mic_failure. This
1913 * information is used to request new encyption key and to initiate
1914 * TKIP countermeasures if needed.
1916 EVENT_MICHAEL_MIC_FAILURE,
1919 * EVENT_SCAN_RESULTS - Scan results available
1921 * This event must be called whenever scan results are available to be
1922 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1923 * is expected to be used some time after struct wpa_driver_ops::scan()
1924 * is called. If the driver provides an unsolicited event when the scan
1925 * has been completed, this event can be used to trigger
1926 * EVENT_SCAN_RESULTS call. If such event is not available from the
1927 * driver, the driver wrapper code is expected to use a registered
1928 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1929 * scan is expected to be completed. Optional information about
1930 * completed scan can be provided with union wpa_event_data::scan_info.
1935 * EVENT_ASSOCINFO - Report optional extra information for association
1937 * This event can be used to report extra association information for
1938 * EVENT_ASSOC processing. This extra information includes IEs from
1939 * association frames and Beacon/Probe Response frames in union
1940 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1941 * EVENT_ASSOC. Alternatively, the driver interface can include
1942 * assoc_info data in the EVENT_ASSOC call if it has all the
1943 * information available at the same point.
1948 * EVENT_INTERFACE_STATUS - Report interface status changes
1950 * This optional event can be used to report changes in interface
1951 * status (interface added/removed) using union
1952 * wpa_event_data::interface_status. This can be used to trigger
1953 * wpa_supplicant to stop and re-start processing for the interface,
1954 * e.g., when a cardbus card is ejected/inserted.
1956 EVENT_INTERFACE_STATUS,
1959 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1961 * This event can be used to inform wpa_supplicant about candidates for
1962 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1963 * for scan request (ap_scan=2 mode), this event is required for
1964 * pre-authentication. If wpa_supplicant is performing scan request
1965 * (ap_scan=1), this event is optional since scan results can be used
1966 * to add pre-authentication candidates. union
1967 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
1968 * candidate and priority of the candidate, e.g., based on the signal
1969 * strength, in order to try to pre-authenticate first with candidates
1970 * that are most likely targets for re-association.
1972 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
1973 * on the candidate list. In addition, it can be called for the current
1974 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
1975 * will automatically skip pre-authentication in cases where a valid
1976 * PMKSA exists. When more than one candidate exists, this event should
1977 * be generated once for each candidate.
1979 * Driver will be notified about successful pre-authentication with
1980 * struct wpa_driver_ops::add_pmkid() calls.
1982 EVENT_PMKID_CANDIDATE,
1985 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
1987 * This event can be used to inform wpa_supplicant about desire to set
1988 * up secure direct link connection between two stations as defined in
1989 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
1990 * STAKey negotiation. The caller will need to set peer address for the
1996 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
1998 * The driver is expected to report the received FT IEs from
1999 * FT authentication sequence from the AP. The FT IEs are included in
2000 * the extra information in union wpa_event_data::ft_ies.
2005 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2007 * The driver can use this event to inform wpa_supplicant about a STA
2008 * in an IBSS with which protected frames could be exchanged. This
2009 * event starts RSN authentication with the other STA to authenticate
2010 * the STA and set up encryption keys with it.
2012 EVENT_IBSS_RSN_START,
2015 * EVENT_AUTH - Authentication result
2017 * This event should be called when authentication attempt has been
2018 * completed. This is only used if the driver supports separate
2019 * authentication step (struct wpa_driver_ops::authenticate).
2020 * Information about authentication result is included in
2021 * union wpa_event_data::auth.
2026 * EVENT_DEAUTH - Authentication lost
2028 * This event should be called when authentication is lost either due
2029 * to receiving deauthenticate frame from the AP or when sending that
2030 * frame to the current AP.
2031 * In AP mode, union wpa_event_data::deauth_info is required.
2036 * EVENT_ASSOC_REJECT - Association rejected
2038 * This event should be called when (re)association attempt has been
2039 * rejected by the AP. Information about authentication result is
2040 * included in union wpa_event_data::assoc_reject.
2045 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2047 EVENT_AUTH_TIMED_OUT,
2050 * EVENT_ASSOC_TIMED_OUT - Association timed out
2052 EVENT_ASSOC_TIMED_OUT,
2055 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2060 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2062 EVENT_WPS_BUTTON_PUSHED,
2065 * EVENT_TX_STATUS - Report TX status
2070 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2072 EVENT_RX_FROM_UNKNOWN,
2075 * EVENT_RX_MGMT - Report RX of a management frame
2080 * EVENT_RX_ACTION - Action frame received
2082 * This event is used to indicate when an Action frame has been
2083 * received. Information about the received frame is included in
2084 * union wpa_event_data::rx_action.
2089 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2091 * This event is used to indicate when the driver has started the
2092 * requested remain-on-channel duration. Information about the
2093 * operation is included in union wpa_event_data::remain_on_channel.
2095 EVENT_REMAIN_ON_CHANNEL,
2098 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2100 * This event is used to indicate when the driver has completed
2101 * remain-on-channel duration, i.e., may noot be available on the
2102 * requested channel anymore. Information about the
2103 * operation is included in union wpa_event_data::remain_on_channel.
2105 EVENT_CANCEL_REMAIN_ON_CHANNEL,
2108 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2110 * This event is used only by driver_test.c and userspace MLME.
2115 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2117 * This event is used to indicate when a Probe Request frame has been
2118 * received. Information about the received frame is included in
2119 * union wpa_event_data::rx_probe_req. The driver is required to report
2120 * these events only after successfully completed probe_req_report()
2121 * commands to request the events (i.e., report parameter is non-zero)
2122 * in station mode. In AP mode, Probe Request frames should always be
2128 * EVENT_NEW_STA - New wired device noticed
2130 * This event is used to indicate that a new device has been detected
2131 * in a network that does not use association-like functionality (i.e.,
2132 * mainly wired Ethernet). This can be used to start EAPOL
2133 * authenticator when receiving a frame from a device. The address of
2134 * the device is included in union wpa_event_data::new_sta.
2139 * EVENT_EAPOL_RX - Report received EAPOL frame
2141 * When in AP mode with hostapd, this event is required to be used to
2142 * deliver the receive EAPOL frames from the driver. With
2143 * %wpa_supplicant, this event is used only if the send_eapol() handler
2144 * is used to override the use of l2_packet for EAPOL frame TX.
2149 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
2151 * This event is used to indicate changes in the signal strength
2152 * observed in frames received from the current AP if signal strength
2153 * monitoring has been enabled with signal_monitor().
2155 EVENT_SIGNAL_CHANGE,
2158 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
2160 * This event is used to indicate that the interface was enabled after
2161 * having been previously disabled, e.g., due to rfkill.
2163 EVENT_INTERFACE_ENABLED,
2166 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
2168 * This event is used to indicate that the interface was disabled,
2169 * e.g., due to rfkill.
2171 EVENT_INTERFACE_DISABLED
2176 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
2178 union wpa_event_data {
2180 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
2182 * This structure is optional for EVENT_ASSOC calls and required for
2183 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
2184 * driver interface does not need to generate separate EVENT_ASSOCINFO
2189 * req_ies - (Re)Association Request IEs
2191 * If the driver generates WPA/RSN IE, this event data must be
2192 * returned for WPA handshake to have needed information. If
2193 * wpa_supplicant-generated WPA/RSN IE is used, this
2194 * information event is optional.
2196 * This should start with the first IE (fixed fields before IEs
2197 * are not included).
2202 * req_ies_len - Length of req_ies in bytes
2207 * resp_ies - (Re)Association Response IEs
2209 * Optional association data from the driver. This data is not
2210 * required WPA, but may be useful for some protocols and as
2211 * such, should be reported if this is available to the driver
2214 * This should start with the first IE (fixed fields before IEs
2215 * are not included).
2220 * resp_ies_len - Length of resp_ies in bytes
2222 size_t resp_ies_len;
2225 * beacon_ies - Beacon or Probe Response IEs
2227 * Optional Beacon/ProbeResp data: IEs included in Beacon or
2228 * Probe Response frames from the current AP (i.e., the one
2229 * that the client just associated with). This information is
2230 * used to update WPA/RSN IE for the AP. If this field is not
2231 * set, the results from previous scan will be used. If no
2232 * data for the new AP is found, scan results will be requested
2233 * again (without scan request). At this point, the driver is
2234 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
2237 * This should start with the first IE (fixed fields before IEs
2238 * are not included).
2240 const u8 *beacon_ies;
2243 * beacon_ies_len - Length of beacon_ies */
2244 size_t beacon_ies_len;
2247 * freq - Frequency of the operational channel in MHz
2252 * addr - Station address (for AP mode)
2258 * struct disassoc_info - Data for EVENT_DISASSOC events
2260 struct disassoc_info {
2262 * addr - Station address (for AP mode)
2267 * reason_code - Reason Code (host byte order) used in
2268 * Deauthentication frame
2273 * ie - Optional IE(s) in Disassociation frame
2278 * ie_len - Length of ie buffer in octets
2284 * struct deauth_info - Data for EVENT_DEAUTH events
2286 struct deauth_info {
2288 * addr - Station address (for AP mode)
2293 * reason_code - Reason Code (host byte order) used in
2294 * Deauthentication frame
2299 * ie - Optional IE(s) in Deauthentication frame
2304 * ie_len - Length of ie buffer in octets
2310 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
2312 struct michael_mic_failure {
2315 } michael_mic_failure;
2318 * struct interface_status - Data for EVENT_INTERFACE_STATUS
2320 struct interface_status {
2323 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
2328 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
2330 struct pmkid_candidate {
2331 /** BSSID of the PMKID candidate */
2333 /** Smaller the index, higher the priority */
2335 /** Whether RSN IE includes pre-authenticate flag */
2340 * struct stkstart - Data for EVENT_STKSTART
2347 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
2349 * During FT (IEEE 802.11r) authentication sequence, the driver is
2350 * expected to use this event to report received FT IEs (MDIE, FTIE,
2351 * RSN IE, TIE, possible resource request) to the supplicant. The FT
2352 * IEs for the next message will be delivered through the
2353 * struct wpa_driver_ops::update_ft_ies() callback.
2359 u8 target_ap[ETH_ALEN];
2360 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
2362 /** Length of ric_ies buffer in octets */
2367 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
2369 struct ibss_rsn_start {
2374 * struct auth_info - Data for EVENT_AUTH events
2385 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
2387 struct assoc_reject {
2389 * resp_ies - (Re)Association Response IEs
2391 * Optional association data from the driver. This data is not
2392 * required WPA, but may be useful for some protocols and as
2393 * such, should be reported if this is available to the driver
2396 * This should start with the first IE (fixed fields before IEs
2397 * are not included).
2402 * resp_ies_len - Length of resp_ies in bytes
2404 size_t resp_ies_len;
2407 * status_code - Status Code from (Re)association Response
2412 struct timeout_event {
2417 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
2426 * struct tx_status - Data for EVENT_TX_STATUS events
2438 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
2440 struct rx_from_unknown {
2446 * struct rx_mgmt - Data for EVENT_RX_MGMT events
2456 * struct rx_action - Data for EVENT_RX_ACTION events
2460 * da - Destination address of the received Action frame
2465 * sa - Source address of the received Action frame
2470 * bssid - Address 3 of the received Action frame
2475 * category - Action frame category
2480 * data - Action frame body after category field
2485 * len - Length of data in octets
2490 * freq - Frequency (in MHz) on which the frame was received
2496 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
2498 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
2500 struct remain_on_channel {
2502 * freq - Channel frequency in MHz
2507 * duration - Duration to remain on the channel in milliseconds
2509 unsigned int duration;
2510 } remain_on_channel;
2513 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
2514 * @aborted: Whether the scan was aborted
2515 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
2516 * @num_freqs: Number of entries in freqs array
2517 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
2519 * @num_ssids: Number of entries in ssids array
2525 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
2530 * struct mlme_rx - Data for EVENT_MLME_RX events
2541 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
2543 struct rx_probe_req {
2545 * sa - Source address of the received Probe Request frame
2550 * ie - IEs from the Probe Request body
2555 * ie_len - Length of ie buffer in octets
2561 * struct new_sta - Data for EVENT_NEW_STA events
2568 * struct eapol_rx - Data for EVENT_EAPOL_RX events
2577 * struct signal_change - Data for EVENT_SIGNAL_CHANGE events
2579 struct signal_change {
2580 int above_threshold;
2586 * wpa_supplicant_event - Report a driver event for wpa_supplicant
2587 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
2588 * with struct wpa_driver_ops::init()
2589 * @event: event type (defined above)
2590 * @data: possible extra data for the event
2592 * Driver wrapper code should call this function whenever an event is received
2595 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
2596 union wpa_event_data *data);
2600 * The following inline functions are provided for convenience to simplify
2601 * event indication for some of the common events.
2604 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
2607 union wpa_event_data event;
2608 os_memset(&event, 0, sizeof(event));
2609 event.assoc_info.req_ies = ie;
2610 event.assoc_info.req_ies_len = ielen;
2611 event.assoc_info.addr = addr;
2612 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
2615 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
2617 union wpa_event_data event;
2618 os_memset(&event, 0, sizeof(event));
2619 event.disassoc_info.addr = addr;
2620 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
2623 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
2626 union wpa_event_data event;
2627 os_memset(&event, 0, sizeof(event));
2628 event.eapol_rx.src = src;
2629 event.eapol_rx.data = data;
2630 event.eapol_rx.data_len = data_len;
2631 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
2634 #endif /* DRIVER_H */