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
550 * max_remain_on_chan - Maximum remain-on-channel duration in msec
552 unsigned int max_remain_on_chan;
555 * max_stations - Maximum number of associated stations the driver
556 * supports in AP mode
558 unsigned int max_stations;
564 struct hostap_sta_driver_data {
565 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
566 unsigned long current_tx_rate;
567 unsigned long inactive_msec;
569 unsigned long num_ps_buf_frames;
570 unsigned long tx_retry_failed;
571 unsigned long tx_retry_count;
576 struct hostapd_sta_add_params {
580 const u8 *supp_rates;
581 size_t supp_rates_len;
583 const struct ieee80211_ht_capabilities *ht_capabilities;
586 struct hostapd_freq_params {
591 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
592 * secondary channel below primary, 1 = HT40
593 * enabled, secondary channel above primary */
596 enum wpa_driver_if_type {
598 * WPA_IF_STATION - Station mode interface
603 * WPA_IF_AP_VLAN - AP mode VLAN interface
605 * This interface shares its address and Beacon frame with the main
611 * WPA_IF_AP_BSS - AP mode BSS interface
613 * This interface has its own address and Beacon frame.
618 * WPA_IF_P2P_GO - P2P Group Owner
623 * WPA_IF_P2P_CLIENT - P2P Client
628 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
629 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
634 struct wpa_init_params {
639 const char *test_socket;
640 int use_pae_group_addr;
644 u8 *own_addr; /* buffer for writing own MAC address */
648 struct wpa_bss_params {
649 /** Interface name (for multi-SSID/VLAN support) */
651 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
662 #define WPA_STA_AUTHORIZED BIT(0)
663 #define WPA_STA_WMM BIT(1)
664 #define WPA_STA_SHORT_PREAMBLE BIT(2)
665 #define WPA_STA_MFP BIT(3)
668 * struct wpa_driver_ops - Driver interface API definition
670 * This structure defines the API that each driver interface needs to implement
671 * for core wpa_supplicant code. All driver specific functionality is captured
674 struct wpa_driver_ops {
675 /** Name of the driver interface */
677 /** One line description of the driver interface */
681 * get_bssid - Get the current BSSID
682 * @priv: private driver interface data
683 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
685 * Returns: 0 on success, -1 on failure
687 * Query kernel driver for the current BSSID and copy it to bssid.
688 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
691 int (*get_bssid)(void *priv, u8 *bssid);
694 * get_ssid - Get the current SSID
695 * @priv: private driver interface data
696 * @ssid: buffer for SSID (at least 32 bytes)
698 * Returns: Length of the SSID on success, -1 on failure
700 * Query kernel driver for the current SSID and copy it to ssid.
701 * Returning zero is recommended if the STA is not associated.
703 * Note: SSID is an array of octets, i.e., it is not nul terminated and
704 * can, at least in theory, contain control characters (including nul)
705 * and as such, should be processed as binary data, not a printable
708 int (*get_ssid)(void *priv, u8 *ssid);
711 * set_key - Configure encryption key
712 * @ifname: Interface name (for multi-SSID/VLAN support)
713 * @priv: private driver interface data
714 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
715 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
716 * %WPA_ALG_NONE clears the key.
717 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
718 * broadcast/default keys
719 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
721 * @set_tx: configure this key as the default Tx key (only used when
722 * driver does not support separate unicast/individual key
723 * @seq: sequence number/packet number, seq_len octets, the next
724 * packet number to be used for in replay protection; configured
725 * for Rx keys (in most cases, this is only used with broadcast
726 * keys and set to zero for unicast keys)
727 * @seq_len: length of the seq, depends on the algorithm:
728 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
729 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
731 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
732 * TKIP: 32, CCMP: 16, IGTK: 16)
734 * Returns: 0 on success, -1 on failure
736 * Configure the given key for the kernel driver. If the driver
737 * supports separate individual keys (4 default keys + 1 individual),
738 * addr can be used to determine whether the key is default or
739 * individual. If only 4 keys are supported, the default key with key
740 * index 0 is used as the individual key. STA must be configured to use
741 * it as the default Tx key (set_tx is set) and accept Rx for all the
742 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
743 * broadcast keys, so key index 0 is available for this kind of
746 * Please note that TKIP keys include separate TX and RX MIC keys and
747 * some drivers may expect them in different order than wpa_supplicant
748 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
749 * will tricker Michael MIC errors. This can be fixed by changing the
750 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
751 * in driver_*.c set_key() implementation, see driver_ndis.c for an
752 * example on how this can be done.
754 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
755 const u8 *addr, int key_idx, int set_tx,
756 const u8 *seq, size_t seq_len,
757 const u8 *key, size_t key_len);
760 * init - Initialize driver interface
761 * @ctx: context to be used when calling wpa_supplicant functions,
762 * e.g., wpa_supplicant_event()
763 * @ifname: interface name, e.g., wlan0
765 * Returns: Pointer to private data, %NULL on failure
767 * Initialize driver interface, including event processing for kernel
768 * driver events (e.g., associated, scan results, Michael MIC failure).
769 * This function can allocate a private configuration data area for
770 * @ctx, file descriptor, interface name, etc. information that may be
771 * needed in future driver operations. If this is not used, non-NULL
772 * value will need to be returned because %NULL is used to indicate
773 * failure. The returned value will be used as 'void *priv' data for
774 * all other driver_ops functions.
776 * The main event loop (eloop.c) of wpa_supplicant can be used to
777 * register callback for read sockets (eloop_register_read_sock()).
779 * See below for more information about events and
780 * wpa_supplicant_event() function.
782 void * (*init)(void *ctx, const char *ifname);
785 * deinit - Deinitialize driver interface
786 * @priv: private driver interface data from init()
788 * Shut down driver interface and processing of driver events. Free
789 * private data buffer if one was allocated in init() handler.
791 void (*deinit)(void *priv);
794 * set_param - Set driver configuration parameters
795 * @priv: private driver interface data from init()
796 * @param: driver specific configuration parameters
798 * Returns: 0 on success, -1 on failure
800 * Optional handler for notifying driver interface about configuration
801 * parameters (driver_param).
803 int (*set_param)(void *priv, const char *param);
806 * set_countermeasures - Enable/disable TKIP countermeasures
807 * @priv: private driver interface data
808 * @enabled: 1 = countermeasures enabled, 0 = disabled
810 * Returns: 0 on success, -1 on failure
812 * Configure TKIP countermeasures. When these are enabled, the driver
813 * should drop all received and queued frames that are using TKIP.
815 int (*set_countermeasures)(void *priv, int enabled);
818 * deauthenticate - Request driver to deauthenticate
819 * @priv: private driver interface data
820 * @addr: peer address (BSSID of the AP)
821 * @reason_code: 16-bit reason code to be sent in the deauthentication
824 * Returns: 0 on success, -1 on failure
826 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
829 * disassociate - Request driver to disassociate
830 * @priv: private driver interface data
831 * @addr: peer address (BSSID of the AP)
832 * @reason_code: 16-bit reason code to be sent in the disassociation
835 * Returns: 0 on success, -1 on failure
837 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
840 * associate - Request driver to associate
841 * @priv: private driver interface data
842 * @params: association parameters
844 * Returns: 0 on success, -1 on failure
846 int (*associate)(void *priv,
847 struct wpa_driver_associate_params *params);
850 * add_pmkid - Add PMKSA cache entry to the driver
851 * @priv: private driver interface data
852 * @bssid: BSSID for the PMKSA cache entry
853 * @pmkid: PMKID for the PMKSA cache entry
855 * Returns: 0 on success, -1 on failure
857 * This function is called when a new PMK is received, as a result of
858 * either normal authentication or RSN pre-authentication.
860 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
861 * associate(), add_pmkid() can be used to add new PMKSA cache entries
862 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
863 * driver_ops function does not need to be implemented. Likewise, if
864 * the driver does not support WPA, this function is not needed.
866 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
869 * remove_pmkid - Remove PMKSA cache entry to the driver
870 * @priv: private driver interface data
871 * @bssid: BSSID for the PMKSA cache entry
872 * @pmkid: PMKID for the PMKSA cache entry
874 * Returns: 0 on success, -1 on failure
876 * This function is called when the supplicant drops a PMKSA cache
877 * entry for any reason.
879 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
880 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
881 * between the driver and wpa_supplicant. If the driver uses wpa_ie
882 * from wpa_supplicant, this driver_ops function does not need to be
883 * implemented. Likewise, if the driver does not support WPA, this
884 * function is not needed.
886 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
889 * flush_pmkid - Flush PMKSA cache
890 * @priv: private driver interface data
892 * Returns: 0 on success, -1 on failure
894 * This function is called when the supplicant drops all PMKSA cache
895 * entries for any reason.
897 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
898 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
899 * between the driver and wpa_supplicant. If the driver uses wpa_ie
900 * from wpa_supplicant, this driver_ops function does not need to be
901 * implemented. Likewise, if the driver does not support WPA, this
902 * function is not needed.
904 int (*flush_pmkid)(void *priv);
907 * get_capa - Get driver capabilities
908 * @priv: private driver interface data
910 * Returns: 0 on success, -1 on failure
912 * Get driver/firmware/hardware capabilities.
914 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
917 * poll - Poll driver for association information
918 * @priv: private driver interface data
920 * This is an option callback that can be used when the driver does not
921 * provide event mechanism for association events. This is called when
922 * receiving WPA EAPOL-Key messages that require association
923 * information. The driver interface is supposed to generate associnfo
924 * event before returning from this callback function. In addition, the
925 * driver interface should generate an association event after having
926 * sent out associnfo.
928 void (*poll)(void *priv);
931 * get_ifname - Get interface name
932 * @priv: private driver interface data
934 * Returns: Pointer to the interface name. This can differ from the
935 * interface name used in init() call. Init() is called first.
937 * This optional function can be used to allow the driver interface to
938 * replace the interface name with something else, e.g., based on an
939 * interface mapping from a more descriptive name.
941 const char * (*get_ifname)(void *priv);
944 * get_mac_addr - Get own MAC address
945 * @priv: private driver interface data
947 * Returns: Pointer to own MAC address or %NULL on failure
949 * This optional function can be used to get the own MAC address of the
950 * device from the driver interface code. This is only needed if the
951 * l2_packet implementation for the OS does not provide easy access to
953 const u8 * (*get_mac_addr)(void *priv);
956 * send_eapol - Optional function for sending EAPOL packets
957 * @priv: private driver interface data
958 * @dest: Destination MAC address
960 * @data: EAPOL packet starting with IEEE 802.1X header
961 * @data_len: Size of the EAPOL packet
963 * Returns: 0 on success, -1 on failure
965 * This optional function can be used to override l2_packet operations
966 * with driver specific functionality. If this function pointer is set,
967 * l2_packet module is not used at all and the driver interface code is
968 * responsible for receiving and sending all EAPOL packets. The
969 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
970 * event. The driver interface is required to implement get_mac_addr()
971 * handler if send_eapol() is used.
973 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
974 const u8 *data, size_t data_len);
977 * set_operstate - Sets device operating state to DORMANT or UP
978 * @priv: private driver interface data
979 * @state: 0 = dormant, 1 = up
980 * Returns: 0 on success, -1 on failure
982 * This is an optional function that can be used on operating systems
983 * that support a concept of controlling network device state from user
984 * space applications. This function, if set, gets called with
985 * state = 1 when authentication has been completed and with state = 0
986 * when connection is lost.
988 int (*set_operstate)(void *priv, int state);
991 * mlme_setprotection - MLME-SETPROTECTION.request primitive
992 * @priv: Private driver interface data
993 * @addr: Address of the station for which to set protection (may be
994 * %NULL for group keys)
995 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
996 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
997 * Returns: 0 on success, -1 on failure
999 * This is an optional function that can be used to set the driver to
1000 * require protection for Tx and/or Rx frames. This uses the layer
1001 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1002 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1003 * set protection operation; instead, they set protection implicitly
1004 * based on configured keys.
1006 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1010 * get_hw_feature_data - Get hardware support data (channels and rates)
1011 * @priv: Private driver interface data
1012 * @num_modes: Variable for returning the number of returned modes
1013 * flags: Variable for returning hardware feature flags
1014 * Returns: Pointer to allocated hardware data on success or %NULL on
1015 * failure. Caller is responsible for freeing this.
1017 * This function is only needed for drivers that export MLME
1018 * (management frame processing) to %wpa_supplicant or hostapd.
1020 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1025 * set_channel - Set channel
1026 * @priv: Private driver interface data
1027 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
1028 * @chan: IEEE 802.11 channel number
1029 * @freq: Frequency of the channel in MHz
1030 * Returns: 0 on success, -1 on failure
1032 * This function is only needed for drivers that export MLME
1033 * (management frame processing) to wpa_supplicant.
1035 int (*set_channel)(void *priv, enum hostapd_hw_mode phymode, int chan,
1039 * set_ssid - Set SSID
1040 * @priv: Private driver interface data
1042 * @ssid_len: SSID length
1043 * Returns: 0 on success, -1 on failure
1045 * This function is only needed for drivers that export MLME
1046 * (management frame processing) to wpa_supplicant.
1048 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
1051 * set_bssid - Set BSSID
1052 * @priv: Private driver interface data
1054 * Returns: 0 on success, -1 on failure
1056 * This function is only needed for drivers that export MLME
1057 * (management frame processing) to wpa_supplicant.
1059 int (*set_bssid)(void *priv, const u8 *bssid);
1062 * send_mlme - Send management frame from MLME
1063 * @priv: Private driver interface data
1064 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1065 * @data_len: Size of the management frame
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.
1071 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
1074 * mlme_add_sta - Add a STA entry into the driver/netstack
1075 * @priv: Private driver interface data
1076 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1077 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
1078 * format (one octet per rate, 1 = 0.5 Mbps)
1079 * @supp_rates_len: Number of entries in supp_rates
1080 * Returns: 0 on success, -1 on failure
1082 * This function is only needed for drivers that export MLME
1083 * (management frame processing) to wpa_supplicant. When the MLME code
1084 * completes association with an AP, this function is called to
1085 * configure the driver/netstack with a STA entry for data frame
1086 * processing (TX rate control, encryption/decryption).
1088 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
1089 size_t supp_rates_len);
1092 * mlme_remove_sta - Remove a STA entry from the driver/netstack
1093 * @priv: Private driver interface data
1094 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1095 * Returns: 0 on success, -1 on failure
1097 * This function is only needed for drivers that export MLME
1098 * (management frame processing) to wpa_supplicant.
1100 int (*mlme_remove_sta)(void *priv, const u8 *addr);
1103 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1104 * @priv: Private driver interface data
1105 * @md: Mobility domain (2 octets) (also included inside ies)
1106 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1107 * @ies_len: Length of FT IEs in bytes
1108 * Returns: 0 on success, -1 on failure
1110 * The supplicant uses this callback to let the driver know that keying
1111 * material for FT is available and that the driver can use the
1112 * provided IEs in the next message in FT authentication sequence.
1114 * This function is only needed for driver that support IEEE 802.11r
1115 * (Fast BSS Transition).
1117 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1121 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1122 * @priv: Private driver interface data
1123 * @action: Action field value
1124 * @target_ap: Target AP address
1125 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1126 * @ies_len: Length of FT IEs in bytes
1127 * Returns: 0 on success, -1 on failure
1129 * The supplicant uses this callback to request the driver to transmit
1130 * an FT Action frame (action category 6) for over-the-DS fast BSS
1133 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1134 const u8 *ies, size_t ies_len);
1137 * get_scan_results2 - Fetch the latest scan results
1138 * @priv: private driver interface data
1140 * Returns: Allocated buffer of scan results (caller is responsible for
1141 * freeing the data structure) on success, NULL on failure
1143 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1146 * set_country - Set country
1147 * @priv: Private driver interface data
1148 * @alpha2: country to which to switch to
1149 * Returns: 0 on success, -1 on failure
1151 * This function is for drivers which support some form
1152 * of setting a regulatory domain.
1154 int (*set_country)(void *priv, const char *alpha2);
1157 * global_init - Global driver initialization
1158 * Returns: Pointer to private data (global), %NULL on failure
1160 * This optional function is called to initialize the driver wrapper
1161 * for global data, i.e., data that applies to all interfaces. If this
1162 * function is implemented, global_deinit() will also need to be
1163 * implemented to free the private data. The driver will also likely
1164 * use init2() function instead of init() to get the pointer to global
1165 * data available to per-interface initializer.
1167 void * (*global_init)(void);
1170 * global_deinit - Global driver deinitialization
1171 * @priv: private driver global data from global_init()
1173 * Terminate any global driver related functionality and free the
1174 * global data structure.
1176 void (*global_deinit)(void *priv);
1179 * init2 - Initialize driver interface (with global data)
1180 * @ctx: context to be used when calling wpa_supplicant functions,
1181 * e.g., wpa_supplicant_event()
1182 * @ifname: interface name, e.g., wlan0
1183 * @global_priv: private driver global data from global_init()
1184 * Returns: Pointer to private data, %NULL on failure
1186 * This function can be used instead of init() if the driver wrapper
1189 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1192 * get_interfaces - Get information about available interfaces
1193 * @global_priv: private driver global data from global_init()
1194 * Returns: Allocated buffer of interface information (caller is
1195 * responsible for freeing the data structure) on success, NULL on
1198 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1201 * scan2 - Request the driver to initiate scan
1202 * @priv: private driver interface data
1203 * @params: Scan parameters
1205 * Returns: 0 on success, -1 on failure
1207 * Once the scan results are ready, the driver should report scan
1208 * results event for wpa_supplicant which will eventually request the
1209 * results with wpa_driver_get_scan_results2().
1211 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1214 * authenticate - Request driver to authenticate
1215 * @priv: private driver interface data
1216 * @params: authentication parameters
1217 * Returns: 0 on success, -1 on failure
1219 * This is an optional function that can be used with drivers that
1220 * support separate authentication and association steps, i.e., when
1221 * wpa_supplicant can act as the SME. If not implemented, associate()
1222 * function is expected to take care of IEEE 802.11 authentication,
1225 int (*authenticate)(void *priv,
1226 struct wpa_driver_auth_params *params);
1229 * set_beacon - Set Beacon frame template
1230 * @priv: Private driver interface data
1231 * @head: Beacon head from IEEE 802.11 header to IEs before TIM IE
1232 * @head_len: Length of the head buffer in octets
1233 * @tail: Beacon tail following TIM IE
1234 * @tail_len: Length of the tail buffer in octets
1235 * @dtim_period: DTIM period
1236 * @beacon_int: Beacon interval
1237 * Returns: 0 on success, -1 on failure
1239 * This function is used to configure Beacon template for the driver in
1240 * AP mode. The driver is responsible for building the full Beacon
1241 * frame by concatenating the head part with TIM IE generated by the
1242 * driver/firmware and finishing with the tail part.
1244 int (*set_beacon)(void *priv, const u8 *head, size_t head_len,
1245 const u8 *tail, size_t tail_len, int dtim_period,
1249 * hapd_init - Initialize driver interface (hostapd only)
1250 * @hapd: Pointer to hostapd context
1251 * @params: Configuration for the driver wrapper
1252 * Returns: Pointer to private data, %NULL on failure
1254 * This function is used instead of init() or init2() when the driver
1255 * wrapper is used withh hostapd.
1257 void * (*hapd_init)(struct hostapd_data *hapd,
1258 struct wpa_init_params *params);
1261 * hapd_deinit - Deinitialize driver interface (hostapd only)
1262 * @priv: Private driver interface data from hapd_init()
1264 void (*hapd_deinit)(void *priv);
1267 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1268 * @priv: Private driver interface data
1269 * @params: BSS parameters
1270 * Returns: 0 on success, -1 on failure
1272 * This is an optional function to configure the kernel driver to
1273 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1274 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1275 * always enabled and the driver uses set_beacon() to set WPA/RSN IE
1276 * for Beacon frames.
1278 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1281 * set_privacy - Enable/disable privacy (AP only)
1282 * @priv: Private driver interface data
1283 * @enabled: 1 = privacy enabled, 0 = disabled
1284 * Returns: 0 on success, -1 on failure
1286 * This is an optional function to configure privacy field in the
1287 * kernel driver for Beacon frames. This can be left undefined (set to
1288 * %NULL) if the driver uses the Beacon template from set_beacon().
1290 int (*set_privacy)(void *priv, int enabled);
1293 * get_seqnum - Fetch the current TSC/packet number (AP only)
1294 * @ifname: The interface name (main or virtual)
1295 * @priv: Private driver interface data
1296 * @addr: MAC address of the station or %NULL for group keys
1298 * @seq: Buffer for returning the latest used TSC/packet number
1299 * Returns: 0 on success, -1 on failure
1301 * This function is used to fetch the last used TSC/packet number for
1302 * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so
1303 * there is no strict requirement on implementing support for unicast
1304 * keys (i.e., addr != %NULL).
1306 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1310 * flush - Flush all association stations (AP only)
1311 * @priv: Private driver interface data
1312 * Returns: 0 on success, -1 on failure
1314 * This function requests the driver to disassociate all associated
1315 * stations. This function does not need to be implemented if the
1316 * driver does not process association frames internally.
1318 int (*flush)(void *priv);
1321 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1322 * @priv: Private driver interface data
1323 * @elem: Information elements
1324 * @elem_len: Length of the elem buffer in octets
1325 * Returns: 0 on success, -1 on failure
1327 * This is an optional function to add information elements in the
1328 * kernel driver for Beacon and Probe Response frames. This can be left
1329 * undefined (set to %NULL) if the driver uses the Beacon template from
1332 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1335 * read_sta_data - Fetch station data (AP only)
1336 * @priv: Private driver interface data
1337 * @data: Buffer for returning station information
1338 * @addr: MAC address of the station
1339 * Returns: 0 on success, -1 on failure
1341 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1345 * hapd_send_eapol - Send an EAPOL packet (AP only)
1346 * @priv: private driver interface data
1347 * @addr: Destination MAC address
1348 * @data: EAPOL packet starting with IEEE 802.1X header
1349 * @data_len: Length of the EAPOL packet in octets
1350 * @encrypt: Whether the frame should be encrypted
1351 * @own_addr: Source MAC address
1353 * Returns: 0 on success, -1 on failure
1355 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1356 size_t data_len, int encrypt,
1357 const u8 *own_addr);
1360 * sta_deauth - Deauthenticate a station (AP only)
1361 * @priv: Private driver interface data
1362 * @own_addr: Source address and BSSID for the Deauthentication frame
1363 * @addr: MAC address of the station to deauthenticate
1364 * @reason: Reason code for the Deauthentiation frame
1365 * Returns: 0 on success, -1 on failure
1367 * This function requests a specific station to be deauthenticated and
1368 * a Deauthentication frame to be sent to it.
1370 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1374 * sta_disassoc - Disassociate a station (AP only)
1375 * @priv: Private driver interface data
1376 * @own_addr: Source address and BSSID for the Disassociation frame
1377 * @addr: MAC address of the station to disassociate
1378 * @reason: Reason code for the Disassociation frame
1379 * Returns: 0 on success, -1 on failure
1381 * This function requests a specific station to be disassociated and
1382 * a Disassociation frame to be sent to it.
1384 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1388 * sta_remove - Remove a station entry (AP only)
1389 * @priv: Private driver interface data
1390 * @addr: MAC address of the station to be removed
1391 * Returns: 0 on success, -1 on failure
1393 int (*sta_remove)(void *priv, const u8 *addr);
1396 * hapd_get_ssid - Get the current SSID (AP only)
1397 * @priv: Private driver interface data
1398 * @buf: Buffer for returning the SSID
1399 * @len: Maximum length of the buffer
1400 * Returns: Length of the SSID on success, -1 on failure
1402 * This function need not be implemented if the driver uses Beacon
1403 * template from set_beacon() and does not reply to Probe Request
1406 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1409 * hapd_set_ssid - Set SSID (AP only)
1410 * @priv: Private driver interface data
1412 * @len: Length of the SSID in octets
1413 * Returns: 0 on success, -1 on failure
1415 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1418 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1419 * @priv: Private driver interface data
1420 * @enabled: 1 = countermeasures enabled, 0 = disabled
1421 * Returns: 0 on success, -1 on failure
1423 * This need not be implemented if the driver does not take care of
1424 * association processing.
1426 int (*hapd_set_countermeasures)(void *priv, int enabled);
1429 * sta_add - Add a station entry
1430 * @priv: Private driver interface data
1431 * @params: Station parameters
1432 * Returns: 0 on success, -1 on failure
1434 * This function is used to add a station entry to the driver once the
1435 * station has completed association. This is only used if the driver
1436 * does not take care of association processing.
1438 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1441 * get_inact_sec - Get station inactivity duration (AP only)
1442 * @priv: Private driver interface data
1443 * @addr: Station address
1444 * Returns: Number of seconds station has been inactive, -1 on failure
1446 int (*get_inact_sec)(void *priv, const u8 *addr);
1449 * sta_clear_stats - Clear station statistics (AP only)
1450 * @priv: Private driver interface data
1451 * @addr: Station address
1452 * Returns: 0 on success, -1 on failure
1454 int (*sta_clear_stats)(void *priv, const u8 *addr);
1457 * set_freq - Set channel/frequency (AP only)
1458 * @priv: Private driver interface data
1459 * @freq: Channel parameters
1460 * Returns: 0 on success, -1 on failure
1462 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1465 * set_rts - Set RTS threshold
1466 * @priv: Private driver interface data
1467 * @rts: RTS threshold in octets
1468 * Returns: 0 on success, -1 on failure
1470 int (*set_rts)(void *priv, int rts);
1473 * set_frag - Set fragmentation threshold
1474 * @priv: Private driver interface data
1475 * @frag: Fragmentation threshold in octets
1476 * Returns: 0 on success, -1 on failure
1478 int (*set_frag)(void *priv, int frag);
1481 * sta_set_flags - Set station flags (AP only)
1482 * @priv: Private driver interface data
1483 * @addr: Station address
1484 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1485 * @flags_or: Bitmap of WPA_STA_* flags to add
1486 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1487 * Returns: 0 on success, -1 on failure
1489 int (*sta_set_flags)(void *priv, const u8 *addr,
1490 int total_flags, int flags_or, int flags_and);
1493 * set_rate_sets - Set supported and basic rate sets (AP only)
1494 * @priv: Private driver interface data
1495 * @supp_rates: -1 terminated array of supported rates in 100 kbps
1496 * @basic_rates: -1 terminated array of basic rates in 100 kbps
1497 * @mode: hardware mode (HOSTAPD_MODE_*)
1498 * Returns: 0 on success, -1 on failure
1500 int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
1504 * set_cts_protect - Set CTS protection mode (AP only)
1505 * @priv: Private driver interface data
1506 * @value: Whether CTS protection is enabled
1507 * Returns: 0 on success, -1 on failure
1509 int (*set_cts_protect)(void *priv, int value);
1512 * set_preamble - Set preamble mode (AP only)
1513 * @priv: Private driver interface data
1514 * @value: Whether short preamble is enabled
1515 * Returns: 0 on success, -1 on failure
1517 int (*set_preamble)(void *priv, int value);
1520 * set_short_slot_time - Set short slot time (AP only)
1521 * @priv: Private driver interface data
1522 * @value: Whether short slot time is enabled
1523 * Returns: 0 on success, -1 on failure
1525 int (*set_short_slot_time)(void *priv, int value);
1528 * set_tx_queue_params - Set TX queue parameters
1529 * @priv: Private driver interface data
1530 * @queue: Queue number
1534 * @burst_time: Maximum length for bursting in 0.1 msec units
1536 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1537 int cw_max, int burst_time);
1540 * valid_bss_mask - Validate BSSID mask
1541 * @priv: Private driver interface data
1544 * Returns: 0 if mask is valid, -1 if mask is not valid, 1 if mask can
1545 * be used, but the main interface address must be the first address in
1546 * the block if mask is applied
1548 int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
1551 * if_add - Add a virtual interface
1552 * @priv: Private driver interface data
1553 * @type: Interface type
1554 * @ifname: Interface name for the new virtual interface
1555 * @addr: Local address to use for the interface or %NULL to use the
1556 * parent interface address
1557 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1558 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1559 * not allowed (applies only to %WPA_IF_AP_BSS type)
1560 * @force_ifname: Buffer for returning an interface name that the
1561 * driver ended up using if it differs from the requested ifname
1562 * @if_addr: Buffer for returning the allocated interface address
1563 * (this may differ from the requested addr if the driver cannot
1564 * change interface address)
1565 * Returns: 0 on success, -1 on failure
1567 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1568 const char *ifname, const u8 *addr, void *bss_ctx,
1569 void **drv_priv, char *force_ifname, u8 *if_addr);
1572 * if_remove - Remove a virtual interface
1573 * @priv: Private driver interface data
1574 * @type: Interface type
1575 * @ifname: Interface name of the virtual interface to be removed
1576 * Returns: 0 on success, -1 on failure
1578 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1579 const char *ifname);
1582 * set_sta_vlan - Bind a station into a specific interface (AP only)
1583 * @priv: Private driver interface data
1584 * @ifname: Interface (main or virtual BSS or VLAN)
1585 * @addr: MAC address of the associated station
1587 * Returns: 0 on success, -1 on failure
1589 * This function is used to bind a station to a specific virtual
1590 * interface. It is only used if when virtual interfaces are supported,
1591 * e.g., to assign stations to different VLAN interfaces based on
1592 * information from a RADIUS server. This allows separate broadcast
1593 * domains to be used with a single BSS.
1595 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1599 * commit - Optional commit changes handler (AP only)
1600 * @priv: driver private data
1601 * Returns: 0 on success, -1 on failure
1603 * This optional handler function can be registered if the driver
1604 * interface implementation needs to commit changes (e.g., by setting
1605 * network interface up) at the end of initial configuration. If set,
1606 * this handler will be called after initial setup has been completed.
1608 int (*commit)(void *priv);
1611 * send_ether - Send an ethernet packet (AP only)
1612 * @priv: private driver interface data
1613 * @dst: Destination MAC address
1614 * @src: Source MAC address
1616 * @data: EAPOL packet starting with IEEE 802.1X header
1617 * @data_len: Length of the EAPOL packet in octets
1618 * Returns: 0 on success, -1 on failure
1620 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1621 const u8 *data, size_t data_len);
1624 * set_radius_acl_auth - Notification of RADIUS ACL change
1625 * @priv: Private driver interface data
1626 * @mac: MAC address of the station
1627 * @accepted: Whether the station was accepted
1628 * @session_timeout: Session timeout for the station
1629 * Returns: 0 on success, -1 on failure
1631 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1632 u32 session_timeout);
1635 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1636 * @priv: Private driver interface data
1637 * @mac: MAC address of the station
1638 * Returns: 0 on success, -1 on failure
1640 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1643 * set_ht_params - Set HT parameters (AP only)
1644 * @priv: Private driver interface data
1645 * @ht_capab: HT Capabilities IE
1646 * @ht_capab_len: Length of ht_capab in octets
1647 * @ht_oper: HT Operation IE
1648 * @ht_oper_len: Length of ht_oper in octets
1649 * Returns: 0 on success, -1 on failure
1651 int (*set_ht_params)(void *priv,
1652 const u8 *ht_capab, size_t ht_capab_len,
1653 const u8 *ht_oper, size_t ht_oper_len);
1656 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
1657 * @priv: Private driver interface data
1658 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
1659 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
1661 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
1662 * to remove extra IE(s)
1663 * Returns: 0 on success, -1 on failure
1665 * This is an optional function to add WPS IE in the kernel driver for
1666 * Beacon and Probe Response frames. This can be left undefined (set
1667 * to %NULL) if the driver uses the Beacon template from set_beacon()
1668 * and does not process Probe Request frames. If the driver takes care
1669 * of (Re)Association frame processing, the assocresp buffer includes
1670 * WPS IE(s) that need to be added to (Re)Association Response frames
1671 * whenever a (Re)Association Request frame indicated use of WPS.
1673 * This will also be used to add P2P IE(s) into Beacon/Probe Response
1674 * frames when operating as a GO. The driver is responsible for adding
1675 * timing related attributes (e.g., NoA) in addition to the IEs
1676 * included here by appending them after these buffers. This call is
1677 * also used to provide Probe Response IEs for P2P Listen state
1678 * operations for drivers that generate the Probe Response frames
1681 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
1682 const struct wpabuf *proberesp,
1683 const struct wpabuf *assocresp);
1686 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1687 * @priv: Private driver interface data
1688 * @authorized: Whether the port is authorized
1689 * Returns: 0 on success, -1 on failure
1691 int (*set_supp_port)(void *priv, int authorized);
1694 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1695 * @priv: Private driver interface data
1696 * @addr: MAC address of the associated station
1697 * @aid: Association ID
1698 * @val: 1 = bind to 4-address WDS; 0 = unbind
1699 * Returns: 0 on success, -1 on failure
1701 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val);
1704 * send_action - Transmit an Action frame
1705 * @priv: Private driver interface data
1706 * @freq: Frequency (in MHz) of the channel
1707 * @dst: Destination MAC address (Address 1)
1708 * @src: Source MAC address (Address 2)
1709 * @bssid: BSSID (Address 3)
1711 * @data_len: data length in octets
1712 * Returns: 0 on success, -1 on failure
1714 * This command can be used to request the driver to transmit an action
1715 * frame to the specified destination. If a remain-on-channel duration
1716 * is in progress, the frame is transmitted on that channel. Otherwise,
1717 * the frame is transmitted on the current operational channel if in
1718 * associated state in station mode or if operating as an AP. If none
1719 * of these conditions is in effect, send_action() cannot be used.
1721 int (*send_action)(void *priv, unsigned int freq,
1722 const u8 *dst, const u8 *src, const u8 *bssid,
1723 const u8 *data, size_t data_len);
1726 * remain_on_channel - Remain awake on a channel
1727 * @priv: Private driver interface data
1728 * @freq: Frequency (in MHz) of the channel
1729 * @duration: Duration in milliseconds
1730 * Returns: 0 on success, -1 on failure
1732 * This command is used to request the driver to remain awake on the
1733 * specified channel for the specified duration and report received
1734 * Action frames with EVENT_RX_ACTION events. Optionally, received
1735 * Probe Request frames may also be requested to be reported by calling
1736 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
1738 * The driver may not be at the requested channel when this function
1739 * returns, i.e., the return code is only indicating whether the
1740 * request was accepted. The caller will need to wait until the
1741 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
1742 * completed the channel change. This may take some time due to other
1743 * need for the radio and the caller should be prepared to timing out
1744 * its wait since there are no guarantees on when this request can be
1747 int (*remain_on_channel)(void *priv, unsigned int freq,
1748 unsigned int duration);
1751 * cancel_remain_on_channel - Cancel remain-on-channel operation
1752 * @priv: Private driver interface data
1754 * This command can be used to cancel a remain-on-channel operation
1755 * before its originally requested duration has passed. This could be
1756 * used, e.g., when remain_on_channel() is used to request extra time
1757 * to receive a response to an Action frame and the response is
1758 * received when there is still unneeded time remaining on the
1759 * remain-on-channel operation.
1761 int (*cancel_remain_on_channel)(void *priv);
1764 * probe_req_report - Request Probe Request frames to be indicated
1765 * @priv: Private driver interface data
1766 * @report: Whether to report received Probe Request frames
1767 * Returns: 0 on success, -1 on failure (or if not supported)
1769 * This command can be used to request the driver to indicate when
1770 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
1771 * Since this operation may require extra resources, e.g., due to less
1772 * optimal hardware/firmware RX filtering, many drivers may disable
1773 * Probe Request reporting at least in station mode. This command is
1774 * used to notify the driver when the Probe Request frames need to be
1775 * reported, e.g., during remain-on-channel operations.
1777 int (*probe_req_report)(void *priv, int report);
1780 * disable_11b_rates - Set whether IEEE 802.11b rates are used for TX
1781 * @priv: Private driver interface data
1782 * @disabled: Whether IEEE 802.11b rates are disabled
1783 * Returns: 0 on success, -1 on failure (or if not supported)
1785 * This command is used to disable IEEE 802.11b rates (1, 2, 5.5, and
1786 * 11 Mbps) as TX rates for data and management frames. This can be
1787 * used to optimize channel use when there is no need to support IEEE
1788 * 802.11b-only devices.
1790 int (*disable_11b_rates)(void *priv, int disabled);
1793 * deinit_ap - Deinitialize AP mode
1794 * @priv: Private driver interface data
1795 * Returns: 0 on success, -1 on failure (or if not supported)
1797 * This optional function can be used to disable AP mode related
1798 * configuration and change the driver mode to station mode to allow
1799 * normal station operations like scanning to be completed.
1801 int (*deinit_ap)(void *priv);
1804 * suspend - Notification on system suspend/hibernate event
1805 * @priv: Private driver interface data
1807 void (*suspend)(void *priv);
1810 * resume - Notification on system resume/thaw event
1811 * @priv: Private driver interface data
1813 void (*resume)(void *priv);
1816 * signal_monitor - Set signal monitoring parameters
1817 * @priv: Private driver interface data
1818 * @threshold: Threshold value for signal change events; 0 = disabled
1819 * @hysteresis: Minimum change in signal strength before indicating a
1821 * Returns: 0 on success, -1 on failure (or if not supported)
1823 * This function can be used to configure monitoring of signal strength
1824 * with the current AP. Whenever signal strength drops below the
1825 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
1826 * should be generated assuming the signal strength has changed at
1827 * least %hysteresis from the previously indicated signal change event.
1829 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
1832 * send_frame - Send IEEE 802.11 frame (testing use only)
1833 * @priv: Private driver interface data
1834 * @data: IEEE 802.11 frame with IEEE 802.11 header
1835 * @data_len: Size of the frame
1836 * @encrypt: Whether to encrypt the frame (if keys are set)
1837 * Returns: 0 on success, -1 on failure
1839 * This function is only used for debugging purposes and is not
1840 * required to be implemented for normal operations.
1842 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
1846 * shared_freq - Get operating frequency of shared interface(s)
1847 * @priv: Private driver interface data
1848 * Returns: Operating frequency in MHz, 0 if no shared operation in
1849 * use, or -1 on failure
1851 * This command can be used to request the current operating frequency
1852 * of any virtual interface that shares the same radio to provide
1853 * information for channel selection for other virtual interfaces.
1855 int (*shared_freq)(void *priv);
1858 * get_noa - Get current Notice of Absence attribute payload
1859 * @priv: Private driver interface data
1860 * @buf: Buffer for returning NoA
1861 * @buf_len: Buffer length in octets
1862 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
1863 * advertized, or -1 on failure
1865 * This function is used to fetch the current Notice of Absence
1866 * attribute value from GO.
1868 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
1871 * set_noa - Set Notice of Absence parameters for GO (testing)
1872 * @priv: Private driver interface data
1874 * @start: Start time in ms from next TBTT
1875 * @duration: Duration in ms
1876 * Returns: 0 on success or -1 on failure
1878 * This function is used to set Notice of Absence parameters for GO. It
1879 * is used only for testing. To disable NoA, all parameters are set to
1882 int (*set_noa)(void *priv, u8 count, int start, int duration);
1885 * set_p2p_powersave - Set P2P power save options
1886 * @priv: Private driver interface data
1887 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
1888 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
1889 * @ctwindow: 0.. = change (msec), -1 = no change
1890 * Returns: 0 on success or -1 on failure
1892 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
1896 * ampdu - Enable/disable aggregation
1897 * @priv: Private driver interface data
1898 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
1899 * Returns: 0 on success or -1 on failure
1901 int (*ampdu)(void *priv, int ampdu);
1904 * set_intra_bss - Enables/Disables intra BSS bridging
1906 int (*set_intra_bss)(void *priv, int enabled);
1911 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1913 enum wpa_event_type {
1915 * EVENT_ASSOC - Association completed
1917 * This event needs to be delivered when the driver completes IEEE
1918 * 802.11 association or reassociation successfully.
1919 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1920 * after this event has been generated. In addition, optional
1921 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1922 * more information about the association. If the driver interface gets
1923 * both of these events at the same time, it can also include the
1924 * assoc_info data in EVENT_ASSOC call.
1929 * EVENT_DISASSOC - Association lost
1931 * This event should be called when association is lost either due to
1932 * receiving deauthenticate or disassociate frame from the AP or when
1933 * sending either of these frames to the current AP. If the driver
1934 * supports separate deauthentication event, EVENT_DISASSOC should only
1935 * be used for disassociation and EVENT_DEAUTH for deauthentication.
1936 * In AP mode, union wpa_event_data::disassoc_info is required.
1941 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1943 * This event must be delivered when a Michael MIC error is detected by
1944 * the local driver. Additional data for event processing is
1945 * provided with union wpa_event_data::michael_mic_failure. This
1946 * information is used to request new encyption key and to initiate
1947 * TKIP countermeasures if needed.
1949 EVENT_MICHAEL_MIC_FAILURE,
1952 * EVENT_SCAN_RESULTS - Scan results available
1954 * This event must be called whenever scan results are available to be
1955 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1956 * is expected to be used some time after struct wpa_driver_ops::scan()
1957 * is called. If the driver provides an unsolicited event when the scan
1958 * has been completed, this event can be used to trigger
1959 * EVENT_SCAN_RESULTS call. If such event is not available from the
1960 * driver, the driver wrapper code is expected to use a registered
1961 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1962 * scan is expected to be completed. Optional information about
1963 * completed scan can be provided with union wpa_event_data::scan_info.
1968 * EVENT_ASSOCINFO - Report optional extra information for association
1970 * This event can be used to report extra association information for
1971 * EVENT_ASSOC processing. This extra information includes IEs from
1972 * association frames and Beacon/Probe Response frames in union
1973 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1974 * EVENT_ASSOC. Alternatively, the driver interface can include
1975 * assoc_info data in the EVENT_ASSOC call if it has all the
1976 * information available at the same point.
1981 * EVENT_INTERFACE_STATUS - Report interface status changes
1983 * This optional event can be used to report changes in interface
1984 * status (interface added/removed) using union
1985 * wpa_event_data::interface_status. This can be used to trigger
1986 * wpa_supplicant to stop and re-start processing for the interface,
1987 * e.g., when a cardbus card is ejected/inserted.
1989 EVENT_INTERFACE_STATUS,
1992 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1994 * This event can be used to inform wpa_supplicant about candidates for
1995 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1996 * for scan request (ap_scan=2 mode), this event is required for
1997 * pre-authentication. If wpa_supplicant is performing scan request
1998 * (ap_scan=1), this event is optional since scan results can be used
1999 * to add pre-authentication candidates. union
2000 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2001 * candidate and priority of the candidate, e.g., based on the signal
2002 * strength, in order to try to pre-authenticate first with candidates
2003 * that are most likely targets for re-association.
2005 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2006 * on the candidate list. In addition, it can be called for the current
2007 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2008 * will automatically skip pre-authentication in cases where a valid
2009 * PMKSA exists. When more than one candidate exists, this event should
2010 * be generated once for each candidate.
2012 * Driver will be notified about successful pre-authentication with
2013 * struct wpa_driver_ops::add_pmkid() calls.
2015 EVENT_PMKID_CANDIDATE,
2018 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2020 * This event can be used to inform wpa_supplicant about desire to set
2021 * up secure direct link connection between two stations as defined in
2022 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2023 * STAKey negotiation. The caller will need to set peer address for the
2029 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2031 * The driver is expected to report the received FT IEs from
2032 * FT authentication sequence from the AP. The FT IEs are included in
2033 * the extra information in union wpa_event_data::ft_ies.
2038 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2040 * The driver can use this event to inform wpa_supplicant about a STA
2041 * in an IBSS with which protected frames could be exchanged. This
2042 * event starts RSN authentication with the other STA to authenticate
2043 * the STA and set up encryption keys with it.
2045 EVENT_IBSS_RSN_START,
2048 * EVENT_AUTH - Authentication result
2050 * This event should be called when authentication attempt has been
2051 * completed. This is only used if the driver supports separate
2052 * authentication step (struct wpa_driver_ops::authenticate).
2053 * Information about authentication result is included in
2054 * union wpa_event_data::auth.
2059 * EVENT_DEAUTH - Authentication lost
2061 * This event should be called when authentication is lost either due
2062 * to receiving deauthenticate frame from the AP or when sending that
2063 * frame to the current AP.
2064 * In AP mode, union wpa_event_data::deauth_info is required.
2069 * EVENT_ASSOC_REJECT - Association rejected
2071 * This event should be called when (re)association attempt has been
2072 * rejected by the AP. Information about authentication result is
2073 * included in union wpa_event_data::assoc_reject.
2078 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2080 EVENT_AUTH_TIMED_OUT,
2083 * EVENT_ASSOC_TIMED_OUT - Association timed out
2085 EVENT_ASSOC_TIMED_OUT,
2088 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2093 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2095 EVENT_WPS_BUTTON_PUSHED,
2098 * EVENT_TX_STATUS - Report TX status
2103 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2105 EVENT_RX_FROM_UNKNOWN,
2108 * EVENT_RX_MGMT - Report RX of a management frame
2113 * EVENT_RX_ACTION - Action frame received
2115 * This event is used to indicate when an Action frame has been
2116 * received. Information about the received frame is included in
2117 * union wpa_event_data::rx_action.
2122 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2124 * This event is used to indicate when the driver has started the
2125 * requested remain-on-channel duration. Information about the
2126 * operation is included in union wpa_event_data::remain_on_channel.
2128 EVENT_REMAIN_ON_CHANNEL,
2131 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2133 * This event is used to indicate when the driver has completed
2134 * remain-on-channel duration, i.e., may noot be available on the
2135 * requested channel anymore. Information about the
2136 * operation is included in union wpa_event_data::remain_on_channel.
2138 EVENT_CANCEL_REMAIN_ON_CHANNEL,
2141 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2143 * This event is used only by driver_test.c and userspace MLME.
2148 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2150 * This event is used to indicate when a Probe Request frame has been
2151 * received. Information about the received frame is included in
2152 * union wpa_event_data::rx_probe_req. The driver is required to report
2153 * these events only after successfully completed probe_req_report()
2154 * commands to request the events (i.e., report parameter is non-zero)
2155 * in station mode. In AP mode, Probe Request frames should always be
2161 * EVENT_NEW_STA - New wired device noticed
2163 * This event is used to indicate that a new device has been detected
2164 * in a network that does not use association-like functionality (i.e.,
2165 * mainly wired Ethernet). This can be used to start EAPOL
2166 * authenticator when receiving a frame from a device. The address of
2167 * the device is included in union wpa_event_data::new_sta.
2172 * EVENT_EAPOL_RX - Report received EAPOL frame
2174 * When in AP mode with hostapd, this event is required to be used to
2175 * deliver the receive EAPOL frames from the driver. With
2176 * %wpa_supplicant, this event is used only if the send_eapol() handler
2177 * is used to override the use of l2_packet for EAPOL frame TX.
2182 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
2184 * This event is used to indicate changes in the signal strength
2185 * observed in frames received from the current AP if signal strength
2186 * monitoring has been enabled with signal_monitor().
2188 EVENT_SIGNAL_CHANGE,
2191 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
2193 * This event is used to indicate that the interface was enabled after
2194 * having been previously disabled, e.g., due to rfkill.
2196 EVENT_INTERFACE_ENABLED,
2199 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
2201 * This event is used to indicate that the interface was disabled,
2202 * e.g., due to rfkill.
2204 EVENT_INTERFACE_DISABLED
2209 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
2211 union wpa_event_data {
2213 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
2215 * This structure is optional for EVENT_ASSOC calls and required for
2216 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
2217 * driver interface does not need to generate separate EVENT_ASSOCINFO
2222 * req_ies - (Re)Association Request IEs
2224 * If the driver generates WPA/RSN IE, this event data must be
2225 * returned for WPA handshake to have needed information. If
2226 * wpa_supplicant-generated WPA/RSN IE is used, this
2227 * information event is optional.
2229 * This should start with the first IE (fixed fields before IEs
2230 * are not included).
2235 * req_ies_len - Length of req_ies in bytes
2240 * resp_ies - (Re)Association Response IEs
2242 * Optional association data from the driver. This data is not
2243 * required WPA, but may be useful for some protocols and as
2244 * such, should be reported if this is available to the driver
2247 * This should start with the first IE (fixed fields before IEs
2248 * are not included).
2253 * resp_ies_len - Length of resp_ies in bytes
2255 size_t resp_ies_len;
2258 * beacon_ies - Beacon or Probe Response IEs
2260 * Optional Beacon/ProbeResp data: IEs included in Beacon or
2261 * Probe Response frames from the current AP (i.e., the one
2262 * that the client just associated with). This information is
2263 * used to update WPA/RSN IE for the AP. If this field is not
2264 * set, the results from previous scan will be used. If no
2265 * data for the new AP is found, scan results will be requested
2266 * again (without scan request). At this point, the driver is
2267 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
2270 * This should start with the first IE (fixed fields before IEs
2271 * are not included).
2273 const u8 *beacon_ies;
2276 * beacon_ies_len - Length of beacon_ies */
2277 size_t beacon_ies_len;
2280 * freq - Frequency of the operational channel in MHz
2285 * addr - Station address (for AP mode)
2291 * struct disassoc_info - Data for EVENT_DISASSOC events
2293 struct disassoc_info {
2295 * addr - Station address (for AP mode)
2300 * reason_code - Reason Code (host byte order) used in
2301 * Deauthentication frame
2306 * ie - Optional IE(s) in Disassociation frame
2311 * ie_len - Length of ie buffer in octets
2317 * struct deauth_info - Data for EVENT_DEAUTH events
2319 struct deauth_info {
2321 * addr - Station address (for AP mode)
2326 * reason_code - Reason Code (host byte order) used in
2327 * Deauthentication frame
2332 * ie - Optional IE(s) in Deauthentication frame
2337 * ie_len - Length of ie buffer in octets
2343 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
2345 struct michael_mic_failure {
2348 } michael_mic_failure;
2351 * struct interface_status - Data for EVENT_INTERFACE_STATUS
2353 struct interface_status {
2356 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
2361 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
2363 struct pmkid_candidate {
2364 /** BSSID of the PMKID candidate */
2366 /** Smaller the index, higher the priority */
2368 /** Whether RSN IE includes pre-authenticate flag */
2373 * struct stkstart - Data for EVENT_STKSTART
2380 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
2382 * During FT (IEEE 802.11r) authentication sequence, the driver is
2383 * expected to use this event to report received FT IEs (MDIE, FTIE,
2384 * RSN IE, TIE, possible resource request) to the supplicant. The FT
2385 * IEs for the next message will be delivered through the
2386 * struct wpa_driver_ops::update_ft_ies() callback.
2392 u8 target_ap[ETH_ALEN];
2393 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
2395 /** Length of ric_ies buffer in octets */
2400 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
2402 struct ibss_rsn_start {
2407 * struct auth_info - Data for EVENT_AUTH events
2418 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
2420 struct assoc_reject {
2422 * resp_ies - (Re)Association Response IEs
2424 * Optional association data from the driver. This data is not
2425 * required WPA, but may be useful for some protocols and as
2426 * such, should be reported if this is available to the driver
2429 * This should start with the first IE (fixed fields before IEs
2430 * are not included).
2435 * resp_ies_len - Length of resp_ies in bytes
2437 size_t resp_ies_len;
2440 * status_code - Status Code from (Re)association Response
2445 struct timeout_event {
2450 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
2459 * struct tx_status - Data for EVENT_TX_STATUS events
2471 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
2473 struct rx_from_unknown {
2479 * struct rx_mgmt - Data for EVENT_RX_MGMT events
2489 * struct rx_action - Data for EVENT_RX_ACTION events
2493 * da - Destination address of the received Action frame
2498 * sa - Source address of the received Action frame
2503 * bssid - Address 3 of the received Action frame
2508 * category - Action frame category
2513 * data - Action frame body after category field
2518 * len - Length of data in octets
2523 * freq - Frequency (in MHz) on which the frame was received
2529 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
2531 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
2533 struct remain_on_channel {
2535 * freq - Channel frequency in MHz
2540 * duration - Duration to remain on the channel in milliseconds
2542 unsigned int duration;
2543 } remain_on_channel;
2546 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
2547 * @aborted: Whether the scan was aborted
2548 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
2549 * @num_freqs: Number of entries in freqs array
2550 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
2552 * @num_ssids: Number of entries in ssids array
2558 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
2563 * struct mlme_rx - Data for EVENT_MLME_RX events
2574 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
2576 struct rx_probe_req {
2578 * sa - Source address of the received Probe Request frame
2583 * ie - IEs from the Probe Request body
2588 * ie_len - Length of ie buffer in octets
2594 * struct new_sta - Data for EVENT_NEW_STA events
2601 * struct eapol_rx - Data for EVENT_EAPOL_RX events
2610 * struct signal_change - Data for EVENT_SIGNAL_CHANGE events
2612 struct signal_change {
2613 int above_threshold;
2619 * wpa_supplicant_event - Report a driver event for wpa_supplicant
2620 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
2621 * with struct wpa_driver_ops::init()
2622 * @event: event type (defined above)
2623 * @data: possible extra data for the event
2625 * Driver wrapper code should call this function whenever an event is received
2628 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
2629 union wpa_event_data *data);
2633 * The following inline functions are provided for convenience to simplify
2634 * event indication for some of the common events.
2637 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
2640 union wpa_event_data event;
2641 os_memset(&event, 0, sizeof(event));
2642 event.assoc_info.req_ies = ie;
2643 event.assoc_info.req_ies_len = ielen;
2644 event.assoc_info.addr = addr;
2645 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
2648 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
2650 union wpa_event_data event;
2651 os_memset(&event, 0, sizeof(event));
2652 event.disassoc_info.addr = addr;
2653 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
2656 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
2659 union wpa_event_data event;
2660 os_memset(&event, 0, sizeof(event));
2661 event.eapol_rx.src = src;
2662 event.eapol_rx.data = data;
2663 event.eapol_rx.data_len = data_len;
2664 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
2667 #endif /* DRIVER_H */