|
wpa_supplicant / hostapd
2.5
|
|
wpa_supplicant / hostapd
2.5
|
Driver interface API definition. More...
#include <driver.h>
Data Fields | |
| const char * | name |
| Name of the driver interface. | |
| const char * | desc |
| One line description of the driver interface. | |
| int(* | get_bssid )(void *priv, u8 *bssid) |
| Get the current BSSID. More... | |
| int(* | get_ssid )(void *priv, u8 *ssid) |
| Get the current SSID. More... | |
| 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. More... | |
| void *(* | init )(void *ctx, const char *ifname) |
| Initialize driver interface. More... | |
| void(* | deinit )(void *priv) |
| Deinitialize driver interface. More... | |
| int(* | set_param )(void *priv, const char *param) |
| Set driver configuration parameters. More... | |
| int(* | set_countermeasures )(void *priv, int enabled) |
| Enable/disable TKIP countermeasures. More... | |
| int(* | deauthenticate )(void *priv, const u8 *addr, int reason_code) |
| Request driver to deauthenticate. More... | |
| int(* | associate )(void *priv, struct wpa_driver_associate_params *params) |
| Request driver to associate. More... | |
| int(* | add_pmkid )(void *priv, const u8 *bssid, const u8 *pmkid) |
| Add PMKSA cache entry to the driver. More... | |
| int(* | remove_pmkid )(void *priv, const u8 *bssid, const u8 *pmkid) |
| Remove PMKSA cache entry to the driver. More... | |
| int(* | flush_pmkid )(void *priv) |
| Flush PMKSA cache. More... | |
| int(* | get_capa )(void *priv, struct wpa_driver_capa *capa) |
| Get driver capabilities. More... | |
| void(* | poll )(void *priv) |
| Poll driver for association information. More... | |
| const char *(* | get_ifname )(void *priv) |
| Get interface name. More... | |
| const u8 *(* | get_mac_addr )(void *priv) |
| Get own MAC address. More... | |
| int(* | set_operstate )(void *priv, int state) |
| Sets device operating state to DORMANT or UP. More... | |
| int(* | mlme_setprotection )(void *priv, const u8 *addr, int protect_type, int key_type) |
| MLME-SETPROTECTION.request primitive. More... | |
| struct hostapd_hw_modes *(* | get_hw_feature_data )(void *priv, u16 *num_modes, u16 *flags) |
| Get hardware support data (channels and rates) More... | |
| int(* | send_mlme )(void *priv, const u8 *data, size_t data_len, int noack, unsigned int freq) |
| Send management frame from MLME. More... | |
| int(* | update_ft_ies )(void *priv, const u8 *md, const u8 *ies, size_t ies_len) |
| Update FT (IEEE 802.11r) IEs. More... | |
| struct wpa_scan_results *(* | get_scan_results2 )(void *priv) |
| Fetch the latest scan results. More... | |
| int(* | set_country )(void *priv, const char *alpha2) |
| Set country. More... | |
| int(* | get_country )(void *priv, char *alpha2) |
| Get country. More... | |
| void *(* | global_init )(void) |
| Global driver initialization. More... | |
| void(* | global_deinit )(void *priv) |
| Global driver deinitialization. More... | |
| void *(* | init2 )(void *ctx, const char *ifname, void *global_priv) |
| Initialize driver interface (with global data) More... | |
| struct wpa_interface_info *(* | get_interfaces )(void *global_priv) |
| Get information about available interfaces. More... | |
| int(* | scan2 )(void *priv, struct wpa_driver_scan_params *params) |
| Request the driver to initiate scan. More... | |
| int(* | authenticate )(void *priv, struct wpa_driver_auth_params *params) |
| Request driver to authenticate. More... | |
| int(* | set_ap )(void *priv, struct wpa_driver_ap_params *params) |
| Set Beacon and Probe Response information for AP mode. More... | |
| int(* | set_acl )(void *priv, struct hostapd_acl_params *params) |
| Set ACL in AP mode. More... | |
| void *(* | hapd_init )(struct hostapd_data *hapd, struct wpa_init_params *params) |
| Initialize driver interface (hostapd only) More... | |
| void(* | hapd_deinit )(void *priv) |
| Deinitialize driver interface (hostapd only) More... | |
| int(* | set_ieee8021x )(void *priv, struct wpa_bss_params *params) |
| Enable/disable IEEE 802.1X support (AP only) More... | |
| int(* | set_privacy )(void *priv, int enabled) |
| Enable/disable privacy (AP only) More... | |
| int(* | get_seqnum )(const char *ifname, void *priv, const u8 *addr, int idx, u8 *seq) |
| Fetch the current TSC/packet number (AP only) More... | |
| int(* | flush )(void *priv) |
| Flush all association stations (AP only) More... | |
| int(* | set_generic_elem )(void *priv, const u8 *elem, size_t elem_len) |
| Add IEs into Beacon/Probe Response frames (AP) More... | |
| int(* | read_sta_data )(void *priv, struct hostap_sta_driver_data *data, const u8 *addr) |
| Fetch station data. More... | |
| 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) More... | |
| int(* | sta_deauth )(void *priv, const u8 *own_addr, const u8 *addr, int reason) |
| Deauthenticate a station (AP only) More... | |
| int(* | sta_disassoc )(void *priv, const u8 *own_addr, const u8 *addr, int reason) |
| Disassociate a station (AP only) More... | |
| int(* | sta_remove )(void *priv, const u8 *addr) |
| Remove a station entry (AP only) More... | |
| int(* | hapd_get_ssid )(void *priv, u8 *buf, int len) |
| Get the current SSID (AP only) More... | |
| int(* | hapd_set_ssid )(void *priv, const u8 *buf, int len) |
| Set SSID (AP only) More... | |
| int(* | hapd_set_countermeasures )(void *priv, int enabled) |
| Enable/disable TKIP countermeasures (AP) More... | |
| int(* | sta_add )(void *priv, struct hostapd_sta_add_params *params) |
| Add a station entry. More... | |
| int(* | get_inact_sec )(void *priv, const u8 *addr) |
| Get station inactivity duration (AP only) More... | |
| int(* | sta_clear_stats )(void *priv, const u8 *addr) |
| Clear station statistics (AP only) More... | |
| int(* | set_freq )(void *priv, struct hostapd_freq_params *freq) |
| Set channel/frequency (AP only) More... | |
| int(* | set_rts )(void *priv, int rts) |
| Set RTS threshold. More... | |
| int(* | set_frag )(void *priv, int frag) |
| Set fragmentation threshold. More... | |
| int(* | sta_set_flags )(void *priv, const u8 *addr, unsigned int total_flags, unsigned int flags_or, unsigned int flags_and) |
| Set station flags (AP only) More... | |
| int(* | set_tx_queue_params )(void *priv, int queue, int aifs, int cw_min, int cw_max, int burst_time) |
| Set TX queue parameters. More... | |
| 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, int use_existing) |
| Add a virtual interface. More... | |
| int(* | if_remove )(void *priv, enum wpa_driver_if_type type, const char *ifname) |
| Remove a virtual interface. More... | |
| int(* | set_sta_vlan )(void *priv, const u8 *addr, const char *ifname, int vlan_id) |
| Bind a station into a specific interface (AP only) More... | |
| int(* | commit )(void *priv) |
| Optional commit changes handler (AP only) More... | |
| 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) More... | |
| int(* | set_radius_acl_auth )(void *priv, const u8 *mac, int accepted, u32 session_timeout) |
| Notification of RADIUS ACL change. More... | |
| int(* | set_radius_acl_expire )(void *priv, const u8 *mac) |
| Notification of RADIUS ACL expiration. More... | |
| 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) More... | |
| int(* | set_supp_port )(void *priv, int authorized) |
| Set IEEE 802.1X Supplicant Port status. More... | |
| int(* | set_wds_sta )(void *priv, const u8 *addr, int aid, int val, const char *bridge_ifname, char *ifname_wds) |
| Bind a station into a 4-address WDS (AP only) More... | |
| 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. More... | |
| void(* | send_action_cancel_wait )(void *priv) |
| Cancel action frame TX wait. More... | |
| int(* | remain_on_channel )(void *priv, unsigned int freq, unsigned int duration) |
| Remain awake on a channel. More... | |
| int(* | cancel_remain_on_channel )(void *priv) |
| Cancel remain-on-channel operation. More... | |
| int(* | probe_req_report )(void *priv, int report) |
| Request Probe Request frames to be indicated. More... | |
| int(* | deinit_ap )(void *priv) |
| Deinitialize AP mode. More... | |
| int(* | deinit_p2p_cli )(void *priv) |
| Deinitialize P2P client mode. More... | |
| void(* | suspend )(void *priv) |
| Notification on system suspend/hibernate event. More... | |
| void(* | resume )(void *priv) |
| Notification on system resume/thaw event. More... | |
| int(* | signal_monitor )(void *priv, int threshold, int hysteresis) |
| Set signal monitoring parameters. More... | |
| int(* | send_frame )(void *priv, const u8 *data, size_t data_len, int encrypt) |
| Send IEEE 802.11 frame (testing use only) More... | |
| int(* | get_noa )(void *priv, u8 *buf, size_t buf_len) |
| Get current Notice of Absence attribute payload. More... | |
| int(* | set_noa )(void *priv, u8 count, int start, int duration) |
| Set Notice of Absence parameters for GO (testing) More... | |
| int(* | set_p2p_powersave )(void *priv, int legacy_ps, int opp_ps, int ctwindow) |
| Set P2P power save options. More... | |
| int(* | ampdu )(void *priv, int ampdu) |
| Enable/disable aggregation. More... | |
| const char *(* | get_radio_name )(void *priv) |
| Get physical radio name for the device. More... | |
| int(* | send_tdls_mgmt )(void *priv, const u8 *dst, u8 action_code, u8 dialog_token, u16 status_code, u32 peer_capab, int initiator, const u8 *buf, size_t len) |
| for sending TDLS management packets More... | |
| int(* | tdls_oper )(void *priv, enum tdls_oper oper, const u8 *peer) |
| Ask the driver to perform high-level TDLS operations. More... | |
| int(* | wnm_oper )(void *priv, enum wnm_oper oper, const u8 *peer, u8 *buf, u16 *buf_len) |
| Notify driver of the WNM frame reception. More... | |
| int(* | set_qos_map )(void *priv, const u8 *qos_map_set, u8 qos_map_set_len) |
| Set QoS Map. More... | |
| int(* | br_add_ip_neigh )(void *priv, u8 version, const u8 *ipaddr, int prefixlen, const u8 *addr) |
| Add a neigh to the bridge ip neigh table. More... | |
| int(* | br_delete_ip_neigh )(void *priv, u8 version, const u8 *ipaddr) |
| Remove a neigh from the bridge ip neigh table. More... | |
| int(* | br_port_set_attr )(void *priv, enum drv_br_port_attr attr, unsigned int val) |
| Set a bridge port attribute. More... | |
| int(* | br_set_net_param )(void *priv, enum drv_br_net_param param, unsigned int val) |
| Set a bridge network parameter. More... | |
| int(* | set_wowlan )(void *priv, const struct wowlan_triggers *triggers) |
| Set wake-on-wireless triggers. More... | |
| int(* | signal_poll )(void *priv, struct wpa_signal_info *signal_info) |
| Get current connection information. More... | |
| int(* | set_authmode )(void *priv, int authmode) |
| Set authentication algorithm(s) for static WEP. More... | |
| int(* | vendor_cmd )(void *priv, unsigned int vendor_id, unsigned int subcmd, const u8 *data, size_t data_len, struct wpabuf *buf) |
| Execute vendor specific command. More... | |
| void(* | set_rekey_info )(void *priv, const u8 *kek, size_t kek_len, const u8 *kck, size_t kck_len, const u8 *replay_ctr) |
| Set rekey information. More... | |
| 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. More... | |
| 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. More... | |
| int(* | add_tspec )(void *priv, const u8 *addr, u8 *tspec_ie, size_t tspec_ielen) |
| Add traffic stream. More... | |
| int(* | add_sta_node )(void *priv, const u8 *addr, u16 auth_alg) |
| Add a station node in the driver. More... | |
| int(* | sched_scan )(void *priv, struct wpa_driver_scan_params *params, u32 interval) |
| Request the driver to initiate scheduled scan. More... | |
| int(* | stop_sched_scan )(void *priv) |
| Request the driver to stop a scheduled scan. More... | |
| void(* | poll_client )(void *priv, const u8 *own_addr, const u8 *addr, int qos) |
| Probe (null data or such) the given station. More... | |
| int(* | radio_disable )(void *priv, int disabled) |
| Disable/enable radio. More... | |
| int(* | switch_channel )(void *priv, struct csa_settings *settings) |
| Announce channel switch and migrate the GO to the given frequency. More... | |
| int(* | add_tx_ts )(void *priv, u8 tsid, const u8 *addr, u8 user_prio, u16 admitted_time) |
| Add traffic stream. More... | |
| int(* | del_tx_ts )(void *priv, u8 tsid, const u8 *addr) |
| Delete traffic stream. More... | |
| int(* | tdls_enable_channel_switch )(void *priv, const u8 *addr, u8 oper_class, const struct hostapd_freq_params *params) |
| Enable channel-switching with TDLS peer. More... | |
| int(* | tdls_disable_channel_switch )(void *priv, const u8 *addr) |
| Disable channel switching with TDLS peer. More... | |
| int(* | start_dfs_cac )(void *priv, struct hostapd_freq_params *freq) |
| Listen for radar interference on the channel. More... | |
| int(* | stop_ap )(void *priv) |
| Removes beacon from AP. More... | |
| int(* | get_survey )(void *priv, unsigned int freq) |
| Retrieve survey data. More... | |
| int(* | status )(void *priv, char *buf, size_t buflen) |
| Get driver interface status information. More... | |
| int(* | roaming )(void *priv, int allowed, const u8 *bssid) |
| Set roaming policy for driver-based BSS selection. More... | |
| int(* | set_mac_addr )(void *priv, const u8 *addr) |
| Set MAC address. More... | |
| int(* | init_mesh )(void *priv) |
| Driver specific initialization for mesh. More... | |
| int(* | join_mesh )(void *priv, struct wpa_driver_mesh_join_params *params) |
| Join a mesh network. More... | |
| int(* | leave_mesh )(void *priv) |
| Leave a mesh network. More... | |
| int(* | do_acs )(void *priv, struct drv_acs_params *params) |
| Automatically select channel. More... | |
| int(* | set_band )(void *priv, enum set_band band) |
| Notify driver of band selection. More... | |
| int(* | get_pref_freq_list )(void *priv, enum wpa_driver_if_type if_type, unsigned int *num, unsigned int *freq_list) |
| Get preferred frequency list for an interface. More... | |
| int(* | set_prob_oper_freq )(void *priv, unsigned int freq) |
| Indicate probable P2P operating channel. More... | |
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::add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio, u16 admitted_time) |
Add traffic stream.
| priv | Private driver interface data |
| tsid | Traffic stream ID |
| addr | Receiver address |
| user_prio | User priority of the traffic stream |
| admitted_time | Admitted time for this TS in units of 32 microsecond periods (per second). |
| 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::br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr, int prefixlen, const u8 *addr) |
Add a neigh to the bridge ip neigh table.
| priv | Private driver interface data |
| version | IP version of the IP address, 4 or 6 |
| ipaddr | IP address for the neigh entry |
| prefixlen | IP address prefix length |
| addr | Corresponding MAC address |
| int(* wpa_driver_ops::br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr) |
Remove a neigh from the bridge ip neigh table.
| priv | Private driver interface data |
| version | IP version of the IP address, 4 or 6 |
| ipaddr | IP address for the neigh entry |
| int(* wpa_driver_ops::br_port_set_attr)(void *priv, enum drv_br_port_attr attr, unsigned int val) |
Set a bridge port attribute.
| attr | Bridge port attribute to set |
| val | Value to be set |
| int(* wpa_driver_ops::br_set_net_param)(void *priv, enum drv_br_net_param param, unsigned int val) |
Set a bridge network parameter.
| param | Bridge parameter to set |
| val | Value to be set |
| 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) |
Deinitialize driver interface.
| priv | private driver interface data from init() Shut down driver interface and processing of driver events. Free
private data buffer if one was allocated in init() handler. |
| 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. If the interface was not dynamically added,
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. If the
interface was not dynamically added, change the interface type back
to station mode. | int(* wpa_driver_ops::del_tx_ts)(void *priv, u8 tsid, const u8 *addr) |
Delete traffic stream.
| priv | Private driver interface data |
| tsid | Traffic stream ID |
| addr | Receiver address |
| int(* wpa_driver_ops::do_acs)(void *priv, struct drv_acs_params *params) |
Automatically select channel.
| priv | Private driver interface data |
| params | Parameters for ACS Returns 0 on success, -1 on failure |
This command can be used to offload ACS to the driver if the driver indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
| 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.
| int(* wpa_driver_ops::get_country)(void *priv, char *alpha2) |
Get country.
| priv | Private driver interface data |
| alpha2 | Buffer for returning country code (at least 3 octets) |
| struct hostapd_hw_modes*(* wpa_driver_ops::get_hw_feature_data)(void *priv, u16 *num_modes, u16 *flags) |
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) |
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.
| int(* wpa_driver_ops::get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type, unsigned int *num, unsigned int *freq_list) |
Get preferred frequency list for an interface.
| priv | Private driver interface data |
| if_type | Interface type |
| num | Number of channels |
| freq_list | Preferred channel frequency list encoded in MHz values Returns 0 on success, -1 on failure |
This command can be used to query the preferred frequency list from the driver specific to a particular interface type.
| 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) |
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, GCMP, 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. | int(* wpa_driver_ops::get_survey)(void *priv, unsigned int freq) |
Retrieve survey data.
| priv | Private driver interface data |
| freq | If set, survey data for the specified frequency is only being requested. If not set, all survey data is requested. |
Use this to retrieve:
- the observed channel noise floor
- the amount of time we have spent on the channel
- the amount of time during which we have spent on the channel that
the radio has determined the medium is busy and we cannot
transmit
- the amount of time we have spent receiving data
- the amount of time we have spent transmitting data
This data can be used for spectrum heuristics. One example is
Automatic Channel Selection (ACS). The channel survey data is
kept on a linked list on the channel data, one entry is added
for each survey. The min_nf of the channel is updated for each
survey. | 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) |
Initialize driver interface (hostapd only)
| hapd | Pointer to hostapd context |
| params | Configuration for the driver wrapper |
This function is used instead of init() or init2() when the driver
wrapper is used with hostapd. | 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, int use_existing) |
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 |
| use_existing | Whether to allow existing interface to be used |
| 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::init_mesh)(void *priv) |
Driver specific initialization for mesh.
| priv | Private driver interface data |
| int(* wpa_driver_ops::join_mesh)(void *priv, struct wpa_driver_mesh_join_params *params) |
Join a mesh network.
| priv | Private driver interface data |
| params | Mesh configuration parameters |
| int(* wpa_driver_ops::leave_mesh)(void *priv) |
Leave a mesh network.
| priv | Private driver interface data Returns 0 on success, -1 on failure |
| 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. | 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.
| 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_MGMT 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::roaming)(void *priv, int allowed, const u8 *bssid) |
Set roaming policy for driver-based BSS selection.
| priv | Private driver interface data |
| allowed | Whether roaming within ESS is allowed |
| bssid | Forced BSSID if roaming is disabled or NULL if not set |
This optional callback can be used to update roaming policy from the
associate() command (bssid being set there indicates that the driver
should not roam before getting this roaming() call to allow roaming.
If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
capability, roaming policy is handled within wpa_supplicant and there
is no need to implement or react to this callback. | 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 no_cck: 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_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_mlme)(void *priv, const u8 *data, size_t data_len, int noack, unsigned int freq) |
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) |
| freq | Frequency (in MHz) to send the frame on, or 0 to let the driver decide |
| int(* wpa_driver_ops::send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code, u8 dialog_token, u16 status_code, u32 peer_capab, int initiator, 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) |
| peer_capab | TDLS peer capability (TDLS_PEER_* bitfield) |
| initiator | Is the current end the TDLS link initiator |
| 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_acl)(void *priv, struct hostapd_acl_params *params) |
Set ACL in AP mode.
| priv | Private driver interface data |
| params | Parameters to configure ACL |
This is used only for the drivers which support MAC address ACL.
| 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_band)(void *priv, enum set_band band) |
Notify driver of band selection.
| priv | Private driver interface data |
| band | The selected band(s) Returns 0 on success, -1 on failure |
| 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_GCMP, WPA_ALG_GCMP_256, WPA_ALG_CCMP_256, WPA_ALG_BIP_GMAC_128, WPA_ALG_BIP_GMAC_256, WPA_ALG_BIP_CMAC_256); 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/GCMP: 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/GCMP: 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_mac_addr)(void *priv, const u8 *addr) |
Set MAC address.
| priv | Private driver interface data |
| addr | MAC address to use or NULL for setting back to permanent |
| 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_prob_oper_freq)(void *priv, unsigned int freq) |
Indicate probable P2P operating channel.
| priv | Private driver interface data |
| freq | Channel frequency in MHz Returns 0 on success, -1 on failure |
This command can be used to inform the driver of the operating frequency that an ongoing P2P group formation is likely to come up on. Local device is assuming P2P Client role.
| int(* wpa_driver_ops::set_qos_map)(void *priv, const u8 *qos_map_set, u8 qos_map_set_len) |
Set QoS Map.
| priv | Private driver interface data |
| qos_map_set | QoS Map |
| qos_map_set_len | Length of QoS Map |
| 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, size_t kek_len, const u8 *kck, size_t kck_len, const u8 *replay_ctr) |
Set rekey information.
| priv | Private driver interface data |
| kek | Current KEK |
| kek_len | KEK length in octets |
| kck | Current KCK |
| kck_len | KCK length in octets |
| 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, char *ifname_wds) |
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 |
| ifname_wds | Buffer to return the interface name for the new WDS station or NULL to indicate name is not returned. |
| int(* wpa_driver_ops::set_wowlan)(void *priv, const struct wowlan_triggers *triggers) |
Set wake-on-wireless triggers.
| priv | Private driver interface data |
| triggers | wowlan triggers |
| 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, unsigned int total_flags, unsigned int flags_or, unsigned 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::start_dfs_cac)(void *priv, struct hostapd_freq_params *freq) |
Listen for radar interference on the channel.
| priv | Private driver interface data |
| freq | Channel parameters |
| int(* wpa_driver_ops::status)(void *priv, char *buf, size_t buflen) |
Get driver interface status information.
| priv | Private driver interface data |
| buf | Buffer for printing tou the status information |
| buflen | Maximum length of the buffer |
| int(* wpa_driver_ops::stop_ap)(void *priv) |
Removes beacon from AP.
| priv | Private driver interface data |
This optional function can be used to disable AP mode related
configuration. Unlike deinit_ap, it does not change to station
mode. | 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::switch_channel)(void *priv, struct csa_settings *settings) |
Announce channel switch and migrate the GO to the given frequency.
| priv | Private driver interface data |
| settings | Settings for CSA period and new channel |
This function is used to move the GO to the legacy STA channel to
avoid frequency conflict in single channel concurrency. | int(* wpa_driver_ops::tdls_disable_channel_switch)(void *priv, const u8 *addr) |
Disable channel switching with TDLS peer.
| priv | Private driver interface data |
| addr | MAC address of the TDLS peer |
This function indicates to the driver that it should stop switching
with a given TDLS peer. | int(* wpa_driver_ops::tdls_enable_channel_switch)(void *priv, const u8 *addr, u8 oper_class, const struct hostapd_freq_params *params) |
Enable channel-switching with TDLS peer.
| priv | Private driver interface data |
| addr | MAC address of the TDLS peer |
| oper_class | Operating class of the switch channel |
| params | Channel specification |
The function indicates to driver that it can start switching to a
different channel with a specified TDLS peer. The switching is
assumed on until canceled with tdls_disable_channel_switch(). | 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::vendor_cmd)(void *priv, unsigned int vendor_id, unsigned int subcmd, const u8 *data, size_t data_len, struct wpabuf *buf) |
Execute vendor specific command.
| priv | Private driver interface data |
| vendor_id | Vendor id |
| subcmd | Vendor command id |
| data | Vendor command parameters (NULL if no parameters) |
| data_len | Data length |
| buf | Return buffer (NULL to ignore reply) |
This function handles vendor specific commands that are passed to
the driver/device. The command is identified by vendor id and
command id. Parameters can be passed as argument to the command
in the data buffer. Reply (if any) will be filled in the supplied
return buffer.
The exact driver behavior is driver interface and vendor specific. As
an example, this will be converted to a vendor specific cfg80211
command in case of the nl80211 driver interface. | int(* wpa_driver_ops::wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer, u8 *buf, u16 *buf_len) |
Notify driver of the WNM frame reception.
| priv | Private driver interface data |
| oper | WNM operation. See enum wnm_oper |
| peer | Destination (peer) MAC address |
| buf | Buffer for the driver to fill in (for getting IE) |
| buf_len | Return the len of buf |
1.8.6