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 AUTH_ALG_OPEN_SYSTEM 0x01
107 #define AUTH_ALG_SHARED_KEY 0x02
108 #define AUTH_ALG_LEAP 0x04
109 #define AUTH_ALG_FT 0x08
111 #define IEEE80211_MODE_INFRA 0
112 #define IEEE80211_MODE_IBSS 1
113 #define IEEE80211_MODE_AP 2
115 #define IEEE80211_CAP_ESS 0x0001
116 #define IEEE80211_CAP_IBSS 0x0002
117 #define IEEE80211_CAP_PRIVACY 0x0010
119 #define WPA_SCAN_QUAL_INVALID BIT(0)
120 #define WPA_SCAN_NOISE_INVALID BIT(1)
121 #define WPA_SCAN_LEVEL_INVALID BIT(2)
122 #define WPA_SCAN_LEVEL_DBM BIT(3)
123 #define WPA_SCAN_AUTHENTICATED BIT(4)
124 #define WPA_SCAN_ASSOCIATED BIT(5)
127 * struct wpa_scan_res - Scan result for an BSS/IBSS
128 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
130 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
131 * @beacon_int: beacon interval in TUs (host byte order)
132 * @caps: capability information field in host byte order
133 * @qual: signal quality
134 * @noise: noise level
135 * @level: signal level
137 * @age: Age of the information in milliseconds (i.e., how many milliseconds
138 * ago the last Beacon or Probe Response frame was received)
139 * @ie_len: length of the following IE field in octets
141 * This structure is used as a generic format for scan results from the
142 * driver. Each driver interface implementation is responsible for converting
143 * the driver or OS specific scan results into this format.
145 * If the driver does not support reporting all IEs, the IE data structure is
146 * constructed of the IEs that are available. This field will also need to
147 * include SSID in IE format. All drivers are encouraged to be extended to
148 * report all IEs to make it easier to support future additions.
150 struct wpa_scan_res {
162 /* followed by ie_len octets of IEs */
166 * struct wpa_scan_results - Scan results
167 * @res: Array of pointers to allocated variable length scan result entries
168 * @num: Number of entries in the scan result array
170 struct wpa_scan_results {
171 struct wpa_scan_res **res;
176 * struct wpa_interface_info - Network interface information
177 * @next: Pointer to the next interface or NULL if this is the last one
178 * @ifname: Interface name that can be used with init() or init2()
179 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
181 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
182 * is not an allocated copy, i.e., get_interfaces() caller will not free
185 struct wpa_interface_info {
186 struct wpa_interface_info *next;
189 const char *drv_name;
192 #define WPAS_MAX_SCAN_SSIDS 4
195 * struct wpa_driver_scan_params - Scan parameters
196 * Data for struct wpa_driver_ops::scan2().
198 struct wpa_driver_scan_params {
200 * ssids - SSIDs to scan for
202 struct wpa_driver_scan_ssid {
204 * ssid - specific SSID to scan for (ProbeReq)
205 * %NULL or zero-length SSID is used to indicate active scan
206 * with wildcard SSID.
210 * ssid_len: Length of the SSID in octets
213 } ssids[WPAS_MAX_SCAN_SSIDS];
216 * num_ssids - Number of entries in ssids array
217 * Zero indicates a request for a passive scan.
222 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
227 * extra_ies_len - Length of extra_ies in octets
229 size_t extra_ies_len;
232 * freqs - Array of frequencies to scan or %NULL for all frequencies
234 * The frequency is set in MHz. The array is zero-terminated.
240 * struct wpa_driver_auth_params - Authentication parameters
241 * Data for struct wpa_driver_ops::authenticate().
243 struct wpa_driver_auth_params {
251 const u8 *wep_key[4];
252 size_t wep_key_len[4];
257 * struct wpa_driver_associate_params - Association parameters
258 * Data for struct wpa_driver_ops::associate().
260 struct wpa_driver_associate_params {
262 * bssid - BSSID of the selected AP
263 * This can be %NULL, if ap_scan=2 mode is used and the driver is
264 * responsible for selecting with which BSS to associate. */
268 * ssid - The selected SSID
273 * ssid_len - Length of the SSID (1..32)
278 * freq - Frequency of the channel the selected AP is using
279 * Frequency that the selected AP is using (in MHz as
280 * reported in the scan results)
285 * wpa_ie - WPA information element for (Re)Association Request
286 * WPA information element to be included in (Re)Association
287 * Request (including information element id and length). Use
288 * of this WPA IE is optional. If the driver generates the WPA
289 * IE, it can use pairwise_suite, group_suite, and
290 * key_mgmt_suite to select proper algorithms. In this case,
291 * the driver has to notify wpa_supplicant about the used WPA
292 * IE by generating an event that the interface code will
293 * convert into EVENT_ASSOCINFO data (see below).
295 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
296 * instead. The driver can determine which version is used by
297 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
300 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
305 * wpa_ie_len - length of the wpa_ie
310 * pairwise_suite - Selected pairwise cipher suite
312 * This is usually ignored if @wpa_ie is used.
314 enum wpa_cipher pairwise_suite;
317 * group_suite - Selected group cipher suite
319 * This is usually ignored if @wpa_ie is used.
321 enum wpa_cipher group_suite;
324 * key_mgmt_suite - Selected key management suite
326 * This is usually ignored if @wpa_ie is used.
328 enum wpa_key_mgmt key_mgmt_suite;
331 * auth_alg - Allowed authentication algorithms
332 * Bit field of AUTH_ALG_*
337 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
342 * wep_key - WEP keys for static WEP configuration
344 const u8 *wep_key[4];
347 * wep_key_len - WEP key length for static WEP configuration
349 size_t wep_key_len[4];
352 * wep_tx_keyidx - WEP TX key index for static WEP configuration
357 * mgmt_frame_protection - IEEE 802.11w management frame protection
360 NO_MGMT_FRAME_PROTECTION,
361 MGMT_FRAME_PROTECTION_OPTIONAL,
362 MGMT_FRAME_PROTECTION_REQUIRED
363 } mgmt_frame_protection;
366 * ft_ies - IEEE 802.11r / FT information elements
367 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
368 * for fast transition, this parameter is set to include the IEs that
369 * are to be sent in the next FT Authentication Request message.
370 * update_ft_ies() handler is called to update the IEs for further
371 * FT messages in the sequence.
373 * The driver should use these IEs only if the target AP is advertising
374 * the same mobility domain as the one included in the MDIE here.
376 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
377 * AP after the initial association. These IEs can only be used if the
378 * target AP is advertising support for FT and is using the same MDIE
379 * and SSID as the current AP.
381 * The driver is responsible for reporting the FT IEs received from the
382 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
383 * type. update_ft_ies() handler will then be called with the FT IEs to
384 * include in the next frame in the authentication sequence.
389 * ft_ies_len - Length of ft_ies in bytes
394 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
396 * This value is provided to allow the driver interface easier access
397 * to the current mobility domain. This value is set to %NULL if no
398 * mobility domain is currently active.
403 * passphrase - RSN passphrase for PSK
405 * This value is made available only for WPA/WPA2-Personal (PSK) and
406 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
407 * the 8..63 character ASCII passphrase, if available. Please note that
408 * this can be %NULL if passphrase was not used to generate the PSK. In
409 * that case, the psk field must be used to fetch the PSK.
411 const char *passphrase;
414 * psk - RSN PSK (alternative for passphrase for PSK)
416 * This value is made available only for WPA/WPA2-Personal (PSK) and
417 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
418 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
419 * be prepared to handle %NULL value as an error.
424 * drop_unencrypted - Enable/disable unencrypted frame filtering
426 * Configure the driver to drop all non-EAPOL frames (both receive and
427 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
428 * still be allowed for key negotiation.
430 int drop_unencrypted;
433 * prev_bssid - Previously used BSSID in this ESS
435 * When not %NULL, this is a request to use reassociation instead of
438 const u8 *prev_bssid;
442 * struct wpa_driver_capa - Driver capability information
444 struct wpa_driver_capa {
445 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
446 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
447 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
448 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
449 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
450 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
451 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
452 unsigned int key_mgmt;
454 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
455 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
456 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
457 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
460 #define WPA_DRIVER_AUTH_OPEN 0x00000001
461 #define WPA_DRIVER_AUTH_SHARED 0x00000002
462 #define WPA_DRIVER_AUTH_LEAP 0x00000004
465 /* Driver generated WPA/RSN IE */
466 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
467 /* Driver needs static WEP key setup after association command */
468 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
469 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
470 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
471 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
472 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
473 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
474 /* Driver provides separate commands for authentication and association (SME in
475 * wpa_supplicant). */
476 #define WPA_DRIVER_FLAGS_SME 0x00000020
477 /* Driver supports AP mode */
478 #define WPA_DRIVER_FLAGS_AP 0x00000040
479 /* Driver needs static WEP key setup after association has been completed */
480 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
489 struct hostap_sta_driver_data {
490 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
491 unsigned long current_tx_rate;
492 unsigned long inactive_msec;
494 unsigned long num_ps_buf_frames;
495 unsigned long tx_retry_failed;
496 unsigned long tx_retry_count;
501 struct hostapd_sta_add_params {
505 const u8 *supp_rates;
506 size_t supp_rates_len;
508 const struct ieee80211_ht_capabilities *ht_capabilities;
511 struct hostapd_freq_params {
516 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
517 * secondary channel below primary, 1 = HT40
518 * enabled, secondary channel above primary */
521 enum wpa_driver_if_type {
523 * WPA_IF_STATION - Station mode interface
528 * WPA_IF_AP_VLAN - AP mode VLAN interface
530 * This interface shares its address and Beacon frame with the main
536 * WPA_IF_AP_BSS - AP mode BSS interface
538 * This interface has its own address and Beacon frame.
543 struct wpa_init_params {
548 const char *test_socket;
549 int use_pae_group_addr;
553 u8 *own_addr; /* buffer for writing own MAC address */
557 struct wpa_bss_params {
558 /** Interface name (for multi-SSID/VLAN support) */
560 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
571 #define WPA_STA_AUTHORIZED BIT(0)
572 #define WPA_STA_WMM BIT(1)
573 #define WPA_STA_SHORT_PREAMBLE BIT(2)
574 #define WPA_STA_MFP BIT(3)
577 * struct wpa_driver_ops - Driver interface API definition
579 * This structure defines the API that each driver interface needs to implement
580 * for core wpa_supplicant code. All driver specific functionality is captured
583 struct wpa_driver_ops {
584 /** Name of the driver interface */
586 /** One line description of the driver interface */
590 * get_bssid - Get the current BSSID
591 * @priv: private driver interface data
592 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
594 * Returns: 0 on success, -1 on failure
596 * Query kernel driver for the current BSSID and copy it to bssid.
597 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
600 int (*get_bssid)(void *priv, u8 *bssid);
603 * get_ssid - Get the current SSID
604 * @priv: private driver interface data
605 * @ssid: buffer for SSID (at least 32 bytes)
607 * Returns: Length of the SSID on success, -1 on failure
609 * Query kernel driver for the current SSID and copy it to ssid.
610 * Returning zero is recommended if the STA is not associated.
612 * Note: SSID is an array of octets, i.e., it is not nul terminated and
613 * can, at least in theory, contain control characters (including nul)
614 * and as such, should be processed as binary data, not a printable
617 int (*get_ssid)(void *priv, u8 *ssid);
620 * set_key - Configure encryption key
621 * @ifname: Interface name (for multi-SSID/VLAN support)
622 * @priv: private driver interface data
623 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
624 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
625 * %WPA_ALG_NONE clears the key.
626 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
627 * broadcast/default keys
628 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
630 * @set_tx: configure this key as the default Tx key (only used when
631 * driver does not support separate unicast/individual key
632 * @seq: sequence number/packet number, seq_len octets, the next
633 * packet number to be used for in replay protection; configured
634 * for Rx keys (in most cases, this is only used with broadcast
635 * keys and set to zero for unicast keys)
636 * @seq_len: length of the seq, depends on the algorithm:
637 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
638 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
640 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
641 * TKIP: 32, CCMP: 16, IGTK: 16)
643 * Returns: 0 on success, -1 on failure
645 * Configure the given key for the kernel driver. If the driver
646 * supports separate individual keys (4 default keys + 1 individual),
647 * addr can be used to determine whether the key is default or
648 * individual. If only 4 keys are supported, the default key with key
649 * index 0 is used as the individual key. STA must be configured to use
650 * it as the default Tx key (set_tx is set) and accept Rx for all the
651 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
652 * broadcast keys, so key index 0 is available for this kind of
655 * Please note that TKIP keys include separate TX and RX MIC keys and
656 * some drivers may expect them in different order than wpa_supplicant
657 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
658 * will tricker Michael MIC errors. This can be fixed by changing the
659 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
660 * in driver_*.c set_key() implementation, see driver_ndis.c for an
661 * example on how this can be done.
663 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
664 const u8 *addr, int key_idx, int set_tx,
665 const u8 *seq, size_t seq_len,
666 const u8 *key, size_t key_len);
669 * init - Initialize driver interface
670 * @ctx: context to be used when calling wpa_supplicant functions,
671 * e.g., wpa_supplicant_event()
672 * @ifname: interface name, e.g., wlan0
674 * Returns: Pointer to private data, %NULL on failure
676 * Initialize driver interface, including event processing for kernel
677 * driver events (e.g., associated, scan results, Michael MIC failure).
678 * This function can allocate a private configuration data area for
679 * @ctx, file descriptor, interface name, etc. information that may be
680 * needed in future driver operations. If this is not used, non-NULL
681 * value will need to be returned because %NULL is used to indicate
682 * failure. The returned value will be used as 'void *priv' data for
683 * all other driver_ops functions.
685 * The main event loop (eloop.c) of wpa_supplicant can be used to
686 * register callback for read sockets (eloop_register_read_sock()).
688 * See below for more information about events and
689 * wpa_supplicant_event() function.
691 void * (*init)(void *ctx, const char *ifname);
694 * deinit - Deinitialize driver interface
695 * @priv: private driver interface data from init()
697 * Shut down driver interface and processing of driver events. Free
698 * private data buffer if one was allocated in init() handler.
700 void (*deinit)(void *priv);
703 * set_param - Set driver configuration parameters
704 * @priv: private driver interface data from init()
705 * @param: driver specific configuration parameters
707 * Returns: 0 on success, -1 on failure
709 * Optional handler for notifying driver interface about configuration
710 * parameters (driver_param).
712 int (*set_param)(void *priv, const char *param);
715 * set_countermeasures - Enable/disable TKIP countermeasures
716 * @priv: private driver interface data
717 * @enabled: 1 = countermeasures enabled, 0 = disabled
719 * Returns: 0 on success, -1 on failure
721 * Configure TKIP countermeasures. When these are enabled, the driver
722 * should drop all received and queued frames that are using TKIP.
724 int (*set_countermeasures)(void *priv, int enabled);
727 * deauthenticate - Request driver to deauthenticate
728 * @priv: private driver interface data
729 * @addr: peer address (BSSID of the AP)
730 * @reason_code: 16-bit reason code to be sent in the deauthentication
733 * Returns: 0 on success, -1 on failure
735 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
738 * disassociate - Request driver to disassociate
739 * @priv: private driver interface data
740 * @addr: peer address (BSSID of the AP)
741 * @reason_code: 16-bit reason code to be sent in the disassociation
744 * Returns: 0 on success, -1 on failure
746 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
749 * associate - Request driver to associate
750 * @priv: private driver interface data
751 * @params: association parameters
753 * Returns: 0 on success, -1 on failure
755 int (*associate)(void *priv,
756 struct wpa_driver_associate_params *params);
759 * add_pmkid - Add PMKSA cache entry to the driver
760 * @priv: private driver interface data
761 * @bssid: BSSID for the PMKSA cache entry
762 * @pmkid: PMKID for the PMKSA cache entry
764 * Returns: 0 on success, -1 on failure
766 * This function is called when a new PMK is received, as a result of
767 * either normal authentication or RSN pre-authentication.
769 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
770 * associate(), add_pmkid() can be used to add new PMKSA cache entries
771 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
772 * driver_ops function does not need to be implemented. Likewise, if
773 * the driver does not support WPA, this function is not needed.
775 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
778 * remove_pmkid - Remove PMKSA cache entry to the driver
779 * @priv: private driver interface data
780 * @bssid: BSSID for the PMKSA cache entry
781 * @pmkid: PMKID for the PMKSA cache entry
783 * Returns: 0 on success, -1 on failure
785 * This function is called when the supplicant drops a PMKSA cache
786 * entry for any reason.
788 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
789 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
790 * between the driver and wpa_supplicant. If the driver uses wpa_ie
791 * from wpa_supplicant, this driver_ops function does not need to be
792 * implemented. Likewise, if the driver does not support WPA, this
793 * function is not needed.
795 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
798 * flush_pmkid - Flush PMKSA cache
799 * @priv: private driver interface data
801 * Returns: 0 on success, -1 on failure
803 * This function is called when the supplicant drops all PMKSA cache
804 * entries for any reason.
806 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
807 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
808 * between the driver and wpa_supplicant. If the driver uses wpa_ie
809 * from wpa_supplicant, this driver_ops function does not need to be
810 * implemented. Likewise, if the driver does not support WPA, this
811 * function is not needed.
813 int (*flush_pmkid)(void *priv);
816 * get_capa - Get driver capabilities
817 * @priv: private driver interface data
819 * Returns: 0 on success, -1 on failure
821 * Get driver/firmware/hardware capabilities.
823 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
826 * poll - Poll driver for association information
827 * @priv: private driver interface data
829 * This is an option callback that can be used when the driver does not
830 * provide event mechanism for association events. This is called when
831 * receiving WPA EAPOL-Key messages that require association
832 * information. The driver interface is supposed to generate associnfo
833 * event before returning from this callback function. In addition, the
834 * driver interface should generate an association event after having
835 * sent out associnfo.
837 void (*poll)(void *priv);
840 * get_ifname - Get interface name
841 * @priv: private driver interface data
843 * Returns: Pointer to the interface name. This can differ from the
844 * interface name used in init() call. Init() is called first.
846 * This optional function can be used to allow the driver interface to
847 * replace the interface name with something else, e.g., based on an
848 * interface mapping from a more descriptive name.
850 const char * (*get_ifname)(void *priv);
853 * get_mac_addr - Get own MAC address
854 * @priv: private driver interface data
856 * Returns: Pointer to own MAC address or %NULL on failure
858 * This optional function can be used to get the own MAC address of the
859 * device from the driver interface code. This is only needed if the
860 * l2_packet implementation for the OS does not provide easy access to
862 const u8 * (*get_mac_addr)(void *priv);
865 * send_eapol - Optional function for sending EAPOL packets
866 * @priv: private driver interface data
867 * @dest: Destination MAC address
869 * @data: EAPOL packet starting with IEEE 802.1X header
870 * @data_len: Size of the EAPOL packet
872 * Returns: 0 on success, -1 on failure
874 * This optional function can be used to override l2_packet operations
875 * with driver specific functionality. If this function pointer is set,
876 * l2_packet module is not used at all and the driver interface code is
877 * responsible for receiving and sending all EAPOL packets. The
878 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
879 * event. The driver interface is required to implement get_mac_addr()
880 * handler if send_eapol() is used.
882 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
883 const u8 *data, size_t data_len);
886 * set_operstate - Sets device operating state to DORMANT or UP
887 * @priv: private driver interface data
888 * @state: 0 = dormant, 1 = up
889 * Returns: 0 on success, -1 on failure
891 * This is an optional function that can be used on operating systems
892 * that support a concept of controlling network device state from user
893 * space applications. This function, if set, gets called with
894 * state = 1 when authentication has been completed and with state = 0
895 * when connection is lost.
897 int (*set_operstate)(void *priv, int state);
900 * mlme_setprotection - MLME-SETPROTECTION.request primitive
901 * @priv: Private driver interface data
902 * @addr: Address of the station for which to set protection (may be
903 * %NULL for group keys)
904 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
905 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
906 * Returns: 0 on success, -1 on failure
908 * This is an optional function that can be used to set the driver to
909 * require protection for Tx and/or Rx frames. This uses the layer
910 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
911 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
912 * set protection operation; instead, they set protection implicitly
913 * based on configured keys.
915 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
919 * get_hw_feature_data - Get hardware support data (channels and rates)
920 * @priv: Private driver interface data
921 * @num_modes: Variable for returning the number of returned modes
922 * flags: Variable for returning hardware feature flags
923 * Returns: Pointer to allocated hardware data on success or %NULL on
924 * failure. Caller is responsible for freeing this.
926 * This function is only needed for drivers that export MLME
927 * (management frame processing) to %wpa_supplicant or hostapd.
929 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
934 * set_channel - Set channel
935 * @priv: Private driver interface data
936 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
937 * @chan: IEEE 802.11 channel number
938 * @freq: Frequency of the channel in MHz
939 * Returns: 0 on success, -1 on failure
941 * This function is only needed for drivers that export MLME
942 * (management frame processing) to wpa_supplicant.
944 int (*set_channel)(void *priv, enum hostapd_hw_mode phymode, int chan,
948 * set_ssid - Set SSID
949 * @priv: Private driver interface data
951 * @ssid_len: SSID length
952 * Returns: 0 on success, -1 on failure
954 * This function is only needed for drivers that export MLME
955 * (management frame processing) to wpa_supplicant.
957 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
960 * set_bssid - Set BSSID
961 * @priv: Private driver interface data
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_bssid)(void *priv, const u8 *bssid);
971 * send_mlme - Send management frame from MLME
972 * @priv: Private driver interface data
973 * @data: IEEE 802.11 management frame with IEEE 802.11 header
974 * @data_len: Size of the management frame
975 * Returns: 0 on success, -1 on failure
977 * This function is only needed for drivers that export MLME
978 * (management frame processing) to wpa_supplicant.
980 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
983 * mlme_add_sta - Add a STA entry into the driver/netstack
984 * @priv: Private driver interface data
985 * @addr: MAC address of the STA (e.g., BSSID of the AP)
986 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
987 * format (one octet per rate, 1 = 0.5 Mbps)
988 * @supp_rates_len: Number of entries in supp_rates
989 * Returns: 0 on success, -1 on failure
991 * This function is only needed for drivers that export MLME
992 * (management frame processing) to wpa_supplicant. When the MLME code
993 * completes association with an AP, this function is called to
994 * configure the driver/netstack with a STA entry for data frame
995 * processing (TX rate control, encryption/decryption).
997 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
998 size_t supp_rates_len);
1001 * mlme_remove_sta - Remove a STA entry from the driver/netstack
1002 * @priv: Private driver interface data
1003 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1004 * Returns: 0 on success, -1 on failure
1006 * This function is only needed for drivers that export MLME
1007 * (management frame processing) to wpa_supplicant.
1009 int (*mlme_remove_sta)(void *priv, const u8 *addr);
1012 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1013 * @priv: Private driver interface data
1014 * @md: Mobility domain (2 octets) (also included inside ies)
1015 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1016 * @ies_len: Length of FT IEs in bytes
1017 * Returns: 0 on success, -1 on failure
1019 * The supplicant uses this callback to let the driver know that keying
1020 * material for FT is available and that the driver can use the
1021 * provided IEs in the next message in FT authentication sequence.
1023 * This function is only needed for driver that support IEEE 802.11r
1024 * (Fast BSS Transition).
1026 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1030 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1031 * @priv: Private driver interface data
1032 * @action: Action field value
1033 * @target_ap: Target AP address
1034 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1035 * @ies_len: Length of FT IEs in bytes
1036 * Returns: 0 on success, -1 on failure
1038 * The supplicant uses this callback to request the driver to transmit
1039 * an FT Action frame (action category 6) for over-the-DS fast BSS
1042 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1043 const u8 *ies, size_t ies_len);
1046 * get_scan_results2 - Fetch the latest scan results
1047 * @priv: private driver interface data
1049 * Returns: Allocated buffer of scan results (caller is responsible for
1050 * freeing the data structure) on success, NULL on failure
1052 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1055 * set_country - Set country
1056 * @priv: Private driver interface data
1057 * @alpha2: country to which to switch to
1058 * Returns: 0 on success, -1 on failure
1060 * This function is for drivers which support some form
1061 * of setting a regulatory domain.
1063 int (*set_country)(void *priv, const char *alpha2);
1066 * global_init - Global driver initialization
1067 * Returns: Pointer to private data (global), %NULL on failure
1069 * This optional function is called to initialize the driver wrapper
1070 * for global data, i.e., data that applies to all interfaces. If this
1071 * function is implemented, global_deinit() will also need to be
1072 * implemented to free the private data. The driver will also likely
1073 * use init2() function instead of init() to get the pointer to global
1074 * data available to per-interface initializer.
1076 void * (*global_init)(void);
1079 * global_deinit - Global driver deinitialization
1080 * @priv: private driver global data from global_init()
1082 * Terminate any global driver related functionality and free the
1083 * global data structure.
1085 void (*global_deinit)(void *priv);
1088 * init2 - Initialize driver interface (with global data)
1089 * @ctx: context to be used when calling wpa_supplicant functions,
1090 * e.g., wpa_supplicant_event()
1091 * @ifname: interface name, e.g., wlan0
1092 * @global_priv: private driver global data from global_init()
1093 * Returns: Pointer to private data, %NULL on failure
1095 * This function can be used instead of init() if the driver wrapper
1098 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1101 * get_interfaces - Get information about available interfaces
1102 * @global_priv: private driver global data from global_init()
1103 * Returns: Allocated buffer of interface information (caller is
1104 * responsible for freeing the data structure) on success, NULL on
1107 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1110 * scan2 - Request the driver to initiate scan
1111 * @priv: private driver interface data
1112 * @params: Scan parameters
1114 * Returns: 0 on success, -1 on failure
1116 * Once the scan results are ready, the driver should report scan
1117 * results event for wpa_supplicant which will eventually request the
1118 * results with wpa_driver_get_scan_results2().
1120 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1123 * authenticate - Request driver to authenticate
1124 * @priv: private driver interface data
1125 * @params: authentication parameters
1126 * Returns: 0 on success, -1 on failure
1128 * This is an optional function that can be used with drivers that
1129 * support separate authentication and association steps, i.e., when
1130 * wpa_supplicant can act as the SME. If not implemented, associate()
1131 * function is expected to take care of IEEE 802.11 authentication,
1134 int (*authenticate)(void *priv,
1135 struct wpa_driver_auth_params *params);
1138 * set_beacon - Set Beacon frame template
1139 * @iface: Interface name (main interface or virtual BSS)
1140 * @priv: Private driver interface data
1141 * @head: Beacon head from IEEE 802.11 header to IEs before TIM IE
1142 * @head_len: Length of the head buffer in octets
1143 * @tail: Beacon tail following TIM IE
1144 * @tail_len: Length of the tail buffer in octets
1145 * @dtim_period: DTIM period
1146 * @beacon_int: Beacon interval
1147 * Returns: 0 on success, -1 on failure
1149 * This function is used to configure Beacon template for the driver in
1150 * AP mode. The driver is responsible for building the full Beacon
1151 * frame by concatenating the head part with TIM IE generated by the
1152 * driver/firmware and finishing with the tail part.
1154 int (*set_beacon)(const char *ifname, void *priv,
1155 const u8 *head, size_t head_len,
1156 const u8 *tail, size_t tail_len, int dtim_period,
1160 * hapd_init - Initialize driver interface (hostapd only)
1161 * @hapd: Pointer to hostapd context
1162 * @params: Configuration for the driver wrapper
1163 * Returns: Pointer to private data, %NULL on failure
1165 * This function is used instead of init() or init2() when the driver
1166 * wrapper is used withh hostapd.
1168 void * (*hapd_init)(struct hostapd_data *hapd,
1169 struct wpa_init_params *params);
1172 * hapd_deinit - Deinitialize driver interface (hostapd only)
1173 * @priv: Private driver interface data from hapd_init()
1175 void (*hapd_deinit)(void *priv);
1178 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1179 * @priv: Private driver interface data
1180 * @params: BSS parameters
1181 * Returns: 0 on success, -1 on failure
1183 * This is an optional function to configure the kernel driver to
1184 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1185 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1186 * always enabled and the driver uses set_beacon() to set WPA/RSN IE
1187 * for Beacon frames.
1189 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1192 * set_privacy - Enable/disable privacy (AP only)
1193 * @priv: Private driver interface data
1194 * @enabled: 1 = privacy enabled, 0 = disabled
1195 * Returns: 0 on success, -1 on failure
1197 * This is an optional function to configure privacy field in the
1198 * kernel driver for Beacon frames. This can be left undefined (set to
1199 * %NULL) if the driver uses the Beacon template from set_beacon().
1201 int (*set_privacy)(const char *ifname, void *priv, int enabled);
1204 * get_seqnum - Fetch the current TSC/packet number (AP only)
1205 * @ifname: The interface name (main or virtual)
1206 * @priv: Private driver interface data
1207 * @addr: MAC address of the station or %NULL for group keys
1209 * @seq: Buffer for returning the latest used TSC/packet number
1210 * Returns: 0 on success, -1 on failure
1212 * This function is used to fetch the last used TSC/packet number for
1213 * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so
1214 * there is no strict requirement on implementing support for unicast
1215 * keys (i.e., addr != %NULL).
1217 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1221 * flush - Flush all association stations (AP only)
1222 * @priv: Private driver interface data
1223 * Returns: 0 on success, -1 on failure
1225 * This function requests the driver to disassociate all associated
1226 * stations. This function does not need to be implemented if the
1227 * driver does not process association frames internally.
1229 int (*flush)(void *priv);
1232 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1233 * @ifname: The interface name (main or virtual BSS)
1234 * @priv: Private driver interface data
1235 * @elem: Information elements
1236 * @elem_len: Length of the elem buffer in octets
1237 * Returns: 0 on success, -1 on failure
1239 * This is an optional function to add information elements in the
1240 * kernel driver for Beacon and Probe Response frames. This can be left
1241 * undefined (set to %NULL) if the driver uses the Beacon template from
1244 int (*set_generic_elem)(const char *ifname, void *priv, const u8 *elem,
1248 * read_sta_data - Fetch station data (AP only)
1249 * @priv: Private driver interface data
1250 * @data: Buffer for returning station information
1251 * @addr: MAC address of the station
1252 * Returns: 0 on success, -1 on failure
1254 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1258 * hapd_send_eapol - Send an EAPOL packet (AP only)
1259 * @priv: private driver interface data
1260 * @addr: Destination MAC address
1261 * @data: EAPOL packet starting with IEEE 802.1X header
1262 * @data_len: Length of the EAPOL packet in octets
1263 * @encrypt: Whether the frame should be encrypted
1264 * @own_addr: Source MAC address
1266 * Returns: 0 on success, -1 on failure
1268 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1269 size_t data_len, int encrypt,
1270 const u8 *own_addr);
1273 * sta_deauth - Deauthenticate a station (AP only)
1274 * @priv: Private driver interface data
1275 * @own_addr: Source address and BSSID for the Deauthentication frame
1276 * @addr: MAC address of the station to deauthenticate
1277 * @reason: Reason code for the Deauthentiation frame
1278 * Returns: 0 on success, -1 on failure
1280 * This function requests a specific station to be deauthenticated and
1281 * a Deauthentication frame to be sent to it.
1283 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1287 * sta_disassoc - Disassociate a station (AP only)
1288 * @priv: Private driver interface data
1289 * @own_addr: Source address and BSSID for the Disassociation frame
1290 * @addr: MAC address of the station to disassociate
1291 * @reason: Reason code for the Disassociation frame
1292 * Returns: 0 on success, -1 on failure
1294 * This function requests a specific station to be disassociated and
1295 * a Disassociation frame to be sent to it.
1297 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1301 * sta_remove - Remove a station entry (AP only)
1302 * @priv: Private driver interface data
1303 * @addr: MAC address of the station to be removed
1304 * Returns: 0 on success, -1 on failure
1306 int (*sta_remove)(void *priv, const u8 *addr);
1309 * hapd_get_ssid - Get the current SSID (AP only)
1310 * @ifname: Interface (master or virtual BSS)
1311 * @priv: Private driver interface data
1312 * @buf: Buffer for returning the SSID
1313 * @len: Maximum length of the buffer
1314 * Returns: Length of the SSID on success, -1 on failure
1316 * This function need not be implemented if the driver uses Beacon
1317 * template from set_beacon() and does not reply to Probe Request
1320 int (*hapd_get_ssid)(const char *ifname, void *priv, u8 *buf, int len);
1323 * hapd_set_ssid - Set SSID (AP only)
1324 * @ifname: Interface (master or virtual BSS)
1325 * @priv: Private driver interface data
1327 * @len: Length of the SSID in octets
1328 * Returns: 0 on success, -1 on failure
1330 int (*hapd_set_ssid)(const char *ifname, void *priv, const u8 *buf,
1333 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1334 * @priv: Private driver interface data
1335 * @enabled: 1 = countermeasures enabled, 0 = disabled
1336 * Returns: 0 on success, -1 on failure
1338 * This need not be implemented if the driver does not take care of
1339 * association processing.
1341 int (*hapd_set_countermeasures)(void *priv, int enabled);
1344 * sta_add - Add a station entry
1345 * @ifname: Interface (master or virtual)
1346 * @priv: Private driver interface data
1347 * @params: Station parameters
1348 * Returns: 0 on success, -1 on failure
1350 * This function is used to add a station entry to the driver once the
1351 * station has completed association. This is only used if the driver
1352 * does not take care of association processing.
1354 int (*sta_add)(const char *ifname, void *priv,
1355 struct hostapd_sta_add_params *params);
1358 * get_inact_sec - Get station inactivity duration (AP only)
1359 * @priv: Private driver interface data
1360 * @addr: Station address
1361 * Returns: Number of seconds station has been inactive, -1 on failure
1363 int (*get_inact_sec)(void *priv, const u8 *addr);
1366 * sta_clear_stats - Clear station statistics (AP only)
1367 * @priv: Private driver interface data
1368 * @addr: Station address
1369 * Returns: 0 on success, -1 on failure
1371 int (*sta_clear_stats)(void *priv, const u8 *addr);
1374 * set_freq - Set channel/frequency (AP only)
1375 * @priv: Private driver interface data
1376 * @freq: Channel parameters
1377 * Returns: 0 on success, -1 on failure
1379 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1382 * set_rts - Set RTS threshold
1383 * @priv: Private driver interface data
1384 * @rts: RTS threshold in octets
1385 * Returns: 0 on success, -1 on failure
1387 int (*set_rts)(void *priv, int rts);
1390 * set_frag - Set fragmentation threshold
1391 * @priv: Private driver interface data
1392 * @frag: Fragmentation threshold in octets
1393 * Returns: 0 on success, -1 on failure
1395 int (*set_frag)(void *priv, int frag);
1398 * sta_set_flags - Set station flags (AP only)
1399 * @priv: Private driver interface data
1400 * @addr: Station address
1401 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1402 * @flags_or: Bitmap of WPA_STA_* flags to add
1403 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1404 * Returns: 0 on success, -1 on failure
1406 int (*sta_set_flags)(void *priv, const u8 *addr,
1407 int total_flags, int flags_or, int flags_and);
1410 * set_rate_sets - Set supported and basic rate sets (AP only)
1411 * @priv: Private driver interface data
1412 * @supp_rates: -1 terminated array of supported rates in 100 kbps
1413 * @basic_rates: -1 terminated array of basic rates in 100 kbps
1414 * @mode: hardware mode (HOSTAPD_MODE_*)
1415 * Returns: 0 on success, -1 on failure
1417 int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
1421 * set_cts_protect - Set CTS protection mode (AP only)
1422 * @priv: Private driver interface data
1423 * @value: Whether CTS protection is enabled
1424 * Returns: 0 on success, -1 on failure
1426 int (*set_cts_protect)(void *priv, int value);
1429 * set_preamble - Set preamble mode (AP only)
1430 * @priv: Private driver interface data
1431 * @value: Whether short preamble is enabled
1432 * Returns: 0 on success, -1 on failure
1434 int (*set_preamble)(void *priv, int value);
1437 * set_short_slot_time - Set short slot time (AP only)
1438 * @priv: Private driver interface data
1439 * @value: Whether short slot time is enabled
1440 * Returns: 0 on success, -1 on failure
1442 int (*set_short_slot_time)(void *priv, int value);
1445 * set_tx_queue_params - Set TX queue parameters
1446 * @priv: Private driver interface data
1447 * @queue: Queue number
1451 * @burst_time: Maximum length for bursting in 0.1 msec units
1453 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1454 int cw_max, int burst_time);
1457 * valid_bss_mask - Validate BSSID mask
1458 * @priv: Private driver interface data
1461 * Returns: 0 if mask is valid, -1 if mask is not valid, 1 if mask can
1462 * be used, but the main interface address must be the first address in
1463 * the block if mask is applied
1465 int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
1468 * if_add - Add a virtual interface
1469 * @iface: Parent interface name
1470 * @priv: Private driver interface data
1471 * @type: Interface type
1472 * @ifname: Interface name for the new virtual interface
1473 * @addr: Local address to use for the interface or %NULL to use the
1474 * parent interface address
1475 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1476 * Returns: 0 on success, -1 on failure
1478 int (*if_add)(const char *iface, void *priv,
1479 enum wpa_driver_if_type type, const char *ifname,
1480 const u8 *addr, void *bss_ctx);
1483 * if_remove - Remove a virtual interface
1484 * @priv: Private driver interface data
1485 * @type: Interface type
1486 * @ifname: Interface name of the virtual interface to be removed
1487 * Returns: 0 on success, -1 on failure
1489 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1490 const char *ifname);
1493 * set_sta_vlan - Bind a station into a specific interface (AP only)
1494 * @priv: Private driver interface data
1495 * @ifname: Interface (main or virtual BSS or VLAN)
1496 * @addr: MAC address of the associated station
1498 * Returns: 0 on success, -1 on failure
1500 * This function is used to bind a station to a specific virtual
1501 * interface. It is only used if when virtual interfaces are supported,
1502 * e.g., to assign stations to different VLAN interfaces based on
1503 * information from a RADIUS server. This allows separate broadcast
1504 * domains to be used with a single BSS.
1506 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1510 * commit - Optional commit changes handler (AP only)
1511 * @priv: driver private data
1512 * Returns: 0 on success, -1 on failure
1514 * This optional handler function can be registered if the driver
1515 * interface implementation needs to commit changes (e.g., by setting
1516 * network interface up) at the end of initial configuration. If set,
1517 * this handler will be called after initial setup has been completed.
1519 int (*commit)(void *priv);
1522 * send_ether - Send an ethernet packet (AP only)
1523 * @priv: private driver interface data
1524 * @dst: Destination MAC address
1525 * @src: Source MAC address
1527 * @data: EAPOL packet starting with IEEE 802.1X header
1528 * @data_len: Length of the EAPOL packet in octets
1529 * Returns: 0 on success, -1 on failure
1531 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1532 const u8 *data, size_t data_len);
1535 * set_radius_acl_auth - Notification of RADIUS ACL change
1536 * @priv: Private driver interface data
1537 * @mac: MAC address of the station
1538 * @accepted: Whether the station was accepted
1539 * @session_timeout: Session timeout for the station
1540 * Returns: 0 on success, -1 on failure
1542 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1543 u32 session_timeout);
1546 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1547 * @priv: Private driver interface data
1548 * @mac: MAC address of the station
1549 * Returns: 0 on success, -1 on failure
1551 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1554 * set_ht_params - Set HT parameters (AP only)
1555 * @ifname: The interface name (main or virtual BSS)
1556 * @priv: Private driver interface data
1557 * @ht_capab: HT Capabilities IE
1558 * @ht_capab_len: Length of ht_capab in octets
1559 * @ht_oper: HT Operation IE
1560 * @ht_oper_len: Length of ht_oper in octets
1561 * Returns: 0 on success, -1 on failure
1563 int (*set_ht_params)(const char *ifname, void *priv,
1564 const u8 *ht_capab, size_t ht_capab_len,
1565 const u8 *ht_oper, size_t ht_oper_len);
1568 * set_ap_wps_ie - Add WPS IE into Beacon/Probe Response frames (AP)
1569 * @ifname: The interface name (main or virtual BSS)
1570 * @priv: Private driver interface data
1571 * @beacon: WPS IE for Beacon frames
1572 * @proberesp: WPS IE for Probe Response frames
1573 * Returns: 0 on success, -1 on failure
1575 * This is an optional function to add WPS IE in the kernel driver for
1576 * Beacon and Probe Response frames. This can be left undefined (set
1577 * to %NULL) if the driver uses the Beacon template from set_beacon()
1578 * and does not process Probe Request frames.
1580 int (*set_ap_wps_ie)(const char *ifname, void *priv,
1581 const struct wpabuf *beacon,
1582 const struct wpabuf *proberesp);
1585 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1586 * @priv: Private driver interface data
1587 * @authorized: Whether the port is authorized
1588 * Returns: 0 on success, -1 on failure
1590 int (*set_supp_port)(void *priv, int authorized);
1593 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1594 * @priv: Private driver interface data
1595 * @addr: MAC address of the associated station
1596 * @aid: Association ID
1597 * @val: 1 = bind to 4-address WDS; 0 = unbind
1598 * Returns: 0 on success, -1 on failure
1600 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val);
1603 * send_action - Transmit an Action frame
1604 * @priv: Private driver interface data
1605 * @freq: Frequency (in MHz) of the channel
1606 * @dst: Destination MAC address
1607 * @src: Source MAC address
1609 * @data_len: data length in octets
1610 * Returns: 0 on success, -1 on failure
1612 * This command can be used to request the driver to transmit an action
1613 * frame to the specified destination. If a remain-on-channel duration
1614 * is in progress, the frame is transmitted on that channel. Otherwise,
1615 * the frame is transmitted on the current operational channel if in
1616 * associated state in station mode or if operating as an AP. If none
1617 * of these conditions is in effect, send_action() cannot be used.
1619 int (*send_action)(void *priv, unsigned int freq,
1620 const u8 *dst, const u8 *src,
1621 const u8 *data, size_t data_len);
1624 * alloc_interface_addr - Allocate a virtual interface address
1625 * @priv: Private driver interface data
1626 * @addr: Buffer for returning the address
1627 * Returns: 0 on success, -1 on failure
1629 * This command pre-allocates an interface address for a new virtual
1630 * interface. This can be used before creating a virtual interface if
1631 * the interface mode (e.g., AP vs. station) is not yet known, but the
1632 * address of the virtual interface is already needed. This helps with
1633 * drivers that cannot change interface mode without destroying and
1634 * re-creating the interface.
1636 * The allocated address can be used in a bss_add() call to request a
1639 int (*alloc_interface_addr)(void *priv, u8 *addr);
1642 * release_interface_addr - Release a virtual interface address
1643 * @priv: Private driver interface data
1644 * @addr: Address to be freed from alloc_interface_addr()
1646 * This command is used to release a virtual interface address that was
1647 * allocated with alloc_interface_addr(), but has not yet been used
1648 * with bss_add() to actually create the interface. This allows the
1649 * driver to release the pending allocation for a new interface.
1651 void (*release_interface_addr)(void *priv, const u8 *addr);
1654 * remain_on_channel - Remain awake on a channel
1655 * @priv: Private driver interface data
1656 * @freq: Frequency (in MHz) of the channel
1657 * @duration: Duration in milliseconds
1658 * Returns: 0 on success, -1 on failure
1660 * This command is used to request the driver to remain awake on the
1661 * specified channel for the specified duration and report received
1662 * Action frames with EVENT_RX_ACTION events. Optionally, received
1663 * Probe Request frames may also be requested to be reported by calling
1664 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
1666 * The driver may not be at the requested channel when this function
1667 * returns, i.e., the return code is only indicating whether the
1668 * request was accepted. The caller will need to wait until the
1669 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
1670 * completed the channel change. This may take some time due to other
1671 * need for the radio and the caller should be prepared to timing out
1672 * its wait since there are no guarantees on when this request can be
1675 int (*remain_on_channel)(void *priv, unsigned int freq,
1676 unsigned int duration);
1679 * cancel_remain_on_channel - Cancel remain-on-channel operation
1680 * @priv: Private driver interface data
1682 * This command can be used to cancel a remain-on-channel operation
1683 * before its originally requested duration has passed. This could be
1684 * used, e.g., when remain_on_channel() is used to request extra time
1685 * to receive a response to an Action frame and the response is
1686 * received when there is still unneeded time remaining on the
1687 * remain-on-channel operation.
1689 int (*cancel_remain_on_channel)(void *priv);
1692 * probe_req_report - Request Probe Request frames to be indicated
1693 * @priv: Private driver interface data
1694 * @report: Whether to report received Probe Request frames
1695 * Returns: 0 on success, -1 on failure (or if not supported)
1697 * This command can be used to request the driver to indicate when
1698 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
1699 * Since this operation may require extra resources, e.g., due to less
1700 * optimal hardware/firmware RX filtering, many drivers may disable
1701 * Probe Request reporting at least in station mode. This command is
1702 * used to notify the driver when the Probe Request frames need to be
1703 * reported, e.g., during remain-on-channel operations.
1705 int (*probe_req_report)(void *priv, int report);
1710 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1712 enum wpa_event_type {
1714 * EVENT_ASSOC - Association completed
1716 * This event needs to be delivered when the driver completes IEEE
1717 * 802.11 association or reassociation successfully.
1718 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1719 * after this event has been generated. In addition, optional
1720 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1721 * more information about the association. If the driver interface gets
1722 * both of these events at the same time, it can also include the
1723 * assoc_info data in EVENT_ASSOC call.
1728 * EVENT_DISASSOC - Association lost
1730 * This event should be called when association is lost either due to
1731 * receiving deauthenticate or disassociate frame from the AP or when
1732 * sending either of these frames to the current AP. If the driver
1733 * supports separate deauthentication event, EVENT_DISASSOC should only
1734 * be used for disassociation and EVENT_DEAUTH for deauthentication.
1735 * In AP mode, union wpa_event_data::disassoc_info is required.
1740 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1742 * This event must be delivered when a Michael MIC error is detected by
1743 * the local driver. Additional data for event processing is
1744 * provided with union wpa_event_data::michael_mic_failure. This
1745 * information is used to request new encyption key and to initiate
1746 * TKIP countermeasures if needed.
1748 EVENT_MICHAEL_MIC_FAILURE,
1751 * EVENT_SCAN_RESULTS - Scan results available
1753 * This event must be called whenever scan results are available to be
1754 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1755 * is expected to be used some time after struct wpa_driver_ops::scan()
1756 * is called. If the driver provides an unsolicited event when the scan
1757 * has been completed, this event can be used to trigger
1758 * EVENT_SCAN_RESULTS call. If such event is not available from the
1759 * driver, the driver wrapper code is expected to use a registered
1760 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1761 * scan is expected to be completed. Optional information about
1762 * completed scan can be provided with union wpa_event_data::scan_info.
1767 * EVENT_ASSOCINFO - Report optional extra information for association
1769 * This event can be used to report extra association information for
1770 * EVENT_ASSOC processing. This extra information includes IEs from
1771 * association frames and Beacon/Probe Response frames in union
1772 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1773 * EVENT_ASSOC. Alternatively, the driver interface can include
1774 * assoc_info data in the EVENT_ASSOC call if it has all the
1775 * information available at the same point.
1780 * EVENT_INTERFACE_STATUS - Report interface status changes
1782 * This optional event can be used to report changes in interface
1783 * status (interface added/removed) using union
1784 * wpa_event_data::interface_status. This can be used to trigger
1785 * wpa_supplicant to stop and re-start processing for the interface,
1786 * e.g., when a cardbus card is ejected/inserted.
1788 EVENT_INTERFACE_STATUS,
1791 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1793 * This event can be used to inform wpa_supplicant about candidates for
1794 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1795 * for scan request (ap_scan=2 mode), this event is required for
1796 * pre-authentication. If wpa_supplicant is performing scan request
1797 * (ap_scan=1), this event is optional since scan results can be used
1798 * to add pre-authentication candidates. union
1799 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
1800 * candidate and priority of the candidate, e.g., based on the signal
1801 * strength, in order to try to pre-authenticate first with candidates
1802 * that are most likely targets for re-association.
1804 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
1805 * on the candidate list. In addition, it can be called for the current
1806 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
1807 * will automatically skip pre-authentication in cases where a valid
1808 * PMKSA exists. When more than one candidate exists, this event should
1809 * be generated once for each candidate.
1811 * Driver will be notified about successful pre-authentication with
1812 * struct wpa_driver_ops::add_pmkid() calls.
1814 EVENT_PMKID_CANDIDATE,
1817 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
1819 * This event can be used to inform wpa_supplicant about desire to set
1820 * up secure direct link connection between two stations as defined in
1821 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
1822 * STAKey negotiation. The caller will need to set peer address for the
1828 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
1830 * The driver is expected to report the received FT IEs from
1831 * FT authentication sequence from the AP. The FT IEs are included in
1832 * the extra information in union wpa_event_data::ft_ies.
1837 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
1839 * The driver can use this event to inform wpa_supplicant about a STA
1840 * in an IBSS with which protected frames could be exchanged. This
1841 * event starts RSN authentication with the other STA to authenticate
1842 * the STA and set up encryption keys with it.
1844 EVENT_IBSS_RSN_START,
1847 * EVENT_AUTH - Authentication result
1849 * This event should be called when authentication attempt has been
1850 * completed. This is only used if the driver supports separate
1851 * authentication step (struct wpa_driver_ops::authenticate).
1852 * Information about authentication result is included in
1853 * union wpa_event_data::auth.
1858 * EVENT_DEAUTH - Authentication lost
1860 * This event should be called when authentication is lost either due
1861 * to receiving deauthenticate frame from the AP or when sending that
1862 * frame to the current AP.
1863 * In AP mode, union wpa_event_data::deauth_info is required.
1868 * EVENT_ASSOC_REJECT - Association rejected
1870 * This event should be called when (re)association attempt has been
1871 * rejected by the AP. Information about authentication result is
1872 * included in union wpa_event_data::assoc_reject.
1877 * EVENT_AUTH_TIMED_OUT - Authentication timed out
1879 EVENT_AUTH_TIMED_OUT,
1882 * EVENT_ASSOC_TIMED_OUT - Association timed out
1884 EVENT_ASSOC_TIMED_OUT,
1887 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
1892 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
1894 EVENT_WPS_BUTTON_PUSHED,
1897 * EVENT_TX_STATUS - Report TX status
1902 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
1904 EVENT_RX_FROM_UNKNOWN,
1907 * EVENT_RX_MGMT - Report RX of a management frame
1912 * EVENT_RX_ACTION - Action frame received
1914 * This event is used to indicate when an Action frame has been
1915 * received. Information about the received frame is included in
1916 * union wpa_event_data::rx_action.
1921 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
1923 * This event is used to indicate when the driver has started the
1924 * requested remain-on-channel duration. Information about the
1925 * operation is included in union wpa_event_data::remain_on_channel.
1927 EVENT_REMAIN_ON_CHANNEL,
1930 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
1932 * This event is used to indicate when the driver has completed
1933 * remain-on-channel duration, i.e., may noot be available on the
1934 * requested channel anymore. Information about the
1935 * operation is included in union wpa_event_data::remain_on_channel.
1937 EVENT_CANCEL_REMAIN_ON_CHANNEL,
1940 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
1942 * This event is used only by driver_test.c and userspace MLME.
1947 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
1949 * This event is used to indicate when a Probe Request frame has been
1950 * received. Information about the received frame is included in
1951 * union wpa_event_data::rx_probe_req. The driver is required to report
1952 * these events only after successfully completed probe_req_report()
1953 * commands to request the events (i.e., report parameter is non-zero)
1954 * in station mode. In AP mode, Probe Request frames should always be
1960 * EVENT_NEW_STA - New wired device noticed
1962 * This event is used to indicate that a new device has been detected
1963 * in a network that does not use association-like functionality (i.e.,
1964 * mainly wired Ethernet). This can be used to start EAPOL
1965 * authenticator when receiving a frame from a device. The address of
1966 * the device is included in union wpa_event_data::new_sta.
1971 * EVENT_EAPOL_RX - Report received EAPOL frame
1973 * When in AP mode with hostapd, this event is required to be used to
1974 * deliver the receive EAPOL frames from the driver. With
1975 * %wpa_supplicant, this event is used only if the send_eapol() handler
1976 * is used to override the use of l2_packet for EAPOL frame TX.
1983 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
1985 union wpa_event_data {
1987 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
1989 * This structure is optional for EVENT_ASSOC calls and required for
1990 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
1991 * driver interface does not need to generate separate EVENT_ASSOCINFO
1996 * req_ies - (Re)Association Request IEs
1998 * If the driver generates WPA/RSN IE, this event data must be
1999 * returned for WPA handshake to have needed information. If
2000 * wpa_supplicant-generated WPA/RSN IE is used, this
2001 * information event is optional.
2003 * This should start with the first IE (fixed fields before IEs
2004 * are not included).
2009 * req_ies_len - Length of req_ies in bytes
2014 * resp_ies - (Re)Association Response IEs
2016 * Optional association data from the driver. This data is not
2017 * required WPA, but may be useful for some protocols and as
2018 * such, should be reported if this is available to the driver
2021 * This should start with the first IE (fixed fields before IEs
2022 * are not included).
2027 * resp_ies_len - Length of resp_ies in bytes
2029 size_t resp_ies_len;
2032 * beacon_ies - Beacon or Probe Response IEs
2034 * Optional Beacon/ProbeResp data: IEs included in Beacon or
2035 * Probe Response frames from the current AP (i.e., the one
2036 * that the client just associated with). This information is
2037 * used to update WPA/RSN IE for the AP. If this field is not
2038 * set, the results from previous scan will be used. If no
2039 * data for the new AP is found, scan results will be requested
2040 * again (without scan request). At this point, the driver is
2041 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
2044 * This should start with the first IE (fixed fields before IEs
2045 * are not included).
2047 const u8 *beacon_ies;
2050 * beacon_ies_len - Length of beacon_ies */
2051 size_t beacon_ies_len;
2054 * freq - Frequency of the operational channel in MHz
2059 * addr - Station address (for AP mode)
2065 * struct disassoc_info - Data for EVENT_DISASSOC events
2067 struct disassoc_info {
2069 * addr - Station address (for AP mode)
2075 * struct deauth_info - Data for EVENT_DEAUTH events
2077 struct deauth_info {
2079 * addr - Station address (for AP mode)
2085 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
2087 struct michael_mic_failure {
2090 } michael_mic_failure;
2093 * struct interface_status - Data for EVENT_INTERFACE_STATUS
2095 struct interface_status {
2098 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
2103 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
2105 struct pmkid_candidate {
2106 /** BSSID of the PMKID candidate */
2108 /** Smaller the index, higher the priority */
2110 /** Whether RSN IE includes pre-authenticate flag */
2115 * struct stkstart - Data for EVENT_STKSTART
2122 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
2124 * During FT (IEEE 802.11r) authentication sequence, the driver is
2125 * expected to use this event to report received FT IEs (MDIE, FTIE,
2126 * RSN IE, TIE, possible resource request) to the supplicant. The FT
2127 * IEs for the next message will be delivered through the
2128 * struct wpa_driver_ops::update_ft_ies() callback.
2134 u8 target_ap[ETH_ALEN];
2135 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
2137 /** Length of ric_ies buffer in octets */
2142 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
2144 struct ibss_rsn_start {
2149 * struct auth_info - Data for EVENT_AUTH events
2160 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
2162 struct assoc_reject {
2164 * resp_ies - (Re)Association Response IEs
2166 * Optional association data from the driver. This data is not
2167 * required WPA, but may be useful for some protocols and as
2168 * such, should be reported if this is available to the driver
2171 * This should start with the first IE (fixed fields before IEs
2172 * are not included).
2177 * resp_ies_len - Length of resp_ies in bytes
2179 size_t resp_ies_len;
2182 * status_code - Status Code from (Re)association Response
2187 struct timeout_event {
2192 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
2201 * struct tx_status - Data for EVENT_TX_STATUS events
2213 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
2215 struct rx_from_unknown {
2221 * struct rx_mgmt - Data for EVENT_RX_MGMT events
2231 * struct rx_action - Data for EVENT_RX_ACTION events
2235 * sa - Source address of the received Action frame
2240 * category - Action frame category
2245 * data - Action frame body after category field
2250 * len - Length of data in octets
2255 * freq - Frequency (in MHz) on which the frame was received
2261 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
2263 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
2265 struct remain_on_channel {
2267 * freq - Channel frequency in MHz
2272 * duration - Duration to remain on the channel in milliseconds
2274 unsigned int duration;
2275 } remain_on_channel;
2278 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
2279 * @aborted: Whether the scan was aborted
2280 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
2281 * @num_freqs: Number of entries in freqs array
2282 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
2284 * @num_ssids: Number of entries in ssids array
2290 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
2295 * struct mlme_rx - Data for EVENT_MLME_RX events
2306 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
2308 struct rx_probe_req {
2310 * sa - Source address of the received Probe Request frame
2315 * ie - IEs from the Probe Request body
2320 * ie_len - Length of ie buffer in octets
2326 * struct new_sta - Data for EVENT_NEW_STA events
2333 * struct eapol_rx - Data for EVENT_EAPOL_RX events
2343 * wpa_supplicant_event - Report a driver event for wpa_supplicant
2344 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
2345 * with struct wpa_driver_ops::init()
2346 * @event: event type (defined above)
2347 * @data: possible extra data for the event
2349 * Driver wrapper code should call this function whenever an event is received
2352 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
2353 union wpa_event_data *data);
2357 * The following inline functions are provided for convenience to simplify
2358 * event indication for some of the common events.
2361 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
2364 union wpa_event_data event;
2365 os_memset(&event, 0, sizeof(event));
2366 event.assoc_info.req_ies = ie;
2367 event.assoc_info.req_ies_len = ielen;
2368 event.assoc_info.addr = addr;
2369 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
2372 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
2374 union wpa_event_data event;
2375 os_memset(&event, 0, sizeof(event));
2376 event.disassoc_info.addr = addr;
2377 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
2380 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
2383 union wpa_event_data event;
2384 os_memset(&event, 0, sizeof(event));
2385 event.eapol_rx.src = src;
2386 event.eapol_rx.data = data;
2387 event.eapol_rx.data_len = data_len;
2388 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
2391 #endif /* DRIVER_H */