Replace hostapd_michael_mic_failure() with generic driver event
[libeap.git] / src / drivers / driver.h
index 6962942..228ce6b 100644 (file)
@@ -15,9 +15,9 @@
 #ifndef DRIVER_H
 #define DRIVER_H
 
-#define WPA_SUPPLICANT_DRIVER_VERSION 3
+#define WPA_SUPPLICANT_DRIVER_VERSION 4
 
-#include "defs.h"
+#include "common/defs.h"
 
 #define HOSTAPD_CHAN_DISABLED 0x00000001
 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
@@ -31,26 +31,15 @@ struct hostapd_channel_data {
        u8 max_tx_power; /* maximum transmit power in dBm */
 };
 
-#define HOSTAPD_RATE_ERP 0x00000001
-#define HOSTAPD_RATE_BASIC 0x00000002
-#define HOSTAPD_RATE_PREAMBLE2 0x00000004
-#define HOSTAPD_RATE_SUPPORTED 0x00000010
-#define HOSTAPD_RATE_OFDM 0x00000020
-#define HOSTAPD_RATE_CCK 0x00000040
-#define HOSTAPD_RATE_MANDATORY 0x00000100
-
-struct hostapd_rate_data {
-       int rate; /* rate in 100 kbps */
-       int flags; /* HOSTAPD_RATE_ flags */
-};
-
 struct hostapd_hw_modes {
        hostapd_hw_mode mode;
        int num_channels;
        struct hostapd_channel_data *channels;
        int num_rates;
-       struct hostapd_rate_data *rates;
+       int *rates; /* array of rates in 100 kbps units */
        u16 ht_capab;
+       u8 mcs_set[16];
+       u8 a_mpdu_params;
 };
 
 
@@ -67,61 +56,12 @@ struct hostapd_hw_modes {
 #define IEEE80211_CAP_IBSS     0x0002
 #define IEEE80211_CAP_PRIVACY  0x0010
 
-#define SSID_MAX_WPA_IE_LEN 40
-/**
- * struct wpa_scan_result - Scan results (old structure)
- * @bssid: BSSID
- * @ssid: SSID
- * @ssid_len: length of the ssid
- * @wpa_ie: WPA IE
- * @wpa_ie_len: length of the wpa_ie
- * @rsn_ie: RSN IE
- * @rsn_ie_len: length of the RSN IE
- * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
- * @caps: capability information field in host byte order
- * @qual: signal quality
- * @noise: noise level
- * @level: signal level
- * @maxrate: maximum supported rate
- * @mdie_present: Whether MDIE was included in Beacon/ProbeRsp frame
- * @mdie: Mobility domain identifier IE (IEEE 802.11r MDIE) (starting from
- * IE type field)
- * @tsf: Timestamp
- *
- * This structure is used as a generic format for scan results from the
- * driver. Each driver interface implementation is responsible for converting
- * the driver or OS specific scan results into this format.
- *
- * This structure is the old data structure used for scan results. It is
- * obsoleted by the new struct wpa_scan_res structure and the old version is
- * only included for backwards compatibility with existing driver wrapper
- * implementations. New implementations are encouraged to implement for struct
- * wpa_scan_res. The old structure will be removed at some point.
- */
-struct wpa_scan_result {
-       u8 bssid[ETH_ALEN];
-       u8 ssid[32];
-       size_t ssid_len;
-       u8 wpa_ie[SSID_MAX_WPA_IE_LEN];
-       size_t wpa_ie_len;
-       u8 rsn_ie[SSID_MAX_WPA_IE_LEN];
-       size_t rsn_ie_len;
-       int freq;
-       u16 caps;
-       int qual;
-       int noise;
-       int level;
-       int maxrate;
-       int mdie_present;
-       u8 mdie[5];
-       u64 tsf;
-};
-
-
 #define WPA_SCAN_QUAL_INVALID          BIT(0)
 #define WPA_SCAN_NOISE_INVALID         BIT(1)
 #define WPA_SCAN_LEVEL_INVALID         BIT(2)
 #define WPA_SCAN_LEVEL_DBM             BIT(3)
+#define WPA_SCAN_AUTHENTICATED         BIT(4)
+#define WPA_SCAN_ASSOCIATED            BIT(5)
 
 /**
  * struct wpa_scan_res - Scan result for an BSS/IBSS
@@ -134,6 +74,8 @@ struct wpa_scan_result {
  * @noise: noise level
  * @level: signal level
  * @tsf: Timestamp
+ * @age: Age of the information in milliseconds (i.e., how many milliseconds
+ * ago the last Beacon or Probe Response frame was received)
  * @ie_len: length of the following IE field in octets
  *
  * This structure is used as a generic format for scan results from the
@@ -155,6 +97,7 @@ struct wpa_scan_res {
        int noise;
        int level;
        u64 tsf;
+       unsigned int age;
        size_t ie_len;
        /* followed by ie_len octets of IEs */
 };
