|
wpa_supplicant / hostapd 2.0
|
|
wpa_supplicant / hostapd 2.0
|
Driver interface API definition. More...
#include <driver.h>
Data Fields | |
| const char * | name |
| const char * | desc |
| int(* | get_bssid )(void *priv, u8 *bssid) |
| Get the current BSSID. | |
| int(* | get_ssid )(void *priv, u8 *ssid) |
| Get the current SSID. | |
| int(* | set_key )(const char *ifname, void *priv, enum 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) |
| Configure encryption key. | |
| void *(* | init )(void *ctx, const char *ifname) |
| Initialize driver interface. | |
| void(* | deinit )(void *priv) |
| Deinitialize driver interface. | |
| int(* | set_param )(void *priv, const char *param) |
| Set driver configuration parameters. | |
| int(* | set_countermeasures )(void *priv, int enabled) |
| Enable/disable TKIP countermeasures. | |
| int(* | deauthenticate )(void *priv, const u8 *addr, int reason_code) |
| Request driver to deauthenticate. | |
| int(* | disassociate )(void *priv, const u8 *addr, int reason_code) |
| Request driver to disassociate. | |
| int(* | associate )(void *priv, struct wpa_driver_associate_params *params) |
| Request driver to associate. | |
| int(* | add_pmkid )(void *priv, const u8 *bssid, const u8 *pmkid) |
| Add PMKSA cache entry to the driver. | |
| int(* | remove_pmkid )(void *priv, const u8 *bssid, const u8 *pmkid) |
| Remove PMKSA cache entry to the driver. | |
| int(* | flush_pmkid )(void *priv) |
| Flush PMKSA cache. | |
| int(* | get_capa )(void *priv, struct wpa_driver_capa *capa) |
| Get driver capabilities. | |
| void(* | poll )(void *priv) |
| Poll driver for association information. | |
| const char *(* | get_ifname )(void *priv) |
| Get interface name. | |
| const u8 *(* | get_mac_addr )(void *priv) |
| Get own MAC address. | |
| int(* | send_eapol )(void *priv, const u8 *dest, u16 proto, const u8 *data, size_t data_len) |
| Optional function for sending EAPOL packets. | |
| int(* | set_operstate )(void *priv, int state) |
| Sets device operating state to DORMANT or UP. | |
| int(* | mlme_setprotection )(void *priv, const u8 *addr, int protect_type, int key_type) |
| MLME-SETPROTECTION.request primitive. | |
| struct hostapd_hw_modes *(* | get_hw_feature_data )(void *priv, u16 *num_modes, u16 *flags) |
| Get hardware support data (channels and rates) | |
| int(* | send_mlme )(void *priv, const u8 *data, size_t data_len, int noack) |
| Send management frame from MLME. | |
| int(* | update_ft_ies )(void *priv, const u8 *md, const u8 *ies, size_t ies_len) |
| Update FT (IEEE 802.11r) IEs. | |
| int(* | send_ft_action )(void *priv, u8 action, const u8 *target_ap, const u8 *ies, size_t ies_len) |
| Send FT Action frame (IEEE 802.11r) | |
| struct wpa_scan_results *(* | get_scan_results2 )(void *priv) |
| Fetch the latest scan results. | |
| int(* | set_country )(void *priv, const char *alpha2) |
| Set country. | |
| void *(* | global_init )(void) |
| Global driver initialization. | |
| void(* | global_deinit )(void *priv) |
| Global driver deinitialization. | |
| void *(* | init2 )(void *ctx, const char *ifname, void *global_priv) |
| Initialize driver interface (with global data) | |
| struct wpa_interface_info *(* | get_interfaces )(void *global_priv) |
| Get information about available interfaces. | |
| int(* | scan2 )(void *priv, struct wpa_driver_scan_params *params) |
| Request the driver to initiate scan. | |
| int(* | authenticate )(void *priv, struct wpa_driver_auth_params *params) |
| Request driver to authenticate. | |
| int(* | set_ap )(void *priv, struct wpa_driver_ap_params *params) |
| Set Beacon and Probe Response information for AP mode. | |
| void *(* | hapd_init )(struct hostapd_data *hapd, struct wpa_init_params *params) |
| Initialize driver interface (hostapd only) | |
| void(* | hapd_deinit )(void *priv) |
| Deinitialize driver interface (hostapd only) | |
| int(* | set_ieee8021x )(void *priv, struct wpa_bss_params *params) |
| Enable/disable IEEE 802.1X support (AP only) | |
| int(* | set_privacy )(void *priv, int enabled) |
| Enable/disable privacy (AP only) | |
| int(* | get_seqnum )(const char *ifname, void *priv, const u8 *addr, int idx, u8 *seq) |
| Fetch the current TSC/packet number (AP only) | |
| int(* | flush )(void *priv) |
| Flush all association stations (AP only) | |
| int(* | set_generic_elem )(void *priv, const u8 *elem, size_t elem_len) |
| Add IEs into Beacon/Probe Response frames (AP) | |
| int(* | read_sta_data )(void *priv, struct hostap_sta_driver_data *data, const u8 *addr) |
| Fetch station data (AP only) | |
| int(* | hapd_send_eapol )(void *priv, const u8 *addr, const u8 *data, size_t data_len, int encrypt, const u8 *own_addr, u32 flags) |
| Send an EAPOL packet (AP only) | |
| int(* | sta_deauth )(void *priv, const u8 *own_addr, const u8 *addr, int reason) |
| Deauthenticate a station (AP only) | |
| int(* | sta_disassoc )(void *priv, const u8 *own_addr, const u8 *addr, int reason) |
| Disassociate a station (AP only) | |
| int(* | sta_remove )(void *priv, const u8 *addr) |
| Remove a station entry (AP only) | |
| int(* | hapd_get_ssid )(void *priv, u8 *buf, int len) |
| Get the current SSID (AP only) | |
| int(* | hapd_set_ssid )(void *priv, const u8 *buf, int len) |
| Set SSID (AP only) | |
| int(* | hapd_set_countermeasures )(void *priv, int enabled) |
| Enable/disable TKIP countermeasures (AP) | |
| int(* | sta_add )(void *priv, struct hostapd_sta_add_params *params) |
| Add a station entry. | |
| int(* | get_inact_sec )(void *priv, const u8 *addr) |
| Get station inactivity duration (AP only) | |
| int(* | sta_clear_stats )(void *priv, const u8 *addr) |
| Clear station statistics (AP only) | |
| int(* | set_freq )(void *priv, struct hostapd_freq_params *freq) |
| Set channel/frequency (AP only) | |
| int(* | set_rts )(void *priv, int rts) |
| Set RTS threshold. | |
| int(* | set_frag )(void *priv, int frag) |
| Set fragmentation threshold. | |
| int(* | sta_set_flags )(void *priv, const u8 *addr, int total_flags, int flags_or, int flags_and) |
| Set station flags (AP only) | |
| int(* | set_tx_queue_params )(void *priv, int queue, int aifs, int cw_min, int cw_max, int burst_time) |
| Set TX queue parameters. | |
| int(* | if_add )(void *priv, enum wpa_driver_if_type type, const char *ifname, const u8 *addr, void *bss_ctx, void **drv_priv, char *force_ifname, u8 *if_addr, const char *bridge) |
| Add a virtual interface. | |
| int(* | if_remove )(void *priv, enum wpa_driver_if_type type, const char *ifname) |
| Remove a virtual interface. | |
| int(* | set_sta_vlan )(void *priv, const u8 *addr, const char *ifname, int vlan_id) |
| Bind a station into a specific interface (AP only) | |
| int(* | commit )(void *priv) |
| Optional commit changes handler (AP only) | |
| int(* | send_ether )(void *priv, const u8 *dst, const u8 *src, u16 proto, const u8 *data, size_t data_len) |
| Send an ethernet packet (AP only) | |
| int(* | set_radius_acl_auth )(void *priv, const u8 *mac, int accepted, u32 session_timeout) |
| Notification of RADIUS ACL change. | |
| int(* | set_radius_acl_expire )(void *priv, const u8 *mac) |
| Notification of RADIUS ACL expiration. | |
| int(* | set_ap_wps_ie )(void *priv, const struct wpabuf *beacon, const struct wpabuf *proberesp, const struct wpabuf *assocresp) |
| Add WPS IE(s) into Beacon/Probe Response frames (AP) | |
| int(* | set_supp_port )(void *priv, int authorized) |
| Set IEEE 802.1X Supplicant Port status. | |
| int(* | set_wds_sta )(void *priv, const u8 *addr, int aid, int val, const char *bridge_ifname) |
| Bind a station into a 4-address WDS (AP only) | |
| int(* | send_action )(void *priv, unsigned int freq, unsigned int wait, const u8 *dst, const u8 *src, const u8 *bssid, const u8 *data, size_t data_len, int no_cck) |
| Transmit an Action frame. | |
| void(* | send_action_cancel_wait )(void *priv) |
| Cancel action frame TX wait. | |
| int(* | remain_on_channel )(void *priv, unsigned int freq, unsigned int duration) |
| Remain awake on a channel. | |
| int(* | cancel_remain_on_channel )(void *priv) |
| Cancel remain-on-channel operation. | |
| int(* | probe_req_report )(void *priv, int report) |
| Request Probe Request frames to be indicated. | |
| int(* | deinit_ap )(void *priv) |
| Deinitialize AP mode. | |
| int(* | deinit_p2p_cli )(void *priv) |
| Deinitialize P2P client mode. | |
| void(* | suspend )(void *priv) |
| Notification on system suspend/hibernate event. | |
| void(* | resume )(void *priv) |
| Notification on system resume/thaw event. | |
| int(* | signal_monitor )(void *priv, int threshold, int hysteresis) |
| Set signal monitoring parameters. | |
| int(* | send_frame )(void *priv, const u8 *data, size_t data_len, int encrypt) |
| Send IEEE 802.11 frame (testing use only) | |
| int(* | shared_freq )(void *priv) |
| Get operating frequency of shared interface(s) | |
| int(* | get_noa )(void *priv, u8 *buf, size_t buf_len) |
| Get current Notice of Absence attribute payload. | |
| int(* | set_noa )(void *priv, u8 count, int start, int duration) |
| Set Notice of Absence parameters for GO (testing) | |
| int(* | set_p2p_powersave )(void *priv, int legacy_ps, int opp_ps, int ctwindow) |
| Set P2P power save options. | |
| int(* | ampdu )(void *priv, int ampdu) |
| Enable/disable aggregation. | |
| const char *(* | get_radio_name )(void *priv) |
| Get physical radio name for the device. | |
| int(* | p2p_find )(void *priv, unsigned int timeout, int type) |
| Start P2P Device Discovery. | |
| int(* | p2p_stop_find )(void *priv) |
| Stop P2P Device Discovery. | |
| int(* | p2p_listen )(void *priv, unsigned int timeout) |
| Start P2P Listen state for specified duration. | |
| int(* | p2p_connect )(void *priv, const u8 *peer_addr, int wps_method, int go_intent, const u8 *own_interface_addr, unsigned int force_freq, int persistent_group) |
| Start P2P group formation (GO negotiation) | |
| int(* | wps_success_cb )(void *priv, const u8 *peer_addr) |
| Report successfully completed WPS provisioning. | |
| int(* | p2p_group_formation_failed )(void *priv) |
| Report failed WPS provisioning. | |
| int(* | p2p_set_params )(void *priv, const struct p2p_params *params) |
| Set P2P parameters. | |
| int(* | p2p_prov_disc_req )(void *priv, const u8 *peer_addr, u16 config_methods, int join) |
| Send Provision Discovery Request. | |
| u64(* | p2p_sd_request )(void *priv, const u8 *dst, const struct wpabuf *tlvs) |
| Schedule a service discovery query. | |
| int(* | p2p_sd_cancel_request )(void *priv, u64 req) |
| Cancel a pending service discovery query. | |
| int(* | p2p_sd_response )(void *priv, int freq, const u8 *dst, u8 dialog_token, const struct wpabuf *resp_tlvs) |
| Send response to a service discovery query. | |
| int(* | p2p_service_update )(void *priv) |
| Indicate a change in local services. | |
| int(* | p2p_reject )(void *priv, const u8 *addr) |
| Reject peer device (explicitly block connections) | |
| int(* | p2p_invite )(void *priv, const u8 *peer, int role, const u8 *bssid, const u8 *ssid, size_t ssid_len, const u8 *go_dev_addr, int persistent_group) |
| Invite a P2P Device into a group. | |
| int(* | send_tdls_mgmt )(void *priv, const u8 *dst, u8 action_code, u8 dialog_token, u16 status_code, const u8 *buf, size_t len) |
| for sending TDLS management packets | |
| int(* | tdls_oper )(void *priv, enum tdls_oper oper, const u8 *peer) |
| Ask the driver to perform high-level TDLS operations. | |
| int(* | signal_poll )(void *priv, struct wpa_signal_info *signal_info) |
| Get current connection information. | |
| int(* | set_authmode )(void *priv, int authmode) |
| Set authentication algorithm(s) for static WEP. | |
| void(* | set_rekey_info )(void *priv, const u8 *kek, const u8 *kck, const u8 *replay_ctr) |
| Set rekey information. | |
| int(* | sta_assoc )(void *priv, const u8 *own_addr, const u8 *addr, int reassoc, u16 status, const u8 *ie, size_t len) |
| Station association indication. | |
| int(* | sta_auth )(void *priv, const u8 *own_addr, const u8 *addr, u16 seq, u16 status, const u8 *ie, size_t len) |
| Station authentication indication. | |
| int(* | add_tspec )(void *priv, const u8 *addr, u8 *tspec_ie, size_t tspec_ielen) |
| Add traffic stream. | |
| int(* | add_sta_node )(void *priv, const u8 *addr, u16 auth_alg) |
| Add a station node in the driver. | |
| int(* | sched_scan )(void *priv, struct wpa_driver_scan_params *params, u32 interval) |
| Request the driver to initiate scheduled scan. | |
| int(* | stop_sched_scan )(void *priv) |
| Request the driver to stop a scheduled scan. | |
| void(* | poll_client )(void *priv, const u8 *own_addr, const u8 *addr, int qos) |
| Probe (null data or such) the given station. | |
| int(* | radio_disable )(void *priv, int disabled) |
| Disable/enable radio. | |
Driver interface API definition.
This structure defines the API that each driver interface needs to implement for core wpa_supplicant code. All driver specific functionality is captured in this wrapper.
| int(* wpa_driver_ops::add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid) |
Add PMKSA cache entry to the driver.
| priv | private driver interface data |
| bssid | BSSID for the PMKSA cache entry |
| pmkid | PMKID for the PMKSA cache entry |
This function is called when a new PMK is received, as a result of either normal authentication or RSN pre-authentication.
If the driver generates RSN IE, i.e., it does not use wpa_ie in associate(), add_pmkid() can be used to add new PMKSA cache entries in the driver. If the driver uses wpa_ie from wpa_supplicant, this driver_ops function does not need to be implemented. Likewise, if the driver does not support WPA, this function is not needed.
| int(* wpa_driver_ops::add_sta_node)(void *priv, const u8 *addr, u16 auth_alg) |
Add a station node in the driver.
| priv | Private driver interface data |
| addr | MAC address of the station to add |
| auth_alg | authentication algorithm used by the station |
This function adds the station node in the driver, when the station gets added by FT-over-DS.
| int(* wpa_driver_ops::add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie, size_t tspec_ielen) |
Add traffic stream.
| priv | Private driver interface data |
| addr | MAC address of the station to associate |
| tspec_ie | tspec ie buffer |
| tspec_ielen | tspec ie length |
This function adds the traffic steam for the station and fills the medium_time in tspec_ie.
| int(* wpa_driver_ops::ampdu)(void *priv, int ampdu) |
Enable/disable aggregation.
| priv | Private driver interface data |
| ampdu | 1/0 = enable/disable A-MPDU aggregation |
| int(* wpa_driver_ops::associate)(void *priv, struct wpa_driver_associate_params *params) |
Request driver to associate.
| priv | private driver interface data |
| params | association parameters |
| int(* wpa_driver_ops::authenticate)(void *priv, struct wpa_driver_auth_params *params) |
Request driver to authenticate.
| priv | private driver interface data |
| params | authentication parameters |
This is an optional function that can be used with drivers that support separate authentication and association steps, i.e., when wpa_supplicant can act as the SME. If not implemented, associate() function is expected to take care of IEEE 802.11 authentication, too.
| int(* wpa_driver_ops::cancel_remain_on_channel)(void *priv) |
Cancel remain-on-channel operation.
| priv | Private driver interface data |
This command can be used to cancel a remain-on-channel operation before its originally requested duration has passed. This could be used, e.g., when remain_on_channel() is used to request extra time to receive a response to an Action frame and the response is received when there is still unneeded time remaining on the remain-on-channel operation.
| int(* wpa_driver_ops::commit)(void *priv) |
Optional commit changes handler (AP only)
| priv | driver private data |
This optional handler function can be registered if the driver interface implementation needs to commit changes (e.g., by setting network interface up) at the end of initial configuration. If set, this handler will be called after initial setup has been completed.
| int(* wpa_driver_ops::deauthenticate)(void *priv, const u8 *addr, int reason_code) |
Request driver to deauthenticate.
| priv | private driver interface data |
| addr | peer address (BSSID of the AP) |
| reason_code | 16-bit reason code to be sent in the deauthentication frame |
| void(* wpa_driver_ops::deinit)(void *priv) |
| int(* wpa_driver_ops::deinit_ap)(void *priv) |
Deinitialize AP mode.
| priv | Private driver interface data |
This optional function can be used to disable AP mode related configuration and change the driver mode to station mode to allow normal station operations like scanning to be completed.
| int(* wpa_driver_ops::deinit_p2p_cli)(void *priv) |
Deinitialize P2P client mode.
| priv | Private driver interface data |
This optional function can be used to disable P2P client mode. It can be used to change the interface type back to station mode.
| const char* wpa_driver_ops::desc |
One line description of the driver interface
| int(* wpa_driver_ops::disassociate)(void *priv, const u8 *addr, int reason_code) |
Request driver to disassociate.
| priv | private driver interface data |
| addr | peer address (BSSID of the AP) |
| reason_code | 16-bit reason code to be sent in the disassociation frame |
| int(* wpa_driver_ops::flush)(void *priv) |
Flush all association stations (AP only)
| priv | Private driver interface data |
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(* wpa_driver_ops::flush_pmkid)(void *priv) |
Flush PMKSA cache.
| priv | private driver interface data |
This function is called when the supplicant drops all PMKSA cache entries for any reason.
If the driver generates RSN IE, i.e., it does not use wpa_ie in associate(), remove_pmkid() can be used to synchronize PMKSA caches between the driver and wpa_supplicant. If the driver uses wpa_ie from wpa_supplicant, this driver_ops function does not need to be implemented. Likewise, if the driver does not support WPA, this function is not needed.
| int(* wpa_driver_ops::get_bssid)(void *priv, u8 *bssid) |
Get the current BSSID.
| priv | private driver interface data |
| bssid | buffer for BSSID (ETH_ALEN = 6 bytes) |
Query kernel driver for the current BSSID and copy it to bssid. Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not associated.
| int(* wpa_driver_ops::get_capa)(void *priv, struct wpa_driver_capa *capa) |
Get driver capabilities.
| priv | private driver interface data |
Get driver/firmware/hardware capabilities.
struct hostapd_hw_modes*(* wpa_driver_ops::get_hw_feature_data)(void *priv, u16 *num_modes, u16 *flags) [read] |
Get hardware support data (channels and rates)
| priv | Private driver interface data |
| num_modes | Variable for returning the number of returned modes flags: Variable for returning hardware feature flags |
| const char*(* wpa_driver_ops::get_ifname)(void *priv) |
Get interface name.
| priv | private driver interface data |
This optional function can be used to allow the driver interface to replace the interface name with something else, e.g., based on an interface mapping from a more descriptive name.
| int(* wpa_driver_ops::get_inact_sec)(void *priv, const u8 *addr) |
Get station inactivity duration (AP only)
| priv | Private driver interface data |
| addr | Station address |
struct wpa_interface_info*(* wpa_driver_ops::get_interfaces)(void *global_priv) [read] |
Get information about available interfaces.
| global_priv | private driver global data from global_init() |
| const u8*(* wpa_driver_ops::get_mac_addr)(void *priv) |
Get own MAC address.
| priv | private driver interface data |
This optional function can be used to get the own MAC address of the device from the driver interface code. This is only needed if the l2_packet implementation for the OS does not provide easy access to a MAC address.
| int(* wpa_driver_ops::get_noa)(void *priv, u8 *buf, size_t buf_len) |
Get current Notice of Absence attribute payload.
| priv | Private driver interface data |
| buf | Buffer for returning NoA |
| buf_len | Buffer length in octets |
This function is used to fetch the current Notice of Absence attribute value from GO.
| const char*(* wpa_driver_ops::get_radio_name)(void *priv) |
Get physical radio name for the device.
| priv | Private driver interface data |
The returned data must not be modified by the caller. It is assumed that any interface that has the same radio name as another is sharing the same physical radio. This information can be used to share scan results etc. information between the virtual interfaces to speed up various operations.
struct wpa_scan_results*(* wpa_driver_ops::get_scan_results2)(void *priv) [read] |
Fetch the latest scan results.
| priv | private driver interface data |
| int(* wpa_driver_ops::get_seqnum)(const char *ifname, void *priv, const u8 *addr, int idx, u8 *seq) |
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 |
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(* wpa_driver_ops::get_ssid)(void *priv, u8 *ssid) |
Get the current SSID.
| priv | private driver interface data |
| ssid | buffer for SSID (at least 32 bytes) |
Query kernel driver for the current SSID and copy it to ssid. Returning zero is recommended if the STA is not associated.
Note: SSID is an array of octets, i.e., it is not nul terminated and can, at least in theory, contain control characters (including nul) and as such, should be processed as binary data, not a printable string.
| void(* wpa_driver_ops::global_deinit)(void *priv) |
Global driver deinitialization.
| priv | private driver global data from global_init() |
Terminate any global driver related functionality and free the global data structure.
| void*(* wpa_driver_ops::global_init)(void) |
Global driver initialization.
This optional function is called to initialize the driver wrapper for global data, i.e., data that applies to all interfaces. If this function is implemented, global_deinit() will also need to be implemented to free the private data. The driver will also likely use init2() function instead of init() to get the pointer to global data available to per-interface initializer.
| void(* wpa_driver_ops::hapd_deinit)(void *priv) |
Deinitialize driver interface (hostapd only)
| priv | Private driver interface data from hapd_init() |
| int(* wpa_driver_ops::hapd_get_ssid)(void *priv, u8 *buf, int len) |
Get the current SSID (AP only)
| priv | Private driver interface data |
| buf | Buffer for returning the SSID |
| len | Maximum length of the buffer |
This function need not be implemented if the driver uses Beacon template from set_ap() and does not reply to Probe Request frames.
| void*(* wpa_driver_ops::hapd_init)(struct hostapd_data *hapd, struct wpa_init_params *params) |
| int(* wpa_driver_ops::hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data, size_t data_len, int encrypt, const u8 *own_addr, u32 flags) |
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 |
| flags | WPA_STA_* flags for the destination station |
| int(* wpa_driver_ops::hapd_set_countermeasures)(void *priv, int enabled) |
Enable/disable TKIP countermeasures (AP)
| priv | Private driver interface data |
| enabled | 1 = countermeasures enabled, 0 = disabled |
This need not be implemented if the driver does not take care of association processing.
| int(* wpa_driver_ops::hapd_set_ssid)(void *priv, const u8 *buf, int len) |
Set SSID (AP only)
| priv | Private driver interface data |
| buf | SSID |
| len | Length of the SSID in octets |
DEPRECATED - use set_ap() instead
| int(* wpa_driver_ops::if_add)(void *priv, enum wpa_driver_if_type type, const char *ifname, const u8 *addr, void *bss_ctx, void **drv_priv, char *force_ifname, u8 *if_addr, const char *bridge) |
Add a virtual interface.
| 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 |
| drv_priv | Pointer for overwriting the driver context or NULL if not allowed (applies only to WPA_IF_AP_BSS type) |
| force_ifname | Buffer for returning an interface name that the driver ended up using if it differs from the requested ifname |
| if_addr | Buffer for returning the allocated interface address (this may differ from the requested addr if the driver cannot change interface address) |
| bridge | Bridge interface to use or NULL if no bridge configured |
| int(* wpa_driver_ops::if_remove)(void *priv, enum wpa_driver_if_type type, const char *ifname) |
Remove a virtual interface.
| priv | Private driver interface data |
| type | Interface type |
| ifname | Interface name of the virtual interface to be removed |
| void*(* wpa_driver_ops::init)(void *ctx, const char *ifname) |
Initialize driver interface.
| ctx | context to be used when calling wpa_supplicant functions, e.g., wpa_supplicant_event() |
| ifname | interface name, e.g., wlan0 |
Initialize driver interface, including event processing for kernel driver events (e.g., associated, scan results, Michael MIC failure). This function can allocate a private configuration data area for
| ctx | file descriptor, interface name, etc. information that may be needed in future driver operations. If this is not used, non-NULL value will need to be returned because NULL is used to indicate failure. The returned value will be used as 'void *priv' data for all other driver_ops functions. |
The main event loop (eloop.c) of wpa_supplicant can be used to register callback for read sockets (eloop_register_read_sock()).
See below for more information about events and wpa_supplicant_event() function.
| void*(* wpa_driver_ops::init2)(void *ctx, const char *ifname, void *global_priv) |
Initialize driver interface (with global data)
| ctx | context to be used when calling wpa_supplicant functions, e.g., wpa_supplicant_event() |
| ifname | interface name, e.g., wlan0 |
| global_priv | private driver global data from global_init() |
This function can be used instead of init() if the driver wrapper uses global data.
| int(* wpa_driver_ops::mlme_setprotection)(void *priv, const u8 *addr, int protect_type, int key_type) |
MLME-SETPROTECTION.request primitive.
| priv | Private driver interface data |
| addr | Address of the station for which to set protection (may be NULL for group keys) |
| protect_type | MLME_SETPROTECTION_PROTECT_TYPE_* |
| key_type | MLME_SETPROTECTION_KEY_TYPE_* |
This is an optional function that can be used to set the driver to require protection for Tx and/or Rx frames. This uses the layer interface defined in IEEE 802.11i-2004 clause 10.3.22.1 (MLME-SETPROTECTION.request). Many drivers do not use explicit set protection operation; instead, they set protection implicitly based on configured keys.
| const char* wpa_driver_ops::name |
Name of the driver interface
| int(* wpa_driver_ops::p2p_connect)(void *priv, const u8 *peer_addr, int wps_method, int go_intent, const u8 *own_interface_addr, unsigned int force_freq, int persistent_group) |
Start P2P group formation (GO negotiation)
| priv | Private driver interface data |
| peer_addr | MAC address of the peer P2P client |
| wps_method | enum p2p_wps_method value indicating config method |
| go_intent | Local GO intent value (1..15) |
| own_interface_addr | Intended interface address to use with the group |
| force_freq | The only allowed channel frequency in MHz or 0 |
| persistent_group | Whether to create persistent group |
This function is only used if the driver implements P2P management, i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in struct wpa_driver_capa.
| int(* wpa_driver_ops::p2p_find)(void *priv, unsigned int timeout, int type) |
Start P2P Device Discovery.
| priv | Private driver interface data |
| timeout | Timeout for find operation in seconds or 0 for no timeout |
| type | Device Discovery type (enum p2p_discovery_type) |
This function is only used if the driver implements P2P management, i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in struct wpa_driver_capa.
| int(* wpa_driver_ops::p2p_group_formation_failed)(void *priv) |
Report failed WPS provisioning.
| priv | Private driver interface data |
This function is used to report failed group formation. This can happen either due to failed WPS provisioning or due to 15 second timeout during the provisioning phase.
This function is only used if the driver implements P2P management, i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in struct wpa_driver_capa.
| int(* wpa_driver_ops::p2p_invite)(void *priv, const u8 *peer, int role, const u8 *bssid, const u8 *ssid, size_t ssid_len, const u8 *go_dev_addr, int persistent_group) |
Invite a P2P Device into a group.
| priv | Private driver interface data |
| peer | Device Address of the peer P2P Device |
| role | Local role in the group |
| bssid | Group BSSID or NULL if not known |
| ssid | Group SSID |
| ssid_len | Length of ssid in octets |
| go_dev_addr | Forced GO Device Address or NULL if none |
| persistent_group | Whether this is to reinvoke a persistent group |
| int(* wpa_driver_ops::p2p_listen)(void *priv, unsigned int timeout) |
Start P2P Listen state for specified duration.
| priv | Private driver interface data |
| timeout | Listen state duration in milliseconds |
This function can be used to request the P2P module to keep the device discoverable on the listen channel for an extended set of time. At least in its current form, this is mainly used for testing purposes and may not be of much use for normal P2P operations.
This function is only used if the driver implements P2P management, i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in struct wpa_driver_capa.
| int(* wpa_driver_ops::p2p_prov_disc_req)(void *priv, const u8 *peer_addr, u16 config_methods, int join) |
Send Provision Discovery Request.
| priv | Private driver interface data |
| peer_addr | MAC address of the peer P2P client |
| config_methods | WPS Config Methods value (only one bit set) |
This function can be used to request a discovered P2P peer to display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The Provision Discovery Request frame is transmitted once immediately and if no response is received, the frame will be sent again whenever the target device is discovered during device dsicovery (start with a p2p_find() call). Response from the peer is indicated with the EVENT_P2P_PROV_DISC_RESPONSE event.
This function is only used if the driver implements P2P management, i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in struct wpa_driver_capa.
| int(* wpa_driver_ops::p2p_reject)(void *priv, const u8 *addr) |
Reject peer device (explicitly block connections)
| priv | Private driver interface data |
| addr | MAC address of the peer |
| int(* wpa_driver_ops::p2p_sd_cancel_request)(void *priv, u64 req) |
Cancel a pending service discovery query.
| priv | Private driver interface data |
| req | Query reference from p2p_sd_request() |
This function is only used if the driver implements P2P management, i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in struct wpa_driver_capa.
| u64(* wpa_driver_ops::p2p_sd_request)(void *priv, const u8 *dst, const struct wpabuf *tlvs) |
Schedule a service discovery query.
| priv | Private driver interface data |
| dst | Destination peer or NULL to apply for all peers |
| tlvs | P2P Service Query TLV(s) |
Response to the query is indicated with the EVENT_P2P_SD_RESPONSE driver event.
This function is only used if the driver implements P2P management, i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in struct wpa_driver_capa.
| int(* wpa_driver_ops::p2p_sd_response)(void *priv, int freq, const u8 *dst, u8 dialog_token, const struct wpabuf *resp_tlvs) |
Send response to a service discovery query.
| priv | Private driver interface data |
| freq | Frequency from EVENT_P2P_SD_REQUEST event |
| dst | Destination address from EVENT_P2P_SD_REQUEST event |
| dialog_token | Dialog token from EVENT_P2P_SD_REQUEST event |
| resp_tlvs | P2P Service Response TLV(s) |
This function is called as a response to the request indicated with the EVENT_P2P_SD_REQUEST driver event.
This function is only used if the driver implements P2P management, i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in struct wpa_driver_capa.
| int(* wpa_driver_ops::p2p_service_update)(void *priv) |
Indicate a change in local services.
| priv | Private driver interface data |
This function needs to be called whenever there is a change in availability of the local services. This will increment the Service Update Indicator value which will be used in SD Request and Response frames.
This function is only used if the driver implements P2P management, i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in struct wpa_driver_capa.
| int(* wpa_driver_ops::p2p_set_params)(void *priv, const struct p2p_params *params) |
Set P2P parameters.
| priv | Private driver interface data |
| params | P2P parameters |
This function is only used if the driver implements P2P management, i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in struct wpa_driver_capa.
| int(* wpa_driver_ops::p2p_stop_find)(void *priv) |
Stop P2P Device Discovery.
| priv | Private driver interface data |
This function is only used if the driver implements P2P management, i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in struct wpa_driver_capa.
| void(* wpa_driver_ops::poll)(void *priv) |
Poll driver for association information.
| priv | private driver interface data |
This is an option callback that can be used when the driver does not provide event mechanism for association events. This is called when receiving WPA EAPOL-Key messages that require association information. The driver interface is supposed to generate associnfo event before returning from this callback function. In addition, the driver interface should generate an association event after having sent out associnfo.
| void(* wpa_driver_ops::poll_client)(void *priv, const u8 *own_addr, const u8 *addr, int qos) |
Probe (null data or such) the given station.
| priv | Private driver interface data |
| own_addr | MAC address of sending interface |
| addr | MAC address of the station to probe |
| qos | Indicates whether station is QoS station |
This function is used to verify whether an associated station is still present. This function does not need to be implemented if the driver provides such inactivity polling mechanism.
| int(* wpa_driver_ops::probe_req_report)(void *priv, int report) |
Request Probe Request frames to be indicated.
| priv | Private driver interface data |
| report | Whether to report received Probe Request frames |
This command can be used to request the driver to indicate when Probe Request frames are received with EVENT_RX_PROBE_REQ events. Since this operation may require extra resources, e.g., due to less optimal hardware/firmware RX filtering, many drivers may disable Probe Request reporting at least in station mode. This command is used to notify the driver when the Probe Request frames need to be reported, e.g., during remain-on-channel operations.
| int(* wpa_driver_ops::radio_disable)(void *priv, int disabled) |
Disable/enable radio.
| priv | Private driver interface data |
| disabled | 1=disable 0=enable radio |
This optional command is for testing purposes. It can be used to disable the radio on a testbed device to simulate out-of-radio-range conditions.
| int(* wpa_driver_ops::read_sta_data)(void *priv, struct hostap_sta_driver_data *data, const u8 *addr) |
Fetch station data (AP only)
| priv | Private driver interface data |
| data | Buffer for returning station information |
| addr | MAC address of the station |
| int(* wpa_driver_ops::remain_on_channel)(void *priv, unsigned int freq, unsigned int duration) |
Remain awake on a channel.
| priv | Private driver interface data |
| freq | Frequency (in MHz) of the channel |
| duration | Duration in milliseconds |
This command is used to request the driver to remain awake on the specified channel for the specified duration and report received Action frames with EVENT_RX_ACTION events. Optionally, received Probe Request frames may also be requested to be reported by calling probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
The driver may not be at the requested channel when this function returns, i.e., the return code is only indicating whether the request was accepted. The caller will need to wait until the EVENT_REMAIN_ON_CHANNEL event indicates that the driver has completed the channel change. This may take some time due to other need for the radio and the caller should be prepared to timing out its wait since there are no guarantees on when this request can be executed.
| int(* wpa_driver_ops::remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid) |
Remove PMKSA cache entry to the driver.
| priv | private driver interface data |
| bssid | BSSID for the PMKSA cache entry |
| pmkid | PMKID for the PMKSA cache entry |
This function is called when the supplicant drops a PMKSA cache entry for any reason.
If the driver generates RSN IE, i.e., it does not use wpa_ie in associate(), remove_pmkid() can be used to synchronize PMKSA caches between the driver and wpa_supplicant. If the driver uses wpa_ie from wpa_supplicant, this driver_ops function does not need to be implemented. Likewise, if the driver does not support WPA, this function is not needed.
| void(* wpa_driver_ops::resume)(void *priv) |
Notification on system resume/thaw event.
| priv | Private driver interface data |
| int(* wpa_driver_ops::scan2)(void *priv, struct wpa_driver_scan_params *params) |
Request the driver to initiate scan.
| priv | private driver interface data |
| params | Scan parameters |
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_results2().
| int(* wpa_driver_ops::sched_scan)(void *priv, struct wpa_driver_scan_params *params, u32 interval) |
Request the driver to initiate scheduled scan.
| priv | Private driver interface data |
| params | Scan parameters |
| interval | Interval between scan cycles in milliseconds |
This operation should be used for scheduled scan offload to the hardware. Every time scan results are available, the driver should report scan results event for wpa_supplicant which will eventually request the results with wpa_driver_get_scan_results2(). This operation is optional and if not provided or if it returns -1, we fall back to normal host-scheduled scans.
| int(* wpa_driver_ops::send_action)(void *priv, unsigned int freq, unsigned int wait, const u8 *dst, const u8 *src, const u8 *bssid, const u8 *data, size_t data_len, int no_cck) |
Transmit an Action frame.
| priv | Private driver interface data |
| freq | Frequency (in MHz) of the channel |
| wait | Time to wait off-channel for a response (in ms), or zero |
| dst | Destination MAC address (Address 1) |
| src | Source MAC address (Address 2) |
| bssid | BSSID (Address 3) |
| data | Frame body |
| data_len | data length in octets @ : Whether CCK rates must not be used to transmit this frame |
This command can be used to request the driver to transmit an action frame to the specified destination.
If the WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will be transmitted on the given channel and the device will wait for a response on that channel for the given wait time.
If the flag is not set, the wait time will be ignored. In this case, if a remain-on-channel duration is in progress, the frame must be transmitted on that channel; alternatively the frame may be sent on the current operational channel (if in associated state in station mode or while operating as an AP.)
| void(* wpa_driver_ops::send_action_cancel_wait)(void *priv) |
Cancel action frame TX wait.
| priv | Private driver interface data |
This command cancels the wait time associated with sending an action frame. It is only available when WPA_DRIVER_FLAGS_OFFCHANNEL_TX is set in the driver flags.
| int(* wpa_driver_ops::send_eapol)(void *priv, const u8 *dest, u16 proto, const u8 *data, size_t data_len) |
Optional function for sending EAPOL packets.
| priv | private driver interface data |
| dest | Destination MAC address |
| proto | Ethertype |
| data | EAPOL packet starting with IEEE 802.1X header |
| data_len | Size of the EAPOL packet |
This optional function can be used to override l2_packet operations with driver specific functionality. If this function pointer is set, l2_packet module is not used at all and the driver interface code is responsible for receiving and sending all EAPOL packets. The received EAPOL packets are sent to core code with EVENT_EAPOL_RX event. The driver interface is required to implement get_mac_addr() handler if send_eapol() is used.
| int(* wpa_driver_ops::send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto, const u8 *data, size_t data_len) |
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 |
| int(* wpa_driver_ops::send_frame)(void *priv, const u8 *data, size_t data_len, int encrypt) |
Send IEEE 802.11 frame (testing use only)
| priv | Private driver interface data |
| data | IEEE 802.11 frame with IEEE 802.11 header |
| data_len | Size of the frame |
| encrypt | Whether to encrypt the frame (if keys are set) |
This function is only used for debugging purposes and is not required to be implemented for normal operations.
| int(* wpa_driver_ops::send_ft_action)(void *priv, u8 action, const u8 *target_ap, const u8 *ies, size_t ies_len) |
Send FT Action frame (IEEE 802.11r)
| priv | Private driver interface data |
| action | Action field value |
| target_ap | Target AP address |
| ies | FT IEs (MDIE, FTIE, ...) (FT Request action frame body) |
| ies_len | Length of FT IEs in bytes |
The supplicant uses this callback to request the driver to transmit an FT Action frame (action category 6) for over-the-DS fast BSS transition.
| int(* wpa_driver_ops::send_mlme)(void *priv, const u8 *data, size_t data_len, int noack) |
Send management frame from MLME.
| priv | Private driver interface data |
| data | IEEE 802.11 management frame with IEEE 802.11 header |
| data_len | Size of the management frame |
| noack | Do not wait for this frame to be acked (disable retries) |
| int(* wpa_driver_ops::send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code, u8 dialog_token, u16 status_code, const u8 *buf, size_t len) |
for sending TDLS management packets
| priv | private driver interface data |
| dst | Destination (peer) MAC address |
| action_code | TDLS action code for the mssage |
| dialog_token | Dialog Token to use in the message (if needed) |
| status_code | Status Code or Reason Code to use (if needed) |
| buf | TDLS IEs to add to the message |
| len | Length of buf in octets |
This optional function can be used to send packet to driver which is responsible for receiving and sending all TDLS packets.
| int(* wpa_driver_ops::set_ap)(void *priv, struct wpa_driver_ap_params *params) |
Set Beacon and Probe Response information for AP mode.
| priv | Private driver interface data |
| params | Parameters to use in AP mode |
This function is used to configure Beacon template and/or extra IEs to add for Beacon and Probe Response frames 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. Depending on the driver architectue, this can be done either by using the full template or the set of additional IEs (e.g., WPS and P2P IE). Similarly, Probe Response processing depends on the driver design. If the driver (or firmware) takes care of replying to Probe Request frames, the extra IEs provided here needs to be added to the Probe Response frames.
| int(* wpa_driver_ops::set_ap_wps_ie)(void *priv, const struct wpabuf *beacon, const struct wpabuf *proberesp, const struct wpabuf *assocresp) |
Add WPS IE(s) into Beacon/Probe Response frames (AP)
| priv | Private driver interface data |
| beacon | WPS IE(s) for Beacon frames or NULL to remove extra IE(s) |
| proberesp | WPS IE(s) for Probe Response frames or NULL to remove extra IE(s) |
| assocresp | WPS IE(s) for (Re)Association Response frames or NULL to remove extra IE(s) |
This is an optional function to add WPS IE 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_ap() and does not process Probe Request frames. If the driver takes care of (Re)Association frame processing, the assocresp buffer includes WPS IE(s) that need to be added to (Re)Association Response frames whenever a (Re)Association Request frame indicated use of WPS.
This will also be used to add P2P IE(s) into Beacon/Probe Response frames when operating as a GO. The driver is responsible for adding timing related attributes (e.g., NoA) in addition to the IEs included here by appending them after these buffers. This call is also used to provide Probe Response IEs for P2P Listen state operations for drivers that generate the Probe Response frames internally.
DEPRECATED - use set_ap() instead
| int(* wpa_driver_ops::set_authmode)(void *priv, int authmode) |
Set authentication algorithm(s) for static WEP.
| priv | Private driver interface data |
| authmode | 1=Open System, 2=Shared Key, 3=both |
This function can be used to set authentication algorithms for AP mode when static WEP is used. If the driver uses user space MLME/SME implementation, there is no need to implement this function.
DEPRECATED - use set_ap() instead
| int(* wpa_driver_ops::set_countermeasures)(void *priv, int enabled) |
Enable/disable TKIP countermeasures.
| priv | private driver interface data |
| enabled | 1 = countermeasures enabled, 0 = disabled |
Configure TKIP countermeasures. When these are enabled, the driver should drop all received and queued frames that are using TKIP.
| int(* wpa_driver_ops::set_country)(void *priv, const char *alpha2) |
Set country.
| priv | Private driver interface data |
| alpha2 | country to which to switch to |
This function is for drivers which support some form of setting a regulatory domain.
| int(* wpa_driver_ops::set_frag)(void *priv, int frag) |
Set fragmentation threshold.
| priv | Private driver interface data |
| frag | Fragmentation threshold in octets |
| int(* wpa_driver_ops::set_freq)(void *priv, struct hostapd_freq_params *freq) |
Set channel/frequency (AP only)
| priv | Private driver interface data |
| freq | Channel parameters |
| int(* wpa_driver_ops::set_generic_elem)(void *priv, const u8 *elem, size_t elem_len) |
Add IEs into Beacon/Probe Response frames (AP)
| priv | Private driver interface data |
| elem | Information elements |
| elem_len | Length of the elem buffer in octets |
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_ap().
DEPRECATED - use set_ap() instead
| int(* wpa_driver_ops::set_ieee8021x)(void *priv, struct wpa_bss_params *params) |
Enable/disable IEEE 802.1X support (AP only)
| priv | Private driver interface data |
| params | BSS parameters |
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_ap() to set WPA/RSN IE for Beacon frames.
DEPRECATED - use set_ap() instead
| int(* wpa_driver_ops::set_key)(const char *ifname, void *priv, enum 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) |
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); WPA_ALG_NONE clears the key. |
| addr | Address of the peer STA (BSSID of the current AP when setting pairwise key in station mode), ff:ff:ff:ff:ff:ff for broadcast keys, NULL for default keys that are used both for broadcast and unicast; when clearing keys, NULL is used to indicate that both the broadcast-only and default key of the specified key index is to be cleared |
| key_idx | key index (0..3), usually 0 for unicast keys; 0..4095 for IGTK |
| set_tx | configure this key as the default Tx key (only used when driver does not support separate unicast/individual key |
| seq | sequence number/packet number, seq_len octets, the next packet number to be used for in replay protection; configured for Rx keys (in most cases, this is only used with broadcast keys and set to zero for unicast keys); NULL if not set |
| seq_len | length of the seq, depends on the algorithm: TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets |
| key | key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key, 8-byte Rx Mic Key |
| key_len | length of the key buffer in octets (WEP: 5 or 13, TKIP: 32, CCMP: 16, IGTK: 16) |
Configure the given key for the kernel driver. If the driver supports separate individual keys (4 default keys + 1 individual), addr can be used to determine whether the key is default or individual. If only 4 keys are supported, the default key with key index 0 is used as the individual key. STA must be configured to use it as the default Tx key (set_tx is set) and accept Rx for all the key indexes. In most cases, WPA uses only key indexes 1 and 2 for broadcast keys, so key index 0 is available for this kind of configuration.
Please note that TKIP keys include separate TX and RX MIC keys and some drivers may expect them in different order than wpa_supplicant is using. If the TX/RX keys are swapped, all TKIP encrypted packets will trigger Michael MIC errors. This can be fixed by changing the order of MIC keys by swapping te bytes 16..23 and 24..31 of the key in driver_*.c set_key() implementation, see driver_ndis.c for an example on how this can be done.
| int(* wpa_driver_ops::set_noa)(void *priv, u8 count, int start, int duration) |
Set Notice of Absence parameters for GO (testing)
| priv | Private driver interface data |
| count | Count |
| start | Start time in ms from next TBTT |
| duration | Duration in ms |
This function is used to set Notice of Absence parameters for GO. It is used only for testing. To disable NoA, all parameters are set to 0.
| int(* wpa_driver_ops::set_operstate)(void *priv, int state) |
Sets device operating state to DORMANT or UP.
| priv | private driver interface data |
| state | 0 = dormant, 1 = up |
This is an optional function that can be used on operating systems that support a concept of controlling network device state from user space applications. This function, if set, gets called with state = 1 when authentication has been completed and with state = 0 when connection is lost.
| int(* wpa_driver_ops::set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps, int ctwindow) |
Set P2P power save options.
| priv | Private driver interface data |
| legacy_ps | 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change |
| opp_ps | 0 = disable, 1 = enable, -1 = no change |
| ctwindow | 0.. = change (msec), -1 = no change |
| int(* wpa_driver_ops::set_param)(void *priv, const char *param) |
Set driver configuration parameters.
| priv | private driver interface data from init() |
| param | driver specific configuration parameters |
Optional handler for notifying driver interface about configuration parameters (driver_param).
| int(* wpa_driver_ops::set_privacy)(void *priv, int enabled) |
Enable/disable privacy (AP only)
| priv | Private driver interface data |
| enabled | 1 = privacy enabled, 0 = disabled |
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_ap().
DEPRECATED - use set_ap() instead
| int(* wpa_driver_ops::set_radius_acl_auth)(void *priv, const u8 *mac, int accepted, u32 session_timeout) |
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 |
| int(* wpa_driver_ops::set_radius_acl_expire)(void *priv, const u8 *mac) |
Notification of RADIUS ACL expiration.
| priv | Private driver interface data |
| mac | MAC address of the station |
| void(* wpa_driver_ops::set_rekey_info)(void *priv, const u8 *kek, const u8 *kck, const u8 *replay_ctr) |
Set rekey information.
| priv | Private driver interface data |
| kek | Current KEK |
| kck | Current KCK |
| replay_ctr | Current EAPOL-Key Replay Counter |
This optional function can be used to provide information for the driver/firmware to process EAPOL-Key frames in Group Key Handshake while the host (including wpa_supplicant) is sleeping.
| int(* wpa_driver_ops::set_rts)(void *priv, int rts) |
Set RTS threshold.
| priv | Private driver interface data |
| rts | RTS threshold in octets |
| int(* wpa_driver_ops::set_sta_vlan)(void *priv, const u8 *addr, const char *ifname, int vlan_id) |
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 |
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(* wpa_driver_ops::set_supp_port)(void *priv, int authorized) |
Set IEEE 802.1X Supplicant Port status.
| priv | Private driver interface data |
| authorized | Whether the port is authorized |
| int(* wpa_driver_ops::set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min, int cw_max, int burst_time) |
Set TX queue parameters.
| priv | Private driver interface data |
| queue | Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK) |
| aifs | AIFS |
| cw_min | cwMin |
| cw_max | cwMax |
| burst_time | Maximum length for bursting in 0.1 msec units |
| int(* wpa_driver_ops::set_wds_sta)(void *priv, const u8 *addr, int aid, int val, const char *bridge_ifname) |
Bind a station into a 4-address WDS (AP only)
| priv | Private driver interface data |
| addr | MAC address of the associated station |
| aid | Association ID |
| val | 1 = bind to 4-address WDS; 0 = unbind |
| bridge_ifname | Bridge interface to use for the WDS station or NULL to indicate that bridge is not to be used |
| int(* wpa_driver_ops::shared_freq)(void *priv) |
Get operating frequency of shared interface(s)
| priv | Private driver interface data |
This command can be used to request the current operating frequency of any virtual interface that shares the same radio to provide information for channel selection for other virtual interfaces.
| int(* wpa_driver_ops::signal_monitor)(void *priv, int threshold, int hysteresis) |
Set signal monitoring parameters.
| priv | Private driver interface data |
| threshold | Threshold value for signal change events; 0 = disabled |
| hysteresis | Minimum change in signal strength before indicating a new event |
This function can be used to configure monitoring of signal strength with the current AP. Whenever signal strength drops below the threshold value or increases above it, EVENT_SIGNAL_CHANGE event should be generated assuming the signal strength has changed at least hysteresis from the previously indicated signal change event.
| int(* wpa_driver_ops::signal_poll)(void *priv, struct wpa_signal_info *signal_info) |
Get current connection information.
| priv | Private driver interface data |
| signal_info | Connection info structure |
| int(* wpa_driver_ops::sta_add)(void *priv, struct hostapd_sta_add_params *params) |
Add a station entry.
| priv | Private driver interface data |
| params | Station parameters |
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.
With TDLS, this function is also used to add or set (params->set 1) TDLS peer entries.
| int(* wpa_driver_ops::sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr, int reassoc, u16 status, const u8 *ie, size_t len) |
Station association indication.
| priv | Private driver interface data |
| own_addr | Source address and BSSID for association frame |
| addr | MAC address of the station to associate |
| reassoc | flag to indicate re-association |
| status | association response status code |
| ie | assoc response ie buffer |
| len | ie buffer length |
This function indicates the driver to send (Re)Association Response frame to the station.
| int(* wpa_driver_ops::sta_auth)(void *priv, const u8 *own_addr, const u8 *addr, u16 seq, u16 status, const u8 *ie, size_t len) |
Station authentication indication.
| priv | Private driver interface data |
| own_addr | Source address and BSSID for authentication frame |
| addr | MAC address of the station to associate |
| seq | authentication sequence number |
| status | authentication response status code |
| ie | authentication frame ie buffer |
| len | ie buffer length |
This function indicates the driver to send Authentication frame to the station.
| int(* wpa_driver_ops::sta_clear_stats)(void *priv, const u8 *addr) |
Clear station statistics (AP only)
| priv | Private driver interface data |
| addr | Station address |
| int(* wpa_driver_ops::sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr, int reason) |
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 |
This function requests a specific station to be deauthenticated and a Deauthentication frame to be sent to it.
| int(* wpa_driver_ops::sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr, int reason) |
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 |
This function requests a specific station to be disassociated and a Disassociation frame to be sent to it.
| int(* wpa_driver_ops::sta_remove)(void *priv, const u8 *addr) |
Remove a station entry (AP only)
| priv | Private driver interface data |
| addr | MAC address of the station to be removed |
| int(* wpa_driver_ops::sta_set_flags)(void *priv, const u8 *addr, int total_flags, int flags_or, int flags_and) |
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 |
| int(* wpa_driver_ops::stop_sched_scan)(void *priv) |
Request the driver to stop a scheduled scan.
| priv | Private driver interface data |
This should cause the scheduled scan to be stopped and results should stop being sent. Must be supported if sched_scan is supported.
| void(* wpa_driver_ops::suspend)(void *priv) |
Notification on system suspend/hibernate event.
| priv | Private driver interface data |
| int(* wpa_driver_ops::tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer) |
Ask the driver to perform high-level TDLS operations.
| priv | Private driver interface data |
| oper | TDLS high-level operation. See enum tdls_oper |
| peer | Destination (peer) MAC address |
This optional function can be used to send high-level TDLS commands to the driver.
| int(* wpa_driver_ops::update_ft_ies)(void *priv, const u8 *md, const u8 *ies, size_t ies_len) |
Update FT (IEEE 802.11r) IEs.
| priv | Private driver interface data |
| md | Mobility domain (2 octets) (also included inside ies) |
| ies | FT IEs (MDIE, FTIE, ...) or NULL to remove IEs |
| ies_len | Length of FT IEs in bytes |
The supplicant uses this callback to let the driver know that keying material for FT is available and that the driver can use the provided IEs in the next message in FT authentication sequence.
This function is only needed for driver that support IEEE 802.11r (Fast BSS Transition).
| int(* wpa_driver_ops::wps_success_cb)(void *priv, const u8 *peer_addr) |
Report successfully completed WPS provisioning.
| priv | Private driver interface data |
| peer_addr | Peer address |
This function is used to report successfully completed WPS provisioning during group formation in both GO/Registrar and client/Enrollee roles.
This function is only used if the driver implements P2P management, i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in struct wpa_driver_capa.
1.7.3
