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 * struct wpa_driver_associate_params - Association parameters
286 * Data for struct wpa_driver_ops::associate().
288 struct wpa_driver_associate_params {
290 * bssid - BSSID of the selected AP
291 * This can be %NULL, if ap_scan=2 mode is used and the driver is
292 * responsible for selecting with which BSS to associate. */
296 * ssid - The selected SSID
301 * ssid_len - Length of the SSID (1..32)
306 * freq - Frequency of the channel the selected AP is using
307 * Frequency that the selected AP is using (in MHz as
308 * reported in the scan results)
313 * wpa_ie - WPA information element for (Re)Association Request
314 * WPA information element to be included in (Re)Association
315 * Request (including information element id and length). Use
316 * of this WPA IE is optional. If the driver generates the WPA
317 * IE, it can use pairwise_suite, group_suite, and
318 * key_mgmt_suite to select proper algorithms. In this case,
319 * the driver has to notify wpa_supplicant about the used WPA
320 * IE by generating an event that the interface code will
321 * convert into EVENT_ASSOCINFO data (see below).
323 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
324 * instead. The driver can determine which version is used by
325 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
328 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
333 * wpa_ie_len - length of the wpa_ie
338 * pairwise_suite - Selected pairwise cipher suite
340 * This is usually ignored if @wpa_ie is used.
342 enum wpa_cipher pairwise_suite;
345 * group_suite - Selected group cipher suite
347 * This is usually ignored if @wpa_ie is used.
349 enum wpa_cipher group_suite;
352 * key_mgmt_suite - Selected key management suite
354 * This is usually ignored if @wpa_ie is used.
356 enum wpa_key_mgmt key_mgmt_suite;
359 * auth_alg - Allowed authentication algorithms
360 * Bit field of WPA_AUTH_ALG_*
365 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
370 * wep_key - WEP keys for static WEP configuration
372 const u8 *wep_key[4];
375 * wep_key_len - WEP key length for static WEP configuration
377 size_t wep_key_len[4];
380 * wep_tx_keyidx - WEP TX key index for static WEP configuration
385 * mgmt_frame_protection - IEEE 802.11w management frame protection
387 enum mfp_options mgmt_frame_protection;
390 * ft_ies - IEEE 802.11r / FT information elements
391 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
392 * for fast transition, this parameter is set to include the IEs that
393 * are to be sent in the next FT Authentication Request message.
394 * update_ft_ies() handler is called to update the IEs for further
395 * FT messages in the sequence.
397 * The driver should use these IEs only if the target AP is advertising
398 * the same mobility domain as the one included in the MDIE here.
400 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
401 * AP after the initial association. These IEs can only be used if the
402 * target AP is advertising support for FT and is using the same MDIE
403 * and SSID as the current AP.
405 * The driver is responsible for reporting the FT IEs received from the
406 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
407 * type. update_ft_ies() handler will then be called with the FT IEs to
408 * include in the next frame in the authentication sequence.
413 * ft_ies_len - Length of ft_ies in bytes
418 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
420 * This value is provided to allow the driver interface easier access
421 * to the current mobility domain. This value is set to %NULL if no
422 * mobility domain is currently active.
427 * passphrase - RSN passphrase for PSK
429 * This value is made available only for WPA/WPA2-Personal (PSK) and
430 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
431 * the 8..63 character ASCII passphrase, if available. Please note that
432 * this can be %NULL if passphrase was not used to generate the PSK. In
433 * that case, the psk field must be used to fetch the PSK.
435 const char *passphrase;
438 * psk - RSN PSK (alternative for passphrase for PSK)
440 * This value is made available only for WPA/WPA2-Personal (PSK) and
441 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
442 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
443 * be prepared to handle %NULL value as an error.
448 * drop_unencrypted - Enable/disable unencrypted frame filtering
450 * Configure the driver to drop all non-EAPOL frames (both receive and
451 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
452 * still be allowed for key negotiation.
454 int drop_unencrypted;
457 * prev_bssid - Previously used BSSID in this ESS
459 * When not %NULL, this is a request to use reassociation instead of
462 const u8 *prev_bssid;
466 * struct wpa_driver_capa - Driver capability information
468 struct wpa_driver_capa {
469 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
470 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
471 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
472 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
473 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
474 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
475 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
476 unsigned int key_mgmt;
478 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
479 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
480 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
481 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
484 #define WPA_DRIVER_AUTH_OPEN 0x00000001
485 #define WPA_DRIVER_AUTH_SHARED 0x00000002
486 #define WPA_DRIVER_AUTH_LEAP 0x00000004
489 /* Driver generated WPA/RSN IE */
490 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
491 /* Driver needs static WEP key setup after association command */
492 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
493 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
494 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
495 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
496 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
497 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
498 /* Driver provides separate commands for authentication and association (SME in
499 * wpa_supplicant). */
500 #define WPA_DRIVER_FLAGS_SME 0x00000020
501 /* Driver supports AP mode */
502 #define WPA_DRIVER_FLAGS_AP 0x00000040
503 /* Driver needs static WEP key setup after association has been completed */
504 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
513 struct hostap_sta_driver_data {
514 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
515 unsigned long current_tx_rate;
516 unsigned long inactive_msec;
518 unsigned long num_ps_buf_frames;
519 unsigned long tx_retry_failed;
520 unsigned long tx_retry_count;
525 struct hostapd_sta_add_params {
529 const u8 *supp_rates;
530 size_t supp_rates_len;
532 const struct ieee80211_ht_capabilities *ht_capabilities;
535 struct hostapd_freq_params {
540 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
541 * secondary channel below primary, 1 = HT40
542 * enabled, secondary channel above primary */
545 enum wpa_driver_if_type {
547 * WPA_IF_STATION - Station mode interface
552 * WPA_IF_AP_VLAN - AP mode VLAN interface
554 * This interface shares its address and Beacon frame with the main
560 * WPA_IF_AP_BSS - AP mode BSS interface
562 * This interface has its own address and Beacon frame.
567 struct wpa_init_params {
572 const char *test_socket;
573 int use_pae_group_addr;
577 u8 *own_addr; /* buffer for writing own MAC address */
581 struct wpa_bss_params {
582 /** Interface name (for multi-SSID/VLAN support) */
584 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
595 #define WPA_STA_AUTHORIZED BIT(0)
596 #define WPA_STA_WMM BIT(1)
597 #define WPA_STA_SHORT_PREAMBLE BIT(2)
598 #define WPA_STA_MFP BIT(3)
601 * struct wpa_driver_ops - Driver interface API definition
603 * This structure defines the API that each driver interface needs to implement
604 * for core wpa_supplicant code. All driver specific functionality is captured
607 struct wpa_driver_ops {
608 /** Name of the driver interface */
610 /** One line description of the driver interface */
614 * get_bssid - Get the current BSSID
615 * @priv: private driver interface data
616 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
618 * Returns: 0 on success, -1 on failure
620 * Query kernel driver for the current BSSID and copy it to bssid.
621 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
624 int (*get_bssid)(void *priv, u8 *bssid);
627 * get_ssid - Get the current SSID
628 * @priv: private driver interface data
629 * @ssid: buffer for SSID (at least 32 bytes)
631 * Returns: Length of the SSID on success, -1 on failure
633 * Query kernel driver for the current SSID and copy it to ssid.
634 * Returning zero is recommended if the STA is not associated.
636 * Note: SSID is an array of octets, i.e., it is not nul terminated and
637 * can, at least in theory, contain control characters (including nul)
638 * and as such, should be processed as binary data, not a printable
641 int (*get_ssid)(void *priv, u8 *ssid);
644 * set_key - Configure encryption key
645 * @ifname: Interface name (for multi-SSID/VLAN support)
646 * @priv: private driver interface data
647 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
648 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
649 * %WPA_ALG_NONE clears the key.
650 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
651 * broadcast/default keys
652 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
654 * @set_tx: configure this key as the default Tx key (only used when
655 * driver does not support separate unicast/individual key
656 * @seq: sequence number/packet number, seq_len octets, the next
657 * packet number to be used for in replay protection; configured
658 * for Rx keys (in most cases, this is only used with broadcast
659 * keys and set to zero for unicast keys)
660 * @seq_len: length of the seq, depends on the algorithm:
661 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
662 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
664 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
665 * TKIP: 32, CCMP: 16, IGTK: 16)
667 * Returns: 0 on success, -1 on failure
669 * Configure the given key for the kernel driver. If the driver
670 * supports separate individual keys (4 default keys + 1 individual),
671 * addr can be used to determine whether the key is default or
672 * individual. If only 4 keys are supported, the default key with key
673 * index 0 is used as the individual key. STA must be configured to use
674 * it as the default Tx key (set_tx is set) and accept Rx for all the
675 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
676 * broadcast keys, so key index 0 is available for this kind of
679 * Please note that TKIP keys include separate TX and RX MIC keys and
680 * some drivers may expect them in different order than wpa_supplicant
681 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
682 * will tricker Michael MIC errors. This can be fixed by changing the
683 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
684 * in driver_*.c set_key() implementation, see driver_ndis.c for an
685 * example on how this can be done.
687 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
688 const u8 *addr, int key_idx, int set_tx,
689 const u8 *seq, size_t seq_len,
690 const u8 *key, size_t key_len);
693 * init - Initialize driver interface
694 * @ctx: context to be used when calling wpa_supplicant functions,
695 * e.g., wpa_supplicant_event()
696 * @ifname: interface name, e.g., wlan0
698 * Returns: Pointer to private data, %NULL on failure
700 * Initialize driver interface, including event processing for kernel
701 * driver events (e.g., associated, scan results, Michael MIC failure).
702 * This function can allocate a private configuration data area for
703 * @ctx, file descriptor, interface name, etc. information that may be
704 * needed in future driver operations. If this is not used, non-NULL
705 * value will need to be returned because %NULL is used to indicate
706 * failure. The returned value will be used as 'void *priv' data for
707 * all other driver_ops functions.
709 * The main event loop (eloop.c) of wpa_supplicant can be used to
710 * register callback for read sockets (eloop_register_read_sock()).
712 * See below for more information about events and
713 * wpa_supplicant_event() function.
715 void * (*init)(void *ctx, const char *ifname);
718 * deinit - Deinitialize driver interface
719 * @priv: private driver interface data from init()
721 * Shut down driver interface and processing of driver events. Free
722 * private data buffer if one was allocated in init() handler.
724 void (*deinit)(void *priv);
727 * set_param - Set driver configuration parameters
728 * @priv: private driver interface data from init()
729 * @param: driver specific configuration parameters
731 * Returns: 0 on success, -1 on failure
733 * Optional handler for notifying driver interface about configuration
734 * parameters (driver_param).
736 int (*set_param)(void *priv, const char *param);
739 * set_countermeasures - Enable/disable TKIP countermeasures
740 * @priv: private driver interface data
741 * @enabled: 1 = countermeasures enabled, 0 = disabled
743 * Returns: 0 on success, -1 on failure
745 * Configure TKIP countermeasures. When these are enabled, the driver
746 * should drop all received and queued frames that are using TKIP.
748 int (*set_countermeasures)(void *priv, int enabled);
751 * deauthenticate - Request driver to deauthenticate
752 * @priv: private driver interface data
753 * @addr: peer address (BSSID of the AP)
754 * @reason_code: 16-bit reason code to be sent in the deauthentication
757 * Returns: 0 on success, -1 on failure
759 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
762 * disassociate - Request driver to disassociate
763 * @priv: private driver interface data
764 * @addr: peer address (BSSID of the AP)
765 * @reason_code: 16-bit reason code to be sent in the disassociation
768 * Returns: 0 on success, -1 on failure
770 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
773 * associate - Request driver to associate
774 * @priv: private driver interface data
775 * @params: association parameters
777 * Returns: 0 on success, -1 on failure
779 int (*associate)(void *priv,
780 struct wpa_driver_associate_params *params);
783 * add_pmkid - Add PMKSA cache entry to the driver
784 * @priv: private driver interface data
785 * @bssid: BSSID for the PMKSA cache entry
786 * @pmkid: PMKID for the PMKSA cache entry
788 * Returns: 0 on success, -1 on failure
790 * This function is called when a new PMK is received, as a result of
791 * either normal authentication or RSN pre-authentication.
793 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
794 * associate(), add_pmkid() can be used to add new PMKSA cache entries
795 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
796 * driver_ops function does not need to be implemented. Likewise, if
797 * the driver does not support WPA, this function is not needed.
799 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
802 * remove_pmkid - Remove PMKSA cache entry to the driver
803 * @priv: private driver interface data
804 * @bssid: BSSID for the PMKSA cache entry
805 * @pmkid: PMKID for the PMKSA cache entry
807 * Returns: 0 on success, -1 on failure
809 * This function is called when the supplicant drops a PMKSA cache
810 * entry for any reason.
812 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
813 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
814 * between the driver and wpa_supplicant. If the driver uses wpa_ie
815 * from wpa_supplicant, this driver_ops function does not need to be
816 * implemented. Likewise, if the driver does not support WPA, this
817 * function is not needed.
819 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
822 * flush_pmkid - Flush PMKSA cache
823 * @priv: private driver interface data
825 * Returns: 0 on success, -1 on failure
827 * This function is called when the supplicant drops all PMKSA cache
828 * entries for any reason.
830 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
831 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
832 * between the driver and wpa_supplicant. If the driver uses wpa_ie
833 * from wpa_supplicant, this driver_ops function does not need to be
834 * implemented. Likewise, if the driver does not support WPA, this
835 * function is not needed.
837 int (*flush_pmkid)(void *priv);
840 * get_capa - Get driver capabilities
841 * @priv: private driver interface data
843 * Returns: 0 on success, -1 on failure
845 * Get driver/firmware/hardware capabilities.
847 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
850 * poll - Poll driver for association information
851 * @priv: private driver interface data
853 * This is an option callback that can be used when the driver does not
854 * provide event mechanism for association events. This is called when
855 * receiving WPA EAPOL-Key messages that require association
856 * information. The driver interface is supposed to generate associnfo
857 * event before returning from this callback function. In addition, the
858 * driver interface should generate an association event after having
859 * sent out associnfo.
861 void (*poll)(void *priv);
864 * get_ifname - Get interface name
865 * @priv: private driver interface data
867 * Returns: Pointer to the interface name. This can differ from the
868 * interface name used in init() call. Init() is called first.
870 * This optional function can be used to allow the driver interface to
871 * replace the interface name with something else, e.g., based on an
872 * interface mapping from a more descriptive name.
874 const char * (*get_ifname)(void *priv);
877 * get_mac_addr - Get own MAC address
878 * @priv: private driver interface data
880 * Returns: Pointer to own MAC address or %NULL on failure
882 * This optional function can be used to get the own MAC address of the
883 * device from the driver interface code. This is only needed if the
884 * l2_packet implementation for the OS does not provide easy access to
886 const u8 * (*get_mac_addr)(void *priv);
889 * send_eapol - Optional function for sending EAPOL packets
890 * @priv: private driver interface data
891 * @dest: Destination MAC address
893 * @data: EAPOL packet starting with IEEE 802.1X header
894 * @data_len: Size of the EAPOL packet
896 * Returns: 0 on success, -1 on failure
898 * This optional function can be used to override l2_packet operations
899 * with driver specific functionality. If this function pointer is set,
900 * l2_packet module is not used at all and the driver interface code is
901 * responsible for receiving and sending all EAPOL packets. The
902 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
903 * event. The driver interface is required to implement get_mac_addr()
904 * handler if send_eapol() is used.
906 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
907 const u8 *data, size_t data_len);
910 * set_operstate - Sets device operating state to DORMANT or UP
911 * @priv: private driver interface data
912 * @state: 0 = dormant, 1 = up
913 * Returns: 0 on success, -1 on failure
915 * This is an optional function that can be used on operating systems
916 * that support a concept of controlling network device state from user
917 * space applications. This function, if set, gets called with
918 * state = 1 when authentication has been completed and with state = 0
919 * when connection is lost.
921 int (*set_operstate)(void *priv, int state);
924 * mlme_setprotection - MLME-SETPROTECTION.request primitive
925 * @priv: Private driver interface data
926 * @addr: Address of the station for which to set protection (may be
927 * %NULL for group keys)
928 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
929 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
930 * Returns: 0 on success, -1 on failure
932 * This is an optional function that can be used to set the driver to
933 * require protection for Tx and/or Rx frames. This uses the layer
934 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
935 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
936 * set protection operation; instead, they set protection implicitly
937 * based on configured keys.
939 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
943 * get_hw_feature_data - Get hardware support data (channels and rates)
944 * @priv: Private driver interface data
945 * @num_modes: Variable for returning the number of returned modes
946 * flags: Variable for returning hardware feature flags
947 * Returns: Pointer to allocated hardware data on success or %NULL on
948 * failure. Caller is responsible for freeing this.
950 * This function is only needed for drivers that export MLME
951 * (management frame processing) to %wpa_supplicant or hostapd.
953 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
958 * set_channel - Set channel
959 * @priv: Private driver interface data
960 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
961 * @chan: IEEE 802.11 channel number
962 * @freq: Frequency of the channel in MHz
963 * Returns: 0 on success, -1 on failure
965 * This function is only needed for drivers that export MLME
966 * (management frame processing) to wpa_supplicant.
968 int (*set_channel)(void *priv, enum hostapd_hw_mode phymode, int chan,
972 * set_ssid - Set SSID
973 * @priv: Private driver interface data
975 * @ssid_len: SSID length
976 * Returns: 0 on success, -1 on failure
978 * This function is only needed for drivers that export MLME
979 * (management frame processing) to wpa_supplicant.
981 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
984 * set_bssid - Set BSSID
985 * @priv: Private driver interface data
987 * Returns: 0 on success, -1 on failure
989 * This function is only needed for drivers that export MLME
990 * (management frame processing) to wpa_supplicant.
992 int (*set_bssid)(void *priv, const u8 *bssid);
995 * send_mlme - Send management frame from MLME
996 * @priv: Private driver interface data
997 * @data: IEEE 802.11 management frame with IEEE 802.11 header
998 * @data_len: Size of the management frame
999 * Returns: 0 on success, -1 on failure
1001 * This function is only needed for drivers that export MLME
1002 * (management frame processing) to wpa_supplicant.
1004 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
1007 * mlme_add_sta - Add a STA entry into the driver/netstack
1008 * @priv: Private driver interface data
1009 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1010 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
1011 * format (one octet per rate, 1 = 0.5 Mbps)
1012 * @supp_rates_len: Number of entries in supp_rates
1013 * Returns: 0 on success, -1 on failure
1015 * This function is only needed for drivers that export MLME
1016 * (management frame processing) to wpa_supplicant. When the MLME code
1017 * completes association with an AP, this function is called to
1018 * configure the driver/netstack with a STA entry for data frame
1019 * processing (TX rate control, encryption/decryption).
1021 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
1022 size_t supp_rates_len);
1025 * mlme_remove_sta - Remove a STA entry from the driver/netstack
1026 * @priv: Private driver interface data
1027 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1028 * Returns: 0 on success, -1 on failure
1030 * This function is only needed for drivers that export MLME
1031 * (management frame processing) to wpa_supplicant.
1033 int (*mlme_remove_sta)(void *priv, const u8 *addr);
1036 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1037 * @priv: Private driver interface data
1038 * @md: Mobility domain (2 octets) (also included inside ies)
1039 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1040 * @ies_len: Length of FT IEs in bytes
1041 * Returns: 0 on success, -1 on failure
1043 * The supplicant uses this callback to let the driver know that keying
1044 * material for FT is available and that the driver can use the
1045 * provided IEs in the next message in FT authentication sequence.
1047 * This function is only needed for driver that support IEEE 802.11r
1048 * (Fast BSS Transition).
1050 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1054 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1055 * @priv: Private driver interface data
1056 * @action: Action field value
1057 * @target_ap: Target AP address
1058 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1059 * @ies_len: Length of FT IEs in bytes
1060 * Returns: 0 on success, -1 on failure
1062 * The supplicant uses this callback to request the driver to transmit
1063 * an FT Action frame (action category 6) for over-the-DS fast BSS
1066 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1067 const u8 *ies, size_t ies_len);
1070 * get_scan_results2 - Fetch the latest scan results
1071 * @priv: private driver interface data
1073 * Returns: Allocated buffer of scan results (caller is responsible for
1074 * freeing the data structure) on success, NULL on failure
1076 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1079 * set_country - Set country
1080 * @priv: Private driver interface data
1081 * @alpha2: country to which to switch to
1082 * Returns: 0 on success, -1 on failure
1084 * This function is for drivers which support some form
1085 * of setting a regulatory domain.
1087 int (*set_country)(void *priv, const char *alpha2);
1090 * global_init - Global driver initialization
1091 * Returns: Pointer to private data (global), %NULL on failure
1093 * This optional function is called to initialize the driver wrapper
1094 * for global data, i.e., data that applies to all interfaces. If this
1095 * function is implemented, global_deinit() will also need to be
1096 * implemented to free the private data. The driver will also likely
1097 * use init2() function instead of init() to get the pointer to global
1098 * data available to per-interface initializer.
1100 void * (*global_init)(void);
1103 * global_deinit - Global driver deinitialization
1104 * @priv: private driver global data from global_init()
1106 * Terminate any global driver related functionality and free the
1107 * global data structure.
1109 void (*global_deinit)(void *priv);
1112 * init2 - Initialize driver interface (with global data)
1113 * @ctx: context to be used when calling wpa_supplicant functions,
1114 * e.g., wpa_supplicant_event()
1115 * @ifname: interface name, e.g., wlan0
1116 * @global_priv: private driver global data from global_init()
1117 * Returns: Pointer to private data, %NULL on failure
1119 * This function can be used instead of init() if the driver wrapper
1122 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1125 * get_interfaces - Get information about available interfaces
1126 * @global_priv: private driver global data from global_init()
1127 * Returns: Allocated buffer of interface information (caller is
1128 * responsible for freeing the data structure) on success, NULL on
1131 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1134 * scan2 - Request the driver to initiate scan
1135 * @priv: private driver interface data
1136 * @params: Scan parameters
1138 * Returns: 0 on success, -1 on failure
1140 * Once the scan results are ready, the driver should report scan
1141 * results event for wpa_supplicant which will eventually request the
1142 * results with wpa_driver_get_scan_results2().
1144 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1147 * authenticate - Request driver to authenticate
1148 * @priv: private driver interface data
1149 * @params: authentication parameters
1150 * Returns: 0 on success, -1 on failure
1152 * This is an optional function that can be used with drivers that
1153 * support separate authentication and association steps, i.e., when
1154 * wpa_supplicant can act as the SME. If not implemented, associate()
1155 * function is expected to take care of IEEE 802.11 authentication,
1158 int (*authenticate)(void *priv,
1159 struct wpa_driver_auth_params *params);
1162 * set_beacon - Set Beacon frame template
1163 * @priv: Private driver interface data
1164 * @head: Beacon head from IEEE 802.11 header to IEs before TIM IE
1165 * @head_len: Length of the head buffer in octets
1166 * @tail: Beacon tail following TIM IE
1167 * @tail_len: Length of the tail buffer in octets
1168 * @dtim_period: DTIM period
1169 * @beacon_int: Beacon interval
1170 * Returns: 0 on success, -1 on failure
1172 * This function is used to configure Beacon template for the driver in
1173 * AP mode. The driver is responsible for building the full Beacon
1174 * frame by concatenating the head part with TIM IE generated by the
1175 * driver/firmware and finishing with the tail part.
1177 int (*set_beacon)(void *priv, const u8 *head, size_t head_len,
1178 const u8 *tail, size_t tail_len, int dtim_period,
1182 * hapd_init - Initialize driver interface (hostapd only)
1183 * @hapd: Pointer to hostapd context
1184 * @params: Configuration for the driver wrapper
1185 * Returns: Pointer to private data, %NULL on failure
1187 * This function is used instead of init() or init2() when the driver
1188 * wrapper is used withh hostapd.
1190 void * (*hapd_init)(struct hostapd_data *hapd,
1191 struct wpa_init_params *params);
1194 * hapd_deinit - Deinitialize driver interface (hostapd only)
1195 * @priv: Private driver interface data from hapd_init()
1197 void (*hapd_deinit)(void *priv);
1200 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1201 * @priv: Private driver interface data
1202 * @params: BSS parameters
1203 * Returns: 0 on success, -1 on failure
1205 * This is an optional function to configure the kernel driver to
1206 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1207 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1208 * always enabled and the driver uses set_beacon() to set WPA/RSN IE
1209 * for Beacon frames.
1211 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1214 * set_privacy - Enable/disable privacy (AP only)
1215 * @priv: Private driver interface data
1216 * @enabled: 1 = privacy enabled, 0 = disabled
1217 * Returns: 0 on success, -1 on failure
1219 * This is an optional function to configure privacy field in the
1220 * kernel driver for Beacon frames. This can be left undefined (set to
1221 * %NULL) if the driver uses the Beacon template from set_beacon().
1223 int (*set_privacy)(void *priv, int enabled);
1226 * get_seqnum - Fetch the current TSC/packet number (AP only)
1227 * @ifname: The interface name (main or virtual)
1228 * @priv: Private driver interface data
1229 * @addr: MAC address of the station or %NULL for group keys
1231 * @seq: Buffer for returning the latest used TSC/packet number
1232 * Returns: 0 on success, -1 on failure
1234 * This function is used to fetch the last used TSC/packet number for
1235 * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so
1236 * there is no strict requirement on implementing support for unicast
1237 * keys (i.e., addr != %NULL).
1239 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1243 * flush - Flush all association stations (AP only)
1244 * @priv: Private driver interface data
1245 * Returns: 0 on success, -1 on failure
1247 * This function requests the driver to disassociate all associated
1248 * stations. This function does not need to be implemented if the
1249 * driver does not process association frames internally.
1251 int (*flush)(void *priv);
1254 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1255 * @priv: Private driver interface data
1256 * @elem: Information elements
1257 * @elem_len: Length of the elem buffer in octets
1258 * Returns: 0 on success, -1 on failure
1260 * This is an optional function to add information elements in the
1261 * kernel driver for Beacon and Probe Response frames. This can be left
1262 * undefined (set to %NULL) if the driver uses the Beacon template from
1265 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1268 * read_sta_data - Fetch station data (AP only)
1269 * @priv: Private driver interface data
1270 * @data: Buffer for returning station information
1271 * @addr: MAC address of the station
1272 * Returns: 0 on success, -1 on failure
1274 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1278 * hapd_send_eapol - Send an EAPOL packet (AP only)
1279 * @priv: private driver interface data
1280 * @addr: Destination MAC address
1281 * @data: EAPOL packet starting with IEEE 802.1X header
1282 * @data_len: Length of the EAPOL packet in octets
1283 * @encrypt: Whether the frame should be encrypted
1284 * @own_addr: Source MAC address
1286 * Returns: 0 on success, -1 on failure
1288 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1289 size_t data_len, int encrypt,
1290 const u8 *own_addr);
1293 * sta_deauth - Deauthenticate a station (AP only)
1294 * @priv: Private driver interface data
1295 * @own_addr: Source address and BSSID for the Deauthentication frame
1296 * @addr: MAC address of the station to deauthenticate
1297 * @reason: Reason code for the Deauthentiation frame
1298 * Returns: 0 on success, -1 on failure
1300 * This function requests a specific station to be deauthenticated and
1301 * a Deauthentication frame to be sent to it.
1303 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1307 * sta_disassoc - Disassociate a station (AP only)
1308 * @priv: Private driver interface data
1309 * @own_addr: Source address and BSSID for the Disassociation frame
1310 * @addr: MAC address of the station to disassociate
1311 * @reason: Reason code for the Disassociation frame
1312 * Returns: 0 on success, -1 on failure
1314 * This function requests a specific station to be disassociated and
1315 * a Disassociation frame to be sent to it.
1317 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1321 * sta_remove - Remove a station entry (AP only)
1322 * @priv: Private driver interface data
1323 * @addr: MAC address of the station to be removed
1324 * Returns: 0 on success, -1 on failure
1326 int (*sta_remove)(void *priv, const u8 *addr);
1329 * hapd_get_ssid - Get the current SSID (AP only)
1330 * @priv: Private driver interface data
1331 * @buf: Buffer for returning the SSID
1332 * @len: Maximum length of the buffer
1333 * Returns: Length of the SSID on success, -1 on failure
1335 * This function need not be implemented if the driver uses Beacon
1336 * template from set_beacon() and does not reply to Probe Request
1339 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1342 * hapd_set_ssid - Set SSID (AP only)
1343 * @priv: Private driver interface data
1345 * @len: Length of the SSID in octets
1346 * Returns: 0 on success, -1 on failure
1348 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1351 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1352 * @priv: Private driver interface data
1353 * @enabled: 1 = countermeasures enabled, 0 = disabled
1354 * Returns: 0 on success, -1 on failure
1356 * This need not be implemented if the driver does not take care of
1357 * association processing.
1359 int (*hapd_set_countermeasures)(void *priv, int enabled);
1362 * sta_add - Add a station entry
1363 * @priv: Private driver interface data
1364 * @params: Station parameters
1365 * Returns: 0 on success, -1 on failure
1367 * This function is used to add a station entry to the driver once the
1368 * station has completed association. This is only used if the driver
1369 * does not take care of association processing.
1371 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1374 * get_inact_sec - Get station inactivity duration (AP only)
1375 * @priv: Private driver interface data
1376 * @addr: Station address
1377 * Returns: Number of seconds station has been inactive, -1 on failure
1379 int (*get_inact_sec)(void *priv, const u8 *addr);
1382 * sta_clear_stats - Clear station statistics (AP only)
1383 * @priv: Private driver interface data
1384 * @addr: Station address
1385 * Returns: 0 on success, -1 on failure
1387 int (*sta_clear_stats)(void *priv, const u8 *addr);
1390 * set_freq - Set channel/frequency (AP only)
1391 * @priv: Private driver interface data
1392 * @freq: Channel parameters
1393 * Returns: 0 on success, -1 on failure
1395 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1398 * set_rts - Set RTS threshold
1399 * @priv: Private driver interface data
1400 * @rts: RTS threshold in octets
1401 * Returns: 0 on success, -1 on failure
1403 int (*set_rts)(void *priv, int rts);
1406 * set_frag - Set fragmentation threshold
1407 * @priv: Private driver interface data
1408 * @frag: Fragmentation threshold in octets
1409 * Returns: 0 on success, -1 on failure
1411 int (*set_frag)(void *priv, int frag);
1414 * sta_set_flags - Set station flags (AP only)
1415 * @priv: Private driver interface data
1416 * @addr: Station address
1417 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1418 * @flags_or: Bitmap of WPA_STA_* flags to add
1419 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1420 * Returns: 0 on success, -1 on failure
1422 int (*sta_set_flags)(void *priv, const u8 *addr,
1423 int total_flags, int flags_or, int flags_and);
1426 * set_rate_sets - Set supported and basic rate sets (AP only)
1427 * @priv: Private driver interface data
1428 * @supp_rates: -1 terminated array of supported rates in 100 kbps
1429 * @basic_rates: -1 terminated array of basic rates in 100 kbps
1430 * @mode: hardware mode (HOSTAPD_MODE_*)
1431 * Returns: 0 on success, -1 on failure
1433 int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
1437 * set_cts_protect - Set CTS protection mode (AP only)
1438 * @priv: Private driver interface data
1439 * @value: Whether CTS protection is enabled
1440 * Returns: 0 on success, -1 on failure
1442 int (*set_cts_protect)(void *priv, int value);
1445 * set_preamble - Set preamble mode (AP only)
1446 * @priv: Private driver interface data
1447 * @value: Whether short preamble is enabled
1448 * Returns: 0 on success, -1 on failure
1450 int (*set_preamble)(void *priv, int value);
1453 * set_short_slot_time - Set short slot time (AP only)
1454 * @priv: Private driver interface data
1455 * @value: Whether short slot time is enabled
1456 * Returns: 0 on success, -1 on failure
1458 int (*set_short_slot_time)(void *priv, int value);
1461 * set_tx_queue_params - Set TX queue parameters
1462 * @priv: Private driver interface data
1463 * @queue: Queue number
1467 * @burst_time: Maximum length for bursting in 0.1 msec units
1469 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1470 int cw_max, int burst_time);
1473 * valid_bss_mask - Validate BSSID mask
1474 * @priv: Private driver interface data
1477 * Returns: 0 if mask is valid, -1 if mask is not valid, 1 if mask can
1478 * be used, but the main interface address must be the first address in
1479 * the block if mask is applied
1481 int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
1484 * if_add - Add a virtual interface
1485 * @priv: Private driver interface data
1486 * @type: Interface type
1487 * @ifname: Interface name for the new virtual interface
1488 * @addr: Local address to use for the interface or %NULL to use the
1489 * parent interface address
1490 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1491 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1492 * not allowed (applies only to %WPA_IF_AP_BSS type)
1493 * Returns: 0 on success, -1 on failure
1495 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1496 const char *ifname, const u8 *addr, void *bss_ctx,
1500 * if_remove - Remove a virtual interface
1501 * @priv: Private driver interface data
1502 * @type: Interface type
1503 * @ifname: Interface name of the virtual interface to be removed
1504 * Returns: 0 on success, -1 on failure
1506 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1507 const char *ifname);
1510 * set_sta_vlan - Bind a station into a specific interface (AP only)
1511 * @priv: Private driver interface data
1512 * @ifname: Interface (main or virtual BSS or VLAN)
1513 * @addr: MAC address of the associated station
1515 * Returns: 0 on success, -1 on failure
1517 * This function is used to bind a station to a specific virtual
1518 * interface. It is only used if when virtual interfaces are supported,
1519 * e.g., to assign stations to different VLAN interfaces based on
1520 * information from a RADIUS server. This allows separate broadcast
1521 * domains to be used with a single BSS.
1523 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1527 * commit - Optional commit changes handler (AP only)
1528 * @priv: driver private data
1529 * Returns: 0 on success, -1 on failure
1531 * This optional handler function can be registered if the driver
1532 * interface implementation needs to commit changes (e.g., by setting
1533 * network interface up) at the end of initial configuration. If set,
1534 * this handler will be called after initial setup has been completed.
1536 int (*commit)(void *priv);
1539 * send_ether - Send an ethernet packet (AP only)
1540 * @priv: private driver interface data
1541 * @dst: Destination MAC address
1542 * @src: Source MAC address
1544 * @data: EAPOL packet starting with IEEE 802.1X header
1545 * @data_len: Length of the EAPOL packet in octets
1546 * Returns: 0 on success, -1 on failure
1548 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1549 const u8 *data, size_t data_len);
1552 * set_radius_acl_auth - Notification of RADIUS ACL change
1553 * @priv: Private driver interface data
1554 * @mac: MAC address of the station
1555 * @accepted: Whether the station was accepted
1556 * @session_timeout: Session timeout for the station
1557 * Returns: 0 on success, -1 on failure
1559 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1560 u32 session_timeout);
1563 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1564 * @priv: Private driver interface data
1565 * @mac: MAC address of the station
1566 * Returns: 0 on success, -1 on failure
1568 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1571 * set_ht_params - Set HT parameters (AP only)
1572 * @priv: Private driver interface data
1573 * @ht_capab: HT Capabilities IE
1574 * @ht_capab_len: Length of ht_capab in octets
1575 * @ht_oper: HT Operation IE
1576 * @ht_oper_len: Length of ht_oper in octets
1577 * Returns: 0 on success, -1 on failure
1579 int (*set_ht_params)(void *priv,
1580 const u8 *ht_capab, size_t ht_capab_len,
1581 const u8 *ht_oper, size_t ht_oper_len);
1584 * set_ap_wps_ie - Add WPS IE into Beacon/Probe Response frames (AP)
1585 * @priv: Private driver interface data
1586 * @beacon: WPS IE for Beacon frames
1587 * @proberesp: WPS IE for Probe Response frames
1588 * Returns: 0 on success, -1 on failure
1590 * This is an optional function to add WPS IE in the kernel driver for
1591 * Beacon and Probe Response frames. This can be left undefined (set
1592 * to %NULL) if the driver uses the Beacon template from set_beacon()
1593 * and does not process Probe Request frames.
1595 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
1596 const struct wpabuf *proberesp);
1599 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1600 * @priv: Private driver interface data
1601 * @authorized: Whether the port is authorized
1602 * Returns: 0 on success, -1 on failure
1604 int (*set_supp_port)(void *priv, int authorized);
1607 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1608 * @priv: Private driver interface data
1609 * @addr: MAC address of the associated station
1610 * @aid: Association ID
1611 * @val: 1 = bind to 4-address WDS; 0 = unbind
1612 * Returns: 0 on success, -1 on failure
1614 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val);
1617 * send_action - Transmit an Action frame
1618 * @priv: Private driver interface data
1619 * @freq: Frequency (in MHz) of the channel
1620 * @dst: Destination MAC address (Address 1)
1621 * @src: Source MAC address (Address 2)
1622 * @bssid: BSSID (Address 3)
1624 * @data_len: data length in octets
1625 * Returns: 0 on success, -1 on failure
1627 * This command can be used to request the driver to transmit an action
1628 * frame to the specified destination. If a remain-on-channel duration
1629 * is in progress, the frame is transmitted on that channel. Otherwise,
1630 * the frame is transmitted on the current operational channel if in
1631 * associated state in station mode or if operating as an AP. If none
1632 * of these conditions is in effect, send_action() cannot be used.
1634 int (*send_action)(void *priv, unsigned int freq,
1635 const u8 *dst, const u8 *src, const u8 *bssid,
1636 const u8 *data, size_t data_len);
1639 * alloc_interface_addr - Allocate a virtual interface address
1640 * @priv: Private driver interface data
1641 * @addr: Buffer for returning the address
1642 * @ifname: Buffer for returning interface name (if needed)
1643 * Returns: 0 on success, -1 on failure
1645 * This command pre-allocates an interface address for a new virtual
1646 * interface. This can be used before creating a virtual interface if
1647 * the interface mode (e.g., AP vs. station) is not yet known, but the
1648 * address of the virtual interface is already needed. This helps with
1649 * drivers that cannot change interface mode without destroying and
1650 * re-creating the interface. If the driver requires a specific
1651 * interface name to be used, the ifname buffer (up to IFNAMSIZ
1652 * characters) will be used to indicate which name must be used for
1653 * this virtual interface.
1655 * The allocated address can be used in a if_add() call to request a
1658 int (*alloc_interface_addr)(void *priv, u8 *addr, char *ifname);
1661 * release_interface_addr - Release a virtual interface address
1662 * @priv: Private driver interface data
1663 * @addr: Address to be freed from alloc_interface_addr()
1665 * This command is used to release a virtual interface address that was
1666 * allocated with alloc_interface_addr(), but has not yet been used
1667 * with if_add() to actually create the interface. This allows the
1668 * driver to release the pending allocation for a new interface.
1670 void (*release_interface_addr)(void *priv, const u8 *addr);
1673 * remain_on_channel - Remain awake on a channel
1674 * @priv: Private driver interface data
1675 * @freq: Frequency (in MHz) of the channel
1676 * @duration: Duration in milliseconds
1677 * Returns: 0 on success, -1 on failure
1679 * This command is used to request the driver to remain awake on the
1680 * specified channel for the specified duration and report received
1681 * Action frames with EVENT_RX_ACTION events. Optionally, received
1682 * Probe Request frames may also be requested to be reported by calling
1683 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
1685 * The driver may not be at the requested channel when this function
1686 * returns, i.e., the return code is only indicating whether the
1687 * request was accepted. The caller will need to wait until the
1688 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
1689 * completed the channel change. This may take some time due to other
1690 * need for the radio and the caller should be prepared to timing out
1691 * its wait since there are no guarantees on when this request can be
1694 int (*remain_on_channel)(void *priv, unsigned int freq,
1695 unsigned int duration);
1698 * cancel_remain_on_channel - Cancel remain-on-channel operation
1699 * @priv: Private driver interface data
1701 * This command can be used to cancel a remain-on-channel operation
1702 * before its originally requested duration has passed. This could be
1703 * used, e.g., when remain_on_channel() is used to request extra time
1704 * to receive a response to an Action frame and the response is
1705 * received when there is still unneeded time remaining on the
1706 * remain-on-channel operation.
1708 int (*cancel_remain_on_channel)(void *priv);
1711 * probe_req_report - Request Probe Request frames to be indicated
1712 * @priv: Private driver interface data
1713 * @report: Whether to report received Probe Request frames
1714 * Returns: 0 on success, -1 on failure (or if not supported)
1716 * This command can be used to request the driver to indicate when
1717 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
1718 * Since this operation may require extra resources, e.g., due to less
1719 * optimal hardware/firmware RX filtering, many drivers may disable
1720 * Probe Request reporting at least in station mode. This command is
1721 * used to notify the driver when the Probe Request frames need to be
1722 * reported, e.g., during remain-on-channel operations.
1724 int (*probe_req_report)(void *priv, int report);
1727 * disable_11b_rates - Set whether IEEE 802.11b rates are used for TX
1728 * @priv: Private driver interface data
1729 * @disabled: Whether IEEE 802.11b rates are disabled
1730 * Returns: 0 on success, -1 on failure (or if not supported)
1732 * This command is used to disable IEEE 802.11b rates (1, 2, 5.5, and
1733 * 11 Mbps) as TX rates for data and management frames. This can be
1734 * used to optimize channel use when there is no need to support IEEE
1735 * 802.11b-only devices.
1737 int (*disable_11b_rates)(void *priv, int disabled);
1740 * deinit_ap - Deinitialize AP mode
1741 * @priv: Private driver interface data
1742 * Returns: 0 on success, -1 on failure (or if not supported)
1744 * This optional function can be used to disable AP mode related
1745 * configuration and change the driver mode to station mode to allow
1746 * normal station operations like scanning to be completed.
1748 int (*deinit_ap)(void *priv);
1751 * suspend - Notification on system suspend/hibernate event
1752 * @priv: Private driver interface data
1754 void (*suspend)(void *priv);
1757 * resume - Notification on system resume/thaw event
1758 * @priv: Private driver interface data
1760 void (*resume)(void *priv);
1763 * signal_monitor - Set signal monitoring parameters
1764 * @priv: Private driver interface data
1765 * @threshold: Threshold value for signal change events; 0 = disabled
1766 * @hysteresis: Minimum change in signal strength before indicating a
1768 * Returns: 0 on success, -1 on failure (or if not supported)
1770 * This function can be used to configure monitoring of signal strength
1771 * with the current AP. Whenever signal strength drops below the
1772 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
1773 * should be generated assuming the signal strength has changed at
1774 * least %hysteresis from the previously indicated signal change event.
1776 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
1779 * send_frame - Send IEEE 802.11 frame (testing use only)
1780 * @priv: Private driver interface data
1781 * @data: IEEE 802.11 frame with IEEE 802.11 header
1782 * @data_len: Size of the frame
1783 * @encrypt: Whether to encrypt the frame (if keys are set)
1784 * Returns: 0 on success, -1 on failure
1786 * This function is only used for debugging purposes and is not
1787 * required to be implemented for normal operations.
1789 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
1795 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1797 enum wpa_event_type {
1799 * EVENT_ASSOC - Association completed
1801 * This event needs to be delivered when the driver completes IEEE
1802 * 802.11 association or reassociation successfully.
1803 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1804 * after this event has been generated. In addition, optional
1805 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1806 * more information about the association. If the driver interface gets
1807 * both of these events at the same time, it can also include the
1808 * assoc_info data in EVENT_ASSOC call.
1813 * EVENT_DISASSOC - Association lost
1815 * This event should be called when association is lost either due to
1816 * receiving deauthenticate or disassociate frame from the AP or when
1817 * sending either of these frames to the current AP. If the driver
1818 * supports separate deauthentication event, EVENT_DISASSOC should only
1819 * be used for disassociation and EVENT_DEAUTH for deauthentication.
1820 * In AP mode, union wpa_event_data::disassoc_info is required.
1825 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1827 * This event must be delivered when a Michael MIC error is detected by
1828 * the local driver. Additional data for event processing is
1829 * provided with union wpa_event_data::michael_mic_failure. This
1830 * information is used to request new encyption key and to initiate
1831 * TKIP countermeasures if needed.
1833 EVENT_MICHAEL_MIC_FAILURE,
1836 * EVENT_SCAN_RESULTS - Scan results available
1838 * This event must be called whenever scan results are available to be
1839 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1840 * is expected to be used some time after struct wpa_driver_ops::scan()
1841 * is called. If the driver provides an unsolicited event when the scan
1842 * has been completed, this event can be used to trigger
1843 * EVENT_SCAN_RESULTS call. If such event is not available from the
1844 * driver, the driver wrapper code is expected to use a registered
1845 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1846 * scan is expected to be completed. Optional information about
1847 * completed scan can be provided with union wpa_event_data::scan_info.
1852 * EVENT_ASSOCINFO - Report optional extra information for association
1854 * This event can be used to report extra association information for
1855 * EVENT_ASSOC processing. This extra information includes IEs from
1856 * association frames and Beacon/Probe Response frames in union
1857 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1858 * EVENT_ASSOC. Alternatively, the driver interface can include
1859 * assoc_info data in the EVENT_ASSOC call if it has all the
1860 * information available at the same point.
1865 * EVENT_INTERFACE_STATUS - Report interface status changes
1867 * This optional event can be used to report changes in interface
1868 * status (interface added/removed) using union
1869 * wpa_event_data::interface_status. This can be used to trigger
1870 * wpa_supplicant to stop and re-start processing for the interface,
1871 * e.g., when a cardbus card is ejected/inserted.
1873 EVENT_INTERFACE_STATUS,
1876 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1878 * This event can be used to inform wpa_supplicant about candidates for
1879 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1880 * for scan request (ap_scan=2 mode), this event is required for
1881 * pre-authentication. If wpa_supplicant is performing scan request
1882 * (ap_scan=1), this event is optional since scan results can be used
1883 * to add pre-authentication candidates. union
1884 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
1885 * candidate and priority of the candidate, e.g., based on the signal
1886 * strength, in order to try to pre-authenticate first with candidates
1887 * that are most likely targets for re-association.
1889 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
1890 * on the candidate list. In addition, it can be called for the current
1891 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
1892 * will automatically skip pre-authentication in cases where a valid
1893 * PMKSA exists. When more than one candidate exists, this event should
1894 * be generated once for each candidate.
1896 * Driver will be notified about successful pre-authentication with
1897 * struct wpa_driver_ops::add_pmkid() calls.
1899 EVENT_PMKID_CANDIDATE,
1902 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
1904 * This event can be used to inform wpa_supplicant about desire to set
1905 * up secure direct link connection between two stations as defined in
1906 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
1907 * STAKey negotiation. The caller will need to set peer address for the
1913 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
1915 * The driver is expected to report the received FT IEs from
1916 * FT authentication sequence from the AP. The FT IEs are included in
1917 * the extra information in union wpa_event_data::ft_ies.
1922 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
1924 * The driver can use this event to inform wpa_supplicant about a STA
1925 * in an IBSS with which protected frames could be exchanged. This
1926 * event starts RSN authentication with the other STA to authenticate
1927 * the STA and set up encryption keys with it.
1929 EVENT_IBSS_RSN_START,
1932 * EVENT_AUTH - Authentication result
1934 * This event should be called when authentication attempt has been
1935 * completed. This is only used if the driver supports separate
1936 * authentication step (struct wpa_driver_ops::authenticate).
1937 * Information about authentication result is included in
1938 * union wpa_event_data::auth.
1943 * EVENT_DEAUTH - Authentication lost
1945 * This event should be called when authentication is lost either due
1946 * to receiving deauthenticate frame from the AP or when sending that
1947 * frame to the current AP.
1948 * In AP mode, union wpa_event_data::deauth_info is required.
1953 * EVENT_ASSOC_REJECT - Association rejected
1955 * This event should be called when (re)association attempt has been
1956 * rejected by the AP. Information about authentication result is
1957 * included in union wpa_event_data::assoc_reject.
1962 * EVENT_AUTH_TIMED_OUT - Authentication timed out
1964 EVENT_AUTH_TIMED_OUT,
1967 * EVENT_ASSOC_TIMED_OUT - Association timed out
1969 EVENT_ASSOC_TIMED_OUT,
1972 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
1977 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
1979 EVENT_WPS_BUTTON_PUSHED,
1982 * EVENT_TX_STATUS - Report TX status
1987 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
1989 EVENT_RX_FROM_UNKNOWN,
1992 * EVENT_RX_MGMT - Report RX of a management frame
1997 * EVENT_RX_ACTION - Action frame received
1999 * This event is used to indicate when an Action frame has been
2000 * received. Information about the received frame is included in
2001 * union wpa_event_data::rx_action.
2006 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2008 * This event is used to indicate when the driver has started the
2009 * requested remain-on-channel duration. Information about the
2010 * operation is included in union wpa_event_data::remain_on_channel.
2012 EVENT_REMAIN_ON_CHANNEL,
2015 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2017 * This event is used to indicate when the driver has completed
2018 * remain-on-channel duration, i.e., may noot be available on the
2019 * requested channel anymore. Information about the
2020 * operation is included in union wpa_event_data::remain_on_channel.
2022 EVENT_CANCEL_REMAIN_ON_CHANNEL,
2025 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2027 * This event is used only by driver_test.c and userspace MLME.
2032 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2034 * This event is used to indicate when a Probe Request frame has been
2035 * received. Information about the received frame is included in
2036 * union wpa_event_data::rx_probe_req. The driver is required to report
2037 * these events only after successfully completed probe_req_report()
2038 * commands to request the events (i.e., report parameter is non-zero)
2039 * in station mode. In AP mode, Probe Request frames should always be
2045 * EVENT_NEW_STA - New wired device noticed
2047 * This event is used to indicate that a new device has been detected
2048 * in a network that does not use association-like functionality (i.e.,
2049 * mainly wired Ethernet). This can be used to start EAPOL
2050 * authenticator when receiving a frame from a device. The address of
2051 * the device is included in union wpa_event_data::new_sta.
2056 * EVENT_EAPOL_RX - Report received EAPOL frame
2058 * When in AP mode with hostapd, this event is required to be used to
2059 * deliver the receive EAPOL frames from the driver. With
2060 * %wpa_supplicant, this event is used only if the send_eapol() handler
2061 * is used to override the use of l2_packet for EAPOL frame TX.
2066 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
2068 * This event is used to indicate changes in the signal strength
2069 * observed in frames received from the current AP if signal strength
2070 * monitoring has been enabled with signal_monitor().
2077 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
2079 union wpa_event_data {
2081 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
2083 * This structure is optional for EVENT_ASSOC calls and required for
2084 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
2085 * driver interface does not need to generate separate EVENT_ASSOCINFO
2090 * req_ies - (Re)Association Request IEs
2092 * If the driver generates WPA/RSN IE, this event data must be
2093 * returned for WPA handshake to have needed information. If
2094 * wpa_supplicant-generated WPA/RSN IE is used, this
2095 * information event is optional.
2097 * This should start with the first IE (fixed fields before IEs
2098 * are not included).
2103 * req_ies_len - Length of req_ies in bytes
2108 * resp_ies - (Re)Association Response IEs
2110 * Optional association data from the driver. This data is not
2111 * required WPA, but may be useful for some protocols and as
2112 * such, should be reported if this is available to the driver
2115 * This should start with the first IE (fixed fields before IEs
2116 * are not included).
2121 * resp_ies_len - Length of resp_ies in bytes
2123 size_t resp_ies_len;
2126 * beacon_ies - Beacon or Probe Response IEs
2128 * Optional Beacon/ProbeResp data: IEs included in Beacon or
2129 * Probe Response frames from the current AP (i.e., the one
2130 * that the client just associated with). This information is
2131 * used to update WPA/RSN IE for the AP. If this field is not
2132 * set, the results from previous scan will be used. If no
2133 * data for the new AP is found, scan results will be requested
2134 * again (without scan request). At this point, the driver is
2135 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
2138 * This should start with the first IE (fixed fields before IEs
2139 * are not included).
2141 const u8 *beacon_ies;
2144 * beacon_ies_len - Length of beacon_ies */
2145 size_t beacon_ies_len;
2148 * freq - Frequency of the operational channel in MHz
2153 * addr - Station address (for AP mode)
2159 * struct disassoc_info - Data for EVENT_DISASSOC events
2161 struct disassoc_info {
2163 * addr - Station address (for AP mode)
2169 * struct deauth_info - Data for EVENT_DEAUTH events
2171 struct deauth_info {
2173 * addr - Station address (for AP mode)
2179 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
2181 struct michael_mic_failure {
2184 } michael_mic_failure;
2187 * struct interface_status - Data for EVENT_INTERFACE_STATUS
2189 struct interface_status {
2192 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
2197 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
2199 struct pmkid_candidate {
2200 /** BSSID of the PMKID candidate */
2202 /** Smaller the index, higher the priority */
2204 /** Whether RSN IE includes pre-authenticate flag */
2209 * struct stkstart - Data for EVENT_STKSTART
2216 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
2218 * During FT (IEEE 802.11r) authentication sequence, the driver is
2219 * expected to use this event to report received FT IEs (MDIE, FTIE,
2220 * RSN IE, TIE, possible resource request) to the supplicant. The FT
2221 * IEs for the next message will be delivered through the
2222 * struct wpa_driver_ops::update_ft_ies() callback.
2228 u8 target_ap[ETH_ALEN];
2229 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
2231 /** Length of ric_ies buffer in octets */
2236 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
2238 struct ibss_rsn_start {
2243 * struct auth_info - Data for EVENT_AUTH events
2254 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
2256 struct assoc_reject {
2258 * resp_ies - (Re)Association Response IEs
2260 * Optional association data from the driver. This data is not
2261 * required WPA, but may be useful for some protocols and as
2262 * such, should be reported if this is available to the driver
2265 * This should start with the first IE (fixed fields before IEs
2266 * are not included).
2271 * resp_ies_len - Length of resp_ies in bytes
2273 size_t resp_ies_len;
2276 * status_code - Status Code from (Re)association Response
2281 struct timeout_event {
2286 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
2295 * struct tx_status - Data for EVENT_TX_STATUS events
2307 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
2309 struct rx_from_unknown {
2315 * struct rx_mgmt - Data for EVENT_RX_MGMT events
2325 * struct rx_action - Data for EVENT_RX_ACTION events
2329 * da - Destination address of the received Action frame
2334 * sa - Source address of the received Action frame
2339 * bssid - Address 3 of the received Action frame
2344 * category - Action frame category
2349 * data - Action frame body after category field
2354 * len - Length of data in octets
2359 * freq - Frequency (in MHz) on which the frame was received
2365 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
2367 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
2369 struct remain_on_channel {
2371 * freq - Channel frequency in MHz
2376 * duration - Duration to remain on the channel in milliseconds
2378 unsigned int duration;
2379 } remain_on_channel;
2382 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
2383 * @aborted: Whether the scan was aborted
2384 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
2385 * @num_freqs: Number of entries in freqs array
2386 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
2388 * @num_ssids: Number of entries in ssids array
2394 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
2399 * struct mlme_rx - Data for EVENT_MLME_RX events
2410 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
2412 struct rx_probe_req {
2414 * sa - Source address of the received Probe Request frame
2419 * ie - IEs from the Probe Request body
2424 * ie_len - Length of ie buffer in octets
2430 * struct new_sta - Data for EVENT_NEW_STA events
2437 * struct eapol_rx - Data for EVENT_EAPOL_RX events
2446 * struct signal_change - Data for EVENT_SIGNAL_CHANGE events
2448 struct signal_change {
2449 int above_threshold;
2454 * wpa_supplicant_event - Report a driver event for wpa_supplicant
2455 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
2456 * with struct wpa_driver_ops::init()
2457 * @event: event type (defined above)
2458 * @data: possible extra data for the event
2460 * Driver wrapper code should call this function whenever an event is received
2463 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
2464 union wpa_event_data *data);
2468 * The following inline functions are provided for convenience to simplify
2469 * event indication for some of the common events.
2472 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
2475 union wpa_event_data event;
2476 os_memset(&event, 0, sizeof(event));
2477 event.assoc_info.req_ies = ie;
2478 event.assoc_info.req_ies_len = ielen;
2479 event.assoc_info.addr = addr;
2480 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
2483 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
2485 union wpa_event_data event;
2486 os_memset(&event, 0, sizeof(event));
2487 event.disassoc_info.addr = addr;
2488 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
2491 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
2494 union wpa_event_data event;
2495 os_memset(&event, 0, sizeof(event));
2496 event.eapol_rx.src = src;
2497 event.eapol_rx.data = data;
2498 event.eapol_rx.data_len = data_len;
2499 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
2502 #endif /* DRIVER_H */