@@ -405,6 +348,14 @@ struct wpa_driver_associate_params {
         * still be allowed for key negotiation.
         */
        int drop_unencrypted;
+
+       /**
+        * prev_bssid - Previously used BSSID in this ESS
+        *
+        * When not %NULL, this is a request to use reassociation instead of
+        * association.
+        */
+       const u8 *prev_bssid;
 };
 
 /**
@@ -433,6 +384,7 @@ struct wpa_driver_capa {
 
 /* Driver generated WPA/RSN IE */
 #define WPA_DRIVER_FLAGS_DRIVER_IE     0x00000001
+/* Driver needs static WEP key setup after association command */
 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
@@ -444,6 +396,8 @@ struct wpa_driver_capa {
 #define WPA_DRIVER_FLAGS_SME           0x00000020
 /* Driver supports AP mode */
 #define WPA_DRIVER_FLAGS_AP            0x00000040
+/* Driver needs static WEP key setup after association has been completed */
+#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE     0x00000080
        unsigned int flags;
 
        int max_scan_ssids;
@@ -476,9 +430,8 @@ struct hostapd_sta_add_params {
        u16 capability;
        const u8 *supp_rates;
        size_t supp_rates_len;
-       int flags;
        u16 listen_interval;
-       const struct ht_cap_ie *ht_capabilities;
+       const struct ieee80211_ht_capabilities *ht_capabilities;
 };
 
 struct hostapd_freq_params {
@@ -491,8 +444,26 @@ struct hostapd_freq_params {
                                 * enabled, secondary channel above primary */
 };
 
-enum hostapd_driver_if_type {
-       HOSTAPD_IF_VLAN, HOSTAPD_IF_WDS
+enum wpa_driver_if_type {
+       /**
+        * WPA_IF_STATION - Station mode interface
+        */
+       WPA_IF_STATION,
+
+       /**
+        * WPA_IF_AP_VLAN - AP mode VLAN interface
+        *
+        * This interface shares its address and Beacon frame with the main
+        * BSS.
+        */
+       WPA_IF_AP_VLAN,
+
+       /**
+        * WPA_IF_AP_BSS - AP mode BSS interface
+        *
+        * This interface has its own address and Beacon frame.
+        */
+       WPA_IF_AP_BSS,
 };
 
 struct wpa_init_params {
@@ -504,8 +475,29 @@ struct wpa_init_params {
        int use_pae_group_addr;
        char **bridge;
        size_t num_bridge;
+
+       u8 *own_addr; /* buffer for writing own MAC address */
+};
+
+
+struct wpa_bss_params {
+       /** Interface name (for multi-SSID/VLAN support) */
+       const char *ifname;
+       /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
+       int enabled;
+
+       int wpa;
+       int ieee802_1x;
+       int wpa_group;
+       int wpa_pairwise;
+       int wpa_key_mgmt;
+       int rsn_preauth;
 };
 
+#define WPA_STA_AUTHORIZED BIT(0)
+#define WPA_STA_WMM BIT(1)
+#define WPA_STA_SHORT_PREAMBLE BIT(2)
+#define WPA_STA_MFP BIT(3)
 
 /**
  * struct wpa_driver_ops - Driver interface API definition
@@ -551,31 +543,8 @@ struct wpa_driver_ops {
        int (*get_ssid)(void *priv, u8 *ssid);
 
        /**
-        * set_wpa - Enable/disable WPA support (OBSOLETE)
-        * @priv: private driver interface data
-        * @enabled: 1 = enable, 0 = disable
-        *
-        * Returns: 0 on success, -1 on failure
-        *
-        * Note: This function is included for backwards compatibility. This is
-        * called only just after init and just before deinit, so these
-        * functions can be used to implement same functionality and the driver
-        * interface need not define this function.
-        *
-        * Configure the kernel driver to enable/disable WPA support. This may
-        * be empty function, if WPA support is always enabled. Common
-        * configuration items are WPA IE (clearing it when WPA support is
-        * disabled), Privacy flag configuration for capability field (note:
-        * this the value need to set in associate handler to allow plaintext
-        * mode to be used) when trying to associate with, roaming mode (can
-        * allow wpa_supplicant to control roaming if ap_scan=1 is used;
-        * however, drivers can also implement roaming if desired, especially
-        * ap_scan=2 mode is used for this).
-        */
-       int (*set_wpa)(void *priv, int enabled);
-
-       /**
         * set_key - Configure encryption key
+        * @ifname: Interface name (for multi-SSID/VLAN support)
         * @priv: private driver interface data
         * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
         *      %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
@@ -617,8 +586,9 @@ struct wpa_driver_ops {
         * in driver_*.c set_key() implementation, see driver_ndis.c for an
         * example on how this can be done.
         */
-       int (*set_key)(void *priv, wpa_alg alg, const u8 *addr,
-                      int key_idx, int set_tx, const u8 *seq, size_t seq_len,
+       int (*set_key)(const char *ifname, void *priv, wpa_alg alg,
+                      const u8 *addr, int key_idx, int set_tx,
+                      const u8 *seq, size_t seq_len,
                       const u8 *key, size_t key_len);
 
        /**
@@ -680,61 +650,6 @@ struct wpa_driver_ops {
        int (*set_countermeasures)(void *priv, int enabled);
 
        /**
-        * set_drop_unencrypted - Enable/disable unencrypted frame filtering
-        * @priv: private driver interface data
-        * @enabled: 1 = unencrypted Tx/Rx frames will be dropped, 0 = disabled
-        *
-        * Returns: 0 on success, -1 on failure
-        *
-        * Configure the driver to drop all non-EAPOL frames (both receive and
-        * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
-        * still be allowed for key negotiation.
-        *
-        * This function is deprecated. New driver wrapper implementations
-        * should use associate() parameter drop_unencrypted instead.
-        */
-       int (*set_drop_unencrypted)(void *priv, int enabled);
-
-       /**
-        * scan - Request the driver to initiate scan (old version)
-        * @priv: private driver interface data
-        * @ssid: specific SSID to scan for (ProbeReq) or %NULL to scan for
-        *      all SSIDs (either active scan with wildcard SSID or passive
-        *      scan)
-        * @ssid_len: length of the SSID
-        *
-        * Returns: 0 on success, -1 on failure
-        *
-        * Once the scan results are ready, the driver should report scan
-        * results event for wpa_supplicant which will eventually request the
-        * results with wpa_driver_get_scan_results().
-        *
-        * This function is deprecated. New driver wrapper implementations
-        * should implement support for scan2().
-        */
-       int (*scan)(void *priv, const u8 *ssid, size_t ssid_len);
-
-       /**
-        * get_scan_results - Fetch the latest scan results (old version)
-        * @priv: private driver interface data
-        * @results: pointer to buffer for scan results
-        * @max_size: maximum number of entries (buffer size)
-        *
-        * Returns: Number of scan result entries used on success, -1 on
-        * failure
-        *
-        * If scan results include more than max_size BSSes, max_size will be
-        * returned and the remaining entries will not be included in the
-        * buffer.
-        *
-        * This function is deprecated. New driver wrapper implementations
-        * should implement support for get_scan_results2().
-        */
-       int (*get_scan_results)(void *priv,
-                               struct wpa_scan_result *results,
-                               size_t max_size);
-
-       /**
         * deauthenticate - Request driver to deauthenticate
         * @priv: private driver interface data
         * @addr: peer address (BSSID of the AP)
@@ -767,30 +682,6 @@ struct wpa_driver_ops {
                         struct wpa_driver_associate_params *params);
 
        /**
-        * set_auth_alg - Set IEEE 802.11 authentication algorithm
-        * @priv: private driver interface data
-        * @auth_alg: bit field of AUTH_ALG_*
-        *
-        * If the driver supports more than one authentication algorithm at the
-        * same time, it should configure all supported algorithms. If not, one
-        * algorithm needs to be selected arbitrarily. Open System
-        * authentication should be ok for most cases and it is recommended to
-        * be used if other options are not supported. Static WEP configuration
-        * may also use Shared Key authentication and LEAP requires its own
-        * algorithm number. For LEAP, user can make sure that only one
-        * algorithm is used at a time by configuring LEAP as the only
-        * supported EAP method. This information is also available in
-        * associate() params, so set_auth_alg may not be needed in case of
-        * most drivers.
-        *
-        * This function is deprecated. New driver wrapper implementations
-        * should use associate() parameter auth_alg instead.
-        *
-        * Returns: 0 on success, -1 on failure
-        */
-       int (*set_auth_alg)(void *priv, int auth_alg);
-
-       /**
         * add_pmkid - Add PMKSA cache entry to the driver
         * @priv: private driver interface data
         * @bssid: BSSID for the PMKSA cache entry
@@ -1087,33 +978,6 @@ struct wpa_driver_ops {
         struct wpa_scan_results * (*get_scan_results2)(void *priv);
 
        /**
-        * set_probe_req_ie - Set information element(s) for Probe Request
-        * @priv: private driver interface data
-        * @ies: Information elements to append or %NULL to remove extra IEs
-        * @ies_len: Length of the IE buffer in octets
-        * Returns: 0 on success, -1 on failure
-        */
-       int (*set_probe_req_ie)(void *priv, const u8 *ies, size_t ies_len);
-
-       /**
-        * set_mode - Request driver to set the operating mode
-        * @priv: private driver interface data
-        * @mode: Operation mode (infra/ibss) IEEE80211_MODE_*
-        *
-        * This handler will be called before any key configuration and call to
-        * associate() handler in order to allow the operation mode to be
-        * configured as early as possible. This information is also available
-        * in associate() params and as such, driver wrappers may not need
-        * to implement set_mode() handler.
-        *
-        * This function is deprecated. New driver wrapper implementations
-        * should use associate() parameter mode instead.
-        *
-        * Returns: 0 on success, -1 on failure
-        */
-       int (*set_mode)(void *priv, int mode);
-
-       /**
         * set_country - Set country
         * @priv: Private driver interface data
         * @alpha2: country to which to switch to
@@ -1196,118 +1060,380 @@ struct wpa_driver_ops {
        int (*authenticate)(void *priv,
                            struct wpa_driver_auth_params *params);
 
-       int (*set_beacon)(void *priv, const u8 *head, size_t head_len,
-                         const u8 *tail, size_t tail_len, int dtim_period);
-
-       int (*set_beacon_int)(void *priv, int value);
+       /**
+        * set_beacon - Set Beacon frame template
+        * @iface: Interface name (main interface or virtual BSS)
+        * @priv: Private driver interface data
+        * @head: Beacon head from IEEE 802.11 header to IEs before TIM IE
+        * @head_len: Length of the head buffer in octets
+        * @tail: Beacon tail following TIM IE
+        * @tail_len: Length of the tail buffer in octets
+        * @dtim_period: DTIM period
+        * @beacon_int: Beacon interval
+        * Returns: 0 on success, -1 on failure
+        *
+        * This function is used to configure Beacon template for the driver in
+        * AP mode. The driver is responsible for building the full Beacon
+        * frame by concatenating the head part with TIM IE generated by the
+        * driver/firmware and finishing with the tail part.
+        */
+       int (*set_beacon)(const char *ifname, void *priv,
+                         const u8 *head, size_t head_len,
+                         const u8 *tail, size_t tail_len, int dtim_period,
+                         int beacon_int);
 
+       /**
+        * hapd_init - Initialize driver interface (hostapd only)
+        * @hapd: Pointer to hostapd context
+        * @params: Configuration for the driver wrapper
+        * Returns: Pointer to private data, %NULL on failure
+        *
+        * This function is used instead of init() or init2() when the driver
+        * wrapper is used withh hostapd.
+        */
        void * (*hapd_init)(struct hostapd_data *hapd,
                            struct wpa_init_params *params);
+
+       /**
+        * hapd_deinit - Deinitialize driver interface (hostapd only)
+        * @priv: Private driver interface data from hapd_init()
+        */
        void (*hapd_deinit)(void *priv);
 
        /**
-        * set_8021x - enable/disable IEEE 802.1X support
-        * @ifname: Interface name (for multi-SSID/VLAN support)
-        * @priv: driver private data
-        * @enabled: 1 = enable, 0 = disable
-        *
+        * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
+        * @priv: Private driver interface data
+        * @params: BSS parameters
         * Returns: 0 on success, -1 on failure
         *
-        * Configure the kernel driver to enable/disable 802.1X support.
-        * This may be an empty function if 802.1X support is always enabled.
+        * This is an optional function to configure the kernel driver to
+        * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
+        * can be left undefined (set to %NULL) if IEEE 802.1X support is
+        * always enabled and the driver uses set_beacon() to set WPA/RSN IE
+        * for Beacon frames.
         */
-       int (*set_ieee8021x)(const char *ifname, void *priv, int enabled);
+       int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
 
        /**
-        * set_privacy - enable/disable privacy
-        * @priv: driver private data
+        * set_privacy - Enable/disable privacy (AP only)
+        * @priv: Private driver interface data
         * @enabled: 1 = privacy enabled, 0 = disabled
+        * Returns: 0 on success, -1 on failure
         *
-        * Return: 0 on success, -1 on failure
-        *
-        * Configure privacy.
+        * This is an optional function to configure privacy field in the
+        * kernel driver for Beacon frames. This can be left undefined (set to
+        * %NULL) if the driver uses the Beacon template from set_beacon().
         */
        int (*set_privacy)(const char *ifname, void *priv, int enabled);
 
-       int (*hapd_set_key)(const char *ifname, void *priv, wpa_alg alg,
-                           const u8 *addr, int key_idx, int set_tx,
-                           const u8 *seq, size_t seq_len,
-                           const u8 *key, size_t key_len);
+       /**
+        * get_seqnum - Fetch the current TSC/packet number (AP only)
+        * @ifname: The interface name (main or virtual)
+        * @priv: Private driver interface data
+        * @addr: MAC address of the station or %NULL for group keys
+        * @idx: Key index
+        * @seq: Buffer for returning the latest used TSC/packet number
+        * Returns: 0 on success, -1 on failure
+        *
+        * This function is used to fetch the last used TSC/packet number for
+        * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so
+        * there is no strict requirement on implementing support for unicast
+        * keys (i.e., addr != %NULL).
+        */
        int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
                          int idx, u8 *seq);
-       int (*get_seqnum_igtk)(const char *ifname, void *priv, const u8 *addr,
-                              int idx, u8 *seq);
+
+       /**
+        * flush - Flush all association stations (AP only)
+        * @priv: Private driver interface data
+        * Returns: 0 on success, -1 on failure
+        *
+        * This function requests the driver to disassociate all associated
+        * stations. This function does not need to be implemented if the
+        * driver does not process association frames internally.
+        */
        int (*flush)(void *priv);
+
+       /**
+        * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
+        * @ifname: The interface name (main or virtual BSS)
+        * @priv: Private driver interface data
+        * @elem: Information elements
+        * @elem_len: Length of the elem buffer in octets
+        * Returns: 0 on success, -1 on failure
+        *
+        * This is an optional function to add information elements in the
+        * kernel driver for Beacon and Probe Response frames. This can be left
+        * undefined (set to %NULL) if the driver uses the Beacon template from
+        * set_beacon().
+        */
        int (*set_generic_elem)(const char *ifname, void *priv, const u8 *elem,
                                size_t elem_len);
 
+       /**
+        * read_sta_data - Fetch station data (AP only)
+        * @priv: Private driver interface data
+        * @data: Buffer for returning station information
+        * @addr: MAC address of the station
+        * Returns: 0 on success, -1 on failure
+        */
        int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
                             const u8 *addr);
+
+       /**
+        * hapd_send_eapol - Send an EAPOL packet (AP only)
+        * @priv: private driver interface data
+        * @addr: Destination MAC address
+        * @data: EAPOL packet starting with IEEE 802.1X header
+        * @data_len: Length of the EAPOL packet in octets
+        * @encrypt: Whether the frame should be encrypted
+        * @own_addr: Source MAC address
+        *
+        * Returns: 0 on success, -1 on failure
+        */
        int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
                               size_t data_len, int encrypt,
                               const u8 *own_addr);
-       int (*sta_deauth)(void *priv, const u8 *addr, int reason);
-       int (*sta_disassoc)(void *priv, const u8 *addr, int reason);
+
+       /**
+        * sta_deauth - Deauthenticate a station (AP only)
+        * @priv: Private driver interface data
+        * @own_addr: Source address and BSSID for the Deauthentication frame
+        * @addr: MAC address of the station to deauthenticate
+        * @reason: Reason code for the Deauthentiation frame
+        * Returns: 0 on success, -1 on failure
+        *
+        * This function requests a specific station to be deauthenticated and
+        * a Deauthentication frame to be sent to it.
+        */
+       int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
+                         int reason);
+
+       /**
+        * sta_disassoc - Disassociate a station (AP only)
+        * @priv: Private driver interface data
+        * @own_addr: Source address and BSSID for the Disassociation frame
+        * @addr: MAC address of the station to disassociate
+        * @reason: Reason code for the Disassociation frame
+        * Returns: 0 on success, -1 on failure
+        *
+        * This function requests a specific station to be disassociated and
+        * a Disassociation frame to be sent to it.
+        */
+       int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
+                           int reason);
+
+       /**
+        * sta_remove - Remove a station entry (AP only)
+        * @priv: Private driver interface data
+        * @addr: MAC address of the station to be removed
+        * Returns: 0 on success, -1 on failure
+        */
        int (*sta_remove)(void *priv, const u8 *addr);
