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
486 * uapsd - UAPSD parameters for the network
487 * -1 = do not change defaults
488 * AP mode: 1 = enabled, 0 = disabled
489 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
495 * struct wpa_driver_capa - Driver capability information
497 struct wpa_driver_capa {
498 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
499 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
500 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
501 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
502 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
503 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
504 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
505 unsigned int key_mgmt;
507 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
508 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
509 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
510 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
513 #define WPA_DRIVER_AUTH_OPEN 0x00000001
514 #define WPA_DRIVER_AUTH_SHARED 0x00000002
515 #define WPA_DRIVER_AUTH_LEAP 0x00000004
518 /* Driver generated WPA/RSN IE */
519 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
520 /* Driver needs static WEP key setup after association command */
521 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
522 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
523 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
524 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
525 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
526 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
527 /* Driver provides separate commands for authentication and association (SME in
528 * wpa_supplicant). */
529 #define WPA_DRIVER_FLAGS_SME 0x00000020
530 /* Driver supports AP mode */
531 #define WPA_DRIVER_FLAGS_AP 0x00000040
532 /* Driver needs static WEP key setup after association has been completed */
533 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
534 /* Driver takes care of P2P management operations */
535 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
536 /* Driver supports concurrent P2P operations */
537 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
539 * Driver uses the initial interface as a dedicated management interface, i.e.,
540 * it cannot be used for P2P group operations.
542 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
543 /* This interface is P2P capable (P2P Device, GO, or P2P Client */
544 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
545 /* Driver supports concurrent operations on multiple channels */
546 #define WPA_DRIVER_FLAGS_MULTI_CHANNEL_CONCURRENT 0x00001000
552 * max_remain_on_chan - Maximum remain-on-channel duration in msec
554 unsigned int max_remain_on_chan;
557 * max_stations - Maximum number of associated stations the driver
558 * supports in AP mode
560 unsigned int max_stations;
566 struct hostap_sta_driver_data {
567 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
568 unsigned long current_tx_rate;
569 unsigned long inactive_msec;
571 unsigned long num_ps_buf_frames;
572 unsigned long tx_retry_failed;
573 unsigned long tx_retry_count;
578 struct hostapd_sta_add_params {
582 const u8 *supp_rates;
583 size_t supp_rates_len;
585 const struct ieee80211_ht_capabilities *ht_capabilities;
588 struct hostapd_freq_params {
593 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
594 * secondary channel below primary, 1 = HT40
595 * enabled, secondary channel above primary */
598 enum wpa_driver_if_type {
600 * WPA_IF_STATION - Station mode interface
605 * WPA_IF_AP_VLAN - AP mode VLAN interface
607 * This interface shares its address and Beacon frame with the main
613 * WPA_IF_AP_BSS - AP mode BSS interface
615 * This interface has its own address and Beacon frame.
620 * WPA_IF_P2P_GO - P2P Group Owner
625 * WPA_IF_P2P_CLIENT - P2P Client
630 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
631 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
636 struct wpa_init_params {
641 const char *test_socket;
642 int use_pae_group_addr;
646 u8 *own_addr; /* buffer for writing own MAC address */
650 struct wpa_bss_params {
651 /** Interface name (for multi-SSID/VLAN support) */
653 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
664 #define WPA_STA_AUTHORIZED BIT(0)
665 #define WPA_STA_WMM BIT(1)
666 #define WPA_STA_SHORT_PREAMBLE BIT(2)
667 #define WPA_STA_MFP BIT(3)
670 * struct wpa_driver_ops - Driver interface API definition
672 * This structure defines the API that each driver interface needs to implement
673 * for core wpa_supplicant code. All driver specific functionality is captured
676 struct wpa_driver_ops {
677 /** Name of the driver interface */
679 /** One line description of the driver interface */
683 * get_bssid - Get the current BSSID
684 * @priv: private driver interface data
685 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
687 * Returns: 0 on success, -1 on failure
689 * Query kernel driver for the current BSSID and copy it to bssid.
690 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
693 int (*get_bssid)(void *priv, u8 *bssid);
696 * get_ssid - Get the current SSID
697 * @priv: private driver interface data
698 * @ssid: buffer for SSID (at least 32 bytes)
700 * Returns: Length of the SSID on success, -1 on failure
702 * Query kernel driver for the current SSID and copy it to ssid.
703 * Returning zero is recommended if the STA is not associated.
705 * Note: SSID is an array of octets, i.e., it is not nul terminated and
706 * can, at least in theory, contain control characters (including nul)
707 * and as such, should be processed as binary data, not a printable
710 int (*get_ssid)(void *priv, u8 *ssid);
713 * set_key - Configure encryption key
714 * @ifname: Interface name (for multi-SSID/VLAN support)
715 * @priv: private driver interface data
716 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
717 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
718 * %WPA_ALG_NONE clears the key.
719 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
720 * broadcast/default keys
721 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
723 * @set_tx: configure this key as the default Tx key (only used when
724 * driver does not support separate unicast/individual key
725 * @seq: sequence number/packet number, seq_len octets, the next
726 * packet number to be used for in replay protection; configured
727 * for Rx keys (in most cases, this is only used with broadcast
728 * keys and set to zero for unicast keys)
729 * @seq_len: length of the seq, depends on the algorithm:
730 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
731 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
733 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
734 * TKIP: 32, CCMP: 16, IGTK: 16)
736 * Returns: 0 on success, -1 on failure
738 * Configure the given key for the kernel driver. If the driver
739 * supports separate individual keys (4 default keys + 1 individual),
740 * addr can be used to determine whether the key is default or
741 * individual. If only 4 keys are supported, the default key with key
742 * index 0 is used as the individual key. STA must be configured to use
743 * it as the default Tx key (set_tx is set) and accept Rx for all the
744 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
745 * broadcast keys, so key index 0 is available for this kind of
748 * Please note that TKIP keys include separate TX and RX MIC keys and
749 * some drivers may expect them in different order than wpa_supplicant
750 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
751 * will tricker Michael MIC errors. This can be fixed by changing the
752 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
753 * in driver_*.c set_key() implementation, see driver_ndis.c for an
754 * example on how this can be done.
756 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
757 const u8 *addr, int key_idx, int set_tx,
758 const u8 *seq, size_t seq_len,
759 const u8 *key, size_t key_len);
762 * init - Initialize driver interface
763 * @ctx: context to be used when calling wpa_supplicant functions,
764 * e.g., wpa_supplicant_event()
765 * @ifname: interface name, e.g., wlan0
767 * Returns: Pointer to private data, %NULL on failure
769 * Initialize driver interface, including event processing for kernel
770 * driver events (e.g., associated, scan results, Michael MIC failure).
771 * This function can allocate a private configuration data area for
772 * @ctx, file descriptor, interface name, etc. information that may be
773 * needed in future driver operations. If this is not used, non-NULL
774 * value will need to be returned because %NULL is used to indicate
775 * failure. The returned value will be used as 'void *priv' data for
776 * all other driver_ops functions.
778 * The main event loop (eloop.c) of wpa_supplicant can be used to
779 * register callback for read sockets (eloop_register_read_sock()).
781 * See below for more information about events and
782 * wpa_supplicant_event() function.
784 void * (*init)(void *ctx, const char *ifname);
787 * deinit - Deinitialize driver interface
788 * @priv: private driver interface data from init()
790 * Shut down driver interface and processing of driver events. Free
791 * private data buffer if one was allocated in init() handler.
793 void (*deinit)(void *priv);
796 * set_param - Set driver configuration parameters
797 * @priv: private driver interface data from init()
798 * @param: driver specific configuration parameters
800 * Returns: 0 on success, -1 on failure
802 * Optional handler for notifying driver interface about configuration
803 * parameters (driver_param).
805 int (*set_param)(void *priv, const char *param);
808 * set_countermeasures - Enable/disable TKIP countermeasures
809 * @priv: private driver interface data
810 * @enabled: 1 = countermeasures enabled, 0 = disabled
812 * Returns: 0 on success, -1 on failure
814 * Configure TKIP countermeasures. When these are enabled, the driver
815 * should drop all received and queued frames that are using TKIP.
817 int (*set_countermeasures)(void *priv, int enabled);
820 * deauthenticate - Request driver to deauthenticate
821 * @priv: private driver interface data
822 * @addr: peer address (BSSID of the AP)
823 * @reason_code: 16-bit reason code to be sent in the deauthentication
826 * Returns: 0 on success, -1 on failure
828 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
831 * disassociate - Request driver to disassociate
832 * @priv: private driver interface data
833 * @addr: peer address (BSSID of the AP)
834 * @reason_code: 16-bit reason code to be sent in the disassociation
837 * Returns: 0 on success, -1 on failure
839 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
842 * associate - Request driver to associate
843 * @priv: private driver interface data
844 * @params: association parameters
846 * Returns: 0 on success, -1 on failure
848 int (*associate)(void *priv,
849 struct wpa_driver_associate_params *params);
852 * add_pmkid - Add PMKSA cache entry to the driver
853 * @priv: private driver interface data
854 * @bssid: BSSID for the PMKSA cache entry
855 * @pmkid: PMKID for the PMKSA cache entry
857 * Returns: 0 on success, -1 on failure
859 * This function is called when a new PMK is received, as a result of
860 * either normal authentication or RSN pre-authentication.
862 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
863 * associate(), add_pmkid() can be used to add new PMKSA cache entries
864 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
865 * driver_ops function does not need to be implemented. Likewise, if
866 * the driver does not support WPA, this function is not needed.
868 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
871 * remove_pmkid - Remove PMKSA cache entry to the driver
872 * @priv: private driver interface data
873 * @bssid: BSSID for the PMKSA cache entry
874 * @pmkid: PMKID for the PMKSA cache entry
876 * Returns: 0 on success, -1 on failure
878 * This function is called when the supplicant drops a PMKSA cache
879 * entry for any reason.
881 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
882 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
883 * between the driver and wpa_supplicant. If the driver uses wpa_ie
884 * from wpa_supplicant, this driver_ops function does not need to be
885 * implemented. Likewise, if the driver does not support WPA, this
886 * function is not needed.
888 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
891 * flush_pmkid - Flush PMKSA cache
892 * @priv: private driver interface data
894 * Returns: 0 on success, -1 on failure
896 * This function is called when the supplicant drops all PMKSA cache
897 * entries for any reason.
899 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
900 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
901 * between the driver and wpa_supplicant. If the driver uses wpa_ie
902 * from wpa_supplicant, this driver_ops function does not need to be
903 * implemented. Likewise, if the driver does not support WPA, this
904 * function is not needed.
906 int (*flush_pmkid)(void *priv);
909 * get_capa - Get driver capabilities
910 * @priv: private driver interface data
912 * Returns: 0 on success, -1 on failure
914 * Get driver/firmware/hardware capabilities.
916 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
919 * poll - Poll driver for association information
920 * @priv: private driver interface data
922 * This is an option callback that can be used when the driver does not
923 * provide event mechanism for association events. This is called when
924 * receiving WPA EAPOL-Key messages that require association
925 * information. The driver interface is supposed to generate associnfo
926 * event before returning from this callback function. In addition, the
927 * driver interface should generate an association event after having
928 * sent out associnfo.
930 void (*poll)(void *priv);
933 * get_ifname - Get interface name
934 * @priv: private driver interface data
936 * Returns: Pointer to the interface name. This can differ from the
937 * interface name used in init() call. Init() is called first.
939 * This optional function can be used to allow the driver interface to
940 * replace the interface name with something else, e.g., based on an
941 * interface mapping from a more descriptive name.
943 const char * (*get_ifname)(void *priv);
946 * get_mac_addr - Get own MAC address
947 * @priv: private driver interface data
949 * Returns: Pointer to own MAC address or %NULL on failure
951 * This optional function can be used to get the own MAC address of the
952 * device from the driver interface code. This is only needed if the
953 * l2_packet implementation for the OS does not provide easy access to
955 const u8 * (*get_mac_addr)(void *priv);
958 * send_eapol - Optional function for sending EAPOL packets
959 * @priv: private driver interface data
960 * @dest: Destination MAC address
962 * @data: EAPOL packet starting with IEEE 802.1X header
963 * @data_len: Size of the EAPOL packet
965 * Returns: 0 on success, -1 on failure
967 * This optional function can be used to override l2_packet operations
968 * with driver specific functionality. If this function pointer is set,
969 * l2_packet module is not used at all and the driver interface code is
970 * responsible for receiving and sending all EAPOL packets. The
971 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
972 * event. The driver interface is required to implement get_mac_addr()
973 * handler if send_eapol() is used.
975 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
976 const u8 *data, size_t data_len);
979 * set_operstate - Sets device operating state to DORMANT or UP
980 * @priv: private driver interface data
981 * @state: 0 = dormant, 1 = up
982 * Returns: 0 on success, -1 on failure
984 * This is an optional function that can be used on operating systems
985 * that support a concept of controlling network device state from user
986 * space applications. This function, if set, gets called with
987 * state = 1 when authentication has been completed and with state = 0
988 * when connection is lost.
990 int (*set_operstate)(void *priv, int state);
993 * mlme_setprotection - MLME-SETPROTECTION.request primitive
994 * @priv: Private driver interface data
995 * @addr: Address of the station for which to set protection (may be
996 * %NULL for group keys)
997 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
998 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
999 * Returns: 0 on success, -1 on failure
1001 * This is an optional function that can be used to set the driver to
1002 * require protection for Tx and/or Rx frames. This uses the layer
1003 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1004 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1005 * set protection operation; instead, they set protection implicitly
1006 * based on configured keys.
1008 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1012 * get_hw_feature_data - Get hardware support data (channels and rates)
1013 * @priv: Private driver interface data
1014 * @num_modes: Variable for returning the number of returned modes
1015 * flags: Variable for returning hardware feature flags
1016 * Returns: Pointer to allocated hardware data on success or %NULL on
1017 * failure. Caller is responsible for freeing this.
1019 * This function is only needed for drivers that export MLME
1020 * (management frame processing) to %wpa_supplicant or hostapd.
1022 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1027 * set_channel - Set channel
1028 * @priv: Private driver interface data
1029 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
1030 * @chan: IEEE 802.11 channel number
1031 * @freq: Frequency of the channel in MHz
1032 * Returns: 0 on success, -1 on failure
1034 * This function is only needed for drivers that export MLME
1035 * (management frame processing) to wpa_supplicant.
1037 int (*set_channel)(void *priv, enum hostapd_hw_mode phymode, int chan,
1041 * set_ssid - Set SSID
1042 * @priv: Private driver interface data
1044 * @ssid_len: SSID length
1045 * Returns: 0 on success, -1 on failure
1047 * This function is only needed for drivers that export MLME
1048 * (management frame processing) to wpa_supplicant.
1050 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
1053 * set_bssid - Set BSSID
1054 * @priv: Private driver interface data
1056 * Returns: 0 on success, -1 on failure
1058 * This function is only needed for drivers that export MLME
1059 * (management frame processing) to wpa_supplicant.
1061 int (*set_bssid)(void *priv, const u8 *bssid);
1064 * send_mlme - Send management frame from MLME
1065 * @priv: Private driver interface data
1066 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1067 * @data_len: Size of the management frame
1068 * Returns: 0 on success, -1 on failure
1070 * This function is only needed for drivers that export MLME
1071 * (management frame processing) to wpa_supplicant.
1073 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
1076 * mlme_add_sta - Add a STA entry into the driver/netstack
1077 * @priv: Private driver interface data
1078 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1079 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
1080 * format (one octet per rate, 1 = 0.5 Mbps)
1081 * @supp_rates_len: Number of entries in supp_rates
1082 * Returns: 0 on success, -1 on failure
1084 * This function is only needed for drivers that export MLME
1085 * (management frame processing) to wpa_supplicant. When the MLME code
1086 * completes association with an AP, this function is called to
1087 * configure the driver/netstack with a STA entry for data frame
1088 * processing (TX rate control, encryption/decryption).
1090 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
1091 size_t supp_rates_len);
1094 * mlme_remove_sta - Remove a STA entry from the driver/netstack
1095 * @priv: Private driver interface data
1096 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1097 * Returns: 0 on success, -1 on failure
1099 * This function is only needed for drivers that export MLME
1100 * (management frame processing) to wpa_supplicant.
1102 int (*mlme_remove_sta)(void *priv, const u8 *addr);
1105 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1106 * @priv: Private driver interface data
1107 * @md: Mobility domain (2 octets) (also included inside ies)
1108 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1109 * @ies_len: Length of FT IEs in bytes
1110 * Returns: 0 on success, -1 on failure
1112 * The supplicant uses this callback to let the driver know that keying
1113 * material for FT is available and that the driver can use the
1114 * provided IEs in the next message in FT authentication sequence.
1116 * This function is only needed for driver that support IEEE 802.11r
1117 * (Fast BSS Transition).
1119 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1123 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1124 * @priv: Private driver interface data
1125 * @action: Action field value
1126 * @target_ap: Target AP address
1127 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1128 * @ies_len: Length of FT IEs in bytes
1129 * Returns: 0 on success, -1 on failure
1131 * The supplicant uses this callback to request the driver to transmit
1132 * an FT Action frame (action category 6) for over-the-DS fast BSS
1135 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1136 const u8 *ies, size_t ies_len);
1139 * get_scan_results2 - Fetch the latest scan results
1140 * @priv: private driver interface data
1142 * Returns: Allocated buffer of scan results (caller is responsible for
1143 * freeing the data structure) on success, NULL on failure
1145 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1148 * set_country - Set country
1149 * @priv: Private driver interface data
1150 * @alpha2: country to which to switch to
1151 * Returns: 0 on success, -1 on failure
1153 * This function is for drivers which support some form
1154 * of setting a regulatory domain.
1156 int (*set_country)(void *priv, const char *alpha2);
1159 * global_init - Global driver initialization
1160 * Returns: Pointer to private data (global), %NULL on failure
1162 * This optional function is called to initialize the driver wrapper
1163 * for global data, i.e., data that applies to all interfaces. If this
1164 * function is implemented, global_deinit() will also need to be
1165 * implemented to free the private data. The driver will also likely
1166 * use init2() function instead of init() to get the pointer to global
1167 * data available to per-interface initializer.
1169 void * (*global_init)(void);
1172 * global_deinit - Global driver deinitialization
1173 * @priv: private driver global data from global_init()
1175 * Terminate any global driver related functionality and free the
1176 * global data structure.
1178 void (*global_deinit)(void *priv);
1181 * init2 - Initialize driver interface (with global data)
1182 * @ctx: context to be used when calling wpa_supplicant functions,
1183 * e.g., wpa_supplicant_event()
1184 * @ifname: interface name, e.g., wlan0
1185 * @global_priv: private driver global data from global_init()
1186 * Returns: Pointer to private data, %NULL on failure
1188 * This function can be used instead of init() if the driver wrapper
1191 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1194 * get_interfaces - Get information about available interfaces
1195 * @global_priv: private driver global data from global_init()
1196 * Returns: Allocated buffer of interface information (caller is
1197 * responsible for freeing the data structure) on success, NULL on
1200 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1203 * scan2 - Request the driver to initiate scan
1204 * @priv: private driver interface data
1205 * @params: Scan parameters
1207 * Returns: 0 on success, -1 on failure
1209 * Once the scan results are ready, the driver should report scan
1210 * results event for wpa_supplicant which will eventually request the
1211 * results with wpa_driver_get_scan_results2().
1213 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1216 * authenticate - Request driver to authenticate
1217 * @priv: private driver interface data
1218 * @params: authentication parameters
1219 * Returns: 0 on success, -1 on failure
1221 * This is an optional function that can be used with drivers that
1222 * support separate authentication and association steps, i.e., when
1223 * wpa_supplicant can act as the SME. If not implemented, associate()
1224 * function is expected to take care of IEEE 802.11 authentication,
1227 int (*authenticate)(void *priv,
1228 struct wpa_driver_auth_params *params);
1231 * set_beacon - Set Beacon frame template
1232 * @priv: Private driver interface data
1233 * @head: Beacon head from IEEE 802.11 header to IEs before TIM IE
1234 * @head_len: Length of the head buffer in octets
1235 * @tail: Beacon tail following TIM IE
1236 * @tail_len: Length of the tail buffer in octets
1237 * @dtim_period: DTIM period
1238 * @beacon_int: Beacon interval
1239 * Returns: 0 on success, -1 on failure
1241 * This function is used to configure Beacon template for the driver in
1242 * AP mode. The driver is responsible for building the full Beacon
1243 * frame by concatenating the head part with TIM IE generated by the
1244 * driver/firmware and finishing with the tail part.
1246 int (*set_beacon)(void *priv, const u8 *head, size_t head_len,
1247 const u8 *tail, size_t tail_len, int dtim_period,
1251 * hapd_init - Initialize driver interface (hostapd only)
1252 * @hapd: Pointer to hostapd context
1253 * @params: Configuration for the driver wrapper
1254 * Returns: Pointer to private data, %NULL on failure
1256 * This function is used instead of init() or init2() when the driver
1257 * wrapper is used withh hostapd.
1259 void * (*hapd_init)(struct hostapd_data *hapd,
1260 struct wpa_init_params *params);
1263 * hapd_deinit - Deinitialize driver interface (hostapd only)
1264 * @priv: Private driver interface data from hapd_init()
1266 void (*hapd_deinit)(void *priv);
1269 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1270 * @priv: Private driver interface data
1271 * @params: BSS parameters
1272 * Returns: 0 on success, -1 on failure
1274 * This is an optional function to configure the kernel driver to
1275 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1276 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1277 * always enabled and the driver uses set_beacon() to set WPA/RSN IE
1278 * for Beacon frames.
1280 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1283 * set_privacy - Enable/disable privacy (AP only)
1284 * @priv: Private driver interface data
1285 * @enabled: 1 = privacy enabled, 0 = disabled
1286 * Returns: 0 on success, -1 on failure
1288 * This is an optional function to configure privacy field in the
1289 * kernel driver for Beacon frames. This can be left undefined (set to
1290 * %NULL) if the driver uses the Beacon template from set_beacon().
1292 int (*set_privacy)(void *priv, int enabled);
1295 * get_seqnum - Fetch the current TSC/packet number (AP only)
1296 * @ifname: The interface name (main or virtual)
1297 * @priv: Private driver interface data
1298 * @addr: MAC address of the station or %NULL for group keys
1300 * @seq: Buffer for returning the latest used TSC/packet number
1301 * Returns: 0 on success, -1 on failure
1303 * This function is used to fetch the last used TSC/packet number for
1304 * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so
1305 * there is no strict requirement on implementing support for unicast
1306 * keys (i.e., addr != %NULL).
1308 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1312 * flush - Flush all association stations (AP only)
1313 * @priv: Private driver interface data
1314 * Returns: 0 on success, -1 on failure
1316 * This function requests the driver to disassociate all associated
1317 * stations. This function does not need to be implemented if the
1318 * driver does not process association frames internally.
1320 int (*flush)(void *priv);
1323 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1324 * @priv: Private driver interface data
1325 * @elem: Information elements
1326 * @elem_len: Length of the elem buffer in octets
1327 * Returns: 0 on success, -1 on failure
1329 * This is an optional function to add information elements in the
1330 * kernel driver for Beacon and Probe Response frames. This can be left
1331 * undefined (set to %NULL) if the driver uses the Beacon template from
1334 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1337 * read_sta_data - Fetch station data (AP only)
1338 * @priv: Private driver interface data
1339 * @data: Buffer for returning station information
1340 * @addr: MAC address of the station
1341 * Returns: 0 on success, -1 on failure
1343 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1347 * hapd_send_eapol - Send an EAPOL packet (AP only)
1348 * @priv: private driver interface data
1349 * @addr: Destination MAC address
1350 * @data: EAPOL packet starting with IEEE 802.1X header
1351 * @data_len: Length of the EAPOL packet in octets
1352 * @encrypt: Whether the frame should be encrypted
1353 * @own_addr: Source MAC address
1355 * Returns: 0 on success, -1 on failure
1357 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1358 size_t data_len, int encrypt,
1359 const u8 *own_addr);
1362 * sta_deauth - Deauthenticate a station (AP only)
1363 * @priv: Private driver interface data
1364 * @own_addr: Source address and BSSID for the Deauthentication frame
1365 * @addr: MAC address of the station to deauthenticate
1366 * @reason: Reason code for the Deauthentiation frame
1367 * Returns: 0 on success, -1 on failure
1369 * This function requests a specific station to be deauthenticated and
1370 * a Deauthentication frame to be sent to it.
1372 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1376 * sta_disassoc - Disassociate a station (AP only)
1377 * @priv: Private driver interface data
1378 * @own_addr: Source address and BSSID for the Disassociation frame
1379 * @addr: MAC address of the station to disassociate
1380 * @reason: Reason code for the Disassociation frame
1381 * Returns: 0 on success, -1 on failure
1383 * This function requests a specific station to be disassociated and
1384 * a Disassociation frame to be sent to it.
1386 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1390 * sta_remove - Remove a station entry (AP only)
1391 * @priv: Private driver interface data
1392 * @addr: MAC address of the station to be removed
1393 * Returns: 0 on success, -1 on failure
1395 int (*sta_remove)(void *priv, const u8 *addr);
1398 * hapd_get_ssid - Get the current SSID (AP only)
1399 * @priv: Private driver interface data
1400 * @buf: Buffer for returning the SSID
1401 * @len: Maximum length of the buffer
1402 * Returns: Length of the SSID on success, -1 on failure
1404 * This function need not be implemented if the driver uses Beacon
1405 * template from set_beacon() and does not reply to Probe Request
1408 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1411 * hapd_set_ssid - Set SSID (AP only)
1412 * @priv: Private driver interface data
1414 * @len: Length of the SSID in octets
1415 * Returns: 0 on success, -1 on failure
1417 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1420 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1421 * @priv: Private driver interface data
1422 * @enabled: 1 = countermeasures enabled, 0 = disabled
1423 * Returns: 0 on success, -1 on failure
1425 * This need not be implemented if the driver does not take care of
1426 * association processing.
1428 int (*hapd_set_countermeasures)(void *priv, int enabled);
1431 * sta_add - Add a station entry
1432 * @priv: Private driver interface data
1433 * @params: Station parameters
1434 * Returns: 0 on success, -1 on failure
1436 * This function is used to add a station entry to the driver once the
1437 * station has completed association. This is only used if the driver
1438 * does not take care of association processing.
1440 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1443 * get_inact_sec - Get station inactivity duration (AP only)
1444 * @priv: Private driver interface data
1445 * @addr: Station address
1446 * Returns: Number of seconds station has been inactive, -1 on failure
1448 int (*get_inact_sec)(void *priv, const u8 *addr);
1451 * sta_clear_stats - Clear station statistics (AP only)
1452 * @priv: Private driver interface data
1453 * @addr: Station address
1454 * Returns: 0 on success, -1 on failure
1456 int (*sta_clear_stats)(void *priv, const u8 *addr);
1459 * set_freq - Set channel/frequency (AP only)
1460 * @priv: Private driver interface data
1461 * @freq: Channel parameters
1462 * Returns: 0 on success, -1 on failure
1464 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1467 * set_rts - Set RTS threshold
1468 * @priv: Private driver interface data
1469 * @rts: RTS threshold in octets
1470 * Returns: 0 on success, -1 on failure
1472 int (*set_rts)(void *priv, int rts);
1475 * set_frag - Set fragmentation threshold
1476 * @priv: Private driver interface data
1477 * @frag: Fragmentation threshold in octets
1478 * Returns: 0 on success, -1 on failure
1480 int (*set_frag)(void *priv, int frag);
1483 * sta_set_flags - Set station flags (AP only)
1484 * @priv: Private driver interface data
1485 * @addr: Station address
1486 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1487 * @flags_or: Bitmap of WPA_STA_* flags to add
1488 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1489 * Returns: 0 on success, -1 on failure
1491 int (*sta_set_flags)(void *priv, const u8 *addr,
1492 int total_flags, int flags_or, int flags_and);
1495 * set_rate_sets - Set supported and basic rate sets (AP only)
1496 * @priv: Private driver interface data
1497 * @supp_rates: -1 terminated array of supported rates in 100 kbps
1498 * @basic_rates: -1 terminated array of basic rates in 100 kbps
1499 * @mode: hardware mode (HOSTAPD_MODE_*)
1500 * Returns: 0 on success, -1 on failure
1502 int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
1506 * set_cts_protect - Set CTS protection mode (AP only)
1507 * @priv: Private driver interface data
1508 * @value: Whether CTS protection is enabled
1509 * Returns: 0 on success, -1 on failure
1511 int (*set_cts_protect)(void *priv, int value);
1514 * set_preamble - Set preamble mode (AP only)
1515 * @priv: Private driver interface data
1516 * @value: Whether short preamble is enabled
1517 * Returns: 0 on success, -1 on failure
1519 int (*set_preamble)(void *priv, int value);
1522 * set_short_slot_time - Set short slot time (AP only)
1523 * @priv: Private driver interface data
1524 * @value: Whether short slot time is enabled
1525 * Returns: 0 on success, -1 on failure
1527 int (*set_short_slot_time)(void *priv, int value);
1530 * set_tx_queue_params - Set TX queue parameters
1531 * @priv: Private driver interface data
1532 * @queue: Queue number
1536 * @burst_time: Maximum length for bursting in 0.1 msec units
1538 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1539 int cw_max, int burst_time);
1542 * valid_bss_mask - Validate BSSID mask
1543 * @priv: Private driver interface data
1546 * Returns: 0 if mask is valid, -1 if mask is not valid, 1 if mask can
1547 * be used, but the main interface address must be the first address in
1548 * the block if mask is applied
1550 int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
1553 * if_add - Add a virtual interface
1554 * @priv: Private driver interface data
1555 * @type: Interface type
1556 * @ifname: Interface name for the new virtual interface
1557 * @addr: Local address to use for the interface or %NULL to use the
1558 * parent interface address
1559 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1560 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1561 * not allowed (applies only to %WPA_IF_AP_BSS type)
1562 * @force_ifname: Buffer for returning an interface name that the
1563 * driver ended up using if it differs from the requested ifname
1564 * @if_addr: Buffer for returning the allocated interface address
1565 * (this may differ from the requested addr if the driver cannot
1566 * change interface address)
1567 * Returns: 0 on success, -1 on failure
1569 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1570 const char *ifname, const u8 *addr, void *bss_ctx,
1571 void **drv_priv, char *force_ifname, u8 *if_addr);
1574 * if_remove - Remove a virtual interface
1575 * @priv: Private driver interface data
1576 * @type: Interface type
1577 * @ifname: Interface name of the virtual interface to be removed
1578 * Returns: 0 on success, -1 on failure
1580 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1581 const char *ifname);
1584 * set_sta_vlan - Bind a station into a specific interface (AP only)
1585 * @priv: Private driver interface data
1586 * @ifname: Interface (main or virtual BSS or VLAN)
1587 * @addr: MAC address of the associated station
1589 * Returns: 0 on success, -1 on failure
1591 * This function is used to bind a station to a specific virtual
1592 * interface. It is only used if when virtual interfaces are supported,
1593 * e.g., to assign stations to different VLAN interfaces based on
1594 * information from a RADIUS server. This allows separate broadcast
1595 * domains to be used with a single BSS.
1597 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1601 * commit - Optional commit changes handler (AP only)
1602 * @priv: driver private data
1603 * Returns: 0 on success, -1 on failure
1605 * This optional handler function can be registered if the driver
1606 * interface implementation needs to commit changes (e.g., by setting
1607 * network interface up) at the end of initial configuration. If set,
1608 * this handler will be called after initial setup has been completed.
1610 int (*commit)(void *priv);
1613 * send_ether - Send an ethernet packet (AP only)
1614 * @priv: private driver interface data
1615 * @dst: Destination MAC address
1616 * @src: Source MAC address
1618 * @data: EAPOL packet starting with IEEE 802.1X header
1619 * @data_len: Length of the EAPOL packet in octets
1620 * Returns: 0 on success, -1 on failure
1622 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1623 const u8 *data, size_t data_len);
1626 * set_radius_acl_auth - Notification of RADIUS ACL change
1627 * @priv: Private driver interface data
1628 * @mac: MAC address of the station
1629 * @accepted: Whether the station was accepted
1630 * @session_timeout: Session timeout for the station
1631 * Returns: 0 on success, -1 on failure
1633 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1634 u32 session_timeout);
1637 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1638 * @priv: Private driver interface data
1639 * @mac: MAC address of the station
1640 * Returns: 0 on success, -1 on failure
1642 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1645 * set_ht_params - Set HT parameters (AP only)
1646 * @priv: Private driver interface data
1647 * @ht_capab: HT Capabilities IE
1648 * @ht_capab_len: Length of ht_capab in octets
1649 * @ht_oper: HT Operation IE
1650 * @ht_oper_len: Length of ht_oper in octets
1651 * Returns: 0 on success, -1 on failure
1653 int (*set_ht_params)(void *priv,
1654 const u8 *ht_capab, size_t ht_capab_len,
1655 const u8 *ht_oper, size_t ht_oper_len);
1658 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
1659 * @priv: Private driver interface data
1660 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
1661 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
1663 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
1664 * to remove extra IE(s)
1665 * Returns: 0 on success, -1 on failure
1667 * This is an optional function to add WPS IE in the kernel driver for
1668 * Beacon and Probe Response frames. This can be left undefined (set
1669 * to %NULL) if the driver uses the Beacon template from set_beacon()
1670 * and does not process Probe Request frames. If the driver takes care
1671 * of (Re)Association frame processing, the assocresp buffer includes
1672 * WPS IE(s) that need to be added to (Re)Association Response frames
1673 * whenever a (Re)Association Request frame indicated use of WPS.
1675 * This will also be used to add P2P IE(s) into Beacon/Probe Response
1676 * frames when operating as a GO. The driver is responsible for adding
1677 * timing related attributes (e.g., NoA) in addition to the IEs
1678 * included here by appending them after these buffers. This call is
1679 * also used to provide Probe Response IEs for P2P Listen state
1680 * operations for drivers that generate the Probe Response frames
1683 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
1684 const struct wpabuf *proberesp,
1685 const struct wpabuf *assocresp);
1688 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1689 * @priv: Private driver interface data
1690 * @authorized: Whether the port is authorized
1691 * Returns: 0 on success, -1 on failure
1693 int (*set_supp_port)(void *priv, int authorized);
1696 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1697 * @priv: Private driver interface data
1698 * @addr: MAC address of the associated station
1699 * @aid: Association ID
1700 * @val: 1 = bind to 4-address WDS; 0 = unbind
1701 * Returns: 0 on success, -1 on failure
1703 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val);
1706 * send_action - Transmit an Action frame
1707 * @priv: Private driver interface data
1708 * @freq: Frequency (in MHz) of the channel
1709 * @dst: Destination MAC address (Address 1)
1710 * @src: Source MAC address (Address 2)
1711 * @bssid: BSSID (Address 3)
1713 * @data_len: data length in octets
1714 * Returns: 0 on success, -1 on failure
1716 * This command can be used to request the driver to transmit an action
1717 * frame to the specified destination. If a remain-on-channel duration
1718 * is in progress, the frame is transmitted on that channel. Otherwise,
1719 * the frame is transmitted on the current operational channel if in
1720 * associated state in station mode or if operating as an AP. If none
1721 * of these conditions is in effect, send_action() cannot be used.
1723 int (*send_action)(void *priv, unsigned int freq,
1724 const u8 *dst, const u8 *src, const u8 *bssid,
1725 const u8 *data, size_t data_len);
1728 * remain_on_channel - Remain awake on a channel
1729 * @priv: Private driver interface data
1730 * @freq: Frequency (in MHz) of the channel
1731 * @duration: Duration in milliseconds
1732 * Returns: 0 on success, -1 on failure
1734 * This command is used to request the driver to remain awake on the
1735 * specified channel for the specified duration and report received
1736 * Action frames with EVENT_RX_ACTION events. Optionally, received
1737 * Probe Request frames may also be requested to be reported by calling
1738 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
1740 * The driver may not be at the requested channel when this function
1741 * returns, i.e., the return code is only indicating whether the
1742 * request was accepted. The caller will need to wait until the
1743 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
1744 * completed the channel change. This may take some time due to other
1745 * need for the radio and the caller should be prepared to timing out
1746 * its wait since there are no guarantees on when this request can be
1749 int (*remain_on_channel)(void *priv, unsigned int freq,
1750 unsigned int duration);
1753 * cancel_remain_on_channel - Cancel remain-on-channel operation
1754 * @priv: Private driver interface data
1756 * This command can be used to cancel a remain-on-channel operation
1757 * before its originally requested duration has passed. This could be
1758 * used, e.g., when remain_on_channel() is used to request extra time
1759 * to receive a response to an Action frame and the response is
1760 * received when there is still unneeded time remaining on the
1761 * remain-on-channel operation.
1763 int (*cancel_remain_on_channel)(void *priv);
1766 * probe_req_report - Request Probe Request frames to be indicated
1767 * @priv: Private driver interface data
1768 * @report: Whether to report received Probe Request frames
1769 * Returns: 0 on success, -1 on failure (or if not supported)
1771 * This command can be used to request the driver to indicate when
1772 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
1773 * Since this operation may require extra resources, e.g., due to less
1774 * optimal hardware/firmware RX filtering, many drivers may disable
1775 * Probe Request reporting at least in station mode. This command is
1776 * used to notify the driver when the Probe Request frames need to be
1777 * reported, e.g., during remain-on-channel operations.
1779 int (*probe_req_report)(void *priv, int report);
1782 * disable_11b_rates - Set whether IEEE 802.11b rates are used for TX
1783 * @priv: Private driver interface data
1784 * @disabled: Whether IEEE 802.11b rates are disabled
1785 * Returns: 0 on success, -1 on failure (or if not supported)
1787 * This command is used to disable IEEE 802.11b rates (1, 2, 5.5, and
1788 * 11 Mbps) as TX rates for data and management frames. This can be
1789 * used to optimize channel use when there is no need to support IEEE
1790 * 802.11b-only devices.
1792 int (*disable_11b_rates)(void *priv, int disabled);
1795 * deinit_ap - Deinitialize AP mode
1796 * @priv: Private driver interface data
1797 * Returns: 0 on success, -1 on failure (or if not supported)
1799 * This optional function can be used to disable AP mode related
1800 * configuration and change the driver mode to station mode to allow
1801 * normal station operations like scanning to be completed.
1803 int (*deinit_ap)(void *priv);
1806 * suspend - Notification on system suspend/hibernate event
1807 * @priv: Private driver interface data
1809 void (*suspend)(void *priv);
1812 * resume - Notification on system resume/thaw event
1813 * @priv: Private driver interface data
1815 void (*resume)(void *priv);
1818 * signal_monitor - Set signal monitoring parameters
1819 * @priv: Private driver interface data
1820 * @threshold: Threshold value for signal change events; 0 = disabled
1821 * @hysteresis: Minimum change in signal strength before indicating a
1823 * Returns: 0 on success, -1 on failure (or if not supported)
1825 * This function can be used to configure monitoring of signal strength
1826 * with the current AP. Whenever signal strength drops below the
1827 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
1828 * should be generated assuming the signal strength has changed at
1829 * least %hysteresis from the previously indicated signal change event.
1831 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
1834 * send_frame - Send IEEE 802.11 frame (testing use only)
1835 * @priv: Private driver interface data
1836 * @data: IEEE 802.11 frame with IEEE 802.11 header
1837 * @data_len: Size of the frame
1838 * @encrypt: Whether to encrypt the frame (if keys are set)
1839 * Returns: 0 on success, -1 on failure
1841 * This function is only used for debugging purposes and is not
1842 * required to be implemented for normal operations.
1844 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
1848 * shared_freq - Get operating frequency of shared interface(s)
1849 * @priv: Private driver interface data
1850 * Returns: Operating frequency in MHz, 0 if no shared operation in
1851 * use, or -1 on failure
1853 * This command can be used to request the current operating frequency
1854 * of any virtual interface that shares the same radio to provide
1855 * information for channel selection for other virtual interfaces.
1857 int (*shared_freq)(void *priv);
1860 * get_noa - Get current Notice of Absence attribute payload
1861 * @priv: Private driver interface data
1862 * @buf: Buffer for returning NoA
1863 * @buf_len: Buffer length in octets
1864 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
1865 * advertized, or -1 on failure
1867 * This function is used to fetch the current Notice of Absence
1868 * attribute value from GO.
1870 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
1873 * set_noa - Set Notice of Absence parameters for GO (testing)
1874 * @priv: Private driver interface data
1876 * @start: Start time in ms from next TBTT
1877 * @duration: Duration in ms
1878 * Returns: 0 on success or -1 on failure
1880 * This function is used to set Notice of Absence parameters for GO. It
1881 * is used only for testing. To disable NoA, all parameters are set to
1884 int (*set_noa)(void *priv, u8 count, int start, int duration);
1887 * set_p2p_powersave - Set P2P power save options
1888 * @priv: Private driver interface data
1889 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
1890 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
1891 * @ctwindow: 0.. = change (msec), -1 = no change
1892 * Returns: 0 on success or -1 on failure
1894 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
1898 * ampdu - Enable/disable aggregation
1899 * @priv: Private driver interface data
1900 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
1901 * Returns: 0 on success or -1 on failure
1903 int (*ampdu)(void *priv, int ampdu);
1906 * set_intra_bss - Enables/Disables intra BSS bridging
1908 int (*set_intra_bss)(void *priv, int enabled);
1913 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1915 enum wpa_event_type {
1917 * EVENT_ASSOC - Association completed
1919 * This event needs to be delivered when the driver completes IEEE
1920 * 802.11 association or reassociation successfully.
1921 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1922 * after this event has been generated. In addition, optional
1923 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1924 * more information about the association. If the driver interface gets
1925 * both of these events at the same time, it can also include the
1926 * assoc_info data in EVENT_ASSOC call.
1931 * EVENT_DISASSOC - Association lost
1933 * This event should be called when association is lost either due to
1934 * receiving deauthenticate or disassociate frame from the AP or when
1935 * sending either of these frames to the current AP. If the driver
1936 * supports separate deauthentication event, EVENT_DISASSOC should only
1937 * be used for disassociation and EVENT_DEAUTH for deauthentication.
1938 * In AP mode, union wpa_event_data::disassoc_info is required.
1943 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1945 * This event must be delivered when a Michael MIC error is detected by
1946 * the local driver. Additional data for event processing is
1947 * provided with union wpa_event_data::michael_mic_failure. This
1948 * information is used to request new encyption key and to initiate
1949 * TKIP countermeasures if needed.
1951 EVENT_MICHAEL_MIC_FAILURE,
1954 * EVENT_SCAN_RESULTS - Scan results available
1956 * This event must be called whenever scan results are available to be
1957 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1958 * is expected to be used some time after struct wpa_driver_ops::scan()
1959 * is called. If the driver provides an unsolicited event when the scan
1960 * has been completed, this event can be used to trigger
1961 * EVENT_SCAN_RESULTS call. If such event is not available from the
1962 * driver, the driver wrapper code is expected to use a registered
1963 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1964 * scan is expected to be completed. Optional information about
1965 * completed scan can be provided with union wpa_event_data::scan_info.
1970 * EVENT_ASSOCINFO - Report optional extra information for association
1972 * This event can be used to report extra association information for
1973 * EVENT_ASSOC processing. This extra information includes IEs from
1974 * association frames and Beacon/Probe Response frames in union
1975 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1976 * EVENT_ASSOC. Alternatively, the driver interface can include
1977 * assoc_info data in the EVENT_ASSOC call if it has all the
1978 * information available at the same point.
1983 * EVENT_INTERFACE_STATUS - Report interface status changes
1985 * This optional event can be used to report changes in interface
1986 * status (interface added/removed) using union
1987 * wpa_event_data::interface_status. This can be used to trigger
1988 * wpa_supplicant to stop and re-start processing for the interface,
1989 * e.g., when a cardbus card is ejected/inserted.
1991 EVENT_INTERFACE_STATUS,
1994 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1996 * This event can be used to inform wpa_supplicant about candidates for
1997 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1998 * for scan request (ap_scan=2 mode), this event is required for
1999 * pre-authentication. If wpa_supplicant is performing scan request
2000 * (ap_scan=1), this event is optional since scan results can be used
2001 * to add pre-authentication candidates. union
2002 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2003 * candidate and priority of the candidate, e.g., based on the signal
2004 * strength, in order to try to pre-authenticate first with candidates
2005 * that are most likely targets for re-association.
2007 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2008 * on the candidate list. In addition, it can be called for the current
2009 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2010 * will automatically skip pre-authentication in cases where a valid
2011 * PMKSA exists. When more than one candidate exists, this event should
2012 * be generated once for each candidate.
2014 * Driver will be notified about successful pre-authentication with
2015 * struct wpa_driver_ops::add_pmkid() calls.
2017 EVENT_PMKID_CANDIDATE,
2020 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2022 * This event can be used to inform wpa_supplicant about desire to set
2023 * up secure direct link connection between two stations as defined in
2024 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2025 * STAKey negotiation. The caller will need to set peer address for the
2031 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2033 * The driver is expected to report the received FT IEs from
2034 * FT authentication sequence from the AP. The FT IEs are included in
2035 * the extra information in union wpa_event_data::ft_ies.
2040 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2042 * The driver can use this event to inform wpa_supplicant about a STA
2043 * in an IBSS with which protected frames could be exchanged. This
2044 * event starts RSN authentication with the other STA to authenticate
2045 * the STA and set up encryption keys with it.
2047 EVENT_IBSS_RSN_START,
2050 * EVENT_AUTH - Authentication result
2052 * This event should be called when authentication attempt has been
2053 * completed. This is only used if the driver supports separate
2054 * authentication step (struct wpa_driver_ops::authenticate).
2055 * Information about authentication result is included in
2056 * union wpa_event_data::auth.
2061 * EVENT_DEAUTH - Authentication lost
2063 * This event should be called when authentication is lost either due
2064 * to receiving deauthenticate frame from the AP or when sending that
2065 * frame to the current AP.
2066 * In AP mode, union wpa_event_data::deauth_info is required.
2071 * EVENT_ASSOC_REJECT - Association rejected
2073 * This event should be called when (re)association attempt has been
2074 * rejected by the AP. Information about authentication result is
2075 * included in union wpa_event_data::assoc_reject.
2080 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2082 EVENT_AUTH_TIMED_OUT,
2085 * EVENT_ASSOC_TIMED_OUT - Association timed out
2087 EVENT_ASSOC_TIMED_OUT,
2090 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2095 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2097 EVENT_WPS_BUTTON_PUSHED,
2100 * EVENT_TX_STATUS - Report TX status
2105 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2107 EVENT_RX_FROM_UNKNOWN,
2110 * EVENT_RX_MGMT - Report RX of a management frame
2115 * EVENT_RX_ACTION - Action frame received
2117 * This event is used to indicate when an Action frame has been
2118 * received. Information about the received frame is included in
2119 * union wpa_event_data::rx_action.
2124 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2126 * This event is used to indicate when the driver has started the
2127 * requested remain-on-channel duration. Information about the
2128 * operation is included in union wpa_event_data::remain_on_channel.
2130 EVENT_REMAIN_ON_CHANNEL,
2133 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2135 * This event is used to indicate when the driver has completed
2136 * remain-on-channel duration, i.e., may noot be available on the
2137 * requested channel anymore. Information about the
2138 * operation is included in union wpa_event_data::remain_on_channel.
2140 EVENT_CANCEL_REMAIN_ON_CHANNEL,
2143 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2145 * This event is used only by driver_test.c and userspace MLME.
2150 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2152 * This event is used to indicate when a Probe Request frame has been
2153 * received. Information about the received frame is included in
2154 * union wpa_event_data::rx_probe_req. The driver is required to report
2155 * these events only after successfully completed probe_req_report()
2156 * commands to request the events (i.e., report parameter is non-zero)
2157 * in station mode. In AP mode, Probe Request frames should always be
2163 * EVENT_NEW_STA - New wired device noticed
2165 * This event is used to indicate that a new device has been detected
2166 * in a network that does not use association-like functionality (i.e.,
2167 * mainly wired Ethernet). This can be used to start EAPOL
2168 * authenticator when receiving a frame from a device. The address of
2169 * the device is included in union wpa_event_data::new_sta.
2174 * EVENT_EAPOL_RX - Report received EAPOL frame
2176 * When in AP mode with hostapd, this event is required to be used to
2177 * deliver the receive EAPOL frames from the driver. With
2178 * %wpa_supplicant, this event is used only if the send_eapol() handler
2179 * is used to override the use of l2_packet for EAPOL frame TX.
2184 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
2186 * This event is used to indicate changes in the signal strength
2187 * observed in frames received from the current AP if signal strength
2188 * monitoring has been enabled with signal_monitor().
2190 EVENT_SIGNAL_CHANGE,
2193 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
2195 * This event is used to indicate that the interface was enabled after
2196 * having been previously disabled, e.g., due to rfkill.
2198 EVENT_INTERFACE_ENABLED,
2201 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
2203 * This event is used to indicate that the interface was disabled,
2204 * e.g., due to rfkill.
2206 EVENT_INTERFACE_DISABLED,
2209 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
2211 * This event is used to indicate that the channel list has changed,
2212 * e.g., because of a regulatory domain change triggered by scan
2213 * results including an AP advertising a country code.
2215 EVENT_CHANNEL_LIST_CHANGED
2220 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
2222 union wpa_event_data {
2224 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
2226 * This structure is optional for EVENT_ASSOC calls and required for
2227 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
2228 * driver interface does not need to generate separate EVENT_ASSOCINFO
2233 * req_ies - (Re)Association Request IEs
2235 * If the driver generates WPA/RSN IE, this event data must be
2236 * returned for WPA handshake to have needed information. If
2237 * wpa_supplicant-generated WPA/RSN IE is used, this
2238 * information event is optional.
2240 * This should start with the first IE (fixed fields before IEs
2241 * are not included).
2246 * req_ies_len - Length of req_ies in bytes
2251 * resp_ies - (Re)Association Response IEs
2253 * Optional association data from the driver. This data is not
2254 * required WPA, but may be useful for some protocols and as
2255 * such, should be reported if this is available to the driver
2258 * This should start with the first IE (fixed fields before IEs
2259 * are not included).
2264 * resp_ies_len - Length of resp_ies in bytes
2266 size_t resp_ies_len;
2269 * beacon_ies - Beacon or Probe Response IEs
2271 * Optional Beacon/ProbeResp data: IEs included in Beacon or
2272 * Probe Response frames from the current AP (i.e., the one
2273 * that the client just associated with). This information is
2274 * used to update WPA/RSN IE for the AP. If this field is not
2275 * set, the results from previous scan will be used. If no
2276 * data for the new AP is found, scan results will be requested
2277 * again (without scan request). At this point, the driver is
2278 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
2281 * This should start with the first IE (fixed fields before IEs
2282 * are not included).
2284 const u8 *beacon_ies;
2287 * beacon_ies_len - Length of beacon_ies */
2288 size_t beacon_ies_len;
2291 * freq - Frequency of the operational channel in MHz
2296 * addr - Station address (for AP mode)
2302 * struct disassoc_info - Data for EVENT_DISASSOC events
2304 struct disassoc_info {
2306 * addr - Station address (for AP mode)
2311 * reason_code - Reason Code (host byte order) used in
2312 * Deauthentication frame
2317 * ie - Optional IE(s) in Disassociation frame
2322 * ie_len - Length of ie buffer in octets
2328 * struct deauth_info - Data for EVENT_DEAUTH events
2330 struct deauth_info {
2332 * addr - Station address (for AP mode)
2337 * reason_code - Reason Code (host byte order) used in
2338 * Deauthentication frame
2343 * ie - Optional IE(s) in Deauthentication frame
2348 * ie_len - Length of ie buffer in octets
2354 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
2356 struct michael_mic_failure {
2359 } michael_mic_failure;
2362 * struct interface_status - Data for EVENT_INTERFACE_STATUS
2364 struct interface_status {
2367 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
2372 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
2374 struct pmkid_candidate {
2375 /** BSSID of the PMKID candidate */
2377 /** Smaller the index, higher the priority */
2379 /** Whether RSN IE includes pre-authenticate flag */
2384 * struct stkstart - Data for EVENT_STKSTART
2391 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
2393 * During FT (IEEE 802.11r) authentication sequence, the driver is
2394 * expected to use this event to report received FT IEs (MDIE, FTIE,
2395 * RSN IE, TIE, possible resource request) to the supplicant. The FT
2396 * IEs for the next message will be delivered through the
2397 * struct wpa_driver_ops::update_ft_ies() callback.
2403 u8 target_ap[ETH_ALEN];
2404 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
2406 /** Length of ric_ies buffer in octets */
2411 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
2413 struct ibss_rsn_start {
2418 * struct auth_info - Data for EVENT_AUTH events
2429 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
2431 struct assoc_reject {
2433 * resp_ies - (Re)Association Response IEs
2435 * Optional association data from the driver. This data is not
2436 * required WPA, but may be useful for some protocols and as
2437 * such, should be reported if this is available to the driver
2440 * This should start with the first IE (fixed fields before IEs
2441 * are not included).
2446 * resp_ies_len - Length of resp_ies in bytes
2448 size_t resp_ies_len;
2451 * status_code - Status Code from (Re)association Response
2456 struct timeout_event {
2461 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
2470 * struct tx_status - Data for EVENT_TX_STATUS events
2482 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
2484 struct rx_from_unknown {
2490 * struct rx_mgmt - Data for EVENT_RX_MGMT events
2500 * struct rx_action - Data for EVENT_RX_ACTION events
2504 * da - Destination address of the received Action frame
2509 * sa - Source address of the received Action frame
2514 * bssid - Address 3 of the received Action frame
2519 * category - Action frame category
2524 * data - Action frame body after category field
2529 * len - Length of data in octets
2534 * freq - Frequency (in MHz) on which the frame was received
2540 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
2542 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
2544 struct remain_on_channel {
2546 * freq - Channel frequency in MHz
2551 * duration - Duration to remain on the channel in milliseconds
2553 unsigned int duration;
2554 } remain_on_channel;
2557 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
2558 * @aborted: Whether the scan was aborted
2559 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
2560 * @num_freqs: Number of entries in freqs array
2561 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
2563 * @num_ssids: Number of entries in ssids array
2569 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
2574 * struct mlme_rx - Data for EVENT_MLME_RX events
2585 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
2587 struct rx_probe_req {
2589 * sa - Source address of the received Probe Request frame
2594 * ie - IEs from the Probe Request body
2599 * ie_len - Length of ie buffer in octets
2605 * struct new_sta - Data for EVENT_NEW_STA events
2612 * struct eapol_rx - Data for EVENT_EAPOL_RX events
2621 * struct signal_change - Data for EVENT_SIGNAL_CHANGE events
2623 struct signal_change {
2625 int above_threshold;
2633 * wpa_supplicant_event - Report a driver event for wpa_supplicant
2634 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
2635 * with struct wpa_driver_ops::init()
2636 * @event: event type (defined above)
2637 * @data: possible extra data for the event
2639 * Driver wrapper code should call this function whenever an event is received
2642 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
2643 union wpa_event_data *data);
2647 * The following inline functions are provided for convenience to simplify
2648 * event indication for some of the common events.
2651 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
2654 union wpa_event_data event;
2655 os_memset(&event, 0, sizeof(event));
2656 event.assoc_info.req_ies = ie;
2657 event.assoc_info.req_ies_len = ielen;
2658 event.assoc_info.addr = addr;
2659 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
2662 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
2664 union wpa_event_data event;
2665 os_memset(&event, 0, sizeof(event));
2666 event.disassoc_info.addr = addr;
2667 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
2670 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
2673 union wpa_event_data event;
2674 os_memset(&event, 0, sizeof(event));
2675 event.eapol_rx.src = src;
2676 event.eapol_rx.data = data;
2677 event.eapol_rx.data_len = data_len;
2678 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
2681 #endif /* DRIVER_H */