+
+       /**
+        * hapd_get_ssid - Get the current SSID (AP only)
+        * @ifname: Interface (master or virtual BSS)
+        * @priv: Private driver interface data
+        * @buf: Buffer for returning the SSID
+        * @len: Maximum length of the buffer
+        * Returns: Length of the SSID on success, -1 on failure
+        *
+        * This function need not be implemented if the driver uses Beacon
+        * template from set_beacon() and does not reply to Probe Request
+        * frames.
+        */
        int (*hapd_get_ssid)(const char *ifname, void *priv, u8 *buf, int len);
+
+       /**
+        * hapd_set_ssid - Set SSID (AP only)
+        * @ifname: Interface (master or virtual BSS)
+        * @priv: Private driver interface data
+        * @buf: SSID
+        * @len: Length of the SSID in octets
+        * Returns: 0 on success, -1 on failure
+        */
        int (*hapd_set_ssid)(const char *ifname, void *priv, const u8 *buf,
                             int len);
+       /**
+        * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
+        * @priv: Private driver interface data
+        * @enabled: 1 = countermeasures enabled, 0 = disabled
+        * Returns: 0 on success, -1 on failure
+        *
+        * This need not be implemented if the driver does not take care of
+        * association processing.
+        */
        int (*hapd_set_countermeasures)(void *priv, int enabled);
+
+       /**
+        * sta_add - Add a station entry
+        * @ifname: Interface (master or virtual)
+        * @priv: Private driver interface data
+        * @params: Station parameters
+        * Returns: 0 on success, -1 on failure
+        *
+        * This function is used to add a station entry to the driver once the
+        * station has completed association. This is only used if the driver
+        * does not take care of association processing.
+        */
        int (*sta_add)(const char *ifname, void *priv,
                       struct hostapd_sta_add_params *params);
+
+       /**
+        * get_inact_sec - Get station inactivity duration (AP only)
+        * @priv: Private driver interface data
+        * @addr: Station address
+        * Returns: Number of seconds station has been inactive, -1 on failure
+        */
        int (*get_inact_sec)(void *priv, const u8 *addr);
+
+       /**
+        * sta_clear_stats - Clear station statistics (AP only)
+        * @priv: Private driver interface data
+        * @addr: Station address
+        * Returns: 0 on success, -1 on failure
+        */
        int (*sta_clear_stats)(void *priv, const u8 *addr);
 
+       /**
+        * set_freq - Set channel/frequency (AP only)
+        * @priv: Private driver interface data
+        * @freq: Channel parameters
+        * Returns: 0 on success, -1 on failure
+        */
        int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
+
+       /**
+        * set_rts - Set RTS threshold
+        * @priv: Private driver interface data
+        * @rts: RTS threshold in octets
+        * Returns: 0 on success, -1 on failure
+        */
        int (*set_rts)(void *priv, int rts);
+
+       /**
+        * set_frag - Set fragmentation threshold
+        * @priv: Private driver interface data
+        * @frag: Fragmentation threshold in octets
+        * Returns: 0 on success, -1 on failure
+        */
        int (*set_frag)(void *priv, int frag);
-       int (*set_retry)(void *priv, int short_retry, int long_retry);
 
+       /**
+        * sta_set_flags - Set station flags (AP only)
+        * @priv: Private driver interface data
+        * @addr: Station address
+        * @total_flags: Bitmap of all WPA_STA_* flags currently set
+        * @flags_or: Bitmap of WPA_STA_* flags to add
+        * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
+        * Returns: 0 on success, -1 on failure
+        */
        int (*sta_set_flags)(void *priv, const u8 *addr,
                             int total_flags, int flags_or, int flags_and);
+
+       /**
+        * set_rate_sets - Set supported and basic rate sets (AP only)
+        * @priv: Private driver interface data
+        * @supp_rates: -1 terminated array of supported rates in 100 kbps
+        * @basic_rates: -1 terminated array of basic rates in 100 kbps
+        * @mode: hardware mode (HOSTAPD_MODE_*)
+        * Returns: 0 on success, -1 on failure
+        */
        int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
                             int mode);
-       int (*set_ieee80211d)(void *priv, int enabled);
-       int (*hapd_set_beacon)(const char *ifname, void *priv,
-                              const u8 *head, size_t head_len,
-                              const u8 *tail, size_t tail_len,
-                              int dtim_period);
-
-       /* Configure internal bridge:
-        * 0 = disabled, i.e., client separation is enabled (no bridging of
-        *     packets between associated STAs
-        * 1 = enabled, i.e., bridge packets between associated STAs (default)
-        */
-       int (*set_internal_bridge)(void *priv, int value);
-       /* Configure broadcast SSID mode:
-        * 0 = include SSID in Beacon frames and reply to Probe Request frames
-        *     that use broadcast SSID
-        * 1 = hide SSID from Beacon frames and ignore Probe Request frames for
-        *     broadcast SSID
-        */
-       int (*set_broadcast_ssid)(void *priv, int value);
+
+       /**
+        * set_cts_protect - Set CTS protection mode (AP only)
+        * @priv: Private driver interface data
+        * @value: Whether CTS protection is enabled
+        * Returns: 0 on success, -1 on failure
+        */
        int (*set_cts_protect)(void *priv, int value);
+
+       /**
+        * set_preamble - Set preamble mode (AP only)
+        * @priv: Private driver interface data
+        * @value: Whether short preamble is enabled
+        * Returns: 0 on success, -1 on failure
+        */
        int (*set_preamble)(void *priv, int value);
+
+       /**
+        * set_short_slot_time - Set short slot time (AP only)
+        * @priv: Private driver interface data
+        * @value: Whether short slot time is enabled
+        * Returns: 0 on success, -1 on failure
+        */
        int (*set_short_slot_time)(void *priv, int value);
+
+       /**
+        * set_tx_queue_params - Set TX queue parameters
+        * @priv: Private driver interface data
+        * @queue: Queue number
+        * @aifs: AIFS
+        * @cw_min: cwMin
+        * @cw_max: cwMax
+        * @burst_time: Maximum length for bursting in 0.1 msec units
+        */
        int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
                                   int cw_max, int burst_time);
-       int (*bss_add)(void *priv, const char *ifname, const u8 *bssid);
-       int (*bss_remove)(void *priv, const char *ifname);
+
+       /**
+        * valid_bss_mask - Validate BSSID mask
+        * @priv: Private driver interface data
+        * @addr: Address
+        * @mask: Mask
+        * Returns: 0 if mask is valid, -1 if mask is not valid, 1 if mask can
+        * be used, but the main interface address must be the first address in
+        * the block if mask is applied
+        */
        int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
-       int (*passive_scan)(void *priv, int now, int our_mode_only,
-                           int interval, int _listen, int *channel,
-                           int *last_rx);
+
+       /**
+        * if_add - Add a virtual interface
+        * @iface: Parent interface name
+        * @priv: Private driver interface data
+        * @type: Interface type
+        * @ifname: Interface name for the new virtual interface
+        * @addr: Local address to use for the interface or %NULL to use the
+        *      parent interface address
+        * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
+        * Returns: 0 on success, -1 on failure
+        */
        int (*if_add)(const char *iface, void *priv,
-                     enum hostapd_driver_if_type type, char *ifname,
-                     const u8 *addr);
-       int (*if_update)(void *priv, enum hostapd_driver_if_type type,
-                        char *ifname, const u8 *addr);
-       int (*if_remove)(void *priv, enum hostapd_driver_if_type type,
-                        const char *ifname, const u8 *addr);
+                     enum wpa_driver_if_type type, const char *ifname,
+                     const u8 *addr, void *bss_ctx);
+
+       /**
+        * if_remove - Remove a virtual interface
+        * @priv: Private driver interface data
+        * @type: Interface type
+        * @ifname: Interface name of the virtual interface to be removed
+        * Returns: 0 on success, -1 on failure
+        */
+       int (*if_remove)(void *priv, enum wpa_driver_if_type type,
+                        const char *ifname);
+
+       /**
+        * set_sta_vlan - Bind a station into a specific interface (AP only)
+        * @priv: Private driver interface data
+        * @ifname: Interface (main or virtual BSS or VLAN)
+        * @addr: MAC address of the associated station
+        * @vlan_id: VLAN ID
+        * Returns: 0 on success, -1 on failure
+        *
+        * This function is used to bind a station to a specific virtual
+        * interface. It is only used if when virtual interfaces are supported,
+        * e.g., to assign stations to different VLAN interfaces based on
+        * information from a RADIUS server. This allows separate broadcast
+        * domains to be used with a single BSS.
+        */
        int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
                            int vlan_id);
+
        /**
-        * commit - Optional commit changes handler
+        * commit - Optional commit changes handler (AP only)
         * @priv: driver private data
         * Returns: 0 on success, -1 on failure
         *
@@ -1318,21 +1444,89 @@ struct wpa_driver_ops {
         */
        int (*commit)(void *priv);
 
+       /**
+        * send_ether - Send an ethernet packet (AP only)
+        * @priv: private driver interface data
+        * @dst: Destination MAC address
+        * @src: Source MAC address
+        * @proto: Ethertype
+        * @data: EAPOL packet starting with IEEE 802.1X header
+        * @data_len: Length of the EAPOL packet in octets
+        * Returns: 0 on success, -1 on failure
+        */
        int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
                          const u8 *data, size_t data_len);
 
+       /**
+        * set_radius_acl_auth - Notification of RADIUS ACL change
+        * @priv: Private driver interface data
+        * @mac: MAC address of the station
+        * @accepted: Whether the station was accepted
+        * @session_timeout: Session timeout for the station
+        * Returns: 0 on success, -1 on failure
+        */
        int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted, 
                                   u32 session_timeout);
+
+       /**
+        * set_radius_acl_expire - Notification of RADIUS ACL expiration
+        * @priv: Private driver interface data
+        * @mac: MAC address of the station
+        * Returns: 0 on success, -1 on failure
+        */
        int (*set_radius_acl_expire)(void *priv, const u8 *mac);
 
+       /**
+        * set_ht_params - Set HT parameters (AP only)
+        * @ifname: The interface name (main or virtual BSS)
+        * @priv: Private driver interface data
+        * @ht_capab: HT Capabilities IE
+        * @ht_capab_len: Length of ht_capab in octets
+        * @ht_oper: HT Operation IE
+        * @ht_oper_len: Length of ht_oper in octets
+        * Returns: 0 on success, -1 on failure
+        */
        int (*set_ht_params)(const char *ifname, void *priv,
                             const u8 *ht_capab, size_t ht_capab_len,
                             const u8 *ht_oper, size_t ht_oper_len);
 
+       /**
+        * set_wps_beacon_ie - Add WPS IE into Beacon frames (AP only)
+        * @ifname: The interface name (main or virtual BSS)
+        * @priv: Private driver interface data
+        * @ie: WPS IE
+        * @len: Length of the ie buffer in octets
+        * Returns: 0 on success, -1 on failure
+        *
+        * This is an optional function to add WPS IE in the kernel driver for
+        * Beacon frames. This can be left undefined (set to %NULL) if the
+        * driver uses the Beacon template from set_beacon().
+        */
        int (*set_wps_beacon_ie)(const char *ifname, void *priv,
                                 const u8 *ie, size_t len);
+
+       /**
+        * set_wps_probe_resp_ie - Add WPS IE into Probe Response frames (AP)
+        * @ifname: The interface name (main or virtual BSS)
+        * @priv: Private driver interface data
+        * @ie: WPS IE
+        * @len: Length of the ie buffer in octets
+        * Returns: 0 on success, -1 on failure
+        *
+        * This is an optional function to add WPS IE in the kernel driver for
+        * Beacon frames. This can be left undefined (set to %NULL) if the
+        * driver does process Probe Request frames.
+        */
        int (*set_wps_probe_resp_ie)(const char *ifname, void *priv,
                                     const u8 *ie, size_t len);
+
+       /**
+        * set_supp_port - Set IEEE 802.1X Supplicant Port status
+        * @priv: Private driver interface data
+        * @authorized: Whether the port is authorized
+        * Returns: 0 on success, -1 on failure
+        */
+       int (*set_supp_port)(void *priv, int authorized);
 };
 
 /**
@@ -1497,7 +1691,22 @@ typedef enum wpa_event_type {
         * rejected by the AP. Information about authentication result is
         * included in union wpa_event_data::assoc_reject.
         */
-       EVENT_ASSOC_REJECT
+       EVENT_ASSOC_REJECT,
+
+       /**
+        * EVENT_AUTH_TIMED_OUT - Authentication timed out
+        */
+       EVENT_AUTH_TIMED_OUT,
+
+       /**
+        * EVENT_ASSOC_TIMED_OUT - Association timed out
+        */
+       EVENT_ASSOC_TIMED_OUT,
+
+       /**
+        * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
+        */
+       EVENT_FT_RRB_RX
 } wpa_event_type;
 
 
@@ -1675,6 +1884,19 @@ union wpa_event_data {
                 */
                u16 status_code;
        } assoc_reject;
+
+       struct timeout_event {
+               u8 addr[ETH_ALEN];
+       } timeout_event;
+
+       /**
+        * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
+        */
+       struct ft_rrb_rx {
+               const u8 *src;
+               const u8 *data;
+               size_t data_len;
+       } ft_rrb_rx;
 };
 
 /**
@@ -1711,8 +1933,6 @@ void wpa_supplicant_sta_rx(void *ctx, const u8 *buf, size_t len,
                           struct ieee80211_rx_status *rx_status);
 
 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie);
-#define WPA_IE_VENDOR_TYPE 0x0050f201
-#define WPS_IE_VENDOR_TYPE 0x0050f204
 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
                                  u32 vendor_type);
 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res,
@@ -1724,12 +1944,15 @@ void wpa_scan_sort_results(struct wpa_scan_results *res);
 /* hostapd functions for driver wrappers */
 
 struct sta_info;
+struct ieee80211_hdr;
 
 void hostapd_new_assoc_sta(struct hostapd_data *hapd, struct sta_info *sta,
                           int reassoc);
 void hostapd_tx_status(struct hostapd_data *hapd, const u8 *addr,
                       const u8 *buf, size_t len, int ack);
-void hostapd_rx_from_unknown_sta(struct hostapd_data *hapd, const u8 *addr);
+void hostapd_rx_from_unknown_sta(struct hostapd_data *hapd,
+                                const struct ieee80211_hdr *hdr, size_t len);
+int hostapd_notif_new_sta(struct hostapd_data *hapd, const u8 *addr);
 int hostapd_notif_assoc(struct hostapd_data *hapd, const u8 *addr,
                        const u8 *ie, size_t ielen);
 void hostapd_notif_disassoc(struct hostapd_data *hapd, const u8 *addr);
@@ -1737,20 +1960,19 @@ void hostapd_eapol_receive(struct hostapd_data *hapd, const u8 *sa,
                           const u8 *buf, size_t len);
 
 struct hostapd_frame_info {
-       u32 phytype;
        u32 channel;
        u32 datarate;
        u32 ssi_signal;
-
-       unsigned int passive_scan:1;
 };
 
 void hostapd_mgmt_rx(struct hostapd_data *hapd, u8 *buf, size_t len,
                     u16 stype, struct hostapd_frame_info *fi);
 void hostapd_mgmt_tx_cb(struct hostapd_data *hapd, u8 *buf, size_t len,
                        u16 stype, int ok);
-void hostapd_michael_mic_failure(struct hostapd_data *hapd, const u8 *addr);
 struct hostapd_data * hostapd_sta_get_bss(struct hostapd_data *hapd,
                                          const u8 *addr);
+void hostapd_probe_req_rx(struct hostapd_data *hapd, const u8 *sa,
+                         const u8 *ie, size_t ie_len);
+void hostapd_button_pushed(struct hostapd_data *hapd);
 
 #endif /* DRIVER_H */